File pointers are used by flow steps that handle files to simplify data management.
App Xchange file pointers share the following attributes:
-
Filename: The name of the file (for example,
invoice.pdf). -
Content Type: The MIME type (for example,
text/csvorapplication/json).Note: If an appropriate file type cannot be determined, the system defaults toapplication/octet-stream. -
Size: The file size in bytes.
Note: The max file size is 500 MB. -
Location: The URL where the actual data resides. This could be a secure internal URL provided by an App Xchange output, a provided public URL, etc.
File pointers hosted in App Xchange's File API are temporary. They remain valid for 12 hours after creation, after which the reference expires. FIle pointers corresponding to public files do not expire.
You can retrieve a file pointer from a Connector Action flow step for whom a file pointer is the top-level result
using the syntax
actionResponse.result
or return
flow.step('your-action-step').actionResponse.result.filePointer;
for the SFTP connector.
You can retrieve a file pointer from any previous flow step for whom a file
pointer is the top-level result using the syntax flow.step('id').output. Some steps accept an entire file pointer object,
while others require the properties broken down as such.
- filename:
flow.step('step-name').output.filename; - contentType:
flow.step('step-name').output.contentType; - size:
flow.step('step-name').output.size; - location:
flow.step('step-name').output.location;
Compatible Flow Steps
These flow steps can interact with file pointers, either by generating them as an output or using them as an input:
Combine Delimited Files flow step
Create Delimited File flow step
Create Text File flow step
Email flow step (input only)
Encrypt File flow step
Extract Zip V2 flow step
Parse Excel File to JSON flow step
Read a CSV File flow step +
Parse Delimited File to JSON flow step (The Read step takes the file pointer as an input and outputs the raw string for the Parse step)
Read a CSV File flow step +
Parse CSV File to JSON flow step (The Read step takes the file pointer as an input and outputs the raw string for the Parse step)
Example Use Case
There are many possible use cases for file pointers. For example,
when using the S/FTP connector, you could use a Connector Action flow step to read a file. The step would output a
file pointer, which you could then pass to a
Read a CSV File flow step. This would output the raw string for a
Parse CSV File to JSON flow step to extract row data.