> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.itential.com/itential-cloud/admin-essentials/navigate/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itential.com/_mcp/server. # Navigate Admin Essentials > An overview of the Admin Essentials interface, including navigation, user permissions, current operations, usage statistics, device counts, message banners, and tags. **Admin Essentials** is used to view, configure, and modify all admin-level properties across Itential Platform. The various features in Admin Essentials are controlled by authorization settings. Therefore, some users will not have access to all features referenced here; however, an administrator can grant access as necessary. The main elements of Admin Essentials are referenced in the table below. Different versions of Itential Platform may have minor variations in the Admin Essentials interface. ![](/_fern-img/e795a37f4c7c4159a5e655e082b48d61175d90541e8730a3ffc06470ad98cb01.webp) | **Label** | **UI Element** | **Function** | | :-------: | :----------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | 1 | Icon Bar | Icons for completing quick actions from anywhere within Admin Essentials. These icons (from left to right) are: Create, Import, Home, Search, [Current Operations](#current-operations), and [Tags](#tags). | | 2 | [Collection Lists](#viewing-collections) | Open the accordion menus in the sidebar to display a list of items in a corresponding collection. Users can search for items within a collection. The accordion menus that appear in the UI are based on user permissions. | | 3 | Quick Start | Contains a series of links to important functions within Admin Essentials such as viewing active jobs and running tasks, setting authorization levels, and downloading [Itential Platform Blueprints](/itential-platform/resources/get-support#how-do-i-generate-a-blueprint-for-my-environment). | | 4 | Server Information | Displays the current server ID, version information, and server uptime. The `Build` listed in the Server Information is Itential's internal build number, which differs from the product release version communicated to customers (Release version 6.0.0 will typically show 2025.X.Y here). | | 5 | [Usage Statistics](#usage-statistics) | Displays the memory and CPU usage of Core and Itential Platform. | | 6 | [Manage Banner](#message-banners-in-itential-platform) | Click this button to create a message banner that displays on specified pages within Itential Platform. | | 7 | [Device Counts](#device-counts) | Displays the number of devices (adapter endpoints) connected to the platform. Historical device count information is available through a downloadable CSV file. | | 8 | Start Up Configuration | Displays the startup configuration of Workflow Engine, indicating whether the Task Worker and Job Worker will run at server startup based on local and central configurations. | | 9 | Alerts | Alerts only display if a service is stopped or connectivity is down. If there are no alerts, this card does not show. | ## Icon bar ### Current Operations The **Quick Start** card on the Admin Essentials homepage contains a link to **Current Operations**, where you can see all running jobs and tasks through the **Active Jobs** and **Running Tasks** dialog views, respectively. Available views, features, and interactions in the Current Operations interface can be limited based on user permissions. ### Tags The **Tags** application from the **Quick Start** area of Admin Essentials makes workflows, forms, and other items search-enabled. You can create or edit tags, as well as add tags to a specific collection. Available views, features, and interactions in the Tags application can be limited based on user permissions. The Tags interface is straightforward to navigate: #### Open Tags Click **Tags** from the **Quick Start** area of the Admin Essentials welcome page to open the application. The **Tags** dialog displays a list of items in table view. #### Create a tag Click the **"+"** icon in the upper-right corner to create a new tag. #### Search for a tag Use the **search bar** to locate a tag from the collection list. Enter one or more characters corresponding to the tag name. A filtered list of results will return. #### Update or delete a tag Click the **menu button** (stacked dots) at the end of each row to display the menu to update or delete a tag. #### Sort tags Use the **Sort** feature to display tag names in ascending or descending order. #### Close Once all actions are complete, click **Close** at the bottom to close the dialog. ![](/_fern-img/7e2729d86d0d4637af83ca8d15796e58d60be952a1925430526f7506fde480b5.webp)![](/_fern-img/234da0eb4369513b88a849eb158565c14c5d3588f0c38896b8f9c53702f58302.webp)![](/_fern-img/f133e330613077a4422cb4f533599ddd65739171562be4679edc89ba87260eb9.webp) #### Creating, editing, and deleting tags To create a new tag: #### Open the create dialog Click the **"+"** icon in the upper-right corner of the Tags dialog. #### Fill in details Provide a unique tag name and a brief description. #### Save Click the **Create** button. A pop-up message displays in the upper-right corner to confirm the new tag was successfully created. ![](/_fern-img/17fa940d0311dd1b77627104d4bd7765755a2ac09d3b442f53aaa2e8d209c70b.webp) To edit a tag: #### Open the edit dialog Click the menu button to the right of a chosen tag and click the pencil icon. #### Make changes Provide the desired edits to the tag (i.e., name, description). #### Save Click the **Update** button. The Tags table immediately refreshes to reflect the edits. ![](/_fern-img/07afadb547ca660b600e0612f231eaaaf6b1bb46d21a42e682116c58905acaf5.webp) To delete a tag: #### Open the delete dialog Click the menu button to the right of a chosen tag and click the trashcan icon. A confirmation prompt displays. #### Confirm deletion Click **Delete** to confirm. A success notification displays to indicate the tag was deleted. ![](/_fern-img/2ba350810f519e739f249dfbe3aebc4d41dd8f956ed7622741dfc44822374cde.webp) #### Adding tags to collections Tags can currently be added to the following collections: | Collection | Description | | :------------ | :------------------------------------------------------------------------------- | | Workflow | Use the automation settings in a workflow to add a tag. | | Template | For both Analytic and Command Templates, use the template settings to add a tag. | | Golden Config | View the config metadata to add a tag. | To add a tag to a Workflow, Template, or Golden Config: #### Create or open an item Create a new workflow, template, or golden config and save it — or open an existing one. #### Open Settings Click the menu (stacked dots) icon in the upper-right of the canvas and click **View Metadata** to open the **Settings** dialog. #### Add the tag Search for the desired tag name and add it. #### Save Click **Save** to update. ![](/_fern-img/6e32b1715658e044d4ac3a5f6d7c076e41ceb6b8802e429161bc705617696067.webp) ## Collection lists The **Collection** dialog displays all items in a collection as cards with services information relevant to the collection item. ![](/_fern-img/d267aaad461d2ac7f092d3a435bccba5f0f17285d819a1a269d5c503801b67a4.webp) | **Label** | **UI Element** | **Function** | | :-------: | :---------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 1 | Collection Toggle | Allows you to switch to a different collection view. | | 2 | Icon Bar | Icons (from left to right) for completing quick actions: Refresh, Select All, Export, Delete. | | 3 | Search and Filter | Use the search bar to search for items in the collection based on filter settings. Filter results using the icon to the left of the search bar. | | 4 | Sort and Sort By | Use the icon to sort items in the collection based on the selected value in the dropdown. | | 5 | Select | Click to select the item for deletion or export. | | 6 | Delete | Icon to delete the selected item. | | 7 | Paging | Shows the total number of discrete pages and enables paging through a collection. Also used to set how many items to show if there are too many in a collection. | ### Active Jobs From the **Active Jobs** view on the **Current Operations** page, you can see all active running jobs. When this view is open, the page refreshes automatically every 60 seconds. ![](/_fern-img/882f3692f642b7680c1fb6f4b5ac4fd28b07c10adb9aa3ff8d2cd4112a09d515.webp) | **Label** | **UI Element** | **Function** | | :-------: | :------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 1 | View Control | Switch between **Active Jobs** or **Running Tasks** views. | | 2 | Task Worker Switch | Use this toggle to suspend or restart tasks in the Workflow Engine. | | 3 | Refresh Server Info | Use this button to manually refresh the current server identification number. | | 4 | Search and Filter | Use the search bar to search for items based on filter settings. Search results can be filtered by Name or Id using the icon to the left of the search bar. | | 5 | Sort and Sort By | Use the icon to sort items in the collection based on the selected value in the dropdown. | | 6 | Job Name | Click the job name on the card to open the **Job Details** page. | | 7 | Job Actions | Hover over the icon to show a job action (i.e., pause or cancel). | | 8 | Paging | Shows the total number of discrete pages and enables paging through a collection. Also used to set how many items to show if there are too many in a collection. | If there are running tasks in a job, a **Tasks** button will appear in the card footer of the job. Clicking this button switches you to the **Task** view. ![](/_fern-img/0dca6faff178d359a468692da7c3dd11d8af6ae9192c497cb71a7da57f6b2608.webp) ### Running Tasks The **Running Tasks** tab shows all running tasks in a table view. Clicking a job name link under the **Job** column will open the **Job Details** page. When tasks are suspended via the Task Worker Switch, a warning banner displays indicating how many tasks are currently running. ![](/_fern-img/6bcd524ae615d9b0d6d535eb2372437d5a3ad9913f705c7da1e254055e1620c9.webp)![](/_fern-img/0ed38e41ecdf3d10f8270df00b2b536a9f9605105b8c1c9a5cb757cd4ac7d542.webp) ## Usage Statistics **Usage Statistics** on the main Admin Essentials page are snapshot measurements of Itential Platform service-related items only. * Itential does NOT measure Redis, Rabbit, Mongo, Python, NSO, or other node server processes. * Itential also does NOT measure load averages (the amount of traffic to your CPU over the past 1 min, 5 min, and 15 min). * The measurement you see in Admin Essentials is a snapshot view, not real-time, and only Itential Platform/Pronghorn related. | Measurement | Description | | --------------------- | -------------------------------------------------------------------------------- | | Core CPU / Memory | Refers to Pronghorn Core processes only. | | Itential CPU / Memory | Refers to the OS and all applications and adapters running in Itential Platform. | For insight into what is consuming CPU resources, navigate to the Applications or Adapters tab under Profiles to get a more granular snapshot view. Itential also recommends utilizing system-level tools like `top` to give more detailed analysis, as described below. ![](/_fern-img/2b35782a8567fb5c9d3f751ec2563f2895b807b38c5790611baf1105fa23fe2a.webp) ### Using the top command to analyze activity and performance To help identify processes that are consuming a lot of resources, use the `top` (table of processes) command to show running processes in the Platform, including CPU and memory usage. **Prerequisites:** A system running Linux, access to a terminal window, and administrator `sudo` privileges. #### Run top Type `top` on the command line to get information on processes, running tasks, memory, and CPU. #### Enable filter mode Type `O` to enable filter mode. #### Filter to Pronghorn processes Type `COMMAND=Pronghorn` to only display Itential Pronghorn processes. #### Quit Press `q` to quit the terminal window. Multiple processors spread across multiple processes (apps, adapters, etc.) within the Itential system can yield a percentage that equals or exceeds 100%. Having too many processes or apps running at once can strain CPU resources. ![](/_fern-img/413fdbaeac28d499ac35c594a015defaf96d568e1f6e3778fed0fdda49ff55e1.webp)![](/_fern-img/d94e053881e02487dc4499b34b306fae7019bf718052465c667bd1afc19203b9.webp)![](/_fern-img/44ca7ce3b803e29bf174469a1da2cb23ed2ea65231e1b5acf16e9718b3fe67ae.webp) ### Using the btop command For a more detailed view into system resources and as an alternative to the standard `top` command, use `btop` to show usage for processor, memory, disks, network, and processes. From the `btop` interface, you can also sort and filter by different metrics and send signals to processes (e.g., `SIGTERM`, `SIGKILL`, `SIGINT`). #### Open a terminal window Open a terminal window. #### Run btop Type `btop` on the command line and press Enter. Note: since `btop` is not included with many standard RHEL builds, you may need to install it first. #### Navigate processes Use the up/down arrow keys to navigate through processes. #### View process details Press Enter on a selected process to show detailed information. #### Filter to Pronghorn processes Type `f` to filter, then type `Pronghorn` to only display Itential Platform/Pronghorn processes. For more information on how to use `btop`, refer to the [btop online documentation](https://github.com/aristocratos/btop). ![](/_fern-img/6dce900963f3582763d27256df413499a7c1058d93b1224f729e779fdb5545d1.webp) ## Manage message banners Message banners are system-wide banners that display on specified pages within the Itential application. The banner feature can be useful for alerting users about upcoming maintenance release windows, software version upgrades, scheduled downtime, or requiring users to acknowledge an announcement before they can proceed. Only a single global banner is supported, and users can dismiss the banner when that option is enabled in the admin settings. Banners are apparent from their background color and placement. The example below shows a banner placed on the home page (at the top) after the initial user login. Admins can set the background color, font type, and size. Font color is auto-adjusted to contrast with the background color to maintain visual accessibility. ![](/_fern-img/eb626d49b130620087784acbd4e02d57f9eab68cf91f42674dfb35efb61e5675.webp) ### Create a message banner #### Open the banner dialog Log in to your Itential Platform instance, navigate to Admin Essentials, and click the **Manage Banner** button (upper-right corner). The "Create Custom Banner" dialog displays. #### Toggle the banner on Toggle the **Show Banner** switch to display your banner. #### Set run dates Use the time controls to enter your desired run dates for the banner. You can enter the date directly or use the calendar icon for selection. Set a "Start Date/Time" (when the banner should first appear) and an "End Date/Time" (when the banner should no longer appear). #### Set background color Use the style control to set a background color for the banner. You can enter the Hex Color Value directly to change the background color. The default color is Blue (Hex #007DBC). #### Add an image (optional) Use **Image Upload** to embed an image (e.g., a custom logo) that displays in the banner. To fit within the banner, the image file (ICO, PNG, JPG, SVG) is resized to 36×36 pixels. #### Enter message text Enter your message text for the banner in the **Message Editor**. A preview of the message appears below the editor. #### Select display pages Select the "Home Page" or "All Pages" option to specify where the banner displays. #### Configure dismissal Slide the toggle to the right to allow users to dismiss the banner. Slide it to the left to keep the banner persistent. #### Save Click **Save** to finalize your changes. The banner should now appear on the specified pages with your message details. ![](/_fern-img/de323f5c5e614aaf224a9e9618c3bf2516651da14bde3b00b78cef1d92c02ec6.webp) ### Message Banner Editor The **Message Editor** is a WYSIWYG editor — what you write will look the same as what appears on the displayed page. It uses Rich Text formatting and includes a formatting toolbar with five categories of options (from left to right): Text Formatting, Paragraph Formatting, Insert URL Link, Font Style, and Font Type. **Text formatting** options include Bold, Italic, and Underline. **Paragraph formatting** options include Unordered list (bulleted) and Ordered list (numbered). **Insert Hyperlink** allows you to add an absolute URL to generate a hyperlink to additional information such as reference articles, product documentation, or release notes. **Text style** options include Heading (first level), Subheading (second level), and Normal text. ![](/_fern-img/47f83d439e3027280e4fba53bd5d1f816edb2bd27e90d79d5c8592cde742fdb2.webp) **Font size** options include Small, Medium, Large, and Huge. ![](/_fern-img/f0c66be95a076833bcca5796da758c37f07da4f6e3ec0acb9d31d087e9876c79.webp) ### Troubleshoot message banners If your banner does not appear, check your permissions. In some instances, you might need to adjust the permissions on the `banner-schema` Customization API routes. ## Device Counts Platform 6 includes the ability to capture the number of "devices" (adapter endpoints) connected to the platform. This functionality is orchestrated through the `getDeviceCount()` API, with access to device count information available through a downloadable CSV file. The CSV file provides a historical device count record specific to each adapter endpoint, along with a date/timestamp reflecting when the polling was done. One year (365 days) of device count data history is retained. ### Assigning device count role permissions Role-based access for device count data is set through Admin Essentials. To utilize this feature, you must have assigned permissions to read/write roles on user and group entities, and must have assigned permissions to perform the download. #### Log in as administrator Log in to Itential Platform as an administrator (a user with the `pronghorn.admin` role). #### Navigate to Authorization Navigate to **Admin Essentials** → **Authorization**. #### Select Users Select **Users** from the sidenav menu. #### Open the admin user Locate `admin@pronghorn` under the **Users** tab and click the pencil icon to open the **Edit User** dialog. #### Add the role Select the `admin` checkbox next to the `DeviceCounts` source to add the role. #### Save Click **Save** to finalize your changes. ![](/_fern-img/769ea60425b9e93ef62557121b8657a4c3dda58dc12da55384a3d3df7f859085.webp)![](/_fern-img/77b088da168cce6805d5ad21bae929841eaeefaf1ec55f149f3b54f8b172df11.webp) ### Download device count data #### Navigate to Device Counts Navigate to the **Device Counts** card in the top row of the UI. **Last Count** indicates when device count data was last collected (polled). **Endpoints** indicates the total count of devices in the polled data. By default, device count data automatically updates at least once per 24-hour interval. #### Download the file Click the **Download Device Count History** link. A CSV-formatted file is downloaded to your system. #### Open the file Go to the location where the CSV file is saved and open it in your spreadsheet application of choice (e.g., Microsoft Excel, Google Sheets, Smartsheet). ![](/_fern-img/1d9e4dcb3dd39e476019c88a444052d8627b0152de93a4a3d4b26637e149ac58.webp) ### Device Count CSV file Device Count information headers in the CSV file follow this format: `,,,