Now that you have Maximo implemented, the Maximo Integration Framework (MIF) gives you the ability to integrate it with your external software systems. This blog post shares how to perform one integration task that will help your Maximo Administrator find MIF messages fast, without searching through entire log files. Implementing this tip will simplify the life of your Maximo Administrator - and requires no programming to set up.
IBM defines the MIF as “a set of applications that help you to integrate the Maximo system to your external applications.” The MIF has grown from a small add-on tool in earlier versions of Maximo into a full-fledged module in Version 7, capable of integrating Maximo with almost any other software application. And like every software platform, there are tricks and tips to using some of the functions that are learned from experience. This month, we share one such tip that, when implemented, will simplify the tasks of your Maximo Administrator.
Message Tracking [Effort Level – EASY]
Message Tracking is a single page application useful for tracking integration messages that are sent in and out of Maximo. This is an application for Maximo System Administrators who have to support and troubleshoot integration problems. System Administrators use this application to look for the messages and associated statuses that are being sent and received by Maximo as they pertain to the actions taken by the MIF.
The typical view of an integration record within this application is shown in the figure below. Note that it is fairly easy for someone to look for a particular message by filtering the records by Integration Component, Operation or Current Status.
However, a typical enterprise implementation of Maximo usually results in multiple integrations being developed and with regular usage, the volume of data that gets exchanged between systems increases. Imagine having to search through hundreds or thousands of messages per integration and having to figure out the exact message that you are interested in. This task quickly becomes laborious. Speed up this process by setting up an identifier that will provide the information to search for a particular message record efficiently, using the External Message ID field within the Message Tracking application.
The External Message ID field is populated with the data element that will help identify a record amongst multiple records of the same type. For example, populating this field with the value from the ASSETNUM attribute identifies a particular Asset record being interfaced. In the example provided earlier, the PERSONID of the Person record being published out identifies the record easily. Follow the two steps below to set this up within Maximo.
Navigate to the Publish Channel or Enterprise Service application in question. For the sake of this post, use the MXPERSONInterface publish channel. Using the Select Action menu, open the Message Tracking dialog box. In the window that opens, enter the XPATH specification that points to the one attribute within the message that is both unique and a non-null value. For our example, enter the following in the External Message ID field.
Note that each attribute from the XML message is preceded by the namespace. For Enterprise Services, this namespace will be the one from the External system sending the message. As you can see, this XPATH value points to the PERSONID attribute of the Person record. This attribute is chosen because the PERSONID will always be unique for a particular Object (PERSON) and will never be null.
When Person records are published from Maximo by the Integration Framework, every record within the Message Tracking application will now display the PERSONID. So, you can now filter the records within the Message Tracking application using the Person ID as shown in the image below.
You now have provided your Maximo Administrator with a fool proof way to find MIF messages faster within the Message Tracking application so they don’t have to search through entire log files. That is, using the tip provided, they can filter messages within the Message Tracking application.
Be sure to visit the blog often to see what other Maximo tips and tricks our consultants will share with you.