Debug Panel - Attachments

Attachments are files of any type that are wrapped and accessible from a task. These files can be easily exported or deployed along with their associated task allowing them to be more transportable and manageable. At runtime, attachments are automatically "unwrapped" to a local directory where they can be accessed by the task. The Attachments debug panel displays any files that are currently attached to the task. It also allows you to add a new attachment to the task as well as modify or remove existing attachments.

Parameters

The Attachments debug panel contains the following column headers.

Column Header

Description

Name

The name of the attachment.

Attachment

The filename (including extension) of the attachment.

Attached On

The date and time when the file was initially attached to the task.

Description

A user defined description of the attachment (this property is optional, therefore, may appear blank).

Context Menu

Right-clicking anywhere inside the Attachments panel displays a context menu with the following items.

Menu Item

Description

Add...

Adds a new attachment to the task.

Properties

Opens the Attachment dialog box to display the properties associated to the selected attachment.

Refresh

Refreshes the Attachments list

Remove

Removes the selected attachment(s). To select more than one attachment, hold down CTRL during selection.

NOTE: When you remove an attachment, be sure to remove all references to the attachment from the task, otherwise the task may fail to execute properly.

Remove All

Removes all attachments that exist in a task.

NOTE: When you remove an attachment, be sure to remove all references to the attachment from the task, otherwise the task may fail to execute properly.

To attach a file to a task

  1. Right-click anywhere inside the Attachments debug panel and select Addfrom the context menu that appears. This opens a dialog titledAttachment(shown below).
  2. Enter the following information:
    • Name - The name of the attachment (this value is what you will use as a placeholder for the file).
    • Attachment file - The full path and filename of the attachment file. Use the folder icon to browse to the file you wish to attach.
    • Description - An optional description of the attachment.

  3. Upon completion, click OK. The new attachment and its properties are displayed in the Attachments Debug panel.

NOTE: Multiple files of any type and size can be attached to a task, however, be aware that the size of the task file expands with the size and number of attachments, which may affect performance. Multiple or large sized attachments used in a single task may slow down task execution.

To remove one or more existing attachments

  1. From the Attachments debug panel, select existing attachment(s) you wish to remove. To select multiple attachments, hold down CTRL during selection.

  2. Right-click the attachment(s) and select Remove from the context menu. To remove all existing attachments, select Remove All.

NOTE: After removing an attachment, make sure to remove all references to it in any step parameter to ensure that no attachment related error occurs during runtime.

To modify an existing attachment

  1. From the Attachments debug panel, right-click the attachment you wish to modify and select Properties from the context menu. This opens the Attachment dialog box.

  2. Make the desired adjustments.

  3. Upon completion, click OK to save changes and close the dialog box.

NOTE: If modifications to the original attachment name is made, make sure to update any step parameters referencing the original name to reflect the new name to ensure that no attachment related error occurs during runtime.