Web Administrative Dashboard

Follow

Updated:

Overview

With the Web Administrative Dashboard, you can configure the connection to NetDocuments and monitor synchronization service activity. The Web Administrative Dashboard contains the following tabs:

  • Dashboard  View the synchronization service statuses, the time of the last synchronization, synchronization errors, the number of the backed-up documents, storage file size, documents in storage, cabinets statistics, and log records.
  • Repositories – View the information on each cabinet from the corresponding repository. You can view the content filtering criteria, the time of the last synchronization, synchronization errors, the number of the backed-up documents, the cabinet file size, the number of documents, the synchronization session statistics, and the cabinet log records.
  • Maintenance – View the list of the failed jobs; re-queue or delete the failed jobs.
  • Settings – Configure the necessary settings before monitoring the synchronization service activity.
    • NetDocuments Authentication – Add, edit, or remove credentials to access NetDocuments; add or remove cabinet(s).
    • Administrator Access – Grant or remove administrator access to the application for users.
    • Sync Frequency – Define the cabinet content, users, groups, and lookup table synchronization frequency settings.
    • Cabinets – Configure cabinet storage location and cabinet content filtering criteria.
    • Global Storage Location – Specify the global storage location to mirror the documents.
    • Global Filtering – Configure synchronization options to filter cabinet content.
    • Network Configuration – Set proxy settings to access NetDocuments.
    • SMTP Configuration – Specify SMTP Server and configure the email notification settings.
    • Log Retention Policy – Define the retention period and the number of records to store within the specified duration.

Dashboard

After configuring settings and adding cabinets, you can see the statistics on the Dashboard page.

Cabinets Summary Boxes

The information presented in these boxes sums up the statistics of all the cabinets you have added.

To view the information per each cabinet:

  • Click the Repositories tab, and then click the needed cabinet in the list that appears.
  • Navigate to the Cabinets Statistics section of the Dashboard page, and then click the header of the corresponding cabinet.

In the table below you can find the information about each cabinet box.

Cabinets Summary Description
Sync Service View the following synchronization service statuses: Running, Stopped, Paused, Pausing, or Scheduled.
Server Activity View the time of the last REST request/communication and the name of the host.
Sync Errors View the number of errors that occurred within the last 24 hours. To view the detailed information about sync errors in the Log Records grid, click the  icon next to the number of sync errors.
Documents Synced View the number of documents mirrored within the last 24 hours.
Storage File Size Track the storage file size.
Documents in Storage View the total number of mirrored documents.

Cabinets Statistics

View the summary information in the box per each cabinet. To hide or unhide the cabinet summary boxes, click  icon.

Upon clicking the cabinet name under Cabinets Statistics, you will see the corresponding cabinet’s page under the Repositories tab.

Cabinets Statistics

Description

Sync Status

Track the synchronization status per each cabinet.

Documents

View the number of mirrored documents.

Last Completed Sync

View the following synchronization statuses:

  • Sync Started – A status that shows when a cabinet synchronization has started (the first servermod search has completed). Its status is Running. When the cabinet synchronization is put on a pause, the Running status changes to Paused.
  • Last Completed Sync – A status that shows when a cabinet synchronization has ended (the last servermod search has completed). Its status is Scheduled. When the cabinet synchronization is put on a pause, the Scheduled status changes to Paused.

Note:

Servermod search is a special search that returns all documents from the cabinet where the internal server modification number is greater than the value provided.

Sync Errors

View the number of errors that occurred within the last 24 hours. To view the detailed information about the cabinet sync errors, in the Log Records grid, click the sync errors number.

Log Records

In the Log Records grid, you can find the following information.

Log Records

Description

#

Log record number.

Cabinet ID

Unique ID number assigned to a particular cabinet.

Document ID

Unique ID number assigned to a particular document.

Message

Explanatory message per each log record.

Level

Log filter level. There are the following log filter levels: Trace, Debug, Info, Warn, Error, and Fatal.

Date and Time

Exact date and time for a particular record to occur.

By default, the Log Records grid shows the first 10 log entries. To search for log records within the document ID, cabinet ID, or message, use the log filtering field above the Log Records table. You can type a part of the message, cabinet or document ID to start searching for log entries.

You can also filter log records by selecting the log filter levels from the Levels drop-down list box, and then clicking Search. The following log filter levels are available:

  • Info
  • Warn
  • Error
  • Fatal

To remove the applied filter, click Clear.

Note: You can edit the Levels list by changing the key <add key="LogLevels" value="Info,Warn,Error,Fatal"/> key in the NetDocuments.LDService.SyncService.exe.config configuration file. After modifying the configuration file, you will need to restart the ndMirror service.

To view more items per page, go to the Show entries option at the bottom of the Log Records grid. Select 25, 50, or 100 to display more log records.

In addition, if the Log Records grid is longer than one page, you can navigate between pages using the page navigation arrows in the lower-right corner of the Log Records grid.

Also, you can use the following buttons on the Dashboard page.

Buttons

Description

Sync Now

Trigger the synchronization process manually.

Pause

Stop the synchronization.

Resume

Restart the synchronization.

Help

Click  icon to read the information about ndMirror.

Minimize/Maximize

Click  icon to expand or collapse tabs on the left pane.

Back to Top

Repositories

To view the list of cabinets that belong to the corresponding repositories, navigate to the Repositories tab, and then click the cabinet in the list of repositories that appear.

Note: You will not be able to see the Repositories tab if there is no cabinet to mirror.

To hide or unhide the list with the repositories and cabinets, click  icon. You can view the synchronization status next to the cabinet name in the upper-left corner of the page.

Cabinet Summary Boxes

The information presented in these boxes sums up the statistics of the corresponding cabinet you have added.

Cabinet Summary

Description

Sync Status

Track the synchronization status per each cabinet. You can view the following statuses:

  • Running – A cabinet is being synchronized.
  • Scheduled – A cabinet is scheduled for synchronization with all current active jobs finished.
  • Pausing – A cabinet synchronization is being stopped. You can see the total number of jobs remaining before a pause.
  • Paused – A cabinet synchronization is stopped.
  • Removed Credentials – User credentials for this cabinet are removed without deleting the cabinet content.
  • Deleting – A cabinet with the content has been removed or user credentials have been removed along with the content.

You can also view the following synchronization statuses:

  • Sync Started – A status that shows when a cabinet synchronization has started (the first servermod search has completed). Its status is Running. When the cabinet synchronization is put on a pause, the Running status changes to Paused.
  • Last Completed Sync – A status that shows when a cabinet synchronization has ended (the last servermod search has completed). Its status is Scheduled. When the cabinet synchronization is put on a pause, the Scheduled status changes to Paused.

If there are some failed jobs, you can click the Failed Jobs link next to the synchronization status. You will be redirected to the Maintenance page, and in the Failed Jobs grid, you can see the list of failed jobs for this cabinet.

Documents Synced

View the number of documents mirrored within the last 24 hours.

Sync Errors

View the number of errors that occurred within the last 24 hours. To view the detailed information about the cabinet sync errors, in the Log Records grid, click the  icon next to the number of sync errors.

Documents in Cabinet

View the total number of documents in the cabinet.

Content

View the content synchronization options status. To edit it, click  icon. On the Cabinets page, you can edit the content versioning settings, and then click Save.

Cabinet File Size

Track the file size of the cabinet.

Sync Session

In the Sync Session grid, you can find the following information.

Sync Session

Description

ID

Synchronization session ID number.

Start Time

Date and time when the synchronization session has started.

End Time

Date and time when the synchronization session has ended.

Duration

Duration per each synchronization session event.

Documents Changed

The number of the changed documents.

Documents Removed

The number of the removed documents.

By default, the Sync Session grid shows the first 5 entries. To view more items per page, go to the Show entries option at the bottom of the Sync Session grid.

Select 10, 25, 50, 75, or 100 to display more entries. In addition, if the Sync Session grid is longer than one page, you can navigate between pages using the page navigation arrows in the lower-right corner of the Sync Session grid.

Cabinet Log Records

In the Cabinet Log Records grid, you can find the following information.

Cabinet Log Records

Description

#

Log record number.

Document ID

The unique ID number of a document.

Message

Explanatory message per each log record.

Level

Log filter level. There are the following log filter levels: Trace, Debug, Info, Warn, Error, and Fatal.

Date and Time

Exact date and time for a cabinet log record to occur.

To search for cabinet log records within the document ID or message, use the log filtering field above the Cabinet Log Records table. You can type a part of the message or document ID to start searching for log entries.

You can enter a part of the word to search for cabinet log entries.

You can also filter log records by selecting the log filter levels from the Levels drop-down list box, and then clicking Search.

The following log filter levels are available:

  • Info
  • Warn
  • Error
  • Fatal

To remove an applied filter, click Clear.

Note: You can edit the Levels list by changing the key <add key="LogLevels" value="Info,Warn,Error,Fatal"/> key in the NetDocuments.LDService.SyncService.exe.config configuration file. After modifying the configuration file, you will need to restart the ndMirror service.

By default, the Cabinet Log Records grid shows the first 10 log entries. To view more items per page, go to the Show entries option at the bottom of the Cabinet Log Records grid.

Select 25, 50, or 100 to display more log records. In addition, if the Cabinet Log Records grid is longer than one page, you can navigate between pages using the page navigation arrows in the lower-right corner of the Cabinet Log Records grid.

Also, you can use the following buttons on the Repositories page.

Buttons

Description

Sync Now

Trigger the synchronization process manually.

Pause

Stop the synchronization.

Resume

Restart the synchronization.

Help

Click  icon to read the information about ndMirror.

Minimize/Maximize

Click  icon to expand or collapse tabs on the left pane.

Back to Top

Maintenance

To view the table with the list of the failed jobs and to remove or re-queue them, click the Maintenance tab on the left page of the Web Administrative Dashboard. Failed jobs do not expire. This allows you to re-queue them without any time pressure. You should re-queue or delete jobs manually. The following rules apply to the Clean Up job:

  • If there are many jobs related to synchronization of the same document, only the most recent (with the highest internal server modification number) will remain; the Clean Up job deletes all other jobs.
  • If there are jobs that are of the unknown type, they will be deleted.
  • If a cabinet does not exist in the database, the failed job will be deleted.
  • If a job has failed because of the authentication issue or due to the removal of credentials, the Clean Up job will re-queue the failed synchronization jobs.
  • If there are duplicate jobs, they will also be deleted.
  • If there is the already-synchronized content after the job has failed (another job is synchronized), then the version content job will be deleted.

Failed Jobs

In the Failed Jobs grid, you can find the following information.

Failed Jobs

Description

Check box

To re-queue or delete the failed job, select  next to the job that failed, and then click either the Requeue jobs or Delete selected. You can also select the check box in the column header to select all failed jobs.

ID

View the unique ID number per each failed job.

Cabinet ID

View the ID of a cabinet.

Document ID

View the ID of a document.

Failed

View the date and time when the job has failed.

Job

View the explanatory message per each failed job. To learn more, click the More details link next to the explanatory message. To hide the information, click the Less details link.

To search for failed jobs within the cabinet ID, type the search criteria, and then click Search. To remove an applied filter, click Clear.

To see the list of failed jobs of a cabinet, go to the Repositories tab, and on the Cabinets subtab, click the Failed Jobs link next to the synchronization status of the Sync Status cabinet summary box.

By default, the Failed Jobs grid shows the first 10 entries. To view more items per page, go to the Show entries option at the bottom of the grid. Select 25, 50, or 100 to display more records.

In addition, if the Failed Jobs grid is longer than one page, you can navigate between pages using the page navigation arrows in the lower-right corner of the grid.

Also, you can use the following buttons on the Maintenance page.

Buttons

Description

Requeue Jobs

Select the check box next to the corresponding job to re-queue it.

Delete Jobs

Select the check box next to the corresponding job to delete it.

 Help

Click  icon to read the information about ndMirror.

 Minimize/Maximize

Click  to expand or collapse tabs on the left pane.

Back to Top

Settings

Before monitoring the synchronization service activity, you need to configure all the necessary settings. In the following sections, you can learn how to add or remove NetDocuments credentials or cabinets, manage the administrator access to users, specify the storage location, set synchronization options, define the retention period, configure email notification settings, and read other useful information.

NetDocuments Authentication

To add, edit, or remove NetDocuments credentials, navigate to the Settings tab on the left pane, and then click the NetDocuments Authentication subtab.

The NetDocuments Authentication page

Step 1. Add Credentials

  1. For each host, provide credentials and add one or more cabinets to mirror. The following hosts are available:
  • vault.netvoyage.com – Use for the US data center.
  • eu.netdocuments.com – Use for the European data center.
  • au.netdocuments.com – Use for the Australian data center.
  • preview.netdocuments.com – Use for previewing new functionality before the beta release of NetDocuments.
Note: You need to add the corresponding host and the port as a Trusted Site in Internet Explorer.
  1. Click New Credentials.
  2. Type NetDocuments credentials, and then click Login.
  3. Allow ndMirror to connect to your NetDocuments account.
  4. Copy and paste the authorization code to the corresponding field, and then click Add.

Note: You can add only one user per each host.

In some environments, you may not be able to see the code on the same page, as some authorization methods cannot display it. To display the code on the separate page, click the link in the Note of the Adding credentials to Vault US dialog box, copy, and then paste the code back into the corresponding field.

Step 2. Add Cabinets

  1. To add cabinets, click Add cabinet to sync.
  2. In the Add cabinet to synchronize dialog box:
    1. Select a cabinet to synchronize from the drop-down box.
    2. Specify the individual storage location by clearing the Use global storage location check box, and then enter a new storage location. If you want to use the global storage location that you have specified during the installation, do not clear the check box. For more information, see Global Storage Location.
    3. Set individual content filtering options by clearing the Use global filtering check box, and then specify the needed synchronization options. If you want to use the global filtering settings you have specified during the installation, do not clear the check box. For more information, see Global Filtering.
    4. To apply changes, click Save.
  3. Repeat the steps above for all the cabinets you want to mirror at each host.
  4. To see if the synchronization has already started and to check its progress, navigate to the Dashboard page.
  5. After specifying hosts and adding cabinets to mirror, you can view the summary information in the Users It shows the user number, the hostname, the user name, and the total number of cabinets.
  6. You can edit this information if needed. For this, click Edit, and then do one of the following:
  • Change the current user to another one within the same host.
  • Renew refresh token if it is about to expire.

Note: Next to the user name, you can see the  icon with the corresponding tooltip that appears two weeks before the expiry date. You can still add cabinets to mirror. After renewing your credentials, the cabinet is scheduled for synchronization automatically.

  • Renew credentials that are expired, revoked, invalid, or are issued to another client.

Note: You can see the  icon with the corresponding tooltip next to the user name. After renewing your credentials, you need to resume cabinet synchronization manually.

On the Dashboard page, the cabinet synchronization status switches then to the Stopped status. Also, you will not be able to resume the synchronization. You can also see the corresponding log message in the Log Records grid. The Add cabinet to sync option is not available.

Note: If you have previously specified the SMTP Server and configured the email notification settings, the user will receive the corresponding messages notifying about the need to renew credentials on a daily basis. For more information, see SMTP Configuration.

  1. To delete the provided credentials, click Remove.
  2. In the Remove credential dialog box, do one of the following:
  • If you want to remove the cabinets content from your storage location, select the Remove cabinets content from the file system check box. After removing the provided credentials with the cabinets content, you will no longer see the summary information in the Users grid of the NetDocuments Authentication page and the cabinets statistics on the Dashboard
  • If you want to leave the cabinets content in your storage location, clear the Remove cabinets content from the file system check box. You can see the Removed status in the Users grid of the NetDocuments Authentication You can no longer add cabinets, as this option becomes unavailable. This particular cabinet is shown on the Dashboard page with the Removed status.

When deleting the cabinet, you can see the Deleting status on the Dashboard page.

Back to Top

Administrator Access

To add or remove users or groups that will or will not have the authorization to access and configure ndMirror using the Web Administrative Dashboard, navigate to the Settings tab on the left pane, and then click the Administrator Access subtab.

To add a new user:

  1. Click Add User.
  2. In the Adding Service User dialog box:
    1. Specify the service user name.
    2. From the Identity Type drop-down menu, select either User or Group.
    3. Click Save.

The installer creates the ndMirrorAdministrators group automatically. To remove the ndMirrorAdministrators group, click the Remove link next to it.

Note: The Remove link is not available for the user who is currently logged in to the Web Administrative Dashboard.

Back to Top

Sync Frequency

To define the storage, users and groups, as well as lookup table synchronization frequency settings, navigate to the Settings tab on the left pane, and then click the Sync Frequency subtab.

Storage Sync Frequency

  • Sync Frequency – Specify the synchronization frequency. The default option is Daily.
  • Sync Start Time – Specify the hour when you want to perform synchronization. The default hour is 12:00 A.M.

Note: Server time zone is UTC. Web Administrative Dashboard uses the browser’s local time zone. So, the time converts to the browser’s time zone before it is being displayed, and then converts back to UTC before sending to the server.

  • Max Threads – Type the maximum threads to execute in parallel.

Note: During installation, configure the maximum pool size for the database connection. The recommended value is the number of maximum threads multiplied by three.

Users and Groups Sync Frequency

  • Sync Frequency – Specify the users and groups synchronization frequency. The default option is Daily.
  • Sync Start Time – Specify the hour when you want to perform synchronization. The default hour is 12:00 A.M.

Note: Server time zone is UTC. Web Administrative Dashboard uses the browser’s local time zone. So, the time converts to the browser’s time zone before it is being displayed, and then converts back to UTC before sending to the server.

Lookup Tables Sync Frequency

  • Sync Frequency – Specify the users and groups synchronization frequency. The default option is Daily.
  • Sync Start Time – Specify the hour when you want to perform users and groups synchronization. The default hour is 12:00 A.M.

Note: Server time zone is UTC. Web Administrative Dashboard uses the browser’s local time zone. So, the time converts to the browser’s time zone before it is being displayed, and then converts back to UTC before sending to the server.

Back to Top

Cabinets

To edit the storage location and set filtering criteria for each cabinet, or remove the cabinet, navigate to the Settings tab on the left pane, and then click the Cabinets subtab.

On the Cabinets page, you can see all cabinets you have added on the NetDocuments Authentication page. You can easily navigate from one cabinet to another one by clicking the corresponding tab.

Use Global Storage Location

After adding a cabinet, you can clear the Use global storage location check box, and then specify another storage location for a particular cabinet.

A new storage location is valid for the updated documents only if the server returns the updated documents. For more information, see Global Storage Location.

Use Global Filtering

After adding a cabinet, you can clear the Use global filtering check box, and then specify individual filtering criteria for it.

Filtering criteria apply to the updated documents only if the server returns the updated documents. For more information, see Global Filtering.

Remove a Cabinet

To delete the cabinet, click Remove Cabinet. In the Remove cabinet dialog box that opens, do one of the following:

  • Select the Remove cabinets content from the file system check box, if you want to remove the cabinets content from your storage location.
  • Clear the Remove cabinets content from the file system check box, if you want to leave the cabinets content in your storage location.

To save settings, click Save. In the Save Cabinet Settings, do one of the following:

  • To save new cabinet settings, click Continue.
  • To restore previous cabinet settings, click Discard.

Note: Content that has already been saved to the previous storage location will be preserved. New settings will be applied with the next synchronization.

After removing the credentials but leaving the cabinets content, the global storage location and global filtering options are still editable, though you cannot save the edits, as the Save button is not available. If you delete the last cabinet from the removed credentials, the credentials will be removed as well.

Back to Top

Global Storage Location

To define the global storage location where the mirrored documents will be stored, navigate to the Settings tab on the left pane, and then click the Global Storage Location subtab. You may override the global storage location and specify the individual cabinet location settings by clearing the Use global storage location check box on the Cabinets page of the Web Administrative Dashboard, and then entering a new cabinet storage location.

The path specified during the installation remains the same. You can edit the global storage location by using either UNC paths or drive letters. You can include the following replaceable parameters to your path.

Replaceable parameter Definition
%creator% Use to create a new folder with the document's creator name when new documents are backed up from the server. All new documents will be grouped by their creator’s name.
%cremonth% Use to create a new folder with the name of the document's creation date in the yyyy-mm format when new documents are backed up from the server.
%creyear% Use to create a new folder with the name of the document's creation year when new documents are backed up from the server. All new documents will be grouped within appropriate folders (year).
%cab% Use to create a new folder with the name of the corresponding cabinet when new documents are backed up from the server. All mirrored documents will be stored in the appropriate folder with the cabinet’s name.
%alpha% Use to create a new folder named as the first character of the next folder when new documents are backed up from the server.
For example, if you specify the storage location in the format C:/NetDocuments/ndMirror/%alpha%/%cab%, its local path will be C:/NetDocuments/ndMirror/L/Legal Agreements. The %alpha% replaceable parameter must be used in the middle of the path.
%client%, %project%, %case%, or other. The names of configurable document attributes may also be used as replaceable parameters by surrounding the attribute name with percent signs.

Important: Performance will suffer if a single directory contains more than a few thousand documents. You can use %alpha% described above to help distribute content across an alpha array of directories.

You can now use attribute numbers in storage locations. ndMirror supports two syntaxes of replaceable parameters—1000 plus attribute ID and the attribute ID itself. NetDocuments supports the same name for the custom profile attribute in the same repository.

The folder with the name EMPTY will store the newly-downloaded documents in the following cases:

  • If there is an incorrect parameter
  • If no profile attribute value is assigned to the document
  • If there is an incorrect attribute

The location path is invalid if there are Windows reserved names (CON, PRN, AUX, NUL, COM1-9, LPT1-9), or one of these characters: < > : " / \ | ? *). If you specify the invalid path, the corresponding message appears notifying about the failure, and then the previous correct value restores.

Back to Top

Global Filtering

To set global filtering options, navigate to the Settings tab on the left pane, and then click the Global Filtering subtab.

With the global and cabinet-level filtering, you can:

  • Choose to synchronize either document or email content, or both.
  • Set a date to start synchronization.

The following content is always synchronized:

  • Lookup tables/Profile-based security/MVP/Linked user
  • User and group lists
  • Cabinet default access lists/Cabinet info/Profile attributes
  • Document metadata, ACLs

The Include all document content and the Include all email content check boxes are selected by default.

Note: If you do not want to synchronize either document or email content (.msg and .eml), you can clear the corresponding check box.

Under the Include all document content and the Include all email content check boxes, the following options are available:

  • Official versions only – Select this option to synchronize only official content versions.
  • All versions – Select this option to synchronize all content versions. This option is selected by default.

If you want to synchronize either document or email content within a certain period of time, do the following:

  1. Under Exclude the following, select the Do not synchronize content older than check box.
  2. To set the date in the calendar, click the date picker icon or type the date in the following format: mm/dd/yyyy.

Important: This is a one-time setting, if you need to change this afterward, you need to resynchronize a cabinet.

  1. Click Save.

To specify the cabinet filtering options, do the following:

  1. Go to the Cabinets subtab of the Settings
  2. Select the cabinet where you want to specify individual filtering options.
  3. Clear the Use global filtering check box, modify synchronization options, and then click Save.

Back to Top

Network Configuration

To configure proxy settings to access NetDocuments, navigate to the Settings tab on the left pane, and then click the Network Configuration subtab. Under Proxy, you can select one of the following options:

  • No Proxy
  • System Proxy (this option is selected by default)
  • HTTP Proxy

If you select HTTP proxy, specify the host and the port numbers in the corresponding text boxes.

To save the selected proxy setting, click Save.

Back to Top

SMTP Configuration

To specify SMTP Server and configure email notification settings, navigate to the Settings tab on the left pane, and then click the SMTP Configuration subtab.

If you have not selected the Enable email notifications check box in the SMTP Configuration dialog box while installing the application, you can configure these settings on this page. After selecting the Enable Email Notifications check box, you need to specify the SMTP Server settings and configure email message notifications.

SMTP Server Settings

  1. In the SMTP Server field, define the email server used by the ndMirror application.
  2. In the SMTP Port field, specify the SMTP port for the specified SMTP Server.
  3. To establish the Secure Sockets Layer (SSL) connection, select the Use SSL check box.
  4. After selecting the SMTP Server requires authentication check box, you can select one of the following options:
  • Use the default credentials of the currently logged on user
  • Log in using credentials. After selecting the Log in using credentials option, type the login name and password into the corresponding fields.
  1. Under the Mail Message Configuration section, in the From field, type the email address that the recipients of the email notification see as the sender.
  2. In the To field, provide the email address of the email notification recipients. If you want to add several email addresses, separate each one with a comma.
  3. Under the Email Notifications section, in the Start Time field, set the specific hour to send email notifications to the recipients. The default hour is 12:00 A.M.

Note: Server time zone is UTC. Web Administrative Dashboard uses the browser’s local time zone. So, the time converts to the browser’s time zone before it is being displayed, and then converts back to UTC before sending to the server.

  1. To save changes, click Save. To check the SMTP configuration settings, you can send the test email message.
  2. If your refresh token is about to expire or credentials are already expired, revoked, invalid, or are issued to another client, the user will receive the corresponding messages notifying about the need to renew credentials on a daily basis.
  3. After configuring SMTP Server and specifying the email notification settings, you will also receive the Daily Statistics email with the synchronization activity details.

Back to Top

Log Retention Policy

To specify synchronization sessions and logs retention period, navigate to the Settings tab on the left pane, and then click the Log Retention Policy subtab.

Sync Sessions

  • Retention Period – Select for how many days synchronization sessions will be stored. The period ranges from one day to one year.
  • Records amount – Select for how many synchronization sessions will be stored. You can store up to 100,000 records.

Note: By default, you can store synchronization sessions for two weeks, and the default amount of records is 1,000. You can change the default values, and then click Save.

  • Sync Sessions Cleanup Start Time (24-hour format) – Set the hour when synchronization sessions will be cleaned up.

Logs

  • Retention Period – Select for how many days logs will be stored. The period ranges from one day to one year.
  • Records amount – Select for how many synchronization sessions will be stored. You can store up to 10,000,000 records.

Note: By default, you can store logs for two weeks, and the amount of records is 100,000. You can change the default values, and then click Save.

  • Logs Sessions Cleanup Start Time (24-hour format) – Set the hour when logs will be cleaned up.

Log retention policies work on a per cabinet basis. This guarantees that logs will be not only for one cabinet but for all. There is a separate group for log records without a cabinet. So, logs are grouped by cabinet ID (one group per each cabinet, and one for non-cabinet messages), and then policies are applied to each group.

Back to Top

Was this article helpful?
0 out of 0 found this helpful
Powered by Zendesk