Tc Start Workflow

This Snap start a workflow in Teamcenter. Workflows are automated business processes in which documents, information, and tasks are passed between the authorized users of the organization in a way that is controlled by rules and conditions.

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 of the Teamcenter object, Template Name and Process Name for the workflow to be started in the Teamcenter system.

Output

This Snap has exactly one document output view.

The output of the snap is the workflow is created in the Teamcenter. The resulting document contains the object information for the given object ID.

Learn more about Error handling.

Examples

Tc Start Workflow: 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 Start Workflow

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

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

Default value: $._id

Example: $.uid

Template Name*

String/Expression/ Suggestion

Specify the name of the template that you want to use for the workflow.

Default value: N/A

Example: TCM Release Process

Process Name*

String/Expression

Specify the name of the process that you want the workflow to follow in the Teamcenter system.

Default value: N/A

Example: TCM Release Process

Process Subject

String/Expression

Specify the subject of the process for the workflow in Teamcenter.

Default value: N/A

Process Description

String/Expression

Specify the description of the process that you want the workflow to follow in the Teamcenter.

Default value: N/A

Target IDs Path

String/Expression

Specify the path to fetch the list of target IDs from Snap JSON input document.

Default value: N/A

Target IDs

Specify the targets you want the Snap to add to the workflow in Teamcenter. Each target must be specified as a new row. Click :add: to add a row.

In case Targets IDs Path is configured to use targets from list in JSON input document these Target IDs are used additionally.

Target ID*

String

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

Default value: N/A

Reference IDs Path

String/Expression

Specify the path to fetch the list of references from Snap JSON input document.

Default value: N/A

Reference IDs

Specify the references you want the Snap to add to workflow in Teamcenter. Each reference must be specified as a new row. Click :add: to add a row.

In case Reference IDs Pathis configured to use targets from list in JSON input document these Reference IDs are used additionally.

Reference ID*

String

Specify the name of the reference.

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 field in configuration 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.