Tc Meta Get Type Description

Use this Snap to get meta information about a data model type from 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.

The required input of the snap is the object type and decision to subtypes and properties included.

Output

This Snap has exactly one document output view.

The output of the snap is the metadata of the Teamcenter datamodel type.

Learn more about Error handling.

Examples

Tc Meta Get Type Description: Get ChangeItemRevision type description output

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 Meta Get Type Description

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

Type*

String/Expression/ Suggestion

Specify the type of the Teamcenter object LOV values shall be fetched for in the Teamcenter system.

In JSON document the content for path can look like this:

[
  {
    "type": "ChangeItemRevision"
  }
]

Name of the JSON property has to be the technical name of a valid type in Teamcenter datamodel.

Default value: N/A

Example: ChangeItemRevision

Include constants*

Checkbox/Expression

Response shall include constants for given type.

In case expression is activated the default value is „false“ or „true“ dependent on checkbox Unselected or Selected state.

Default value: Unselected

Example: Unselected

Include type-constants*

Checkbox/Expression

Response shall include type-constants for given type.

In case expression is activated the default value is „false“ or „true“ dependent on checkbox Unselected or Selected state.

Default value: Unselected

Example: Unselected

Include sub-types*

Checkbox/Expression

Response shall include sub-types for given type.

In case expression is activated the default value is „false“ or „true“ dependent on checkbox Unselected or Selected state.

Default value: Unselected

Example: Unselected

All sub-types (recursive)*

Checkbox/Expression

Specify if sub-types shall be evaluated one level down or recursive over all levels.

Default value: Unselected

Example: Unselected

Include properties*

Checkbox/Expression

Response shall include properties for given type.

Default value: Unselected

Example: Unselected

Filter properties

Expression

optionally properties can be filtered by expression.

Default value: Unselected

Example: Unselected

Transform properties

Expression

optionally properties can be transformed by expression.

Default value: Unselected

Example: Unselected

Flatten result

Checkbox/Expression

will return one flat list rather than showing data grouped under their respective parents.

Default value: Unselected

Example: Unselected

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

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.