Using Object IDs

<< Back to API Tutorials

Each item in a Synthesis repository is identified by a unique record identifier called an object ID. The same object ID is never generated twice; if an item in the repository is copied or duplicated, a unique object ID will be generated for the duplicate item.

Typical end users of Synthesis applications rarely need to see a record's object ID; however, when you are learning how to use the Synthesis API or are developing applications for the API, the object IDs can be useful for helping you trace the response of a call and debug code.

The location of the object ID depends on the item you are working with. In this article, we'll show you where to find the object IDs of various items.

Displaying the Object ID

To display the object ID in a Synthesis application, choose File > Application Setup. Then click Other under the Synthesis Settings heading in the navigation panel. Select the check box for Display Object IDs.

Projects

The object ID of a project is displayed in two locations:

• The Project Properties window (Project > Management > Edit Project Properties) displays the project's object ID at the caption bar of the window.

• The Manage Projects window (Project > Management > Manage Projects) displays a column containing the object IDs of each project in the database.

Resources

The Resource Manager (Project > Synthesis > Resource Manager) displays a column containing the object IDs of the resources.

Xfmea, RCM++ and RBI System Hierarchy Items

To display the object ID (also called "record ID") of a system hierarchy item, right-click any of the column headers in the System Hierarchy panel and choose Customize Columns. Select the Record ID check box.

FMEA Items

To display the object IDs of FMEA functions, causes, effects, controls and actions, right-click any of the column headers in the FMEA analysis and choose Customize Columns. Select the Record ID check box.