Itential Developers (DevGuides)

21 Articles in this category

Dark

Light

Itential Developers (DevGuides)

These developer-focused guides are a resource for Itential Platform users. These articles aim to add additional usage examples, deep dive into code samples, or teach you how to use an API or feature.

21 Articles in this category

Dark

Light

Adapter API Routes

Adapter API routes can be defined in the same manner as application routes. This allows you to expose adapter functionality using a web API instead of a task or custom code. Route Example Adding the route property to a method in the pronghorn...

Updated on : 29 Jan 2025

Adapter Degraded Status

Degraded Connection The degraded status is an additional adapter state alongside the online (connected) and offline (disconnected) status. This unique state would be used for adapter-nso and other adapters that have multiple connection types...

Updated on : 29 Jan 2025

Broker Principal Config Setting

To improve the capabilities of the Itential platform, the ability to build principal objects via broker calls to a local AAA adapter is supported. This configuration setting ( brokerPrincipal ) can be found within the authenticationProps of an act...

Updated on : 20 Feb 2025

Enumerations in Applications

This guide provides a general explanation of the ENUM feature, and shows the use of ENUM in the pronghorn.json file of Itential Platform. Terminology and Concepts Enum is a short abbreviation for "enumerations", which means "specifically lis...

Updated on : 20 Feb 2025

Integration API Routes

⚠ WARNING: This feature is deprecated in the 2023.1.2 release and targeted for removal in the 2023.2 release. Refer to the Deprecation Notice for more detail. Itential Platform automatically creates integr...

Updated on : 20 Feb 2025

Event System

The event system is a global service object named eventSystem that is available to application developers in the Itential Platform environment. The eventSystem allows a service to publish information to the Itential Platform environment that oth...

Updated on : 20 Feb 2025

Events

Itential Platform publishes events using an internal Event System . To subscribe to an event topic, a source and event handler need to be provided. The format is source, topic, handler as illustrated in this example: eventSystem.subscribe("@...

Updated on : 20 Feb 2025

Log Class

The Log class is an Itential Platform class which is used to output errors, warnings, and other information to the console or the Itential Platform log files. Accessing the Log Object An instantiation of the Log class is made by Itential Platfor...

Updated on : 20 Feb 2025

Naming Conventions

This guide highlights the set of rules around naming conventions for certain values inside of the Itential Platform. Application Names For custom applications, the id in the pronghorn.json file is a combination of the scope and the applicati...

Updated on : 10 Feb 2025

Operations Manager Search APIs

Operations Manager ("Ops Manager") includes two search APIs that support advanced functionality through query parameters. Note: The information presented herein applies only to the /jobs and /tasks APIs. Que...

Updated on : 20 Feb 2025

Public and Trusted Methods

The "protection" property in pronghorn.json To support public or trusted methods, a Developer must set the protection key at the root-layer inside of a method in pronghorn.json. Itential supports two values for this protection, which overrid...

Updated on : 20 Feb 2025

Run as Another User

The Pronghorn class has a function called sudo that provides the ability to run a given method using the permissions of a different user. This is an asynchronous function and can only be used to call asynchronous functions. Accessing the Prongho...

Updated on : 20 Feb 2025

Search API

The Search API provides a simple way to search the MongoDB databases long as your data is properly exposed to the Itential Platform search engine. This guide explains how to set indexes and expose your data collections with search objects. ...

Updated on : 20 Feb 2025

Service Brokers

This guide explains how to associate an Itential Platform (IP) service with a broker. What Brokering Does Associating a service with an IP broker means the service agrees to implement the broker's interface. Basically, the service will supply a ...

Updated on : 15 Jan 2025

Service Config Property Encryption

This guide explains how to automatically configure property encryption in Hashicorp Vault for an application or adapter. What properties should be encrypted It is recommended that all sensitive properties be encrypted. Examples of properties tha...

Updated on : 21 Mar 2024

Serving UI Directories

UI Directories Property For all services with a user interface (UI) that serve static files, a new uiDirectories property is now required at the root level of the pronghorn.json file. The property is a list of top level directory names, in which...

Updated on : 20 Feb 2025

Table Control

Table Control is a PHUI class used to create tables that list data. It is useful where you want to list a body of entities (less than 100 entities) with multiple properties or where a data set is too large to display all at once. Table Contro...

Updated on : 20 Feb 2025

URL Query Parameters

URL query parameters have been added as a feature to support queries through the API. They work by assigning a value to a key within the URL, in the format ?key=value , and this string is then passed in as parameters to the API's function. They als...

Updated on : 21 Mar 2024

User Account References

User accounts are uniquely identified in Itential Platform by a database ID, or a username and provenance pair where the provenance is the name of the AAA adapter from which the user account originated. This guide lays out best practices for user ac...

Updated on : 20 Feb 2025

User Group References

Within Itential Platform is the representation of groups. Groups can be uniquely identified by either a database id, or a name and provenance pair, where the provenance is the name of the AAA adapter from which the group originated. This guide discu...

Updated on : 20 Feb 2025

Using Query Parameters in API Requests

Query parameters in Itential Platform are a defined set of parameters (params) attached to the end of a GET request. They are used to help define specific content or actions based on the data being passed. More specifically, query parameters allow...

Updated on : 20 Feb 2025

Changing your password will log you out immediately. Use the new password to log back in.

Current password

New password

Confirm password

First Name

First name must have atleast 2 characters. Numbers and special characters are not allowed.

Last Name

Last name must have atleast 1 characters. Numbers and special characters are not allowed.

New email

Enter a valid email

Re-enter your password

Enter a valid password

Your profile has been successfully updated.

Logout