.png?sv=2022-11-02&spr=https&st=2024-12-23T17%3A41%3A52Z&se=2024-12-23T17%3A51%3A52Z&sr=c&sp=r&sig=g7v%2BgOTxdqkak%2BtL1epzxVfoKNTDKj4w51rlpMXBhlo%3D){kind=logo}
Intro to Admin Essentials
- 29 Apr 2024
-
DarkLight
-
PDF
Intro to Admin Essentials
- Updated on 29 Apr 2024
-
DarkLight
-
PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
The Admin Essentials application is used to view, configure and modify all admin level properties across the Itential platform. The various features in Admin Essentials are controlled by authorization settings. Therefore, some users will not have access to all the features referenced herein; however, an administrator can give user access to the features as necessary.
UI Overview
The main features of the Admin Essentials user interface are referenced in the table below.
Note: Different versions of IAP may have minor variations in the Admin Essentials User interface.
| 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, Tags, and View Documentation. |
| 2 | Collection Lists | 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 accordian menu list that shows on the UI is based on user permissions. |
| 3 | Quick Start | Contains a series of links to important functions within Admin Essentials such as setting authorization levels and downloading IAP Blueprints. |
| 4 | Server Information | Displays the current server ID, version information, and server uptime. |
| 5 | Operation Execution | Located beneath the Server Information. Displays the current status of the Job Worker and Task Worker. Toggle the switches to control whether new jobs will run or new tasks will run. IAP 2023.1 & 2023.2 Only. |
| 6 | Usage Statistics | Displays the memory and CPU usage of Core and IAP. IAP 2023.1 & 2023.2 Only. |
| 7 | 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. IAP 2023.1 & 2023.2 Only. |
| 8 | Alerts | Shows if a service is stopped or connectivity is down. |
Icon Bar Permissions
The following outlines the permissions that must be applied to a user account to gain access to the Icon Bar.
| Access to | User Permissions |
|---|---|
| Current Operations | WorkFlow Engine, activate WorkFlow Engine, deactivate |
| Tags | Tags, all |
Menu Permissions
The following outlines the permissions that must be applied to a user account to gain access to the Menus in the sidebar.
| Access to | User Permissions |
|---|---|
| Profiles | Profiles, getProfiles |
| Applications | Applications, getApplications |
| Adapters | Adapters, getAdapters |
| Integrations | Integrations, getIntegrations |
| Integration Models | IntegrationModels, getIntegrationModels |
| Pre-builts | Prebuilts, getPrebuilts |
Create Dialog Permissions
The Create icon will open a dialog with choices for creating a new item in a collection. The choices that appear are based on user permissions as defined in the table below.
Figure: Create Icon
| Access to | User Permissions |
|---|---|
| User User Groups |
Must be on Local AAA with no access to Pronghorn admin role. |
| Profile | Profiles, createProfile |
| Adapter | Adapters, createAdapter |
| Integration | Integrations, createIntegration |
| Integration Models | IntegrationModels, createIntegrationModel |
| Tags | Tags, createTag |
Import Permissions
The Import icon will open up a dialog with choices for uploading a new item to a collection. The Import dialog accepts a JSON file. The choices that appear are based on user permissions as defined in the table below.
Figure: Import Icon
| Access to | User Permissions |
|---|---|
| Profile | Profiles, createProfile |
| Adapter | Adapters, createAdapter |
| Tags | Tags, createTags |
| Pre-builts | Prebuilts, importPrebuilt |
View Documentation
The View Documentation icon will open a dialog that provides links to the documentation pages, in addition to providing a view for the pronghorn-core changelogs.
Figure: View Documentation Icon
Collection Items
The Collection dialog displays all of the items in a collection as cards with services information relevant to the collection item displayed within the card.
| Label | UI Element | Function |
|---|---|---|
| 1 | Collection Toggle | Allows the user 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 the results using the icon to the left of the search bar. |
| 4 | Sort and Sort By | Use the icon to sort the 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 | Used to show the total number of discrete pages and to page through a collection. Also used to set how many items to show if there are too many in a collection. |
Changing Application/Adapter Log Levels
A user with permissions for the generic updateAdapter and updateApplication methods can modify the log_level of an application or adapter in IAP using the Advanced View switch located in the upper-right corner of the interface.
To access this feature, navigate to: Admin Essentials→ Adapters (or Applications) → adapter/application name → Logging (tab)→ Advanced View (switch).
For example, to change the log_level to debug:
- Replace the value of the
log_levelproperty by changinginfotodebug. - Click the SAVE button (lower-left corner).
Of note, the specific details logged at each level (i.e. what information is logged and what messages are returned) is determined by the application developer and defined within the adapter code.
Additional log level properties for Syslog are saved in the Log Settings view shown below. If the Syslog properties are not configured in the Advanced View of an application or adapter page, the user will be unable to change that property in the Logging tab.
Changing Log Levels in Profile Properties
A user can also modify the log_level in IAP using the Admin Essentials interface by navigating to: Admin Essentials→ Profiles→ profile name→ Edit Profile Properties→ loggerProps. Previously, changing a profile's logging was done via code editor; it is now done using a form as shown in the image below.
Profiling Feature
To help troubleshoot performance issues resulting in high CPU usage, Itential Automation Platform (IAP) now includes a built-in profiler based on V8.dev profiling and simple-profiling. For more information on how to use this feature, see the IAP Configuration guide.
Was this article helpful?
