Configure the Maximo Context File

Steps

  1. On the APM Connect server, navigate to the <root:>/APMConnect/Config folder.

  2. Rename the RENAME_TO_SYSTEM_NAME folder to the name of the system you will be using.
  3. Open the folder, and then open the context file to edit.

    IMPORTANT: Changes made to the context file will override changes made in the APM Connect Administration Center Context parameters section.

    Note: Multiple values can be entered into the filter parameters using comma separated values or standard wild cards values.

    Intermediate Repository (IR) Connection Parameters Description Default or Recommend Value
    IR_HOST IP address of the IR. Value is unique to the user.
    IR_PORT Port number of the IR. 5432 (PostgreSQL default)
    IR_DATABASE

    Database in which the IR data is stored.

    APMconnectIR_<Release Number(X_X_X)>.

    IR_SCHEMA Schema associated with the IR. Public
    IR_USER_ID IR user name. Value is unique to the user.
    IR_PASSWORD IR system password. Value is unique to the user.
    IR_TALEND_OUTPUT File share folder to which the Maximo Adapter will write files. Value is unique to the user.
    PG_ADMIN_USER Administrator user name for the PostgresSQL IR. Value is unique to the user, and is used when creating the IR database. It can be removed after the database is created.
    PG_ADMIN_PASSWORD Administrator password for the PostgresSQL IR. Value is unique to the user, and is used when creating the IR database. It can be removed after the database is created.
    APM Connection Parameters Description Default or Recommend Value
    APM_APP_SERVER GE Digital APM Server name. Value is unique to the user.
    APM_DATASOURCE GE Digital APM data source to which the data will be exported. Value is unique to the user.

    APM_USERID

    The GE Digital APM APM Framework User ID. Value is unique to the user.
    APM_PASSWORD The GE Digital APM APM Framework password. Value is unique to the user.
    SITE_REFERENCE_EQUIP Used to map the site reference value to a Maximo field. This dictates which Maximo field will be used as the site reference for GE Digital APM Equipment records. 

    You can enter a value defined in GE Digital APM.

    Note: The value that is entered will be applied to all records. 

    -or-

    You can use the character # at the beginning and end of a GE Digital APM Field Name to indicate the field that is used to set to set the site reference.

    Tip: For more information, see About Site Filtering Configuration in the Context File.

    SITE_REFERENCE_FLOC Used to map the site reference value to a Maximo field. This dictates which SAP field will be used as the site reference for GE Digital APM Functional Location records. 

    You can enter a value defined in GE Digital APM.

    Note: The value that is entered will be applied to all records. 

    -or-

    You can use the character # at the beginning and end of a GE Digital APM Field Name to indicate the field that is used to set to set the site reference.

    Tip: For more information, see About Site Filtering Configuration in the Context File.

    APM_WEBSERVICE URL for the APM integration web services. /MeridiumIntegrationServices
    APM_CONNECTION_TIMEOUT How long, in seconds, GE Digital APM will wait for the connection to the Adapters before timing out. 300
    APM_RECEIVE_TIMEOUT How long, in seconds, GE Digital APM will wait for the response from the Adapters before timing out. 600
    Maximo Connection Parameters for Extraction Interfaces Description Default or Recommended Value
    MAXIMO_USERID Maximo system user ID. Value is unique to the user.
    MAXIMO_PASSWORD Maximo system password. Value is unique to the user.
    LANGUAGE The Maximo letter code that represents the language of the description to transfer into GE Digital APM. Value is unique to the user.
    MAXIMO_REST_URL The REST URL for the Maximo end point, and is used if you want to use the REST service component.

    http://<host>:<port>/maxrest/rest/os

    This value is not required if using the MAXIMO_WEBSERVICE_URL parameter.

    Note: REST services are not fully supported in 7.1 and 7.5.

    MAXIMO_WEBSERVICE_URL The web service URL when SOAP web services are used to call Maximo

    http://maximo<host>:<port>/meaweb/services.

    This value is not required if using the MAXIMO_REST_URL parameter.

    MAXIMO_WEBSERVICE Determines which type of web service to use: REST services or SOAP web services.
    • true: Uses the web services
    • false: Uses the REST web services and is the default value.
    MAXIMO_SYSTEM The EAM system named defined on the EAM System Record in GE Digital APM. Value is unique to the user, and should match the value in GE Digital APM exactly.
    MAXIMO_CONNECTION_TIMEOUT How long, in seconds, the Maximo Adapters will wait for the connection to Maximo before timing out. Recommended value is 30.
    MAXIMO_RECEIVE_TIMEOUT How long, in seconds, the Maximo Adapters will wait for the response from Maximo before timing out. Recommended value is 60.
    MAXIMO_REST_ASSETNAME Created equipment object structure. MIASSET
    MAXIMO_REST_FLOCNAME Created functional location object structure. MIOPERLOC
    MAXIMO_REST_SRNAME Created service request object structure. MISR
    MAXIMO_REST_WONAME Created work order object structure. MIWO
    Common Filters Description Default or Recommend Value
    CHANGE_DATE_START 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. Optional.
    CHANGE_DATE_END 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. Optional.
    CHANGE_TIME_START Time value that limits the data extracted to records changed on or after the specified date. Time must be in the following format: HHMMSS. Optional.
    CHANGE_TIME_END Time value that limits the data extracted to records changed on or before the specified date. Time must be in the following format: HHMMSS. Optional.
    SITE_ID Site ID as identified in GE Digital APM Value is unique to the user. Optional.
    Functional Location Specific Filters Description Default or Recommend Value
    LOCATION Number that identifies the Functional Location record you want to extract. Value is unique to the use. Optional.
    LOCATION_TYPE ID of the Functional Location Type that will limit the Functional Locations extracted. Value is unique to the user. Optional.
    LOCATION_STATUS Status of the Functional Location that will limit the Functional Locations extracted. Value is unique to the user. Optional.
    Asset Specific Filters Description Default or Recommend Value
    ASSETNUM Asset number for the asset(s) that you want to extract. Value is unique to the user. Optional.
    ASSET_TYPE ID of the Asset Type that will limit the assets extracted. Value is unique to the user. Optional.
    ASSET_STATUS Status of the Asset that will limit the Functional Locations extracted. Value is unique to the user. Optional.
    Work History Specific Filters Description Default or Recommend Value
    SERVICE_REQUEST_NO Service Request number(s) that will limit the Service Request(s) extracted. Value is unique to the user. Optional.
    SERVICE_REQUEST_STATUS Service Request status that will limit the data extracted. Value is unique to the user. Optional.
    WORK_ORDER_NO Work Order number(s) that will limit the Work Order(s) extracted. Value is unique to the user. Optional.
    WORK_ORDER_TYPE Type of Maximo Work Order that will limit the work orders extracted. Value is unique to the user. Optional.
    WORK_ORDER_SYSTEM_STATUS Work Order system status that will limit the work orders extracted. Value is unique to the user. Optional.
    WORKORDER_OR_SERVICEREQUEST_FILTER Determines if Maximo services Requests or Work Orders will be transferred to and from GE Digital APM.
    • SERVICEREQUEST: Loads only service requests.
    • WORKORDER: Loads only work orders.
    • null: Will load service requests.
    Maximo Miscellaneous Parameters Description Default or Recommenced Value
    EXTRACT_ONLY Determines if records will be loaded only into the staging tables or into the IR and then to APM.
    • true: Will only load records into the IR.
    • false: Will load records from EAM to APM.
    MANUAL_RUN Determines how the date parameters will be treated.
    • 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.
    RESTART Determines if the Maximo Adapters will pull records from the failure log or from the failure logs and other records.
    • true: Looks to the failure table in the IR and loads the records from there.
    • false: Will look to the failure records and then continue to process other records.
    LOG_REQUEST Logs the GE Digital APM Web service requests.
    • true: Enables logging
    • false: Disables logging

    Note: False is recommended.

    LOG_RESPONSE Logs the GE Digital APM Web service responses.

    • true: Enables logging
    • false: Disables logging
    Note: False is recommended.

    ROWS_TO_PROCESS

    GE Digital APM web services batch count. Default value is 100.
    REST_FILTER_LIMIT Limits the amount of records in the failure table that are extracted in one load. Default value is 100.
    MAXIMO_RS_COUNT Limits the amount of Maximo records extracted in one load. Default value is 1,000.
    Maximo Notification Management Parameters Description Default or Recommended Value
    There are two parameters unique to the Maximo Notification Management Adapters. All other parameters are configured using the same guidelines as the extraction filters and connection parameters.

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

    MAXIMO_CREATE_WO_SR Determines if the Maximo Adapter will transfer Maximo Work Orders or Service Request.
    • WO: Will transfer only work orders
    • SR: Will transfer only service request
    • null: Will transfer service requests only.
    MAXIMO_DEFAULT_SITE_ID Maximo Site ID. Value is unique to the user, but can match the value of the Site Reference record that is linked to the EAM System Record.

What's Next?

Copyright © 2017 General Electric Company. All rights reserved.