-
Enter the appropriate values for each parameter into the context file according to the following table.
Interface Mode Selection Description Default or Recommend Value SAP_CLOUD_ENABLED Determines whether the Adapter will be used in a cloud environment. true: adapters will be run in the cloud.
false: adapters will be run on premises.
LOAD_MERIDIUM_APM Determines if data will be loaded into the Meridium database. true: data will be loaded into the Meridium database.
false: data will not be loaded into the Meridium database.
LOAD_DIGITAL_APM
Determines if data will be loaded into the Predix database. true: data will be loaded into the Predix database.
false: data will not be loaded into the Predix database.
Intermediate Repository (IR) Connection Parameters Description Default or Recommend Value IR_HOST The IP address of the IR. Enter the host name of the PostgresSQL server. If you installed APM Connect using the default settings, then the value is localhost. IR_PORT The port number of the IR. Enter your PostgreSQL port. The default value is 5432. IR_DATABASE The database in which the IR data is stored.
Enter a name for the IR database. This value will be used to create the IR database.
IR_SCHEMA The schema in which the IR database will be created.
The default value is public.
IR_USERID The IR user name.
Enter the user name for the PostgresSQL database. The default user name is postgres.
IR_PASSWORD The IR system password.
Enter the password for the PostgresSQL database that was created during installation.
PG_ADMIN_USER The IR user name that is used to create the database.
Enter the user name for the PostgreSQL database. The default user name is postgres.
PG_ADMIN_PASSWORD The IR system password that is used to create the database.
Enter the password for the PostgresSQL database that was created during installation.
SAP Connection Parameters Description Default or Recommend Value SAP_CLIENT SAP client from where data is imported. Enter your unique value. SAP_HOST The IP address of the SAP Application Server. Enter your unique value. SAP_LANGUAGE The letter code that represents the language of the description to transfer into GE Digital APM. Enter your unique value. SAP_SYSTEM_NUMBER The service port of the SAP Application Server. Enter your unique value. SAP_USERID The SAP system user ID. Enter your unique value. SAP_PASSWORD The SAP system password. Enter your unique value. SAP_FILE_ENCODING Determines the encoding of the source data. The default value is UTF8.
All character encodings supported by the Java Virtual Machine (JVM) are correct.
EXTRACT_NUM_PARALLEL_JOB Determines the maximum number of SAP background jobs allowed during execution. 10 is the recommended value. File System Parameters Description Default or Recommend Value PLSAP_INPUT The path of the directory you created that SAP uses to place data files that APM Connect uses . Enter your unique value. PLSAP_OUTPUT The path of the directory that APM Connect looks for files SAP creates. This directory should be shared with the SAP server. Enter your unique value. IR_TALEND_OUTPUT The temporary workspace used when moving files from SAP into APM Connect. Enter your unique directory path. LOG_BASE_DIR
The directory path to the log file.
C:\APMConnect\Logs
SFTP_STAGING_DIR
The temporary storage location for files that are waiting to be loaded.
Enter your unique value (e.g., C:\APMConnect\Staging). UNC_FILE_PATH The path of the directory of the data loader file share. Enter your unique value. APM Connect Parameter Description Default or Recommend Value APM_CONNECT_HOST The host name of the machine where APM Connect Administration Center is installed. Enter your unique value. APM_CONNECT_PORT The port name of the machine where APM Connect Administration Center is installed. Enter your unique value. Note: The APM Connection Parameters are not required for cloud deployments.
APM Connection Parameters Description Default or Recommend Value APM_API_APP_SERVER The GE Digital APM API application server name. Enter the name of your GE Digital APM API Server. APM_APP_SERVER The GE Digital APM application server name. Enter the name of your GE Digital APM Server. APM_DATASOURCE The GE Digital APM data source to which the data will be exported. Enter the name of your GE Digital APM data source. APM_USERID
The GE Digital APM Framework User ID. Enter your unique value. APM_PASSWORD The GE Digital APM Framework password. Enter your unique value. Miscellaneous Parameters Description Default or Recommended Value MANUAL_RUN Determines how the dates parameters will be treated. True: The dates specified in the context files will be used. Additionally, the dates of the last successful run stored in the database will not be updated.
False: The date range used during the extraction will be the date of the last successful record as stored in the database. Each time a job is run successfully, the database is updated with those dates and all the subsequent runs will use the dates from the last successful record.
Filter Parameters
Description
Recommended or Default Value
MAINT_PLANT
The ID(s) of the Maintenance Plant whose data you want to extract.
Plant values cannot exceed four characters.
LANGUAGE
The SAP code that represents the language.
The value must be a single character.
CREATE_DATE_START
The date value that limits the data extracted to records created on or after the specified date.
Dates must be entered in the following format: YYYYMMDD.
CREATE_DATE_END
The date value that limits the data extracted to records created on or before the specified date.
Dates must be entered in the following format: YYYYMMDD.
CHANGE_DATE_START
The date value that limits the data extracted to records changed on or after the specified date.
Dates must be entered in the following format: YYYYMMDD.
CHANGE_DATE_END
The date value that limits the data extracted to records changed on or before the specified date.
Dates must be entered in the following format: YYYYMMDD.
CREATE_TIME_START
The time value that limits the data extracted to records created on or after the specified time.
Time must be in the following format: HHMMSS.
CREATE_TIME_END
The time value that limits the data extracted to records created on or before the specified time.
Time must be in the following format: HHMMSS.
CHANGE_TIME_START
The time value that limits the data extracted to records changed on or after the specified time.
Time must be in the following format: HHMMSS.
CHANGE_TIME_END
The time value that limits the data extracted to records changed on or before the specified time.
Time must be in the following format: HHMMSS.
Equipment Filter Criteria
Description
Recommended or Default Value
EQUIPMENT_NO
The equipment that you want to extract.
The Equipment number should not exceed 18 characters. You cannot exceed 500 Equipment numbers.
EQUIPMENT_CATEGORY
The ID of the Equipment Category that will limit the Equipment extracted.
Must be a single character.
EQUIPMENT_TYPE
The ID of the Equipment Type that will limit the Equipment extracted.
The Equipment Type should not exceed 10 characters.
EQUIPMENT_CLASS
The ID of the Equipment Classification that will limit the Equipment extracted.
The Equipment Classification should not exceed 18 characters.
If an Equipment has multiple Classifications, as long as you specify one of those Classifications, the Equipment record will be extracted.
Functional Location Filter Criteria
Description
Recommended or Default Value
FLOC_NO
The ID of the Functional Location that will limit the Functional Locations extracted.
The Functional Location ID should not exceed 40 characters. You cannot exceed 500 Functional Location numbers.
FLOC_TYPE
The ID of the Functional Location Type that will limit the Functional Locations extracted.
Functional Location Type ID should not exceed 10 characters.
FLOC_CLASS
The ID of the Functional Location Classification that will limit the Functional Locations extracted.
Functional Location Classification ID should not exceed 18 characters.
FLOC_CATEGORY
The ID of the Functional Location Category that will limit the Functional Locations extracted.
Must be a single character.
Work History Filter Criteria
Description
Recommended or Default Value
NOTIFICATION_NO
The number that identifies the Notification record.
Notification number should not exceed 12 characters.
WORK_ORDER_NO
The number that identifies the Work Order record.
Work Order number should not exceed 12 characters.
NOTIFICATION_TYPE
The Notification Type that limits the orders that you want to extract.
Notification Type should not exceed two characters.
WORK_ORDER_TYPE
The ID of the Work Order Type that limits the orders that you want to extract.
Work Order Type should not exceed four characters.
WORK_ORDER_SYSTEM_STATUS
The Work Order Systems Status that limits the Work Orders you want to extract.
Work Order System Status should not exceed four characters.
WORK_ORDER_USER_STATUS
The Work Order User Status that limits the Work Orders that you want to extract.
Work Order User Status should not exceed four characters.
NOTIFICATION_SYSTEM_STATUS
The Notification System Status that limits the notifications that you want to extract.
Notification System Status should not exceed four characters.
NOTIFICATION_USER_STATUS
Notification User Status that limits the notifications that you want to extract.
User Status should not exceed four characters.
Note: The Queue parameters only apply to cloud deployments.
Queue
Description
Recommended or Default Value
QUEUE_HOST
The queue host name.
Enter your unique value, which was provided at installation.
QUEUE_HOST_1
An additional queue host name.
Enter your unique value, which was provided at installation.
QUEUE_HOST_2
An additional queue host name.
Enter your unique value, which was provided at installation.
QUEUE_PORT
The queue port.
Enter your unique value, which was provided at installation.
QUEUE_PORT_1
An additional queue port.
Enter your unique value, which was provided at installation.
QUEUE_PORT_2
An additional queue port.
Enter your unique value, which was provided at installation.
QUEUE_USER
The queue user name.
Enter your unique value, which was provided at installation.
QUEUE_PASSWORD
The queue password.
Enter your unique value, which was provided at installation.
CUSTOMER_NAME
The coded customer name.
Enter your unique value, which was provided at installation.
FTP Parameters
Description
Default or Recommend Value
Using an FTP Connection is only supported for the SAP and SAP PI Adapters, and configuration is only required if you are using FTP to transfer information between your systems.
IMPORTANT: If you are using an SAP System with the SAPFTP_SERVERS table, you must configure that table to activate FTP servers according to the SAP Help System. You can refer to SAP OSS 1605054 for more details. Typically, this will apply to any SAP version later than ECC6 EHP5.
PLSAP_FTP_HOST
The FTP server host name.
Enter your unique value.
PLSAP_FTP_USERID
The FTP server user name.
Enter your unique value.
PLSAP_FTP_PASSWORD
The FTP server password.
Enter your unique value.
PLSAP_FTP_PORT
The FTP server port.
If the default configuration was followed, enter one of the following:
- 21: for FTP connection.
- 22: for SFTP connection.
PLSAP_FTP_MODE
The mode by which files are copied.
Enter one of the following values:
- SERVER: to use file shares.
- FTP: to use standard FTP.
- SFTP: to use standard Secure FTP.
PLSAP_FTP_SCAN_DIR
The remote FTP directory used to scan for files.
Enter your unique value.
PLSAP_FTP_NUM_OF_RETRY
The number of times to scan the FTP server for files.
10
PLSAP_FTP_SLEEP_TIME
The time in seconds between scans.
10
PLSAP_SFTP_SCP_COMMAND The command name created when establishing the SFTP transfer in SAP. Enter your unique value.
Note: The SFTP parameters only apply to cloud deployments.
SFTP Parameter
Description
Recommended or Default Value
SFTP_HOST
The SFTP server host name.
Enter your unique value, which was provided at installation.
SFTP_USERID
The SFTP server user name.
Enter your unique value, which was provided at installation.
SFTP_PASSWORD
The SFTP server password.
Enter your unique value, which was provided at installation.
SFTP_PORT
The SFTP server port.
Enter your unique value, which was provided at installation.
SFTP_LANDING_DIR
The directory path where the shared files are stored.
Enter your unique value, which was provided at installation.
USE_SSH_KEY Determines if SSH security configuration will be used by the adapters. True : SSH configuration will be used.
False: SSH configuration will not be used.
SSH_PRIVATE_KEY The directory where the SSH key is stored. Enter your unique value. The SSH key must be generated by the user in the openSSH format. This key can be stored in any directory on the APM Connect server, but it is recommended to store it in the following folder: C:/APMConnect/Config
Note: The Email Notification parameters only apply to cloud deployments.
Email Notification Parameters Description Recommenced or Default Value CMMS_ID
The CMMS ID is used as the identifier for your SAP System, and is <SAP System ID>-<SAP Client ID>.
For example, if your SAP System ID is D03 and your SAP Client ID is 001, then your CMMS ID would be DO3-001.
Enter your unique value.
REPORT_TARGET_DIR The directory path where the report file will be delivered. Enter your unique value. FAILURE_DETAIL_REPORT_ENABLED Indicates whether or not the failure detail report will be sent when a record fails to load. True: The Failure Detail report will be sent detailing the records that failed to load and the reason why.
False: The Failure Detail report will not be sent.
FAILURE_DETAIL_REPORT_JRXML_FILE_PATH The directory path where the failure report file will be delivered. Enter your unique value. LOAD_SUMMARY_REPORT_ENABLED Indicates whether or not to load the complete report with every extraction. True: The Load Complete report will be sent detailing the number of records that were extracted and successfully loaded into GE Digital APM.
False: The Load Complete report will not be sent.
LOAD_SUMMARY_REPORT_JRXML_FILE_PATH The directory path where the load complete report file will be delivered. Enter your unique value. EMAIL_TO The email address(es) to which the notification email will be sent. Enter your unique value. EMAIL_FROM The email address from which the notification email will be sent. Enter your unique value. SMTP_HOST The host for SMTP installation the APM Connect server. Enter your unique value. SMTP_PORT The port for SMTP. Default value is 25. Guardrail Parameters Description Recommenced or Default Value EQUIPMENT_THRESHOLD The maximum number of records that should be transferred from SAP to GE Digital APM in a single run of the Equipment Adapter. The default value is 100000. FLOC_THRESHOLD The maximum number of records that should be transferred from SAP to GE Digital APM in a single run of the Function Location Adapter. The default value is 100000. WORKHISTORY_THRESHOLD The maximum number of records that should be transferred from SAP to GE Digital APM in a single run of the Work History Adapter. The default value is 50000. OVERRIDE_GUARDRAILS Indicates whether or not the job should continue if the number of records exceeds the defined thresholds. The default value is Y, which means that the job will run regardless of the number of records included. A warning notification will also be sent to the email address specified in the EMAIL_TO parameters within the Email Notification Parameters section of this file. If you set this parameter to N, the job will be terminated if the number of records exceeds the defined threshold, and an error notification will also be sent.