- Print
- DarkLight
Runtime Fields
- Print
- DarkLight
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
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 types.
KPIs: Runtime Fields can be used and referenced in your KPIs.
Accessing Runtime Fields
Follow the steps below to access runtime fields:
Step 1: Navigate to Factory Build
Step 2: Select the Runtime Field Chips for a specific workspace.
Step 3: Access the list of your runtime fields.
Creating Runtime Fields
This guide provides a step-by-step process to create a runtime field.
Step 1: Navigate to the navigation bar and select create new.
Step 2: On the new page, provide a display name for the field.
Step 3: Provide a field name.
Step 4: Select a model from the available options.
Step 5: Choose the asset types for the runtime field.
Step 6: If desired, choose a unit.
Step 7: Select the aggregation for the runtime field.
Step 8: Decide if the field should be visible in applications.
Step 9: Write the formula for the runtime field.
Step 10: Optionally, provide a description for the runtime field.
Step 11: After filling all the fields, select create to finalize the creation of the runtime field.
The runtime field is now created.
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 field 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:
Updating Runtime Fields
This guide explains how to update a runtime field.
Step 0: Start by selecting the desired field from the runtime field list.
Step 1: Switch the view from active to draft
Step 2: Make the changes to the runtime field.
Step 3: Save the changes by reactivating the runtime field. This action makes the draft version active.
The runtime field is now updated
Viewing Runtime Fields
This guide explains how to view runtime fields in the factory view of workspaces.
Follow these steps:
Step 1: Navigate to the factory view in workspaces.
Step 2: Click on the runtime fields chip.
This action opens a list of runtime fields. The list includes details such as:
Display name
Field name
Formula
Asset types
Model
Unit (if available)
Description (if available)
The last modification date and the person who made it
Whether the field is active or inactive, and the activation date
If there's an error, it indicates that it's an invalid runtime field and provides information about the error.
Deactivating Runtime Fields
This guide provides steps to deactivate a runtime field.
Step 1: Click on the desired field to deactivate.
Step 2: Navigate into the draft
Step 3: Click Deactivate.
Follow these steps to successfully deactivate a runtime field.
Deleting Runtime Fields
This guide explains how to delete a runtime field.
Step 0: Start by clicking on the desired runtime field.
Step 1: Ensure the field is deactivated. If the field isn't deactivated, it's impossible to delete.
Step 2: Select Options, then Delete.
Step 3: Select Proceed to confirm the deletion
This action deletes the runtime field.
Reverting Runtime Fields
This guide explains how to revert a runtime field draft back to its active state after making changes that you're not satisfied with. This process allows you to return to the active version without having to undo all the changes manually.
Step 1: Start by making changes to your runtime field. If you're not happy with the modifications, you'll want to revert back to the active version.
Step 2: Navigate to the options menu.
Step 3: Select Revert to Active.
This action generates a draft that mirrors the active version.
Step 4: Observe that the draft and the active version are identical.
Step 5: Save the changes. The field is now fully reverted back to its active state.