Tc Create Dispatcher Request

This Snap send a request to a Teamcenter dispatcher service provider.

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 Provider and Service name and optionally one or two lists as arguments.

Output

This Snap has exactly one document output view.

The output of the snap is the response of the dispatcher service.

Learn more about Error handling.

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 Create Dispatcher Request

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

Provider*

String/Expression

Name of the dispatcher service provider.

Default value: N/A

Example: SIEMENS

Service*

String/Expression

Name of the dispatcher service.

Default value: N/A

Example: tozipfile

Priority*

String/Expression

Priority for service call in dispatcher.

Default value: 1

Example: 1

First Argument List (Object IDs) Path

String/Expression

Specify the JSON path of the list of IDs in the JSON input document to be send as first argument to service.

Default value: N/A

First Argument List (Object IDs)

Specify a list you want the Snap to send as first argument to service. Each ID must be specified as a new row. Click :add: to add a row.

In case First Argument List (Object IDs) Pathis configured to use IDs given in JSON input document these First Argument List (Object IDs)are used additionally.

Object ID*

String

Specify a UID (unique identifier) or a Teamcenter adapter ID of the Teamcenter object you want to add to first argument list.

Default value: N/A

Example: APKAQgKc7hAnmD

UIDs in Teamcenter are as the name says UNIQUE. The UIDs in the example only exist in our Teamcenter system as expected for our example. Same is valid for Adapter ID "_id" since its base is the UID.

Second Argument List (Object IDs) Path

String/Expression

Specify the JSON path of the list of IDs in the JSON input document to be send as second argument to service.

Default value: N/A

Second Argument List (Object IDs)

Specify a list you want the Snap to send as first argument to service. Each ID must be specified as a new row. Click :add: to add a row.

In case Second Argument List (Object IDs) Pathis configured to use IDs given in JSON input document these Second Argument for Dispatcher Request (Objects)are used additionally.

Object ID*

String

Specify a UID (unique identifier) or a Teamcenter adapter ID of the Teamcenter object you want to add to second argument list.

Default value: N/A

Example: AHEAQgKc7hAnmD

UIDs in Teamcenter are as the name says UNIQUE. The UIDs in the example only exist in our Teamcenter system as expected for our example. Same is valid for Adapter ID "_id" since its base is the UID.

Additional Arguments Path

String/Expression

Specify the JSON path of the list of key-value pairs in the JSON input document.

Default value: N/A

Example: $.arguments

Additional Arguments

Specify key-value pairs you want to send to the Snap as additional arguments. Each pair must be specified as a new row. Click :add: to add a row.

In case Additional Arguments Pathis configured to use pairs given in JSON input document these Additional Argumentsare used additionally.

Name*

String/Expression

Name of the argument.

Default value: N/A

Value*

String/Expression

Value of the argument.

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

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.