Tc BOM Structure Get
This Snap expand the Teamcenter BoM (Bills of materials) of structure to one level from Teamcenter for a given BOM node. The BOM structure will be extracted into a JSON document for further processing in the pipeline.
Supported Accounts
- This is a Read-type Snap.
- Support for Ultra Tasks: Works in Ultra Tasks if for Mode* the value collect or inline is selected.

Prerequisites
- A valid Teamcenter account with the required permissions.
Snap views
| 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 Object ID and revision rule the BOM structure shall be read for in Teamcenter. |
|
| Output |
This Snap has exactly one document output view. The output of the snap is the BOM structure for the defined object in Teamcenter. |
|
| 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 Get |
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 |
Object ID*
String/Expression/ Suggestion |
From input document take the JSON data node to get the Teamcenter structure. Default value: $._id Example: UID |
Revision Rule*
String/Expression/ Suggestion |
Specify the revision rule for the BOM expand operation. Default value: N/A Example: Any Status; Working |
View Type
String/Expression/ Suggestion |
Specify the view type for the BOM expand operation. Default value: N/A Example: view |
Mode*
Dropdown list |
Select the mode in which you want to showcase the results. The options available are:
Prerequisite: An input document is required. It will be enriched with relation information. Default value: inline Example: each |
Property Name
String/Expression/ Suggestion |
Appears in case Mode“inline” is selected. Specifiy a new property used as document key in the result to collect the relation or reference objects. Default value: ExistingBOM Example: TcBOM |
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:
|