Family Field Descriptions | On-Premises APM

API Node Credential Records

API Node Credential records store information about user credentials that can be used by the policy execution service when executing an API. The following table provides an alphabetical list and description of the fields that exist in the API Node Credential family. The information in the table reflects the baseline state and behavior of these fields.

This family is enabled for site filtering, which means that records in this family can be assigned to a specific site and will only be accessible to users who are assigned to the same site and have the appropriate license and family privileges. For more information, refer to the Sites section of the documentation.

By default, this family is configured to be excluded from global search and to use Rules.


Field	Data Type	Description	Behavior and Usage
Authentication Type	Character	The authentication method to be used when executing an API node.
Display Name	Character	The display name of the user credential.	This value is displayed in the API Node Settings window in Policy Designer. A value is required and must be unique.
GUID	Character	The unvarying unique identifier for the record. It is used to identify the API user in the policy model.	This field is populated automatically.
User ID	Character	The user ID to be used when executing an API Node.

Policy Records

Policy records store basic information about policies. The following table provides an alphabetical list and description of the fields that exist in the Policy family and that are displayed on the baseline Policy datasheet (unless otherwise noted). The information in the table reflects the baseline state and behavior of these fields. This list is not comprehensive.

This family is not enabled for site filtering, which means that records in this family can be accessed by any user with the appropriate license and family privileges. See the Site Filtering section of the documentation for more information.

By default, this family is configured to be included in global search and to use Rules.

Note: The values in Policy records cannot be modified in Record Manager.


Field	Data Type	Description	Field Behavior and Usage
Active	Boolean	Indicates whether the policy is active or inactive.	Reflects the selection of the activate/deactivate policy button in the Details workspace.
Automatic Evaluation	Boolean	Indicates whether the policy logic will be executed automatically when records belonging to the policy instance are modified.	Reflects the selection in the Automatic Execution check box in the Details workspace.
Description	Text	A brief summary of the policy.	Contains the value that you enter in the Description box on the Details workspace.
Execution History Setting	Character	Defines how the execution history is recorded for the policy.	Reflects the selection in the Execution History option in the Details workspace. The field is populated with the value Normal, by default.
Last Policy Model Change Date	Date and Time	Date and time when the policy model was last updated.	This field is populated automatically with the current date and time when you save the policy only if the policy model has been substantively modified. If you modify the layout of the nodes on the canvas but do not make any other changes to the model, or you modify the name, description, schedule, or other settings of the policy, this field is not updated.
Model	Text	Code defining the logic that is represented by the policy model.	This field is populated automatically and does not appear on the Policy datasheet.
Module Workflow Policy	Character	Module Identifier	This field is used to determine whether the policy is a Module Workflow Policy for purposes of the Policy Designer Overview page. The value in this field indicates the product module in which the policy is used. It does not appear on the Policy datasheet.
Last Scheduled Execution	Date and Time	Last scheduled execution date and time	If the policy is scheduled, this field contains the date and time at which the policy was last scheduled to execute.
Name	Character	The name of the policy.	Contains the value that you specify in the Name box in the Details workspace. This field is required, and the value must be unique.
Next Scheduled Execution		Next scheduled execution date and time	If the policy is scheduled, this field contains the date and time at which the policy is next scheduled to execute.
Owner	Character	The owner of the policy.	Contains the policy owner that appears at the top of the Details workspace. Only the owner of the policy can save changes to the policy. This field is required. This field is configured to track revision history by default. You can look at the revision history for this field to determine the ownership history for a particular policy.
Schedule	Character	Code defining the policy's schedule.	This field is populated automatically and does not appear on the Policy datasheet.
Schedule Executed	Boolean	Indicates whether the currently configured schedule has executed at least once.	This field is populated automatically and does not appear on the Policy datasheet.
Scheduled	Boolean	Indicates whether the policy has a defined execution schedule.	Populated automatically.
Time Zone	Character	The time zone associated with the policy.	Contains the value that you specify in the Time Zone list in the Details workspace. This field contains the value (UTC) Coordinated Universal Time by default.
Upgrade Log	Text	The log of upgrade steps that are applied to the policy model.	If your APM database has been upgraded from an earlier version to V5.0.0.0.0 or later versions, this field contains a record of the upgrade steps that were applied to the policy model to accommodate data model changes in V5.0.0.0.0.or a later release. This field does not appear on the Policy datasheet. Review the upgrade log information to identify any issues that need to be corrected manually once the upgrade is complete.

Policy Instance Records

Policy Instance records store information about policy instances that are associated with a policy. The following table provides an alphabetical list and description of the fields that exist in the Policy Instance family. The information in the table reflects the baseline state and behavior of these fields.

This family is not enabled for site filtering, which means that records in this family can be accessed by any user with the appropriate license and family privileges. See the Site Filtering section of the documentation for more information.

By default, this family is configured to be excluded from global search and to use Rules.

Note: The values in Policy Instance records cannot be modified in Record Manager. You must update the instance in the Policy Designer module in order to change values in the record.


Field	Data Type	Description	Behavior and Usage
Active	Logical	Indicates whether the instance is active or inactive.	Reflects the selection of the activate/deactivate policy instance button in the Instances pane.
ID	Character	The name of the instance.	Populated automatically with the value that you enter in the Instance box in the Instances pane.
Mapping	Text	Contains code that maps values from records belonging to the policy instance to the nodes in the associated policy model.	This field is disabled and does not appear in the Policy Instance datasheet.
Policy Key	Character	The entity key of the associated policy record.	This field is disabled and does not appear in the Policy Instance datasheet.

Policy Event Records

Policy Event records store information about events that are associated with Equipment or Functional Location records that are monitored by a policy. The following table provides an alphabetical list and description of the fields that exist in the Policy Event family and that are displayed on the baseline Policy Event datasheet (unless otherwise noted). The information in the table reflects the baseline state and behavior of these fields. This list is not comprehensive.

This family is enabled for site filtering, which means that records in this family can be assigned to a specific site and will then only be accessible to users who are assigned to the same site and have the appropriate license and family privileges. See the Site Filtering section of the documentation for more information on using this feature.

By default, this family is configured to be excluded from global search and to use Rules.


Field	Data Type	Description	Behavior and Usage
Close Description	Text	A description of why the event was closed.	Populated automatically based on the properties defined for the associated Create Event or Close Event node.
Description	Text	A description of the event.	Populated automatically based on the properties defined for the associated Create Event node.
End Time	Date	The date on which the event ended.	Populated automatically based on the properties defined for the associated Create Event or Close Event node. This field is used only when the Has Duration field is set to True.
Event Type	Character	The type of event.	Populated automatically based on the properties defined for the associated Create Event node.
Has Duration	Logical	Indicates whether or not there is an end time associated with the event.	Populated automatically based on the properties defined for the associated Create Event node.
Name	Character	The name of the event.	Populated automatically based on the properties defined for the associated Create Event node. In the Execution History pane, this value will appear as a hyperlink that you can select to access the Events section in Asset Health Manager.
Policy Instance Key	Character	The entity key of the associated policy instance record.	In the Policy Event datasheet, this field is labeled Link to Policy and contains a link to the policy that created the Policy Event record.
Severity	Character	The severity of the event.	Populated automatically based on the properties defined for the associated Create Event node.
Start Time	Date	The date on which the event started.	Populated automatically based on the properties defined for the associated Create Event node.
Time Line Reset	Logical	This field is not currently used.	N/A

Policy Recommendation Records

Policy Recommendation records store basic information about recommendations that have been created as a result of a policy. The following table provides an alphabetical list and description of some of the fields that exist in the Policy Recommendation family. The information in the table reflects the baseline state and behavior of these fields. This list is not comprehensive.

This family is enabled for site filtering, which means that records in this family can be assigned to a specific site and will only be accessible to users who are assigned to the same site and have the appropriate license and family privileges. For more information, refer to the Sites section of the documentation.

By default, this family is configured to be included in global search and to use Rules.

Note: Email notifications are not provided for Policy Recommendations that are overdue or require re-evaluation.


Field	Data Type	Description	Behavior and Usage
Associated Reference	Character	The Reference ID of the event or any other entity that originated the recommendation.	Populated automatically based on the properties defined for the associated Create Recommendation node.
Completed Date	Date	The date on which the recommended action was completed.	You can use the Calendar feature to select the date on which the recommended action was completed.
Completion Comments	Text	Details about the completed recommendation.	You can enter a value manually.
Create Work Request?	Boolean	Specifies whether a work request for the EAM system that you have configured in APM will be created from the Policy Recommendation record.	Populated automatically based on the properties defined for the associated Create Recommendation node.
Equipment ID	Character	The Record ID of the Equipment record to which the Policy Recommendation record is linked.	Populated automatically based on the properties defined for the associated Create Recommendation node. -or- Populated automatically with the Record ID of the Equipment record that is linked to the Functional Location record identified by the value in the Functional Location ID field.
Functional Location ID	Character	The Record ID of the Functional Location record to which the Policy Recommendation record is linked.	Populated automatically based on the properties defined for the associated Create Recommendation node. -or- Populated automatically with the Record ID of the Functional Location record that is linked to the Equipment record identified by the value in the Equipment ID field.
Recommendation Basis	Character	The policy that created the recommendation.	Populated automatically with the name of the Policy record to which the Policy Recommendation record is linked. This field does not appear on the Policy Recommendation datasheet.
Recommendation Description	Text	Information about the policy logic that caused the Policy Recommendation record to be created.	Populated automatically.
Recommendation Headline	Character	A short description of the recommended action.	Populated automatically based on the properties defined for the associated Create Recommendation node.
Recommendation ID	Character	A unique value that identifies the Policy Recommendation record.	Populated automatically when the recommendation is created.
Recommendation Priority	Character	The priority value used to rank the importance of the recommendation.	Populated automatically based on the properties defined for the associated Create Recommendation node.
Recommendation Type	Character	The type of recommendation record.	Populated automatically with the value Policy (PCY). This field does not appear on the Policy Recommendation datasheet.
Target Completion Date	Date	The date by which the recommended action should be completed.	Populated automatically based on the properties defined for the associated Create Recommendation node. This field is required.
Work Request Equipment	Character	The ID of the EAM system Equipment that is associated with the work request that was created from this Policy Recommendation record.	Populated automatically when the work request is created.
Work Request Functional Location	Character	The ID of the EAM system Functional Location that is associated with the work request that was created from this Policy Recommendation record.	Populated automatically when the work request is created.
Work Request Reference	Character	The ID of the EAM system work request that was created from this Policy Recommendation record.	Populated automatically when the work request is created.