How to use IBM App Connect with IBM Maximo

Supported product and API versions

To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.

Connecting to Maximo

You can either complete the connection fields in the App Connect Designer Connect > Applications and APIs page or when you create a flow. If necessary, work with your Maximo administrator to obtain these values.

To connect App Connect to an Maximo account, complete the following steps.

1. To connect to Maximo from the App Connect for the first time, expand Maximo and click Connect.
2. From the Authorization method list, select the authorization method that you want to use to establish a connection.
   • Provide credentials for App Connect to use (BASIC)
   • Provide credentials for App Connect to use (API KEY)
3. Complete the connection fields.

   BASIC

   • Set the Maximo URL to the URL of the Maximo on-premises instance in the format <https>://<hostname>:<port> or <http>://<hostname>:<port>.
   • Set the User name to the username for the Maximo account.
   • Set the Password to the password for the specified username.
   • Private network connection (optional): Select the name of a private network connection that App Connect uses to connect to your private network. This list is populated with the names of private network connections that are created from the Private network connections page in the Designer instance. You see this field only if a switch server is configured for this Designer instance. For more information, see Connecting to a private network from App Connect Designer. (In App Connect Designer 12.0.10.0-r1 or earlier instances that include this field, the display name is shown as Agent name.)
   • Set the WebSphere Application Server user name to the username for the WebSphere Application Server account.
     Tip: If the Maximo instance is installed on WebSphere® Application Server, provide the username of the WebSphere Application Server account so that you can use WebSphere authentication. For more information, see Installing on WebSphere Application Server in the Maximo Asset Management documentation.
   • Set the WebSphere Application Server password to the password for the WebSphere Application Server account.

   API KEY

   • Set the Maximo URL to the URL of the Maximo on-premises instance in the format <https>://<hostname>:<port> or <http>://<hostname>:<port>.
   • Private network connection (optional): Select the name of a private network connection that App Connect uses to connect to your private network. This list is populated with the names of private network connections that are created from the Private network connections page in the Designer instance. You see this field only if a switch server is configured for this Designer instance. For more information, see Connecting to a private network from App Connect Designer. (In App Connect Designer 12.0.10.0-r1 or earlier instances that include this field, the display name is shown as Agent name.)
   • Set the API key to the API key that is used to authenticate the REST API calls. For more information, see API keys on the Maximo documentation.
   • Set the WebSphere Application Server user name to the username for the WebSphere Application Server account.
     Tip: If the Maximo instance is installed on WebSphere Application Server, provide the username of the WebSphere Application Server account so that you can use WebSphere authentication. For more information, see Installing on WebSphere Application Server in the Maximo Asset Management documentation.
   • Set the WebSphere Application Server password to the password for the WebSphere Application Server account.

   The following example shows completed fields to connect to Maximo from App Connect.

   

   Note: If Maximo is installed on WebSphere Application Server, you must also provide credentials for the WebSphere Application Server account.
4. Click Connect.

This action creates an account in App Connect. For more information, see .

What to consider first

Triggering an event-driven flow with a Maximo event

App Connect supports new, updated, and deleted event types for a defined set of Maximo objects.

To use any of these event types as the trigger for an event-driven flow, you must work with your Maximo system administrator to configure the Maximo Integration Framework. As part of this configuration, you need to provide the webhook callback URL that is supplied for the event in the App Connect flow editor.

Webhook callback URLs are unique to an App Connect instance, and Maximo account, object, and event type (as illustrated in the following figure), so you must configure a separate Maximo integration for each event type that you add to a flow. For example, if you are connected to Maximo with Account 1, and you want to trigger flows whenever a record is created, updated, or deleted for an asset object, configure three separate integrations for the New asset, Updated asset, and Deleted asset event types. You must also configure similar integrations for the event types for other Maximo objects under Account 1. After you configure the integration for a specific event type (for example, New asset), you can use it in multiple flows in your App Connect instance.The following example shows a webhook callback URL in App Connect.

Error handling in the Maximo Integration Framework

Messages in the outbound sequential queue are processed on a first-in-first-out basis and they remain in the queue until they are successfully delivered to App Connect or are deleted from the queue. If a message is flagged with a processing error, subsequent messages in the queue are not processed until the error is resolved or deleted.

If you're not seeing the expected results for your App Connect flow and no errors are logged for the flow in App Connect, a possible cause might be that the flow isn't being triggered because Maximo messages are not being delivered to the endpoint URL. Use the Message Reprocessing application to check whether any message is flagged with an error and then resolve or delete the error message. For more information, see Error management in the Maximo Asset Management documentation.

Events and actions

Maximo events

These events are for changes in this application that trigger a flow to start completing the actions in the flow.

Maximo actions

Your flow completes these actions on this application.

Assets (mxapiasset)

Create asset

Retrieve assets

Update asset

Delete asset

Update or create asset

Replace asset

Replace or create asset

Download assets as CSV

Assets (mxasset)

Create asset

Retrieve assets

Update asset

Delete asset

Update or create asset

Replace asset

Replace or create asset

Download assets as CSV

Companies (mxapivendor)

Create company

Retrieve companies

Update company

Delete company

Update or create company

Replace or create company

Download companies as CSV

Replace company

Contracts (mxapicontract)

Create contract

Retrieve contracts

Update contract

Delete contract

Update or create contract

Replace or create contract

Download contracts as CSV

Replace contract

Crafts (mxapicraft)

Create craft

Retrieve crafts

Update craft

Delete craft

Update or create craft

Replace or create craft

Download crafts as CSV

Replace craft

Labors (mxapilabor)

Create labor (mxapilabor)

Retrieve labors

Update labor

Delete labor

Update or create labor

Replace labor

Replace or create labor

Download labors as CSV

Locations (mxapilocations)

Create location

Retrieve locations

Update location

Delete location

Update or create location

Replace location

Replace or create location

Download locations as CSV

Person groups (mxapipersongroup)

Create person group

Retrieve person groups

Update person group

Delete person group

Update or create person group

Replace or create person group

Download person groups as CSV

Replace person group

Person users (mxapiperuser)

Create person user

Retrieve person users

Update person user

Delete person user

Update or create user

Replace or create person user

Download person users as CSV

Replace user

Purchase orders (mxapipo)

Create purchase order

Retrieve purchase orders

Update purchase order

Delete purchase order

Update or create purchase order

Replace or create purchase order

Download purchase orders as CSV

Replace purchase order

Service addresses (mxapiseraddress)

Create service address

Retrieve service addresses

Update service address

Delete service address

Update or create service address

Replace or create service address

Download service addresses as CSV

Replace service address

Service requests (mxapisr)

Create service request

Retrieve service requests

Update service request

Delete service request

Update or create service request

Replace or create service request

Download service requests as CSV

Replace service request

Work orders (mxapiwo)

Create work order

Retrieve work orders

Update work order

Delete work order

Update or create work order

Replace work order

Replace or create work order

Download work orders as CSV

More items are available after you connect App Connect to Maximo.