Provide file

This action allows to retrieve files from different sources and make them available within the workflow. Possible sources are from previous actions, client and form files, attachments of the process, and files from the Internet.

Parameters

File resource details

File

Selection of the file to be used. Available are Formcycle files, Client files, resources loaded via a URL, files from previous actions or form record attachments. There is no restriction regarding the format, so all file types (PDF, GIF, PNG, DOC ...) can be used. See actions for a list of supported URL protocols.

When using an external resource URL:

Resource URL

URL to the file. The use of variables is possible.

Connection timeout

Defines the time limit in seconds for establishing the connection to retrieve the external resource. The value must be between 1 and 60.

Read timeout

Defines the time limit in seconds for read operations during the retrieval of the external resource. The value must be between 1 and 600.

Storage options for the created files

Output file name

Name of the output file.

Attach file to form record

If this option is selected, files created in this action will be attached to the form record. Otherwise, they are only available for other actions within the workflow processing in the same processing chain.

Action variables

Actions of type Provide file provide Action variables which can be used in subsequent actions.

Standard action variables

[%$<action name>.SUCCESS%]

Return whether action was successfully executed. Returns Boolean (true/false).

[%$<action name>.RESULT%]

Return all results provided by the action in structured form.

[%$<action name>.ERROR_CODE%]

The error code thrown in case of an error in the action. Empty if no error occurred.

[%$<action name>.ERROR_MESSAGE%]

The thrown error message in the action's error case. Empty if no error occurred.

Action specific action variables

[%$<action name>.RESULT.fileSize%]

Size of the provided file, in bytes.

[%$<action name>.ERROR.message%]

Error code returned if the text file could not be written to the file system or could not be read, if the URL provided does not match a valid format, or if no source file could be determined to perform the action.