Action Nodes

An Add Value to Health Indicator node represents an action to create a Health Indicator Value record and link it to a Health Indicator record.

When an Add Value to Health Indicator node is executed, a Health Indicator Value record is created with the timestamp and value defined by the policy logic and corresponding instances.

The outputs of an Add Value to Health Indicator node are the Content GUID and Entity Key of the record that the node creates.

Node Properties

The Properties window for an Add Value to Health Indicator node contains the items that are described in the following table.

A Close Event node represents an action to populate fields in an existing Policy Event record to signify that the associated event has been closed.

When a Close Event node is executed, the following fields will be populated in the associated Policy Event record:

• End Time
• Close Description

To use a Close Event node, the policy model must also contain a Create Event node that is associated with the same Policy Event record (that is, with the same value specified in the Event Name section on the Properties window). The properties of the Create Event node must be configured such that:

• The Has Duration section is set to True.
• The Start Time section contains a value.
• The End Time section does not contain a value.

In the policy model, a dotted line will appear between Create Event and Close Event nodes that are associated with the same Policy Event record.

Node Properties

The Properties window for a Close Event node contains the items that are described in the following table. In each section, you can select the icon to display the outupt of a predecessor node. The values that you define in each section will be used to populate the corresponding fields in the associated Policy Event record.

A Create Entity node represents an action to create a new record in any baseline or custom entity family. The fields in the new records are populated with the input values that you specify in the Properties window for the node.

Node Properties

The Properties window for a Create Entity node contains the items that are described in the following table.

Item	Description	Notes
Family ID list	Specifies the type of records that the Create Entity node will create.	The Family ID list contains all of the baseline and custom entity families in GE Digital APM for which you have update privileges.
Site Key section	Specifies the Site Reference Key of the site to which the new record should be assigned.	You can select to specify the output of a predecessor node in this section.
Auto-map field values? option	Specifies whether you want to automatically map values from a collection to fields in the selected family.	When the values that you want to use to create a record are contained in a collection, you can use this option instead of, or in addition to, specifying the corresponding value for each field individually.
Field values collection section	Specifies the collection that contains new values for fields in the selected family.	This section is enabled only when you select yes for the Auto-map field values? option. The collection that you specify in this section is used to populate the matching fields in the created entity(s) for the selected family. In the records that are created, the fields that are populated are those in which the Field ID matches a Column ID in the collection. Any columns in the collection that do not match a Field ID are skipped.
button	Adds a new row to the Create Entity node.	Each row represents a field that you want to modify in the corresponding record(s). Note: If you are using the auto-map feature, you are not required to add rows to the Create Entity node, but you can use a combination of auto-mapped fields and individually specified fields if you want to. However, if the same field is specified by each method, the individually specified field takes precedence over the field from the auto-mapped collection.
Field column	Specifies a field in the selected family that will be modified.	Both baseline and custom fields will appear in each list.
Value column	Specifies the new value for the corresponding field.	You can select to specify the output of a predecessor node in this section. Important: If a field has complex behavior defined by field-level rules (for example, rules for valid values) and field-level behaviors, this behavior will not be reflected in the Properties window or detected by policy validation. Therefore, you are responsible for ensuring that the values you specify are valid according to any baseline or custom field-level rules for the corresponding field. If a field value is defined by a system code, the value that you specify in the corresponding section must be the system code, not the value that is displayed to the end user.
button	Deletes the corresponding row from the Properties window.	None

A Create Event node represents an action to create a Policy Event record, which stores information about events that are associated with Equipment or Functional Location records.

When a Create Event node is executed, a Policy Event record will be created using the values that you specify on the Properties window for the node. One Policy Event record will be created for each Create Event node in the policy model that has a unique name.

The outputs of the Create Event node are the following system fields for the record that the node creates: Content GUID, Entity Key, Entity ID, and Site Key.

If a Policy Event record is created for an event that has a duration, additional Policy Event records with the same name will not be created until the event is closed (that is, the End Time field in the Policy Event record contains a value).

Node Properties

The Properties window for a Create Event node contains the items that are described in the following table. The values that you define in each section will be used to populate the corresponding fields in the Policy Event record that is created.

A Create Production Event node represents an action to create a Production Event record that is populated with the input values that you specify on the Properties window.

The outputs of the Create Production Event node are the following system fields for the record that the node creates: Content GUID, Entity Key, Entity ID, and Site Key.

Node Properties

The Properties window for a Create Production Event node contains the items that are described in the following table. In each section, you can select the icon to display the outupt of a predecessor node. The values that you define in each section will be used to populate the corresponding fields in the Production Event record that is created.

A Create Recommendation node represents an action to create a Policy Recommendation record that is populated with the input values that you specify on the Properties window for the node and includes (in the Recommendation Description field) a summary of the policy logic that caused the record to be created.

The outputs of the Create Recommendation node are the following system fields for the record that the node creates: Content GUID, Entity Key, Entity ID, and Site Key.

Node Properties

The Properties window for a Create Recommendation node contains the items that are described in the following table. In each section, you can select the icon to display the outupt of a predecessor node. The values that you define in each section will be used to populate the corresponding fields in the Policy Recommendation record that is created.

A Create Relationship node represents an action to create one or more new records in any baseline or custom relationship family. Each new record creates a relationship between a specified predecessor and successor entity record.

The outputs of the Create Relationship node are the following system fields for the record that the node creates: Content GUID, Entity Key, Entity ID, and Site Key.

Node Properties

The Properties window for a Create Relationship node contains the items that are described in the following table.

A Deactivate This Instance node represents an action to deactivate the current policy instance. You can use this node to ensure that an action is taken only once per instance.

When a Deactivate This Instance node is executed, the policy instance whose values caused the node to be executed will be deactivated automatically. If more than one policy instance is associated with the policy, all other policy instances will remain unchanged.

After the conditions that caused the instance to be deactivated have been addressed, you can reactivate the policy instance manually from the Instances pane in Policy Designer or the Policies section in Asset Health Manager.

Node Properties

Other than optionally specifying a name for the node, there are no properties to configure for a Deactivate This Instance node.

A Delete Entity node represents an action to delete from the GE Digital APM database one or more records in any baseline or custom entity family.

Node Properties

The Properties window for a Delete Entity node contains the items that are described in the following table.

Node Properties

The Properties window for a Delete Relationship node contains the items that are described in the following table.

Item	Description	Notes
Family ID list	Specifies the type of record that the Delete Relationship node will delete.	The Family ID list contains all of the baseline and custom relationship families in GE Digital APM for which you have delete privileges.
Predecessor Entity Key(s) section	Specifies the key(s) of the predecessor entity record(s) in the relationship that will be deleted.	You can delete the following types of relationships depending on how you specify values in the Predecessor Entity Key(s) and Successor Entity Key(s) sections: Single one-to-one relationship : Specify a single key in each section. The relationship between the two entity records will be deleted. Multiple one-to-one relationships : Specify the same number of keys in each section. The relationship between each pair of entity records will be deleted. One-to-many relationship : Specify one key in the one section and multiple keys in the other section. The relationship between the single entity record and all the entity records specified in the other section will be deleted. In each section, you can select the icon to display the outupt of a predecessor node. If you specify multiple predecessor and successor records, they do not have to be in the same family. Relationships will not be deleted in the following scenarios: If a relationship you specify does not exist. However, other valid relationships in the same transaction will be deleted. When attempting to delete multiple one-to-one relationships, if the number of keys in each section do not match.
Successor Entity Key(s) section	Specifies the key(s) of the successor entity record(s) in the relationship that will be deleted.

An Edit Entity node represents an action to modify a record in any baseline or custom entity family. The fields in the specified record(s) are populated with the values that you specify on the Properties window for the node. Any field not specified via the Properties window will be unchanged.

Node Properties

The Properties window for an Edit Entity node contains the items that are described in the following table.

Item	Description	Notes
Family ID list	Specifies the type of record that the Edit Entity node will modify.	The Family ID list contains all of the baseline and custom entity families in GE Digital APM for which you have update privileges.
Entity Key(s) section	Specifies the entity key(s) of the record(s) that will be modified.	You can select to specify the output of a predecessor node in this section. The record(s) you specify must be in the family selected in the Family ID list.
Auto-map field values? option	Specifies whether or not you want to automatically map values from a collection to fields in the selected family.	When the values that you want to use to update a record are contained in a collection, you can use this option instead of, or in addition to, specifying the corresponding value for each field individually.
Field values collection section	Specifies the collection that contains new values for fields in the selected family.	This section is enabled only when you select yes for the Auto-map field values? option. The collection that you specify in this section is used to populate the matching fields in the record(s) specified in the Entity Key(s) section. The exact records that are modified is determined as follows: If the collection you specify contains a column with the exact name ENTY_KEY, the records specified in the Entity Key(s) section that have matching Entity Keys are updated. Any other records are not updated. If the collection does not contain a column with the name ENTY_KEY, all records specified in the Entity Key(s) section are updated with values from the first row in the collection. In the records that are modified, the fields that are updated are those where the where the Field ID matches a Column ID in the collection. Any columns in the collection that do not match a Field ID are skipped.
button	Adds a new row to the Edit Entity node.	Each row represents a field that you want to modify in the corresponding record(s). Note: If you are using the auto-map feature, you are not required to add rows to the Edit Entity node, but you can use a combination of auto-mapped fields and individually specified fields if you want to. However, if the same field is specified by each method, the individually specified field takes precedence over the field from the auto-mapped collection.
Field column	Specifies a field in the selected family that will be modified.	Both baseline and custom fields will appear in each list.
Value column	Specifies the new value for the corresponding field.	You can select to specify the output of a predecessor node in this section. Important: If a field has complex behavior defined by field-level rules (for example, rules for valid values) and field-level behaviors, this behavior will not be reflected in the Properties window or detected by policy validation. Therefore, you are responsible for ensuring that the values you specify are valid according to any baseline or custom field-level rules for the corresponding field. If a field value is defined by a system code, the value that you specify in the corresponding section must be the system code, not the value that is displayed to the end user.
button	Deletes the corresponding row from the Properties window.	None.

An Email Contact node represents an action to send an email message. When an Email Contact node is executed, an email message with a summary of the policy execution will be sent to the specified recipient(s). Emails sent via this node use the From address specified in the Email Settings section of Operations Manager.

Node Properties

The Properties window for an Email Contact node contains the items that are described in the following table.

A Return Value node represents an action to return a specific value. You can use this node for a variety of reason, such as:

• To include specified values in the execution results summary for a policy.
• While designing a policy, to show the result of a specific node in order to verify that certain values are being evaluated as expected in cases where the value would not otherwise be displayed in the validation results (because validation results only display the values that are used by a subsequent node). Once the policy logic is fully validated, you can remove the Return Value nodes to make the policy smaller.
• When used within a baseline policy for a GE Digital APM analysis (for example, Risk Based Inspection), to pass values from the policy back to the analysis process that triggers the policy.

Node Properties

The Properties window for a Return Value node contains the items that are described in the following table.

A Rule node represents an action to execute a custom rule that provides functionality that the existing nodes in Policy Designer do not provide.

The inputs and outputs of a Rule node are defined by a rule that will be executed when the policy is executed.

Node Properties

The Properties window for a Rule node contains the items that are described in the following table.

Item	Description	Notes
Rule Path box	Specifies the Catalog path to the rule project that contains the rule that will be executed when the policy is executed.	You can enter the path manually, or you can browse to it by selecting the button.
Rule Class list	Specifies the class containing the specified rule.	None.
Additional sections corresponding to the inputs defined by the specified rule.	Specifies the values for the inputs defined by the rule.	You can select to specify the output of a predecessor node in this section.

A Sub Policy node is an Action node that you can use in the policy model to pass values from one policy (the calling policy) to be evaluated or acted on by a different policy (the sub policy). Results from the sub policy may be returned to the calling policy for further evaluation or action.

A sub policy can be created for commonly used policy logic to reduce policy development time and ensure consistency. It also allows large policy models to be broken down into a series of sub policies, which are easier to understand and perform better in the Policy Designer user interface.

Node Properties

The Properties window for a Sub Policy node contains items that are described in the following table:

Working with Sub Policies

You must configure the sub policy such that all the required inputs are defined as single value Point Value nodes (that is, collection inputs are not supported). Results from the sub policy may be passed back to the calling policy by using Return Value nodes. If you configure the sub policy to be executed for each row of an input collection, each output of the sub policy is a collection of values.