Split Document using AI
The CloudFiles: Split Document Using AI flow action enables automated splitting of merged PDF files stored in Salesforce or external cloud storage into individual documents. By leveraging AI, the action intelligently identifies and separates multiple documents within a merged PDF. This is particularly useful for processing files like scanned bundles of invoices or multi-document contracts.
The CloudFiles: Split Document Using AI action asynchronously processes a specified merged PDF document and splits it into multiple files based on its contents. These split files are then saved to a specified destination in Salesforce or an external storage platform. Instead of providing direct outputs, the action publishes a Document Split event upon completion. This event includes metadata for the generated files, which can be used for further automation.
Example Use Case:
Automating the processing of uploaded invoice bundles. A merged PDF containing multiple invoices is split into individual invoice files, which are then saved to a designated folder in Salesforce or external storage.
In your Flow Builder, search for the element named "CloudFiles: Split Document using AI". You can find this action in the CloudFiles category when you click on the "Action" element in the "Add Element" box. Select the action to insert it into the flow, and then configure the input parameters.
In order to specify a Salesforce File to be processed, Input paramters as:
- Library - salesforce
- FileID - The ContentDocumentID of the Salesforce File to be split.
You can get the ContentDocumentID of the Salesforce File from other standard salesforce elements like "Get Records" or standard Screen Flow "Upload Files" component or from details of CloudFiles Events like Salesforce File Attached.
- It is mandatory to input both Library and FileID to specify a Salesforce File.
If you are using CloudFiles: Document Managemnt pacakage as well, then you can Process and Split the file in connected external storage as well.
In order to specify an External Storage File to be processed, Input paramters as:
- Library - The Library parameter is the external storage type you are using. Possible values are sharepoint, google (for Google Drive), azure , onedrive, dropbox, box, cloudfiles (for AWS S3).
- Drive Id - The Id of the drive where the document resides. This is important for Google Drive & Sharepoint libraries only. The Drive Id is a unique identifier for a storage location in both SharePoint and Google Drive. In SharePoint, it represents a document library within a site, while in Google Drive, it identifies a user's drive or shared drive.
- File Id - The unique identifier (Resource Id) of the file that is to be processed.
Based on the use case, you can get these parameters from details of other CloudFiles Events like File Uploaded or File Received etc.
An optional identifier to track the source of the event or any other intended/necessary details. This shall be available in corresponding output i.e. in the corresponding Document Split event details.
The Context parameter is particularly helpful if this action is used in multiple flows. For example, if you’re processing documents attached to Contact records, you can set the Contact’s Record Id as the Context. When events are published, this Context value will help you track the origin of each event by showing the associated Contact record.
The Destination parameter determines where the generated files will be stored after CloudFiles completes the splitting process.
Steps to Configure Destination:
- Create an Apex-Defined Variable of Apex Class cldfs__Resource
- Assign the necessary metadata (e.g., Library, Drive Id, Id) based on the chosen storage option.
- To Save in Salesforce
- Default Behavior (Salesforce Files):
- If no destination parameter is specified, the files shall be stored in the Salesforce File Library.
- Link to a Specific Record:
- Assign the following fields:
- Library: Set to salesforce.
- Id: Set to the Record Id of the Salesforce record to which the files will be linked.
- To Store in External Storage
- Assign the following fields to define the external storage location:
- Library: Specify the library name.
- Drive Id: Specify the Id of the connected drive.
- Id: Specify the Id of the folder or location within the drive.
- Pass the configured variable as the Destination Parameter in the CloudFiles: Split Document Using AI action.
This setup provides flexibility to store files in Salesforce or external storage, aligning with your business needs.
The apex action does not return anything as an output in the flow it is used but for every file processed for split, a Document Split event is published. This event signals the completion of document split and can be used to trigger platform event flows to perform post-split actions.