Skip to main content
Feedback

File Resource Response Profiles

A File Resource Response Profile defines the structure of data returned to Flow after a file operation (such as an upload) completes. Although you can build your profiles manually, clicking Import on the Flow Service Operation opens the Flow Service Operation Import wizard. This automatically generates a standard Response Profile template for either of the two File Resource Operations.

Import

This profile will define the data returned to Flow after a file has uploaded. An example of an automatically generated Upload File Operation Response Profile is shown below:

Response Profile

  • You should rename the top-level Object element from the generic 'Object' to a more meaningful reference. This profile name maps to the name of the type that you will use in Flow with the file data. For example, renaming this to 'RefA' will then align with a type name of '$File RESPONSE - RefA' in Flow.

  • A process must return a populated 'externalid' value in the profile, so you must include this element in the profile. Some external systems (such as AWS S3) may provide a GUID in response to a file-save mechanism that could be used in this value. Alternatively a default piece of data could be used to populate this value. You can remove all other profile entries if not required. Best practice recommends that any necessary destination or identifier information is returned to the Flow as part of the profile, with this data saved as needed from the Flow.

  • Additional entries can be added into the automatically generated profile if you wish to include additional information in the contents of uploaded files. For example, a simple Character entry (FileSimpleContents) could be added to return simple text contents for a file.