Table of Contents
File renaming
Table of Contents
You can use the File rename action to:
- Preserve the original file name in metadata.
- Generate new file names using metadata fields, dynamic tags, and text values.
- Add incremental numbering to help ensure unique file names and maintain a predictable naming sequence. This can make file names easier to identify and organize than relying solely on duplicate file name suffixes.
The File rename action is added immediately after the workflow input node because it processes file names before any subsequent workflow actions. Any subsequent action in the workflow uses the renamed file name produced by this step.
File name validation and naming limitations
Generated file names are validated before processing so that:
- Unsupported characters are replaced with an underscore (_).
- Reserved Windows file names, such as
CON,PRN,AUX,NUL,COM1-COM9, andLPT1-LPT9are not allowed. - File names that exceed the maximum supported length (150 characters) are truncated.
This helps ensure generated file names remain compatible with supported file systems and applications.
Naming limitations
- Maximum file name length: 150 characters
- Maximum rename elements: 30
- Supported characters:
A-Za-z0-9Space-_.()[]
Using the file rename action
Original file name handling
Keep the original file name in a metadata field - select to save all or part of the original file name.
Select Full, First, or Last from the dropdown list. If you select First or Last, you need to enter the number of characters.
Select the metadata field where the file name should be stored.
Example
Original file name: IMG_20250115_001.jpg
Keep the first 8 characters: IMG_20250
The selected value is stored in the selected metadata field. The file name is stored before any new file name is generated.
Include the original name in the new file name - select to incorporate the original file name into the generated file name. You can place the original file name at the start or end of the file name.
Example
Generated file name pattern: Originalfile name_{{asset.metadata:801}}
Result: IMG_0042_4500
Tip: You can save the original file name to metadata and include it in the generated file name at the same time.
Renaming
Enter a new file name in the text field. A file name can contain plain text, metadata fields, dynamic tags, and the original file name.
Separator - Select the character used to separate filename elements. Choose a hyphen (-), underscore (_), or None to place values together without a separator
Select Add to insert a new text field, metadata field, or dynamic tag.
Text field example:Archive
Use text values to add fixed elements to the file name.
Metadata field example:{{asset.metadata:120}}
When the workflow runs, the placeholder is replaced with the asset's metadata value.
Dynamic tags example: {{incnumber_local}}
Dynamic tags generate values automatically when the workflow runs.
Example file name pattern: {{asset.metadata:120}}_{{asset.metadata:801}}_OriginalFileName
Generated file name: 2025-01-15_4500_IMG_0042
Add incremental numbering
Incremental numbering automatically adds a number sequence to generated file names. This helps create unique file names and maintain a predictable sequence across assets.
Select Add incremental numbering to enable numbering options.
Use the global number sequence - Sets a global count starting point across workflows. Use a global sequence when assets processed by multiple workflows must share the same numbering series. The current sequence number is displayed above when you select this option.
Sequence will start from chosen number when saved - You can enter values below to set a start number. This is particularly useful when migrating from another system or continuing an existing numbering convention. If your previous system ended at 456, for example, set the start value to 457. The next processed asset receives that number.
Start increment from - Enter the start number-
Use … to separate - Select a hyphen or underscore from the dropdown list.
Restart the sequence when the number reaches - To automatically reset numbering after a specific value, enter a number here. If the value given is 999, for example, the next generated number restarts at the beginning of the configured sequence.
Example - Creating a standardized file name
The following configuration:
- Stores the original file name in metadata
- Includes the original file name in the generated file name
- Uses metadata fields
- Adds workflow-specific numbering
File name pattern: {{asset.metadata:120}}_{{asset.metadata:801}}_{{incnumber_local}}_OriginalFileName
Metadata values:
| Field | Value |
|---|---|
| Camera date | 2025-01-15 |
| Archive number | 4500 |
| Increment number | 1 |
| Original file name | IMG_0042 |
Generated file name: 2025-01-15_4500_001_IMG_0042