First-time Deployment

The following are the steps that you must complete to deploy and configure this module for the first time. These instructions assume that you have completed the steps for deploying the basic APM system architecture.

1. On the APM Connect server, navigate to the following folder: <root>:/APMConnect/Config.
2. Rename the folder RENAME_TO_SYSTEM_NAME to the name of the Maximo system that you are using.
3. Open the folder that you renamed, and then, using an XML editor or a text editor, open the following file: ContextFile.xml.
   The content in the context file appears in the editor, displaying the parameters that you can configure for data extraction.
4. As needed, modify the values for the parameters in the context file, and then save the file.
   Your changes to the context file are saved.

You must import and configure the Notification Management file so notifications are generated correctly.

1. On the APM Connect server, navigate to folder: <root:>\APMConnect\Config.
2. Copy the file connectServices.cfg to folder <root:>\APMConnect\Utilities\runtime\etc.
3. Edit the file and provide these values for the listed parameters.

   Parameter	Value
   context	Default
   IR_HOST	IP address of the system containing the Intermediate Repository.
   IR_PORT	Port number of the system containing the Intermediate Repository.
   IR_DATABASE	The database that contains the Intermediate Repository.
   IR_SCHEMA	The schema that defines the Intermediate Repository.
   IR_USERID	The userid to access the Intermediate Repository.
   IR_PASSWORD	The password associated with the userid that accesses the Intermediate Repository.
   LOG_REQUEST	false
   LOG_RESPONSE	false

   Important: The path in the configuration file must use forward slashes (/).
4. Save the file.
5. Access the APM Connect installation package, and then copy the file connectServices.jar.
6. Navigate to the following directory: <root:>\APMConnect\Utilities\runtime\deploy.
7. Optional: If you already have an existing connectServices.jar file, delete it before copying the new file into the directory.
8. Paste the copied file connectServices.jar in the directory.

1. In the APM Connect Administration Center, in the Job Conductor workspace, select the MAXIMO_MASTER_INTERFACE Job.
2. At the bottom of the Job Conductor workspace, select Context parameters.

   The Context parameters section appears, displaying the following parameters:

   Context Parameter	Description
   CONFIG_FILE_DIRECTORY	The file path to context files for the jobs.
   SYSTEM_TO_RUN	Name of the folder in which the context file is stored, and is the <system name> folder.
   LOG4J_CONFIG_FILE	The file path for Log4j.
   RUN_WORKHISTORY	The Work History Job.
   RUN_EQUIPMENT	The Equipment Job.
   RUN_FLOC	The Functional Location Job.

3. Select the Active check box for each parameter whose custom value you want to edit.
4. To save the custom value, press Enter.
5. In the CONFIG_FILE_DIRECTORY Custom value box, enter the directory where the context files are stored. If the default configuration was followed, the path will be the following: <root:>\APMConnect\Config.
6. Press Enter.
7. In the SYSTEM_TO_RUN Custom value box enter:
   • The name of the system directory from which you want to extract data.

     -or-

   • * to extract from all systems.
8. Press Enter.
   The master job is configured.

This topic describes how to set up a repository in preparation to run your first job.

1. Log in to the APM Connect Administration Center web application.
   Note: The user logging in must have access to the Job Conductor by being designated the Operations Manager role. By default, users designated as administrators do not have Job Conductor permissions.
2. In the Job Conductor workspace, in the appropriate project, select the CreateIntermediateRepository job.
3. Select Context parameters.

   The Context parameters section appears.

4. Configure the following parameter.

   Context Parameter	Description
   CONFIG_FILE_PATH	The file path to context files for the jobs. Important: You must change the default value to reflect the actual path to your configuration file. CMMS_ID and SOURCE_SYSTEM_TYPE must be set in the context file.

5. Select Run.
   If you are configuring a single system, you have completed your configuration.
   The intermediate repository database is created for the project.

If you are configuring multiple EAM systems, perform the remaining steps in this topic.

6. In the Job Conductor workspace, in the appropriate project, select the addSourceSystem job.
7. Configure the following parameter.

   Context Parameter	Description
   CONFIG_FILE_PATH	The file path to context files for the jobs. Important: You must change the default value to reflect the actual path to your configuration file. CMMS_ID and SOURCE_SYSTEM_TYPE must be set in the context file.

8. Select Run.
9. Repeat steps 6 through 8 for all adapters.

This topic describes how to modify the autojoin_control table in the Intermediate Repository, to assign site references to records using values other than those in the default configuration.

Steps: Configure the Site Reference Value to Use an Indirect Site Reference Value

1. Using a database browser tool, access your Intermediate Repository.

   A list of tables available in the repository appears.

2. In the list of tables, navigate to the autojoin_control table, and then, in the data available for the table, locate the site_reference column.
3. For each row in which you want to modify the Site Reference, in the site_reference column, modify the value using the following format: #FIELD_ID#, where FIELD_ID represents the ID of the APM field from which you want to populate the site reference value.

   For example, if you want the Site Reference for the Equipment and Functional Location records to be assigned with the name of the CMMS System from which the data was extracted, then modify the value in the site_reference column with the following values:

   • Where the value #MI_EQUIPOO_SITE_C# occurs, replace the value with #MI_EQUIP000_SAP_SYSTEM_C#.
   • Where the value #MI_FNCLOC00_SITE_C# occurs, replace the value with #MI_FNCLOC00_SAP_SYSTEM_C#.

   MI_EQUIP000_SAP_SYSTEM_C and the MI_FNCLOC00_SAP_SYSTEM_C are fields in the Equipment and Functional Location records that store the name of the CMMS System.

4. Save the autojoin_control table.

   Your changes are saved. When you import records into APM from your Maximo system, the site assigned to the records will be based on the Site Reference that you specified in the autojoin_control table.

Steps: Configure the Site Reference Value to Use a Direct Site Reference

5. Using a database browser tool, access your Intermediate Repository.
   A list of tables available in the repository appears.
6. In the list of tables, navigate to the autojoin_control table, and then, in the data available for the table, locate the site_reference column.
7. For each row in which you want to modify the Site Reference, in the site_reference column, replace the value with the name of the Site that you want to assign to the records.
8. Save the autojoin_control table.
   Your changes are saved. When you import records into APM from your Maximo system, the site assigned to the records will be the Site that you specified in the autojoin_control table.

• Create Object Structure - Asset
  1. In the Go To Application column, select Integration, and select Object Structures.
  2. In the Object Structure window, in the Object Structure box, enter MXASSET, and then open the object structure.
  3. In the Go To Application column, in the More Actions section, select Duplicate Object Structure, and then enter the Object Structure name MIASSET.
  4. In the Source Object for MIASSET section, remove all objects except the ASSET object.
  5. Add the CLASSSTRUCTURE object with ASSET as parent and CLASSSTRUCTURE as relationship.
  6. In the Go To Application column, in the More Actions section, select Exclude/ Include Fields.
  7. In the Exclude/Include Fields window, in the Persistent Fields tab, clear the Exclude? check boxes on the rows corresponding to the following fields:
     • ASSETID
     • ASSETNUM
     • ASSETTYPE
     • CHANGEDATE
     • DESCRIPTION
     • INSTALLDATE
     • ITEMNUM
     • LOCATION
     • MANUFACTURER
     • PRIORITY
     • SERIALNUM
     • SITEID
     • STATUS
     • VENDOR
     • WARRANTYEXPDATE
  8. In the Non-Persistent Fields tab, select the Include? check box on the row corresponding to the DESCRIPTION_LONGDESCRIPTION field.
  9. Under the CLASSTRUCTURE object structure, in the Non-Persistent Fields section, select the Include? check box in the row corresponding to the following fields:
     • HIERARCHYPATH
     • DESCRIPTION_CLASS
  10. Select OK.
• Create Object Structure - Location
  1. In the Go To Application column, select Integration, and select Object Structures.
  2. In the Object Structure window, in the Object Structure box, enter MXOPERLOC, and then open the object structure.
  3. In the Go To Application column, in the More Actions section, select Duplicate Object Structure, and then enter the Object Structure name MIOPERLOC.
  4. In the Source Object for MIOPERLOC section, remove all objects except the LOCATION object.
  5. Add the ASSET object with LOCATION as parent and ASSET as relationship.
  6. In the Go To Application column, in the More Actions section, select Exclude/ Include Fields.
  7. In the Exclude/Include Fields window, in the Persistent Fields tab, clear the Exclude? check boxes on the rows corresponding to the following Fields:
     • CHANGEDATE
     • DESCRIPTION
     • LOCATION
     • LOCATIONSID
     • SITEID
     • STATUS
     • TYPE
  8. In the Non-Persistent Fields tab, select the Include ? check box on the row corresponding to the following fields:
     • FAILURECODE
     • PARENT
     • LOCPRIORITY
     • DESCRIPTION_LONGDESCRIPTION
  9. Under the CLASSTRUCTURE object structure, in the Non-Persistent Fields section, select the Include? check box in the row corresponding to the following fields:
     • HIERARCHYPATH
     • DESCRIPTION_CLASS
  10. Select OK.
• Create Object Structure - Work Order
  1. In the Go To Application column, select Integration, and select Object Structures.
  2. In the Object Structure window, in the Object Structure box, enter MXWO, and then open the object structure.
  3. In the Go To Application column, in the More Actions section, select Duplicate Object Structure, and enter the Object Structure name MIWO.
  4. In the Source Object for MIWO section, remove all objects except the WORK ORDER object.
  5. In the Go To Application column, in the More Actions section, select Exclude/ Include Fields.
  6. In the Exclude/Include Fields window, in the Persistent Fields tab, clear the Exclude? check boxes on the rows corresponding to the following fields:
     • ACTFINISH
     • ACTLABCOST
     • ACTLABHRS
     • ACTMATCOST
     • ACTSERVCOST
     • ACTSTART
     • ACTTOOLCOST
     • ACTTOTALCOST
     • ASSETLOCPRIORITY
     • ASSETNUM
     • CALCPRIORITY
     • CHANGEBY
     • CHANGEDATE
     • CREWID
     • DESCRIPTION
     • ESTLABCOST
     • ESTLABHRS
     • ESTMATCOST
     • ESTSERVCOST
     • ESTTOOLCOST
     • JPNUM
     • JUSTIFYPRIORITY
     • LEAD
     • LOCATION
     • OUTLABCOST
     • OUTMATCOST
     • OUTTOOLCOST
     • PMNUM
     • REPORTDATE
     • SCHEDFINISH
     • SCHEDSTART
     • SITEID
     • STATUS
     • TARGCOMPDATE
     • TARGSTARTDATE
     • WONUM
     • WOPRIORITY
     • WORKTYPE
  7. In the Non-Persistent Fields tab, select the Include ? box on the row corresponding to the DESCRIPTION_LONGDESCRIPTION field.
  8. Select OK.
• Create Object Structure - Service Request
  1. In the Go To Application column, select Integration, and select Object Structures.
  2. In the Object Structure window, in the Object Structure box, enter MXSR, and then open the object structure.
  3. In the Go To Application column, in the More Actions section, select Duplicate Object Structure, and enter the Object Structure name MISR.
  4. In the Source Object for MIWO section, remove all objects except the service request object.
  5. In the Go To Application column, in the More Actions section, select Exclude/ Include Fields.
  6. In the Exclude/Include Fields window, in the Persistent Fields tab, clear the Exclude? check boxes on the rows corresponding to the following fields:
     • ASSETNUM
     • DESCRIPTION
     • LOCATION
     • SITEID
     • TICKETID
  7. In the Non-Persistent Fields tab, select the Include ? box on the row corresponding to the DESCRIPTION_LONGDESCRIPTION field.
  8. Select OK.

1. On the Go To Applications menu, select Integration, and then select Web Service Library.
   The Web Services Library page appears.
2. In the More Actions section, select Create Web Service, and then select Create Web Service from Object Structure.
   The Create Web Service from an Object Structure Service Definition window appears.
3. In the Source Name column, select the check box next to the web service name you want to create, and then select Create.
   The web service name appears in the Web Services Library list.
4. In the More Actions tab, select Deploy to Product Web Service Container, and then select Deploy Web Service.
5. Repeat Steps 1-4 to create the remaining web services.

If you have enabled web service authentication in your Maximo system, then you must configure a default user name and password in Maximo.

1. In Maximo, select System configuration, and then select Platform configuration, and then select System properties.
2. Search for the following property: mxe.int.dfltuser.
3. For the mxe.int.dfluser property set the default user as mxintadm.
4. Refresh your Maximo system, and then search for the following property mxe.int.dfltuserpassword.
5. For the mxe.int.dfltuserpassword property, enter your default password, and then refresh your Maximo system.
   The default user name and password are configured.

1. In the Go To Application column, select System Configuration, select Platform configuration, and then select System Properties.
   The System Properties page appears displaying the Global Properties and Instance Properties.
2. In the Global Properties section, navigate to the property mxe.int.keyresponse.
3. On the mxe.int.keyresponse row, select .
   The row is expanded, and the Global Properties Details appear.
4. In the Global Value box, enter 1.
   The Global Value is equal to 1.

You must configure an EAM System record to establish a connection between any EAM system and APM.

1. Create a new EAM System record.
2. In the Datasheet ID box, select Maximo.
3. In the Name box, enter the name of your system.
4. If this system is the system to and from which you want to send data by default, select the Default EAM System? check box.
5. In the System Type box, select Maximo.
6. In the User ID box, enter a valid User ID.
7. In the Password box, select .
8. In the Enter EAM System Password window, in the Password box, enter the password that is associated with the specified user ID.
9. In the Confirm Password box, reenter the password.
10. Select OK.
11. In the Web Service URL box, enter the URL for the Maximo Web Services that will extract the data.
12. In the Language box, enter the code of the language for this connection (for example, EN).
13. In the Service Request Family Name box, enter the table name for the Service Request in Maximo (this value is usually MISR).
14. In the Work Order Family Name box, enter the table name for the Work Order in Maximo (this value is usually MIWO).
15. In the WO or SR box, enter the default notification type to be created. This value can either be WO or SR.
16. In the Default Site ID box, enter the Site under which the WO or SR should be created if it is not provided in the notification the system receives.
17. Optional: Select Use Rest to have the system use REST requests to create service requests or work orders.
18. Select .
    The EAM System record is saved.
19. Select , and then select Test Connection.
    The connection parameters are verified, and the System ID box is populated with your EAM System Name.

To enable data flow when there are multiple cultures configured for a single source system, you must complete the following steps.

1. Create a context file for each culture originating from a specific source system.
   1. Assign a CMMS_ID and TARGET_CMMS_ID that indicates the culture.
      For example, consider a source system that supports both French and Spanish. Your CMMS_ID and TARGET_CMMS_ID for the two systems could resemble SRC1_client_FR and SRC1_client_ES.
2. Create the Intermediate Repository database for the first CMMS_ID you define.
3. For each additional CMMS_ID defined in Step 1.a, run the addSourceSystem job.
4. For each CMMS_ID defined in Step 1.a, create an EAM system record, using the CMMS_ID in the System Name field.
5. Select Test Connection for each EAM System record you created.