Tc File Delete Referenced

This Snap delete a single file or all files referenced by a Dataset in Teamcenter.

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 ID of the dataset the file(s) shall be deleted from.
Output

This Snap has exactly one document output view.

The output of the snap is the object information from your Teamcenter.
Learn more about Error handling.

Examples

Delete referenced 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 Delete Referenced
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 dataset object.

Default value: $._id

Example: $.uid
File ID

String/Expression

Specify a UID (unique identifier) or a Teamcenter adapter ID of the file you want to delete. If empty all related files will be deleted.

Default value: N/A

Example: $.fileID
Delete if empty

Checkbox/Expression

Select checkbox if dataset shall be deleted if no file is related anymore.

Default value: Unselected

Example: Selected
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
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.