General Reference

SAP Transactions-Quick Reference

The following table provides a list of SAP transactions and their functions.

This transaction:	...Lets you:
/n/MIAPM/MIPRO	View a list of GE Digital APM-specific steps that can be performed in SAP.
/n/MIAPM/MANAGE_PARAMS	Access and manage the /MIAPM/PARAMS table.
/n/MIAPM/MANAGE_TSKCNF	Access the /MIAPM/TASK_CNF table.
SM37	Check the status of a background process.
IW43	Validate SAP Confirmations against that data in GE Digital APM Confirmation records.

Requirements

SAP System Requirements

SAP Backend System: The following versions are supported:
- SAP ECC 6.0 (Enhancement Packs [EhP] 1 and above)
- S/4 Hana (1511, 1610, 1709, and 1809)
SAP Database: A database that contains the SAP data model and data.
SAP Internet Transaction Server (ITS): Version 6.20 or higher.
SAP Java Connector Files (SAP JCO) downloaded from the SAP marketplace, which contains the following files:
- sapjco.dll
- sapjco3.dll
- sapjco3.jar

SAP PI System Requirements

SAP Backend System: The following versions are supported:
- SAP ECC 6.0 (Enhancement Packs [EhP] 1 and above)
- S/4 Hana (1511, 1610, 1709, and 1809)
SAP PI: An SAP PI system 7.00 and above, up to SAP PI/PO 7.50.

APM Connect User Profile Requirements

To successfully extract data from SAP, APM Connect needs authority objects, access to RFCs, and access to SAP Tables.

Authority Objects Required

APM Connect must have the authority objects listed.

Authorization Object	Description
C_TCLA_BKA	Authorization for Class Types
I_AUART	PM: Order Type
I_BERG	PM: Authorization Group
I_BETRVORG	PM: Business Operation
I_INGRP	PM: Maintenance Planner Group
I_KOSTL	PM: Cost Centers
I_QMEL	PM/QM: Notification Types
I_SWERK	PM: Maintenance Plant
I_WERK	PM: Maintenance Planning Plant
S_BTCH_JOB	Background Processing: Operations
S_DATASET	Authorization for File Access
S_LOG_COM	Required if file transfer is SFTP/SCP. For server mode this authorization is not required.
S_RFC	Authorization Check for RFC Access
S_TABU_NAM	Table Access with Generic Standard

RFCs Required

APM Connect must have access to the RFCs listed in the following table.

/MIAPM/*	RFC_GET_FUNCTION_INTERFACE	SYSTEM_RESET_RFC_SERVER
CLAF_CLASSIFICATION_OF_OBJECTS	RFCPING
DDIF_FIELDINFO_GET	SYSTEM_RESET_RFC_CONNECTION

SAP Tables Required

APM Connect must have access to the tables listed in the following table.

/MIAPM/*	COVP	INOB	PLPO	T024I	TCURR
AFVV	CRHD	JEST	PMCO	T350	T499S
AFKO	CRTX	JSTO	PRPS	T352B_T	TGSBT
AFRU	CSKT	KLAH	QMEL	T353I_T	TJ02T
AFVC	CVERS	KSML	QMFE	T356_T	TJ30T
AFVV	EAPL	KSSK	QMMA	T357	TKA01
AUSP	EQBS	MAKT	QMUR	T357A_T	TQ80
BGMKOBJ	EQKT	MHIS	QPCT	T357M_T	TQ80_T
CABN	EQUI	MHIO	SWOR	T370C_T	VIAUFKST
CABNT	EQUZ	MMPT	T001	T370F_T	VIQMEL
CAWN	IFLO	MPLA	T001W	T370U	VIMPLA
CAWNT	IFLOS	OBJK	T003P	TAPL	VIMPOS
COBK	IFLOT	PLAS	T006	TCLA
COEP	ILOA	PLKO	T006A	TCURC

SAP Interfaces Security Groups

The following table lists the baseline Security Groups available for users within this module, as well as the baseline Roles to which those Security Groups are assigned. In GE Digital APM GE Digital APM, Roles are assigned to Security Users through permission sets.

Important: Assigning a Security User to a Role grants that user the privileges associated with all of the Security Groups that are assigned to that Role. To avoid granting a Security User unintended privileges, before assigning a Security User to a Role, be sure to review all of the privileges associated with the Security Groups assigned to that Role. Also, be aware that additional Roles, as well as Security Groups assigned to existing Roles, can be added via Security Manager.

Security Group	Roles
MI SAP Interface Administrator	None
MI SAP Interface User	None

The baseline family-level privileges that exist for these Security Groups are summarized in the following table.

Family	MI SAP Interface Administrator	MI SAP Interface User
Entity Family
Confirmation	View, Update, Insert, Delete	View, Update, Insert
Equipment	View, Update, Insert, Delete	View, Update, Insert
Functional Location	View, Update, Insert, Delete	View, Update, Insert
SAP System	View, Update, Insert, Delete	View
Site Reference	View	View
Work History	View, Update, Insert, Delete	View, Update, Insert
Work History Detail	View, Update, Insert, Delete	View, Update, Insert
Relationship Families
Equipment Has Equipment	View, Update, Insert, Delete	View, Update, Insert, Delete
Functional Location Has Equipment	View, Update, Insert, Delete	View, Update, Insert, Delete
Functional Location Has Functional Location(s)	View, Update, Insert, Delete	View, Update, Insert, Delete
Has Confirmation	View, Update, Insert, Delete	View, Update, Insert, Delete
Has Event Detail	View, Update, Insert, Delete	View, Update, Insert, Delete
Has SAP System	View, Update, Insert, Delete	View, Update, Insert, Delete
Has Work History	View, Update, Insert, Delete	View, Update, Insert, Delete
User Assignment	View, Update, Insert, Delete	View, Update, Insert, Delete

About Site Filtering Configuration via the autojoin_control Table

Site Reference values are managed in the Intermediate Repository, specifically in the autojoin_control table as shown in the following image.

About the Baseline Site Reference Configuration

The baseline configuration of the SAP Adapters uses the SAP System to determine the site to which a record should be assigned. More specifically, the value in the site_reference column in the autojoin_control table is #MI_FNCLOCOO_SAP_SYSTEM_C# for Functional Location records and #MI_EQUIPOO_SAP_SYSTEM_C# for Equipment records.

Additionally, if SAP System value is null or empty on a record in SAP, once transferred into GE Digital APM, it will be assign the site reference defined in the defaut_site_reference column in the autojoin_control table. The default value is *Global*.

If you want to use your SAP System as the site for all records transferred from SAP to APM then no additional configuration is needed. However, if necessary, you can configure different site reference values.

Important: A Site Reference record corresponding to your SAP System(s) must exist in GE Digital APM before you can transfer records.

About the autojoin_control Table

You can specify site references using the autojoin_control table. The columns in this table are described in the following table.

Column	Description
AUTOJOIN_ID	Surrogate ID used to uniquely identify a row; i.e., the primary key.
BATCH_NAME	When a load is processed, queries defined in this table are run together in batches. All queries with the same BATCH_NAME are executed together.
TABLE_NAME	The name of the temporary table that will be created for this row. This name will be concatenated by the load UUID.
SQL_EXECUTION_ORDER	Within a batch, the value in this column defines the order in which the SQL statements will be executed. Lower numbers will be executed first.
SQL	The SQL SELECT statement to be executed. The results of this statement will be copied to the temporary table defined by the load UUID and the TABLE_NAME column. Columns defined in the SELECT statement should match exactly the column names in the GE Digital APM family for which data is being loaded.
SITE_REFERENCE	This column specifies the value to use for the corresponding record's Site Reference Key. This can be a direct site reference (i.e., a specific site reference name) or it can contain an indirect site reference (i.e., a field that contains the site reference name to use). See the topic Configure Site Reference Values for details. Note: The baseline value is `#MI_FNCLOCOO_SAP_SYSTEM_C#` for Functional Location records and `#MI_EQUIPOO_SAP_SYSTEM_C#` for Equipment records. This means the SAP System will determine to which site records are assigned.
APM_SITE_REFERENCE_COLUMN	The GE Digital APM column used to store Site Reference values. Unless you have customized the GE Digital APM database, this value should be `MI_SITE_NAME`.
APM_SITE_REFERENCE_FAMILY	The GE Digital APM family to which the site reference will be applied. When the relationship is being built within the records of the same entity, the value is <PRED_FAMILY_ID>. Unless you have customized the GE Digital APM database, you do not need to modify this value.
USE_RELATIONSHIP_LOOKUP	This column specifies whether the row is for an entity or relationship. If this row is populating a relationship, the value should be 1. If not, the value should be 0. This affects the way relationship references are defined in the resulting SQL statements.
DEFAULT_SITE_REFERENCE	If an indirect site reference is specified, this value defines the Site Reference Key that should be used if the value in the specified indirect site reference column is NULL. Enter `Global` to assign the site as global Enter the name of a site to assign records to that site.

About File Shares and APM Connect

File shares mounted in the APM Connect architecture allow you to read and write files between servers within your architecture configuration.

File Mount Configurations

If you are using SAP PI, create a file share on your APM Connect server, and then mount it to your SAP PI server. Then, create a share on your SAP server, and then mount to your SAP PI Server. Similarly, if you are not using SAP PI, or you are bypassing your SAP PI server, you must create a file share on your APM Connect server, and then mount it to your SAP Server.

Note: The SAP PI Adapters determine if SAP PI server will be used via the FILE_MOVE_USE_PI parameter in the context file. If the parameter is true, then SAP PI will be used to copy files from your SAP server to your APM Connect server. If it is false, SAP PI will not be used to copy files from your SAP server to your APM Connect sever. In both configurations however, the SAP PI server will be used to proxy RFC calls.

Additionally, in the most common architecture, the APM Connect server is hosted on a Windows Sever with the SAP server and the SAP PI server hosed on a Linux server. The following diagrams details the recommended configurations.

User’s Permissions for File Shares

When using a shared file system to facilitate data extraction from SAP to APM Connect, you will need to grant the service account user(s) the appropriate permissions to access both systems.

Note: Using active directory to manage the service account is recommended.

The volume to be mounted can be in three configurations: NAS/SAN, Windows, or Unix. Additionally, access control could be different for each configuration, as shown in the following table:

Tip: When the shares are created and permissions configured correctly, run the equipment job for a single equipment ID. This is a quick and easy way to check that permissions are set up correctly. After you run the job, a file will be created using the SAP service account, then opened and read by the APM Connect system.

Volume (Disk, Share, LUN)	Access Control
NAS/SAN	Vendor specific user mapping (i.e. NetApp), or active directory integrations.
Windows	Users/Groups permissions are defined in Active Directory.
Unix	Active Directory integration, or user maps (i.e. Samba or Config).

About Classification Hierarchies

In SAP, for any given class, multiple characteristics can be inherited from another class.

For example, consider the following SAP classes:

EQ_CLASS_0001
Fasteners
Bolts
Hexagonal Bolt

As shown in the following image, EQ_CLASS_0001 has four unique characteristics:

As shown in the following image, Fasteners also has four sets of unique characteristics:

Bolts, however, inherits all of the characteristics from EQ_CLASS_0001 and FASTENERS. In addition, Bolts has two unique characteristics of its own: HEAD_SHAPE and BOLT_TYPE:

Finally, Hexagonal Bolt also inherits all of the characteristics from EQ_CLASS_0001, FASTENERS, and BOLTS. It also has one unique characteristic of its own: TOLERANCE:

Using these SAP classes, in GE Digital APM system, if you were to select the Extract From CMMS System check box for the HEXAGONALBOLT class, after selecting the Synchronize Characteristics link while viewing the HEXAGONALBOLT CMMS Classification record, the following CMMS Characteristic records would be created automatically:

As you can see from the Classification column, some of the characteristics are inherited from other classes:

Specifically, you can see that:

The following characteristics are inherited from the class EQ_CLASS_0001:
- COLOR
- LOCAL_REG_NUM
- OPH
- SAP_EHS_1017_003_TEST_TYPE
The following characteristics are inherited from the class FASTENERS:
- FASTENER_DIAMETER
- LENGTH
- NUMBEROFTHREADS
- THREAD_TYPE
The following characteristics are inherited from the class BOLTS:
- HEAD_SHAPE
- BOLT_TYPE
The characteristic TOLERANCE is assigned directly to the class HEXAGONALBOLT (no highlighting).

If you selected the Extract From CMMS System check boxes for all of these characteristics, if you were to run the Equipment Characteristics Extraction Interface without filters, all of these characteristics would be extracted.

If, however, you were to filter the report to extract only characteristics belonging to the HEXAGONALBOLT class, only characteristics that are assigned directly at the HEXAGONALBOLT level would be extracted. In other words, because only TOLERANCE is assigned directly to HEXAGONALBOLT, only the TOLERANCE characteristic would be extracted.

About Extracting Characteristics

When you create CMMS Classification Type records using the CMMS System list, you must select the SAP system from which you want to extract characteristics belonging to that classification type.

Note: If you using SAP PI, Classification and Characteristic synchronization are not supported.

The CMMS System list displays the values in the Name field in all existing EAM System records. When you save the CMMS Classification Type record, the GE Digital APM system finds the EAM System record whose Name field contains the selected value, and the value in the System ID field in that EAM System record is copied to the CMMS System ID field in the CMMS Classification Type record.

Then, when you create CMMS Classification or CMMS Characteristic records that are associated with that CMMS Classification Type record, the value in the CMMS System ID field in the CMMS Classification Type record is copied automatically to the CMMS System ID field in those records.

CMMS Characteristic records are created automatically and linked to the CMMS Classification record. Each CMMS Characteristic record is created from a characteristic that currently exists in the specified SAP system (using the CMMS System field in the CMMS Classification record). The CMMS Characteristic records are displayed in a grid on the CMMS Classification datasheet.

Note: The System ID field is available on the baseline EAM System datasheet, but the CMMS System ID field is not available on the baseline CMMS Classification Type, CMMS Classification, or CMMS Characteristic datasheets.

When you run the Equipment Characteristic Extraction Interface or the Functional Location Characteristic Extraction Interface, GE Digital APM needs to determine which specific characteristics to extract from that system. To do so, it evaluates the CMMS Characteristic records that exist in your GE Digital APM database. If it finds any CMMS Characteristic records whose CMMS System ID field value identifies the SAP system from which you are running the interface, it will extract only those characteristics from that SAP system (assuming that the Extract from CMMS System check box is selected in the CMMS Characteristic record).

About Site Filtering Configuration in the Context File

The EAM Adapters are used to populate the Site Reference on Equipment, Functional Location, and Work History records in GE Digital APM.

Note: This site filtering configuration applies only to SAP PI deployment. If you are deploying the SAP Adapters, site filtering is handled by modifying the autojoin_control table.

Important:

Site Reference records must exist in your GE Digital APM system, before you can use the EAM Adapters to populate the Site Reference Key. Additionally, the site entered into the context file must match the exact value in the corresponding Site Reference record.
The user who is running the EAM Adapters jobs must be assigned, in GE Digital APM, to the site to which the records being loaded will be assigned. Additionally, the credentials for that user must be entered into the context file. If the user is not a member of the appropriate site, then the data load will fail, and an error message will appear.

The adapters populate the MI_SITE_KEY system field with the ENTY_KEY system field associated with the Site Reference value to be populated. On asset records, the Site Reference is stored in the MI_SITE_KEY field, a system field in GE Digital APM. The EAM Adapters use the Site Name (MI_SITE_NAME) to translate the value to the corresponding Site Reference Key and populate the MI_SITE_KEY field; therefore, you do not need to know the key to be able to populate the site reference. This functionality is important because this value can change from one database to another.

When records are loaded using the Equipment, Function Location, and Work History Adapters, the system will assign the Site Reference Key (MI_SITE_KEY) to the assets using the value designated in the applicable context file (that is, the file for SAP or for Maximo ). The following parameters are used to designate the Site Reference Key value:

SITE_REFERENCE_EQUIP: Used to populate the Site Reference Key on Equipment records being loaded into GE Digital APM. The Site Reference Key determines the Site to which the Equipment record(s) will be assigned.
SITE_REFERENCE_FLOC: Used to populate the Site Reference Key on Functional Location records loaded into GE Digital APM. The Site Reference Key determines Site to which the Functional Location record(s) will be assigned.
Note: The values entered into these parameters should match, because Equipment records are linked to Functional Location records. Therefore, they should have the same site.

These parameters accept two types of values to determine the site reference value.

Site Name: You can enter the site name directly as defined on the preexisting Site Reference record (i.e., Site 100).
Column Name: You can enter a column value between two pound symbols (#) to set the site reference. The following columns can be used:
- SAP columns:
  - MI_EQUIP000_SAP_SYSTEM_C
  - MI_EQUIP000_MAINT_PLANT_C
  - MI_FNCLOC00_MAINT_PLNT_C
  - MI_FNCLOC00_SAP_SYSTEM_C
For example, if you wanted to use your SAP maintenance plant field as your GE Digital APM site reference, you would enter #MI_EQUIP000_MAINT_PLANT_C#.

After the adapters are run, records designated to be transferred into GE Digital APM will be assigned to the site defined in the Site Reference parameters.

In addition to Equipment and Functional Location records loaded by the EAM adapters, Work History records and shell records are impacted by site reference functionality as detailed in the following table.

Action	Result
If the Work History Adapter is run after the Equipment or Functional Location Adapter...	The Work History records will inherit the Site Reference Key of their parent Functional Location or Equipment records.
If the Work History Adapter is run before the Equipment or Functional Location Adapter...	The Site Reference Key will be inherited from the shell record that will be created for Equipment and Functional Location.
If a shell record is created while loading data...	The Site Reference Key will be the value set in the context parameters.

Note: If you are using multiple SAP Systems, you must set up a context file for each system, and then designate the appropriate site(s) for each EAM Systems.