Tc Requirement Structure Synchronize

This Snap has exactly one document input view.

The required input of the snap are the Teamcenter types and attributes that needs to be defined for creating the requirement structure as (multi) level structure style in JSON document. The JSON object “lineObject”includes properties for the object. The JSON object „children“ is a list of JSON objects including “lineObject” information and “lineData” information for the componens and structure to be build. Optionally “lineObject” can include html rich content in “[richContent]” attribute. See Example chapter.

• Mapper
• Copy

This Snap has exactly one document output view.

The output of the snap is the requirement structure and information about removed, added or synchronized childs by added property "action" in child JSON objects.

• Mapper
• Router

Define the revision rule to create the structure content

Define the view type to create the structure content

A flag (true or false) to determine the precise structure property

The parent element of the structure.

This may be

• new created based given properties and values
• identified by a query definition or
• identified by a given UID value

With config document key the mode (key mode) and matching (key match) attributes can be defined.

Defaults are:

• FullSynchronization for mode and
• lineObject and bl_sequence_no for matching

Full overview in next chapter Synchronisation configuration.

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)

Default value: Tc Requirement Structure Synchronize

Specify the path of the Requirement structure to be fetched from JSON input document.

Default value: $

Example: $

In case checkbox is ON Snap will do a deep refresh before starting to create the structure.

Default value: Unselected

Example: Unselected

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

Specify retry shall be done in case of error.

Default value: Unselected

Example: Unselected

Appears when Retry in case of recoverable error is selected.

Specify the number of retries.

Default value: 5

Example: 5

Snap will execute a validation of requirement structure.

Default value: Selected

Example: Selected

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

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

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