Archive Shuttle 11.0 - Administration Guide

Enable logging

In this article we’ll discover information about log files and logging that can be performed by Archive Shuttle.

Logging Overview

All log files are centralised on the core server under the logging directory specified during installation.

It is rare to need to access module servers in order to review log files.

Logs are:

·Generated per module

·Roll over automatically (10 rollover files are kept)

·Default to ‘info’ level reporting

Important Log Files

Several important log files include:

WEBUI.TXT

This is the log file for all user interface interactions

ArchiveShuttle.WebServicesLog.txt

This is the web services log file. It contains server side information about module to core communication. It can show which tasks or commands were queued and executed.

ArchiveShuttle.Service.Log.txt

This contains information about execution of database updates, and scheduled tasks.

Module core logs

These have a *.ModuleName.Core.txt suffix. They contain communication between the core and applicable module.

Module client logs

These have a *.ModuleName.Client.txt suffix.

Logging Levels

Module logging levels are controlled from the user interface. Go to Configuration > Modules > Select the desired module and choose the ‘Set Log Level’ button.  Changes take place almost instantly, there is no need for modules to be restarted.

Core logging level is set via System Configuration > General

Trace level logging is the most detailed.

Overview of a log file

Key of terms

1.Date/time in UTC

2.Process ID

3.Hostname

4.Thread ID

5.Logging level

6.Function

7.Log entry

>> Implies the start of a request

<< Implies the completion of a request

Summary log file entries

Some log entries provide a summary of the modules current activity. This is often the visible report of a system’s health.

Entries can contain a lot of information to aid in troubleshooting:

·Current performance

·Resource conumption

·Current processing statistics

·Summary of actions taken

·Duration of actions taken

Here is an example:

Errors, warning, exceptions

Log levels are used to clearly identify exceptions. All warnings are logged at WARN logging level. All exceptions are ERROR or FATAL log levels.

How to identify what log to look in

Many issues are highly reproducible. Try to identify the conditions resulting in an issue. Being able to reproduce an issue on demand helps issue resolution and investigation.

Determining which log file to look into often comes with experience.

·webui – user interface errors/issues

·services – database upgrades and scheduled task execution

·*client* – problems with an actual module

·*core* – problems with retrieving and processing of commands

How to adjust logging levels

Go to Configuration > Modules, then select the desired module and choose the ‘Set Log Level’ button.  Changes take place almost instantly and there is no need for modules to be restarted.

Core logging level is set via System Configuration > General.

Identifying the point of failure

At the highest level, Archive Shuttle recommends to:

·Enable trace level logging on the Core (if appropriate) and modules which may be involved in the issue

·Try to repeat the activity of action which resulted in an error (for example retrying failed items, or retrying a Stage 2 workflow command)

·Search the log files for ERROR

·Check the thread ID of that error message and search in the logs for everything that the thread has done around about the time of the failure.

Shared mailbox over quota rollover

If a mailbox is over quota, a new one can be created automatically and any remaining data for this transformation is ingested into the new mailbox.

The new mailbox has a _1 suffix added, eg John.doe_1@domain.com. Additional rollovers for this container will be _2, _3 and so on.

There is a button in the user interface so that an operator can perform this action:

This is an additional possibility in a migration. Previously an over quota shared mailbox could be converted to a normal mailbox, but that consumes an additional Microsoft license. By creating a new, shared mailbox additional licenses are not consumed. It is also shown to be faster ingesting into this type of mailbox compared with moving data from a primary mailbox to a secondary/personal archive mailbox.

Re-exporting a PST for a certain user

When migrating to PST, you might encounter corrupt PST files and need to re-export items for a certain user. Here’s how to do it:

1.On the Stage 1 (Sync Data) page, expand the line that contains JC PST mappings.

2.Right-click on the Primary Smtp Address of the mapping that contains PSTs you want to view/re-import and select Show list of PSTs. A window opens showing associated PSTs.

3.Select the desired item(s) and click the Enable For Re-Export button.

Additional information

In step 2 above, when the window opens and displays the user’s PSTs, you’ll notice the window’s URL includes the user, item database ID, and container mapping ID.

Limitations

A maximum of 10 PST files are processed (deleted/reset) for a Journal Explosion re-export. If needed, you can re-export remaining files after the first batch of 10 are ingested.

Adding Sender-Recipient SMTP addresses

Manually add an active Sender-Recipient SMTP address

1.Go to Configuration.

2.Select Journal Transformation User Management page.

3.From the Select Journal Transformation Name drop down, select All or the required Journal Transformation Container Mapping.

4.Click Add toolbar button.

5.In the Enable Users for Journal Transformation pop out window, select the required active Sender-Recipient SMTP and click Save & Close button.

The selected Sender-Recipient SMTP address is now enabled for use in Journal Transformation and is added to the User Mappings screen.

Add Sender-Recipient SMTP address using .csv file

A .csv file can be used to add users for Journal Transformation.

The .csv file requires the format to be: OriginalSMTPAddress,PrimarySMTPAddress(optional)

1.Go to Configuration

2.Select the ‘Journal Transformation User Management’ page

3.From the ‘Select Journal Transformation Name’ drop down, select ‘All’ or the required Journal Transformation Container Mapping

4.Click Import from CSV toolbar button

5.Click Browse and select your .csv file

6.Ensure the option, ‘Update existing user mappings’ is NOT selected

7.Click Import

The selected Sender-Recipient SMTP address is now enabled for use in Journal Transformation and is added to the ‘User Mappings’ screen.

Manually enable an active address for import

To manually enable a Sender-Recipient SMTP address:

1.In the ‘User Mappings’ screen, Select the required Sender-Recipient SMTP address

2.Ensure the selected Sender-Recipient SMTP address status is:

a.Has Mailbox = Yes

b.Is Ready for Import = Ready

c.Enabled for Import = No

d.Is Deleted = No

3.Then click the ‘Enable for Import’ toolbar button

4.Ensure the ‘Enabled for Import’ status changes to ‘Yes’ (Enabled) for the selected Sender-Recipient SMTP address

Monitor progress of an ‘Enabled for Import’ Sender-Recipient SMTP address

To monitor the progress of the Enabled Sender-Recipient SMTP address Journal Transformation mapping:

1.Go to Manage & Operations > Stage 1

2.Select the required Journal Transformation container mapping

3.Expand the Journal Transformation container mapping to view the enabled Sender-Recipient SMTP sub-containers.

Troubleshooting

Sender-Recipient SMTP address does not appear

If the required Sender-Recipient SMTP does not appear in the ‘Enable Users for Journal Transformation’ pop out window when you attempt to add a user for Journal Transformation.

You will need to confirm the SMTP address is correct and that the Stage1 Journal Transformation mapping has completed exporting/identifying sender-recipient SMTP addresses. As only exploded sender-recipient SMTP addresses appear.

If you are adding a Sender-Recipient SMTP using csv file, ensure the file is formatted correctly and contains valid Sender-Recipient SMTP address.

If the export has completed for all Journal Transformation Container Mapping. Further investigation of the logs and database will be required by Archive Shuttle.

CSV Import Fails

Check the WebUI log for the tenant and you will see the UI activity, example below:

2020-02-10 14:41:43Z|11405|chs-as-01| 53|TRACE|                                 ReadUsersFromFile|File [E:\WebHotel\cola\UI\App_data\UploadTemp\2d4adde5-a376-4664-88a3-0d34e9cb8711.csv] was processed, [1] lines were read with total of [0] user mappings