Logging
Archive Shuttle performs logging for activities in two locations, both of which can be useful for troubleshooting purposes. Logging can be configured to record data at a number of different levels: Info, Debug, Trace, Warn, Error, and Fatal.
Module-level logging
Each module records log information at the INFO level though that can be overridden if required. When the modules are installed, the location of these log files can be chosen. By default, the location is inside the program files folder in a subfolder called Logs.
|
|
NOTE: When the module logs (or default core log from System Configuration) for particular modules are set to a different logging level than 'Info', the logging level is set back to 'Info' after a specific period of time (default 12 hours). |
The current location for the log files can be seen on the Modules page in the Archive Shuttle Admin Interface.
In addition to logging data locally, each module also transmits this log information to the Archive Shuttle Core, using a Web Service.
Each module can log extended information about item-level migration details; for example, on successful migration of an item an EV Import module may log the Archive Shuttle reference for an item, the source item ID and the target item ID.
Core-level logging
The Archive Shuttle Core logs information as well as the modules. The location where the log files will be written can be configured during the installation of the Archive Shuttle Core. In addition, to the core operations the Archive Shuttle Core will also log user interface actions to a file on the Archive Shuttle Core.
The Archive Shuttle Core also receives logging from each module. These files have .Client in their filename. This means it is not normally necessary to get log files from the servers where modules are installed.
Logging levels
There are several logging levels in log files, that vary in severity.
Solution
Here are listed all allowed logging levels in order from most severe to least severe along with explanation and example when to use it:
Fatal
·The highest log level, only the most important information is logged
·Minimum entries in the log file
Error
·High log level, application crashes/exceptions are logged
·Average number of entries in the log file
Warn
·High log level, incorrect behavior but the application can continue
·Average number of entries in the log file
Info
·Default log level, logging contains all above, used for normal behavior like item export
·Average number of entries in the log file
Debug
·Low log level, executed queries, user authenticated, session expired, etc
·Average number of entries in the log file
Trace
·The lowest log level, everything is logged, begin method X, end method X, etc.
·Maximal number of entries in the log file
Reporting
|
|
NOTE: The reports are in PDF format. |
Each report can be configured to email one or more recipients, and is controlled via separate schedules, or, optionally triggered immediately using the Send Now button.
|
|
NOTE: In order to send out reports it is necessary to use the System Configuration page and enter information in the SMTP Settings page. |
This is controlled on the Scheduled Reports screen in the Archive Shuttle User Interface.
Link statistics
This page shows an overview of all containers that have been switched to target and shows the status in the Stage 2 workflow.
|
|
NOTE: Additional columns are available if the Advanced view is enabled (under the Views tab) though this makes the user interface slower if there are a large number of mappings. |
The following basic information about each container is visible in the grid view:
·Source User Name
·Group
·Source Container Type
·Link (for the source)
·Target User Name
·Group
·Target Container Type
·Link (for the target)
·Command
The current command which is being ran by Archive Shuttle.
·Status: The status of the command
·Error: Information relating to errors
·Date/Time
·Next Command: The next command to be executed by Archive Shuttle
·Finished
Actions to be performed on the Workflow Status page
These actions can be performed on this page:
Refresh: Refreshes the tables data.
Columns: Allows the selection of additional data columns, which might then be used to select groups of containers.
Reset: Resets the grid to the default columns, and removes any filters.
Load: Loads a saved filter/page-layout.
Save: Saves the current filter/page-layout.
Add to Group: One or more containers can be added to an existing or new group. This group membership can then be used for filtering and batching of users for migration.
Reset Workflow Status: Can be used to retry the current command.
Skip: Skip the current command in the workflow.
Pause: Pause the workflow.
Resume: Continue from a paused workflow.
Change Policy: Allows a new policy to be chosen and the workflow restarted with that policy.
Export to .pdf, .xls, .xlsx, .csv: Allow data to be exported to several formats.