PBS API usage guidance - Intergraph Smart Completions - Intergraph Smart Completions Update 24 - Customization & Programming - Hexagon

Intergraph Smart Completions Smart API Programmer's Reference Guide (5.3.24)

Intergraph Smart Completions
Search by Category
Customization & Programming
Smart Completions Version

This topic provides guidance for common scenarios you might encounter when using the PBS API.

When to use the ProcessBreakdowns endpoint

A company can choose to create and manage the PBS in an application other than Smart Completions, such as HxGN SDx. When this happens, you can use the ProcessBreakdowns endpoint to add the PBS to Smart Completions and keep it up-to-date when changes are made in the source application.

Basic PBS creation workflow

  1. Create the new PBS using the ProcessBreakdowns endpoint.

  2. Assign the PBS to an existing project using the ProcessBreakdownProjects endpoint.

Creating the PBS hierarchy when the source application PBS uses fewer than four tiers

In most source applications, the PBS hierarchy has only Systems and/or Subsystems instead of the four-tier hierarchy used by Smart Completions (Plant > Process Area > System > Subsystem).

In this case, we recommend that:

  • When creating the Plant, use the project or plant name as the ProcessBreakdownID.

  • If the source application does not contain a Subsystem, create a single Subsystem. Use a general name, such as Commissioning Systems.

Understanding and choosing PBS item number, name, and summary values

In Smart Completions, each PBS item is uniquely identified by its SUMMARY. When you use the API to create PBS items, Smart Completions creates the SUMMARY by concatenating NUMBER and NAME values. This means that each PBS item must have a unique NUMBER and NAME. We recommend that you define these values as follows:

  • If the item exists in the source application, use the NUMBER and NAME values from that application.

  • If the item will only exist in Smart Completions, assign unique NUMBER and NAME values when you create the item. This can happen when, for example, the source application PBS uses fewer than four tiers.