Family Field Descriptions | On-Premises APM

CMMS Characteristic

CMMS Characteristic records are used by the SAP Adapters to facilitate data extracts and loads to and from SAP.

This topic provides an alphabetical list and description of the fields that exist for the CMMS Characteristic. 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.


Field	Data Type	Description	Behavior and Usage
Characteristic Description	Character	The description of the characteristic (as it is defined in the SAP system).	This field is disabled.
Characteristic Name	Character	The ID of the characteristic (as it is defined in the SAP system).	On the datasheet, the value in this field is formatted as a hyperlink, which you can select to open the CMMS Characteristic by itself, outside of the context of its master CMMS Classification record. This field is disabled.
Class Group	Character	The SAP class group to which this characteristic belongs.	The value in this field is set automatically, and this field is disabled.
Classification	Character	The classification to which this characteristic belongs.	On the datasheet, the value in this field is formatted as a hyperlink, which you can select to open the CMMS Classification record representing the classification to which this characteristic belongs. This field is disabled.
CMMS System ID	Character	The ID of the SAP System from which this characteristic will be extracted.	This field is populated automatically and used internally by the APM system. This field is not available on the baseline datasheets.
Extract From CMMS System	Boolean	A value that identifies whether or not this characteristic will be extracted.	On the datasheet, you can select this check box if you want to extract this characteristic.

CMMS Classification

CMMS Classification records are available on the baseline Classification Type Classifications master-detail datasheet, the table explains how these fields behave when you are viewing CMMS Classification records in the context of this master-detail record.

This topic provides an alphabetical list and description of the fields that exist for the CMMS Classification 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.


Field	Data Type	Description	Behavior and Usage
Class Group	Character	The SAP class group to which this classification belongs.	The value in this field is set automatically, and this field is disabled.
Classification	Character	The ID of the classification (as it is defined in the SAP system).	On the datasheet, the value in this field is formatted as a hyperlink, which you can select to see all of the characteristics that belong to this classification. This field is disabled.
Classification Description	Character	The description of the classification (as it is defined in the SAP system).	This field is disabled.
CMMS System ID	Character	The value in the System ID field in the EAM System record whose Name field contains the value that is stored in the CMMS System field in this record.	This field is populated automatically and used internally by the APM system. This field is not available on the baseline datasheets.
Extract From CMMS System	Boolean	A value that identifies whether or not characteristics for this classification will be extracted from the SAP system.	On the datasheet, you can select this check box if you want to extract characteristics belonging to this classification.
Internal Classification Number	Character	This value is used internally by the APM system.	The value in this field is set automatically, and this field is disabled.

CMMS Classification Type Records

CMMS Classification Type records are used by the SAP Adapters to facilitate data extracts and loads to and from SAP.

This topic provides an alphabetical list and description of the fields that exist for the CMMS Classification Type 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.


Field	Data Type	Description	Behavior and Usage
Classification Type	Character	The item whose characteristics will be extracted.	You can select either Equipment or Functional Location. This field is required.
Classification Type Code	Character	A code assigned to the item whose characteristics will be extracted.	This field is populated based on the selection of the Classification Type field. This value is used internally by the APM system.
CMMS System	Numeric	The SAP system from which characteristics will be extracted.	The field is read-only and populated with the value in the Name field in the EAM System record whose Default EAM System field contains the value True.
CMMS System ID	Character	The value in the System ID field in the EAM System record whose Name field contains the value that you selected in CMMS System list in this CMMS Classification Type record.	This field is populated automatically and used internally by the APM system. This field does not appear on the baseline datasheets.

EAM System

EAM System records are used to store information about your systems to facilitate data extractions and loads.

When you transfer data from APM to your EAM or service management system, the APM system uses EAM System records to determine which EAM system to use.

In addition, EAM System records are used by the Equipment Adapter and the Functional Location Adapter.

This topic provides an alphabetical list and description of the fields that exist for the EAM System 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. For more information, refer to the Sites section of the documentation.


Field	Data Type	Description	Behavior and Usage
ASI Function Module Prefix	Character	ASI Function Module Prefix	The default value is '/MIAPM/'. Can be used during configurations to specify a custom set of function modules to be used instead of the product '/MIAPM/' function modules. Note: This field is not available on the datasheet.
Connection String	Character	The connection information for the system.	Note: The value of this field is for all systems that require a connection string, even though the template values contain the characters SAP. In new EAM System records, you need to delete all angle brackets and: Replace the text SAP_SERVER_IP with the IP address of the server. Replace the text SAP_SYSTEM_NUMBER with the system number. Replace the text SAP_CLIENT_NUMBER with the client number. For ServiceMax, enter the URL for the ServiceMax endpoint, for example, https://login.salesforce.com/services/oauth2/token.
Connection Type	Character	The type of connection that will be used to connect to the EAM system.	This field is available on the SAP System for RCMO datasheet, and is not enabled by default. The default and recommended value is RFC. This connection type uses a REST web service call as an intermediary between SAP and APM, thereby avoiding RFC calls directly between APM and your SAP server. Note: If necessary, you can modify the connection type to RFC Direct. Changing this value will bypass APM Connect and use a direct RFC connection when connecting your APM system and your SAP system. To modify this value, you must first enable editing on the datasheet.
Default EAM System?	Boolean	A value that indicates whether this system should be used by default when transferring data between your APM system and your system.	On the datasheet, you can select the check box to identify this system as the Default EAM System. The default EAM system is used when creating a notification from a General Recommendation when there is no technical object from which to obtain the EAM system for the creation of the notification.
ITS URL	Character	The URL to the ITS Server.	In new EAM System records, if this value is required, you will need to delete the angle brackets and replace the text its_or_integrated_its_server_url with the appropriate SAP ITS URL.
Name	Character	The name of the system.	You can enter any name, but we recommend that you enter a name in the format <SYSID>-<CLIENT>, where <SYSID> is the System ID of the system and <CLIENT> is the Client number. By doing so, the value in the Name field will match the value that will be populated automatically in the System ID field.
Password	Character	The password to the system.	The password that you enter will be encrypted and displayed as asterisks on the datasheet.
Reconnect Delay	Numeric	Specifies the delay in seconds between when a communication failure is encountered when connecting and when the system should try to connect again.	The default value is 0. Enter your unique value.
System ID	Character	The ID of the system.	This field is populated automatically after you test the connection to the system using the Test Connection link on the Associated Pages menu. Specifically, the System ID field is populated automatically with the name of the system, using the format <SYSID>-<CLIENT>, where <SYSID> is the System ID of the system and <CLIENT> is the Client number.
System Type	Character	EAM system type.	Enter the value SAP.
User ID	Character	The User ID of a user that can log in to the system.	None

Technical Characteristic

Technical Characteristics records are used to store information about your SAP Technical Characteristics to facilitate data extracts and loads to and from SAP.

This topic provides an alphabetical list and description of the fields that exist for the Technical Characteristic family and appear on the baseline EAM System datasheet. 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.


Field	Data Type	Description	Behavior and Usage
Name	Character	The name of the characteristic.	None
Value	Character	The value assigned to the characteristic.	If multiple values are assigned to a characteristic in SAP, all of those values will be displayed in the Value field, separated by commas.