This section of the user interface lists all the Archive Shuttle modules and on which server they have been installed. The display also shows whether a module is enabled or not and the current logging level for the module and Core.
Modules have to be enabled in order for them to receive work to do.
The modules are monitored every 5 minutes to check if they are still running, or have failed. If they have failed an attempt will be made to restart a module, by issuing a command to the Admin Module on the affected machine. By default Archive Shuttle will try 5 times to restart a module. Every retry to start the module is by default one more minute apart from the previous attempt for a maximum of 10 minutes. The status of the module will be on the System Health page.
Actions to be performed on the Modules page
- Enable: Enable selected modules
- Disable: Disable selected modules
- Configure: Most modules allow specific configuration relating to parallelism and other performance/load related elements to be configured. For example you could configure one EV Export module to have archive and item parallelism of 10 and 2 respectively, and another EV Export module could have archive and item parallelism of 15 and 1 respectively.
It’s also possible to have these configuration changes scheduled to be effective at particular times of day and days of the week.
The data grid showing module information also includes columns which show which configuration is active, and the time left before the next change in configuration.
- Start: Start the selected module immediately
- Stop: Send a command to the selected module to stop processing
- Restart: Send a command to the selected module to restart
- Delete: Remove a module. It may be necessary to choose a replacement.
- Enable performance statistics: Enables the collection of performance statistics for a module
- Disable performance statistics: Disables the collection of performance statistics for a module
- Set Schedule: Define a schedule for when the selected module should run
- Update: Send a command to the selected module to perform an automatic update to the latest version.
Note: For the “Update” command to work correctly, there are additional steps that should be performed on the Archive Shuttle Core Server. These are covered later in this section
- Download: Allows you to download the module MSI package.
- Set Log Level: Allow the logging level of a module (or set of modules) to be changed in real-time. Increasing the logging level may help with providing more detail to Quadrotech Support for troubleshooting.
- Refresh: Refreshes the module grid
Note: Disabled modules still transmit backlog data to the Core Web Service. These modules do not get new work to perform.
Setting a Schedule for a Module
Each of the Archive Shuttle modules can have a schedule defined for when the module should execute tasks. To set a schedule, follow these steps:
- Navigate to the “Modules” page.
- Select a Module by clicking on the checkbox next to the name of the module
- Click on “Set Schedule” in the navigation bar
Note: When setting a schedule remember to click on “Save” in the “Set Schedule” window to commit the schedule to the database.
The following screenshot shows a module schedule where the module is configured to run 24×7:
The following screenshot shows a module schedule where the module is configured to run just on Saturday and Sunday:
Update Installed Modules
During a complex migration there may be many modules installed on different servers throughout an environment. Archive Shuttle has a method for simplifying the process of updating the modules when new versions become available. In order to update modules from the Archive Shuttle Web Interface, follow these steps:
- Download the new MSI file, the file required will have a name formatted in this manner: ArchiveShuttleModulesInstall-X.x.x.xxxxx
- Copy the MSI file to the following folder on the server that hosts the Archive Shuttle Web Service:
- Navigate to the “Modules” page in the Archive Shuttle User Interface.
- Select one or more modules, and click “Update”.
The MSI file will then be transferred to the server that was selected, and then the MSI file will be executed in order to update the installation.
Restart Enterprise Vault Services
From the ‘Services’ tab it is possible to restart some or all of the Enterprise Vault services on a particular Enterprise Vault server. You can also direct the command to a particular Archive Shuttle Admin Service.