File and folder connectors
Warning about UNC/network paths
When file and folder connectors are called using a UNC/network path, the folders opened must be shared folders.
Write file
| Starting point Universal GUI | Starting point Win/Web GUI | Starting point system flow (Indicium) | System flow action |
|---|---|---|---|
| - | - | + | + |
This connector allows you to write files to a storage location.
It is mandatory to select the file storage location. The connector can only read and write files and file information within the configured file storage location. See also File storage location for a branch.
| Input parameters | |
|---|---|
| Target file name | Name that should be applied to the file. |
| Encoding | Determine whether encoding should be applied to the file (ANSI Latin 1, US-ASCII, UTF-16, UTF-32, UTF-8) |
| Write preamble | Yes or No. Determines whether Indicium should write a preamble for the code file. A preamble (also known as Byte Order Mark, or BOM) consists of some bytes at the start of a file. They indicate how the text has been stored binarily (in which coding). Not all encodings contain a preamble. |
| File data | Binary string that contains the file data. |
| Write mode | Determine the write mode: - New file (default) disk_write_mode_new - There may not be a file present at the specified location. - Overwrite file disk_write_mode_overwrite - There may be a file present at the specified location, this will be overwritten. - Append file disk_write_mode_append - There must be a file present at the specified location, this will be extended. |
| Output parameters | |
|---|---|
| Target file path | Absolute path to the file that has been created. |
| Status code | 0 - Successful -1 - Unsuccessful (unknown) -2 - Unsuccessful (no path specified) -3 - Unsuccessful (the specified path is too long) -4 - Unsuccessful (the specified path is invalid) -5 - Unsuccessful (the specified disk could not be found) -6 - Unsuccessful (one or more sub-folders could not be found) -7 - Unsuccessful (access refused) -8 - Unsuccessful (the file is in use) -9 - Unsuccessful (target disk not found) -10 - Unsuccessful (target file already exists) -11 - Unsuccessful (no file storage provider specified) |
Copy file
| Starting point Universal GUI | Starting point Win/Web GUI | Starting point system flow (Indicium) | System flow action |
|---|---|---|---|
| - | - | + | + |
This connector allows copying files within a storage location.
It is mandatory to select the file storage location. The connector can only read and write files and file information within the configured file storage location. See also File storage location for a branch.
To copy between file storage locations, use the Read file and Write file connectors.
| Input parameters | |
|---|---|
| Source file (pointer) | Absolute path to the file that has to be copied. |
| Target file name | Relative path to the file storage location. |
| Output parameters | |
|---|---|
| Target file path | Absolute path to the location the file has been copied to. |
| Status code | 0 - Successful -1 - Unsuccessful (unknown) -2 - Unsuccessful (no path specified) -3 - Unsuccessful (the specified path is too long) -4 - Unsuccessful (the specified path is invalid) -5 - Unsuccessful (the specified disk could not be found) -6 - Unsuccessful (one or more sub-folders could not be found) -7 - Unsuccessful (access refused) -8 - Unsuccessful (the file is in use) -9 - Unsuccessful (target disk not found) -10 - Unsuccessful (target file already exists) -11 - Unsuccessful (no file storage provider specified) |
Read file
| Starting point Universal GUI | Starting point Win/Web GUI | Starting point system flow (Indicium) | System flow action |
|---|---|---|---|
| - | - | + | + |
This connector allows you to read files from a storage location.
It is mandatory to select the file storage location. The connector can only read and write files and file information within the configured file storage location. See also File storage location for a branch.
| Input parameters | |
|---|---|
| Source file (pointer) | Absolute path to the file that has to be read. |
| Encoding | Select whether encoding should be applied to the file that is made readable. |
| Output parameters | |
|---|---|
| File data | Binary string that contains the file data. |
| Status code | 0 - Successful -1 - Unsuccessful (unknown) -2 - Unsuccessful (no path specified) -3 - Unsuccessful (the specified path is too long) -4 - Unsuccessful (the specified path is invalid) -5 - Unsuccessful (the specified disk could not be found) -6 - Unsuccessful (one or more sub-folders could not be found) -7 - Unsuccessful (access refused) -8 - Unsuccessful (the file is in use) -9 - Unsuccessful (target disk not found) -10 - Unsuccessful (target file already exists) -11 - Unsuccessful (no file storage provider specified) |
Move file
| Starting point Universal GUI | Starting point Win/Web GUI | Starting point system flow (Indicium) | System flow action |
|---|---|---|---|
| - | - | + | + |
This connector allows moving files within a storage location.
It is mandatory to select the file storage location. The connector can only read and write files and file information within the configured file storage location. See also File storage location for a branch.
| Input parameters | |
|---|---|
| Source file (pointer) | Absolute path to the file that has to be moved. |
| Target file name | Relative path to the file storage location. |
| Output parameters | |
|---|---|
| Status code | 0 - Successful -1 - Unsuccessful (unknown) -2 - Unsuccessful (no path specified) -3 - Unsuccessful (the specified path is too long) -4 - Unsuccessful (the specified path is invalid) -5 - Unsuccessful (the specified disk could not be found) -6 - Unsuccessful (one or more sub-folders could not be found) -7 - Unsuccessful (access refused) -8 - Unsuccessful (the file is in use) -9 - Unsuccessful (target disk not found) -10 - Unsuccessful (target file already exists) -11 - Unsuccessful (no file storage provider specified) |
Print file (PDF)
| Starting point Universal GUI | Starting point Win/Web GUI | Starting point system flow (Indicium) | System flow action |
|---|---|---|---|
| - | - | + | + |
This connector allows you to print PDF files from a storage location. It is mandatory to select the printer that should be used.
It is mandatory to select the file storage location. The connector can only read and write files and file information within the configured file storage location. See also File storage location for a branch.
PDF files can only be printed on a Windows platform, and the printer must be installed on the web server.
In a process flow that requires user interaction, the optional parameters are only available for the Universal GUI. In a system flow, the optional parameters are available for both the Universal GUI and the Windows GUI.
| Input parameters | |
|---|---|
| File name | Name of the PDF file that has to be printed. |
| File data | Binary string that contains the PDF file data. |
| Number of copies | The number of times the PDF file should be printed. |
| Override printer name | Optional. Use this printer instead of the model object printer. |
| Duplexing | Optional. Choose a duplexing option: - One sided - Two sided long edge - Two sided short edge |
| Input bin (Tray) | Optional. Choose which input bin (tray) should be used: - Auto select - Auto sheet feeder -Cassette - Manual - Tractor |
| Output color | Optional. Choose the color output: - Color - Grayscale - Monochrome |
| Output quality | Optional. Choose the output quality: - Automatic - Draft - Fax - High - Normal - Photographic - Text |
| Borderless | Optional. Choose whether or not to print without borders. |
| Page order | Optional. Choose the page ordering: - Reverse - Standard |
| Page orientation | Optional. Choose the page orientation: - Portrait - Landscape - Reverse portrait - Reverse landscape |
| Page per sheet | Optional. Choose the number of pages per sheet. |
| Page per sheet direction | Optional. Choose the order in which the pages will be printed on the sheet. |
| Stapling | Optional. Choose if and where the printer should staple the printed paper. |
| Output parameters | |
|---|---|
| Status code | 0 - Successful -1 - Unsuccessful (unknown) -2 - Unsuccessful (no path specified) -3 - Unsuccessful (the specified path is too long) -4 - Unsuccessful (the specified path is invalid) -5 - Unsuccessful (the specified disk could not be found) -6 - Unsuccessful (one or more sub-folders could not be found) -7 - Unsuccessful (access refused) -8 - Unsuccessful (the file is in use) -9 - Unsuccessful (target disk not found) -10 - Unsuccessful (target file already exists) -11 - Unsuccessful (no file storage provider specified) |
Delete file
| Starting point Universal GUI | Starting point Win/Web GUI | Starting point system flow (Indicium) | System flow action |
|---|---|---|---|
| - | - | + | + |
This connector allows you to delete files from a storage location.
It is mandatory to select the file storage location. The connector can only read and write files and file information within the configured file storage location. See also File storage location for a branch.
| Input parameters | |
|---|---|
| Source file (pointer) | Absolute path to the file that has to be deleted. |
| Output parameters | |
|---|---|
| Status code | 0 - Successful -1 - Unsuccessful (unknown) -2 - Unsuccessful (no path specified) -3 - Unsuccessful (the specified path is too long) -4 - Unsuccessful (the specified path is invalid) -5 - Unsuccessful (the specified disk could not be found) -6 - Unsuccessful (one or more sub-folders could not be found) -7 - Unsuccessful (access refused) -8 - Unsuccessful (the file is in use) -9 - Unsuccessful (target disk not found) -10 - Unsuccessful (target file already exists) -11 - Unsuccessful (no file storage provider specified) |
Create folder
| Starting point Universal GUI | Starting point Win/Web GUI | Starting point system flow (Indicium) | System flow action |
|---|---|---|---|
| - | - | + | + |
| Input parameters | |
|---|---|
| Source folder (pointer) | Relative path to the folder that has to be created. This path must be within the configured file storage location. Example: my_folder or my_folder/my_sub_folder. |
| Output parameters | |
|---|---|
| Status code | 0 - Successful -1 - Unsuccessful (unknown) -2 - Unsuccessful (no path specified) -3 - Unsuccessful (the specified path is too long) -4 - Unsuccessful (the specified path is invalid) -5 - Unsuccessful (the specified disk could not be found) -6 - Unsuccessful (one or more sub-folders could not be found) -7 - Unsuccessful (access refused) -8 - Unsuccessful (the file is in use) -9 - Unsuccessful (target disk not found) -10 - Unsuccessful (target file already exists) -11 - Unsuccessful (no file storage provider specified) |
List folder
| Starting point Universal GUI | Starting point Win/Web GUI | Starting point system flow (Indicium) | System flow action |
|---|---|---|---|
| - | - | + | + |
This connector allows you to return the contents of a folder in a list.
It is mandatory to select the file storage location. The connector can only read and write files and file information within the configured file storage location. See also File storage location for a branch.
| Input parameters | |
|---|---|
| Source folder (pointer) | Absolute path to the folder that is requested or has to be displayed. This path must be within the configured file storage location. Example: https://tsfstorage.file.core.windows.net/files. |
| Recursive | Yes or no. Determines whether the request should take sub-folders into consideration. |
| Output parameters | |
|---|---|
| Folder contents (JSON) | JSON value that returns the contents of the requested folder. See also Example of Folder contents (JSON). |
| Status code | 0 - Successful -1 - Unsuccessful (unknown) -2 - Unsuccessful (no path specified) -3 - Unsuccessful (the specified path is too long) -4 - Unsuccessful (the specified path is invalid) -5 - Unsuccessful (the specified disk could not be found) -6 - Unsuccessful (one or more sub-folders could not be found) -7 - Unsuccessful (access refused) -8 - Unsuccessful (the file is in use) -9 - Unsuccessful (target disk not found) -10 - Unsuccessful (target file already exists) -11 - Unsuccessful (no file storage provider specified) |
Example of 'Folder contents (JSON)'
[
{
"Path":"https://thinkwise.file.core.windows.net/files//testfile.xml",
"Name":"testfile.xml",
"IsFolder":false
},
{
"Path":"https://thinkwise.file.core.windows.net/files//testfileCopy.xml",
"Name":"testfileCopy.xml",
"IsFolder":false
}
]
Copy folder
| Starting point Universal GUI | Starting point Win/Web GUI | Starting point system flow (Indicium) | System flow action |
|---|---|---|---|
| - | - | + | + |
This connector allows you to copy folders within a storage location.
It is mandatory to select the file storage location. The connector can only read and write files and file information within the configured file storage location. See also File storage location for a branch.
To copy folders between file storage locations, use the Create folder, Read file and Write file connectors. Use List folder to retrieve the contents of the folder.
| Input parameters | |
|---|---|
| Source folder (pointer) | Absolute path to the folder that has to be copied. This path must be within the configured file storage location. Example: https://tsfstorage.file.core.windows.net/files. |
| Target folder name | Relative path to the file storage location. |
| Existing file strategy | The strategy for dealing with existing files at the target location. - Abort action (default) - Abort the process action if a file already exists at the target location. - Overwrite existing files - Overwrite existing files at the target location. - Skip existing files - Ignore existing files at the target location. |
| Output parameters | |
|---|---|
| Status code | 0 - Successful -1 - Unsuccessful (unknown) -2 - Unsuccessful (no path specified) -3 - Unsuccessful (the specified path is too long) -4 - Unsuccessful (the specified path is invalid) -5 - Unsuccessful (the specified disk could not be found) -6 - Unsuccessful (one or more sub-folders could not be found) -7 - Unsuccessful (access refused) -8 - Unsuccessful (the file is in use) -9 - Unsuccessful (target disk not found) -10 - Unsuccessful (target file already exists) -11 - Unsuccessful (no file storage provider specified) |
Move folder
| Starting point Universal GUI | Starting point Win/Web GUI | Starting point system flow (Indicium) | System flow action |
|---|---|---|---|
| - | - | + | + |
This connector allows your to move folders from one storage location to another.
It is mandatory to select the file storage location. The connector can only read and write files and file information within the configured file storage location. See also File storage location for a branch.
| Input parameters | |
|---|---|
| Source folder (pointer) | Absolute path to the folder that has to be moved. This path must be within the configured file storage location. Example: https://tsfstorage.file.core.windows.net/files. |
| Target folder name | Relative path to the file storage location. |
| Output parameters | |
|---|---|
| Status code | 0 - Successful -1 - Unsuccessful (unknown) -2 - Unsuccessful (no path specified) -3 - Unsuccessful (the specified path is too long) -4 - Unsuccessful (the specified path is invalid) -5 - Unsuccessful (the specified disk could not be found) -6 - Unsuccessful (one or more sub-folders could not be found) -7 - Unsuccessful (access refused) -8 - Unsuccessful (the file is in use) -9 - Unsuccessful (target disk not found) -10 - Unsuccessful (target file already exists) -11 - Unsuccessful (no file storage provider specified) |
Delete folder
| Starting point Universal GUI | Starting point Win/Web GUI | Starting point system flow (Indicium) | System flow action |
|---|---|---|---|
| - | - | + | + |
This connector allows you to delete folders from a storage location.
It is mandatory to select the file storage location. The connector can only read and write files and file information within the configured file storage location. See also File storage location for a branch.
| Input parameters | |
|---|---|
| Source folder (pointer) | Absolute path to the folder that has to be deleted. This path must be within the configured file storage location. Example: https://tsfstorage.file.core.windows.net/files. |
| Delete all directory contents | Yes or no. Indicates whether this connector should delete sub-folders and files within the specified path. |
| Output parameters | |
|---|---|
| Status code | 0 - Successful -1 - Unsuccessful (unknown) -2 - Unsuccessful (no path specified) -3 - Unsuccessful (the specified path is too long) -4 - Unsuccessful (the specified path is invalid) -5 - Unsuccessful (the specified disk could not be found) -6 - Unsuccessful (one or more sub-folders could not be found) -7 - Unsuccessful (access refused) -8 - Unsuccessful (the file is in use) -9 - Unsuccessful (target disk not found) -10 - Unsuccessful (target file already exists) -11 - Unsuccessful (no file storage provider specified) |