Tc Meta Get Adapter Configuration

Use this Snap to get the currently used adapter configuration of the running adapter. Configuration is partitioned in different groups for clarity. The snap shall help in case issues are raised and reason is indistinct.

Another functionality is that the snap can initiate a restart of the adapter on a node.

Supported Accounts


Settings tab of snap to show example values.

Prerequisites

  • A valid Teamcenter account with the required permissions.
  • A valid account.

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 of configuration name value pairs partitioned in

  • pool
  • teamcenter
  • session
  • debug
  • embedded

configuration groups.

Learn more about Error handling.

Examples

Tc Meta Get Adapter Configuration: Get Adapter configuration 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 Adapter Configuration

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

Include pool data

Checkbox/Expression

OFF: no pool data information added.

ON: response contains configuration and runtime information of adapter pool.

Default value: Unselected

Example: Unselected

Include startup log

Checkbox/Expression

Include startup log of embedded adapter if there is one.

Default value: Unselected

Example: Unselected

Include environment

Checkbox

OFF: no environment information added.

ON: add selected information about environment of executing groundplex node.

Default value: Unselected

Example: Unselected

Restart adapter

Checkbox

Restart adapter before reading data. Adapter restart happens for the one node request was send to.

Default value: Unselected

Example: Unselected

Host to restart

String

Appears when Include environment and Restart adapter are selected.

Specify the host restart shall be done on.

Default value: N/A

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.