Connection manager (handler)

Certain connection point managers or handlers are provided as standard.

For configuring changes, see also the settings of the module.

Simple File

Data is exchanged in the form of files, to be read (Import) or written (Export) to the directories specified in the configuration.

Simple File: All files present in the directory are processed, regardless of their content.

Example of XML file:

<entities externalSystem="CODE_SYSTEME_EXTERNE" exchangeInterface="CODE_INTERFACE">

Example of CSV file:

externalSystem;CODE_SYSTEME_EXTERNE;exchangeInterface;CODE_INTERFACE>

When executing an interface on an external system, CARL Source only processes the files from the interface on the current system. Therefore, files from multiple interfaces and external systems can be stored in the same directory.

Configuration Attributes

Output Directory: Full path to the directory where the output files are placed, produced by CARL Source (including error files).
Input Directory: Full path to the directory where the files to be integrated by CARL Source are read.
File Extension: File suffix. The suffix is independent of the format, even though it is recommended to follow convention.
File Name: Output files will bear this name followed by the extension (this attribute is not taken into account during an import/entry).
Encoding: File encoding, for preservation of special characters.
Input Message Backup Directory: Directory where a copy of the file will be stored before import.
This directory must be different from the input directory, otherwise, any processed file will appear again in the directory of files to be processed.
Input Message Backup File Name: Name of the backup copy before import, followed by a unique suffix and the extension.
Output Message Backup Directory: Directory where a copy of the exported file will be stored.
Output Message Backup File Name: Name of the backup copy of the exported file, followed by a unique suffix and the extension.
Import Filtering File Name: Prefix of the file to import.
Automatic Suffix (if the file name is specified): By checking this box, a unique identifier will be added between the file name and extension (if specified).
ZIP Input Directory: If this parameter is specified, the Handler will attempt to decompress the file in a temporary directory created in the input directory, then search for the file to process in that subdirectory.
The input directory in the ZIP is relative to the temporary directory resulting from the decompression.
A period (.) means the file should be selected directly from the temporary directory.
The path must use Unix style; slash (/) as the separator.
ZIP File Prefix: Parameter used to select the file to process from those obtained after decompression.
ZIP File Extension: Parameter used to select the file to process from those obtained after decompression.
Compression of Output File: Checking this box means the output file will be compressed and turned into a ZIP archive.

Filtered Simple File

Data is exchanged in the form of files, to be read (Import) or written (Export) to the directories specified in the configuration.

Filtered Simple File: The interface and external system must be specified in the file header.

Configuration Attributes

Output Directory: Full path to the directory where the output files are placed, produced by CARL Source (including error files).
Input Directory: Full path to the directory where the files to be integrated by CARL Source are read.
File Extension: File suffix. The suffix is independent of the format, even though it is recommended to follow convention.
File Name: Output files will bear this name followed by the extension (this attribute is not taken into account during an import/entry).
Encoding: File encoding, for preservation of special characters.
Input Message Backup Directory: Directory where a copy of the file will be stored before import.
This directory must be different from the input directory, otherwise, any processed file will appear again in the directory of files to be processed.
Input Message Backup File Name: Name of the backup copy before import, followed by a unique suffix and the extension.
Output Message Backup Directory: Directory where a copy of the exported file will be stored.
Output Message Backup File Name: Name of the backup copy of the exported file, followed by a unique suffix and the extension.
Automatic Suffix (if the file name is specified): By checking this box, a unique identifier will be added between the file name and extension (if specified).

Error File

Configuration Attributes

Output Directory: Full path to the directory where the output files are placed, produced by CARL Source (including error files).
File Extension: File suffix. The suffix is independent of the format, even though it is recommended to follow convention.
Encoding: File encoding, for preservation of special characters.

Exchanges with a Web Server

Configuration Attributes

Output Directory: Full path to the directory where the output files are placed, produced by CARL Source (including error files).
Input Directory: Full path to the directory where the files to be integrated by CARL Source are read.
File Extension: File suffix. The suffix is independent of the format, even though it is recommended to follow convention.
Host Name: Host name (or IP address).
Port: Connection port on the host.
File Name: Output files will bear this name followed by the extension (this attribute is not taken into account during an import/entry).
Encoding: File encoding, for preservation of special characters.
Input Message Backup Directory: Directory where a copy of the file will be stored before import.
This directory must be different from the input directory, otherwise, any processed file will appear again in the directory of files to be processed.
Input Message Backup File Name: Name of the backup copy before import, followed by a unique suffix and the extension.
Output Message Backup Directory: Directory where a copy of the exported file will be stored.
Output Message Backup File Name: Name of the backup copy of the exported file, followed by a unique suffix and the extension.
Import Filtering File Name: Prefix of the file to import.
Automatic Suffix (if the file name is specified): By checking this box, a unique identifier will be added between the file name and extension (if specified).
ZIP Input Directory: If this parameter is specified, the Handler will attempt to decompress the file in a temporary directory created in the input directory, then search for the file to process in that subdirectory.
The input directory in the ZIP is relative to the temporary directory resulting from the decompression.
A period (.) means the file should be selected directly from the temporary directory.
The path must use Unix style; slash (/) as the separator.
ZIP File Prefix: Parameter used to select the file to process from those obtained after decompression.
ZIP File Extension: Parameter used to select the file to process from those obtained after decompression.
HTTP Command Used to Download the File: Command to download the file: GET, POST.
Path to the Resource to Download: URL of the resource to download (import).
Path to the Resource to Upload: URL of the resource to upload (export).
Connection Protocol on the Remote Server: Protocol name: http, https.
Authentication ID on the Remote Server: Login for authentication.
Password for Authentication on the Remote Server: Password for authentication.
Compression of Output File: Checking this box means the output file will be compressed and turned into a ZIP archive.

Exchanges with an FTP Server

Configuration Attributes

Output Directory: Full path to the directory where the output files are placed, produced by CARL Source (including error files).
Input Directory: Full path to the directory where the files to be integrated by CARL Source are read (from the application server's perspective).
File Extension: File suffix. The suffix is independent of the format, even though it is recommended to follow convention.
Host Name: Host name (or IP address).
Port: Connection port on the host.
File Name: Output files will bear this name followed by the extension (this attribute is not taken into account during an import/entry).
Encoding: File encoding, for preservation of special characters.
Input Message Backup Directory: Directory where a copy of the file will be stored before import.
This directory must be different from the input directory, otherwise, any processed file will appear again in the directory of files to be processed.
Input Message Backup File Name: Name of the backup copy before import, followed by a unique suffix and the extension.
Output Message Backup Directory: Directory where a copy of the exported file will be stored.
Output Message Backup File Name: Name of the backup copy of the exported file, followed by a unique suffix and the extension.
Automatic Suffix (if the file name is specified): By checking this box, a unique identifier will be added between the file name and extension (if specified).
ZIP Input Directory: If this parameter is specified, the Handler will attempt to decompress the file in a temporary directory created in the input directory, then search for the file to process in that subdirectory.
The input directory in the ZIP is relative to the temporary directory resulting from the decompression.
A period (.) means the file should be selected directly from the temporary directory.
The path must use Unix style; slash (/) as the separator.
ZIP File Prefix: Parameter used to select the file to process from those obtained after decompression.
ZIP File Extension: Parameter used to select the file to process from those obtained after decompression.
FTP Client Mode: FTP Mode: ACTIVE or PASSIVE
Action to Perform After Downloading: Action to take after the file is retrieved: NONE, DELETE, MOVE
Relative Directory for Moving (.=rename): The remote directory where the downloaded file should be moved.
Prefix Applied During Move: Prefix applied to the file.
Suffix Applied During Move: Suffix applied to the file.
Compression of Output File: Checking this box means the output file will be compressed and turned into a .ZIP

Exchanges with an SFTP Server

Configuration Attributes

Only the attributes specific to the SFTP connector are described below.
For other attributes, refer to the information related to the FTP connector (see the previous chapter).

Key Authentication (with or without passphrase): Boolean.
If set to [False]: authentication is performed with a password.

The chosen authentication mode must be configured on the SFTP server side and specified by its manager.

There are three possible authentication methods:

With username and password.

With username and key-based authentication (specifying its location).

With username and key-based authentication (specifying its location) as well as the passphrase for the key.
Note: The passphrase may or may not be defined by the administrator when generating the key. Therefore, it is not mandatory.

Key Location: Location and name of the file containing the key (it must be in OPENSSH format).
The file must be placed on a path accessible by the CARL Source application server.
This parameter must be filled in if the "Key Authentication (with or without passphrase)" parameter (see above) is checked.
Passphrase for the Key: Passphrase for the key.
Path to the known_hosts File: The known_hosts file contains a list of approved servers along with their public keys.
- A line in a known_hosts file consists of:
  - The hostname, i.e., the SSH server. The IP address is also listed.
    A number of hostnames and IP addresses separated by commas can be listed within the file.
  - The applicable public key algorithm: "ssh-rsa" (for RSA key pairs) or "ssh-dss" (for DSA key pairs).
  - The public key encoded in base 64.
- The known_hosts file is theoretically composed of multiple lines, one for each host the client may want to connect to.