Content Script Volume Import Tool¶
Major change in version 3.2.0
Since Module Suite version 3.2.0, there have been major changes in the way the content of the Content Script Volume is managed.
Module Suite's components behaviour and functionalities can be modified and extended by manipulating the content of the Content Script Volume (a Content Server’s Volume created when installing the Content Script module).
Prior to Module Suite version 3.2, all Content Script Volume resources had to be necessarily imported in the Volume, with no exceptions. Starting with version 3.2, Module Suite is capable of using certain resources (CSFormSnippets, CSScriptSnippets, CSPageSnippets) directly from the Module installation folders on the filesystem, without the strict need to "materialize" them in the Content Script Volume. This approach allows to avoid the overhead of importing certain resources if the administrator does not plan to customize them, but it optionally allows to "materialize" them in the Volume if needed.
This new approach allows to significantly reduce the effort required in validating the content of the Content Script Volume and solving conflicts in case of updates, since if the resources have not been materialized, the update will be transparent for the users (the library in the new Module version will replace the old one).
As a result of this new approach, the CSVolume administration tools have been reorganized and updated.
All "system critical" resources are now automatically imported (and updated) though a Volume Library management utility. This currently includes:
- CSPageSnippets (folder structure only)
- CSFormSnippets (folder structure only)
Optional "feature activation" resources can be boostrapped on-demand through a dedicated set of utilities ("Module Suite Features"). This will include reources such as:
The following resources are not imported by default, as the system is capable of using them from the original library on the filesystem :
Nevertheless, it will be possible to "materialize" them locally using the Volume Conflict Resolution utility.
This section will describe the available tools designed to simplify the management of the content of the Content Script Volume, handling new imports, updates and conflicts resolution.
Accessing the Content Script Volume Import Tool¶
In order to access the Content Script Volume Import Tool:
As the system Admin user, open the Content Server Administration pages.
Locate the AnswerModules Administration section. Within this section, open the Content Script Volume Import tool.
Volume Library utility¶
One of the main features of the Content Script Volume Import Tool is to assist the OTCS system administrator in the management of the core Volume Library. This library includes all Content Script Volume elements that are critical for the execution of Module Suite. As part of the initial installation process, the Volume Library should always be imported in the Content Script Volume.
When opening the Content Script Volume Import Tool, the "Volume Library" section will occasionally show up as the very first section in the page.
On initial installation, an alert message will notify the administrator that the Volume Library has not been imported yet.
In case of subsequent upgrades, the Content Script Volume Import Tool should always be checked to verify the presence of changes to be imported. In case of pending updates, the Library Update section will show, together with an "import" button.
Once complete, the Volume Library import will prompt the user to refresh the page.
If the "Volume Library" section not shown, the Volume Library is up-to-date and no action should be taken.
Module Suite Features utilities¶
The Content Script Volume Import Tool is also used to control the root Content Script Volume elements required to activate certain functionalities of the Module Suite.
For each feature, a dedicated section of the tool will allow to automatically bootstrap the related Content Script Volume content. A table with the following values is shown:
- Folder : The corresponding CSVolume root folder required to activate this feature
- Description : Additional usage details of the folder
- Imported (y/n) : A status flag showing wether the resource has been already imported in the system
Additionally, each section will include an import button.
When using the import, the specific folders (and the initial content, if necessary) will be automatically set up on the system. If the import function is used for resources that were already imported, any missing resource will be initialized, but existing resources will not be touched.
At the present moment, the following features can be activated:
Manages all resources necessary to use the Content Script Callbacks (synchronous and asynchronous).
Manages all resources necessary to use the Content Script extension for Classic UI features.
Manages the resources necessary to create Content Script column datasources.
Manages all resources necessary to set up Smart UI overrides using the Smart Pages capabilities.
Imports the available Content Script Tools (e.g. BWF Studio, PDF Viewer, ...)
Sets up the resources required to use the "xECM for Everything" capabilties.
Volume's Conflicts Resolution utility¶
Since Content Script Volume objects are accessible and customizable by the Module Suite administrators and developers, it is possible to generate conflicts between the customized versions and the new/updated versions included in Module Suite upgrade packages.
The Content Script Volume Import Tool includes a utility that lets the administrators:
- identify and resolve any version conflicts in the Content Script Volume.
- materialize certain resources in the Content Script Volume in order to allow for local customization.
Upon opening the page, the tool will automatically trigger the analysis of all the objects present within the Content Script Volume. This operation might require some time to complete, depending on the content of the Content Script Volume.
Once the analysis is complete, the utility will present with a tree view of all relevant Content Script Volume resources.
The following resources will always be present, regardless of their status:
All other containers will only be present in case of conflicts with the corresponding filesystem resources.
For each resource, depending on the status, the administrator will have a choice to handle the conflict.
For CSFormSnippets, CSScriptSnippets, and CSPageSnippets that have not been materialized on the system, the utility will show a "Not overridden" status. Importing the object will result in the object being created in the system. This will override the original library object when that specific resource is used.
For CSFormSnippets, CSScriptSnippets, and CSPageSnippets that have been materialized on the system, the utility will show any conflicting situation (for example, if the version on the system is different from the one in the original library). It is up to the administrators to solve or ignore these conflicts.
For all other resources (which the system is not capable of using if not imported in the Content Script Volume), that have not been imported, the utility will show a notice that the object is available to be imported.
For all other resources (which the system is not capable of using if not imported in the Content Script Volume), that have been imported, the utility will show any conflict status (newer version available for import, conflict, etc..). It is up to the administrators to solve or ignore these conflicts.
The utility presents two distinct options to import the selected objects.
Import option: this will result in the materialization of the selected resource(s) in the Content Script Volume. In case the resource was already present in the Volume, it is skipped and the local changes are not reverted.
Override and update : this will result in the materialization of the selected resources(s), regardless of the presence of a local version in the Content Script Volume. This operation will override any changes performed locally.