Skip to main content Skip to complementary content
Qlik Resources

Setting advanced connection properties using Replicate Log Reader

This section describes which properties are available in the Advanced tab when using Replicate Log Reader to access the redo logs. For information on which properties are available in the Advanced tab when using LogMiner to access the redo logs, see Setting advanced connection properties using Oracle LogMiner.

  • Automatically add supplemental logging: Select this to automatically set up supplemental logging for the Oracle database. This option is also available when LogMiner is selected as the redo logs access method.

    For more information on supplemental logging, see Set up supplemental logging.

  • Under the Access redo logs via label, choose Replicate Log Reader (the default). Replicate will access the redo logs as a binary file.

  • Secret Store encryption entries: When the source tables are encrypted or contain encrypted columns, you need to specify the Oracle Wallet encryption keys and their values.

    For information on locating the required keys, see Finding the wallet entries used for TDE Encryption.

  • ASM Parameters (if redo logs are stored in ASM) - If the Oracle redo logs you are using are stored using Automated Storage Management (ASM), enter the required access information in the designated fields.

    Information note
    • These options are only available when Access redo logs via Log Reader is selected.
    • To access the redo logs in ASM, you also need to grant the additional privileges described in Required ASM privileges
    • ASM Connection String: The connection string to the ASM instance if your Oracle database is using ASM.
    • ASM user name: The user name for the ASM user.

    • ASM password: The password for the ASM user.

    • Number of concurrent ASM Read threads: The number of threads to use when reading the redo logs from ASM. Increasing this number may improve performance when there is a large volume of changes.

  • To access a redo log as a binary file (i.e. not using LogMiner), select one of the following options:

Using the path as it appears in the database

  • Replicate has file-level access to the redo log files: Select this to access and read the redo logs directly from the file system of the local computer where Qlik Replicate is installed.

  • Copy redo logs to a temporary folder: Select this to copy the redo logs to a temporary folder and then specify the path of the redo logs on the Oracle machine.

    Information note

    When configuring multiple tasks that use the same temporary folder (configured in the Oracle source endpoint), do not select the Delete processed archived redo log files option. This is because Replicate uses the original archived log names.

    Information note

    When working in a RAC environment, it is strongly recommended to set up a shared folder that is accessible by all the RAC instances. If this is not possible, you need to define a temporary folder with the same name on each of the RAC instances. In addition, you need to define separate Oracle and ASM connection strings for each RAC instance.

    For more information on defining RAC connection strings, see Setting general connection properties.

    • Replicate has file-level access to temporary folder: Select this to access the archived redo logs directly from the file system of the local computer where Qlik Replicate is installed.

      • Access archived redo logs in folder: To enable Qlik Replicate to access the temporary folder (when it has file level access), you need to specify the path to the shared temporary folder on the Oracle machine, e.g. \\my.oracle.box\tempshare.

        Information note

        When a stopped task is resumed, Replicate will try to re-copy the currently processed Redo logs. If there are no Redo logs in the specified directory, the task will wait for them to be copied there.

  • Look for missing archived redo logs in folder: Type the full path to a location from where you want Qlik Replicate to read the archived redo logs if they are not found in the default location. The folder can be located anywhere in the network where Qlik Replicate is located, but be sure that the location is accessible to the Qlik Replicate user.

    Information note

    When this option is configured, the name of each redo log in the folder must be identical to the name returned by v$archived_log view for the current sequence, thread, and destination ID.

    As the v$archived_log view returns redo log names only when the log status is ACTIVE (meaning the log exists), Replicate will be unable to determine which redo log to access when the status is not ACTIVE.

  • Replicate has file-level access to the specified folder: Select this to access and read the archived redo logs directly from the file system of the local computer where Qlik Replicate is installed.

  • Delete processed archived redo log files: Select this to delete the copied archived redo log files after they have been read.

    Warning note

    Archived redo logs will only be deleted if the Copy redo logs to temporary folder option is enabled as well.

    • This option requires the following additional permissions for the Replicate user: 

    • GRANT SELECT ON DBA_FILE_GROUPS

      Example:

      GRANT SELECT ON DBA_FILE_GROUPS to nonpriv_user;

    • GRANT EXECUTE on SYS.DBMS_FILE_GROUP

      Example:

      GRANT EXECUTE ON SYS.DBMS_FILE_GROUP to nonpriv_user;

    • EXECUTE DBMS_FILE_GROUP.GRANT_SYSTEM_PRIVILEGE with the system privilege 'MANAGE_FILE_GROUP' for the Replicate user.

      Example:

      execute DBMS_FILE_GROUP.GRANT_SYSTEM_PRIVILEGE (DBMS_FILE_GROUP.MANAGE_FILE_GROUP, 'nonpriv_user', FALSE)
      Information note

      Verify that another file group is not using the configured temp directory under a different Oracle user.

  • Retry interval: Use the counter or type the number of seconds that the system waits before resending a query.

  • Archived redo logs destination ID: The destination of the archived redo logs. The value should be the same as the DEST_ID number in the V$archived_log table.

    When working with multiple log destinations (DEST_ID), you should specify an Archived redo logs location identifier that represents archived logs that can be accessed by the Qlik replication server. If the Archived redo logs location identifier is not specified, the Qlik replication server will use the ID specified in the Alternate archived redo logs destination ID field. If no alternate ID is specified, then the Qlik replication server will use the minimal existing DEST_ID.

  • Alternate archived redo logs destination ID: The archive destination in the event of a failure to read from the primary destination.

  • Expose NUMBER as: Select one of the following:

    • A precision-scale combination
    • FLOAT

    • VARCHAR

    Information note
    • If precision is 39 or greater, select VARCHAR
    • By default, the NUMBER data type is converted to precision 38, scale 10
    • The "Expose NUMBER" definition in the Oracle database is used for the NUMBER data type only (without the explicit precision and scale definition)
  • Use archived redo logs only: When this option is selected, the Qlik replication server will only access the archived redo logs. If the archived redo logs ares stored on ASM only, the user specified in the endpoint settings needs to be granted the ASM privileges described in Required ASM privileges.
  • Support nested tables: Select this option if you need to replicate Oracle tables containing columns that are nested tables or defined types. For more information on this feature and its prerequisites, see Replicating nested tables.

  • Support invisible columns: Select this option to replicate invisible columns.

Replacing the path prefix

  • Replace path prefix: You can determine whether to read the redo logs from a different root location while leaving the relative path unchanged.

    Type the first part of the path to the current location of the redo logs. For example, C:\OldFolder.

    You can include one folder or directory level or multiple folders or directories in this field.

    With: Type the name of the folder or prefix to replace the existing prefix that you added in the field above. For example, C:\NewFolder.

    Information note

    The following examples illustrate how to change the prefix:

    If the redo logs are located in C:\OldFolder\archive\logs and you specify C:\OldFolder in the Replace path prefix field, and C:\NewFolder in the With field, the redo logs will be read from:

    C:\NewFolder\archive\logs

    If the redo logs are located in C:\temp\oracle\logs\archive\RedoLogs and you specify C:\temp\oracle\logs in the Replace path prefix field, and C:\companyName in the With field, then the redo logs will be read from:

    C:\companyName\archive\RedoLogs

    In this case, the new folder or directory called companyName replaces all of the first three level folders that you included in the Replace path prefix field.

    • Apply prefix replacement to online and archived redo logs: Select this to apply the prefix replacement to the online and archived redo logs.
      • Replicate has file-level access to the new location: Select this to access and read the online and archived redo log files directly from the file system of the local computer where Qlik Replicate is installed.
    • Apply prefix replacement to archived redo logs only: Select this to apply the prefix replacement to the archived redo logs only (and not to the online redo logs).
      • Replicate has file-level access to the original online location: Select this to access and read the original online redo log files directly from the file system of the local computer where Qlik Replicate is installed.
      • Replicate has file-level access to the new archive location: Select this to access and read the archived redo log files directly from the file system of the local computer where Qlik Replicate is installed.

    • Delete processed archived redo log files: Select this to delete the copied archived redo log files after they have been read.

      Warning note

      Archived redo logs will only be deleted if the Copy redo logs to temporary folder option is enabled as well.

      • This option requires the following additional permissions for the Replicate user: 

      • GRANT SELECT ON DBA_FILE_GROUPS

        Example:

        GRANT SELECT ON DBA_FILE_GROUPS to nonpriv_user;

      • GRANT EXECUTE on SYS.DBMS_FILE_GROUP

        Example:

        GRANT EXECUTE ON SYS.DBMS_FILE_GROUP to nonpriv_user;

      • EXECUTE DBMS_FILE_GROUP.GRANT_SYSTEM_PRIVILEGE with the system privilege 'MANAGE_FILE_GROUP' for the Replicate user.

        Example:

        execute DBMS_FILE_GROUP.GRANT_SYSTEM_PRIVILEGE (DBMS_FILE_GROUP.MANAGE_FILE_GROUP, 'nonpriv_user', FALSE)
        Information note

        Verify that another file group is not using the configured temp directory under a different Oracle user.

  • Retry interval: Use the counter or type the number of seconds that the system waits before resending a query.

  • Archived redo logs destination ID: The destination of the archived redo logs. The value should be the same as the DEST_ID number in the V$archived_log table.

    When working with multiple log destinations (DEST_ID), you should specify an Archived redo logs location identifier that represents archived logs that can be accessed by the Qlik replication server. If the Archived redo logs location identifier is not specified, the Qlik replication server will use the ID specified in the Alternate archived redo logs destination ID field. If no alternate ID is specified, then the Qlik replication server will use the minimal existing DEST_ID.

  • Alternate archived redo logs destination ID: The archive destination in the event of a failure to read from the primary destination.

  • Expose NUMBER as: Select one of the following:

    • A precision-scale combination
    • FLOAT

    • VARCHAR

    Information note
    • If precision is 39 or greater, select VARCHAR
    • By default, the NUMBER data type is converted to precision 38, scale 10
    • The "Expose NUMBER" definition in the Oracle database is used for the NUMBER data type only (without the explicit precision and scale definition)
  • Use archived redo logs only: When this option is selected, the Qlik replication server will only access the archived redo logs. If the archived redo logs ares stored on ASM only, the user specified in the endpoint settings needs to be granted the ASM privileges described in Required ASM privileges.
  • Support nested tables: Select this option if you need to replicate Oracle tables containing columns that are nested tables or defined types. For more information on this feature and its prerequisites, see Replicating nested tables.

  • Support invisible columns: Select this option to replicate invisible columns.

Internal parameters

Internal parameters are parameters that are not exposed in the UI. You should only use them 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 settings by clicking the Setting Summary link. This is useful if you need to send a summary of your settings 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!

Leave your feedback here