- 24 May 2024
-
DarkLight
-
PDF
IAP Dashboard
- Updated on 24 May 2024
-
DarkLight
-
PDF
Immediately after logging into Itential Automation Platform (IAP), you will be redirected to the IAP Dashboard. The IAP Dashboard provides easy access to all of the applications available to you in IAP. In addition, the IAP Dashboard allows you to bookmark frequently accessed links and obtain support in your use of IAP. These features combined create a unified interface that you can use as a starting point for any task that you need to accomplish in IAP. This guide documents all of the features available in the IAP Dashboard and describes how you can leverage them to complete your day-to-day work.
IAP Dashboard User Interface
The user interface (UI) of the IAP Dashboard is comprised of the following main elements (labeled in Figure 1).
Label | UI Element | Function |
---|---|---|
1 | Side Navigation Menu | Provides access to the IAP application collections and the application banner menu. |
2 | Bookmarks | Allows you to create, access, edit, and delete bookmarks. |
3 | Help & Support | Lists links to resources you can use to get support for IAP. |
Note: Different versions of IAP may have minor variations in the IAP Dashboard.
Figure 1: IAP Dashboard Main UI Elements
Details regarding the use of each UI element are provided in the following sections.
Applications
All of the functions that IAP can perform are provided by applications. By default, IAP includes many applications that are developed and maintained by Itential, but users are also able to develop their own custom applications that can be added to an IAP instance.
Application Collections
IAP applications are divided into four collections based on their functionality.
Application Collection | Function |
---|---|
Administration | Contains applications that perform administrative functions affecting IAP. Examples include setting user roles and permissions, managing tags, and editing IAP profile settings. |
Design | Contains Automation Studio and Lifecycle Manager that allow you to create workflows, forms, and templates within IAP. |
Operation | Contains Operations Manager and Configuration Manager that allow you to manage the execution of automations and device configuration templates within IAP. |
Legacy & Custom | Contains legacy and user-created applications. |
Launching an Application
IAP Dashboard
To launch an application from the IAP Dashboard:
- Locate the desired application in the side navigation menu on the left-hand side of the screen.
- Select the application; you will be redirected to that application in your active browser tab.
Application Menu
You can also launch applications from the application banner menu by performing the following steps:
- Select the hamburger menu icon located at the top-right corner of the side navigation menu; the application banner menu will appear.
- Hover your cursor over the Applications entry in the application banner menu; a list of applications will appear.
- Select the desired application from the list; you will be redirected to that application in your active browser tab.
Bookmarks
In addition to launching applications, the IAP Dashboard allows you to manage user-defined bookmarks. A bookmark is a link to a uniform resource locator (URL) that is given a name and, optionally, a description. Bookmarks can link to any URL; however, the URL defined in the bookmark does not have to direct the user to a feature within IAP (though it can).
See also: External Links (Admin)
Bookmarks User Interface
The user interface of the IAP Dashboard Bookmarks element is comprised of the following (labeled in Figure 2).
Label | UI Element | Function |
---|---|---|
1 | Toolbar | Displays icons used to perform bookmark management actions. From left to right, these are: Create, Info, Select All, and Delete. |
2 | Search Bar | Allows you to search for bookmarks by name. |
3 | Sort By | Controls what order the displayed bookmarks are sorted in. |
4 | Bookmark | A representation of a bookmark. |
5 | Bookmark Action Icons | Displays icons used to access, edit, or delete the relevant bookmark. |
Figure 2: IAP Dashboard Bookmarks UI
Creating a Bookmark
To create a bookmark from the IAP Dashboard:
- Select the Create icon in the toolbar; the Create Bookmark modal will appear.
- Enter a name and address (URL) for the bookmark and, optionally, define a description for the bookmark.
- Select the Create button at the bottom-left corner of the Create Bookmark modal.
⚠ Use full URLs when defining bookmark addresses. For example, to create a bookmark to the Itential website, enter https://www.itential.com
.
Accessing Bookmarks
To access a bookmark from the IAP Dashboard:
- Use the Sort by button to specify the desired sorting criteria (optional).
- Locate the desired bookmark.
- Select the menu button (stacked dots) located at the bottom-right corner of the bookmark; the bookmark action icons will appear.
- Select the Open page here icon to be redirected to the bookmark in your active browser tab, or select the Open in new window icon to open the bookmark in a new browser tab.
If you know the name of the desired bookmark, you can find it by using the search bar. Any bookmarks that do not at least partially match the name specified in the search bar will be filtered from display.
Editing Bookmarks
To edit a bookmark from the IAP Dashboard:
- Select the menu button (stacked dots) located at the bottom-right corner of the bookmark; the bookmark action icons will appear.
- Select the Edit icon; the Update Bookmark modal will appear.
- Make any desired changes to the name, address (URL), and description of the bookmark.
- Select the Update button at the bottom-left corner of the Update Bookmark modal to save and retain your changes.
Deleting Bookmarks
Bookmarks can be deleted from the IAP Dashboard individually or in bulk.
To delete an individual bookmark:
- Select the menu button (stacked dots) located at the bottom-right corner of the bookmark; the bookmark action icons will appear.
- Select the Delete icon; a confirmation modal will appear.
- Confirm the deletion of the bookmark by selecting the Delete button at the bottom-left corner of the confirmation modal.
To delete bookmarks in bulk :
- Select each bookmark to be deleted by ticking the selection box located at the bottom-left corner of the bookmark; a checkmark will appear in the selection box.
- Select the Delete icon from the toolbar; a confirmation modal will appear.
- Confirm the deletion of the bookmarks by selecting the Delete button at the bottom-left corner of the confirmation modal.
Getting Help & Support
Several links to support resources, such as user guides and API references, are provided in the Help & Support element of the IAP Dashboard. Upon selecting a link, you will be redirected to the relevant content in a new browser tab.
Support links are also available in the application banner menu. Access the application banner menu by selecting the hamburger menu icon located at the top-right corner of the side navigation menu.
Additional resource information for our customers is referenced below.
Resource | Description |
---|---|
Resource Library | Access the Resource Library for the latest white papers, e-books, videos, podcasts and more. |
Developer Hub | Explore tools, resources, and open source projects in the Itential Developer Hub. |
Itential Support | Contact the Product Support Team for help with specific support issues (production environment). |