This topic provides guidance for common scenarios you might encounter when using the LBS API.
When to use the PhysicalLocationss endpoint
A company can choose to create and manage the LBS in an application other than Smart Completions, such as HxGN SDx. When this happens, you can use the PhysicalLocationss endpoint to add the LBS to Smart Completions and keep it up-to-date when changes are made in the source application.
Basic LBS workflow
-
Create the new LBS in Smart Completions using the PhysicalLocationss endpoint.
-
Assign the LBS to an existing project using the PhysicalLocationProjects endpoint.
Creating the LBS hierarchy when the source application LBS uses fewer than four tiers
In most source applications, the LBS hierarchy has only Areas and Physical Locations instead of the four-tier hierarchy used by Smart Completions (Plant > Process Area > Area > Physical Locations).
In this case, we recommend that:
-
When creating the Plant, use the project name as the LocationBreakdownId.
-
If the source application does not contain a Process Area, create a single Process Area. Use a general name, such as Construction Work Areas.
Understanding and choosing LBS item number, name, and summary values
In Smart Completions, each LBS item is uniquely identified by its SUMMARY. When you use the API to create LBS items, Smart Completions creates the SUMMARY by concatenating NUMBER and NAME values. This means that each LBS 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 LBS uses fewer than four tiers.