Skip to main content

Setup Zuora Connector for Generic ClickHouseEdit

Zuora

Setup Zuora Connector for Generic ClickHouseEdit

  1. Last updated
  2. Save as PDF
Provides detailed instructions for setting up the Zuora Connector for Generic ClickHouse.

Follow the steps mentioned below to setup Zuora Connector for Generic ClickHouse.

Step 1: Allow access

  1. Make a note of Zuora static IP

Zuora Connectors – Outbound IP Whitelisting Requirement

Zuora connectors require the destination to be accessible via the public internet. Please ensure that the following Zuora outbound IPs are whitelisted at your data destination:

Production Tenants
API Sandbox & Central Sandbox Tenants

If you are not sure whether to use US Cloud1 or Cloud2, see Zuora Data Centers.

   2. Create a rule in a security group or firewall settings to whitelist:

  • Incoming connections to your host and port (usually 9440) from the static IP.
  • Outgoing connections from ports 1024 to 65535 to the static IP.

Step 2: Create reader user

Create a database user to perform the reading of the source data.

  1. Open a connection to your ClickHouse database.
  2. Create a user for the data transfer by executing the following SQL command.
CREATE USER <username>@'%' IDENTIFIED BY '<some-password>';

  1. Grant user required privileges on the database.

GRANT SELECT ON <{database.table|database.*|*.*}> TO <username>@'%';
GRANT CREATE TEMPORARY TABLE, S3 on *.* TO <username>@'%';
The CREATE TEMPORARY TABLE and S3 permissions

The CREATE TEMPORARY TABLE and S3 permissions are required to efficiently transfer data from ClickHouse. Under the hood, these permissions are used to stage data in a temporary table and export compressed data into object storage for transferring. By definition, the temporary table will not exist outside of the session.

Step 3: Setup staging bucket

ClickHouse sources require a staging bucket to efficiently transfer data. Configure your staging bucket using one of the following guides:

Step 4: Add Your Destination

  1. After completing the initial setup, access the Generic ClickHouse connector setup UI to start the provisioning process. To do this, you will need access to the Integration Hub. Refer Integration Hub to complete the installation.
  2. Follow this article to link your Connect account to your Zuora account and install the app. For any assistance, raise a support ticket and stay in touch with your account representative for the necessary access to the Integration Hub UI.
  3. Once you have access, navigate to the Marketplace > Integration Hub UI.
  4. Search and select Zuora Connector for Generic ClickHouse.
  5. Click the Setup tab, click Configure, enter the required details, and select objects for synchronization.
  6. Click Test Connection. If successful, click Save Destination to finalize the setup. This will initiate the onboarding process.
  7. After onboarding, the connector’s Status will change to Active, and you will see status data in the Status tab after the first successful transfer.
  8. Alternatively, If you encounter issues gaining access to this UI, share your ClickHouse host address with a Zuora representative. They will assist in creating a connection link. Use the provided connection link to securely input your ClickHouse database details, including the Bucket vendor, Bucket name, Bucket region, port, cluster, etc. and staging bucket information to complete the setup.