Skip to content

Create a connection

If your Job require access to a file, database, URL, SMTP server or FTP Server, you first need to create a connection. The connection configuration is available for all Jobs.

All connections need to be set in connections array of objects and all contains 2 mandatory keys that are id and type, both string and doesn't have use of variables.

A third key name is optional.

The type key is the type of the connection.

The keys encoding and encoding_var are use to set the encoding of the connections type csv, json, xml, ragged-right and fixed-width. See encoding list supported: Encodings. If not set, default is UTF-8.

Note

You can use keys needed only. If for example the path of a file is a variable (path_var key) then isn't neccesary to use the path key.

Valid type values

Connection to CSV file

Keys:

  • path: the path of file. String.
  • path_var: key to set a variable with the path. String.
  • delimiter: delimiter of csv file. String.
  • delimiter_var: key to set a variable with the delimiter. String.
  • delimiter: delimiter of csv file. String. Default ,.
  • delimiter_var: key to set a variable with the delimiter. String.
  • enclosure: enclosure of csv file. String. Default ".
  • enclosure_var: key to set a variable with the enclosure. String.
  • encoding: encoding of file. String. Default is UTF-8 if not is specified.
  • encoding_var: key to set a variable with the encoding. String.

Examples:

[[connections]]
id = 'csv-conn1'
type = 'csv'
name = 'CSV CONNECTION'
path = 'test/in_files/testtypes.csv'
delimiter = ','
path_var = ''
delimiter_var = ''
enclosure = '"'
enclosure_var = ''
encoding = 'UTF-8'
encoding_var = ''

connections:
  - id: csv-conn1
    type: csv
    name: CSV CONNECTION
    path: test/in_files/testtypes.csv
    delimiter: ','
    path_var: ''
    delimiter_var: ''
    enclosure: '"'
    enclosure_var: ''
    encoding: 'UTF-8'
    encoding_var: ''

"connections": [
    {
      "id": "csv-conn1",
      "type": "csv",
      "name": "CSV CONNECTION",
      "path": "test/in_files/testtypes.csv",
      "delimiter": ",",
      "path_var": "",
      "delimiter_var": "",
      "enclosure": "\"",
      "enclosure_var": "",
      "encoding": "UTF-8",
      "encoding_var": ""
    }
  ]

Note

In these examples the keys path_var, delimiter_var, encoding_var and enclosure_var can be omitted because are empty.

Connection to MYSQL database

Keys:

  • host: ip or name of the MySQL server. String
  • host_var: key to set a variable with the host. String.
  • database: database to connect in MySQL server. String
  • database_var: key to set a variable with the database. String.
  • port: port to connect to the database in MySQL server. Integer. Default 3306.
  • port_var: key to set a variable with the port. String.
  • username: username to connect to the database in MySQL server. String
  • username_var: key to set a variable with the username. String.
  • username_encrypted: username encrypted to connect to the database in MySQL server. String
  • username_encrypted_var: key to set a variable with the username encrypted. String
  • password: password to connect to the database in MySQL server. String
  • password_var: key to set a variable with the password. String.
  • password_encrypted: password id saved with the password to connect to the database in MySQL server. String
  • password_encrypted_var: key to set a variable with the password_encrypted. String.

Examples:

[[connections]]
id = 'mysql-conn1'
type = 'mysql'
name = 'MYSQL Connection'
host = 'localhost'
username = 'root'
password = 'pass'
username_encrypted = ''
    password_encrypted = ''
database = 'test'
port = 3306
host_var = ''
username_var = ''
password_var = ''
database_var = ''
port_var = 'mysqlport'
username_encrypted_var = ''
password_encrypted_var = ''

connections:
  - id: mysql-conn1
    type: mysql
    name: MYSQL Connection
    host: localhost
    username: root
    password: pass
    username_encrypted: ''
    password_encrypted: ''
    database: test
    port: 3306
    host_var: ''
    username_var: ''
    password_var: ''
    database_var: ''
    port_var: mysqlport
    username_encrypted_var: ''
    password_encrypted_var: ''

"connections": [
    {
      "id": "mysql-conn1",
      "type": "mysql",
      "name": "MYSQL Connection",
      "host": "localhost",
      "username": "root",
      "password": "pass",
      "username_encrypted": "",
      "password_encrypted": "",
      "database": "test",
      "port": 3306,
      "host_var": "",
      "username_var": "",
      "password_var": "",
      "database_var": "",
      "port_var": "mysqlport",
      "username_encrypted_var": "",
      "password_encrypted_var": "",
    }
  ]

Note

In these examples the keys host_var, username_var, password_var, password_encrypted, username_encrypted, username_encrypted_var, password_encrypted_var and database_var can be omitted because are empty.

Also port can be omitted because key port_var is set with a variable (should be int).

Connection to MSSQL database

To connect to Microsoft SQL Database you need have TCP enabled. Open your SQL Server Configuration (Windows only) and allow TCP connections

Keys:

  • host: ip or name of the MSSQL server. String
  • host_var: key to set a variable with the host. String.
  • database: database to connect in MSSQL server. String
  • database_var: key to set a variable with the database. String.
  • port: port to connect to the database in MSSQL server. Integer. Default 1433.
  • port_var: key to set a variable with the port. String.
  • windows_auth: set true if you want to connect to the database in MSSQL server using Windows Authentication (only supported in Windows). Bool
  • windows_auth_var: key to set a variable with the windows_auth boolean value. String.
  • username: username to connect to the database in MSSQL server. String
  • username_var: key to set a variable with the username. String.
  • password: password to connect to the database in MSSQL server. String
  • password_var: key to set a variable with the password. String.
  • password_encrypted: password id saved with the password to connect to the database in MSSQL server. String
  • password_encrypted_var: key to set a variable with the password_encrypted. String.

Examples:

[[connections]]
id = 'mssql-conn1'
type = 'mssql'
name = 'mssql Connection'
host = 'localhost/instance'
windows_auth = true
username = 'test'
password = 'pass'
username_encrypted = ''
password_encrypted = ''
database = 'testdb'
port = 1433
host_var = ''
username_var = ''
password_var = ''
database_var = ''
port_var = 'mssqlport'
username_encrypted_var = ''
password_encrypted_var = ''
windows_auth_var = ''

connections:
  - id: mssql-conn1
    type: mssql
    name: mssql Connection
    host: localhost/instance
    windows_auth: true
    username: test
    password: pass
    username_encrypted: ''
    password_encrypted: ''
    database: testdb
    port: 1433
    host_var: ''
    username_var: ''
    password_var: ''
    database_var: ''
    port_var: mssqlport
    username_encrypted_var: ''
    password_encrypted_var: ''
    windows_auth_var: ''

"connections": [
    {
      "id": "mssql-conn1",
      "type": "mssql",
      "name": "mssql Connection",
      "host": "localhost/instance",
      "windows_auth": true,
      "username": "test",
      "password": "pass",
      "username_encrypted": "",
      "password_encrypted": "",
      "database": "testdb",
      "port": 1433,
      "host_var": "",
      "username_var": "",
      "password_var": "",
      "database_var": "",
      "port_var": "mssqlport",
      "username_encrypted_var": "",
      "password_encrypted_var": "",
      "windows_auth_var": ""
    }
  ]

Note

In these examples the keys host_var, username_var, password_var, password_encrypted, password_encrypted_var, windows_auth_var and database_var can be omitted because are empty.

Also the key port can be omitted because key port_var is set with a variable (should be int).

Also the keys username and password can be omitted because key windows_auth is set to true.

Connection to JSON file

The JSON input should have an array key with objects to obtain the values, an example input is:

{
   "conversation":[
      {
         "Name":"Ed",
         "Text":"Knock knock."
      },
      {
         "Name":"Sam",
         "Text":"Who's there?"
      },
      {
         "Name":"Ed",
         "Text":"Go fmt."
      },
      {
         "Name":"Sam",
         "Text":"Go fmt who?"
      },
      {
         "Name":"Ed",
         "Text":"Go fmt yourself!"
      }
   ]
}

Note

Doesn't matter how big if the JSON file, you can specify it in the connection.

If connection is used for JSON output, then the JSON will have the same structure.

Keys:

  • path: the path of file. String.
  • path_var: key to set a variable with the path. String.
  • data_var: variable with json fixed content to load instead using the key path.
  • array_key: json array key for get the data. String.
  • array_key_var: key to set a variable with the json array key. String.
  • encoding: encoding of file. String. Default is UTF-8 if not is specified.
  • encoding_var: key to set a variable with the encoding. String.

Examples:

[[connections]]
id = 'json-conn1'
type = 'json'
name = 'JSON CONNECTION'
path = 'test/out_files/test.json'
array_key = 'list'
path_var = ''
array_key_var = ''
encoding = 'UTF-8'
encoding_var = ''

connections:
  - id: json-conn1
    type: json
    name: JSON CONNECTION
    path: test/out_files/test.json
    array_key: list
    path_var: ''
    array_key_var: ''
    encoding: 'UTF-8'
    encoding_var: ''

"connections": [
    {
      "id": "json-conn1",
      "type": "json",
      "name": "JSON CONNECTION",
      "path": "test/out_files/test.json",
      "array_key": "list",
      "path_var": "",
      "array_key_var": "",
      "encoding": "UTF-8",
      "encoding_var": ""
    }
  ]

Note

In these examples the keys encoding_var, path_var and array_key_var can be omitted because are empty.

Connection to XML file

The XML input should have an row name with objects to obtain the values, an example input is:

<?xml version="1.0" encoding="UTF-8"?>
<bookstore>
   <book>
      <title>The Iliad and The Odyssey</title>
      <price>12.95</price>
      <comments>
         <userComment rating="4">Best translation I've read.</userComment>
         <userComment rating="2">I like other versions better.</userComment>
      </comments>
   </book>
   <book>
      <title>Anthology of World Literature</title>
      <price>24.95</price>
      <comments>
         <userComment rating="3">Needs more modern literature.</userComment>
         <userComment rating="4">Excellent overview of world literature.</userComment>
      </comments>
   </book>
   <journal>
      <title>Journal of XML parsing</title>
      <issue>1</issue>
   </journal>
</bookstore>

Note

Doesn't matter how many row names have the input XML, you can specify it in the connection.

If connection is used for XML output, then the JSON will have the this structure:

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <book>
        <columntest>4</columntest>
    </book>
    <book>
        <columntest>27</columntest>
    </book>
    <book>
        <columntest>21</columntest>
    </book>
    <book>
        <columntest>27</columntest>
    </book>
</root>
The root name of XML output can be set in connection, the row name in this output example is book.

Keys:

  • path: the path of file. String.
  • path_var: key to set a variable with the path. String.
  • data_var: variable with xml fixed content to load instead using the key path.
  • row_name: xml row name key to get the data. String.
  • row_name_var: key to set a variable with the xml row name key. String.
  • root_name: xml name of root for output only. String.
  • root_name_var: key to set a variable with the xml name of root. String.
  • encoding: encoding of file. String. Default is UTF-8 if not is specified.
  • encoding_var: key to set a variable with the encoding. String.

Examples:

[[connections]]
id = 'xml-conn1'
type = 'xml'
name = 'XML CONNECTION'
path = 'test/in_files/test.xml'
path_var = ''
root_name = 'root'
row_name = 'book'
root_name_var = ''
row_name_var = ''
encoding = 'UTF-8'
encoding_var = ''

connections:
  - id: xml-conn1
    type: xml
    name: XML CONNECTION
    path: test/in_files/test.xml
    path_var: ''
    root_name: root
    row_name: book
    root_name_var: ''
    row_name_var: ''
    encoding: 'UTF-8'
    encoding_var: ''

  "connections": [
    {
      "id": "xml-conn1",
      "type": "xml",
      "name": "XML CONNECTION",
      "path": "test/in_files/test.xml",
      "path_var": "",
      "root_name": "root",
      "row_name": "book",
      "root_name_var": "",
      "row_name_var": "",
      "encoding": "UTF-8",
      "encoding_var": ""
    }
  ]

Note

In these examples the keys path_var, row_name_var, encoding_var and root_name_var can be omitted because are empty.

Connection to PostgreSQL database

Keys:

  • host: ip or name of the PostgreSQL server. String
  • host_var: key to set a variable with the host. String.
  • database: database to connect in PostgreSQL server. String
  • database_var: key to set a variable with the database. String.
  • port: port to connect to the database in PostgreSQL server. Integer. Default 5432.
  • port_var: key to set a variable with the port. String.
  • username: username to connect to the database in PostgreSQL server. String
  • username_var: key to set a variable with the username. String.
  • password: password to connect to the database in PostgreSQL server. String
  • password_var: key to set a variable with the password. String.
  • password_encrypted: password id saved with the password to connect to the database in PostgreSQL server. String
  • password_encrypted_var: key to set a variable with the password_encrypted. String.

Examples:

[[connections]]
id = 'pgsql-conn1'
type = 'pgsql'
name = 'pgsql Connection'
host = 'localhost'
username = 'test'
password = 'pass'
username_encrypted = ''
password_encrypted = ''
database = 'testdb'
port = 5432
host_var = ''
username_var = ''
password_var = ''
database_var = ''
port_var = ''
username_encrypted_var = ''
password_encrypted_var = ''

connections:
  - id: pgsql-conn1
    type: pgsql
    name: pgsql Connection
    host: localhost
    username: test
    password: pass
    username_encrypted: ''
    password_encrypted: ''
    database: testdb
    port: 5432
    host_var: ''
    username_var: ''
    password_var: ''
    database_var: ''
    port_var: ''
    username_encrypted_var: ''
    password_encrypted_var: ''

"connections": [
    {
      "id": "pgsql-conn1",
      "type": "pgsql",
      "name": "pgsql Connection",
      "host": "localhost",
      "username": "test",
      "password": "pass",
      "username_encrypted": "",
      "password_encrypted": "",
      "database": "testdb",
      "port": 5432,
      "host_var": "",
      "username_var": "",
      "password_var": "",
      "database_var": "",
      "port_var": "",
      "username_encrypted_var": "",
      "password_encrypted_var": ""
    }
  ]

Note

In these examples the keys port_var, host_var, username_var, password_var, password_encrypted, username_encrypted, username_encrypted_var, password_encrypted_var and database_var can be omitted because are empty.

Connection to XLSX file

Keys:

  • path: the path of file. String.
  • path_var: key to set a variable with the path. String.
  • sheet_name: name of sheet. String.
  • sheet_name_var: key to set a variable with the name of sheet. String.
  • password: password to read or save XLSX file. String
  • password_var: key to set a variable with the password. String.
  • password_encrypted: password id saved with the password to read XLSX file. String
  • password_encrypted_var: key to set a variable with the password_encrypted. String.

Examples:

[[connections]]
id = 'xlsx-conn1'
type = 'xlsx'
name = 'XLSX CONNECTION'
path = 'test/out_files/test.xlsx'
sheet_name = 'sheet12345'
path_var = ''
sheet_name_var = ''

connections:
  - id: xlsx-conn1
    type: xlsx
    name: XLSX CONNECTION
    path: test/out_files/test.xlsx
    sheet_name: sheet12345
    path_var: ''
    sheet_name_var: ''

"connections": [
    {
      "id": "xlsx-conn1",
      "type": "xlsx",
      "name": "XLSX CONNECTION",
      "path": "test/out_files/test.xlsx",
      "sheet_name": "sheet12345",
      "path_var": "",
      "sheet_name_var": ""
    }
  ]

Note

In these examples the keys path_var and sheet_name_var can be omitted because are empty.

Connection to Firebird SQL database

Keys:

  • host: ip or name of the Firebird SQL server. String
  • host_var: key to set a variable with the host. String.
  • database: path of database to connect in Firebird SQL server. String
  • database_var: key to set a variable with the path of database. String.
  • port: port to connect to the database in Firebird SQL server. Integer. Default 3050.
  • port_var: key to set a variable with the port. String.
  • encoding: encoding of database. String. Default is UTF-8 if not is specified.
  • encoding_var: key to set a variable with the encoding. String.
  • username: username to connect to the database in Firebird SQL server. String
  • username_var: key to set a variable with the username. String.
  • password: password to connect to the database in Firebird SQL server. String
  • password_var: key to set a variable with the password. String.
  • password_encrypted: password id saved with the password to connect to the database in Firebird SQL server. String
  • password_encrypted_var: key to set a variable with the password_encrypted. String.

Examples:

[[connections]]
id = 'firebird-conn1'
type = 'firebird'
name = 'firebird Connection'
host = 'localhost'
username = 'test'
password = 'pass'
username_encrypted = ''
password_encrypted = ''
database = 'C:/db/testdb.fdb'
port = 3050
host_var = ''
username_var = ''
password_var = ''
database_var = ''
port_var = ''
username_encrypted_var = ''
password_encrypted_var = ''

connections:
  - id: firebird-conn1
    type: firebird
    name: firebird Connection
    host: localhost
    username: test
    password: pass
    username_encrypted: ''
    password_encrypted: ''
    database: 'C:/db/testdb.fdb'
    port: 3050
    host_var: ''
    username_var: ''
    password_var: ''
    database_var: ''
    port_var: ''
    username_encrypted_var: ''
    password_encrypted_var: ''

"connections": [
    {
      "id": "firebird-conn1",
      "type": "firebird",
      "name": "firebird Connection",
      "host": "localhost",
      "username": "test",
      "password": "pass",
      "username_encrypted": "",
      "password_encrypted": "",
      "database": "C:/db/testdb.fdb",
      "port": 3050,
      "host_var": "",
      "username_var": "",
      "password_var": "",
      "database_var": "",
      "port_var": "",
      "username_encrypted_var": "",
      "password_encrypted_var": ""
    }
  ]

Note

In these examples the keys port_var, host_var, username_var, password_var, password_encrypted, username_encrypted, username_encrypted_var, password_encrypted_var and database_var can be omitted because are empty.

Connection to SQLite3 database

Keys:

  • database: path of SQLite3 database. String
  • database_var: key to set a variable with the path of SQLite3 database. String.
  • journal_mode: path of SQLite3 journal_mode. Allowed DELETE, TRUNCATE, WAL, MEMORY, PERSIST. Default DELETE. String
  • journal_mode_var: key to set a variable with the path of SQLite3 journal_mode. String.

Examples:

[[connections]]
id = 'sqlite3-conn1'
type = 'sqlite3'
name = 'sqlite3 Connection'
database = 'C:/db/testdb.db'
database_var = ''

connections:
  - id: sqlite3-conn1
    type: sqlite3
    name: sqlite3 Connection
    database: 'C:/db/testdb.db'
    database_var: ''

"connections": [
    {
      "id": "sqlite3-conn1",
      "type": "sqlite3",
      "name": "sqlite3 Connection",
      "database": "C:/db/testdb.db",
      "database_var": ""
    }
  ]

Note

In these examples the keys database_var can be omitted because is empty.

Connection to Oracle database

To connect to Oracle, you need the Oracle Instant Client required in your platform.

Keys:

  • host: ip or name of the Oracle server. String
  • host_var: key to set a variable with the host. String.
  • port: port to connect in Oracle server. Integer. Default 1521.
  • port_var: key to set a variable with the port. String.
  • servicename: service name or SID to connect in Oracle server. String
  • servicename_var: key to set a variable with the service name or SID. String.
  • username: username to connect in Oracle server. String
  • username_var: key to set a variable with the username. String.
  • password: password to connect in Oracle server. String
  • password_var: key to set a variable with the password. String.
  • password_encrypted: password id saved with the password to connect in Oracle server. String
  • password_encrypted_var: key to set a variable with the password_encrypted. String.

Examples:

[[connections]]
id = 'oracle-conn1'
type = 'oracle'
name = 'oracle Connection'
host = 'localhost'
username = 'test'
password = 'pass'
username_encrypted = ''
password_encrypted = ''
servicename = 'XE'
port = 1521
host_var = ''
username_var = ''
password_var = ''
servicename_var = ''
port_var = ''
username_encrypted_var = ''
password_encrypted_var = ''

connections:
  - id: oracle-conn1
    type: oracle
    name: oracle Connection
    host: localhost
    username: test
    password: pass
    username_encrypted: ''
    password_encrypted: ''
    servicename: 'XE'
    port: 1521
    host_var: ''
    username_var: ''
    password_var: ''
    servicename_var: ''
    port_var: ''
    username_encrypted_var: ''
    password_encrypted_var: ''

"connections": [
    {
      "id": "oracle-conn1",
      "type": "oracle",
      "name": "oracle Connection",
      "host": "localhost",
      "username": "test",
      "password": "pass",
      "username_encrypted": "",
      "password_encrypted": "",
      "servicename": "XE",
      "port": 1521,
      "host_var": "",
      "username_var": "",
      "password_var": "",
      "servicename_var": "",
      "port_var": "",
      "username_encrypted_var": "",
      "password_encrypted_var": ""
    }
  ]

Note

In these examples the keys port_var, host_var, username_var, password_var, password_encrypted, username_encrypted, username_encrypted_var, password_encrypted_var and servicename_var can be omitted because are empty.

Connection to IBM DB2 database

To connect to IBM DB2, you need the clidriver for DB2. Use this link or this to download it.

For Windows, set in PATH the bin folder inside clidriver folder: PATH=C:\clidriver\bin

For Linux and macOS:

export DB2HOME=/home/uname/ibmdb/clidriver

To execute:

Linux:
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$DB2HOME/lib
Mac:
export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:$DB2HOME/lib

Keys:

  • host: ip or name of the IBM DB2 server. String
  • host_var: key to set a variable with the host. String.
  • port: port to connect to dababase in IBM DB2 server. Integer. Default 50000.
  • port_var: key to set a variable with the port. String.
  • database: database to connect in IBM DB2 server. String
  • database_var: key to set a variable with the database. String.
  • schema: schema to connect in IBM DB2 server. String
  • schema_var: key to set a variable with the schema. String.
  • username: username to connect in IBM DB2 server. String
  • username_var: key to set a variable with the username. String.
  • password: password to connect in IBM DB2 server. String
  • password_var: key to set a variable with the password. String.
  • password_encrypted: password id saved with the password to connect in IBM DB2 server. String
  • password_encrypted_var: key to set a variable with the password_encrypted. String.

Examples:

[[connections]]
id = 'ibm-db2-conn1'
type = 'ibm-db2'
name = 'ibm-db2 Connection'
host = 'localhost'
username = 'test'
password = 'pass'
username_encrypted = ''
password_encrypted = ''
database = 'SAMPLE'
schema = 'SCHEMATEST'
port = 50000
host_var = ''
username_var = ''
password_var = ''
database_var = ''
port_var = ''
username_encrypted_var = ''
password_encrypted_var = ''
schema_var = ''

connections:
  - id: ibm-db2-conn1
    type: ibm-db2
    name: ibm-db2 Connection
    host: localhost
    username: test
    password: pass
    username_encrypted: ''
    password_encrypted: ''
    database: 'SAMPLE'
    schema: 'SCHEMATEST'
    port: 50000
    host_var: ''
    username_var: ''
    password_var: ''
    database_var: ''
    port_var: ''
    username_encrypted_var: ''
    password_encrypted_var: ''
    schema_var: ''

"connections": [
    {
      "id": "ibm-db2-conn1",
      "type": "ibm-db2",
      "name": "ibm-db2 Connection",
      "host": "localhost",
      "username": "test",
      "password": "pass",
      "username_encrypted": "",
      "password_encrypted": "",
      "database": "SAMPLE",
      "schema": "SCHEMATEST",
      "port": 50000,
      "host_var": "",
      "username_var": "",
      "password_var": "",
      "database_var": "",
      "port_var": "",
      "username_encrypted_var": "",
      "password_encrypted_var": "",
      "schema_var": ""
    }
  ]

Note

In these examples the keys port_var, schema_var, host_var, username_var, password_var, password_encrypted, username_encrypted, username_encrypted_var, password_encrypted_var and database_var can be omitted because are empty.

Connection to Ragged Right file

Keys:

  • path: the path of file. String.
  • path_var: key to set a variable with the path. String.
  • row_delimiter: row delimiter of file. String.
  • row_delimiter_var: key to set a variable with the row delimiter. String.
  • columns_len: length of columns. Integer array.
  • encoding: encoding of file. String. Default is UTF-8 if not is specified.
  • encoding_var: key to set a variable with the encoding. String.

Examples:

[[connections]]
id = 'ragged-conn'
type = 'ragged-right'
name = 'RAGGED RIGHT CONNECTION'
path = 'test/in_files/ragged.txt'
path_var = ''
row_delimiter = 'CRLF'
row_delimiter_var = ''
columns_len = [
    10,
    50,
    12,
]
encoding = 'UTF-8'
encoding_var = ''

connections:
  - id: ragged-conn
    type: ragged-right
    name: RAGGED RIGHT CONNECTION
    path: test/in_files/ragged.txt
    path_var: ''
    row_delimiter: CRLF
    row_delimiter_var: ''
    columns_len:
      - 10
      - 50
      - 12
    encoding: 'UTF-8'
    encoding_var: ''

"connections": [
    {
      "id": "ragged-conn",
      "type": "ragged-right",
      "name": "RAGGED RIGHT CONNECTION",
      "path": "test/in_files/ragged.txt",
      "path_var": "",
      "row_delimiter": "CRLF",
      "row_delimiter_var": "",
      "columns_len": [
        10,
        50,
        12
      ],
      "encoding": "UTF-8",
      "encoding_var": ""
    }
  ]

Note

In these examples the keys encoding_var, path_var and row_delimiter_var can be omitted because are empty.

Connection to Fixed Width file

Keys:

  • path: the path of file. String.
  • path_var: key to set a variable with the path. String.
  • row_delimiter: row delimiter of file. String.
  • row_delimiter_var: key to set a variable with the row delimiter. String.
  • columns_len: length of columns. Integer array.
  • encoding: encoding of file. String. Default is UTF-8 if not is specified.
  • encoding_var: key to set a variable with the encoding. String.

Examples:

[[connections]]
id = 'fixed-conn'
type = 'fixed-width'
name = 'fixed width CONNECTION'
path = 'test/in_files/fixed.txt'
path_var = ''
row_delimiter = 'CRLF'
row_delimiter_var = ''
columns_len = [
    10,
    50,
    12,
]
encoding = 'UTF-8'
encoding_var = ''

connections:
  - id: fixed-conn
    type: fixed-width
    name: fixed width CONNECTION
    path: test/in_files/fixed.txt
    path_var: ''
    row_delimiter: CRLF
    row_delimiter_var: ''
    columns_len:
      - 10
      - 50
      - 12
    encoding: 'UTF-8'
    encoding_var: ''

"connections": [
    {
      "id": "fixed-conn",
      "type": "fixed-width",
      "name": "fixed width CONNECTION",
      "path": "test/in_files/fixed.txt",
      "path_var": "",
      "row_delimiter": "CRLF",
      "row_delimiter_var": "",
      "columns_len": [
        10,
        50,
        12
      ],
      "encoding": "UTF-8",
      "encoding_var": ""
    }
  ]

Note

In these examples the keys encoding_var, path_var and row_delimiter_var can be omitted because are empty.

Connection to FTP server

Keys:

  • host: ip or name of the FTP server. String
  • host_var: key to set a variable with the host. String.
  • port: port to connect to FTP server. Integer
  • port_var: key to set a variable with the port. String.
  • username: username to connect in FTP server. String
  • username_var: key to set a variable with the username. String.
  • password: password to connect in FTP server. String
  • password_var: key to set a variable with the password. String.
  • password_encrypted: password id saved with the password to connect in FTP server. String
  • password_encrypted_var: key to set a variable with the password_encrypted. String.
  • connect_timeout: timeout in seconds for connection attemp to FTP server. Integer
  • connect_timeout_var: key to set a variable with the timeout in seconds for connection attemp to FTP server. String.

Examples:

[[connections]]
id = 'ftp-conn'
type = 'ftp'
name = 'FTP Connection'
host = 'ftp.host.com'
port = 21
username = 'test'
password = 'pass'
username_encrypted = ''
password_encrypted = ''
connect_timeout = 15
host_var = ''
port_var = ''
username_var = ''
password_var = ''
connect_timeout_var = ''
username_encrypted_var = ''
password_encrypted_var = ''

connections:
  - id: ftp-conn
    type: ftp
    name: FTP Connection
    host: ftp.host.com
    port: 21
    username: test
    password: pass
    username_encrypted: ''
    password_encrypted: ''
    connect_timeout: 15
    host_var: ''
    port_var: ''
    username_var: ''
    password_var: ''
    connect_timeout_var: ''
    username_encrypted_var: ''
    password_encrypted_var: ''

"connections": [
    {
      "id": "ftp-conn",
      "type": "ftp",
      "name": "FTP Connection",
      "host": "ftp.host.com",
      "port": 21,
      "username": "test",
      "password": "pass",
      "username_encrypted": "",
      "password_encrypted": "",
      "connect_timeout": 15,
      "host_var": "",
      "port_var": "",
      "username_var": "",
      "password_var": "",
      "connect_timeout_var": "",
      "username_encrypted_var": "",
      "password_encrypted_var": ""
    }
  ]

Note

In these examples the keys connect_timeout_var, host_var, username_var, password_var, password_encrypted, username_encrypted, username_encrypted_var, password_encrypted_var and port_var can be omitted because are empty.

Connection to HTTP URL

You can use this connection with httprequest and soaprequest job types.

Keys:

  • url: url. String
  • url_var: key to set a variable with the url. String.
  • username: username to connect with basic authentication. String
  • username_var: key to set a variable with the username. String.
  • password: password to connect with basic authentication. String
  • password_var: key to set a variable with the password. String.
  • password_encrypted: password id saved with the password to connect with basic authentication. String
  • password_encrypted_var: key to set a variable with the password_encrypted. String.
  • timeout: timeout in seconds for connection to url. Integer
  • timeout_var: key to set a variable with the timeout. String.
  • auth_type: optional. Authentication type of connection. Permitted values: basic, digest, none. String. Default none.
  • auth_type_var: optional. Key to set a variable with the authentication type. String.
  • headers: optional. Object to set headers used in httprequest job type for now. Object.
  • headers_var: optional. Key to set a variable with the headers, the variable shoule be a map type with a json in his value, example value: {"authorization":"Basic dXNlcjpwYXNzd2Q="} . String.

Warning

Digest authentication is not supported for soaprequest.

For soaprequest, if the wsdl file is local, the url should be file:// and the path of wsdl file. Example: file://C:/WSDL_Directory/ipservice.asmx

Examples: 

[[connections]]
id = 'http-conn'
type = 'http'
name = 'http Connection'
url = 'http://wsgeoip.lavasoft.com/ipservice.asmx?WSDL'
username = 'aaaaa'
password = 'bbbbb'
username_encrypted = ''
password_encrypted = ''
timeout = 10
url_var = ''
username_var = ''
password_var = ''
timeout_var = ''
username_encrypted_var = ''
password_encrypted_var = ''

[connections.headers]
authorization = 'Basic dXNlcjpwYXNzd2Q='

connections:
  - id: http-conn
    type: http
    name: http Connection
    url: 'http://wsgeoip.lavasoft.com/ipservice.asmx?WSDL'
    username: aaaaa
    password: bbbbb
    username_encrypted: ''
    password_encrypted: ''
    timeout: 10
    url_var: ''
    username_var: ''
    password_var: ''
    timeout_var: ''
    username_encrypted_var: ''
    password_encrypted_var: ''
    headers:
      authorization: Basic dXNlcjpwYXNzd2Q=

"connections": [
    {
      "id": "http-conn",
      "type": "http",
      "name": "http Connection",
      "url": "http://wsgeoip.lavasoft.com/ipservice.asmx?WSDL",
      "username": "aaaaa",
      "password": "bbbbb",
      "username_encrypted": "",
      "password_encrypted": "",
      "timeout": 10,
      "url_var": "",
      "username_var": "",
      "password_var": "",
      "timeout_var": "",
      "username_encrypted_var": "",
      "password_encrypted_var": "",
      "headers": {
        "authorization": "Basic dXNlcjpwYXNzd2Q="
      }
    }
  ]

Note

In these examples the keys url_var, timeout_var, username_var, password_var, password_encrypted and username_encrypted, username_encrypted_var, password_encrypted_var can be omitted because are empty.

Connection to SMTP server

Keys:

  • host: ip or name of the SMTP server. String
  • host_var: key to set a variable with the host. String.
  • port: port to connect to SMTP server. Integer
  • port_var: key to set a variable with the port. String.
  • username: username to connect to SMTP server. String
  • username_var: key to set a variable with the username. String.
  • password: password to connect to SMTP server. String
  • password_var: key to set a variable with the password. String.
  • password_encrypted: password id saved with the password to connect to SMTP server. String
  • password_encrypted_var: key to set a variable with the password_encrypted. String.
  • connect_timeout: timeout in seconds to connect in SMTP server. Integer
  • connect_timeout_var: key to set a variable with the connect timeout. String.
  • send_timeout: timeout in seconds to send an email through SMTP server. Integer
  • send_timeout_var: key to set a variable with the send timeout. String.
  • encryption_type: encryption type of connection. Permitted values: none, ssl, tls, starttls, otherwise none is used. String
  • encryption_type_var: key to set a variable with the encryption type. String.
  • auth_type: authentication type of connection. Permitted values: plain, login, cram-md5, none, otherwise plain is used. String (none from v1.8.0)
  • auth_type_var: key to set a variable with the authentication type. String.
  • skip_cert_verification: boolean to ignore certificate validation. Boolean.
  • skip_cert_verification_var: key to set a variable with the skip_cert_verification. String.

Examples:

[[connections]]
id = 'smtp-conn'
type = 'smtp'
name = 'SMTP Connection'
host = 'smtp.server.com'
port = 25
username = 'test@example.com'
password = 'pass'
password_encrypted = 'ENCRYPTED PASS'
encryption_type = 'none'
auth_type = 'plain'
connect_timeout = 10
send_timeout = 10
skip_cert_verification = false
host_var = ''
port_var = 'port3'
username_var = 'smtpuser'
password_var = 'smtppass'
username_encrypted_var = ''
password_encrypted_var = ''
encryption_type_var = 'encryption'
auth_type_var = ''
connect_timeout_var = 'connecttimeout'
send_timeout_var = 'sendtimeout'

connections:
  - id: smtp-conn
    type: smtp
    name: SMTP Connection
    host: smtp.server.com
    port: 25
    username: test@example.com
    password: pass
    password_encrypted: ENCRYPTED PASS
    encryption_type: none
    auth_type: plain
    connect_timeout: 10
    send_timeout: 10
    host_var: ''
    port_var: port3
    username_var: smtpuser
    password_var: smtppass
    username_encrypted_var: ''
    password_encrypted_var: ''
    encryption_type_var: encryption
    auth_type_var: ''
    connect_timeout_var: connecttimeout
    send_timeout_var: sendtimeout

"connections": [
    {
      "id": "smtp-conn",
      "type": "smtp",
      "name": "SMTP Connection",
      "host": "smtp.server.com",
      "port": 25,
      "username": "test@example.com",
      "password": "pass",
      "password_encrypted": "ENCRYPTED PASS",
      "encryption_type": "none",
      "auth_type": "plain",
      "connect_timeout": 10,
      "send_timeout": 10,
      "host_var": "",
      "port_var": "smtpport",
      "username_var": "smtpuser",
      "password_var": "smtppass",
      "username_encrypted_var": "",
      "password_encrypted_var": "",
      "encryption_type_var": "encryption",
      "auth_type_var": "",
      "connect_timeout_var": "connecttimeout",
      "send_timeout_var": "sendtimeout"
    }
  ]

Note

In these examples the keys port, username, encryption_type, send_timeout, and connect_timeout can be omitted because keys with suffix _var are set.

Also the keys host_var, username_encrypted, username_encrypted_var, password_encrypted_var and auth_type_var can be omitted because keys are empty.

Also the keys password and password_var can be omitted because key password_encrypted is set.

Connection to SAP HANA database

Keys:

  • host: ip or name of the SAP HANA DB server. String
  • host_var: key to set a variable with the host. String.
  • port: port to connect to dababase in SAP HANA DB server. Integer. Default 39013.
  • port_var: key to set a variable with the port. String.
  • schema: schema to connect in SAP HANA DB server. String
  • schema_var: key to set a variable with the schema. String.
  • username: username to connect in SAP HANA DB server. String
  • username_var: key to set a variable with the username. String.
  • password: password to connect in SAP HANA DB server. String
  • password_var: key to set a variable with the password. String.
  • password_encrypted: password id saved with the password to connect in SAP HANA DB server. String
  • password_encrypted_var: key to set a variable with the password_encrypted. String.

Examples:

[[connections]]
id = 'sap-hdb-conn1'
type = 'sap-hdb'
name = 'sap-hdb Connection'
host = 'localhost'
username = 'test'
password = 'pass'
username_encrypted = ''
password_encrypted = ''
schema = 'SCHEMATEST'
port = 39013
host_var = ''
username_var = ''
password_var = ''
port_var = ''
username_encrypted_var = ''
password_encrypted_var = ''
schema_var = ''

connections:
  - id: sap-hdb-conn1
    type: sap-hdb
    name: sap-hdb Connection
    host: localhost
    username: test
    password: pass
    username_encrypted: ''
    password_encrypted: ''
    schema: 'SCHEMATEST'
    port: 39013
    host_var: ''
    username_var: ''
    password_var: ''
    port_var: ''
    username_encrypted_var: ''
    password_encrypted_var: ''
    schema_var: ''

"connections": [
    {
      "id": "sap-hdb-conn1",
      "type": "sap-hdb",
      "name": "sap-hdb Connection",
      "host": "localhost",
      "username": "test",
      "password": "pass",
      "username_encrypted": "",
      "password_encrypted": "",
      "schema": "SCHEMATEST",
      "port": 39013,
      "host_var": "",
      "username_var": "",
      "password_var": "",
      "port_var": "",
      "username_encrypted_var": "",
      "password_encrypted_var": "",
      "schema_var": ""
    }
  ]

Note

In these examples the keys port_var, schema_var, host_var, username_var, password_var, password_encrypted and username_encrypted, username_encrypted_var, password_encrypted_var can be omitted because are empty.

Connection to HTML Table

Keys:

  • path: the path of file. String.
  • path_var: key to set a variable with the path. String.
  • encoding: encoding of file. String. Default is UTF-8 if not is specified.
  • encoding_var: key to set a variable with the encoding. String.

Examples:

[[connections]]
id = 'html-table-conn1'
type = 'html-table'
name = 'HTML TABLE CONNECTION'
path = 'test/out_files/test.html'
path_var = ''
encoding = 'UTF-8'
encoding_var = ''

connections:
  - id: html-table-conn1
    type: html-table
    name: HTML TABLE CONNECTION
    path: test/out_files/test.html
    path_var: ''
    encoding: 'UTF-8'
    encoding_var: ''

"connections": [
    {
      "id": "html-table-conn1",
      "type": "html-table",
      "name": "HTML TABLE CONNECTION",
      "path": "test/out_files/test.html",
      "path_var": "",
      "encoding": "UTF-8",
      "encoding_var": ""
    }
  ]

Note

In these examples the keys path_var and encoding_var can be omitted because are empty.

Connection to Markdown Table

Keys:

  • path: the path of file. String.
  • path_var: key to set a variable with the path. String.
  • encoding: encoding of file. String. Default is UTF-8 if not is specified.
  • encoding_var: key to set a variable with the encoding. String.

Examples:

[[connections]]
id = 'markdown-table-conn1'
type = 'markdown-table'
name = 'MARKDOWN TABLE CONNECTION'
path = 'test/out_files/test.md'
path_var = ''
encoding = 'UTF-8'
encoding_var = ''

connections:
  - id: markdown-table-conn1
    type: markdown-table
    name: MARKDOWN TABLE CONNECTION
    path: test/out_files/test.md
    path_var: ''
    encoding: 'UTF-8'
    encoding_var: ''

"connections": [
    {
      "id": "markdown-table-conn1",
      "type": "markdown-table",
      "name": "MARKDOWN TABLE CONNECTION",
      "path": "test/out_files/test.md",
      "path_var": "",
      "encoding": "UTF-8",
      "encoding_var": ""
    }
  ]

Note

In these examples the keys path_var and encoding_var can be omitted because are empty.

Connection to AWS

Keys:

  • region: Region to connect to AWS account. String.
  • region_var: key to set a variable with the region. String.
  • access_key_id: The Access Key ID to connect to AWS. String.
  • access_key_id_var: key to set a variable with the access_key_id. String.
  • access_key_id_encrypted: access_key_id encrypted. String.
  • access_key_id_encrypted_var: key to set a variable with the access_key_id_encrypted. String.
  • secret_access_key: Secret Access Key to connect to AWS. String
  • secret_access_key_var: key to set a variable with the secret_access_key. String.
  • secret_access_key_encrypted: secret_access_key encrypted. String
  • secret_access_key_encrypted_var: key to set a variable with the secret_access_key_encrypted. String.

On v1.8.1 and below: - client_cert_file_path: Cert file to connect to AWS if needed. String. - client_cert_file_path_var: key to set a variable with the client_cert_file_path. String. - client_key_file_path: Cert fey file to connect to AWS if needed. String. - client_key_file_path_var: key to set a variable with the client_key_file_path. String.

Note

client_cert_file_path and client_key_file_path, if needed, both need to be set.

Examples:

[[connections]]
id = 'aws-conn'
type = 'aws'
name = 'AWS Connection'
region = 'us-east-2'
access_key_id = 'ACCESSKEYID'
secret_access_key = 'SECRETACCESSKEY'
access_key_id_encrypted = ''
secret_access_key_encrypted = ''
region_var = ''
access_key_id_var = ''
secret_access_key_var = ''
access_key_id_encrypted_var = ''
secret_access_key_encrypted_var = ''

connections:
  - id: aws-conn
    type: aws
    name: AWS Connection
    region: 'us-east-2'
    access_key_id: ACCESSKEYID
    secret_access_key: SECRETACCESSKEY
    access_key_id_encrypted: ''
    secret_access_key_encrypted: ''
    region_var: ''
    access_key_id_var: ''
    secret_access_key_var: ''
    access_key_id_encrypted_var: ''
    secret_access_key_encrypted_var: ''

"connections": [
    {
      "id": "aws-conn",
      "type": "aws",
      "name": "AWS Connection",
      "region": "us-east-2",
      "access_key_id": "ACCESSKEYID",
      "secret_access_key": "SECRETACCESSKEY",
      "access_key_id_encrypted": "",
      "secret_access_key_encrypted": "",
      "region_var": "",
      "access_key_id_var": "",
      "secret_access_key_var": "",
      "access_key_id_encrypted_var": "",
      "secret_access_key_encrypted_var": ""
    }
  ]

Note

In these examples the keys secret_access_key_encrypted, region_var, access_key_id_var, secret_access_key_var, secret_access_key_encrypted_var, access_key_id_encrypted, access_key_id_encrypted_var can be omitted because are empty.