System administration dashboard

The system administration dashboard provides metrics about the operation and usage of the system. The elements or tiles in the dashboard displays a consolidated view of the following information:

  • System license
  • Default repository
  • Full text search
  • User sessions
  • Library statistics
  • Courier license

The colour of the tiles depends on the status of the dashboard element:

  • Problem — red
  • Warning — yellow
  • Normal — green
  • No thresholds — blue

The dashboard is located under My FileHold in both the FDA and Web Client. The dashboard can be made viewable by all users by enabling a permission setting. When enabled, the dashboard elements are hyperlinked for a user who belongs to the corresponding system role:

  • System license — Links to licensing page and accessible to System Administrators role only
  • Repository — Links to document repository locations and accessible to System Administrators role only
  • Full text search — Links to full text search status page and accessible to Library Administrators role and above
  • User sessions — Links to users page and accessible to System Administrators role only
  • Library — Links to library level statistics and accessible to Read only role and above
  • Courier license — Links to list of Courier licenses and accessible to System Administrators role only

To access the dashboard

  1. In the FDA or Web Client, sign in as a system administrator. Note that the dashboard can be made viewable by all users by enabling a permission setting.
  2. Go to My FileHold > Dashboard. The following information is displayed:

Element

Description

Status/Threshold

System license

Status - Status of the license.

Activated (Green)

Deactivated (Yellow)

Disabled (Red)

Time Limit- Date when the current license expires. Unlimited indicates that there is no date limit on license

 

Repository

Available space – Percentage of total repository space (not including threshold) divided by the usable repository space (includes threshold) in bytes.

Normal threshold- greater or equal to 5%(Green)

Warning threshold - between 1 to 5% (Yellow)

Problem threshold - less than 1% (Red)

Free space – Percentage of total repository storage space divided by the free storage repository space in bytes.

 

Full text search

Queue size – Number of documents in the full text search queue.

Normal – less than or equal to 2 documents (Green)

Warning – between 2 and 50 documents (Yellow)

Problem – greater than or equal to 50 documents (Red)

Number of words – Total number of words in the full text search index.

 

User sessions

Remaining normal – Percentage of the number of licensed concurrent sessions divided by the actual concurrent sessions in use now. Guaranteed sessions count as in use.

Normal – greater than or equal to 10% (Green)

Warning – between 2% and 10% (Yellow)

Problem – less than or equal to 2% (Red)

In use – Total number of concurrent sessions currently in use. Includes guaranteed sessions.

 

Library

Total documents – Total number of documents in library. Does not include library archive or previous versions.

No threshold (Blue)

Total size – Total size of the documents in the library. Does not include library archive or previous versions.

 

Courier license

Last pack remaining– Percentage of last added Courier pack size divided by the available Courier units

Normal – greater than or equal to 25% (Green)

Warning – between 15% and 25% (Yellow)

Problem – less than 15% (Red)

Remaining units – Number of Courier units available across all license packs. Does not include locked or cancelled packs.

 

To enable the dashboard for all users

  1. In the Web Client, go to Administration Panel > System Configuration > Settings > General.
  2. In the Dashboard Settings area, select the Allow dashboard to be visible to non-administration users check box. When enabled, the dashboard can be seen by all users in their My FileHold area.