IBM Support

How to Generate an Entity Relationship (ERD) Document for Maximo

How To


Summary

How to Generate an Entity Relationship Document for Maximo

Objective

The Maximo Entity Relationship Document (ERD) describes the Maximo business objects and the logical relationships between them.

Environment

The process is for Maximo Asset Management 7.6.1.x. For Maximo Application Suite (MAS), the ability to create ERDs is under development.

Steps

  1. Log on to the server where the Maximo Application workstation is installed
  2. Open a Command Prompt (Windows) or a Terminal session (Linux)
  3. Change the directory to \IBM\SMP\maximo\tools\maximo\internal (Windows) or /IBM/SMP/maximo/tools/maximo/internal (Linux)
  4. Execute generd.bat|.sh
  5. Execute generdwithlogical.bat|.sh
  6. In a browser, open <SMP_directory_location\maximo\tools\maximo\erd\index.html

Additional Information

In some environments, execution of generd fails with a JsonWriter class not found error, for example:
Exception in thread "main" java.lang.NoClassDefFoundError: com.google.gson.stream.JsonWriter
     at psdi.tools.GenERD.generateMaximoObjectsFile(GenERD.java:1243)
     at psdi.tools.GenERD.generateMaximoObjectsFiles(GenERD.java:1209)
     at psdi.tools.GenERD.generateFiles(GenERD.java:1289)
     at psdi.tools.GenERD.execute(GenERD.java:2601)
     at psdi.tools.GenERD.main(GenERD.java:384)
Caused by: java.lang.ClassNotFoundException: com.google.gson.stream.JsonWriter
     at java.net.URLClassLoader.findClass(URLClassLoader.java:610)
     at java.lang.ClassLoader.loadClassHelper(ClassLoader.java:945)
     at java.lang.ClassLoader.loadClass(ClassLoader.java:890)
     at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:349)
     at java.lang.ClassLoader.loadClass(ClassLoader.java:873)
     ... 5 more

To resolve this error, 
  1. Go to the \maximo\applications\maximo\lib\ directory. Search for the gson jar file, and note the version number (for example, gson-2.8.9.jar).
  2. Using a pure text editor (such as Notepad++), open \maximo\tools\maximo\commonenv.bat|sh.
  3. Search for gson and replace the version reference in the file with the version in the Maximo lib directory.
  4. Run generd.bat|sh again.

Document Location

Worldwide

[{"Line of Business":{"code":"LOB59","label":"Sustainability Software"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSLKT6","label":"IBM Maximo Asset Management"},"ARM Category":[{"code":"a8m50000000CbA4AAK","label":"System Administration-\u003EDatabase Configuration"}],"ARM Case Number":"TS004743597","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"7.6.0;7.6.1"},{"Type":"MASTER","Line of Business":{"code":"LOB59","label":"Sustainability Software"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSLPL8","label":"IBM Maximo Manage"},"ARM Category":[{"code":"a8m50000000CbP6AAK","label":"System Administration"}],"ARM Case Number":"TS013974647","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"},{"Type":"MASTER","Line of Business":{"code":"LOB59","label":"Sustainability Software"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSWT9A","label":"IBM Control Desk"},"ARM Category":[{"code":"a8m500000008b3TAAQ","label":"Miscellaneous Category (Portal, UI, Maximo, Install)"}],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"7.6.0;7.6.1"}]

Product Synonym

TPAE MAS

Document Information

Modified date:
28 August 2023

UID

ibm16403201

Page Feedback