Package Versioning

Manual Import

A version of Weasis can be manually imported into ViewerHub in the tab “Package”.

The file to be imported must have a name in this format: “weasis-native xxx.zip”.

This file corresponds to one of the Weasis release versions produced here: https://github.com/nroduit/Weasis/releases/

Import process

The import process of a Weasis version follows these different steps:

• Retrieval of the “weasis-native xxx.zip” file, decompression and storage of the version’s resources/bundles in minio/S3.
• Compression of the version’s “resources” folder into a zip file (necessary for Weasis) and storage on S3.
• Update on S3 of the Weasis version compatibility file if the imported version is more recent.
• Cache update regarding Weasis version compatibility mapping.
• Loading of the version’s properties into the database.

Nexus Import

Currently not available, will be implemented later.

Remove Weasis package version

In order to delete a version of Weasis, it is necessary to select the version to delete, then right-click and confirm the deletion.

Deleting a version whose “launch config” is “default” will result in the deletion of all versions linked to this “default”.

Group-specific versions

It is possible to create a version of Weasis that will only be launched for certain groups of users or hosts.

In the “package” view, click on “Create new group config”.

Then select the desired Weasis version (package version + launch config) and the new group to associate then press “Create”.

The new version will thus be displayed in the list of versions already present.

If the user or host belongs to the group, the previously created configuration will be used to launch Weasis.

Configuring version properties

ViewerHub allows to modify the properties of versions on-the-fly.

To modify a property, it is necessary to open a version and double-click on the property to modify.

For example to modify the name of the viewer for a package/launch config/group:

• modification of the property “weasis.name”

• launching the viewer after modification: the label corresponds to the modified property

Internationalization

Import

It is possible to import the translations that will be used by Weasis depending on the version of Weasis launched and the correspondence of this version with the compatibility file.

The name of the file to import must have the format “weasis-i18n-dist-X.X.X-SNAPSHOT.zip”.

The translation zip files to import are present at this address: https://github.com/nroduit/weasis-i18n

In ViewerHub, management of translation packages is located in the “Translation” tab.

The import will decompress the zip file and load the translation resources into the MinIO S3.

Removal

Deleting a translation version is done by selecting the version and right-clicking on this version and then confirming the deletion.

Package Qualifier

Default values

When calling the ViewerHub, Weasis will send in an Http header the version installed on the client workstation (User-Agent header).

If the corresponding Weasis version has not been installed on ViewerHub and/or when no qualifier has been associated with the user/host/group making the request, a version and/or a qualifier are used by default to retrieve the resources to launch Weasis.

These default values are defined in the config-server in the application-package.yml file.

Qualifier mapping to user/host/group

In order to be able to test specific versions or to be able to launch a version of Weasis different from the default one for a group, it is possible to specify the version to launch for a user/host/group by mapping a particular qualifier.

In order to use this feature:

• the weasis-native.zip file containing the specific version must be loaded into ViewerHub and associated with a group.
• the “qualifier” property must be defined in the launch_prefered table and must be of type “qualifier”.

• the mapping of the qualifier to use this version must be done at the launch table level for the target/launch_config/launch_preferred association.
  If this mapping is not done, the default qualifier defined in ViewerHub configuration will be taken into account (see previous paragraph).
  In order to do this mapping, you must define a configuration in the launch table associating the desired group/launch_config, the previous launch_preferred “qualifier” and for the “selection” column specify the qualifier to launch.

Version Compatibility

Compatibility file

A compatibility file named “version-compatibility.json” is present in each Weasis release
(in the weasis-native.zip file => bin-dist => weasis => conf).

This file contains the mapping between the release version (“release-version”) and the minimum version of Weasis that should be installed on the client workstation (“minimal-version”).

This file also indicates which translation version should be used (“i18n-version”).

Cache

When uploading a new version in ViewerHub or when starting the application (in case the compatibility file is already present in the S3), ViewerHub will construct the different possible combinations from the compatibility file between the versions installed in ViewerHub and the Weasis releases.

These combinations will be stored in a redis cache. This cache is currently refreshed every 24 hours.

So when a client will launch Weasis via ViewerHub, it will directly know which version, i18n, resources to use when launching Weasis on the user computer.

Minio/S3

By importing a new version of Weasis into ViewerHub, if the compatibility file is more recent, ViewerHub will replace the compatibility file present on the S3. This compatibility file will be renamed on S3 “mapping-minimal-version.json”

In order to compare if this mapping file is more recent, ViewerHub will compare the version number of the latest release.

Groups

To easily manage your computer network, ViewerHub allows the creation and association of user or host groups.

Creation

Users, hosts, user groups and host groups are represented by ‘targets’.

There are 4 types of target:

• user
• host
• user group
• host group

To create a target, go to the ‘association’ menu and define the type of target to be created.

Group association

To associate a target with a group or a host/user, look for the desired target in the target name section and add the group or host/user in the ‘Belongs to/Member of’ section.

It is possible to associate several users with a user group and several hosts with a host group.

It is not possible to mix up the association between a user and a host group or a host in a user group.