This page documents how to access Itential Platform and then moves into explaining all of the features available in the Dashboard, a centralized hub that gives you an immediate view of available applications and support information that you can leverage to support your day-to-day work.
Accessing the Platform
To log in:
- Navigate to the address of the server with port 3000. Example: http://10.1.1.1:3000
- Enter a valid username and password. The default is
admin@pronghorn
andadmin
. - Press Enter or click Sign In.
- Itential Platform's main dashboard displays.
Supported Browsers
Itential Platform supports the most current version of the following browsers.
- Chrome
- Firefox
- Edge
If you're unsure which version you are actually running, be sure to check.
Third-Party Software Compatibility
The Itential Platform is compatible with several third-party software products for network operating environments. All third-party software version compatibility is documented on this resource page. To get the most up-to-date requirements for any third-party software, including open source, first identify which Itential Platform release you’re using and then refer to the respective release note.
Navigating the Dashboard
Immediately after logging into Itential Platform, you will be redirected to the Platform's main Dashboard (Figure 1). The Dashboard provides easy access to all of the applications available to you in the Platform. In addition, the Dashboard allows you to bookmark frequently accessed links and obtain support in your use of Itential Platform. These features combined create a unified interface that you can use as a starting point for any task that you need to accomplish in Itential Platform.
UI Element | Function |
---|---|
Side Navigation Menu | Provides access to the application collection menus: Administration, Design, Operation, Legacy & Custom. |
Projects | Provides access to Projects, a collaborative, container-like environment to create workflows, forms, templates, and JSTs as use cases within Studio. |
Automation with Itential | Use definitions for the primary app collections within Itential Platform: Administration, Design, Operation. |
Help & Support | Lists links to resources you can use to get support for Itential Platform. |
Bookmarks | Allows you to create, access, edit, and delete bookmarks. |
Note: Different versions of Itential Platform may have minor variations in the Dashboard.
Figure 1: Itential Platform 6Dashboard
Applications
All of the functions the Itential Platform can perform are provided by applications. By default, Itential Platform 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 Itential Platform instance.
Itential Platform applications are divided into four collections based on their functionality.
Application Collection | Function |
---|---|
Administration | Contains Admin Essentials that allow you to perform administrative functions affecting the Platform. Examples include setting user roles and permissions, managing tags, and editing profile settings. |
Design | Contains Automation Studio and Lifecycle Manager that allow you to create workflows, forms, and templates within Itential Platform. |
Operation | Contains Operations Manager and Configuration Manager that allow you to manage the execution of automations and device configuration templates within Itential Platform. |
Legacy & Custom | Contains legacy and user-created applications. |
To launch an application from the 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.
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.
Projects
Projects is a protected design and development space within Itential Platform where users can collaborate on use cases and then quickly develop, test, and publish assets for production-ready environments.
Additional product details on how to access and use Projects in the Platform, including project validation and reference management, can be found here: Projects
Bookmarks
In addition to launching applications, the 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 Itential Platform (though it can).
The Bookmarks area of the Dashboard is comprised of the following UI elements (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: Bookmarks UI
Creating a Bookmark
To create a bookmark:
- 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:
- 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:
- 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 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.
External Links (Admin)
External links are essentially browser bookmarks - simple links to arbitrary URLs along with a name and optional description. One key difference from a browser bookmark is these external links are globally available. Only an Admin can add/remove them, and they are intended to be used when an Admin wants all users to have the exact same set of links.
As an Admin, granting yourself the ExternalLinks.admin
role will allow you to add, edit, and view/open external links. Non-admins can only view/open external links (with the proper permissions). The ExternalLinks.getLinks
permission is needed to view/open external links and is available in the ExternalLinks.apiread
role.
On the Itential Platform Homepage, click the plus sign (+) icon in Bookmarks to create a new external link. The Update Bookmark dialog will display.
Figure 3: Bookmarks
Admins can add an External Link with a name, address, and description (optional). After creating the bookmark, the link should appear in the External Link widget, and should open in a new tab when clicked. Admins can also delete and edit links from this widget.
Figure 4: Update Bookmark
When there are several links, a collection will display as cards with the bookmark name relevant to the link displayed within the card.
Figure 5: Bookmarks Collection
Of note, there are differences between the Admin and User view when accessing Itential Platform Bookmarks, namely the buttons to create, edit, and delete will not appear in the User view.
Getting Help & Support
Several links to support resources, such as user guides and API references, are provided in the Help & Support element of the 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). |