Tc Localized Properties Get

This Snap retrieve locale-specific property attributes from a Teamcenter object. For example, you can retrieve the German display name (object_name with locale code de_DE) or French description (object_desc with locale code fr_FR) of an Item Revision, depending on the configured locale settings in 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 ID and (optional) attributes of the object that needs to be fetched from the Teamcenter.
Output

This Snap has exactly one document output view.

The output of the snap is the retrieved object from Teamcenter.
Learn more about Error handling.

Examples

Tc Localized Properties Get: 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 Localized Properties 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/ Suggestion

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

Default value: $._id

Example: $.uid
Use additional refresh

Checkbox/Expression

Refresh object.

Default value: Unselected

Example: Unselected
Use deep refresh

Checkbox/Expression

In addition to a standard refresh a Deep Refresh reloads the entire structure and related references, such as BOM lines, child items, and datasets.

Default value: Unselected

Example: Unselected
Object Type

String/Expression/ Suggestion

Specify the type of the object to be found in Teamcenter.

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

[
  {
    "object_type": "Part"
  }
]

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

Default value: N/A
All properties

Checkbox

Decide if snap shall return all properties or only defined list. If checkbox is selected, the Properties path and Property will disappear.

Default value: Unselected

Example: Unselected
Properties Path

String/Expression

Appears in case All properties is unselected.

Specify the path of the property attributes in the input document.

Default value: N/A
Property

String

Specify the table of object properties you want the Snap to fetch from Teamcenter. Each attribute must be specified as a new row. Click + to add a row. In case Properties Pathis configured, these Properties are used additionally.

Default value: N/A
All locales

Checkbox

Decide if snap shall return all locales or only defined attributes.

Default value: selected

Example: Unselected
Locales Path

String/Expression

Only in case All locales is unselected. Specify the path of the locales attributes in the input document.

Default value: N/A
Locales

String

Only in case All locales is unselected. Specify the table of locales properties you want the Snap to retrieve from Teamcenter. Each attribute must be specified as a new row. Click + to add a row. In case Locales Pathis configured, these Properties are used additionally.

All configured localization codes in Teamcenter can be retrieved by snap Tc Meta Get Languages List.Example values for Localeare:

  • de_DE[German]
  • en_US [English]
  • fr_FR[French]

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