Set/edit file names for File Transfers
Compose Enterprise is going through a design update. The illustrations on this page might be of the old design, but the information is up to date. Thank you for your patience during this update!
Compose allows you to transfer all the generated and uploaded files from a workflow. These can be collected by a File Transfer and transferred by FlowRemote. If you have specific requirements for the file name you have the option to set/edit file names for all files transferred by the File Transfer. You can also combine the original file name with other parameters. All static names can be entered by simply typing the preferred name. For dynamic file names you need to use placeholders.
Available placeholders
A placeholder allows you to add dynamic information to the file name. You may not know exactly what a file name should be before the workflow has been completed, and the use of placeholders enables you to add these dynamic parameters to the file name. The following placeholders are available:
Information | Placeholder | When do you use it? | Example | File name in file transfer |
---|---|---|---|---|
Original file name | {filename} | When you want to include the original file name (form attached files) in the file name | F_{filename}.pdf | F_CV.pdf (If the uploaded file name is CV) |
File extension | {ext} | When {ext} is added as the extension of the file name, the file will include the original extension (from attached files) | Form00.{ext} | Form00.pdf (If file with PDF format was uploaded) Form00.docx (If file with .docx Word format was uploaded) |
Transfer ID | {id} | When you want to include the ID from the Transfer ID activity in the workflow. | Form00_{id}.xml | Form00_1.xml (If workflow got the first possible transfer ID) Form00_2.xml (If workflow got the second possible transfer ID) Form00_532.xml (If workflow got the 532nd possible transfer ID) |
File number count | {filenumber} | Depending on how many files are included in a delivery, all files will include a number. If there are 5 files in the delivery sent to the file transfer {filenumber} will be replaced by 1,2,3,4,5 respectively. | Form00_attachment{filenumber}.{ext} | Form00_attachment1.pdf Form00_attachment2.jpg Form00_attachment3.pdf (If 3 files have this placeholder and are included in the same delivery.) |
Generated ID | {unique_ID_activity_name} | The placeholder for a generated ID (Unique ID). Note: The placeholder will be the name you have given the Unique ID activity in the workflow. | Form1234_{idGen}.xml Form1100_{genID}.pdf | Form1234_55ID.xml (If generated ID is 55ID and the name of the Unique ID activity is idGen) Form1100_ID_400.pdf (If generated ID is ID_400 and the name of the Unique ID activity is genID) |
How do you edit the File Transfer file names?
This is a short example of how to edit file names for File Transfer files in a workflow. The example will show how to set/edit the name for a uploaded file and a generated PDF.
This example will not show how to configure the basics for the elements, so take a look at the Build a simple workflow user guide for additional help.
Before creating the workflow you need to create a versioned form with a duplicatable file upload question group and a file upload question, a Unique ID activity and a Send via File Transfer activity.
In this example we will use a workflow with the following workflow elements:
A Start Point
A Form
A Unique ID
A PDF
A Send via File Transfer
An End point
Start by adding all the elements to the workflow canvas and connecting them.
Then configure the settings for the Start Point, the Form Activity, the Unique ID Activity, the PDF and the End Point. When all these elements have been configured, please select the Send via File Transfer activity in the canvas.
Browse to connect the previously created File Transfer.
Attachment from Uploaded File Question
Then click Add file in the File Transfer activity properties panel. A dialog box appears. Please Browse to find the file upload question.
Expand (>) the Form Activity, select the file upload question and press OK.
The Select files dialog box reappears. Under File Name select New and enter the file name you wish to give the file. In this example we will use the file name Form1100_{filename}_{idGen}_{filenumber}.{ext}. This will result in a file name with the entered static text first, then the original file name of the uploaded file, the generated ID we receive from the Unique ID Activity, the filenumber (counting all files uploaded) and the original extension of the uploaded file.
When you have pressed OK. The selected file and file name can be seen in the list of files under the File Transfer properties panel.
Attachment from Duplicatable Uploaded File Question Group
To add the attachments from the duplicatable file upload group, please click Add File again.
To be able to add the group of attachments, select Question Group and Browse.
Expand (>) the Form Activity, select the file upload question group and press Ok.
The Select files dialog box reappears. Under File Name select New and enter the file name you wish to give the file. In this example we will use the file name Form1100_attachment_{idGen}_{filenumber}.{ext}. This will result in a file name with the entered static text first, the generated ID we receive from the Unique ID Activity, the filenumber (counting all files uploaded) and the original extension of the uploaded file.
When you have pressed OK. The selected file and file name can be seen in the list of files under the File Transfer properties panel.
Generated PDF in workflow
To add the generated PDF, please click Add File and Browse.
Select the PDF and press OK.
The Select files dialog box reappears. Under File Name select New and change the file name you wish to give the PDF-file. In this example we will use the file name Form1100_{idGen}_{filenumber}.pdf. This will result in a file name with the entered static text first, the generated ID we receive from the Unique ID Activity, the filenumber (counting all files uploaded) and .pdf as the file extension.
When you have pressed OK. The selected PDF and selected file name can be seen in the list of files under the File Transfer properties panel.
When you have saved the draft and version your workflow, it is ready to be set into production.
When the respondent runs through the workflow the files will be given the names you have set. For the examples shown above the following files are collected by the File Transfer:
Edit the file name
If you want to edit the file names after adding them to the File Transfer Activity, please select the File Transfer Activity and select the file you wish to rename in the list of files.
When the file is selected, click Edit File.
Edit the file name and click Ok.
When you have saved the draft and version your workflow, it is ready to be set into production.