Skip to main content

Process flow connectors

Introduction to process flow connectors

Various special process action types are available, called connectors. Connectors differ from the other process action types in that they do not expose GUI features for automation but enable you to connect to other applications, services and media through various common protocols.

Application connector

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

The Application connector provides input options to establish a connection to the database of another application. The command will be executed using the pool account configured for Indicium. The user initiating the process flow will not be impersonated. The Application connector has no limit to the command wait time; no timeout will occur.

The Application connector can retrieve multiple result sets:

  • From a single query.
  • By using multiple queries, separated by a delimiter specified in the process flow.

If multiple result sets are detected, the Application connector will retrieve them and put them in a single JSON file. You can use this for a stored procedure in the Application connector, returning multiple result sets.

If a tsf_send_message procedure sends a message to the Application connector, the message is translated into the language of the user who initiated the process flow. If the Application connector is called from a system flow, then the message is translated into the application's fallback language.

danger

Contrary to the Database connector, parameterization of the statements is not yet available. Be careful when creating SQL queries on-the-fly using the textual values of process variables or data present in the database. This can open up the application to SQL Injection attacks.

Input options
Application id/aliasThe ID or the alias of an active application (or runtime configuration) present in the same IAM (or SF). For example 211 or insights. Using an alias is recommended as this can remain stable throughout environments and versions.
SQLThe SQL executed by this process action, for example:
select total_amount from sales_order where customer_id = 15 and sales_order_id = 21
Or:
exec generate_sales_order 15, 10
Command delimiter (regex)Optional. A C# regular expression used to instruct the connector to execute multiple sequential commands on the same connection.
The SQL value will be split into multiple commands using this regular expression.
Continue on errorOptional. Use in conjunction with Command delimiter (regex). If an error occurs during command execution, the next command can be executed or the execution can be halted based on this setting.
Yes continue_on_error_yes
No (default) continue_on_error_no
Start from indexWhen multiple statements are specified with a delimiter, Indicium will start with the one indicated by the Start from index parameter, ignoring all the statements before that.

Command delimiter (regex) example:

;[^;]*(?:\z|--go\r\n|--go\n|--GO\r\n|--GO\n)

This example regular expression will split the commands using a semicolon followed by --GO in various casings. This is the command delimiting style used by the Software Factory for generated DB2 code.

Output options
Status codeThe status code of the executed action.
0 - Successful
-1 - Unsuccessful (unknown)
-2 - Unsuccessful (Missing application id or alias)
-3 - Unsuccessful (Unknown application id or alias)
-4 - Unsuccessful (no command text)
-5 - Unsuccessful (could not parse command delimiter regex)
-6 - Unsuccessful (could not load application model)
-7 - Unsuccessful (could not open database)
-8 - Unsuccessful (could not connect to database server)
-9 - Unsuccessful (invalid credentials for database connection)
-100 - Unsuccessful (Indicium is not used by the client executing the process flow)
ResultA JSON-formatted list containing the success status and result set(s) of the executed command.
When using a Command delimiter: A JSON-formatted list of executed commands with corresponding results.
MessagesA JSON-formatted list of messages thrown by the executed command. These messages are pre-parsed to formal messages using the model of the target application.
When using a Command delimiter: A JSON-formatted nested list of executed commands with corresponding messages.

HTTP connector

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

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

Input options
URLThe complete url that will be used for the request.
HTTP methodThe HTTP method that will be used for the request.
http_method_delete
http_method_get
http_method_head
http_method_options
http_method_patch
http_method_post
http_method_put
http_method_trace
HeadersOptional. The header that will be provided with the request. This input option must be completed in the following manner:
[ { "Key": "Header1", "Value": "Value1" }, { "Key": "Header2", "Value": "Value2" } ]
When specifying a Headers input option, the Key attribute cannot be empty.
CookieOptional. A possible cookie that will be provided with the request.
Content-TypeOptional. The MIME type for the content that will be provided with the request.
ContentOptional. The content that will be sent with the request, for instance with a POST.
Authentication typeOptional. The authentication type that will be used for the request.
None (default) http_auth_none - No authentication
Basic http_auth_basic - Basic authentication
Digest http_auth_digest - Digest authentication
Windows (Negotiate) http_auth_negotiate - Negotiate (NTLM/Kerberos)
UsernameOptional. The user name that will be used for the authentication, if applicable.
PasswordOptional. The password that will be used for the authentication, if applicable.
TimeoutOptional. An integer that indicates the timeout of the request in milliseconds. Default is 100,000.
Output options
Status codeThe status code of the executed action.
0 - Successful
-1 - Unsuccessful (unknown)
-2 - Unsuccessful (invalid URL)
-3 - Unsuccessful (invalid HTTP method)
-4 - Unsuccessful (invalid headers)
-5 - Unsuccessful (invalid cookie)
-6 - Unsuccessful (request timed out)
HTTP status codeThe HTTP status code of the response. For example 200, 403, 404, 500, etc.
HeadersThe headers of the response, for example:
[{"Key":"Content-Type","Value":"application/json"},{"Key":"Content-Encoding","Value":""}]
Set-CookieThe HTTP Cookie that possibly returns with the response.
Content-TypeThe MIME type for the content that was returned with the response.
Content encodingThe encoding that is used for the content in the response.
Content-LengthThe length of the content of the response.
Content-DispositionPossibly contains a suggestion for a file name.
ContentThe content of the response.

SMTP connector

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

This connector provides the following input options to control several properties of an SMTP request and an SMTP message:

  • If you have selected a Storage location and wish to make attachments available, use input parameter Storage attachment path.
  • For attachments without using a file storage location, use the Disk file attachments and Disk file deletable attachments input parameters. :::
Input options
SMTP server addressThe host name or the IP address of the SMTP server with which the email will be sent.
SMTP server portThe port to which the SMTP server listens.
Use SSLOptional. Whether SSL must be used for the connection.
No (default)
Yes
smtp_con_usernameOptional. The user name that will be used for the authentication.
PasswordOptional. The password that will be used for the authentication.
From addressThe email address that will be used as sender of the email.
From nameOptional. The display of the sender of the email. If not specified, this will be equal to From address.
To recipientsOptional. A list of email addresses separated by semi-colons. These addresses appear in the TO field of the email.
CC recipientsOptional. A list of email addresses separated by semi-colons. These addresses appear in the CC field of the email.
BCC recipientsOptional. A list of email addresses separated by semi-colons. These addresses appear in the BCC field of the email.
SubjectThe subject with which the email will be sent.
MessageOptional. The message of the email.
Message encodingOptional. The encoding for the message of the email.
ASCII smtp_enc_ascii
UTF8 (default) smtp_enc_utf8
UTF16 smtp_enc_utf16
UTF32 smtp_enc_utf32
Allow HTMLOptional. Indicates whether the content of the message can be interpreted as HTML.
No (default) smtp_body_html_off
Yes smtp_body_html_on
Disk file attachmentsOptional. A list of file paths separated by semi-colons. The files will be added as an attachment to the email. Only for use without a file storage location.
Disk file deletable attachmentsOptional. A list of file paths separated by semi-colons. The files will be added as an attachment to the email. These files will be deleted after transmission of the email. Only for use without a file storage location.
PriorityOptional. Gives the priority of the email to be sent.
Low smtp_msg_priority_low
Normal (default) smtp_msg_priority_normal
High smtp_msg_priority_high
SignatureOptional. The signature that is placed under the email to be sent.
Storage attachments pathOptional. You can add one absolute path that refers to a file in the file storage containing the email attachments.
This parameter can only be used when a file storage location is specified in this process action's Form tab.
Output options
Status codeThe status code of the executed action.
0 - Successful
-1 - Unsuccessful (unknown)
-2 - Unsuccessful (making a connection with server failed)
-3 - Unsuccessful (from address not entered)
-4 - Unsuccessful (one or more addressees could not be reached)
-5 - Unsuccessful (one or more attachments could not be deleted)
-6 - No storage configuration was configured.
-7 - The storage attachments path input parameter was given an invalid value, it must be a valid, absolute path.
-8 - The storage attachments path input parameter refers to a file that does not exist, or a folder instead of a file.

Database connector

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

The Database connector provides the following input options to establish a database connection. The command executed by the Database connector has no limit to the wait time; no timeout will occur.

note

If you plan to use the Database connector, verify that your ODBC driver version is compatible with your SQL Server edition.

Input options
Connection stringThe ODBC connection string that includes the source database name, and other parameters needed to establish the initial connection, for example:
- SQL Server standard: Driver={SQL Server}; Server=myServerAddress; Database=myDataBase; User Id=myUsername; Password=myPassword;
- SQL Server Trusted: Driver={SQL Server}; Server=myServerAddress; Database=myDataBase; Trusted_Connection=True;
- DB2 standard: Driver={iSeries Access ODBC Driver}; System=myServerAddress; DefaultLibraries=myDataBase; UserId=myUsername; Password=myPassword; CommitMode=2; QueryTimeout=0;
- DB2 DSN: Dsn=myDsnName;Uid=myUsername;Pwd=myPassword
SQLThe SQL statement executed by this process action.
Parameters (JSON)Optional. A JSON-formatted list of parameters. See example below.
ParametersOptional. A comma-separated list of process flow variables to be used as parameters, for example:
customer_id,sales_order_id

The command parameter name and datatype will be based on the process variable.
Input parametersOptional. Use in conjunction with Parameters. A comma-separated list of parameters marked to be input for the command(s), for example: customer_id

The value will automatically be mapped from the process variable.
Output parametersOptional. Use in conjunction with Parameters. A comma-separated list of parameters marked to be output in the command(s), for example: sales_order_id

Note: the output value will not automatically be mapped back to the process variable.
Command delimiter (regex)Optional. A C# regular expression used to instruct the connector to execute multiple sequential commands on the same connection.
The SQL value will be split into multiple commands using this regular expression.
Continue on errorOptional. Use in conjunction with Command delimiter (regex). If an error occurs during command execution, the next command can be executed or the execution can be halted based on this setting.
Yes continue_on_error_yes
No (default) continue_on_error_no
Start from indexWhen multiple statements are specified with a delimiter, Indicium will start with the one indicated by the Start from index parameter, ignoring all the statements before that.

SQL statement in database connector

The SQL statement in a database connector uses placeholders for each input parameter. These placeholders are single question marks without quotes. ODBC does not use named parameters.

For example:

select total_amount from sales_order where customer_id = ? and sales_order_id = ?

Or:

exec generate_sales_order ?,?
caution

The input parameters must be specified in the exact order in which they appear in the SQL statement.

If you want to return a value, you can do it in two ways:

  • Explicitly select the value. In the select statement above, this is total_amount. The selected value is returned in the result set.

  • Use question mark placeholders for parameters. The exec statement above contains two placeholders. The database connector then retrieves these values and returns them as Output parameter values, which you can reference and use in a process procedure.

To use a process procedure, select the Use process procedure checkbox in menu Process flows > Form > Performance.

use process procedureUse process procedure checkbox

Parameters (JSON) example

[
{
"Name": "customer_id",
"Value": "test",
"Type": "VarChar",
"Size": 100
},
{
"Name": "sales_order_id",
"Value": 0,
"Type": "Int",
"Output": true
}
]

Command delimiter (regex) example

;[^;]*(?:\z|--go\r\n|--go\n|--GO\r\n|--GO\n)

This example regular expression will split the commands using a semicolon followed by --GO in various casings. This is the command delimiting style used by the Software Factory for generated DB2 code.

Output options
Status codeThe status code of the executed action.
0 - Successful
-1 - Unsuccessful (unknown)
-2 - Unsuccessful (empty connection string)
-3 - Unsuccessful (no command text)
-4 - Unsuccessful (invalid parameter JSON structure)
-5 - Unsuccessful (cannot combine JSON parameters with mapped process variable parameters)
-6 - Unsuccessful (input or output parameter was not found as mapped process variable parameter)
-7 - Unsuccessful (mapped process variable parameter was not set as input or output)
-8 - Unsuccessful (mapped process variable parameter was not found as process variable)
-9 - Unsuccessful (could not parse command delimiter regex)
ResultA JSON-formatted list containing the result set(s) of the executed command, for example:
[{"result":[{"customer_id":1,"sales_order_id":14},{"customer_id":2,"sales_order_id":15}]}]

When using a Command delimiter: A JSON-formatted list of executed commands with corresponding results.

Use the OPENJSON and JSON_VALUE SQL functions to select from the JSON result, for example:
`select json_value(value, '$.customer_id'), json_value(value, '$.sales_order_id') from openjson(@result, '$[0].result')
Output parametersA JSON-formatted list of the output parameter values of the executed command, for example:
[{"Name":"sales_order_id","Value":16}]

When using a Command delimiter: A JSON-formatted nested list of executed commands with corresponding output parameters and output parameter values.
SQL info messageA JSON-formatted list of info messages thrown by the executed command.
When using a Command delimiter: A JSON-formatted nested list of executed commands with corresponding info messages.
SQL error messageError message thrown when opening the connection or by the executed command.
When using a Command delimiter: A JSON-formatted list of executed commands with corresponding error message.
SQL error codeError code thrown when opening the connection or by the executed command.
When using a Command delimiter: A JSON-formatted list of executed commands with corresponding error code.

Convert JSON to XML/convert XML to JSON

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

The conversion between JSON and XML can be done with this connector. SQL Server offers built-in support for JSON starting with version 2016.

Input options
Convert inputThe input value that needs to be converted.
Output options
Status codeThe status code of the executed action.
0 - Successful
-4 - Unsuccessful (no input)
Convert outputThe converted output value.

OAuth connectors

Windows GUI

OAuth is an open-standard authorization protocol or framework that describes how unrelated servers and services can safely allow authenticated access to their assets without actually sharing the initial, related, single logon credential. This is also known as secure, third-party, user-agent, delegated authorization.

In a process flow, two process actions (connectors) are available for OAuth. They can be used, for example, to leverage the Microsoft Graph API (Azure, Office 365, Microsoft 365) on behalf of a user instead of a service account.

Both connectors need a connection to an OAuth server:

OAuth server for Oauth connector OAuth server selected for an OAuth connector

  • To configure a server: menu Projects > Project overview > tab Project versions > tab OAuth server.

    Oauth server configuration

  • To override this server for development or testing purposes: menu Deployment > Runtime configuration > tab OAuth servers.

  • To override this server in IAM: menu Authorization > Applications > tab OAuth server configurations.

OAuth login connector

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

In a process flow, you can use the process action OAuth login connector to retrieve an OAuth 2.0 authorization code, by redirecting a user to an external identity platform.

See also Connect the OAuth login connector to Azure.

Input options
ScopeIf a parameter is entered here, it will override the OAuth server settings.
UsePromptOptional.
- Default: True = always consent necessary by user.
- False = no consent asked. If the user has not been authorized before, an error may occur.
Configuration optionsWhere to apply
OAuthRedirectURIApplication setting IAMUse this extended property to change the standard OAuth connector redirect URI (http://localhost/oauth-callback). Use it, for example, to change HTTP to HTTPS.
Output options
Access tokenThe access token string as issued by the authorization server.
Granted scopesIf the scope the user granted is identical to the scope the app requested, this parameter is optional. If the granted scope is different from the requested scope, such as if the user modified the scope, then this parameter is required.
Expires inRecommended. This parameter contains the duration of time the access token is granted for.
Refresh tokenOptional. If the access token will expire, then it is useful to return a refresh token which applications can use to obtain another access token. However, to obtain a refresh token offline access needs to be enabled in the configuration.
Token typeAt this moment, only bearer is supported.
OAuth login connector status codes
0 - Successful.
-1 Unsuccessful, cause unknown.
-2 Unsuccessful, aborted. The user has aborted the login screen.
-3 Unsuccessful, connection error with the OAuth server.
-5 Unsuccessful, unsupported token type. The token response is not a bearer token.

Connect OAuth login connector to Azure

To connect the OAuth login connector to your Azure environment:

  1. In the Azure portal, search for Azure Active Directory and open this service.

    Open Azure Active Directory Open Azure Active Directory

  2. In the menu at the left, open the menu item App registrations.

  3. Press New registration.

    New registration

  4. Register your application.

    • The standard redirect URI for the Windows GUI and Web GUI is Web and http://localhost/oauth-callback.
    • To change the standard, use the OAuthRedirectURI extended property in IAM.

    Register your application Register your application

  5. Press Register.

  6. In your new application, at the Client credentials, select Add a certificate or secret.

    Add certificate or secret Add certificate or secret

  7. Add a New client secret and copy its Value.

    New client secret New client secret

    After refreshing this page, the value is hidden:

    Client secret hidden Client secret after page refresh

    The Application (client) ID is now displayed under Essentials:

    Application client ID Application client ID (fully visible in your Azure portal)

  8. Press Endpoints for an overview of all the token and authorization endpoints. The Thinkwise Platform uses:

    • OAuth 2.0 authorization endpoint (v2).
    • OAuth 2.0 token endpoint (v2).

    Azure endpoints

  9. In the Software Factory, navigate to the menu Projects > Project overview > tab Project versions > tab OAuth servers.

  10. Add Scope User.Read (Microsoft Graph).

    Scope for Oauth server Scope for Oauth server for Azure

    In the Developer ribbon, you can view the result in the Process flow monitor, after executing the Oauth connector process step:

    Process flow monitor Result after executing OAuth connector

Oauth refresh token connector

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

In a process flow, the process action OAuth refresh token connector can request a new access token for OAuth if the old one is expired. This connector uses a refresh call, which removes the need for user interaction with the OAuth server every time the access token expires.

Input options
Refresh tokenThe refresh token, received by the OAuth login connector.
Output options
Access tokenThe new access token string, issued by the OAuth server.
Granted scopesThe scopes returned by the OAuth Server. If the granted scope is identical to the scope the app requested, this parameter is optional. If the granted scope differs from the requested scope, eg, if the user modified the scope, then this parameter is mandatory.
Expires inRecommended. The lifetime of the new access token in seconds.
Refresh tokenOptional. If the OAuth server allows the refresh token to be used only once, a new refresh token is obtained for the next time the OAuth refresh token refreshes the access token.
Token typeAt the moment, only bearer is supported.
OAuth refresh token status codes
0 - Successful.
-1 Unsuccessful, cause unknown.
-2 Unsuccessful, no OAuth server configured.
-3 Unsuccessful, input data is missing.

File and folder connectors

caution

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

Write file

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

This connector allows you to write files to a storage location. It is mandatory to select the target storage location.

Input parameters
Target file nameName that should be applied to the file.
EncodingDetermine whether encoding should be applied to the file (ANSI Latin 1, US-ASCII, UTF-16, UTF-32, UTF-8)
Write preambleYes 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 dataBinary string that contains the file data.
Write modeDetermine the write mode:
- New file (default) - The file does not yet exist at the specified location.
- Overwrite file - If a file already exists at the specified location, this will be overwritten.
Output parameters
Target file pathAbsolute path to the file that has been created.
Status code0 - 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 GUIStarting point Win/Web GUIStarting point system flow (Indicium)System flow action
--++

This connector allows copying files within a storage location. It is mandatory to select a storage location.

note

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 nameRelative path to the file storage location.
Output parameters
Target file pathAbsolute path to the location the file has been copied to.
Status code0 - 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 GUIStarting point Win/Web GUIStarting point system flow (Indicium)System flow action
--++

This connector allows you to read files from a storage location. It is mandatory to select the target storage location.

Input parameters
Source file (pointer)Absolute path to the file that has to be read.
EncodingSelect whether encoding should be applied to the file that is made readable.
Output parameters
File dataBinary string that contains the file data.
Status code0 - 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 GUIStarting point Win/Web GUIStarting point system flow (Indicium)System flow action
--++

This connector allows moving files within a storage location. It is mandatory to select a storage location.

Input parameters
Source file (pointer)Absolute path to the file that has to be moved.
Target file nameRelative path to the file storage location.
Output parameters
Status code0 - 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)
Starting point Universal GUIStarting point Win/Web GUIStarting 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.

PDF files can only be printed on a Windows platform, and the printer must be installed on the web server.

Input parameters
File nameName of the PDF file that has to be printed.
File dataBinary string that contains the PDF file data.
Number of copiesThe number of times the PDF file should be printed.
Output parameters
Status code0 - 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 GUIStarting point Win/Web GUIStarting point system flow (Indicium)System flow action
--++

This connector allows you to delete files from a storage location. It is mandatory to select the storage location.

Input parameters
Source file (pointer)Absolute path to the file that has to be deleted.
Output parameters
Status code0 - 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 GUIStarting point Win/Web GUIStarting point system flow (Indicium)System flow action
--++
Input parameters
Source folder (pointer)Relative path to the folder that has to be created.
Output parameters
Status code0 - 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 GUIStarting point Win/Web GUIStarting 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 target storage location.

Input parameters
Source folder (pointer)Absolute path to the folder that is requested or has to be displayed.
RecursiveYes 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 code0 - 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 GUIStarting point Win/Web GUIStarting point system flow (Indicium)System flow action
--++

This connector allows you to copy folders within a storage location. It is mandatory to select a storage location.

note

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.
Target folder nameRelative path to the file storage location.
Existing file strategyThe 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 code0 - 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 GUIStarting point Win/Web GUIStarting 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 target storage location.

Input parameters
Source folder (pointer)Absolute path to the folder that has to be moved.
Target folder nameRelative path to the file storage location.
Output parameters
Status code0 - 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 GUIStarting point Win/Web GUIStarting point system flow (Indicium)System flow action
--++

This connector allows you to delete folders from a storage location. It is mandatory to select the storage location.

Input parameters
Source folder (pointer)Absolute path to the folder that has to be deleted.
Delete all directory contentsYes or no. Indicates whether this connector should delete sub-folders and files within the specified path.
Output parameters
Status code0 - 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)

Generate report

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

With this process action, you can generate reports via system flows and use the returned report data in, for example, a Write file connector. The process action will not use any default or layout procedures attached to the report.

Output parameters
Status codeThe status code of the executed action.
0 - Successful
-1 - Unsuccessful (unknown)
-2 - Unsuccessful (no report context)
-3 - Unsuccessful (mandatory parameter empty)
-4 - Unsuccessful (export path contains invalid character)
File nameFor example, text.rpt.
Report dataA binary string that can be used for storage in the database or to write a report to file with a Write file connector.

See also:

AutoML connectors

Run AutoML model

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

A trained AutoML model can be used in process flows to perform predictions. Before creating this process action, one of the trained AutoML models must be activated. More information about training AutoML models can be found here.

note

Note: At the moment, this process action is exclusive to scheduled process flows. In the future, this process action will become available to user-initated flows.

Input options
[PREDICTOR]The value of a predictor, used as input for the trained AutoML model
Output options
[TARGET]The predicted value of the target
Status codeThe status code of the executed action.
0 - Successful
-1 - Unsuccessful (unknown)
-2 - Unsuccessful (the AutoML service is not running)
-3 - Unsuccessful (All predictors are empty)
-4 - Unsuccessful (The trained model could not be found)
-100 - Unsuccessful (Indicium is not used by the client executing the process flow)

Train classification/regression model

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

AutoML training options

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

Non-file storage connectors

caution

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.

caution

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 GUIStarting point Win/Web GUIStarting 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 locationThe path to the file that must be read. The path must be an absolute local path or a UNC path.
Output options
Status codeThe 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 dataThe byte-representation of the file.

Write disk file (non-file storage)

Starting point Universal GUIStarting point Win/Web GUIStarting 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 locationThe 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 dataThe binary data (bytes) of the file.
Write modeThe mode that determines how certain situations must be dealt with:
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 subdirectoriesIndicates 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.
EncodingIndicates 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 codeThe 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

caution

As of Thinkwise Platform version 2022.2, this solution is deprecated. Use the [Write file] connector instead.

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.

Extended file storage Example of a file storage process flow

  1. In the Write File connector process action, use this process variable for the File location input parameter.
  2. 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 GUIStarting point Win/Web GUIStarting 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 locationThe path to the file that has to be moved. This path has to be an absolute local path or a UNC path.
To file locationThe 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 subdirectoriesIndicates 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 codeThe 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 GUIStarting point Win/Web GUIStarting 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 locationThe path to the file that has to be moved. This path has to be an absolute local path or a UNC path.
To file locationThe 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 directoryIndicates 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 codeThe 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 GUIStarting point Win/Web GUIStarting 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 locationThe 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 codeThe 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 GUIStarting point Win/Web GUIStarting 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 locationThe path to the folder that has to be created. This path has to be an absolute local path or a UNC path.
Create all subdirectoriesIndicates 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 codeThe 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 GUIStarting point Win/Web GUIStarting 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 locationThe path to the folder that has to be moved. This path has to be an absolute local path or a UNC path.
To folder locationThe 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 directoryIndicates 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 codeThe 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 GUIStarting point Win/Web GUIStarting 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 locationThe path to the folder that has to be moved. This path has to be an absolute local path or a UNC path.
To folder locationThe 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 directoryIndicates 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 strategyDetermines 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 codeThe 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 GUIStarting point Win/Web GUIStarting 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 locationThe 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 contentsIndicates 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 codeThe 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 GUIStarting point Win/Web GUIStarting 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
URLThe complete URL that will be used for the request.
FTP methodThe 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 nameOptional. In the case of a RenameFile action, this input option can be used to provide the new name for the file.
File dataOptional. The content that will be sent with the request, for example, with an UploadFile action.
Use SSLOptional. Indicates whether SSL has to be used for the request.
Possible values:
Yes smtp_ssl_on
No (default) smtp_ssl_off
Authentication typeOptional. The authentication type that will be used for the request.
None (default) - No authentication
Basic - Basic authentication
UsernameOptional. The user name that will be used for the authentication, if applicable.
PasswordOptional. The password that will be used for the authentication, if applicable.
TimeoutOptional. An integer that indicates the timeout of the request in milliseconds. Default is endless.
Use passive modeOptional.
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 codeThe status code of the executed action.
0 - Successful
-1 - Unsuccessful (unknown)
-2 - Unsuccessful (invalid URL)
-3 - Unsuccessful (invalid FTP method)
FTP status codeThe FTP status code of the response. For example 2xx, 4xx, 5xx, etc.
Status descriptionA description of the response status.
Last modifiedThe date and time at which the file on the server was last modified.
File data lengthThe length of the content of the response.
File dataThe content of the response.