Configuring - TimeInState
You can configure the Sigmfine TimeInState Data Reference in two ways:
- Graphically, with a wizard, described in TimeInState Configuration Walk-through.
- Entering the configuration string programmatically.
To configure an Attribute for TimeInState date reference, you must have created an Attribute with one of the value types listed in the following table:
Allowed Attribute Value Types.
| Value Type (Template) | UOM Template | Calculate (DR Config) | Show As (DR config) | Time Unit (DR Config) | Result Displayed as (example) | Option # |
|---|---|---|---|---|---|---|
| Anything/Double/Single | \<None> | Actual Time | Number | Hours | 10.03 | 1 |
| Actual Time | Number | Minutes | 602.05 | 2 | ||
| Actual Time | Number | Seconds | 36123 | 3 | ||
| Percent | Number | Percent | 41.81 | 4 | ||
| Double/Single | Hours | Actual Time | Number | Hours | 10.03 h | 5 |
| Minutes | Actual Time | Number | Minutes | 602.05 min | 6 | |
| Seconds | Actual Time | Number | Seconds | 36123 s | 7 | |
| Percent | Percent | Number | Percent | 41.81 % | 8 | |
| String | \<None> | Actual Time | Text | Seconds | 10 h 2 min 3 s | 9 |
| Percent | Text | Percent | 41.81 % | 10 |
This table can be referenced when reading through the TimeInState Use Cases, by using the Option # column. The column will be referenced in the figures of the TimeInState Use Cases, to better illustrate the range of the TimeInState Data Reference’s utility.
Note:
- This configuration is meant for Element Attributes and not template attributes.
- The TimeInState attribute’s output value is Case start time and end time dependent.
TimeInState Configuration Walk-through
To configuration the data reference with the wizard follow the steps below using either System Explorer or Modeler. The example procedure shown below is performed in System Explorer, selecting an Element template. However, the options are the same whether you are using System Explorer or Modeler.
Open System Explorer or ProcessBook Modeler.
Select an Element or Element template.
System ExplorerClick the Attributes tab.
In the AF Properties window, click the Attributes table.
The remaining steps are the same whether you are using System Explorer or Modeler.
Under Name, select the Attribute to configure with the TimeInState data reference (i.e. A1_TimeInState_Attribute).
Next, you select the data reference.
Click on the Data Reference down-arrow and select TimeInState.
Click the Settings button to open the Time In State Configuration Dialog window.
Use the following table as a guide when completing the remaining steps.
Time In State Options
Input Box / Option Description Tag State The PI Tag ‘State Number’ or ‘State Name’ or the PI Tag value for which the run hours need to be calculated. PI Point Configuration Settings Enter or select the PI Point configuration setting string. Calculate Select Actual Time or Percent for your desired result value Show As Display time as text or number.Select time units (seconds, minutes, or hours) . In the Tag State box, type the and name for the tag state you want to use.
In the PI Point Configuration Settings box, type the PI Point configuration setting string.
Alternatively, you can click the
ellipsis button and select the string.An example of this configuration string is:
Where {ServerName} and {TagName} are replaced with your server name and tag name respectively.
Under Calculate select the type of calculation to use (Actual Time or Percent).
Under Show As, select a time to display as option and the time units to display in (Hours, Minutes, Seconds).
Click OK to save your configuration and close the window.
Refer to TimeInState Use Cases for usage scenarios.