If you're using Vizlib Writeback Table with Vizlib Server, you'll need to set up and select an Integration to store your data and any changes you make. Integrations allow you to connect Vizlib products with your existing solutions (e.g. an email server or a database) to improve data sharing and collaboration. Integrations are configured in the Vizlib Management Console (VMC).
Vizlib Writeback Table e're going to use Google BigQuery in this example. You can find a full list of supported products here.
TABLE OF CONTENTS
- Before you Start - Checklist
- Adding an Integration
- Adding a Destination
- Adding Writeback Settings
- Working with Vizlib Writeback Table - Data Load Updates
Note on Authentication: Google BigQuery integrations currently only use Service Authentication with Vizlib Writeback Table.
Note on Supported Columns: Struct, array and bytes column types are not currently supported.
Before you Start - Checklist
Before you add an integration, make sure you have all the information and permissions you need. Work through all the items in this list and then you'll be ready.
- Installations - Vizlib Writeback Table and Vizlib Server should be installed before you start. We have online tutorials for installing Vizlib Server and Vizlib Extensions to help you
- VMC login / Password - to create and configure the integration, writeback destination and check the audit trail. The VMC is installed as part of Vizlib Server.
- Qlik Sense Connection - your Qlik Sense environment needs a data connection to select and load data from a Google BigQuery database. You can find full setup instructions here.
- Authentication - remember only Service Authentication can be used.
- Column Types - remember columns with type struct, array and bytes are not supported.
- Project ID / Key File - Google BigQuery configuration values used to set up the integration. The ID and file are found in your service account in the Google Cloud Console, please see more information here.
- Dataset / Table Name - to configure the destination type.
- Security Rule - to set up secure access for a destination, a security rule should be configured in the VMC. See our security rules article here for more information.
Adding an Integration
The first step to connecting is to add or configure an integration.
- Log in to the VMC. You should see the dashboard, with all your current integrations listed in the top left panel (Figure 1).
Figure 1: VMC Dashboard Integrations, with integrations highlighted.
- Go to System Settings, and click Integrations to open the Integrations homepage (Figure 2). Integrations with errors are indicated by .
Figure 2: Integrations Page
- Click Add Integration to open the pop-up screen (Figure 3).
- Select bigQuery as the Type, and pick a unique Id. This will be displayed in Vizlib Writeback Table so keep that in mind when you're creating it, we've used bigQuery-test here.
- Set the integration to Public (available for every user with VMC access) or Private (access only for the creator, and users with Admin and Root Admin permissions).
- Enter the Google BigQuery Project Id.
- Click the button at the far right of Upload Key File to open the explorer and locate the Key File. When the upload is complete, the file name (or path) is displayed and the Add Integration button turns blue (enabled).
Note on Key File: Adding a Key File does not affect the settings of any other Google BigQuery integrations (e.g. in contrast to Oracle Wallet files) and the Key File can be referenced in more than one integration on the same server.
- Enter a Proxy value if you require one (this is an optional field).
Figure 3: Integration Fields
Figure 4: Add Integration
- Click on Add Integration when you're finished. You should see the new integration listed in the dashboard.
Check on Integration Status and Errors: Your integration should display on the dashboard with a green tick icon before going to the next step (Figure 5). If it's showing an error, follow the advice in the message (e.g. an incorrect port number has been entered).
Figure 5: Integration Completed Successfully
Adding a Destination
Now, you'll need to add a Destination, which is the data source for your Writeback table.
- In the VMC menu, click on Writeback Settings, then Destinations and Security. You should see the list of current destinations displayed on the page (Figure 6).
Figure 6: Destinations & Security
- Click Add Destination and you'll create a new entry. Click on the destination ID to add your destination data (Figure 7 and 8). Your destination will already have an ID and configuration generated from the last entry in the table, but you'll be able to change this in the next step.
Figure 7: Destination Fields
Figure 8: Destination Settings
- Enter a destination id, then go to the Writeback Settings panel and select BigQuery as the Destination Type.
Check on Destination ID: Destination ID has to be a unique value, or you won't be allowed to save your changes.
Now you can start to configure your destination. The Writeback Settings panel (Figure 9) holds information about the level of functionality allowed in your Vizlib Writeback Table app.
Figure 9: Writeback Settings
In the Destination Settings panel (Figure 10) enter information about your data source.
Figure 10: Destination Settings
- Click Add Destination to save your destination in the VMC.
Now, you need to go to Vizlib Writeback Table and configure your app to write back to the destination. You'll find these settings in the property panel under Destinations.
- Open your Qlik Sense Hub and find the Vizlib Writeback Table sheet you'd like to work with.
- Open the sheet in Edit mode, then go to Destinations in the property panel.
- Click on Vizlib Server in Pick Destination (Figure 14).
Figure 14: Pick Destination
Working with Vizlib Writeback Table - Data Load Updates
When you've completed the setup, you will need to update your data load script to make sure data is loaded correctly back into the app. Otherwise it will look like the operation isn't completing.
The data load script is part of the Qlik Sense environment, you can find out more about editing the data load script in a Qlik Sense app here.
Tip: Use * to specify all columns in the table should be loaded. This is especially useful when you expect the content of the table to change (e.g. by adding new columns).
When you complete these steps, the table will be loaded back into the app correctly and you can start to use Vizlib Writeback Table to help make the most of your analytics solution.