Non-file storage connectors in process flows

Non-file storage connectors

warning

As of platform version 2022.2, the connectors listed below should no longer be used if they are not necessarily required. Instead, use connectors as listed under File and folder connectors.

warning

When file and folder connectors are called using a UNC/network path, the folders opened must be shared folders.

Read disk file (non-file storage)

Starting point Universal GUI	Starting point Win/Web GUI	Starting point system flow (Indicium)	System flow action
-	-	+	+

Files at locations within the local network can be read using this connector. This connector uses absolute, local file paths or UNC paths and gives as output the byte-representation of the file. The use of environment variables, like %TEMP% or %APPDATA%, is supported.

Input options
File location	The path to the file that must be read. The path must be an absolute local path or a UNC path.

Output options
Status code	The status code of the executed action. 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 (the file could not be found) -8 - Unsuccessful (access refused)
File data	The byte-representation of the file.

Write disk file (non-file storage)

Starting point Universal GUI	Starting point Win/Web GUI	Starting point system flow (Indicium)	System flow action
-	-	+	+

Files can be written to a location within the local network using this connector. This connector uses absolute, local file paths or UNC paths, and expects the data of the file in the form of text or binary data. The use of environment variables, like %TEMP% or %APPDATA%, is supported.

Input options
File location	The path to the file that must be created. The path must be an absolute local path or a UNC, including the file name and extension.path.
File data	The binary data (bytes) of the file.
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.
Create all subdirectories	Indicates whether the entire folder structure has to be created or that all higher level folders have to exist. No disk_create_all_dirs_off - All higher level folders have to exist already. Yes (default) disk_create_all_dirs_on - The complete folder structure will be created.
Encoding	Indicates the encoding to use. disk_enc_ansi_lat1 disk_enc_us_ascii disk_enc_utf_16 disk_enc_utf_32 disk_enc_utf_8

Output options

Status code

The status code of the executed action. 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 (the file could not be found) -8 - Unsuccessful (the file already exists) -9 - Unsuccessful (access refused) -10- Unsuccessful (no file data present)

Write files to an external location

Indicium

You can write files to an external file storage location using the Write File connector:

1. Create a process variable. The Process variable should end with a double underscore __ followed by the intended file storage location ID.
   This is only available for File System, FTP, Azure, and AWS storage locations, not for database storage locations.

   Example of a file storage process flow

2. In the Write File connector process action, use this process variable for the File location input parameter.

3. The value of the process variable must be the file name, as it will be written to the storage location. It can also be a relative path that ends with a file name. In that case, the storage location is the base path. Valid examples are:

my_file.txt
my_sub_folder\another_sub_folder\my_file.txt

The data provided in the File data input parameter is written to the storage location.

Move disk file (non-file storage)

Starting point Universal GUI	Starting point Win/Web GUI	Starting point system flow (Indicium)	System flow action
-	-	+	+

Files from locations within the local network can be moved to other locations within the local network using this connector. The source path and the target path are provided by means of input options and have to have the form of an absolute, local file path or UNC path. The use of environment variables, like %TEMP% or %APPDATA%, is supported.

Input options
From file location	The path to the file that has to be moved. This path has to be an absolute local path or a UNC path.
To file location	The path to the location the file has to be moved to. This path has to be an absolute local path or a UNC path.
Create all subdirectories	Indicates whether the entire folder structure of To file location has to be created or that all higher level folders have to exist. No disk_create_all_dirs_off - All higher level folders have to exist already. Yes (default) disk_create_all_dirs_on - The complete folder structure will be created.

Output options

Status code

The status code of the executed action. 0 - Successful -1 - Unsuccessful (unknown) -2 - Unsuccessful (no source path specified) -3 - Unsuccessful (no target path specified) -4 - Unsuccessful (one of the specified paths is too long) -5 - Unsuccessful (one of the specified paths is invalid) -6 - Unsuccessful (source path not found) -7 - Unsuccessful (source disk not found) -8 - Unsuccessful (target path not found) -9 - Unsuccessful (target disk not found) -10 - Unsuccessful (target path already exists) -11 - Unsuccessful (access refused)

Copy disk file (non-file storage)

Starting point Universal GUI	Starting point Win/Web GUI	Starting point system flow (Indicium)	System flow action
-	-	+	+

Files from locations within the local network can be copied to other locations within the local network using this connector. The source path and the target path are provided by means of input options and have to have the form of an absolute, local file path or UNC path. The use of environment variables, like %TEMP% or %APPDATA%, is supported.

Input options
From file location	The path to the file that has to be moved. This path has to be an absolute local path or a UNC path.
To file location	The path to the location the file has to be moved to. This path has to be an absolute local path or a UNC path.
Create target directory	Indicates whether the entire folder structure of To file location has to be created or that all higher level folders have to exist. No - All higher level folders have to exist already. Yes (default) - The complete folder structure will be created.

Output options

Status code

The status code of the executed action. 0 - Successful -1 - Unsuccessful (unknown) -2 - Unsuccessful (no source path specified) -3 - Unsuccessful (no target path specified) -4 - Unsuccessful (one of the specified paths is too long) -5 - Unsuccessful (one of the specified paths is invalid) -6 - Unsuccessful (source path not found) -7 - Unsuccessful (source disk not found) -8 - Unsuccessful (target path not found) -9 - Unsuccessful (target disk not found) -10 - Unsuccessful (target file already exists) -11 - Unsuccessful (access refused)

Delete disk file (non-file storage)

Starting point Universal GUI	Starting point Win/Web GUI	Starting point system flow (Indicium)	System flow action
-	-	+	+

A file at a location within the local network can be deleted using this connector. The path to the file is provided by means of an input option and has to have the form of an absolute, local file path or UNC path. The use of environment variables, like %TEMP% or %APPDATA%, is supported.

Input options
File location	The path to the file that has to be deleted. This path has to be an absolute local path or a UNC path.

Output options

Status code

The status code of the executed action. 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)

Create disk folder (non-file storage)

Starting point Universal GUI	Starting point Win/Web GUI	Starting point system flow (Indicium)	System flow action
-	-	+	+

A folder can be created on a location within the local network using this connector. The path to the file that has to be created is provided by means of an input option and has to have the form of an absolute, local file path or UNC path. In addition, it can also be indicated whether the provided folder structure has to exist or may be created. The use of environment variables, like %TEMP% or %APPDATA%, is supported.

Input options
Directory location	The path to the folder that has to be created. This path has to be an absolute local path or a UNC path.
Create all subdirectories	Indicates whether the entire folder structure from Directory location has to be created or that all higher level folders have to exist. No disk_create_all_dirs_off - All higher level folders have to exist already. Yes (default) disk_create_all_dirs_on - The complete folder structure will be created.

Output options
Status code	The status code of the executed action. 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)

Move disk folder (non-file storage)

Starting point Universal GUI	Starting point Win/Web GUI	Starting point system flow (Indicium)	System flow action
-	-	+	+

Folders from locations within the local network can be moved to other locations within the local network using this connector. The source path and the target path are provided by means of input options and have to have the form of an absolute, local path or UNC path. The use of environment variables, like %TEMP% or %APPDATA%, is supported.

Input options
From folder location	The path to the folder that has to be moved. This path has to be an absolute local path or a UNC path.
To folder location	The path to the location the folder has to be moved to. This path has to be an absolute local path or a UNC path.
Create target directory	Indicates whether the entire folder structure of To folder location has to be created or that all higher level folders have to exist. No disk_create_all_dirs_off - All higher level folders have to exist already. Yes (default) disk_create_all_dirs_on - The complete folder structure will be created.

Output options

Status code

The status code of the executed action. 0 - Successful -1 - Unsuccessful (unknown) -2 - Unsuccessful (no source path specified) -3 - Unsuccessful (no target path specified) -4 - Unsuccessful (one of the specified paths is too long) -5 - Unsuccessful (one of the specified paths is invalid) -6 - Unsuccessful (source path not found) -7 - Unsuccessful (source disk not found) -8 - Unsuccessful (target path not found) -9 - Unsuccessful (target disk not found) -10 - Unsuccessful (target path already exists) -11 - Unsuccessful (access refused)

Copy disk folder (non-file storage)

Starting point Universal GUI	Starting point Win/Web GUI	Starting point system flow (Indicium)	System flow action
-	-	+	+

Folders from locations within the local network can be copied to other locations within the local network using this connector. The source path and the target path are provided by means of input options and have to have the form of an absolute, local path or UNC path. The use of environment variables, like %TEMP% or %APPDATA%, is supported.

Input options
From folder location	The path to the folder that has to be moved. This path has to be an absolute local path or a UNC path.
To folder location	The path to the location the folder has to be moved to. This path has to be an absolute local path or a UNC path.
Create target directory	Indicates whether the entire parent folder structure of To folder location has to be created or that all higher level folders of the target path have to exist. No - All higher level folders have to exist already. Yes (default) - The complete target folder structure will be created.
Existing file strategy	Determines the strategy of dealing with existing files at the target location. Skip existing files disk_exist_skip - Ignore existing files in the target location Overwrite existing files disk_exist_overwrite - Overwrite existing files in the target location Abort action (default) disk_exist_abort - Abort the process action if a file already exists in the target location.

Output options

Status code

The status code of the executed action. 0 - Successful -1 - Unsuccessful (unknown) -2 - Unsuccessful (no source path specified) -3 - Unsuccessful (no target path specified) -4 - Unsuccessful (one of the specified paths is too long) -5 - Unsuccessful (one of the specified paths is invalid) -6 - Unsuccessful (source path not found) -7 - Unsuccessful (source disk not found) -8 - Unsuccessful (target path not found) -9 - Unsuccessful (target disk not found) -10 - Unsuccessful (file already exists in target folder) -11 - Unsuccessful (access refused)

Delete disk folder (non-file storage)

Starting point Universal GUI	Starting point Win/Web GUI	Starting point system flow (Indicium)	System flow action
-	-	+	+

A folder on a location within the local network can be deleted using this connector. The path to folder is provided by means of an input option and has to have the form of an absolute, local path or UNC path. The use of environment variables, like %TEMP% or %APPDATA%, is supported.

Input options
Folder location	The path to the folder that has to be deleted. This path has to be an absolute local path or a UNC path.
Delete all directory contents	Indicates whether the process action may or may not delete sub-folders and files within the specified path. No (default) disk_delete_recursive_off - No content will be deleted. Yes disk_delete_recursive_on - All folder content will be deleted.

Output options

Status code

The status code of the executed action. 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 specified path is ambiguous, there is a folder and a file with the same name) -9 - Unsuccessful (the specified folder is in use, read only or contains sub-folders) -10 - Unsuccessful (the specified folder is in use or contains sub-folders)

FTP connector (non-file storage)

Starting point Universal GUI	Starting point Win/Web GUI	Starting point system flow (Indicium)	System flow action
-	-	+	+

The FTP connector provides the following input options with which several properties of an ftp request can be controlled.

Input options
URL	The complete URL that will be used for the request.
FTP method	The FTP method that will be used for the request. ftp_method_appe - Append a file ftp_method_dele - Delete a file ftp_method_retr - Download a file ftp_method_mdtm - Retrieve the date-time stamp of a file ftp_method_list - Get a detailed list of files ftp_method_nlist - Get a short list of files ftp_method_mkd - Create a directory ftp_method_pwd - Print the name of the current working directory ftp_method_rmd - Remove a directory ftp_method_rename - Rename a directory ftp_method_size - Retrieve the size of a file ftp_method_stor - Upload a file ftp_method_stou - Upload a file with a unique name For more information, see: https://docs.microsoft.com/en-us/dotnet/api/system.net.webrequestmethods.ftp
New file name	Optional. In the case of a RenameFile action, this input option can be used to provide the new name for the file.
File data	Optional. The content that will be sent with the request, for example, with an UploadFile action.
Use SSL	Optional. Indicates whether SSL has to be used for the request. Possible values: Yes smtp_ssl_on No (default) smtp_ssl_off
Authentication type	Optional. The authentication type that will be used for the request. None (default) - No authentication Basic - Basic authentication
Username	Optional. The user name that will be used for the authentication, if applicable.
Password	Optional. The password that will be used for the authentication, if applicable.
Timeout	Optional. An integer that indicates the timeout of the request in milliseconds. Default is endless.
Use passive mode	Optional. No ftp_passive_off if it is necessary to wait for a connection. Yes (default) ftp_passive_on if the connection itself must be established.

Output options
Status code	The status code of the executed action. 0 - Successful -1 - Unsuccessful (unknown) -2 - Unsuccessful (invalid URL) -3 - Unsuccessful (invalid FTP method)
FTP status code	The FTP status code of the response. For example 2xx, 4xx, 5xx, etc.
Status description	A description of the response status.
Last modified	The date and time at which the file on the server was last modified.
File data length	The length of the content of the response.
File data	The content of the response.