Tc BOM Structure Synchronize
This Snap syncronize (create, update) a Teamcenter BoM (Bills of materials) based on a given JSON structure. The Teamcenter parts, items, or elements of derived data types must already exist in the system.
Supported Accounts
- This is a Write-type Snap.
Works in Ultra Tasks

Prerequisites
- A valid Teamcenter account with the required permissions.
Snap views
The document consists of a list ‘[]’ of so-called JSON objects ‘{}’.
On top level of the structure document the general structure options are to be defined. These are
By default, if no JSON object “config” is provided, matching for synchronization will use Teamcenter default BOMLine attribute bl_sequence_no and synchronization mode FullSynchronization.
To configure synchronization information is given in JSON input document by using object “config” and its attributes as:
„config“: { „mode“: „<synchronisation mode>“, „match“: [ „<property1>“, „<property2>“…] }
Possible synchronization modes and their behavior are:
List “match” can contain any existing BOMLine property. Properties should exist in Teamcenter BOMLine and lineObject in JSON input document. If it does not exist, match will be false.
| Type | Description | Examples of upstream and downstream Snaps |
|---|---|---|
| Input |
Optional.This Snap has at the most one document input view. The required input of the snap is the path to the JSON structure in input document which represents the BOM structure to be the result of the synchronization in Teamcenter. |
|
| Output |
This Snap has exactly one document output view. The output of the snap is the synchronized structure in Teamcenter. |
|
| revisionRule |
Define the revision rule to create the structure content |
|
| bomViewType |
Define the view type to create the structure content |
|
| precise |
A flag (true or false) to determine the precise structure property |
|
| lineObject |
The parent element of the structure. This may be
|
|
| config |
With config document key the mode (key mode) and matching (key match) attributes can be defined. Defaults are:
|
|
| children |
A list of documents containing the information about the structure children Each child document consists of a document for lineObject and a document for lineData (optional as long as system handles required information with defaults ). The lineObject is specifying the Teamcenter element which shall be a child element in the structure. The lineData is specifying properties of the structure itself, such as position (bl_sequence_no) or quantity (bl_quantity) |
|
| FullSynchronization |
will be added as new BOMLines |
will be used to update BOMLine |
| UpdateLines |
will be ignored |
will be used to update BOMLine |
| RemoveLines |
will be ignored |
will be deleted |
| AddAndUpdateLines |
will be added as new BOMLines |
will be used to update BOMLine |
| AddLines |
will be added as new BOMLines |
will be ignored |
| Learn more about Error handling. | ||
Examples
Snap settings
| Field/Field set | Description |
|---|---|
Label
String |
Specify a unique name for the Snap. Modify this to
be more appropriate, especially if there are more than one of the same Snap in the
pipeline.
Default value: Tc BOM Structure Synchronize |
Configure policy
Checkbox |
Select this checkbox to run the Snap with a specific named Teamcenter policy. A policy determines the set of object properties that Teamcenter returns. Learn more: Configure policy. Default status: Deselected |
Configure session context
Checkbox |
Select this checkbox to run the Snap with a group, role, or project other than the one configured in the account. Learn more: Configure session context. Default status: Deselected |
Structure Data path*4
String/Expression/ Suggestion |
From input document take the JSON data node to create the Teamcenter structure. Default value: $ Example: $.structure |
Refresh before modification
Checkbox/Expression |
In case checkbox is ON Snap will do a deep refresh before starting to create the structure. Default value: Unselected Example: Unselected |
Refresh and retry in case of error
Checkbox/Expression |
In case checkbox is ON Snap will do a deep refresh in case of error while creating the structure and retry create. Default value: Unselected Example: Unselected |
Retry in case of recoverable error
Checkbox |
Option to force the snap for executing a retry in case an recoverable error (e.g. refresh issue). Default value: Unselected Example: Unselected |
Maximum number of retries
String |
Appears when Retry in case of recoverable error is selected. Specify the number of retries. Default value: 5 Example: 5 |
Validate before synchronization
Checkbox/Expression |
Option to validate the document structure to be able to proceed. Default value: Unselected Example: Unselected |
Configure error handling
Checkbox |
Select this checkbox to define how the Snap behaves when Teamcenter returns an error. Use these settings for analysis and debugging. Learn more: Configure error handling. Default status: Deselected |
Simplified expand
Checkbox |
Select this checkbox to make the Snap look for the name given in
Expand Attributes Path in the input document (for example,
When deselected, configure Expand Attributes Path as a string or an expression. Default status: Deselected |
Expand Attributes Path
String/Expression |
Specify the JSON path to the expand attributes in the input document. Expand attributes are the list of attributes that the Teamcenter response must contain. Each name must be the technical name of a valid property in the Teamcenter data model for the expected objects. For example:
Learn more: Configuring Expand Attributes. Default value: N/A Example: $.expandAttributes |
Build reference/lov documents
Dropdown list/Expression |
Select how the Snap represents references and lists of values (LOVs) that
Teamcenter returns. The Snap can return them as nested JSON objects instead of
flattened IDs and internal values with additional
The available options are:
Default value: Use Default Example: Yes |
Configure output
Checkbox |
Select this checkbox to specify the Teamcenter properties that the Snap includes in the output. This Snap offers the output settings described in Variant: type field in configuration settings. Default status: Deselected |
Snap execution
Dropdown list |
Choose one of the three modes in
which the Snap executes. Available options are:
|