Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Production Management Web Client

Configure Behavior properties

  • Last UpdatedSep 27, 2023
  • 6 minute read

These properties appear in the Behavior category of a Knowledge field.

Note: Depending on your selections some properties may appear or disappear from the available set of properties.

Behavior properties

Property

Description

Valid values

Action

Defines whether this field stores a value with each record or whether it retrieves a value from the Calendar when the record is accessed by AVEVA™ Production Management.

For more information, see Use the Lookup Calendar function in Studio Help.

If the Action property is set to LookupCalendar, specify the ItemName in the Calendar.

If the Action property is set to Store, specify the calculation and capture values.

Store, LookupCalendar

CalendarItem

The ItemName in the Calendar table. AVEVA™ Production Management retrieves the item value based on the ItemName and ActiveDateTime pair.

This property is available only when the Action property is LookupCalendar.

Example

ItemName [ActiveDateTime, Item Value]

ItemName [ActiveDateTime, Item Value]

This directs AVEVA™ Production Management to lookup the value of ItemValue associated with specified ItemName in the dbo.Calendar table, based on ActiveDateTime.

ItemName in the dbo.Calendar table of project data SQL database.

CalculationType

Specifies the type of calculation that the field performs.

The available options will be different depending on type of reporting point.

Options:

  • None - If the field does not perform a calculation, set the CalculationType property to None.

  • Accumulator - An Accumulator field keeps a tally of the accumulated total, but it does not supply a value to the reporting point until the reporting point triggers. An example of an accumulator field is one having a tag that counts the number of items that the plant produces. AVEVA™ Production Management does not capture the actual value of the tag; it captures the difference between the current value of the tag and the value of the tag when the last record was captured.

  • Inventory - This is an advanced setting. Add the capture value to the inventory value to keep a running total of inventory value. The last inventory value is the inventory value at the last sample time. To modify the last inventory value, select Browse next to the LastInventoryValue property. The Edit Inventory Value dialog box appears where you can modify the last inventory value.

For more information, see Configure the Calculation Type property for fields in Studio Help.

None, Accumulator, Inventory

CaptureValueForManualRecords

Specifies whether the field uses the expression result as the default value in manual records.

True, False

DataAvailabilityType

Specifies whether the data is immediately available or is late arriving.

Immediate or LateBound

DataType

The data type for the field. This is an important value for storing and aggregating data correctly.

The correct data type is critical to the ability of Production Analyst to display and aggregate information in fields.

The type you select can cause different options to display in the Properties pane. If it is a numeric data type, you can optionally specify the Minimum and Maximum values under the Details Display category.

The data type is required information, however, sometimes can be supplied by the SourceField.

For more information, see Configure the Data Type property for fields in Studio Help.

If the data type is String, set the String-related properties that determine text entry properties. See StringType property.

Boolean, Date, Double, Integer, Long, Single, String.

StringType

This property appears when DataType is set to String. It specifies the formatting type of the string data.

  • PlainText - This option enables the user to enter plain text only.

  • HyperLink - This option enables user to enter a linked Internet address.

  • HTML - This option enables the user to enter HTML formatting into text edit box.

Studio Knowledge Field Definition field data editor.

For String Type, set the MaximumEditLength and VisibleRows properties under the Details Display category.

PlainText, HyperLink, HTML

DisplayFormat

This value specifies the formatting of numeric data types: Double, Integer, Long, and Single.

For each different numeric data type there is a default format; for example, 0.######. For more information, see Configure the Display Format property for fields in Studio Help.

0.######

FieldType

Specifies the type of field as an ID field or Other. When this value is set to ID, the FieldIDType property appears.

A field that has the DataType property set to String and the FieldType property set to ID is available for Grouping by in charts and reports.

For more information, see Configure the Field Type property for fields in Studio Help.

ID, Other

FieldIDType

This property appears when FieldType is set to ID. Specifies the type of ID field used in grouping data in the charts.

For more information, see Configure the Field ID Type property for fields in Studio Help.

ProductID, LotID, EquipmentID, Other

Filterable

Specifies whether the field is filterable in the Production Analyst data results.

True, False

HasBudget

Indicates whether the field has a budget associated with it. If the field should have a budget value, select True. A budget sub-item appears beneath the field.

Studio project hierarchy view showing the budget item in a field definition.

True, False

HasTarget

Indicates whether the field has a target associated with it. If the field should have a target value, select True. A target sub-item appears beneath the field.

Studio project hierarchy view showing the target item in a field definition.

True, False.

HasTrendDirection

Indicates whether the field has a trend direction associated with it. If the field should have an additional trend direction field, select True.

A trend direction sub-item appears beneath the field to specify properties of the trend direction field.

Embedded Image (65% Scaling) (LIVE)

An additional Trend Direction field appears next to the custom field in the Results grid. An arrow indicates the trend over time based on the last 5 rows. The method of calculation is simple linear regression.

Embedded Image (65% Scaling) (LIVE)

True, False

HistorialFieldExpression

Specifies the value or source of value to be stored.

Click Browse (...) to open the Expression Editor. Use the Expression Editor to build an historical expression that defines the raw field value.

Any valid expression

RefreshOnManualEntry

Specifies whether the expression is recalculated for manual entry. Set the CaptureValueForManualRecords property to True for this property to be effective.

Select True to get new values for manual records, but not for automatic records.

True, False

RefreshValueOnCapture

Specifies whether the value of an expression is refreshed when the field is captured, rather than only when the expression subscription triggers are activated.

In many cases, this value is set to True to enable accurate capture of the last recent value. The application refreshes the sample stream upon field capture and make a new value available for automatic and manual records.

True, False.

Units

Any string value to use as the units in the display. Used for display purposes in AVEVA™ Production Management.

Any string value

In This Topic
TitleResults for “How to create a CRG?”Also Available in