Altair® Panopticon

 

Workbook Repository

Previous versions of the server stored workbook files in the Workbooks subdirectory of the application data directory (i.e., c:\vizserverdata\Workbooks), and older versions of those workbooks in the Archive subdirectory (i.e., c:\vizserverdata\Archive). Starting with the 2020.0 release, workbooks are now stored in a version tracking repository, located in the .repository subdirectory (i.e., c:\vizserverdata\.repository).

The new workbook repository tracks changes to workbooks, folders, and permissions. It also makes it possible for multiple servers to synchronize their repositories, so you only have to make changes to a workbook on one node in a server cluster, and it will automatically propagate to the other servers.

When synchronizing nodes in a cluster, designate a leader server. The rest will be followers and should point to the leader. If conflicting changes are made to the same workbook on different nodes at the same time, the leader’s changes always win.

The first time you start the 2020.0 server, it will initialize an empty repository in the application data directory. If you are upgrading an existing install, and reuse the same application data folder, it will automatically import all workbooks from the old Workbooks subdirectory. Once this is done, it will not use the Workbooks subdirectory anymore.

If for some reason there are issues with the old workbook files and they cannot be imported, the cause will be written to the server log. The import also logs the number of workbooks that are successfully imported, so it is recommended to check it after the import.

The following properties control the repository behavior:

 

 

Property

Workbook repository

Attribute

repository.communication.secret

Description

When creating a cluster, all of the servers must have the same value set in this property. The value can be any random hard password (no specific requirements) that will be used by the servers to encrypt and decrypt a secret that enables them to create a valid token used to authenticate calls to the repository services.

Default Value

Property

Workbook repository

Attribute

repository.import.archived.workbooks

Description

Set to true if you want the initial workbook import (first time the server is started with an old application data directory) to also import the workbook history from the Archive subdirectory. Set to false to only import the current versions of the workbooks.

Default Value

true

Property

Workbook repository

Attribute

repository.remote.url

Description

In a cluster, set this on the follower nodes to point to the leader node. It should be the base URL of the Panopticon web application, e.g., http://leader_server:8080/panopticon.

Default Value

 

Property

Workbook repository

Attribute

repository.pack.enabled

Description

The repository tracks all changes to all workbooks. If you have a very large number of workbooks, or have kept the repository for a very long time, the sheer number of files inside the .repository subdirectory could cause the repository to become slower. Set this property to true to have the repository pack all the files into fewer larger ones for faster access.

IMPORTANT: If you must use this property, then ensure that repository.import.archived.workbooks is set to false, otherwise the import will be very slow. To make this import faster, you can first import and then enable the pack.

Default Value

false