Rename

4 minute read Last updated on December 10, 2021

Rename Icon

The Rename process will change the file name to whatever you define it to be in the Rename Node window. To open the Rename Node window, add a process node for Rename and double-click on it.

Rename node

  • Check the Enabled box so that the process will be run. When unchecked, this process will be ignored. Documents will pass through as if the node was not present (i.e., continue along the default or ‘positive’ path). Note that a disabled node will not check for logic or error conditions.

  • In the Node Name field, enter a meaningful name for the Rename node.

  • In the Description field, enter a description for the Rename node. Although this is not required, it can be helpful to distinguish one process from another. If the description is long, you can hover the mouse over the field to read its entire contents.

  • In the File Naming Components area, you can customize the following components to rename your files. Note that the length of the file name cannot exceed 255 characters (a Windows limit).

    • 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 click on 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 (Date, File, System, User) will appear in the window. On the Metadata Browser, you can do the following:

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

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

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

    • Specify a page-level and/or occurrence number for the metadata reference by clicking on the Other check box and entering the correct syntax in the empty field provided.

    • Search for metadata by entering the appropriate text string in the empty Search field on the left-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 numbers). 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 (MM-DD-YYYY, MM, dd, or 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 (HH-mm-ss, HH, mm, or ss).

  • 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 not 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, files with the same name will be merged into a single file).

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

    Note: It is necessary to include the ‘File Extension’ option to the Rename Process if the output files are to be viewed.

  • In the Resulting File Name area, view the file name that you have 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 on the bottom of the Preview area.

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

  • Select the Save button to keep the Rename definition. You can also select the Help button to access online help and select the Cancel button to exit the window without saving any changes.