IBM Support

Adding Lookup Functionality to a Field in Maximo Using a Table Domain

Troubleshooting


Problem

The purpose of this document is to provide steps to associate a lookup to a field in Maximo

Resolving The Problem

In the following example we will associate the COMPANIES lookup to a user defined field called XCOMP.


To associate a lookup to a field, a Table Domain must be created.
Select the Domain application from the Configuration module.
At the bottom right of the screen, select the Add New Domain button and select Add New Table Domain.
Enter a unique identifier value for the Domain and also enter a description.
Select the object the values will be selected from (the table the values you want to lookup exist in).
In this example we will use COMPANIES.
The List Where Clause will limit the values returned by the lookup based on the entered criteria.
For example we only want to return COMPANIES values of the type M.
The List Where Clause would be:
TYPE = 'M'
The Validation Where Clause validates any entries made to the field whether they are selected or manually entered.
In this example the Validation Where Clause would be:
COMPANY = :XCOMP
The : before the XCOMP denotes to Maximo that the value of the XCOMP field should be used as a variable and compared against the COMPANIES.COMPANY value to be validated.
Select OK.
The Table Domain now needs to be associated to the field launching the lookup, in this example the XCOMP attribute.
This is done is Database Configuration.
Select the Database Configuration application from the Configuration module.
Select the Object your attribute exists on, and select the attribute the lookup will be associated to.
In the example this is the XCOMP field.
Expand the details of the attribute and select the DOMAINID value for the Table Domain created for this lookup in the previous steps.
Also set the Same As Object and Same As Attribute values for the field to match the object and key attribute the lookup is getting the values from.
In this example that would be COMPANIES for the Same As Object and COMPANY for the Same As Attribute.
Maximo uses these settings for the mapping of the lookup on the return of a selected value.

Save and configure.

The Table domain has been created and associate to our launch field. We now need to reference the lookup in the properties for the launch field.
This is done in Application Designer.
Select the Application Designer application from the Configuration module.
Select the application and find the launch field and highlight it.
With the launch field highlighted, select the Control Properties icon.
In the Lookup field, enter the table id for the lookup. In the example this is the COMPANIES lookup, the following note explains how this value can be determined.

Note: All the lookups for Maximo exist in the LOOKUPS.XML file and are referenced by a table id value.
A lookup id can be found from the properties of a field that has the lookup already associated to it out of the box, or by exporting and searching the lookups.xml file.
From the Select Actions menu, select Export System XML.
Select the LOOKUPS xml by clicking the blue arrow next to it in the list.
Save to a local location and open the file.
Typically the table id for the lookup will be the Object / table name the values exist in.

If you are trying to set up a lookup that references an object that is user defined, you will not find a lookup in the lookups.xml as it is not part of the object or custom app creation process.
This is a manual process that requires you to export the lookups.xml file from the App Designer application, add a new section with a unique table id for the lookup, along with a row for the main column and a row for the description from the user defined object, along with whatever other columns you want to display in the lookup. Existing lookups can be referenced for the correct syntax.
Save and import the modified lookups.xml in App Designer.
When setting the lookup property for your field you will use the unique table id value you added for your lookup in the lookups.xml.

[{"Product":{"code":"SSLKT6","label":"IBM Maximo Asset Management"},"Business Unit":{"code":"BU055","label":"Cognitive Applications"},"Component":"Domains","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"6.1;6.2.1;6.2.2;6.2.3;6.2.4;6.2.5;6.2.6;6.2.7;6.2.8;7.1;7.1.1;7.5;7.6","Edition":"","Line of Business":{"code":"LOB59","label":"Sustainability Software"}},{"Product":{"code":"SSLKTY","label":"Maximo Asset Management for IT"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":null,"Platform":[{"code":"","label":"All"}],"Version":"","Edition":"","Line of Business":{"code":"LOB59","label":"Sustainability Software"}},{"Product":{"code":"SSWK4A","label":"Maximo Asset Management Essentials"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Component":null,"Platform":[{"code":"","label":"All"}],"Version":"","Edition":"","Line of Business":{"code":"LOB59","label":"Sustainability Software"}}]

Historical Number

M05284

Product Synonym

MAXIMO

Document Information

Modified date:
17 June 2018

UID

swg21261925