How to import an endpoint into Qlik Replicate

[dima_etkin]

There has always been a noticeable gap in Qlik Replicate, where users had no means of importing just an endpoint into Qlik Replicate. This article provides a workaround to that limitation.

1. To start creating an endpoint, it is advisable to prototype something the product generates.
   
   Create a dummy task with a dummy endpoint (source or target) which resembles the endpoint you wish to import. This task or endpoint does not have to be perfectly filled out. See example below: 
   
   
   
   
2. Once the dummy task has been set up, export the task. See Exporting tasks.
   
   
3. Open the resulting JSON file. See Editing an exported (json) file. 
   
   
4. You will only need the following definitions from the task JSON payload:
   
   The "cmd.replication_definition"."databases" group and a "_version" member:
   
   

   {
   	"cmd.replication_definition":	{
   		"databases":	[{
   		...
   			}]
   	},
   	"_version":	{
   		...
   	}
   }

5.  Create the JSON definitions of the endpoint following the example below. This will be the endpoint you import. 
   
   

   Verify that your endpoint name is correct.  
   
   

   You may want to skip entering the password and add it later through the user interface. Inputting the password in the JSON is in plain text.

   {
   	"cmd.replication_definition":	{
   		"databases":	[{
   				"name":	"DB2z_Source",
   				"description":	"",
   				"role":	"SOURCE",
   				"is_licensed":	true,
   				"type_id":	"DB2ZOS_NATIVE_COMPONENT_TYPE",
   				"db_settings":	{
   					"$type":	"Db2zosSettings",
   					"additionalConnectionProperties":	"MaryHad=aLittleLamb",
   					"username":	"dimae",
   					"databaseAlias":	"DBALIAS",
   					"server":	"lpardns.mydomain.com",
   					"port":	5035,
   					"databaseName":	"LOCATION",
   					"CCSIDMapping":	"234,ibm-p100-2345",
   					"ifi306SpName":	"R4Z_UDF_ALL_NEW"
   				},
   				"override_properties":	{
   				}
   			}]
   	},
   	"_version":	{
   		"version":	"2023.5.0.213",
   		"version_major":	2023,
   		"version_minor":	5,
   		"version_revision":	213
   	}
   }

6. Save this content as a .JSON file. We recommend the /data/imports folder to make the import command simpler, but any folder and drive your user has access to can be used.
   
   
7. Import the definitions into the Qlik Replicate server.
   
   You can do so using either:
   • Qlik Enterprise Manager API
   • Qlik Enterprise Manager
   • Qlik Replicate UI, 
   • repctl CLI  command (on Windows):
     

     repctl importrepository json_file=NAMEOFFILE.JSON folder_name=DRIVE:\FOLDER

        

Related Content

Editing an exported (json) file
ImportAll | Enterprise Manager API
Exporting and importing tasks
Importing tasks

Environment

• Qlik Replicate
• Qlik Enterprise Manager

The information in this article is provided as-is and to be used at own discretion. Depending on tool(s) used, customization(s), and/or other factors ongoing support on the solution below may not be provided by Qlik Support.

[alvinj]

Is this applicable to version 2022.11.0.394? Me and my colleagues can't make this procedure work. We are having issues with the JSON file (We tried via GUI and REST API ImportAll). Below is our JSON file contents: 

   {

        "cmd.replication_definition": {

          "databases": [{

              "name": "Test_Endpoint_via_API",

              "role": "TARGET",

              "is_licensed": true,

              "type_id": "GOOGLE_STORAGE_COMPONENT_TYPE",

              "db_settings": {

                "type": "GooglestorageSettings",

                "addColumnName": true,

                "cdcMaxBatchInterval": 900,

                "createMetadata": true,

                "fileFormat": "JSON",

                "jsonCredentials": "",

                "bucketName": "nonprod-dev-lakehouse",

                "bucketFolder": "LINX/",

                "proxyHost": "wsgproxydtl.abc.int",

                "proxyPort": 3128,

                "proxyScheme": "HTTP",

                "useProxyServer": true

              },

              "override_properties": {

              }

}]

        },

        "_version": {

          "version": "2022.11.0.394",

          "version_major": 2022,

          "version_minor": 11,

          "version_revision": 394

        }

      }

[dima_etkin]

Hi @alvinj ,

The solution was tested from Replicate on V23.05.(both via UI and CLI)

Latest tests from QEM show that the same approach is not currently supported via the QEM UI nor the APIs.

Regards,

   Dima

[JOliv221]

Hi @dima_etkin , thank you for the reply!

Quick question on the 2nd statement "Latest tests from QEM show that the same approach is not currently supported via the QEM UI nor the APIs."

Does this refer to the latest QEM version from November 2023?