Tc Product Configurator Structure Get

This Snap get a fully expanded Product Configurator Structure from your Teamcenter System. The Teamcenter Product Configurator provides a variability management to plan, manage and account for variability.

The Snap is processing the data input and expands a product configuration structure for a given object in your Teamcenter system.

Supported Accounts


Settings tab of snap to show example values.

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 PDC Object created/already existing in Teamcenter.

Output

This Snap has exactly one document output view.

The output of the snap is the PDC object and its structure from Teamcenter.

Learn more about Error handling.

Examples

Tc Product Configurator Structure Get: Get product configuration structure

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 Product Configurator 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

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

Default value: $._id

Example: QKGAAAuAbq612C

UIDs in Teamcenter are as the name says UNIQUE. The UIDs in the example only exist in our Teamcenter system as expected for our example. Same is valid for Adapter ID "_id" since its base is the UID.

Revision Rule*

String/Expression/ Suggestion

Specify the revision rule that you want the Snap to use for the structure expansion.

Default value: N/A

Example: Latest Working

Configure revision rule

Checkbox

Select checkbox to configure date or effectivity dates to get revision rule instead of ootb „most recent“ date.

Default value: Selected

Example: Selected

Date Format

String/Expression

Define date format for next field Date.

Default value: yyyy-MM-dd HH:mm:ss

Example: yyyy-MM-dd

Date

String/Expression

Define date of Revision Rule.

Default value: N/A

Example: 2022-01-01

Effectivity In Date (yyyy-MM-dd)

String/Expression

Define Effectivity In Date of revision rule.

Default value: N/A

Effectivity Out Date (yyyy-MM-dd)

String/Expression

Define Effectivity Out Date of revision rule.

Default value: N/A

Get variants

Checkbox/Expression

Activate checkbox to get variants information in response.

Default value: Deselected

Example: Selected

Extract variants by rule text

Checkbox/Expression

Activate checkbox to extract variant information based on rule texts for variants.

OFF: Extraction of variants is done as the default behavior of the SOA Service provides it.

ON: Manual rule text evaluation leads to extraction of families, groups etc. relevant for current variant.

Default value: Selected

Example: Selected

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: doubled output configuration.

Default status: Deselected

Use dynamic policy for rules

Checkbox

ON: Policy is built dynamically using the expand attributes for rules to inprove performance.

Default value: Selected

Example: Selected

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 for Rules Path

String/Expression

Specify the JSON path of the expand attributes in the JSON input document. Expand attributes are a list of attributes the response from Teamcenter shall contain. In JSON document the content for path can look like this:

"ruleExpandAttributes": [
            "object_string"
        ]

Names in list have to be technical names of valid properties in Teamcenter datamodel for the expected objects.

Default value: N/A

Example: $.ruleExpandAttributes

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 for Rules

Checkbox

Select this checkbox if you want the Snap to specify the configuration of the Teamcenter properties for rules in the output. Learn more about configuring output.

Default value: Unselected

Example: Selected

Type

String/Suggestion

Appears when Configure output for Rulesis selected.

Teamcenter Data Model Type suggestion for Expand Attributes searches attributes for.

Expand Attributes

Specify the attributes you want the Snap to fetch from Teamcenter. Each attribute must be specified as a new row. Click :add: to add a row.

In case Expand Attributes for Rules Pathis configured to use attributes given in JSON input document these Expand Attributes are used additionally.

Name*

String/Expression/ Suggestion

Appears when Configure output for Rulesis selected.

Specify the name of the attribute.

Default value: N/A

Example: object_type

Use dynamic policy for rules

Checkbox

Select this checkbox if you want the Snap to create a policy for rules based on expand attributes dynamically.

Default value: Selected

Example: Selected

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.