Tc File Upload

This Snap upload a data file to Teamcenter. You can upload the file to an existing dataset or an existing Item Revision. If the file is uploaded to an Item Revision a new dataset will be created to serve as joining object.

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

This Snap has exactly one binary input view.

The required input of the snap is binary data of a file. Configuration requires the ID of the parent object the file shall be related to and the File Name and Relation information for the file that you want to be uploaded.

Output

This Snap has exactly one document output view.

The output of the snap is the Metadata for the uploaded file in your Teamcenter.

Learn more about Error handling.

Examples

  1. Create a part, upload and download a file
  2. Find or create a part, upload or replace a file

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 File Upload

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

Parent ID*

String/Expression

Specify a UID (unique identifier) or a Teamcenter adapter ID of the parent element where you want to upload the file to.

Default value: : $._id

Example: _docID

Parent is Dataset

Checkbox

Select checkbox if parent object is a dataset.

Default value: Unselected

Example: Unselected

Dataset Name

String/Expression

Appears when Parent is Dataset is deselected.

Specify the name of the dataset which will be created. Datasets are used to manage data files created by other software applications.

Default value: N/A

Example: DSTestUpload

Dataset Type

String/Expression/ Suggestion

Appears when Parent is Dataset is deselected.

Specify the type of the dataset which will be created. The dataset type is supposed to manage the filetype in Teamcenter and manages the authoring applications as well.

Default value: N/A

Example: Text

Dataset Relation

String/Expression/ Suggestion

Appears when Parent is Dataset is deselected.

Specify the relation of the dataset with the file you want the Snap to upload.

Default value: N/A

Example: TC_Attaches

File Name*

String/Expression

Specify the name of the file to upload.

Default value: N/A

Example: FileForDocumentation2.txt

Reference Name

String/Expression

Specify the name of the reference to be used.

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 as value list.

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.