Tc Classification Get Class Definitions

This Snap request all class definitions of your Teamcenter.

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.

There is no required input.

Output

This Snap has exactly one document output view.

The output of the snap is a list “result” containing all existing class definitions.

Learn more about Error handling.

Examples

Tc Classification Get Class Definitions: Simple output example

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 Classification Get Class Definitions

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

Advanced classification

Checkbox

Specify the classification to get is an advanced classification. If unselected basic classification is fetched.

Default value: Unselected

Example: Unselected

Node

String/Expression

Appears when Advanced classification is selected.

Node ID. Leave empty to get all.

Default value: N/A

Include details

Checkbox/Expression

Appears when Advanced classification is selected.

Include details of class definition.

Default value: Selected

Example: Deselected

Include descriptors

Checkbox/Expression

Appears when Advanced classification is selected.

Include descriptors of class definition.

Default value: Selected

Example: Deselected

Max. Level

String/Expression

Appears when Advanced classification is selected.

Level of classification tree to be expanded. Va.ue -1means to expand all levels.

Default value: -1

Example: 1

Node Batch Size

String/Expression

Appears when Advanced classification is selected.

Batch size for class node description retrieval. Value -1 means all at once. In some cases Teamcenter with -1 Teamcenter creates errors on loading the data from Teamcenter.

Default value: -1

Example: 2

Descriptor Batch Size

String/Expression

Appears when Advanced classification and Include descriptors is selected.

Batch size for class descriptor retrieval. Value -1 means all at once. In some cases Teamcenter with -1 Teamcenter creates errors on loading the data from Teamcenter.

Default value: -1

Example: 2

Flatten result

Checkbox/Expression

Output will be structured as list of one-level Structure (flatten) or more complex as nested object structure as image of the multi-level Teamcenter Structure.

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: type and reference related fields for suggestion.

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.