Workflow Dashboard Portlet - Web Parts for Microsoft SharePoint - English - Foundation 22.1 - OnBase - external

Web Parts for Microsoft SharePoint

Platform
OnBase
Product
Web Parts for Microsoft SharePoint
Release
Foundation 22.1
License
Note:

This portlet requires a Business Activity Monitoring license. In addition, users must be granted appropriate rights to life cycles and queues.

  1. Select the life cycle from the Life Cycle drop-down list. The life cycle is selected in the Available Queues list.
  2. Select the queues you want summarized from Available Queues.
    • You can select a single queue or multiple. To select multiple queues, press CTRL as you click each queue's name.

    • To add all the queues in a life cycle, select the life cycle's name.

  3. Click Add.

    If you want to remove a queue or life cycle, click Remove.

  4. Select a queue from Added Queues.
    • By default, any warning and alert values configured for the queue in OnBase Configuration are displayed in the monitoring fields. These values determine when a warning or alert is displayed for a queue.

    • When a warning or alert is triggered, an icon is displayed next to the queue name in the color you specify for warnings or alerts.

  5. In the fields provided, enter the appropriate warning or alert values. Available fields are described in the following table:

    Field

    Description

    Display warning when item count meets or exceeds

    If a queue's document count is greater than or equal to these values, a warning or alert is triggered.

    For example, suppose the warning value is 10 and the alert value is 25. If the queue's document count is 15, a warning is triggered.

    Display alert when item count meets or exceeds

    Display warning when item count is at or below

    If a queue's document count is less than or equal to these values, a warning or alert is triggered.

    For example, suppose the warning value is 10 and the alert value is 5. If the queue's document count is 5, an alert is triggered.

    Display alert when item count is at or below

    Count document as warning when the age of the document meets or exceeds

    Enter the age threshold for documents that should trigger a warning or alert. If a document is the same age or older than the values specified, a warning or alert is triggered. These values can be provided in minutes, hours, days, or weeks.

    Note:

    In the next set of fields, you can configure a tolerance to allow a certain number of documents to match or exceed the value configured here without triggering a warning or alert.

    Count document as alert when the age of the document meets or exceeds

    Display warning when the number of documents older than warning age meets or exceeds

    Enter the maximum number of documents that can match or exceed the document age thresholds without triggering a warning or alert.

    For example, if a queue always contains five documents older than the warning or alert age threshold, and you do not want those documents taken into account when the portlet displays a warning or alert, enter 5 here.

    Display alert when the number of documents older than alert age meets or exceeds

    Select a keyword type that you wish to sum. The sum will be used for a warning and/or alert

    Select the Keyword Type whose combined values should be displayed in the portlet.

    For example, if Amount is selected, the Amount values on all documents in the queue are added together. In the portlet, the Keyword Type and sum are displayed next to the queue's name.

    In the next set of fields, you can configure the sum to trigger a warning or alert when it matches or exceeds a specific value.

    Display a warning when the sum of keywords within queue meet or exceeds

    Enter the sum that should trigger a warning or alert. Each field is limited to 10 characters.

    For example, suppose the warning value is 25000 and the alert value is 50000. If the combined value for the selected Keyword Type is 30000, a warning is triggered.

    Note:

    Floating Point Keyword Types are not supported for Keyword sums. Negative values are also not supported.

    Display an alert when the sum of keywords within queue meet or exceeds

  6. Configure the following display settings:

    Option

    Description

    Normal Color

    Select the color to use for queues that do not trigger a warning or alert.

    Warning Color

    Select the color to use for queues that trigger a warning.

    Alert Color

    Select the color to use for queues that trigger an alert.

    Show only warnings and alerts

    Select to display only queues that trigger a warning or alert.

    Ignore queues with a document count less than

    Select to hide queues with a document count less than the specified value. Enter the value in the field provided.

    Note:

    If this field is set to 0, then this setting is ignored. It will function the same as if the field were blank.

    Show Chart

    Select to display the queues as a chart. The following chart options are available:

    • Bar Chart: Displays queue counts as a horizontal bar graph.

    • Column Chart: Displays queue counts as a vertical bar graph.

  7. Click Save.