Configuring Maximo (TPAE IF ) for TDI Connectors

Integrating TAMIT with TDI using TPAE IF

This article describes how TDI and TAMIT are integrated through the newly added connectors in TDI such as the Simple TPAE IF Connector and the TPAE IF Connector.

Mr. Raghavendra T A (raghavendra.ta@in.ibm.com), Staff software Engineer, IBM

Photo of Raghu T A Raghavendra T A is Staff Software Engineer, currently working with Tivoli Directory Integrator Development team at IBM India Software Labs. He holds Master degree in Systems Engineering from Banaras Hindu University. He is IBM Certified Administrator - Tivoli Monitoring V6.2, Certified in IBM Tivoli Netcool/Omnibus V7.2 Implementation.



Mr. Nagesh Bhagwat (nagesh_bhagwat@in.ibm.com), Staff Software Engineer, IBM India Software Lab

Photo of Mr. Nagesh R. BhagwatNagesh is Staff Software Engineer and currently working with Tivoli Directory Integrator Level 3 development support team at IBM India Software Labs. He holds Bachelor of Engineering Degree in Computer Science. He is IBM Tivoli Access Manager for e-business V6.0 Implementation-certified, IBM Tivoli Directory Server V6.2 deployment Certified, IBM Tivoli Directory Integrator V7.1 deployment Certified, IBM Certified DB2 V 8.1 Associate and SUN Certified Java Professional and he has more then 6 years of IT experience.



Abhijit C. Dusane (abhijitdusane@in.ibm.com), Staff Software Engineer, IBM India Software Labs

Photo of  Abhijit DusaneAbhijit is currently leading the Tivoli Directory Integrator Level 3 support at IBM India Software Labs. Abhijit has completed his Masters degree in Computer Science from the University of Pune and has more than seven years of IT experience.



11 May 2012

Introduction and Solution Architecture

IBM® Tivoli® Directory Integrator enables synchronization, transformation and migration of generic and identity data across heterogeneous systems, helping organizations maintain consistent and trusted data across multiple resources.

Tivoli Asset Management for IT (TAMIT) solutions deliver increased visibility, control and automation to support efficient, cost-effective IT asset management throughout the asset life cycle, including planning, acquisition, management and disposition of software, hardware, and related licenses.

The Tivoli Process Automation Engine (TPAE), also known as Base Services, is a collection of core Java classes and is used as a base to build Java applications. The Integration Framework, a TPAE feature contains standard integration objects (Object Structures and interfaces) and outbound/inbound objects. The TPAE IF Connector connects Tivoli Directory Integrator to the TPAE Integration Framework to exchange information.

The TPAE IF Connector reads from and writes to the Integration Framework. It supports Maximo® Business Object (MBO) and is processed through an integration object. This Connector uses the MBO layer for validating imported or exported objects.

This article describes how TDI and TAMIT are integrated via newly added connectors in TDI i.e Simple TPAE IF Connector and TPAE IF Connector.

It provides detailed steps for the following.

  • Middleware installation and Configuration for TAMIT.
  • TAMIT (Maximo) installation and Configuration.
  • Maximo post install configuration.
  • Maximo configuration for TDI TPAE IF Connector.
  • TDI Solution test verification.
  • Troubleshooting.

Architecture

The below diagram describes the basic architecture of the solution, how TDI TPAE IF Connector will communicate with TPAE Integration framework (IF)

Figure 1. Architecture
Architecture

Middleware Installation for TAMIT

This section describes the middleware installation that is required before TAMIT is installed.

  • For Middleware installation, extract all the TAMIT and Middleware install images.
  • Copy the missing images from TAMFIT_V722_2of2_Multiplatform to TAMFIT_V722_1of2_Multiplatform directory.
  • Launch TAMFIT_V722_1of2_Multiplatform\Launchpad.exe.
    Figure 2. TAMIT Installation Wizard
    TAMIT Installation Wizard
  • Launch the IBM Tivoli Asset Management for IT Installation wizard.
  • Select Middleware Installer. Click Next.
  • Specify appropriate directory as workspace to store deployment choices and configuration parameters. Click Next.
  • Select to install the following features to deploy.
    • Database Server.
    • Directory Server.
    • J2EE Server.
  • Select Secure J2EE Server using the Directory Server. Click Next.
  • Summary of components to be installed. Click Next
  • Override the local hostname is not selected.
  • Select the checkbox to use this password as the value for all subsequent passwords. Specify appropriate password values. Click Next.
  • Select appropriate Install location.
  • Specify username and password (will be filled automatically) for DB2 Server Administration. Click Next.
  • Specify Default instance name, instance port, username and password (automatically filled). Click Next.
  • Specify configuration parameters Instance name, Port, Instance username for Database Instance. Click Next.
  • Specify configuration parameters for DB2 Administrator Group and DB 2 user group. Click Next.
  • Specify configuration parameters Install location, Administrator distinguished name and Administrator password (automatically filled) for Tivoli Directory Server (TDS). Click Next.
  • Specify configuration parameters Organization unit, Organization and country suffix, Directory server port, Directory server secure port, Administration port and Administration secure port for TDS . Click Next.
  • Specify configuration parameters Database name, Instance name, Port and Instance User password for TDS Instance. Click Next.
  • Specify configuration parameters LDAP Hostname, Directory server port, LDAP base entry, User Suffix, Group Suffix and Organization container suffix for WebSphere Application Server (WAS) security. Click Next.
  • Specify configuration parameters Bind distinguished name and Bind password for WAS security. Click Next.
  • Specify configuration parameters Install location, Administrator username and Administrator password for WAS ND. Click Next.
  • Specify configuration parameters Deployment Manager Profile name and Application server profile name. Click Next.
  • Specify configuration parameters Cell name, Deployment Manager node name, Application server node name, Application server name and Update Installer install location. Click Next.
  • Specify configuration parameters Install location, HTTP port and Admin server port for IBM HTTP Server. Click Next.
  • Specify configuration parameter Profile name for configuring WAS plugin for IBM HTTP server. Click Next.
  • Select specify a directory option. Click Next.
  • Specify a directory having the appropriate install images available. Click Next.
  • If you face any problem like images not found, kindly refer to troubleshooting section for more details.
  • Select deploy the plan.
  • Summary page will be shown before deployment starts. Click Deploy.
  • Deployment in progress.
    Figure 3. Middleware Deployment
    Middleware Deployment
  • Once deployment is complete, summary page is shown. Middleware installation is complete. Click Finish.

TAMIT installation

This section will describe installation of TAMIT.

Select Install IBM Tivoli Asset Management for IT v7.2.2.0 from launchpad

Figure 4. TAMIT Installer
TAMIT Installer
  • Select Tivoli Asset Management for IT 7.2.2.0 and Click Next.
  • Click Next.
  • Select Installation directory for TAMIT and Click Next.
  • Select Simple. Click Next.
  • Specify Host name, Remote user ID and Remote password. Click Next.
  • Specify Database userID, Database password, Database Instance administrator user ID and Database instance administrator password. Click Next.
  • Specify User ID, Password. Click Next.
  • Keep SMTP server and Administrator e-mail blank. If required SMTP server can be configured later. Click Next.
  • Select Deploy data integration and context menu services into the same database that you created for the product. Click Next.
  • Select In a new Program Group. Specify Tivoli Asset Management for IT. Click Next.
  • Click Install.
    Figure 5. TAMIT Installation Sucess
    TAMIT Installation Sucess
  • Click Done to finish installation.

Maximo Post Install configuration

Login to maximo console http://localhost/maximo/ui using administrator privileges and perform the following steps.

1. Create an organization with Site:

  • Create Currency codes:
  • Goto Financial->Currency codes.
  • Click on New row.
  • Enter a name (ex:- USD).
  • Enter description (ex:- United States Dollar).
  • Save.

2. Create Item and Company Sets

  • Goto Administration->Sets.
  • Click on New row .
  • Enter a set name (ex:- IT Items).
  • Enter "Type" as "ITEM"
  • Set default "default item status" to ACTIVE.
  • Click on New row.
  • Enter set name (ex:- IT Comps).
  • Enter Type = "COMPANY".
  • Set default "default item status" to ACTIVE.
  • Save.

3. Create Organization

  • Goto->Administration->Organizations.
  • Click on new organization icon, in the toolbar.
  • Enter the Organization name (e.g. "IBM").
  • Select Base Currency 1 (select the currency you created in step 1).
  • Select Item Set (select the Item set you created in step 2).
  • Select Company Set (select the Company set you created in step 2).
  • Select a default item satus (ex: "PENDING").
  • Set 'default item status' to "active".
  • Save.
  • Click on Site tab.
  • Click on new row, in Site tab.
  • Enter the site name (e.g. 'B901').
  • Save Organization.

4. Create GL Component

  • Goto->System Configuration->Platform Configuration->Database Configuration.
  • In 'Select Action' drop down box, select 'GL Account Configuration'.
  • Select 'New Row'.
  • Enter Component name 'SSSCOMPONENT' (or any name).
  • Enter Length '5'.
  • Enter Type 'ALN'.
  • Screen Delimiter '-' (sinal de menos).
  • Click OK (it may take a while to get the control back, be patient).

5. Create GL Account

  • Goto->Financials->Chart of Accounts.
  • Select your organization, "IBM", from the list.
  • Create a GL Component.
    • In 'Select Action' drop down box, select 'GL Component Maintenance'
    • Click on New row.
    • Enter a GL Component value(length must be less than 5) (ex:- GLA1).
    • Enter GL component description (ex:- GLComponent1).
    • Select "ok"
  • Create GL Account.
    • Click on New row on GL Accounts
    • Select your GL Account component GLA1.
    • Choose segment as 'SSSCOMPONENT'.
    • Select "ok".
    • Save

6. Set Clearing Account on Organization

  • Go back to Organization App.
  • Select your Org, "IBM".
  • Go to Clearing Account field and select value (select the GL Account you just created.).
  • Choose segment as 'SSSCOMPONENT'.
  • Check 'Active?'.
  • Activate Site
    • Goto Sites tab
    • Open twisty on the site entry to see details.
    • Check "Active?"
    • save.

7. Set up default insert site

  • Goto->Security->Users.
  • Search for maxadmin and open the record.
  • Set 'Default Insert Site' to 'B901' (if you used a different site name in the steps above, use that instead).
  • Set 'Storeroom Site for Self-Service Recquisitions' to 'B901' also.
  • save.
  • Restart mxserver from WAS admin console .

8. Commit Changes to the Database

  • In Websphere - Stop MXServer using WAS Admin Console.
    Figure 6. Stop Maximo Server
    Stop Maximo Server
  • Open a command prompt
  • Go to c:\ibm\smp\maximo\tools\maximo
  • Run the command: configdb.bat. The following output would be seen.
    Figure 7. ConfigDB output
    Configdb output
  • Run the command : dropbackup.bat. The following output would be see.
    Figure 8. dropbackup output
    dropbackup output
  • In Websphere - Start MXServer using the WAS Admin Console.
    Figure 9. Start Maximo Server
    Start Maximo Server
  • Maximo post install configuration is complete.

Configuring Maximo for using TDI TPAE IF Connector

Maximo configuration for TDI TPAE IF connector needs external system configuration

External system configuration has two steps

  • Generating XML schema definition
  • Creating Enterprise Service

Generating XML schema definition

When using the TPAE IF Connector for the first time, perform the following steps:

  • Log on to Maximo as an administrator to perform system configuration tasks.
  • From the Go To menu on the Navigation Toolbar, select Integration -> Object Structures to open the Object Structures application.
  • Repeat the following steps for each Object Structure you are going to use:
  • On the List tab, search for the name of the Object Structure, for example, MXASSET.
  • To search, open the Filter and type the name of the Object Structure, or a partial name, in the Filter field of the Object Structure column. Press ENTER.
  • Click the Object Structure name to open the record for the Object Structure.
  • From the Select Action menu, select Generate Schema/View XML.
    Figure 10. Generate Schema/XML
    Generate Schema/XML
  • Click OK. The View XML dialog box appears.
  • Click OK to return to the List tab.

Creating Enterprise Service

The Tpae IF Connector supports both Object Structure Services and Enterprise Services. If you specify the External System parameter, you need to provide names of the Enterprise Services for the following parameters:

  • QUERY Enterprise Service - this parameter requires services that are bound to the specified Object Structure.
  • SYNC Enterprise Service - this parameter requires services that are bound to the specified Object Structure.
  • MAXOBJECT/MAXATTRIBUTE QUERY Enterprise Service - this parameter is used to obtain metadata information for the Object Structure and requires service bound to the Object Structure containing MAXOBJECT/MAXATTRIBUTE MBOs.

Tpae IF Connector uses these parameters to query or modify an Object Structure using Enterprise Services instead of Object Structure Services.

Note: In case of Simple TPAE IF Connector you may need to create Enterprise Services for Create, Update, Delete, Query and sync operations

To create an Enterprise Service for an Object Structure through a specified external system:

  • Log on to Maximo as an administrator to perform system configuration tasks.
  • From the Go To menu on the Navigation toolbar, select Integration -> Enterprise Services to open the Enterprise Services application.
  • Click New Enterprise Service to create an Enterprise Service.
  • Provide details for the following the parameters:
  • Enterprise Service - unique name for the Enterprise Service.
  • Adapter - name of the adapter, which is used by Enterprise Service. The default name is Maximo.
  • Object Structure - name of the Object Structure associated with the Enterprise Service.
  • Operation - indicates the type of operation. The default operation is Sync. The Sync option includes Create, Delete, and Update functionality. For Tpae IF Connector, you can create an Enterprise Service only for Query or Sync operations
    Figure 11. Creating Enterprise Service
    Creating Enterprise service
  • Enable and save your Enterprise Service.
  • From the Go To menu on the Navigation toolbar, select Integration -> External to open the External Systems application.
  • Select the external system and its Enterprise Services tab.
  • Click New row and type the name of the newly created Enterprise Service
    Figure 12. Adding Enterprise services
    Adding Enterprise service
  • Enable the external system
    Figure 13. Enable external system
    Enable external system

Maximo configuration for TDI TPAE IF connector is complete


TDI Solution test verification

  • First step of testing the solution is to copy the required jars as indicated below.
    • Copy <TDI_Install_Dir>/examples/ TpaeIFConnector/ TpaeIFConnector.jar To the location <TDI_Install_Dir>/jars/connectors.
    • Copy <TDI_Install_Dir>/examples/SimpleTpaeIFConnector/SimpleTpaeIFConnector.jar to the location "<TDI_Install_Dir>/jars/connectors.
  • Launch TDI v7.1 (7.1 Fix pack 6 is recommended)
  • Create a sample TDI project say "TDI-TPAEProj" as shown below.
  • Click on File -> New -> TDI Project
    Figure 14. TDI project
    TDI Project
  • Specify any project name, in this case it is "TDI-TPAEProj" and click Finish.
    Figure 15. TDI project name
    Architecture
  • Import the config from the <TDI_71_fp6_Install_Dir>/examples/TpaeIFConnector/TpaeIFConnector_example.xml.
    • This can be done by simply selecting "TDI-TPAEProj" project and click on File-> "Open Tivoli directory integrator configuration file" option and use above configuration file path to import.
  • The AddOnly AL reads the assets from assets.txt and adds those Assets into maximo using the TPAE IF Connector (add mode ).
  • Modify the following connection parameters in the AddOnly AL, in order to add the new asset to maximo.
    • Modify the <TDI_Install_Dir>/examples/ TpaeIFConnector/assets.txt (if needed).
    • Modify Base URL from TPAE IF Connection parameter.
    • Modify credentials (User ID / Password).
    • Modify the Object Structure.
      Figure 16. TPAE Connector Panel
      TPAE connector panel
  • Also modify the parameters under the Enterprise services section with the services that you have created and also modify the external systems info as shown below.
    Figure 17. TPAE Connector Advance panel
    TPAE_Connector_Advance_Panel

Note: The MyMaxEnter1 and MyMaxEnter2 are the enterprise services created earlier.

  • Run the "AddOnly" AL and the following output will be seen.
    Figure 18. AL output
    AL_Output
  • After successful AL run, ASSET-3 and ASSET-4 will be added to maximo. The assets.txt was modified with values ASSET-3 and ASSET-4.
  • Verify maximo console whether Asset has been added.
    • Login to maximo console as administrator.
    • Click on Go To -> Assets -> Assets
      Figure 19. Maximo Asset
      Maximo Asset
  • Once you are there, hit enter one should see "TDI-ASSET 3" and "TDI-ASSET 4". The image below shows newly added Assets "TDI-ASSET 3" and "TDI-ASSET 4" along with existing assets ( "TDI-ASSET1" , "TDI-ASSET2" ) created before.
    Figure 20. Maximo Asset
    Maximo Asset
  • Verification is complete.
  • Similarly you can perform other operation likes Iterate, Lookup, Update and Delete using TPAE IF Connector and also using Simple TPAE IF Connector

Troubleshooting

Problem-I: TAMIT Middleware installation failure

Description: TAMIT Middleware installation fails with missing middleware images

Figure 21. Instllation failure
Installation failure

Solution:

Create the new directory with name "middleware" and extract all three middleware zip to this directory and specify this path.

Problem-II:TAMIT installation failure with user "maximo"

Description: During TAMIT installation where DB2 database is configured for maximo, installation fails with following error

Figure 22. Installation failure
Installation failure

Solution: You need to create the maximo user manually on specified machine but sometime this doesnot help on windows machine, so user need to restart the machine and clear the C:\ibm\smp directory, Check the DB2, WAS and TDS services before installation is started

Problem-III: Incorrect documentation

Description: In TDI v7.1 Fixpack 6 - <TDI_Install_Dir>/examples/ TpaeIFConnector/TpaeIFConnector.pdf document under External system configuration- Creating Enterprise Service- Step-2 is wrong, instead it should be as follows

From the Go To menu on the Navigation toolbar, select Integration -> Enterprise Services to open the Enterprise Services application

Problem-IV: Example AL failure

Description: Once the external system configuration is completed in TPAEIF Connector, when you the TDI example TpaeIFConnector_example.xml, AL will fail with following error.

Listing 1.
'Error 500: nested exception is: psdi.util.MXApplicationException: 
BMXAA1562E - The external system EXTSYS1 is disabled.

Solution :

  • Enable the external systems along with each enterprise services created.
Figure 23. Enable external system
Enable external system

Problem-V: Unable to login to maximo

Description: Sometime when you try to login to maximo console, Login fails.

Solution:

  • Ensure your TDS server instance is up and running.

Problem-V: Extracting detailed maximo error/exception.

Description: If an AssemblyLine with a TPAE IF Connector fails, you can retrieve additional information about the error as follows

Solution:

  • Add the following code in the "Default On Error hook" or "Prolog- On Connection error hook"..
Listing 2.
task.logmsg("ERROR", "An exception occurred.");
mxConn.connector. extractMaximoException(error);  //Assuming mxConn is connector name
task.dumpEntry(error);

Resources

Comments

developerWorks: Sign in

Required fields are indicated with an asterisk (*).


Need an IBM ID?
Forgot your IBM ID?


Forgot your password?
Change your password

By clicking Submit, you agree to the developerWorks terms of use.

 


The first time you sign into developerWorks, a profile is created for you. Information in your profile (your name, country/region, and company name) is displayed to the public and will accompany any content you post, unless you opt to hide your company name. You may update your IBM account at any time.

All information submitted is secure.

Choose your display name



The first time you sign in to developerWorks, a profile is created for you, so you need to choose a display name. Your display name accompanies the content you post on developerWorks.

Please choose a display name between 3-31 characters. Your display name must be unique in the developerWorks community and should not be your email address for privacy reasons.

Required fields are indicated with an asterisk (*).

(Must be between 3 – 31 characters.)

By clicking Submit, you agree to the developerWorks terms of use.

 


All information submitted is secure.

Dig deeper into Tivoli (service management) on developerWorks


static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=1
Zone=Tivoli, Tivoli (service management)
ArticleID=815763
ArticleTitle= Configuring Maximo (TPAE IF ) for TDI Connectors
publish-date=05112012