Tc Relation Expand Multi

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

The required input of the snap is an array of objects identified by attribute UID or _id.

• Mapper
• Copy

This Snap has exactly one document output view.

The output of the snap is a copy of the input document where each objects includes a list object named by value of field Property Name. List contains 0 .. n related objects.

• Mapper
• JSON Splitter

Default value: Tc Relation Expand Multi

Path to the array of Id (UID, _id) to be used to expand specified relation or reference. In JSON document the content for path can look like this:

"objects":
        [
            {"_id":"TC*Part*null***A2OAgQJH7hAnmD"},
            {"_id":"TC*Part Revision*null***A6CAgQJH7hAnmD"},
            {"_id":"TC*Part Revision*null***AWOAgogw7hAnmD"}
        ]

“_id” (or UID) in each JSON object has to be an ID of existing objects in the connected Teamcenter.

Default value: N/A

Example: $.objects[*]

Chose the value to define type of the expansion.

Default value: Relation.

Example: Reference

Chose the value to define direction of the expansion.

Default value: Primary → Secondary.

Example: Secondary → Primary

Specify the name of reference or relation to be expanded. Typically this name shall be provided by customers specification. For investigation the suggestion can be used.

Default value: N/A

Example: Fnd0IsDescribedByDocument

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: MultiExpandDescribedBy

Option to get the relation as object into the result. This might be neccessary in case the relation provides meta data for further processing needs.

Default value: Unselected

Example: Unselected

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