The third setup screen relates to the setup of the Maximo Service Request interface. Default values are provided (where appropriate), but configuration points are available in case a particular Maximo instance requires a deviation from the standard setup.
-
Disable Service Requests - Select this checkbox if the Maximo Service Request interface isn't required or if it will be configured later.
Disabling the service requests interface doesn't affect the assets and locations
synchronization. If the Disable Maximo interface checkbox was selected on the Maximo Server Settings screen, you need to select this checkbox to continue with j5 setup.
Query service request WSDL configuration
The j5 Maximo interface queries Maximo for service requests using a SOAP web service exposed by Maximo.
-
Service Request Query WSDL URL - Enter the WSDL URL of this web service in this box. If a SOAP service is configured off the default service request object (MXSR), the WSDL URL is: http://<server name>:<port name>/meaweb/services/MXSR?wsdl.
In some versions of Maximo, when a third party application queries the SOAP service
for service requests using the standard service request object, Maximo returns a constructor
error message. This is a defect in Maximo and is logged as APAR IJ05279 - Error using Web Service in Maximo 7.5.0.6 (IBM Ticket #: TS000804214). IBM has released a patch that addresses this issue. You might need to apply the
patch to use the out of the box web service.
-
Service Request Query Service URL - Enter the URL that j5 should use to call the query operation in the WSDL. This service URL is usually defined in the WSDL but Maximo can be configured to expose a different URL - this is why it is a separate configuration point. If a SOAP service is configured off the default service request object (MXSR), the service URL is: http://<server name>:<port name>/meaweb/services/MXSR. For more information on how to find the service URL, refer to Find the service URL for a web service.
-
Service Request Query Operation - Enter the text name for the web service operations on the WSDL for querying service requests. For example, if the web service operations are CreateMXSR, DeleteMXSR, QueryMXSR and so on, then the Service Request Query Operation is MXSR.
-
SOAP identifier for Service Request Set - Enter the SOAP element that contains the list of service requests. This defaults to MXSRSet.
-
Service Request Identifier - Enter the name of the field that is the unique identifier of a service request in the Maximo table. This is typically TICKETID.
It's important to enter the correct service request identifier. It's used to iterate
through the data set of service requests during a full synchronization, and it's used
as the unique identifier of the service requests in the j5 Service Request logbook.
-
Service Request Query Filter - When required, enter a filter condition to exclude a subset of service requests from the synchronization. This is in the form of a SQL WHERE clause. For example, FIELDX IS NOT NULL.
-
SQL query to fetch the Service Request record with the maximum ID - Enter a SQL query to identify the service request record with the largest ID. This is used by the batch processing during the full synchronization with Maximo. The maximum TICKETID sets the upper limit during synchronization to identify when the operation is complete. The default query is ticketid = (select max(ticketid) from ticket where status not in ('CLOSED', 'CANCELED', 'RESOLVED')).
-
Service Request Date Change Field - Enter the identifier for the field on a service request that displays the last date and time the service request was modified in Maximo. This is used to identify the change set during the incremental synchronization.
Create a service request WSDL configuration
When a service request is created in j5, it is submitted to Maximo so a Maximo service request can be created. This is done using a create service request web service exposed by Maximo.
-
Service Request Create WSDL URL - Enter the WSDL URL of this web service in this box
-
Service Request Create Service URL - Enter the URL that j5 should use to call the create operation in the WSDL. This service URL is usually defined in the WSDL but Maximo can be configured to expose a different URL - this is why it is a separate configuration point. For more information on how to find the service URL, refer to Find the service URL for a web service.
-
Service Request Create Operation - Enter the text name for the web service operations on the WSDL for querying service requests. For example, if the web service operations are CreateMXSR, DeleteMXSR, QueryMXSR and so on, then the Service Request Create Operation is MXSR.
-
SOAP tag identifier for Service Requests - Enter the name of the service request object in the create service request web service. This is SR in the out of the box installation, but it has been known to be different in customized Maximo environments (for example, TICKET).
The image below shows an example of the Service Request WSDL Create operation where the SOAP tag identifier for Service Requests is TICKET.
-
Number of look back days (Duplicate check) - j5 raises a note, for the end user, when a service request is created against a piece of equipment and a service request already exists for that same equipment in j5 within the configured look-back period of time. Enter the number of days that j5 should look back to check for duplicates.
Validation
-
Validate WSDL URLs - Select this checkbox if you want j5 to connect the Service Request Query WSDL URL and the Service Request Create WSDL URL with the SOAP authentication credentials provided, when you select Next. If this connection fails, an error message is displayed showing the reason for failure.
Schedule options
The j5 Maximo interface can be set to automatically synchronize service requests using the incremental synchronization mechanism.
-
Service Request Auto Sync Enabled - Select this checkbox if you want to automatically synchronize your service requests.
-
Sync at same time as asset sync - Select this checkbox if you want the interface to synchronize the service requests on the same schedule as the assets and locations.
-
Service Request Sync Schedule - This default to Daily. The following options are available: Daily, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Monthly. The Monthly schedule runs on the first day of every month.
-
Service Request Sync Time - Determines the hour of the day that the synchronization starts (00 to 23).
After entering your data, select Next. The setup process validates the above settings.