Tc BOM Structure Create

This Snap create a Teamcenter BoM (Bills of materials) based on a given JSON structure.

Supported Accounts


Settings tab of snap to show example values.

Prerequisites

  • A valid Teamcenter account with the required permissions.

Snap views

The document consists of a list ‘[]’ of so-called JSON objects ‘{}’ Each document starts with some keys to determine the structure properties.

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 created in Teamcenter.

Output

This Snap has exactly one document output view.

The output of the snap is the newly created BOM 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

Defines the parent element of the structure.

This can be

  • new created based given properties and values within the sub document (containing pairs of attributes of values)
  • identified by a query definition or
  • identified by a given UID value

children

Consists of 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)

Learn more about Error handling.

Examples

  1. Tc BOM Structure Create: Create new elements and structure based on JSON document
  2. Create Teamcenter Parts and BOM based on data from Excel sheet using the Tc BOM Structure Create Snap

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
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 Create

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*

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 creation

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, $expand) or in the Pipeline parameters (for example, _expand), and use that content. Expand Attributes Path then changes to a String field with the default value $.expand. In Pipeline parameters, separate the attribute names with commas.

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:

"expandAttributes": [
  "item_id",
  "item_revision_id",
  "last_mod_date",
  "object_string",
  "items_tag.uom_tag"
]

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 _DISPLAY attributes:

  • References become {"_id": …, "UID": …, "_display": …} or null, including inside reference arrays.
  • LOVs become {"_value": …, "_display": …} or null, including inside LOV arrays.

The available options are:

  • Yes. The referenced object or LOV is a separate JSON object in the result. For example:
    "owning_user": {
      "_id": "TC*User*null***AgKAUUYTZLWoZA",
      "object_string": "user111 (user111)",
      "UID": "AgKAUUYTZLWoZA"
    }
  • No. The referenced object or LOV is flattened into attributes on the current result object, and synthetic attributes such as those ending in _DISPLAY are added. For example:
    "owning_user": "TC*User*null***AgKAUUYTZLWoZA",
    "owning_user_DISPLAY": "user111 (user111)"
  • Use Default. The Snap uses the default configured for the Snap Pack, which is Yes or No depending on the adapter.tc.snaplogic.expandReferencesAndLovs setting in the teamcenter_snappack.properties file.

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:
  • Validate & Execute. Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only. Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled. Disables the Snap and all Snaps that are downstream from it.