ArchiveWeb Setup
ArchiveWeb is configured and ready for use right after installation. No user action is required. However, should the need arise, default configuration can be adjusted in Archive Manager Configuration tool.
The Archive Manager Configuration tool is available on the ArchiveWeb server under <installdir>/Program Files (x86)/Common Files/PAM/PAMConfig/PamConfig.exe. Its ArchiveWeb tab list available configuration options. (For more information on the Multi-factor authentication tab see the section Multi-factor authentication (MFA).)
Specify the properties as described below:
Tenant service location - URL for MultiTenantWS web service
AM for Exchange service - URL for ExchangePAMWS web service if Archive Manager for Exchange is installed.
AM for Files service - URL for FilePAMWebService web service if Archive Manager for Files is installed.
Search service location - URL for PamSearch web service
Search cache folder - user's temporary storage folder to store e.g. messages downloaded from Exchange server for preview functionality
Export folder - folder where exported files (PST export, ZIP export) are stored (download link points to this folder)
Export folder auto-cleanup [days] - files older than the specified number of days will be deleted from the Export folder.
Export one version per document during PST export - indicates whether to export one version per document during PST export
Auditing server name & port - machine where auditing component is installed
Log-off time - time in minutes to log off when inactive
Show offline server caption - select this option to show [OFFLINE] suffix for decommissioned servers in servers' list if Archive Manager for Files is installed.
Use cache for views - select this option to cache all grid source data after first load so that operations on grid that do not change the data will be performed quicker.
Hide location server - unchecked by default; indicating whether to hide Location Server Name from user's mailbox displayed in Mailboxes tree-view; if not checked, Location Server Name will be displayed as a suffix to user's email, e.g. administrator@[VMMVC5]
Check trusted domains - select this option to check trusted domains and read information from trusted relationships. When unchecked the entire login process can be accelerated because no additional reads (from trusted domains) are performed
Use Single Sign-On - select this option to activate the Single Sign-On feature for ArchiveWeb login.
Use Multi-factor authentication - select this option to activate the fields in the Multi-factor authentication Configuration window. See Multi-factor Authentication for more details.
Multi-factor Authentication
ArchiveWeb supports multi-factor authentication (MFA) for O365 user accounts. Setting up MFA is a two-step process:
1.Create a new application in the Microsoft Entra admin center.
2.Configure ArchiveWeb with the Archive Manager Configuration tool.
Create a new application in the Microsoft Entra admin center
ArchiveWeb requires a specific Microsoft Entra ID registration to be created that is used to return an authentication token back to the ArchiveWeb after a user is authenticated via Microsoft portal.
1.Login to the Microsoft Entra admin center (https://entra.microsoft.com/) using your administrator credentials. If your account gives you access to more than one tenant, select your account in the top right corner, and set your portal session to the Microsoft Entra ID tenant that you want.
2.From the navigation pane, click Identity > Applications > App registrations and then click New registration. The Register an Application page opens.
3.Provide the following information on this page as described below:
a.Name - Enter a meaningful application name that will be displayed to users. For example, Archive Manager ArchiveWeb.
b.Supported account types - Select the account type you would like your application to support that best meets your company policy.
c.Redirect URI - from the application type dropdown select Web. In the URI field enter the ArchiveWeb URI where the user will be redirected after multi-factor authentication (eg. https://<fullservername>/ArchiveWeb/Login)
|
|
NOTE: The HTTPS protocol is required for MFA to work with O365. To ensure the HTTPS can be used by the ArchiveWeb server, follow the steps below; 1.On the ArchiveWeb server, open the IIS Management Console. 2.Expand the server node and then expand the Sites node. 3.Select Default Web Site and right-click to open the context menu. Then select Edit Bindings. The Site Bindings window opens. 4.Click Add. The Add Site Bindings window opens. 5.Select https from the Type dropdown and fill in the other details as required. 6.Click OK to save the https site binding. 7.Restart the IIS service from the server node and then close the IIS Management console. |
4.Click Register.
5.Your application is registered. Microsoft Entra ID assigns a unique application (client) ID to your application, and the application's Overview page opens.
6.From the navigation pane, click Branding & properties. Enter the URLs that your organization may use for the different branding artifacts.
7.From the navigation menu, click Authentication and verify that the Redirect URI parameters are as expected. If you revise any values, remember to click Save.
8.From the navigation menu, click Certificates & Secrets. In the Client secrets section click New client secret. The Add a client secret page opens.
9.Enter values as described below:
a.Description - enter a meaningful description. For example, ArchiveWeb Client Secret.
b.Expires - set the expiry term that best meets your company policy.
10.Click Add. the client secret is displayed on the Certificates & Secrets page.
|
|
IMPORTANT: Copy and save the client secret in a safe place. It will not be available when you navigate away from this portal. |
11.From the navigation menu, click API Permissions. and then click Add a permission. The Request API permissions page appears.
12.From the Microsoft APIs category, scroll down to the Supported legacy APIs section and select Microsoft Graph.
13.From the Request API permissions page for Microsoft Graph that appears, select Delegated permissions.
14.Click Add permission.
15.From the navigation menu, click Expose an API. In the Scopes defined section, click Add a scope. The Add a scope page opens.
Microsoft Entra ID generates an Application ID URI automatically. It is a globally unique URI used to identify this web API. It is the prefix for scopes and in access tokens,and is also referred to as an identifier URI. You can keep this value or specify a unique value in the same format.
|
|
IMPORTANT: Copy and save this value in a safe place. |
16.Click Save and continue. The Add a scope page displays more options.
17.Click Add scope to complete the registration.
Configure ArchiveWeb with the Archive Manager Configuration tool
1.Open the Archive Manager Configuration tool from C:\Program Files (x86)\Common Files\PAM\PAMConfig\PamConfig.exe
2.From the sidebar, click ArchiveWeb.
3.Click the ArchiveWeb tab. The ArchiveWeb Configuration page appears.
4.Select Use Multi-factor Authentication to activate the fields in the Multi-factor authentication Configuration window.
5.Click the Multi-factor authentication tab. The Multi-factor authentication Configuration window appears.
6.Enter the field values as described below:
a.Organization Name in Office365 - enter the name of your O365 organization URL. For example, democorp.onmicrosoft.com
b.Client ID - enter the Client Id that you saved from the Microsoft Entra ID application registration steps.
c.Client Secret - enter the Client Secret that you saved from the Microsoft Entra ID application registration steps.
7.Click Apply.
|
|
IMPORTANT: When at least one user in an organization has MFA set, the Organization, Client ID and Client Secret should be set in Multi-factor authentication tab as a readiness exercise. If only a few users in your organization have MFA activated, the Use Multi-factor Authentication checkbox should remain unchecked. The settings in the Multi-factor authentication tab will persist when the Use Multi-factor Authentication checkbox is unchecked. The users who have MFA activated will be prompted to enter the credentials (user email and password) and then they will be redirected to the Microsoft site where the user has to authenticate again. After a successful authentication by Microsoft, the user will be redirected back to ArchiveWeb. When all users accounts in an organization have MFA activated, the Use Multi-factor Authentication checkbox can be selected. This will allow ArchiveWeb to use multi-factor authentication for all users that log in to ArchiveWeb. Users will be prompted to enter only the login email address and they will be redirected to the Microsoft login form to finish the login process. |
Search Scopes
The Archive Manager Search installer installs the Search and Post Processing services which allows a user to search and run specific tasks on each archived message. Search scopes must be configured to allow searching for archived emails with ArchiveWeb. A search scope is a specified Archive server.
|
|
NOTE: If you install Archive Manager for Exchange with the Express or Advanced installation option, the Search Scope is automatically configured for you. If you install Archive Manager for Exchange manually, you must configure the Search Scope manually. |
Steps to add Search scopes
1.From the feature panel on the left in the Archive Manager Configuration wizard, click Search and select the Search scopes tab.
2.Click Add. The Add Search scope window opens.
Enter the information and described below:
a.Server name - name of the primary Archive Manager for Exchange server (eg. AMXSERVER) where the role will be set to Archive server.
b.Type - Select Exchange Archive Server.
3.Click Next. The Set up the Archive database connection window opens.
4.If the database already exists, click Import. Otherwise click Configure to setup the Archive Manager for Exchange database. The Database Connection Wizard opens.
5.Select either Microsoft SQL Server or Oracle and click Next. The database connection information window opens for the selected database.
For Microsoft SQL Server
a.Server name - name of the SQL server (eg. AMXDB)
b.Initial catalog - name of the Archive Manager for Files database (e.g. MAMEXCH which is the default name of the Archive Manager for Files database)
c.Schema name - name of the SQL Schema (e.g. dbo)
d.Authentication authentication type used for the database. Choose either Windows authentication or SQL Server authentication
e.Username - database login username if SQL Server authentication is the selected as the authentication mode.
f.Password - password of the database user if SQL Server authentication is the selected as the authentication mode.
For Oracle
a.Oracle net name - net service name that describes the network address of the HSM database in your tnsnames.ora file (eg. AMXDB)
b.Schema - name of the Archive Manager for Files database (e.g. MAMEXCH which is the default name of the Archive Manager for Files database)
c.Username - database login username
d.Password - password of the database user
6.Click Next and then click Yes on the confirmation dialog that opens.
7.If the database connection is setup successfully, the configuration confirmation window opens.
8.Click Finish to close the Database Connection wizard. The Set up the Archive database connection window reopens.
9.Click Next. The Setup the Index database connection window opens.
10.If the database already exists, click Import. Otherwise click Configure to setup the Index database connection. The Database Connection Wizard opens.
11.Select either Microsoft SQL Server or Oracle and click Next. The database connection information window opens for the selected database.
For Microsoft SQL Server
g.Server name - name of the SQL server (eg. AMXDB)
h.Initial catalog - name of the Archive Manager for Files database (e.g. MAMINDEX which is the default name of the Archive Manager for Files database)
i.Schema name - name of the SQL Schema (e.g. dbo)
j.Authentication authentication type used for the database. Choose either Windows authentication or SQL Server authentication
k.Username - database login username if SQL Server authentication is the selected as the authentication mode.
l.Password - password of the database user if SQL Server authentication is the selected as the authentication mode.
For Oracle
e.Oracle net name - net service name that describes the network address of the HSM database in your tnsnames.ora file (eg. AMXDB)
f.Schema - name of the Archive Manager for Files database (e.g. MAMEXCH which is the default name of the Archive Manager for Files database)
g.Username - database login username
h.Password - password of the database user
12.Click Next and then click Yes on the confirmation dialog that opens.
13.If the database connection is setup successfully, the configuration confirmation window opens.
14.Click Finish to close the Database Connection wizard. The Setup the Index database connection window opens.
1.If the database already exists, click Import. Otherwise click Configure to setup the Index database connection. The Database Connection Wizard opens.
2.Select either Microsoft SQL Server or Oracle and click Next. The database connection information window opens for the selected database.
For Microsoft SQL Server
a.Server name - name of the SQL server (eg. AMXDB)
b.Initial catalog - name of the Archive Manager for Files database (e.g. MAMINDEX which is the default name of the Archive Manager for Files database)
c.Schema name - name of the SQL Schema (e.g. dbo)
d.Authentication authentication type used for the database. Choose either Windows authentication or SQL Server authentication
e.Username - database login username if SQL Server authentication is the selected as the authentication mode.
f.Password - password of the database user if SQL Server authentication is the selected as the authentication mode.
For Oracle
a.Oracle net name - net service name that describes the network address of the HSM database in your tnsnames.ora file (eg. AMXDB)
b.Schema - name of the Archive Manager for Files database (e.g. MAMINDEX which is the default name of the Archive Manager for Files database)
c.Username - database login username
d.Password - password of the database user
3.Click Next and then click Yes on the confirmation dialog that opens.
4.If the database connection is setup successfully, the configuration confirmation window opens.
5.Click Finish to close the Database Connection wizard. The Set up the Index database connection window reopens.
15.Click Next. The Index directory window opens.
16.Click Browse to select or create a folder for the search index and then click Next. The Apply the configuration changes confirmation window opens.
17.Click Finish. The Archive server for Server type = Exchange Archive is added to the Manage search scopes section. Click the icon for the Archive server that you added, and verify the information in the Configuration summary section.
|
|
NOTE: Search scopes for Archive Manager for Exchange and Archive Manager for Files are separate entities based on the Server type. |
18.If the Restart service window opens, click Yes to restart the MAM service. Otherwise you must start the windows service manually.
19.Close the Archive Manager Configuration wizard.
Post-processing
The Archive Manager Search installer installs the Search and Post Processing services which allows a user to search and run specific tasks on each archived message. Post processing scopes must be configured to allow specific tasks from search results in ArchiveWeb. A Post Processing scope is a specified Archive server.
|
|
NOTE: If you install Archive Manager for Exchange with the Express or Advanced installation option, Post Processing scopes are automatically configured for you. If you install Archive Manager for Exchange manually, you must configure the Post Processing scopes manually. |
In this topic:
·Steps to add Post Processing scopes
·Steps to install the SearchIndexPluginRange
·Steps to specify a bookmark date
Steps to add Post Processing scopes
1.From the feature panel on the left in the Archive Manager Configuration wizard, click Search and select the Search scopes tab.
2.Click Add. The Add Post processing scope window opens.
3.Enter the information and described below:
·Server name - specify the name of the Archive Manager for Exchange server.
·Type - select Exchange Archive server
4.Click OK.
To revise the configuration of an existing Post Processing scope, select the scope and click Configure. Then edit the information and click OK.
Post processing plugins
Besides Subject and From text boxes in the Exchange Archive search, you can search the To field for items sent to specific recipient. To activate searching the To field, a post processing plugin must be installed and configured. This plugin indexes mail recipients.
·Steps to install the SearchIndexPluginRange
Steps to install the SearchIndexPluginRange
1.Open Archive Manager Configuration tool from <installdir>\ Program Files (x86) \Common Files \ PAM \ PAMConfig \ PamConfig.exe.
2.Open the Post Processing tab.
3.Open the Post Processing scopes tab.
4.Right-click on the scope and from the context menu select Configure.
5.Click Add.
6.Installed plugins will be loaded in the Add Plugin pop-up window. Select PostProcessPAMsearchIndex.SearchIndexPluginRange from the dropdown box and click Add.
7.The plugin is listed in the Plugins list in Configuration tab. By default it is active.
When a new plugin is added to the Plugins list, there are no mailboxes specified by default. You must specify the mailboxes as well as the Bookmark Date. If no mailboxes are selected then post processing will not process any archived emails and attachments.
1.From the Plugins list, select the PostProcessPAMsearchIndex.SearchIndexPluginRange plugin. Right-click the plugin and click Properties from the context menu .
2.In the Plugin properties window set the properties as described below.
The plugin properties are as follows;
a.Plugin is active - select this checkbox to activate the plugin.
b.Apply for selected mailboxes - the plugin scope is determined by the mailboxes that you can select when you click Mailboxes.
i.In the Plugin mailboxes window click Add to add mailboxes.
ii.In the Select mailbox enter the name of a mailbox in the text box to search for the mailbox. Double-click the mailbox in the list to transfer it to the Selected objects section. In the Selected objects section you can check which users you have selected.
iii.Confirm by clicking OK. The selected mailboxes appear in the Plugin mailboxes window.
iv.Click Close.
c.Apply for all mailboxes - the plugin scope is across all mailboxes.
d.Start Date - indicates the date when email indexing starts. Click the dropdown to set the date from the calendar popup.
e.End Date - indicates the date when email indexing ends. Click the dropdown to set the date from the calendar popup.
f.Bookmark Date - indicates the most recent index date and time. Click the dropdown to set the date from the calendar popup. When the plugin is installed, the Bookmark Date should be the same as the Start Date. If you want to index old email items, set the Start Date and the Bookmark Date to the same date in the past from where you would want the indexing to begin.
g.Reindex keywords - select this checkbox if keywords should be re-indexed within the specified data range.
a.Reindex recipients - select this checkbox if email recipeinets should be re-indexed within the specified data range.
Steps to specify a bookmark date
1.Right-click the plugin and click Set Bookmark from the context menu.
2.In the Enter bookmark window specify the time. Click OK.
|
|
NOTE: The bookmark date is displayed in the Plugins list in Configuration tab. If you reset the bookmark date, the change takes effect immediately, and there is no need to deactivate and activate the plugin again. If you remove a plugin by using the Remove button, it will stop completely without remembering where it stopped. If you then load that plugin again, you must configure it again. |