Setting general connection properties
This section describes how to configure general connection properties. For an explanation of how to configure advanced connection properties, see Setting advanced connection properties.
To add an Microsoft Azure ADLS target endpoint to Qlik Replicate:
- In Tasks view, click Manage Endpoint Connections to open the Manage Endpoints Connections dialog box. Then click the New Endpoint Connection button. For more information on adding an endpoint to Qlik Replicate, see Defining and managing endpoints.
- In the Name field, type a name for your endpoint. This can be any name that will help to identify the endpoint being used.
- Optionally, in the Description field, type a description that helps to identify the endpoint.
- Select Target as the endpoint role.
- Select Microsoft Azure ADLS as the endpoint Type.
-
Configure the remaining settings in the General tab as described in the sections below.
Information noteSome of the settings are specific to the selected the storage type (Azure Data Lake Storage (ADLS) Gen2 or Azure Data Lake Storage (ADLS) Gen1).
Azure Storage
| Option | Description |
|---|---|
|
Storage type |
Choose one of the following as appropriate:
|
|
Storage account |
If you selected the Azure Data Lake Storage (ADLS) Gen2 storage type, specify the name of your storage account. Information note
To connect to an Azure resource on Government Cloud or China Cloud, you need to specify the full resource name of the storage account. For example, assuming the storage account is "myaccount", then the resource name for China Cloud would be myaccount.dfs.core.chinacloudapi.cn In addition, you also need to specify the login URL using the adlsLoginUrl internal parameter. For China Cloud, this would be https://login.chinacloudapi.cn For information on setting internal parameters, see Internal Parameters |
|
Data Lake Store name |
If you selected the Azure Data Lake Storage (ADLS) Gen1 storage type, specify the full name of the ADLS storage. Information note
To connect to an Azure resource on Government Cloud or China Cloud, you need to specify the full resource name of the storage account. For example, assuming the storage account is "myaccount", then the resource name for China Cloud would be myaccount.dfs.core.chinacloudapi.cn In addition, you also need to specify the login URL using the adlsLoginUrl internal parameter. For China Cloud, this would be https://login.chinacloudapi.cn For information on setting internal parameters, see Internal Parameters |
|
Azure Active Directory Tenant ID |
The Azure Active Directory tenant ID. |
|
Application Registration Client ID |
The application registration client ID. |
|
Application Registration Secret |
The application registration secret. |
|
Container |
If you selected the Azure Data Lake Storage (ADLS) Gen2 storage type, specify the container containing your folders and files. |
|
SSL CA Path: |
If you selected the Azure Data Lake Storage (ADLS) Gen1 storage type, specify the path of a CA certificate (or certificate chain if needed) in PEM format. The CA file must also contain the CA of login.microsoftonline.com. |
|
Specify where to create the data files on ADLS. If you selected theAzure Data Lake Storage (ADLS) Gen2 storage type, this should be a location in your file system. |
File attributes
Delimiters can be standard characters or a hexadecimal (hex) value. Note that the "0x" prefix must be used to denote a hexadecimal delimiter (e.g. 0x01 = SOH). In the Field delimiter, Record delimiter and Null value fields, the delimiter can consist of concatenated hex values (e.g. 0x0102 = SOHSTX), whereas in the Quote character and Escape character fields, it can only be a single hex value.
0x00 is not supported (i.e. only 0x01-0xFF are supported).| Option | Description |
|---|---|
|
Format |
You can choose to create the target files in CSV or JSON, or Parquet format. Information noteParquet format is supported from Replicate May 2022 Service Release 02 only.
In a JSON file, each record is represented by a single line, as in the following example: { "book_id": 123, "title": "Alice in Wonderland", "price": 6.99, "is_hardcover": false } { "book_id": 456, "title": "Winnie the Pooh", "price": 6.49, "is_hardcover": true } { "book_id": 789, "title": "The Cat in the Hat", "price": 7.23, "is_hardcover": true } Information noteChanging the format (for example, from CSV to JSON or from JSON to CSV) while the task is in a stopped state and then resuming the task, is not supported.
Information noteIf you choose JSON or Parquet format, the following fields will be hidden as they are only relevant to CSV format: Field delimiter, Record delimiter, Null value, Quote character, Escape character, and Add metadata header.
For information about data type mappings when using Parquet format and limitations, see Mapping from Qlik Replicate data types to Parquet and Limitations and considerations.
|
|
Field delimiter |
The delimiter that will be used to separate fields (columns) in the target files. The default is a comma. Example using a comma as a delimiter: "mike","male" |
|
Null value |
The string that will be used to indicate a null value in the target files. Example (where \n is the record delimiter and @ is the null value): "mike","male",295678\n "sara","female",@\n |
|
Quote escape character |
The character used to escape a quote character in the actual data. Example (where" is the quote character and \ is the escape character): 1955,"old, \"rare\", Chevrolet","$1000" |
|
Record delimiter |
The delimiter that will be used to separate records (rows) in the target files. The default is a newline ( Example: "mike","male"\n "sara","female"\n |
|
Quote character |
The character that will be used at the beginning and end of a text column. The default is the double-quote character ("). When a column that contains column delimiters is enclosed in double-quotes, the column delimiter characters are interpreted as actual data, and not as column delimiters. Example (where a @ is the quote character): @mike@,@male@ |
|
Add metadata header |
When the target storage format is set to Text, you can optionally add a header row to the data files. The header row can contain the source column names and/or the intermediate (i.e. Replicate) data types. Example of a target file with a header row when both With column names and With data types are selected: Position:DECIMAL(38,0),Color:VARCHAR(10) 1,"BLUE" 2,"BROWN" 3,"RED" ... |
|
The maximum size a file can reach before it is closed (and optionally compressed). This value applies both to data files and to Reference Files. For information on generating reference files, see Setting advanced connection properties. |
|
|
Compress files using |
Choose one of the compression options to compress the target files or NONE (the default) to leave them uncompressed. Note that the available compressions options are determined by the selected file format. |
Change processing
| Option | Description |
|---|---|
|
Specify the maximum size of Change Data to accumulate before uploading the file to Microsoft Azure ADLS . |
|
|
Specify the maximum time to wait before applying the changes. |
Metadata files
| Option | Description |
|---|---|
|
When this option is selected, for each data file, a matching metadata file with a .dfm extension will be created under the specified target folder. The metadata files (which are in standard JSON format) provide additional information about the task/data such as the source endpoint type, the source table name, the number of records in the data file, and so on. For a full description of the metadata file as well as possible uses, see Metadata file description . |
Testing the connection
To determine if the connection information you entered is correct, click Test Connection. If the connection test is successful, click Save.
As part of connection testing process, Replicate uploads a test file to the specified Microsoft Azure ADLS Target folder and then deletes it once a connection has been established.
If the connection is successful, a message in green is displayed. If the connection fails, an error message is displayed at the bottom of the dialog box.
To view the log entry if the connection fails, click View Log. The server log is displayed with the information for the connection failure. Note that this button is not available unless the test connection fails.