IBM TAS Connector for Maximo

Import the OM Package labelled APIConnector into the TAS instance. Navigate to Tools -> Administration -> Object Migration and select New Import Package to begin the import process. For more information, see Object migration overview.

Navigate to Portfolio > People > My Profile and select the user profile that triggers the action. In the Date Time Format field, set the format in UTC.

1. Create an Organization named TRIRIGA
   1. Navigate to the Organizations page and click the blue + button on the top row.
   2. Fill in the Organization name as TRIRIGA and the description as TAS Organization.
   3. Fill in the remaining required fields as:

      Field name	Value
      Base Currency 1	USD
      Item Set	SET1
      Company Set	COMPSET1
      Default Item Status	PENDING
      Default Stock Category	STK

   4. Click Save Organization on the left side of the screen under Common Actions. This is set to Active state later after there is a clearing account.
2. Create a Testing clearing account in Chart of Accounts
   Un-require the GL Account fields

   1. Navigate to Financial -> Chart of Accounts and click on the previously created TAS org in the Organizations table. Currently, there should be no GL Accounts for TAS present.
   2. Click GL Component Maintenance on the left side under More Actions, and add a New Row with the following values:

      Field name	Value
      GL Component Value	1001
      Description	Testing
      Active	Yes

   3. Click OK. Click New Row under GL Accounts for TRIRIGA and click the Search icon to search for that GL Component. Select the component to populate in the GL Account and Description fields. The Active Date field must auto-populate to the current date.
   4. Navigate back to Organizations and update the TRIRIGA organization to show the newly created Clearing Account, select the Active check box, and then click Save Organization.
3. Create a site TRIMAIN and set it to active
   1. On the Organization page, click the Sites tab at the top of the page.
   2. Click New Row under Sites and enter TRIMAIN as the site name and MAIN Site as the description. Set the site to Active.
   3. Click Save Organization.
4. API Key
   MAS

   1. Navigate to Integration > API Keys.
   2. Click Add API key.
   3. Select the MXINTADM user and then click Add to generate an API key for this user. Securely store this API key for later use.
   Maximo 7.6.1.2

   1. Navigate to Administration -> Administration. A new window opens with the Maximo-X application.
   2. On the Integration page, click the API Keys tab at the top of the page and then click the Add API key button.
   3. Select the MXINTADM user and click the Add button to generate an API key for this user. Securely store this API key for later use.
5. Integration Controls
   1. Navigate to Enterprise Services and click Create Integration Controls. These integration controls help translate specific external values into values Maximo understands. The following tables contain values to set up this demo, but can be customized to fit your TAS and Maximo naming conventions. There should be 5 X-Ref Integration Controls created with the following associations:

      Integration control	Maximo value	External value	Description	Domain
      PLUSILOCSTATUS	ACTIVE	ACTIVE	TAS Location Status mapping for inbound flows	LOCASSETSTATUS
      PLUSILOCSTATUS	INACTIVE	REVIEW IN PROGRESS	N/A	N/A
      PLUSILOCSTATUS	OPERATING	OPERATING	N/A	N/A
      PLUSIORG	TRIMAIN	IBM	Organization mapping for TAS	N/A
      PLUSIORG	TAS	TAS	N/A	N/A
      PLUSIORGEN	TAS	EAGLENA	TAS Organization mapping for Inbound flow	N/A
      PLUSIORGEN	TAS	IBM	N/A	N/A
      PLUSIORGEN	TAS	MAXIMO ORG	N/A	N/A
      PLUSIORGEN	TAS	TAS	N/A	N/A
      PLUSIPRIORITY	1	High	Priority mapping for TAS	N/A
      PLUSIPRIORITY	2	Medium	N/A	N/A
      PLUSIPRIORITY	3	Low	N/A	N/A
      PLUSISITEEN	TRIMAIN	BEDFORD	TAS Location mapping for inbound flows	N/A
      PLUSISITEEN	TRIMAIN	SPACE 01	N/A	N/A
      PLUSISITEEN	TRIMAIN	TRIMAIN	N/A	N/A

   2. Once these Integration Controls are created, associate them in both the created Enterprise Services and Publish Channels by using the following two tables:

      Enterprise service	Control
      PLUSIASSET	PLUSIORGEN
      PLUSIASSET	PLUSIPRIORITY
      PLUSIASSET	PLUSISITEEN
      PLUSILOCATION	PLUSILOCSTATUS
      PLUSILOCATION	PLUSISITEEN
      PLUSILOCATION	PLUSISTATUS
      PLUSIPERSON	PLUSIORGEN
      PLUSIPERSON	PLUSISITEEN
      PLUSIWO	PLUSIWOPRIORITY

      Publish channel	Control
      PLUSIASSET	PLUSIPRIORITY
      PLUSILOCATION	N/A
      PLUSIPERSON	PLUSIORG
      PLUSISR	N/A
      PLUSIWO	PLUSIWOPRIORITY
      PLUSIWO	PLUSIWOSTART

   3. Return to the PLUSITRIRIGA External System. On the left side of the External Systems page, select Setup Integration Controls under More Actions and make sure that all 5 Integration Controls are showing as present.
6. Enable Object Structure Security
   The user needs to be able to transact against the specific object structures in Manage.

   1. Navigate to Object Structures and search for MXPERSON. On the left side of the MXPERSON screen select Configure Object Structure Storage and toggle the Use Object Structure for Authorization Name button. The object structure is saved.
      

      Complete this process for the following object structures:

      • MXASSET
      • MXOPERLOC
      • MXSR
      • MXWO
      • MXDOMAIN
   2. Navigate to Security -> Security Groups and select the security group the current user is part of.
   3. Click the Object Structures tab and filter search for MXPERSON. Once selected, click Grant Listed Options for This Object Structure and save the Group.
      
      Note: Repeat this process for the other changed structures.
7. Application Designer Changes

   Navigate to System Configuration -> Platform Configuration -> Application Designer.

   • Person
     1. 1. Search for PERSON, switch to the Person tab and select a section to add three new boxes.
        2. At the top, click the Control Palette icon and add a Multipart Textbox at the bottom of the section. Add the values from the below table within the properties of the Multipart Textbox and click Save Definition.

           Note: Ensure that the Attributes are taken from the PERSON Object.

           Type of Control	Label	Attribute	Attribute for Part 2 (If Multipart Textbox)	Lookup	Input Mode for Part 2 (If Multipart Textbox)
           Multipart Textbox	TAS Location Path	PLUSIPRIMARYLOCPATH	PLUSILOCATIONPATH.DESCRIPTION	VALUELIST	Read only
           Multipart Textbox	TAS Primary Organization	PLUSIORGPATH	PLUSIORGANIZATIONPATH.DESCRIPTION	VALUELIST	Read only
           Textbox	TAS Record ID	EXTERNALREFID (From the Person Object)	N/A	N/A	N/A

           Follow the same directions by using the above information for the other objects that will be used in the integration.
   • Asset

     Search for ASSET in Application Designer.

     Note: Ensure that the Attributes are taken from the ASSET Object.

     Type of Control	Label	Attribute	Attribute for Part 2 (If Multipart Textbox)	Lookup	Input Mode for Part 2 (If Multipart Textbox)
     Multipart Textbox	TAS Building Equipment Spec	PLUSIASSETSPECNAME	PLUSIASSETSPECCLASS.DESCRIPTION	VALUELIST	Read only
     Multipart Textbox	TAS Primary Organization	PLUSIORGPATH	PLUSIORGANIZATIONPATH.DESCRIPTION	VALUELIST	Read only
     Multipart Textbox	TAS Location Path	PLUSILOCPATH	PLUSILOCATIONPATH.DESCRIPTION	VALUELIST	Read only
     Textbox	TAS Record ID	EXTERNALREFID (From the Asset Object)	N/A	N/A	N/A

   • Location

     Search for LOCATION in Application Designer.

     Note: Ensure that the Attributes are taken from the LOCATION Object.

     Type of Control	Label	Attribute	Attribute for Part 2 (If Multipart Textbox)	Lookup	Input Mode for Part 2 (If Multipart Textbox)
     Multipart Textbox	TAS Space Classification	PLUSISPACECLASSIFICATION	PLUSISPCCLASSIFICATION.DESCRIPTION	VALUELIST	Read only
     Multipart Textbox	TAS Parent Location	PLUSIPARENTLOCATION	PLUSIPARENTPATH.DESCRIPTION	VALUELIST	Read only
     Textbox	TAS Record ID	EXTERNALREFID (From the Location Object)	N/A	N/A	N/A

   • Service Request

     Search for SR in Application Designer.

     Note: Ensure that the PLUSIREQCLASSID Attribute is taken from the TICKET Object.

     Type of Control	Label	Attribute	Attribute for Part 2 (If Multipart Textbox)	Lookup	Input Mode for Part 2 (If Multipart Textbox)
     Multipart Textbox	TAS Request Classification	PLUSIREQCLASSID	PLUSIREQCLASS.DESCRIPTION	VALUELIST	Read only
     Multipart Textbox	TAS Primary Organization	PLUSIORGPATH	PLUSIORGANIZATIONPATH.DESCRIPTION	VALUELIST	Read only
     Multipart Textbox	TAS Parent Location	PLUSIPARENTLOCATION	PLUSIPARENTPATH.DESCRIPTION	VALUELIST	Read only
     Textbox	TAS Record ID	EXTERNALREFID (From the Location Object)	N/A	N/A	N/A

     Click Save Definition after the changes are added.

   • Work Order

     Search for WOTRACK in Application Designer.

     Note: Ensure that the PLUSIREQCLASSID Attribute is taken from the WORKORDER Object.

     Type of Control	Label	Attribute	Attribute for Part 2 (If Multipart Textbox)	Lookup	Input Mode for Part 2 (If Multipart Textbox)
     Multipart Textbox	TAS Location Path	PLUSILOCPATH	PLUSILOCATIONPATH.DESCRIPTION	VALUELIST	Read only
     Multipart Textbox	TAS Primary Organization	PLUSIORGPATH	PLUSIORGANIZATIONPATH.DESCRIPTION	VALUELIST	Read only
     Textbox	External Ref ID	EXTERNALREFID (From the Work Order Object)	N/A	N/A	N/A

     Click Save Definition after the changes are added.

8. TAS to Maximo Service Request Comment & Attachment Support
   The PLUSITRIServiceRequest2MX_v_1_1_0 integration supports both Comments and Attachments from TAS. This includes pictures or images that are attached as either Comments or Attachments in TAS. You must do the following configuration steps to include Comments and Attachments:

   • DB Config
     1. Go to Database Configuration and pull up the WORKLOG object.
     2. Add EXTERNALREFID as an attribute with a type ALN and 50 length.
     3. Turn on Admin Mode and run Database Configuration for this change to be referenced in the Index.
     4. Once EXTERNALREFID is added, navigate to Indexes and add the index PLUSIEXTREF. Under the Columns table ensure to reference the EXTERNALREFID attribute that was created and leave Enforce Uniqueness unchecked.
     5. Turn on Admin Mode and run Database Configuration again to save the changes
   • Object Structure
     1. Navigate to Object Structure and search MXSR. Duplicate this Object Structure and rename it as PLUSISRDOCS.
     2. Add the following new Source Objects to the Structure underneath SR: DOCLINKS and WORKLOG.
     3. Select the WORKLOG Source Object. In the Details section add the PLUSIEXTREF Index to the Alternate Key field. Navigate to Exclude/Include fields and then click Non-Persistent fields in the window and ensure that Description_LongDescription is selected as Included.
   • Enterprise Services

     After making the changes in database and object structure level, you must reference the changes in the Enterprise Service.

     1. Duplicate the default PLUSISR Enterprise Service and rename it as PLUSISRDOCS that references the newly created Object Structure.
     2. Remove the default PLUSISR Enterprise Service from the PLUSITRIRIGA External System to delete the Enterprise Service. After deletion, duplicate PLUSISRDOCS and name it PLUSISR to replace the deleted Enterprise Service.
     3. Add the new PLUSISR back into the External System. When a Service Request arrives containing a comment or an attachment, Maximo keeps track of the comments in the Worklog section and images or documents in the Attachments section.

1. Navigate to the End Points application and click Test at the bottom of the integration that you would like to test.
2. Send a test payload that is a valid object. For example, {"Hello":"World"}.
3. If the response is anything other than Bad Request, see what might be causing the error

1. Extract the App Connect certificate from an imported flow URL. Navigate to the flow's page and click on Test and then Try It to get the proper URL.

2. Navigate to the Admin dashboard for MAS and go to the workspace where Manage is deployed.

   

3. Update the configuration and scroll down to Imported Certificates. Untick the System managed button and fill in the extracted certificate in the fields.

   

4. Click Apply Changes at the top of the page and MAS will update the trust store with the new certificate.

Configure WebSphere Certificates. This makes a test connection to a Secure Sockets Layer (SSL) port and retrieves the signer from the server during the handshake.

1. Log into the WebSphere console that is hosting the Maximo server.

2. Click on Security -> SSL certificate & key management. Under Related Items click on Key stores and certificates.
   
3. Click on CellDefaultTrustStore and on the next page under Additional Properties click on Signer certificates.
   

4. From this page, click Retrieve from Port and fill in the required fields using the table below:

   

   Field	Value
   Host	The host from the imported flow URL
   Port	443
   Alias	appconnect

5. Once all three have been entered in, click Retrieve signer information and the information from the URL will populate on screen. Click Save in the box at the top and then repeat the process for NodeDefaultTrustStore.