Rename

The Rename process will change the file name to whatever you define it to be in the Rename Node window. This is particularly useful for ensuring standard document naming practices, clarifying document names, and improving later document retrieval. Documents can be renamed using a set of standard file name elements or with workflow metadata. To open the Rename Node window, add a process node for Rename and double-click on it.

• Enabled - To enable this node in the current workflow, check the box at this field. If you leave the box blank, the workflow ignores the node and documents pass through as if the node was not present. Note that a disabled node does not check for logic or error conditions.

• Node Name - This editable field contains a default node name that appears in the workflow under the node icon. Use this field to specify a meaningful name for the node that indicates its use in the workflow.

• Description - Enter an optional description for this node. A description can help you remember the purpose of the node in the workflow or distinguish nodes from each other. If the description is long, you can hover the mouse over the field to read its entire contents.

• Help - To access Dispatcher Online Help, click this button.

• Save - To preserve your node definition and exit the window, click this button.

• Cancel - To exit the window without saving any changes, click this button.

In the File Naming Components area, you can customize the following components to rename your files. In order to begin renaming files, you must drag and drop one of the following components into the File Naming Components area:

• Text: Drag-and-drop this icon into the Naming Components area; then double-click on it to enter any text string you want included in the new file name. With this component, you can also use file level dynamic variables. For example, type {file:fullname} to include the file’s entire file name in the rename process.

• Metadata - Double-click on the Metadata naming component and then select the Select Metadata Key button to launch the Metadata Browser window, which displays system-defined variables and metadata from other nodes that are used in the workflow. If you have not added any other nodes, only system-defined variables (File, User, Workflow, etc.) will appear in the window. On the Metadata Browser, you can do the following:

  • Expand the list by selecting the + sign next to the metadata that you are interested in. For example, if you are interested in File metadata, click on the + sign next to File and the following expandable list will appear:

    

  • Collapse the list by selecting the - sign next to the appropriate metadata.

  • Choose metadata to add to the new name by selecting the metadata and selecting the Select button. At this point, the Metadata Browser will close and you will return to the Rename window.

  • Search for metadata by entering the appropriate text string in the empty Search field in the upper right-hand side of the window.

• Counter: Drag-and-drop this icon into the Naming Components area to add a sequential counter to the new file name; then double-click on it to customize the counter (defining the start number, the maximum value, the number by which the counter should be incremented, and whether or not to use leading zeros). The maximum value for incrementing is 4 billion.

  Note: In order to maintain count integrity, once the workflow is run for the first time, the counter will no longer be editable.

• Date: Drag-and-drop this icon into the Naming Components area to include the process date in the new file name; then double-click on it to choose the date format. The following options are available:

  • MM-dd-yyyy

  • M-d-yyyy

  • yyyy-MM-dd

  • MM

  • dd

  • yyyy

• Time: Drag-and-drop this icon into the Naming Components area to include the time in the new file name; then double-click on it to choose the time format. The following options are available:

  • HH-mm-ss

  • h-mm tt

  • HH

  • mm

  • ss

  Note: The Time component defaults to the time zone associated with the Region selected during tenant creation.

• Separator: Drag-and-drop this icon into the Naming Components area to include a separator in the new file name; then double-click on it to view a list of available separators.

In addition, the following components can be added to the new file name but cannot be modified:

• File Name: Drag-and-drop this icon into the Naming Components area to include the original file name in the new file name.

• Unique ID: Drag-and-drop this icon into the Naming Components area to include a unique identifier to the new file name (if not selected, new files will overwrite old files if they have identical names).

• File Extension: Drag-and-drop this icon into the Naming Components area to include the original file extension in the new file name.

Notes:

• It is necessary to include the “File Extension” option in the Rename process if the output files are to be viewed.

• The length of the file name cannot exceed 255 characters (a Windows limit).

In the Resulting File Name area, view an example of the file name created during the Rename process.

• To view the results of the Rename process on a sample file, select the Click here to upload a sample file to see the resulting file name link at the bottom of the Preview area.

• To delete already defined naming components, select the Delete (X) icon next to the component you would like to remove.