The Vizlib Management Console (VMC) is an administrative tool which Enterprise customers can use to configure and monitor Vizlib products and their components. This article contains information of the settings available in the VMC, with each section containing an overview and a diagram for reference. In each section, you'll find links to articles which contain more details on how to work with that particular group of settings (e.g. setting up a security rule).
TABLE OF CONTENTS
- Security Rules
- Logs Browsers
- User Roles
- System Settings
- Teamwork Settings
- Writeback Settings
- Finance Settings
- Support Portal / Documentation
Note on Tooltip Help: You can find out more information about VMC functions by clicking , and more about VMC fields by clicking .
Note on Server Restarts: There is a Restart Server button in the VMC, but a restart is only required for changes to the Server, Qlik Sense, and Logs pages in System Settings, and Update License on the Dashboard. Any changes to streams, integrations and destinations are saved to the server instantly. This helps minimise disruption where integrations support multiple destinations, as users can continue working while updates are made.
The VMC opens on the Dashboard screen when you log in. The dashboard has a navigation menu on the left, with information about the server installation.
A system dashboard, showing the status for Integrations and connectivity with Qlik Sense. The symbol indicates a successful setup, and indicates a setup error.
License details for your Vizlib subscriptions, which you can amend by clicking on Update License.
In the top right corner, there are 2 buttons - clicking will restart the server and clicking the user button opens a list of options.
Click Refresh Permissions to commit any changes to user permissions.
The Change password option is only available for Root Admin users.
Log out will end the session.
Figure 1 shows an example dashboard and the change password screen.
Figure 1: VMC Dashboard
The Security Rules screen (Figure 2) contains a list of any security rules you’ve added (e.g. rules governing user permissions). You can click on an existing rule to make changes, and to add a security rule, click the New Rule button. To filter the security rules page (e.g. to find a group of rules with similar names or properties) you can enter free text for the Description or Resource Id or select from the Resource Type or Access Level dropdowns. Figure 2 shows a filtered result for Teamwork Stream resources with an Admin access level.
Figure 2: Security Rules
If you'd like to read more about creating and managing security rules please see the article here.
The Logs Browsers screen contains a list of system-generated logs (Figure 3). The screen contains dropdowns you can use to filter log information.
Date - Select the date you want to view.
Log Level - Select the log status level you want to view, choosing from All log levels (default), Error, Warning, Info, Debug, and Silly.
Figure 3: Logs Browsers
User Roles shows you the list of user accounts which can access the VMC (Figure 4). You can view the user Name, the Directory allocated to the account, the User ID, and the Role (Root Admin, Admin, VMC Admin or Content Admin). You can find more information on VMC User Roles here, and a full reference of user role permissions here.
Figure 4: User Roles
The System Settings menu (Figure 5) contains system configuration details.
Server holds the configuration information for Vizlib Server, including the server protocol, port number and URL custom property. You can also import and export the Vizlib Server configuration between different instances in the Server Configuration panel.
Note: You must click Save Changes before leaving the page, or your changes will be lost.
Qlik Sense stores Qlik Sense configuration details. It and allows you to define multi-node connectivity, using Add QS Node, and also set the port numbers for each of the Qlik Sense services (you can use tooltip to find out the full service name if you need it). You can read more about multi-node connectivity in our article here.
Note: You must click Save Changes before leaving the page, or your changes will be lost.
Integrations lists the external resources used by the system, including the database connection (SQL and Oracle), the SMTP server, the Slack bot token, and the MS Teams webhook URL. You can add or delete integrations on this page. Integrations with errors are indicated by , and if you hover on the icon, the tool. You must click Add Integration or Update Integration to save the changes.
Default Settings (version 3.1.0+) controls the default settings for any VMC Resources you create (integration, destination, workspace, stream), and is only available to Root Admin and Admin users. By default, any new resources will be Private, but you can choose to make them Public and/or Secure (access is controlled via a security rule). You can also select a specific Virtual Proxy to use for VMC user logins via Qlik Sense.
Logs stores configuration information for system logs, where you can select the output type (console or file), logging level and define a file path.
Figure 5: System Settings
The Teamwork Settings menu (Figure 6) contains configuration settings for Vizlib Teamwork. You can read more about Vizlib Teamwork here.
Streams and Security contains database settings, custom properties and teamwork stream configurations. Secure Streams are marked with , and you can open the user list for a stream by clicking .
Add a new Teamwork stream with Add Stream or edit an existing stream.
Enable sharing options for comments (email, Slack, Teams).
Secure the stream connection to limit access (Secure Stream).
Set user access levels (User Access).
Enable secure hierarchy groups (Secure Hierarchy Groups).
Set a timeframe for editing comments (Editing Timeframe).
Enable / disable mentions for users in the Teamwork stream (Enable mentions).
Enable / disable adding message content to a mention (Attach message to notification). This setting is enabled by default, but can be disabled for security reasons.
Users displays a list of users. You can override custom usernames stored in Qlik Sense, edit an account by clicking the username, or add a new user (Add User). To receive mentions from a Teamwork stream, the Email Attribute field should be populated with a value which contains a valid email address (Figure 7). Note: If the VMC is installed successfully, users are automatically added to this list if they open an app or sheet where Vizlib Collaboration products are enabled (Vizlib Teamwork, Vizlib Writeback Table, Vizlib Input Form).
Figure 7: Email Attribute
Workspaces holds Workspace settings, You can find out more information on workspace settings here.
Workflows holds Workflow settings, where you can add a new workflow or edit an existing one, and also check User Roles. For full instructions on adding or editing workflows see our article here.
Comments Browser and Archiving contains a search function for any comments stored in the database, and you can click on Export to csv to save your results to a file. You can choose which columns you want to export (e.g. add the App Name and Sheet Name) and define a mechanism to archive or delete comments made outside a defined time interval (e.g. over 6 months old).
Figure 6: Teamwork Settings
The Writeback Settings menu contains configuration settings used for Vizlib Writeback Table. You can read more about Vizlib Writeback Table here.
- Destinations and Security contains settings for Writeback Destinations. Destinations are the endpoints for saving user data in Vizlib Writeback table, with destination types QVD/CSV/TXT (data file), REST (REST API), Oracle and SQL (choose from Postgres, MsSQL, MySQL or SQLite). You can add a new destination by clicking Add Destination, edit an existing destination, duplicate an existing destination by clicking or remove a destination with . Each Destinations panel is presented in 4 sections.
- Writeback Settings lets you choose the destination type (see above), the writeback operation type, reload options and the app name.
- There are 4 versions of the Destination Settings panel, 1 for each destination type. You can select data relating to the file, the REST API or the database you're using.
- Fields Validation helps you validate the structure and content of fields written to the writeback table.
- Locking manages the locking settings for the destination, allowing you to lock the destination when you start to input data, and unlock the table when you have finished. You can also choose to add the destination to a Lock Group.
- Access & Security allows you to secure the destination connection to limit access by enabling Secure Stream set User Access levels, enabling an audit trail (see Writeback Audit section below) and an extra lock on the app during data inputs (the default lock is triggered when a writeback operation starts).
Figure 8 shows an example SQL Destination type in the VMC. You can find more information on destination types in our article here.
Figure 8: Writeback Settings
- Clicking Lock Groups contains settings for any lock groups used by your destinations (Figure 9). You'll see a list of any lock groups you've created when the page opens. You can add your own lock group by clicking Add Lock Group and entering the name and the access level. Lock groups are very useful when a data source is being used by several destinations at once, as you're able to lock and unlock every destination in the group. You can find out more about lock groups here.
Figure 9: Lock Groups
- Clicking Writeback Audit displays information from the audit trail of each destination with the setting enabled (see Writeback Settings above). The Search function looks for matches when you type in some text, highlighting the results (Figure 10). You can also search by Destination or by entering a start and end date.
- When you click on a row, a popup will open, with shading to highlight any changes. Updated values are displayed in green, with the previous values shaded light red. If a symbol hasn't changed in both old and new versions e.g. # the shading will be much lighter. If a row has been deleted it will be shaded entirely in red.
- While all information about changes is stored, an audit trail will only display a maximum of 15 changes for a destination.
- Tutorial: You can watch a step by step video tutorial on setting up an audit trail here.
- Coming Soon! As you can see at the end of the video below, we're working on an Export function for Writeback Audit just now.
Figure 10: Writeback Audit