.png?sv=2022-11-02&spr=https&st=2024-12-23T05%3A41%3A44Z&se=2024-12-23T05%3A51%3A44Z&sr=c&sp=r&sig=%2FvQQmfcAPE9AdSYFYvLt6lECl5F3f534KYTjfwL%2FlNI%3D){kind=logo}
Intro to Pre-Builts in IAP
- 05 Dec 2024
-
DarkLight
-
PDF
Intro to Pre-Builts in IAP
- Updated on 05 Dec 2024
-
DarkLight
-
PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Pre-Built Component Types
Prebuilts allow developers to accelerate execution of network automation use cases within IAP (Itential Automation Platform). More specifically, pre-builts combine the abilities of multiple components that live within IAP. As such, a pre-built can be comprised of the following component types:
- Automation Catalog
- Automations (Operations Manager)
- Form
- JSON Forms
- Integrations
- Integration Models
- Command Template (MOP)
- Analytic Template (MOP)
- Service Catalog
- Template
- Transformation
- Triggers (Operations Manager)
- Workflow
Each of these components serves a specific role to help various network use cases. You can read more about each component in their respective product documentation guides on docs.itential.com.
Terminology
The following terms apply to the use of pre-builts in Admin Essentials.
| Term | Description |
|---|---|
| Prebuilt | A prebuilt automation uses other IAP components to execute a certain network use case. |
| Component | A component is a building block of a prebuilt. Each component helps serve as a tool in a network automation use case. |
| IAP Dependency | An IAP dependency is an application or adapter that is required by the pre-built to be in the current IAP environment for the pre-built to function properly. |
Pre-Builts UI
The primary user interfaces (UI) in the Prebuilts application are described below. Each interface allows you to view details about the pre-built along with the ability to uninstall a pre-built item or download data.
Details View
User interactions available through the Details View are referenced below.
Figure 1: Pre-builts Details View
| Label | UI Element | Edit View Function |
|---|---|---|
| 1 | Browse | Click to browse all available prebuilts from the Itential Open Source Repository. |
| 2 | Search bar | Use to search the list of installed prebuilts. |
| 3 | Installed pre-builts | A collection list of all installed pre-builts on the current IAP environment. |
| 4 | Name | The name of the prebuilt. |
| 5 | Details | Pre-built metadata regarding the publisher, publish date, version info, repository location, and license info. |
| 6 | Beta release | A prebuilt will show the Beta flag if the version is less than 1.0.0. |
| 7 | Uninstall | Click to uninstall the prebuilt. |
| 8 | Download | Click to download a pre-built data file from the database of the current IAP environment. |
| 9 | ReadMe | Displays the readme file for the prebuilt. |
| 10 | Pre-Built Content | Click the links to access components for the prebuilt in Automation Catalog, JSON Forms, and Automation Studio. |
Browse View
User interactions available through the Browse View are referenced below.
Figure 2: Browse Prebuilts Catalog
| Label | UI Element | List View Function |
|---|---|---|
| 1 | Search | Used to search the prebuilt repository. |
| 2 | Name | The name of the prebuilt. |
| 3 | Version Info | The latest version of the prebuilt that is compatible with the current running IAP version. |
| 4 | Description | A summary description of the prebuilt. |
| 5 | View | Click to view details about the prebuilt. |
| 6 | Beta release | A prebuilt will show the Beta flag if the version is less than 1.0.0. See note below for more information on this feature. |
| 7 | Download | Click to download a prebuilt data file from the repository. |
| 8 | Metadata | Prebuilt metadata regarding the publisher, publish date, version, repository type, and license type. |
| 9 | ReadMe | The readme file for the prebuilt. |
Note: If the Beta release of a prebuilt is not compatible with the current environment, a red indicator displays next to the Beta flag.
Figure 3: Noncompatible Beta Flag
Was this article helpful?
