Early Access: The content on this website is provided for informational purposes only in connection with pre-General Availability Qlik Products.
All content is subject to change and is provided without warranty.
Skip to main content Skip to complementary content

Setting advanced connection properties

In the Advanced tab, you can enable the creation of a reference file and set post-processing actions. These options are described in detail below.

Advanced tab settings
Option Description

Generate reference files

Select this option to generate a Reference File containing the full path to the Apply Changes data files.

Information note

The reference file only points to the location of the Apply Changes files, and not the Full Load files.

For more information on this feature, see Generating reference files.

For information on using reference files with the File source endpoint, see Reference files.

Reference file folder

The folder on the Replicate machine in which the Reference File will be created.

Information note

Multiple tasks with file target endpoints that have the same target directory are not supported (as each task will attempt to write to the same reference file).

Example:

c:\temp\

Post-process files

You can process the final target files using a custom command. The command will be run whenever a data file is created.

Information note

If the Generate a reference file option is selected, a row (specifying the file's location) will be added to the Reference File only after the command completes successfully.

  • Command name - The location of the command e.g. C:\utils\move.exe.

  • Working directory - The directory where you want the command to run.

  • Parameters - Specify any parameters that need to be passed to the command during runtime. You can use the following built-in parameters:

    ${FILENAME} - The full path to the CSV file containing the full load or CDC data.

    ${METADATA_FILENAME} - The full path to the DFM file containing the metadata.

    Information note
    • If the CSV/DFM file paths contain spaces, you must enclose these parameters with quotation marks (e.g "${FILENAME}").
    • The post-processing command must return a proper exit code. For information on the available exit code options, see Exit codes for the Post-Processing command.

For information on creating metadata files, see Setting general properties.

After post processing completes

You can decide what to do with the original target files after post-processing completes:

  • Do nothing - Leaves the files in their original location
  • Delete files - Deletes the files from the disk
  • Archive files to folder - Archives the files to the specified folder.

Exit codes for the Post-Processing command

The post-processing command must return a proper exit code. You can either use the standard exit code values described below or set a custom exit code value as described in Setting Post Command exit codes with an internal parameter below.

Standard Post Command exit codes

  • 0 - Success
  • 1 - Recoverable error. The task will recover from the point of failure according to the settings in the Environmental errors tab.
  • 2 - Table error. If a table error occurs, Replicate will handle the error according to the settings in the Table Errors tab.
  • 3 (or any other value e.g. -100) - Fatal error. The task will fail and not attempt recovery.

Setting Post Command Exit Codes with an Internal Parameter

You can use internal parameters to set exit codes with custom values. This is especially useful if your application already uses the standard exit code values.

See Standard Post Command exit codes above for a description of the exit codes.

  • successExitCode
  • recoverableErrorExitCode
  • tableErrorExitCode
  • fatalErrorExitCode

Internal parameters

Internal parameters are parameters that are not exposed in the UI and should only be used if instructed by Qlik Support.

To add internal Qlik Replicate parameters:

  1. Click the Internal Parameters link.

    The Internal Parameters dialog box opens.

  2. In the edit box, type the name of the parameter you need to add and then click it.
  3. The parameter is added to the table below the search box with its default value.
  4. Change the default value as required.
  5. To reset the parameter value to its default, click the "Restore default value" icon at the end of the row.

More options

These options are not exposed in the UI as they are only relevant to specific versions or environments. Consequently, do not set these options unless explicitly instructed to do so by Qlik Support or product documentation.

To set an option, simply copy the option into the Add feature name field and click Add. Then set the value or enable the option according to the instructions you received.

Settings summary

You can view a summary of your setting by clicking the View Setting Summary link. This is useful if you need to send a summary of your setting to Qlik Support.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!