The Box Destination step is used to write files to Box. A Box account is required for this step to work. In addition, a connection to Box needs to be created.
The technical diagram below illustrates the data flow when a record is sent to a Box Destination step.
Creating a Box Connection
A connection to Box must be created on Synatic before a step can be used. Follow the instructions below to create a Box connection:
1. Click on the Connection Tab in the Menu bar (1), and then click on the plus button to access the available connections (2).
2. Select the Box Connection (3) from the list or use the search bar to look for it.
3. Provide a name in the Connection Name section.
4. Select the Oauth 2.0 Connection Type and click on the Logon to box button. It will redirect to the box page where the required credentials will be entered.
5. Once credentials are entered, click on the Grant Access to Box button to set the Oath Token on the connection.
6. There is an option to fill in the Commonly Accessed Folders section to cache folders that can be accessed quickly from Box. Provide the Folder Name, Folder ID and the Parent Folder ID.
7. Click the Save button to save the connection.
Adding a Box Destination Step
To add a Box Destination step in a flow, follow the instructions below:
1. Click on the plus icon as shown in the image below.
2. The page below will appear. Click on the Destination tab and select or search for Box as shown in the image below.
Configuring a Box Destination Step
Illustrated in the image below is the configuration available in the Box Destination step.
Select an existing connection by clicking on the dropdown arrow as shown in the image above.
Path – The full file path to save on Box.
Folder ID – The Parent folder ID (Default is 0)
Create Path Checkbox – Create the destination path if it does not exist.
Overwrite Checkbox – Overwrite the file if it exists in the path.
Move Existing Files – Move a file from one path to another. Click on the Enable Checkbox to move files. This will provide a Path field to move the files to.
Trigger File – Write a trigger file on completion of the file being written. This will provide a Path field to move the files to, as well as a text template field to write the trigger file.
Empty File – Write an empty file if there are no records. This will provide a text template field to write the trigger file.
Using a Box Destination Step
The image below shows the PDF Writer step, which will create a PDF file that will be saved on the created path in the Box Destination step.
To use a Box Destination step, follow the instructions below:
1. Click the Execute Flow button shown in the image below.
2. Click the Create Run button.
The image below shows the file created in the path after the run.