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 can integrate with different data output types, and we're going to use SQL in this example. You can find a full list of supported products in the Introduction 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
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 to start.
- Installations - Vizlib Writeback Table and Vizlib Server should be installed before you start. We have online tutorials for installing Vizlib Server and Vizlib Products to help you (Vizlib Products are all installed in the same way, so while the tutorial uses Vizlib Library, it can also be used for Vizlib Writeback Table).
Note: If you haven't installed any Vizlib products before, please install the product (Vizlib Writeback Table) then install Vizlib Server. If you have already installed Vizlib Server, please perform a restart after installing Vizlib Writeback Table.
- 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.
- Database name, password, host name, port number - to enter when you're adding the integration.
- Table name - to configure the destination type.
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). The symbol indicates a successful setup, and indicates a setup error.
Figure 1: VMC Dashboard Integrations, with Integrations and System Settings >Integrations highlighted.
- Go to System Settings, then click Integrations (see Figure 1) 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 and 4).
- Select sql as the Type, select a database Dialect for your connection (postgres in this example) 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 postgres-2 here.
- In the SQL settings panel, there are 2 ways you can enter values.
- Use the Database, Username, Password, Host and Port (Protocol is currently optional).
- Use a Connection URI.
Note: The username and password you enter here is for your database connection. You won't be able to use your Windows username or password.
We've included both methods here, with a numbered reference to show you where the values should go, but you'll only need to use one.
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: Your integration should display the green tick icon before going to the next step. If it's showing an error, follow the advice in the message (Figure 5).
Figure 5: Integration Completed Successfully
Adding a Destination
Now, you'll need to add a Destination, which is the location where the data for your Writeback table is stored.
- 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
- 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 which is 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: Adding a Destination
- Enter a destination id, then go to the Writeback Settings panel and select SQL as the type.
Check: 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 SQL Destination Settings panel (Figure 10), enter information about your data source.
Figure 10: SQL Destination Settings
Figure 13: Access & Security
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
Figure 15: Server Settings
Working with Vizlib Writeback Table - Data Load Updates
Now 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.