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.

Settings for Replicate November 2024 Service Release 1 or later

To add a MongoDB source endpoint to Qlik Replicate:

1. In the Qlik Replicate Console, 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.
2. In the Name field, type a name for your endpoint. This can be any name that will help to identify the database being used.
3. In the Description field, type a description that helps to identify the MongoDB database. This is optional.

4. Select Source as the endpoint role.

5. From the Type drop-down list, select MongoDB.

   Information note

   When this endpoint is used as a duplicated source in a Log Stream Staging setup, select the Read changes from log stream staging folder check box and then select the relevant Log Stream Staging task from the drop-down list.

   For information on setting up and managing Log Stream Staging tasks, see Using the Log Stream.

6. Select Standard or MongoDB Atlas for MongoDB deployment.

7. For Standard deployment, configure the settings according to the following table:

   MongoDB Standard settings

   Option	Description
   Hosts	When working with a MongoDB cluster, you can specify multiple hosts in the following format: host1[:port1][,...hostN[:portN]] Replicate will try to connect to the first host. If it is unable to do so, it will then try to connect to the other hosts in the order they are listed.
   Authentication method	Select one of available authentication methods. When using x.509 authentication, you must also enable Use SSL and provide the Certificate Authority and Client Certificate settings described below. For all other authentication methods, Use SSL is optional. SCRAM-SHA-256 Provide the following information: User name: Specify the user name of a user with the required role. Password: Specify the password of the above user. Authentication database name: The name of the authentication database on which the specified user account is defined. SCRAM-SHA-1 Provide the following information: User name: Specify the user name of a user with the required role. Password: Specify the password of the above user. Authentication database name: The name of the authentication database on which the specified user account is defined. x.509 When this option is selected, you must enable Use SSL (described below) and provide the Certificate Authority and Client Certificate settings. PLAIN (LDAP SASL) When this authentication methods is selected, you also need to provide the following information: User name: Specify the user name of a user with the required role. Password: Specify the password of the above user. None
   Use SSL	Select to transfer data over an encrypted connection. When this option is selected, you must also provide the following information: Certificate Authority Truststore file (in JKS format): The full path of the truststore file on the Replicate Server machine. The trustore file should contain the CA certificate for verifying the MongoDB servers' certificates. Truststore Password: The password for accessing your truststore. Client Certificate Information noteThese settings are not available when the authentication method is None. Certificate subject: The subject of your public key certificate. Keystore file (in JKS format): The full path of the keystore file (containing your private key) on the Replicate Server machine. Keystore password: The passphrase for accessing your keystore file.

   For MongoDB Atlas deployment, configure the settings according to the following table:

   MongoDB Atlas settings

   Option	Description
   Atlas hostname	When working with MongoDB Atlas, you must specify the host in the following format: server.example.com
   Authentication method	Select one of available authentication methods. When using x.509 authentication, you must also specify your client certificate settings. For all other methods, authentication using a client certificate is optional. SCRAM-SHA-1 When this authentication method is selected, you also need to provide the following information: User name: Specify the user name of a user with the required role. Password: Specify the password of the above user. Authentication database name: The name of the authentication database on which the specified user account is defined. x.509 When this option is selected, you must provide the Client Certificate settings (described below). AWS IAM With this authentication method, you use an IAM credentials source with one of the following options: Key pair: Specify the Access key, the Secret key, and the Session token (optional). Environment variables: Must be set by the user. PLAIN (LDAP SASL) When this authentication methods is selected, you also need to provide the following information: User name: Specify the user name of a user with the required role. Password: Specify the password of the above user.
   Client Certificate	Certificate subject: The subject of your public key certificate. Keystore file (in JKS format): The full path of the keystore file (containing your private key) on the Replicate Server machine. Keystore password: The passphrase for accessing your keystore file.

Settings for Replicate November 2024 Initial Release

To add a MongoDB source endpoint to Qlik Replicate:

1. In the Qlik Replicate Console, 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.
2. In the Name field, type a name for your endpoint. This can be any name that will help to identify the database being used.
3. In the Description field, type a description that helps to identify the MongoDB database. This is optional.

4. Select Source as the endpoint role.

5. From the Type drop-down list, select MongoDB.

   Information note

   When this endpoint is used as a duplicated source in a Log Stream Staging setup, select the Read changes from log stream staging folder check box and then select the relevant Log Stream Staging task from the drop-down list.

   For information on setting up and managing Log Stream Staging tasks, see Using the Log Stream.

6. Select Standard or MongoDB Atlas for MongoDB deployment.

7. For Standard deployment, configure the settings according to the table below:

   Setting configurations

   Option	Description
   Hosts	When working with a MongoDB cluster, you can specify multiple hosts in the following format: host1[:port1][,...hostN[:portN]] Replicate will try to connect to the first host. If it is unable to do so, it will then try to connect to the other hosts in the order they are listed.
   Authentication method	Select one of the following: SCRAM-SHA-256 SCRAM-SHA-1 When one of the SCRAM authentication methods is selected, you also need to provide the following information: User name: Specify the user name of a user with the required role. Password: Specify the password of the above user. Authentication database name: The name of the authentication database on which the specified user account is defined. x.509 (Certificate) - To make this available for selection, first select the Use SSL option. When this authentication method is selected, you also need to provide the following information: Certificate subject: The subject of your public key certificate. Keystore file (in JKS format): The full path of the keystore file (containing your private key) on the Replicate Server machine. Keystore password: The passphrase for accessing your keystore file. PLAIN (LDAP SASL) When this authentication methods is selected, you also need to provide the following information: User name: Specify the user name of a user with the required role. Password: Specify the password of the above user. None
   Use SSL	Select to transfer data over an encrypted connection. When this option is selected, you also need to provide the following information: Truststore file (in JKS format): The full path of the truststore file on the Replicate Server machine. The trustore file should contain the CA certificate for verifying the MongoDB servers' certificates. Truststore Password: The password for accessing your truststore.

   For MongoDB Atlas deployment, configure the settings according to the table below:

   Setting configurations

   Option	Description
   Atlas hostname	When working with MongoDB Atlas, you must specify the host in the following format: server.example.com
   Authentication method	Select one of the following: SCRAM-SHA-1 Whenthis authentication methods is selected, you also need to provide the following information: User name: Specify the user name of a user with the required role. Password: Specify the password of the above user. Authentication database name: The name of the authentication database on which the specified user account is defined. x.509 (Certificate) - To make this available for selection, first select the Use SSL option. When this authentication method is selected, you also need to provide the following information: Certificate subject: The subject of your public key certificate. Keystore file (in JKS format): The full path of the keystore file (containing your private key) on the Replicate Server machine. Keystore password: The passphrase for accessing your keystore file. AWS IAM With this authentication method, you use an IAM credentials source with one of the following options: Key pair: Specify the Access key, the Secret key, and the Session token (optional). Environment variables: Must be set by the user. PLAIN (LDAP SASL) When this authentication methods is selected, you also need to provide the following information: User name: Specify the user name of a user with the required role. Password: Specify the password of the above user.