Properties

On the left of the Tab Editor is an array of properties that configure what is displayed in the label of the selected tab as well as what is displayed when that tab is selected in the main screen. Changes are automatically saved and will be updated in the main screen.

 

Display Name

 

The ‘Display Name’ is the text that will be used for the label of the tab.

 

Icon Selector

 

The ‘Icon Selector’ has the same images as the image selection in the Type Editor and can be searched in the same way. The selected image will be the icon on the tab representing the objects that are to be displayed when it is selected.

 

Filter

 

The ‘Filter’ property determines what objects are displayed in the tab and uses an API query. An example query would be: “deleted=0&type=Box”, which would display all objects that are not deleted and are of the type Box.

 

Hierarchical View

 

The ‘Hierarchical View’ and ‘Hierarchical Structure’ change what related object types are displayed when an object is clicked and expanded in the Grid View. All object types that have a related object to the selected object are displayed in the first expanded view by default.

 

 

This can be changed by text input into the Hierarchical Structure textbox. Each level of the hierarchy is separated by a forward slash and if there are multiple object types for that level they should be separated by a comma. There should be no spaces in the text, as shown in the example below.

 

 

Here the Hierarchy is to first show the Block objects, this first position should be the main object types of the tab. Then the next position which here is the Branch and Volume object types, followed by both the Box type, and finally the Volume. This specific hierarchy results in the following expanded display.

 

 

Note that the selected Volume above has relations but does not expand due to the hierarchy structure as it will not expand past the specified levels.

 

Apply Filter

 

The ‘Apply Filter’ checkbox must be checked to allow the objects contained in the tab to be filtered using the search and filter options at the top of the main screen next to the menus.

 

Show Panel

 

The ‘Show Panel’ dropdown can be used to add a classification box or another additional filter panel at the top of the Object display area, this allows for a more specific filter to be created for this specific tab.

 

API

 

The ‘API’ dropdown is used to select which API should be accessed to find and filter objects, all user made tabs will be Object API calls while the System calls will be pre-configured tabs such as the Capture and Documentum tabs.

Pulse Tab

Overview

The Pulse tab acts as a mission-control dashboard for AgileIM, condensing live metrics, workflow activity, and system health into one workspace. It provides records managers, administrators, and operational leads with immediate situational awareness of ingestion performance, licensing status, and any recent exceptions detected by the platform.

Designed to reduce friction between monitoring and action, Pulse links directly into other tabs—such as Objects, Logs, and Access Requests—so users can quickly follow up on insights surfaced by the dashboard.

---

Accessing the Tab

• Open the Pulse tab from the main navigation ribbon.

• The tab is only visible to users who have been granted access to the Operational Pulse feature in their Display Configuration.

• The dashboard initializes on first open in each session. Once loaded, Pulse begins collecting live data using your saved filters, refresh cadence, and log date selections.

---

Hero Metrics Ribbon

The top ribbon displays four metric cards, each summarizing a key system indicator. These values are refreshed from /api/objects or related service endpoints on load and during scheduled refreshes.

---

License & Service Health Strip

Below the hero ribbon, the Pulse tab displays live operational health indicators:

• License Status – Shows Valid or Expired depending on the signed-in user’s license record.

• License Countdown – Displays the expiration date of the current license. After expiry, the status label turns red and the dashboard marks the system as expired.

• Read-only Indicator – Highlights whether AgileIM is currently operating in read-only mode.

• Service Heartbeat – Indicates Healthy, Stale, or Unknown, based on the latest /api/logs entry timestamp. Log entries older than 5 minutes are flagged as Stale.

• Last Updated Stamp – Notes the completion time of the most recent refresh cycle.

---

Exception Spotlight

The Exception Spotlight lists the most recent log entries fetched from /api/logs. Each record includes:

• Timestamp

• Severity (color-coded)

• Message and detailed payload

Navigating Log Entries

• Use the scroll bar or mouse wheel to browse results.

• When additional entries are available, a Load more button appears at the bottom to retrieve further pages.

• If no logs exist for the selected date, Pulse displays a “No log entries found” message.

Filtering Exceptions by Date

Select a date using the picker to focus the view on specific log activity.

• The Today shortcut instantly returns to the current day’s log stream.

• The selected date also controls the Service Heartbeat indicator, as the most recent retrieved log acts as the heartbeat source.

---

Workflow Burndown

The Workflow Burndown chart visualizes the last seven days of access request outcomes.

• Bars represent Approved and Rejected requests, grouped by modification date.

• Use this chart to detect workload spikes or validate that requests are being processed within acceptable timeframes.

---

Activity Heat Map

The Activity Heat Map highlights system hotspots over the past two weeks.

• Each cell represents updates by repository (or type/source if repository data is unavailable).

• Higher volumes are shaded darker, surfacing the busiest content areas.

• Selecting any cell launches the Objects tab scoped to that repository and date, allowing you to inspect recent changes.

---

Refresh Behavior

The Pulse dashboard updates automatically when Auto Refresh is enabled.

• Default cadence: 60 seconds

• Manual refresh: Use the Refresh button at any time to force an update.

• While refreshing, the button label changes to Refreshing dashboard metrics… and disables interaction until complete.

• Pause halts automatic refreshes temporarily. The control toggles between Pause and Resume.

• When a new refresh begins, any prior pending request is cancelled to prevent overlapping API calls.

---

Error Handling

If the Pulse tab fails to reach one or more API endpoints:

• An Info banner appears at the bottom of the page summarizing the failure.

• The message includes the API name and exception text for diagnostic purposes.

• The dashboard continues to display the most recent successful dataset.

• You can retry immediately using the Refresh button.

---

Customizing the Experience

Administrators can modify Pulse tab behavior through the Tab Editor:

Changes saved in the Tab Editor are stored in the display configuration and applied the next time the Pulse tab is opened.

---

Best Practices

 

• Use Pulse as a daily health check tool to verify ingestion and retention compliance.

• Investigate Awaiting Classification and Expired Retention metrics regularly to maintain data integrity.

• If you notice the Service Heartbeat turning stale, verify background services or connectors are still processing events correctly.

• Keep the Auto Refresh interval at or above 60 seconds to avoid unnecessary load on your API server.

 

User

 

The User option controls which users have access to the tab being edited. To access the list of users, click on the “Users:” text itself, outlined in red below, this will open the list with checkboxes next to each username. To add access check the appropriate box, this will save automatically and update the access.

 

 

 

 

 

 

Enabled

 

The ‘Enabled’ checkbox determines whether the tab is displayed or not in the main screen.