Open topic with navigation

Maximo Context File Parameters

The following table contains a list of parameters that you can configure in the Maximo context file.

IMPORTANT: Modifying the context file will override the configurations in the Context Parameters section of the APM Connect Administration Center.

Note: For parameters in the Functional Location Specific Filters, Equipment Specific Filters, and Work History Specific Filters sections, you can enter multiple values by separating the values using commas.

Parameters Description Default or Recommended Value
Interface Mode Selection
MAXIMO_CLOUD_ENABLED Determines if the Adapter will be used in a cloud environment.

You must enter one of the following values:

  • true: Adapter will run in the cloud.
  • false: Adapter will run on premises.
LOAD_MERIDIUM_APM Determines if data will be loaded into the Meridium database.

You must enter one of the following values:

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

You must enter one of the following values:

  • true: Data will be loaded into the Predix database.
  • false: Data will not be loaded into the Predix database.
CMMS_ID

The CMMS ID is used as the identifier for your system, and is <System ID>-<Client ID>.

For example, if your System ID is D03 and your Client ID is 001, then your CMMS ID would be DO3-001.

This value is required.

Enter a unique value.
SOURCE_SYSTEM_TYPE Identifies the type of system connecting with GE Digital APM.

This value is required.

You must enter the value MAXIMO.
Intermediate Repository (IR) Connection
IR_HOST The IP address of the IR. This value is unique for each user.
IR_PORT The port number of the IR. The default value is 5432.
IR_DATABASE

The database in which the IR data is stored.

 This value is unique for each user.
IR_SCHEMA The schema associated with the IR. The default value is Public.
IR_USER_ID The IR user name. This value is unique for each user.
IR_PASSWORD The IR system password. This value is unique for each user.
IR_TALEND_OUTPUT The shared folder to which the Maximo Adapter will write files. This value is unique for each user.
APM Connect Connection
CUSTOMER_NAME The coded customer name. Enter your unique value, which was provided during installation.
APM Connection

Note: The APM Connection Parameters are not required for a cloud deployment.
APM_API_APP_SERVER The name of the GE Digital APM server. This value is unique for each user.
APM_API_USE_SSL Specifies whether the GE Digital APM API application uses SSL.

The valid values are:

  • true: The API application uses SSL.
  • false: The API application does not use SSL.

The default value is false.
APM_APP_SERVER The name of the GE Digital APM server. This value is unique for each user.
APM_DATASOURCE The name of the GE Digital APM data source to which the data will be exported. This value is unique for each user.

APM_USERID

 Your GE Digital APM user ID. This value is unique for each user.
APM_PASSWORD Your GE Digital APM password. This value is unique for each user.
Maximo Connection for Extraction Interfaces
MAXIMO_USERID The Maximo system user ID. This value is unique for each user.
MAXIMO_PASSWORD The Maximo system password. This value is unique for each user.
LANGUAGE The alphabetical code that represents the language used for values in the records that are transferred to GE Digital APM. This value is unique for each user.
MAXIMO_REST_URL The REST URL for the Maximo Interface. This value is used if you want to use the REST web services to communicate with the Maximo system.

You must enter a value in the following format: http://<maximohost>:<port>/maxrest/rest/os

This value is not required if the value for the MAXIMO_WEBSERVICE parameter is false.

Note: REST services are not fully supported in Maximo versions 7.1 and 7.5.
MAXIMO_WEBSERVICE_URL The web service URL for the Maximo Interface. This value is used if you want to use the SOAP web services to communicate with the Maximo system.

You must enter a value in the following format: http://<maximohost>:<port>/meaweb/services

This value is not required if the value for the MAXIMO_WEBSERVICE parameter is true.

MAXIMO_WEBSERVICE Determines the type of web service to use.

You must enter one of the following values:

  • true: Uses the SOAP web services.
  • false: Uses the REST web services. This is the default value for this parameter.
MAXIMO_SYSTEM The EAM System name defined in the EAM System record in GE Digital APM. This value is unique for each user, and must match the value in the Name field in the EAM System family in GE Digital APM.
MAXIMO_CONNECTION_TIMEOUT The duration, measured in seconds, until which the Maximo Adapters will wait for the connection to be established with the Maximo system before timing out. The recommended value is 30.
MAXIMO_RECEIVE_TIMEOUT The duration, measured in seconds, until which the Maximo Adapters will wait for the response from the Maximo system before timing out. The recommended value is 60.
MAXIMO_REST_ASSETNAME This value is based on the Equipment object structure that you created in the Maximo system. The default value fis MIASSET.
MAXIMO_REST_FLOCNAME This value is based on the Functional Location object structure that you created in the Maximo system. The default value is MIOPERLOC.
MAXIMO_REST_SRNAME This value is based on the Service Request object structure that you created in the Maximo system. The default value is MISR.
MAXIMO_REST_WONAME This value is based on the Work Order object structure that you created in the Maximo system. The default value is MIWO.
EXTRACT_NUM_PARALLEL_JOBS Determines the maximum number of Maximo background jobs allowed during extraction. The recommended value is 10.
IR_LOAD_NUM_PARALLEL_JOBS Determines the maximum number of Maximo background jobs allowed during loading. The recommended value is 10.
Common Filter
CHANGE_DATE_START The data extracted is restricted to records changed on or after the date specified for this parameter.

A value is optional for this parameter.

You must enter a date in the following format: YYYYMMDD
CHANGE_DATE_END The data extracted is restricted to records changed on or before the date specified for this parameter.

A value is optional for this parameter.

You must enter a date in the following format: YYYYMMDD
CHANGE_TIME_START The data extracted is restricted to records changed on or after the time specified for this parameter.

A value is optional for this parameter.

You must enter time in the following format: HHMMSS
CHANGE_TIME_END The data extracted is restricted to records changed on or before the time specified for this parameter.

A value is optional for this parameter.

You must enter time in the following format: HHMMSS
SITE_ID The site ID as defined in GE Digital APM.

A value is optional for this parameter. This value is unique for each user.

Functional Location Specific Filter
LOCATION A number that identifies the Functional Location whose data you want to extract. A value is optional for this parameter. This value is unique for each user.
LOCATION_TYPE The ID of the Functional Location type whose data you want to extract. A value is optional for this parameter. This value is unique for each user.
LOCATION_STATUS The status of the Functional Location whose data you want to extract. A value is optional for this parameter. This value is unique for each user.
Equipment Specific Filter
ASSETNUM The asset numbers of the assets that you want to extract. A value is optional for this parameter. This value is unique for each user.
ASSET_TYPE The ID of the Asset type that will limit the assets extracted. A value is optional for this parameter. This value is unique for each user.
ASSET_STATUS The asset status that will limit the Functional Locations extracted. A value is optional for this parameter. This value is unique for each user.
Work History Specific Filter
SERVICE_REQUEST_NO The Service Request number that will limit the Service Requests extracted. A value is optional for this parameter. This value is unique for each user.
SERVICE_REQUEST_STATUS The Service Request status that will limit the data extracted. A value is optional for this parameter. This value is unique for each user.
WORK_ORDER_NO The Work Order number that will limit the Work Orders extracted. A value is optional for this parameter. This value is unique for each user.
WORK_ORDER_TYPE The type of Work Order that will limit the Work Orders extracted. A value is optional for this parameter. This value is unique for each user.
WORK_ORDER_SYSTEM_STATUS The Work Order system status that will limit the Work Orders extracted. A value is optional for this parameter. This value is unique for each user.
WORKORDER_OR_SERVICEREQUEST_FILTER Determines if the Maximo Service Requests or Work Orders will be transferred to and from GE Digital APM.

For Work Order and Service Request extraction jobs, a value is required for this parameter. You can enter one of the following values:

  • SERVICEREQUEST: Loads only Service Requests.
  • WORKORDER: Loads only Work Orders. This is the default value.

Note: If no value is entered for this parameter, then both Service Requests and Work Orders will be extracted.
Miscellaneous
MANUAL_RUN Determines how the date parameters will be treated.

You must enter one of the following values:

  • true: The dates specified in the context file 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 subsequent runs will use the dates from the last successful record.
LOG_REQUEST Determines if the GE Digital APM web service requests must be logged.

You must enter one of the following values:

  • true: Enables log creation for requests.
  • false: Disables log creation for requests. This is the recommended value.
LOG_RESPONSE Determines if the GE Digital APM web service responses must be logged.

You must enter one of the following values:

  • true: Enables log creation for responses.
  • false: Disables log creation for responses. This is the recommended value.
REST_FILTER_LIMIT A numeric value that indicates the number of records that are extracted in one load in the failure table. The default value is 100.
MAXIMO_RS_COUNT Limits the amount of Maximo records extracted in one load. The default value is 1,000.
Maximo Notification Management

IMPORTANT: You must configure the Maximo parameters for the parameters that correspond to your version of Maximo. For example, if you are using Maximo 76, configure the parameters in the MAXIMO76 section.

MAXIMO_USERID The Maximo system user ID. This value is unique for each user.
MAXIMO_PASSWORD The Maximo system password. This value is unique for each user.
LANGUAGE The alphabetical code that represents the language used for values in the records that are transferred from GE Digital APM. This value is unique for each user.
MAXIMO_REST_URL The REST URL for Maximo Interface. This value is used if you want to use the REST web services to communicate with the Maximo system.

You must enter a value in the following format: http://<maximohost>:<port>/maxrest/rest/os

This value is not required if the value for the MAXIMO_WEBSERVICE_URL parameter is false.

Note: REST services are not fully supported in Maximo versions 7.1 and 7.5.
MAXIMO_WEBSERVICE_URL The web service URL for Maximo Interface. This value is used if you want to use the SOAP web services to communicate with the Maximo system.

You must enter a value in the following format: http://<maximohost>:<port>/meaweb/services

This value is not required if the value for the MAXIMO_WEBSERVICE_URL parameter is true.

MAXIMO_CONNECTION_TIMEOUT The duration, measured in seconds, until which the Maximo Adapters will wait for the connection to be established with the Maximo system before timing out. The recommended value is 30.
MAXIMO_RECEIVE_TIMEOUT The duration, measured in seconds, until which the Maximo Adapters will wait for the response from the Maximo system before timing out. The recommended value is 60.
MAXIMO_REST_SRNAME This value is based on the Service Request object structure that you created in the Maximo system. The default value is MISR.
MAXIMO_REST_WONAME This value is based on the Work Order object structure that you created in the Maximo system. The default value is MIWO.
MAXIMO_CREATE_WO_SR Determines if the Maximo Adapter will transfer Maximo Work Orders or Service Requests.

For Notification Management jobs, a value is required for this parameter. You can enter one of the following values:

  • WO: Will transfer only Work Orders.
  • SR: Will transfer only Service Requests.
MAXIMO_DEFAULT_SITE_ID The site ID in the Maximo records. This value is unique for each user. You can enter the value of the Site record that is linked to the EAM System records that you are loading to Maximo.
Queue

Note: The Queue parameters apply only to a cloud deployment.
QUEUE_HOST The queue host name. Enter your unique value, which was provided during installation.
QUEUE_HOST_1 The additional queue host name. Enter your unique value, which was provided during installation.
QUEUE_HOST_2 The additional queue host name. Enter your unique value, which was provided during installation.
QUEUE_PORT The queue port. Enter your unique value, which was provided during installation.
QUEUE_PORT_1 The additional queue port. Enter your unique value, which was provided during installation.
QUEUE_PORT_2 The additional queue port. Enter your unique value, which was provided during installation.
QUEUE_USER The queue user name. Enter your unique value, which was provided during installation.
QUEUE_PASSWORD The queue password. Enter your unique value, which was provided during installation.
CUSTOMER_NAME The coded customer name. Enter your unique value, which was provided during installation.
Email Notification

Note: The Email Notification parameters apply only to a cloud deployment.
EMAIL_TO Email address(es) to which the email will be sent. Enter your unique value.
EMAIL_FROM Email address from which the email will be sent. Enter your unique value.
REPORT_TARGET_DIR Directory where the report file will be delivered. Enter your unique value.
FAILURE_DETAIL_REPORT_JRXML_FILE_PATH Directory where the failure report file will be delivered. Enter your unique value.
LOAD_SUMMARY_REPORT_JRXML_FILE_PATH Directory where the load complete report file will be delivered. Enter your unique value.
SMTP_HOST Host for SMTP installation on the APM Connect server. Enter your unique value.
SMTP_PORT Port for SMTP. The default value is 25.
LOAD_SUMMARY_REPORT_ENABLED

Indicates whether the load complete report will be loaded with each extraction.

You must enter one of the following values:

  • true: The load complete report, detailing the number of records that were extracted and successfully loaded into GE Digital APM, will be sent.
  • false: The load complete report will not be sent.
FAILURE_DETAIL_REPORT_ENABLED Indicates whether the failure detail report will be sent when a record fails to load.

You must enter one of the following values:

  • true: The failure detail report, detailing the records that failed to load into GE Digital APM and the reason for failure, will be sent.
  • false: The failure detail report will not be sent.
SFTP

Note: The SFTP parameters apply only to a cloud deployment.
SFTP_HOST The SFTP server host name. Enter your unique value, which was provided during installation.
SFTP_USERID The SFTP server user name. Enter your unique value, which was provided during installation.
SFTP_PASSWORD The SFTP server password. Enter your unique value, which was provided during installation.
SFTP_PORT The SFTP server port. Enter your unique value, which was provided during installation.
SFTP_LANDING_DIR Directory where the shared files are stored. Enter your unique value, which was provided during installation.
USE_SSH_KEY Determines if the SSH security configuration will be used by the adapters.

You must enter one of the following values:

  • true: SSH security configuration will be used.
  • false: SSH security configuration will not be used.
SSH_PRIVATE_KEY 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
Related Information

Copyright © 2018 General Electric Company. All rights reserved.