Tc Relation Expand

Optional.This Snap has at the most one document input view.

The required input of the snap is the Object ID and Expansion Information that needs to be fetched from the Teamcenter.

• Mapper
• Copy

This Snap has exactly one document output view.

The output of the snap is the wanted object, zero to n related objects and its relation in case of respective Snap configuration from Teamcenter.

• Mapper
• JSON Splitter

Default value: Tc Relation Expand

Select the UID (unique identifier) or the Teamcenter adapter ID of the object.

Default value: $._id

Example: $.UID

Define if a reference or a relation shall be expanded.

• Relation
• Reference
• Named Reference
• Where Referenced

Default value: Relation

Example: Relation

Directions to expand relation:

• Primary → Secondary
• Secondary → Primary

Default value: Primary -> Secondary

Example: Primary → Secondary

Filter expansion result using defined object class.

Default value: N/A

Example: TC_Attaches

Select the mode in which you want to showcase the results. The options available are:

• collect

  output document contains all relations in one document.

• each
  • Response contains document for each relation.
  • Works not in Ultra Tasks
• inline

Prerequisite: An input document is required. It will be enriched with relation information.

Default value: inline

Example: collect

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: N/A

Example: DocumentRelation

Select this checkbox if you want the Snap to include the relation of the object in the results.

Default value: Unselected

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