First-time Deployment

Deploy Maximo Adapters for the First Time

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.

About This Task

These tasks may be completed by multiple people in your organization. We recommend, however, that the tasks be completed in the order in which they are listed.

Results


Step	Task	Notes
1	Configure the Maximo Context File	This step is required.
2	Maximo Context File Parameters	This step is required.
3	About Site Reference Configuration via the autojoin_control Table	This step is required.
4	Import the Maximo Notification Management File	This step is required.
5	Configure Context Parameters	This step is required.
6	Create the Intermediate Repository Database	This step is required.
7	Configure Site Reference Values	This step is required.
8	Create Object Structures in Maximo	This step is required.
9	Create Web Services in Maximo	This step is required.
10	Configure the Default Password	This step is required.
11	Set System Properties Settings for Web Service Response	This step is required.
12	Create a Maximoan SAPan SAP PIa ServiceMax EAM System Record	This step is required.
13	Enable Multiple Cultures From a Single Source System	This step is required.

Configure the Maximo Context File

Procedure

On the APM Connect server, navigate to the following folder: <root>:/APMConnect/Config.
Rename the folder RENAME_TO_SYSTEM_NAME to the name of the Maximo system that you are using.
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.
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.

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 Maximo system. 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 APM.	This value is required. You must enter the value MAXIMO.
Parameters	Description	Default or Recommended Value
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.
Parameters	Description	Default or Recommended Value
APM Connect Connection
CUSTOMER_NAME	The coded customer name.	Enter your unique value, which was provided during installation.
Parameters	Description	Default or Recommended Value
APM Connection Note: The APM Connection Parameters are not required for a cloud deployment.
APM_API_APP_SERVER	The name of the APM server.	This value is unique for each user.
APM_API_USE_SSL	Specifies whether the 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 APM server.	This value is unique for each user.
APM_DATASOURCE	The name of the APM data source to which the data will be exported.	This value is unique for each user.
APM_USERID	Your APM user ID.	This value is unique for each user.
APM_PASSWORD	Your APM password.	This value is unique for each user.
Parameters	Description	Default or Recommended Value
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 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 APM.	This value is unique for each user, and must match the value in the Name field in the EAM System family in 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.
Parameters	Description	Default or Recommended Value
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 APM.	A value is optional for this parameter. This value is unique for each user.
Parameters	Description	Default or Recommended Value
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.
Parameters	Description	Default or Recommended Value
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.
Parameters	Description	Default or Recommended Value
Work History Specific Filter
EXTRACT_PARENT_WO_ONLY	Determines whether to extract only parent work orders.	You must enter one of the following values: true: Specifies that APM should extract only the parent work orders from the Maximo system. false: Specifies that the entire work history hierarchy should be extracted from the Maximo system. The default value is false.
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 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, both Service Requests and Work Orders will be extracted.
Parameters	Description	Default or Recommended Value
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.
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.
Parameters	Description	Default or Recommended Value
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 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.
Parameters	Description	Default or Recommended Value
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.
Parameters	Description	Default or Recommended Value
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 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 APM and the reason for failure, will be sent. false: The failure detail report will not be sent.
Parameters	Description	Default or Recommended Value
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.
SFTP_STAGING_DIR	The temporary storage location for files that are waiting to be loaded.	Enter your unique value (for example, C:\APMConnect\Staging).
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

About Site Reference Configuration via the autojoin_control Table

The Equipment, Functional Location, and Work History records that are imported to APM are assigned to a Site based on a Site Reference. In the Maximo adapter, the Site Reference is configured using the autojoin_control table in the Intermediate Repository.

In the table, the value in the site_reference column in each row defines the Site that must be used while loading the data defined by the SQL statement specified in that row. To modify the value assigned as the Site in the imported records, you must modify the value in the site_reference column.

Important: Site records corresponding to the Sites that you want to assign to the records must exist in APM before you can import the records.

You can configure Site Reference in one of the following ways:

Direct Site Reference:

The Site Reference is configured with a specific site name (for example, Site 100).

Indirect Site Reference:

The Site Reference is configured to use the value in a specific APM field to assign the Site in the imported records. The following fields can be used as Site References for records extracted from Maximo Systems:

MI_FNCLOC00_SITE_C
MI_EQUIP000_SITE_C

By default, in the autojoin_control table, the site_reference column contains the following values:

#MI_FNCLOCOO_SITE_C# for Functional Location records
#MI_EQUIPOO_SITE_C# for Equipment records

These values indicate that the site assigned to the Functional Location and Equipment records is determined by the value in the SITEID field in the Maximo system.

Additionally, in the autojoin_control table, if the value in the site_reference column is null or blank in a row, the records will be assigned with a Site based on the value specified in the defaut_site_reference column. The default value in the default_site_reference column is *Global*, which assigns the Site Global to the imported records.

In the autojoin_control table, the value in the site_reference column for the rows that define relationships of the Work History with Functional Locations and Equipment, determines the Site assigned to the Work History records loaded by the Maximo adapters.

Configure Site Reference Values

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.

About This Task

Important: Site records corresponding to the Sites that you want to assign to the records must exist in APM before you can import the records.

Procedure

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

Using a database browser tool, access your Intermediate Repository.

A list of tables available in the repository appears.
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.
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.
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

Using a database browser tool, access your Intermediate Repository.
A list of tables available in the repository appears.
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.
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.
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 Structures in Maximo

About This Task

To connect your Maximo system and your APM system, you will need to create object structures in Maximo for the following:

Asset
Location
Work Order
Service Request

Procedure

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.

Create Web Services in Maximo

About This Task

Note: You must only complete this step if you are not using the REST services. REST services are not fully supported in Maximo versions 7.1 and 7.5.

To complete the connection between your Maximo and your APM System, you need to deploy each of the following web services in your Maximo system:

MIASSET
MIOPERLOC
MIWO
MISR

Procedure

On the Go To Applications menu, select Integration, and then select Web Service Library.
The Web Services Library page appears.
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.
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.
In the More Actions tab, select Deploy to Product Web Service Container, and then select Deploy Web Service.
Repeat Steps 1-4 to create the remaining web services.

Configure the Default Password

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

Procedure

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

What To Do Next

After configuring the default user name and password, you can run the web service, and authentication will be accomplished through the default user and password.

Set System Properties Settings for Web Service Response

Procedure

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.
In the Global Properties section, navigate to the property mxe.int.keyresponse.
On the mxe.int.keyresponse row, select .
The row is expanded, and the Global Properties Details appear.
In the Global Value box, enter 1.
The Global Value is equal to 1.

Results

Setting the Global Value to one enables Service Request numbers or Work Order numbers on APMRecommendation to be updated and the Request Number field will be populated. It allows the response returned during the update to contain key elements and will prevent the value from being null.

Create a Maximo EAM System Record

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

Procedure

Create a new EAM System record.
In the Datasheet ID box, select Maximo.
In the Name box, enter the name of your system.
If this system is the system to and from which you want to send data by default, select the Default EAM System? check box.
In the System Type box, select Maximo.
In the User ID box, enter a valid User ID.
In the Password box, select .
In the Enter EAM System Password window, in the Password box, enter the password that is associated with the specified user ID.
In the Confirm Password box, reenter the password.
Select OK.
In the Web Service URL box, enter the URL for the Maximo Web Services that will extract the data.
In the Language box, enter the code of the language for this connection (for example, EN).
In the Service Request Family Name box, enter the table name for the Service Request in Maximo (this value is usually MISR).
In the Work Order Family Name box, enter the table name for the Work Order in Maximo (this value is usually MIWO).
In the WO or SR box, enter the default notification type to be created. This value can either be WO or SR.
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.
Optional: Select Use Rest to have the system use REST requests to create service requests or work orders.
Select .
The EAM System record is saved.
Select , and then select Test Connection.
The connection parameters are verified, and the System ID box is populated with your EAM System Name.

Results

An EAM system record is created for the EAM system that defines a connection with APM. The ID for this EAM record should now be used in the Name field of a Site Reference record.
Linking an EAM system to an EAM System record enables the APM Connect Adapters to create Notifications against that EAM System.

Enable Multiple Cultures From a Single Source System

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

Procedure

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.
Create the Intermediate Repository database for the first CMMS_ID you define.
For each additional CMMS_ID defined in Step 1.a, run the addSourceSystem job.
For each CMMS_ID defined in Step 1.a, create an EAM system record, using the CMMS_ID in the System Name field.
Select Test Connection for each EAM System record you created.

Results

You have configured APM Connect to support multiple cultures from a single source system.