Tc Get Preference

Use this Snap to retrieve the definition and values of a preference from Teamcenter. Teamcenter preferences are settings stored in the Teamcenter database that allow you to control system behavior. They enable you to modify the user interface, define default behaviors, and specify default values

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 preference name.
Output

This Snap has exactly one document output view.

The output of the snap is the Preference definition and value from Teamcenter.
Learn more about Error handling.

Examples

Tc Get Preference: Get Preference information for async connection retries

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 Get Preference
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
Preference*

String/Expression/ Suggestion

Specify the preference to get information for from Teamcenter system.

Default value: N/A

Example: ASYNC_connection_retries
Location*

String/Expression

Specify the location of the preference. Value can differ dependent on location. Possible locations are

  • Default
  • Site
  • Group
  • Role
  • User

Default value: Default

Example: Default
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 Basic settings.

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.