Use pre-builts | Itential

The Itential Open Source Pre-Builts repository is no longer actively maintained. Those pre-builts have been certified up to Platform 2023.2, but can still be imported to Platform 6. We recommend transitioning to Projects for the best experience.

If you migrated from Platform 23.2 or earlier, pre-builts that were installed on your instance before upgrading to Platform 6 remain installed and continue to function. This guide is for users who need to install new pre-builts on a Platform 6 instance.

Install pre-builts by connecting the Pre-Builts Catalog to a Git repository (Option 1) or by manually importing a pre-built artifact file (Option 2).

Option 1: Connect the Pre-Builts Catalog to Git

Use this option to browse and install pre-builts from a Git repository through the Pre-Builts Catalog in Admin Essentials.

Prerequisites

Access to the Platform 6 Admin Essentials application
Access to the Platform server’s configuration file (platform.properties or legacy iap.properties)
Ability to restart the Platform server

Profiles are deprecated in Platform 6, but prebuiltProps is the one stateful property that still depends on a Profile, so an active profile is required to configure a pre-built repository. See Profiles deprecation for details.

Step 1: Create a profile in Admin Essentials

Open Profiles

In Admin Essentials, expand Profiles in the left navigation panel.

Open the Create dialog

Click the Create (+) button to open the Create dialog.

Select Profile

From the What would you like to create? dropdown, select Profile.

Name the profile

Enter a Name for the profile (for example, my_profile).

Describe the profile

Enter a Description (for example, Profile to configure repository for Pre-Builts).

Save

Click Save.

After saving, you’re redirected to the profile configuration page. The profile displays a list of services and profile properties.

Step 2: Set the profile as active

Setting the profile as active through Admin Essentials isn’t supported. Instead, set it using either an environment variable or your configuration file. For the full property reference, see Platform environment variables and properties.

Environment variable

Configuration file

Set the ITENTIAL_PROFILE_ID environment variable to the name of the profile you created (for example, my_profile).

Step 3: Restart the Platform server

After setting the active profile, restart the Platform server for the change to take effect.

Stop the server

Stop the Platform server (for example, Ctrl+C in the terminal running the server).

Start the server

Start the server again using the appropriate startup command (for example, iap-start master --quick).

Wait for startup

Wait for the server to fully start and all services to load.

After the server restarts, navigate to Admin Essentials > Profiles and confirm that your profile is now marked as the Active Profile.

Step 4: Configure the Pre-Builts repository

Open Repositories

In Admin Essentials, expand Repositories in the left navigation panel.

Create a repository configuration

If a repository configuration for @itentialopensource doesn’t already exist, click the Create (+) button and select Repository Configuration.

Configure the repository

Configure the repository with the following settings:

Field	Value
Connected	Enabled (toggled on)
Name	`@itentialopensource`
Type	GitLab
Host	`gitlab.com`
Path	`itentialopensource/prebuilt-automations`

Enable older releases

Enable the Show Prebuilts on older releases toggle. Because pre-builts are only certified through Platform 2023.2, this toggle is required to display them in the catalog on Platform 6.

Save

Click Save.

Step 5: Browse and install pre-builts

Open the Pre-Builts Catalog

After saving the repository configuration, navigate to the Pre-Builts Catalog. You can access the catalog from the repository configuration page or from Pre-builts in the left navigation.

Search for a pre-built

Use the search bar to filter pre-builts by name (for example, cisco-ios, netbox).

Review pre-built details

Select a pre-built from the list to view its details in the preview panel, including the overview and description, included workflows, external dependencies, and required adapters.

Install

Click Install to install the pre-built.

Confirm overwrite (if prompted)

If prompted with an Overwrite Files On System warning, review the list of components that will be overwritten, then click Install to confirm.

After installation, the pre-built’s workflows, transformations, and other components are available in the Platform. You can view installed workflows in Studio.

If the pre-built requires adapters or services that aren’t present in your environment, an error message indicates which services are missing or offline. Ensure all required dependencies are installed and running before using the pre-built’s workflows.

Option 2: Import a pre-built artifact file

If you prefer not to connect to a Git repository, you can manually import a pre-built using its artifact file.

Download the artifact file

Download the artifact.json file from the pre-built’s Git repository. This file is a required part of every pre-built’s repository file structure.

Import the file

Import the file using Admin Essentials.

For the complete procedure, see Download and import pre-builts manually.