Runtime Field Editor

What are Runtime Fields?

Runtime Fields are dynamic calculations derived from existing attributes and fields within the data foundation. They allow you to compute formulas in real-time without the need for time-consuming pipeline redeployments. Once activated, these fields are available within seconds in Factory Analyze and are ready to be used with Data Visualization or Cookbooks.

Restrictions

• Cycle Sink: Runtime Fields are supported exclusively on cycle sinks. During configuration, you will need to specify a single machine type.

• Deployed Workspace: Runtime Fields can only be activated within workspaces where a pipeline has been deployed.

• Activation: Runtime Fields can only be used when they are activated.

Usage

• Runtime Fields: Runtime Fields can be used and referenced when creating other Runtime Fields, as long as all referenced fields are defined on the same machine type.

• KPIs: Runtime Fields can be used and referenced in your KPIs.

Accessing Runtime Field Builder

To access Runtime Field builder, navigate to the /dev page, available at https://<environment-name>.sightmachine.io/dev and then click Runtime Field Editor.

Working with Workspaces

Runtime Fields are workspace-specific, allowing modifications without impacting production.

• Copying a Workspace: When a workspace is copied, a copy of the Runtime Fields from the original workspace will be included.

• Merging a Workspace: When workspaces are merged, the Runtime Fields from the source workspace will be copied to the newly created workspace.

Create your first Runtime Field

To create your first Runtime Field, select any deployed Workspace in your environment, and click the “Create New Runtime Field” button on the top left corner.

After clicking the button, you will be able to configure all the parameters for this new Runtime Field. The editor comes with instructions on how to write the syntax along with a preloaded example to demonstrate how you can create your own calculations.

Parameters:

• name: The unique name of the Runtime Field.

• display_name: The display name of the Runtime Field. Should be unique.

• description: A helpful description of the Runtime Field.

• formula: The Runtime Field formula.

• machine_type:  The machine type for which the runtime field will be defined. Must be an existing machine type

• unit: The unit of the Runtime Field

Syntax

• Runtime Field names that contain spaces or other reserved characters must be enclosed in $'' (the dollar sign distinguishes them from string literals, which are also enclosed in single quotes).

• All whitespaces in the formula are ignored.

• Aside from column names, the language is not case-sensitive.

Formulas

All supported formulas are included, with examples and description to help you find the right ones for your calculations:

For example, if we wanted to calculate the weighted pressure between 2 sensors for our Paper Mill Dryer we would create a calculation like this:

In this example, we selected “mt_paper_mill_pm2_dryer_section” as our machine type and identified two pressure-related fields to compute the weighted average.

How can I find the fields that I want to use in the formula?

Use the Field Explorer page

If the Runtime Field configuration is correct, you'll see a green validation indicating it's a “Valid Runtime Field”. Otherwise, a message will appear below, signaling a validation error along with a description pinpointing the issue with the Runtime Field.

After ensuring your Runtime Field is valid, click the “Create” button located in the top left corner, confirm your selection, and your new field will be instantly generated.

Any newly created Runtime Field is automatically inactive by default. Therefore, before you can start using it, there's one final step: the activation process.

Activate your Runtime Field

To active a Runtime Field, is as simple as clicking the “Activate” button on the top left corner next to the Runtime Field status. After confirming, you will see how the Runtime Filed status transitions from INACTIVE to ACTIVE.

This is a very important step, because you will not be able to use Runtime Fields unless they have been activated.

View your Runtime Fields

To view your Runtime Fields, navigate back to any deployed Workspace within your environment. There, you'll find a table containing information about all the Runtime Fields created within it.

For each Runtime Field, you will see the following information:

• Display Name

• Name

• Formula

• Description

• Machine Type

• Active

• Last Updated (Time and User)

Use your Runtime Fields

Now that your Runtime Field has been activated, you can start using it. In this example we will create a data table for all machines of the same machine type.

And then we will be able to select the Runtime Field, which is already available among all data fields

Finally we will generate the table, and we can immediately see the results showing for this new Runtime Field.

Update your Runtime Fields

Updating Runtime Fields is as effortless and rapid as creating a new one. Any changes you make are automatically saved, and you'll receive a notification in the top right corner indicating the update with “changed since last activation”. This notification alerts you that the current active version varies from the latest saved version. To implement these changes and make them accessible, simply click the 'Reactivate' button to activate them.

After you confirm, your changes will be immediately available everywhere else in the platform.

Deactivate your Runtime Fields

If you wish to disable a Runtime Field from being available, you can simply deactivate it by clicking the "Deactivate" button located in the top right corner. This action retains the Runtime Field but renders it inaccessible throughout the platform.

Finally, if you wish the fully removed a Runtime Field, you can click the “Delete” button on the top right corner to do so. Please note that you are only allowed to delete Runtime Fields that are inactive.