Action Nodes

About Action Nodes in Family Policies

Action nodes represent actions that are performed when a policy is executed and the conditions preceding the Action node are met.

Action Nodes

Add Value to Health Indicator Nodes in Family Policies

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.

Note: You can use the Add Value to Health Indicator node only if you have the Asset Health license.

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.

Important: If you use this node in a Before Insert or After Insert policy for the Health Indicator Value family or in a Before Update or After Update policy for the Health Indicator family, make sure that the policy logic contains conditions to prevent a circular reference (that is, a scenario in which the action of the policy triggers the policy to execute continuously). The notification bar will display a warning if such a scenario is detected.

Node Properties

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


Item	Description	Notes
Health Indicator Entity Key section	Specifies the entity key of the Health Indicator record to which the new Health Indicator Value record will be linked.	You must specify a Health Indicator record without a source.
Timestamp section	Specifies the value that will populate the Timestamp field in the new Health Indicator Value record.	You can select to specify the output of a predecessor node in this section. The value in this section must be a timestamp.
Value (Numeric) section	Specifies the value that will populate the Value (Numeric) field in the new Health Indicator Value record.	You can select to specify the output of a predecessor node in this section. The value in this section must be numeric.

Tip: Refer to the Policy Designer documentation to see an example of this node.

Apply Strategy Template Nodes in Family Policies

The Apply Strategy Template node represents an action to apply an asset strategy template to an asset or asset strategy. You can use the Apply Strategy Template node to apply the asset strategy template as a copy or master to the asset or asset strategy. For more information on asset strategy and asset strategy templates, refer to the Asset Strategy Management documentation.

Note:

You can use the Apply Strategy Template node only if you have the Asset Strategy Management license.
Even if the execution of the Apply Strategy Template node is successful, the specified template is applied to the asset or asset strategy only if the policy containing the node is successfully executed.

Node Properties

The Properties window for an Apply Strategy Template node contains the fields and sections described in the following table:


Field/Section	Description	Note
Strategy Template Key	Specifies the entity key of the asset strategy record that you want to apply as a template.	None.
Asset or Strategy Key	Specifies the entity key of the asset or asset strategy record to which you want to apply the template.	None.
Select option to apply template	Specifies whether the template must be applied as a copy or master.	In this section, you can select one of the following options: Apply the template as a copy Apply the template as a master Note: By default, the Apply the template as a copy option is selected.
Select portions of template to apply	Specifies whether both actions and risks, or only the risks associated with the template must be applied to the asset or asset strategy. Note: This section is enabled only if you select Apply the template as a copy in the Select option to apply template section.	In this section, you can select one of the following options: Apply both actions and risks Apply risks only Note: By default, the Apply both actions and risks option is selected.
Select option to handle existing Asset Strategies	Specifies whether the actions and risks that are already associated with the strategy must be deleted or the items of the template that you want to apply must be appended to the existing actions and risks associated with the strategy. Note: This section is enabled only if you select Apply the template as a copy in the Select option to apply template section.	In this section, you can select one of the following options: Mark existing items for deletion Append the template items to the existing items Note: By default, the Mark existing items for deletion option is selected.

The following example illustrates how you can use a Apply Strategy Template node to apply an appropriate asset strategy template as master to every Equipment record that is added to the GE Digital APM database:

In this example, the Current Entity node represents the Equipment record that is added to the database. Based on the model of the equipment, the Query node identifies the asset strategy template that must be applied to the equipment. The Apply Strategy Template node then applies the template identified by the Query node as master to the equipment.

The Properties window for the Apply Strategy Template node described in this example is shown in the following image:

Close Event Nodes in Family Policies

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

Important: If you use this node in a Before Update or After Update policy for the Policy Event family, make sure that the policy logic contains conditions to prevent a circular reference (that is, a scenario in which the action of the policy triggers the policy to execute continuously). The notification bar will display a warning if such a scenario is detected.

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 (i.e., 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 to display the output 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.


Item	Description	Notes
Event Name section	Specifies the name of the event that you want to close.	Important: The value that you specify in this section must match the Event Name value for the corresponding Create Event node (i.e. the value in the Name field in the associated Policy Event record) in order for the event to be closed successfully. Note: If you specify the output of a predecessor node, whether the nodes match depends on the values used when the policy is executed. For example, you can specify the Event Name in the Create Event node using a field from an Entity node and specify the Event Name in the Close Event node using the output of a Case node. As long as the values used in execution match, the events will be recognized as matching.
End Time section	Specifies the timestamp that is associated with the end of the event.	This value is required. If you enter a date, you must use the correct format.
Close Description section	Specifies a description of why the event was closed.	None

Tip: Refer to the Policy Designer documentation to see an example of this node.

Create Entity Nodes in Family Policies

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

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

Important: If you use the Create Entity node in a Before Insert or After Insert policy to create a record in the same family that triggers the policy, make sure that the policy logic contains conditions to prevent a circular reference (that is, a scenario in which the action of the policy triggers the policy to execute continuously). The notification bar will display a warning if such a scenario is detected.

Node Properties

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


Item	Description	Notes
Family ID	Specifies the unique ID of the family for which you want to create a record.	The Family ID list contains all the baseline and custom entity families in GE Digital APM for which you have update privileges.
Site Key	Specifies the Site Reference Key of the site to which the new record must be assigned.	None.
Auto-map field values	Specifies whether the fields of the newly created record must be automatically populated with the values of a collection.	If the values that you want to specify for the record are part of a collection, you can use this option to specify the values for the fields of the record. If you use this option to specify the values for only some fields of the record, you must manually specify the values for the remaining fields.
Field values collection	Specifies the collection that contains the values that you want to specify for the newly created records. Note: If the collection is the result of a query, make sure the query is run in unformatted mode.	This section is enabled only when you select Yes for the Auto-map field values option. Depending on the source of the collection, the fields of the newly created records are automatically populated with the collection values in the following ways: For a collection that is created using a query, if the label of a column matches the Field ID of a field, the field in each record is populated with the corresponding value of the column. For example, if the Field ID of the Reading Taken Date field is MI_READING0_RDG_TAKEN_DT_D, the field in each record is populated with the corresponding value of the collection column whose caption is MI_READING0_RDG_TAKEN_DT_D. For a collection that is not created using a query, if the Column ID of a column matches the Field ID of a field, the field in each record is populated with the corresponding value of the column. For example, if the Field ID of the Reading Taken Date field is MI_READING0_RDG_TAKEN_DT_D, the field in each record is populated with the corresponding value of the collection column whose Column ID is MI_READING0_RDG_TAKEN_DT_D. Note: If the Field ID of a field does not match the Column ID or name of any column in the collection, the field is not populated with any value.
	Adds a new row to the Properties window.	Each newly added row represents a field in the record for which you want to specify a value. Note: If you specify a value for a field that is configured to be auto-populated from a collection, the value that you specify takes precedence over the corresponding value in the collection.
Field	Specifies the field in the newly created record for which you want to specify a value.	This list contains baseline and custom fields of the record.
Value	Specifies the new value for the corresponding field.	If a field has a complex behavior defined by the 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 during policy validation. Therefore, make sure that the values you specify are valid according to the baseline or custom field-level rules for the corresponding field. If a field value is defined by a system code, you must specify the system code in this field and not the value that is displayed to the user.

Tip: Refer to the Policy Designer documentation to see an example of this node.

Create Event Nodes in Family Policies

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.

Important: If you use this node in a Before Insert or After Insert policy for the Policy Event family, make sure that the policy logic contains conditions to prevent a circular reference (that is, a scenario in which the action of the policy triggers the policy to execute continuously). The notification bar will display a warning if such a scenario is detected.

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).

Note: You can use a corresponding Close Event node to populate the End Time and Close Description fields in the same Policy Event record when subsequent conditions indicate that the event has closed.

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.


Item	Description	Notes
Asset Key section	Specifies the entity key of the Equipment or Functional Location record that is associated with the event, (that is, the record to which the Policy Event record will be linked).	This value is required.
Event Name section	Specifies the name of the event.	This value is required. You can select to specify the output of a predecessor node in this section.
Description section	Specifies a description of the event.	You can select to specify the output of a predecessor node in this section.
Event Type list	Specifies the type of event.	You can select one of the following values: Generic : The event is not associated with a specific type of event. Excursion : The event is associated with an operation that is outside of an established operating window.
Severity list	Specifies the severity of the event.	You can select one of the following values: Information : Routine events not affecting asset health. Warning : Events indicating a low-risk or early warning of asset health issues. Alert : Events indicating a high-risk or imminent warning of asset health issues.
Start Time section	Specifies the timestamp that is associated with the beginning of the event.	This value is required. You can select to specify the output of a predecessor node in this section. If you enter a date, you must use the correct format.
End Time section	Specifies the timestamp that is associated with the end of the event.	You should only define a value in this section when the Has Duration field is set to True. Important: If the policy contains a corresponding Close Event node, you should not specify values in this section. You should specify values in the End Time section on the Properties window that is displayed for the Close Event node. You can select to specify the output of a predecessor node in this section. If you enter a date, you must use the correct format.
Close Description section	Specifies a description of why the event was closed.	Important: If the policy contains a corresponding Close Event node, you should not specify values in this section. You should specify values in the Close Description section on the Properties window that is displayed for the Close Event node. You can select to specify the output of a predecessor node in this section.
Has Duration section	Specifies whether or not there is an end time associated with the event.	You can select to specify the output of a predecessor node in this section. The value that you define must be a logical result (that is, Yes or No). Important: If the policy contains a corresponding Close Event node, you must set the value in this section to Yes.
Time Line Reset section	This field is not currently used.	None

Tip: Refer to the Policy Designer documentation to see an example of this node.

Create Production Event Nodes in Family Policies

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.

Note: You can use the Create Production Event node only if you have the Production Loss Accounting license.

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.

Important: If you use this node in a Before Insert or After Insert policy for the Production Event family, make sure that the policy logic contains conditions to prevent a circular reference (that is, a scenario in which the action of the policy triggers the policy to execute continuously). The notification bar will display a warning if such a scenario is detected.

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 to display the output 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.


Item	Description	Notes
Causing Asset Key section	Specifies the Equipment record that represents the piece of equipment that caused the event.	The Causing Asset Key value must match exactly the Entity Key of the asset that caused the event.
Description section	Specifies a detailed description of the event.	None
End Date section	Specifies the date that the event ended.	Along with the start date, the end date determines whether or not the production event will be available in the Production Event list in the Production Event workspace.
Headline section	Specifies a short description of the event.	None
Source Production Unit section	Specifies the production unit to which loss is attributed.	The created Production Event record will be automatically linked to the specified Production Unit record.
Start Date section	Specifies the date that the event started.	Along with the end date, the start date determines whether or not the production event will be available in the Production Event list in the Production Event workspace.

Note: If you add a custom field to the Production Event family, that field will also appear in the Properties window for the Create Production Event node.

Tip: Refer to the Policy Designer documentation to see an example of this node.

Create Recommendation Nodes in Family Policies

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.

Important: If you use this node in a Before Insert or After Insert policy for the Policy Recommendation family, make sure that the policy logic contains conditions to prevent a circular reference (that is, a scenario in which the action of the policy triggers the policy to execute continuously). The notification bar will display a warning if such a scenario is detected.

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 to display the output 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.


Item	Description	Notes
Associated Reference section	Specifies the Reference ID of the event or any other entity that originated the recommendation.	None
State Assignee User ID	Specifies the user that is assigned to the initial state.	The state assignee value must match exactly a valid User ID for an active Security User.
Create Work Request section	Specifies whether a work request for the EAM system that you have configured in GE Digital APM will be created from the Policy Recommendation record.	The value in this section must be a logical result (i.e., Yes or No).
Equipment ID section	The Record ID of the Equipment record to which the Policy Recommendation record will be linked.	You do not need to specify a value in both the Equipment ID and Functional Location ID sections. If you specify a value in either section, the GE Digital APM system will automatically create relationships between the related Equipment, Functional Location, and Recommendation records. However, if you do specify values in both sections, they must correspond to the same asset.
Event Start Date section	Specifies the timestamp that is associated with the beginning of the event for which the Policy Recommendation record is created.	If you enter a date, you must use the correct format.
Functional Location ID section	The Record ID of the Functional Location record to which the Policy Recommendation record will be linked.	You do not need to specify a value in both the Equipment ID and Functional Location ID sections. If you specify a value in either section, the GE Digital APM system will automatically create relationships between the related Equipment, Functional Location, and Recommendation records. However, if you do specify values in both sections, they must correspond to the same asset.
Recommendation Headline section	A short description of the recommended action.	None
Recommendation Priority section	Specifies a priority value used to rank the importance of the recommendation.	The value you specify must be valid according to any field-level rules that you have specified for the Recommendation Priority field.
Target Completion Date	The date by which the recommended action should be completed.	This value is required. If you enter a date, you must use the correct format.

Note: If you add a custom field to the Policy Recommendation family, that field will also appear in the Properties window for the Create Recommendation node.

Tip: Refer to the Policy Designer documentation to see an example of this node.

Create Relationship Nodes in Family Policies

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.

Important:

In a Before Insert policy, you cannot use the Create Relationship node to create a relationship between the record that triggers the policy and the records that will be created due to the execution of the policy.
In a Before Insert or After Insert policy, if you use this node to create a record in the same family that triggers the policy, make sure that the policy logic contains conditions to prevent a circular reference (that is, a scenario in which the action of the policy triggers the policy to execute continuously). The notification bar will display a warning if such a scenario is detected.

Node Properties

The Properties window for a Create 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 Create Relationship node will create.	The Family ID list contains all the baseline and custom relationship families in GE Digital APM for which you have insert privileges.
Predecessor Entity Key(s) section	Specifies the keys of the predecessor entity records in the relationship.	You can create relationships in the following ways 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. Multiple one-to-one relationships: Specify the same number of keys in each section. A relationship will be added between each pair of keys. One-to-many relationship: Specify a key in one section and multiple keys in the other section. In each section, you can select to display the output of a predecessor node. Tip: You can specify the Entity Key output of an action node that creates records (such as the Create Entity node) to use the newly created records as either the predecessors or successors of a relationship. However, in a Before Insert policy, you cannot create a relationship between the records that will be created by the Action node and the record that is configured to trigger the policy. Relationships will not be created in the following scenarios: If the relationship you specify already exists. If no relationship definition is defined for the records you specify. When attempting to create multiple one-to-one relationships, if the number of keys in each section do not match.
Successor Entity Key(s) section	Specifies the keys of the successor entity records in the relationship.

Tip: Click here to see an example of this node used within a complete policy model.

Delete Entity Nodes in Family Policies

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.

Important: In a Before Update, Before Insert, Before Delete, or After Delete policy, it is not valid to use this node to delete the record that triggered the policy (i.e., the record represented by the Current Entity node).

Node Properties

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


Item	Description	Notes
Entity Key(s) section	Specifies the entity key(s) of the record(s) that will be deleted.	You can select to specify the output of a predecessor node in this section. If you specify multiple records to be deleted at the same time, they do not have to be in the same family.

Delete Relationship Nodes in Family Policies

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

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 to display the output 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.

Tip: Click here to see an example of this node used within a complete policy model.

Edit Entity Nodes in Family Policies

An Edit Entity node represents an action to modify a record of a baseline or custom entity family. The fields in the specified record are updated with the values that you specify in the Properties window for the node. The fields for which you do not specify any value in the Properties window are not modified.

Important:

If you use the Create Entity node in a Before Update or After Update policy to modify a record of the same family that triggers the policy, make sure that the policy logic contains conditions to prevent a circular reference (that is, a scenario in which the action of the policy triggers the policy to execute continuously). The notification bar will display a warning if such a scenario is detected.
In a Before Delete or After Delete policy, it is not valid to use this node to modify the record that triggered the policy (that is, the record represented by the Current Entity node).

Node Properties

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


Item	Description	Notes
Family ID	Specifies the unique ID of the family associated with the record that must be modified.	The Family ID list contains all the baseline and custom entity families in GE Digital APM for which you have update privileges.
Entity Key(s)	Specifies the entity key of the record that must be modified.	The entity keys that you specify must belong to the family selected in the Family ID list. Note: If no entity keys are passed to the node during execution, a warning message appears.
Auto-map field values	Specifies whether the field values for the records must be automatically updated from a collection.	If the values that you want to specify for the record are part of a collection, you can use this option to specify the values for the fields of the record. If you use this option to specify the values for only some fields of the record, you must manually specify the values for the remaining fields.
Entity Key Column	Specifies the collection column that contains the entity keys of the records that you want to modify. Note: If you mapped the field values collection from an R Script node or a Sub Policy node, no values are available for selection in this drop-down list box.	This section is enabled only when you select Yes for the Auto-map field values option. Depending on the value that you specify in this drop-down list box, the records are modified as follows: If any value in the specified entity key column of the field values collection matches an entity key specified in the Entity Key(s) section, the record associated with the entity key is automatically updated with the values in the collection row corresponding to the entity key. If the values in the specified entity key column of the field values collection do not match any entity key specified in the Entity Key(s) section, the records are not modified. If you do not select a value in this drop-down list box and if the field values collection contains a column with the name `ENTY_KEY`, the values of the ENTY_KEY column are compared with the entity keys specified in the Entity Key(s) section, and the associated records are updated accordingly. If the collection has only a single row, all records associated with the entity keys specified in the Entity Key(s) section are updated with the values in that row.
	Adds a new row to the Properties window.	Each row represents a field that you want to update in the record. Note: If you specify a value for a field that is configured to be updated from a collection, the value that you specify takes precedence over the corresponding value in the collection.
Field	Specifies a field that you want to update in the record.	This list contains both baseline and custom fields of the record.
Value	Specifies the new value for the corresponding field.	If a field has a complex behavior defined by the 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 during policy validation. Therefore, make sure that the values you specify are valid according to the baseline or custom field-level rules for the corresponding field. If a field value is defined by a system code, you must specify the system code in this field and not the value that is displayed to the user. Note: Irrespective of the Unit of Measure (UOM) Conversion Set configured for your user account, the value that you specify in this field is considered to be in the base UOM of the field.

In this example, the following queries are used:

LR Entity Keys Query: Returns the Entity Keys of the Lubrication Requirement records related to the Lubrication Requirement Template.
LRT Fields Query: Returns the current values in some fields of the Lubrication Requirement Template record specified in a policy instance. The Column IDs in the query are defined to match the Field IDs of the Lubrication Requirement family.

As shown in the following image of the Properties window for the Edit Entity node, the results of the LR Entity Keys Query provide the entity keys of the Lubrication Requirement records that will be updated. The node is additionally configured to automatically update the fields of the Lubrication Requirement records with the results of the LRT Fields Query. No field values are specified in addition to the values to be updated from the LRT Fields Query.

On executing this policy, all Lubrication Requirements related to the Lubrication Requirement Template that is specified in the policy instance are updated with the new values from the Lubrication Requirement Template record.

Email Contact Nodes in Family Policies

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.


Item	Description	Notes
To Address section	The email address(es) to which the message should be sent.	You can select to specify the output of a predecessor node in this section. When you specify a constant value, you can enter one or more email addresses directly in the text box, or you can select the button to select a recipient via the Choose Users window. If you enter more than one email address in the text box, each email address must be separated by a comma or semicolon.
Message section	Content that you want to include in the email message in addition to the summary of the policy execution (which is always included automatically).	You can select to specify the output of a predecessor node in this section.

Tip: Click here to see an example of this node used within a complete policy model.

Return Value Nodes in Family Policies

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.

Note: The name that you specify for a Return Value node should be unique unless the policy logic is configured such that only one Return Value node with a given name can be executed each time that the policy is executed.

Node Properties

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


Item	Description	Notes
Return Value section	Specifies the value that you want to return.	You can select to specify the output of a predecessor node in this section.

Tip: Refer to the Policy Designer documentation to see an example of this node.

Rule Nodes in Family Policies

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.

Important: The improper implementation of a rule through the Rule node could severely impact the performance of policy executions. If you want to use this node, you should contact GE Digital for additional instructions and assistance.

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.

Sub Policy Nodes in Family Policies

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 Family Policy user interface.

Note: You can configure a Sub Policy node to pass values to only those policies for which you have Designer or User permissions.

Node Properties

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


Item	Description	Note
Policy	Name of the sub policy to call.	None.
Iterate Over Collection?	Specifies whether the sub policy must be executed for each row in a collection that is used as an input for the node.	None.
Execute Specific Instance?	Specifies whether a specific instance associated with the sub policy must be executed.	If you select Yes, in the Instance Id box that appears, you can specify the name of the sub policy instance that you want to be executed.
Additional sections corresponding to the inputs defined by the Point Value nodes contained in the sub policy.	Specifies the values to be represented by the Point Value nodes in the sub policy.	A Point Value node in the sub policy can represent a single value. If the Sub Policy node is configured to iterate the execution of the associated sub policy, you can specify a column of an input collection as the input for a Point Value node in the sub policy.

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.

Important:

Make sure that the sub policies called by a policy are active. If a sub policy is inactive, a message appears in the notification bar and the calling policy cannot be activated.
Changes to Point Value or Return Value nodes, or the name of a sub policy will not be automatically reflected in calling policies that use the sub policy. It is possible to specify additional security for a sub policy to minimize the inadvertent impact to other policies.
While it is possible for a sub policy to act as a calling policy for another sub policy, it is essential that a circular execution path is not created. In other words, if policy A calls policy B, which calls policy C, then policy C must not call policy A or policy B. If such a circular execution path is detected while you are editing the policy, a message appears in the notification bar. However, a circular execution path where the sub policy acts on the same entity or relationship that triggers the calling policy is not detected and no message appears in the notification bar. Make sure that such a circular execution path is not created in a policy.
If an error occurs during the execution of a sub policy, execution of the calling policy fails, irrespective of the execution status of other sub policies called by the policy.
If a Return Value node in a sub policy represents a collection, other nodes in the calling policy model that use the output of the Sub Policy node cannot process the values in the columns of the collection.

Sub Policy Node Execution Details

After you validate or execute a policy that contains a Sub Policy node, you can select the Sub Policy node to view the execution details of the node in the Node Execution Details window. Along with viewing the execution details of the node, you can select the View Execution Details link in the Node Execution Details window to view the policy model and execution details of the sub policy that is mapped to the node.

The following image is an example of the Node Execution Details window for a Sub Policy node:

The following image is an example of the Sub policy execution details for policy window that appears when you select the View Execution Details link in the Node Execution Details window for a Sub Policy node:

Sub Policy Node Configured for Single Execution

The following is an example of how a Sub Policy node can be used to implement a standard calculation method which could be applied in any number of other policies. Consider the following nodes and connections:

In this example, the latest reading values from two measurement locations and a constant value are passed into a sub policy, which calculates a value to be used in the Email node. The Properties window for the Sub Policy node is shown in the following image:

The sub policy used in the above example includes Is Null nodes which provide default values to be used if the calling policy does not supply an input value, as shown in the following image:

Sub Policy Node Configured for Iterated Execution

The following is an example of how a Sub Policy node can be used to add a collection of calculated values to a health indicator.

In this example, the Collection Filter nodes are used to filter the readings that are taken for the last two days from two Measurement Location nodes. An Entity node is used to define the health indicator record to which the readings must be added. The collections of readings and time stamps are passed to the sub policy and a single health indicator entity key value is used for each iteration of the sub policy. Each execution of the sub policy calculates a new value based on the readings from the two measurement locations and updates it to the health indicator. The following image shows the Properties window for the Sub Policy node:

The following image shows the sub policy used in the above example:

The sub policy contains four Point Value input nodes. The Reading Value 1, Reading Value 2, and Health Indicator Key Point Value nodes are configured to represent Decimal data type values, and the Reading Date/Time node is configured to represent a Time & Date data type value. Even though the calling policy is configured to pass a collection of values, each iteration of the sub policy will use a single value from each input collection.

The values represented by the Reading Value 1, Reading Value 2 nodes are passed to a Math node which calculates a new value to be written to the health indicator by the Add Value to Health Indicator node. The Return Value node is configured to return the single value output from the Math node. In the calling policy, the corresponding output from the Sub Policy node is a collection made up of the results from each iteration of the sub policy.