Itential Technical Resources

A specific library of technical resources that summarize the configurations and customizations available for adapter generation and integration.

One of the core strengths of the Itential Automation Platform (IAP) is the agile ability to establish integrations with other network applications, systems and devices by creating your own adapter using the Adapter Builder. As such, Itential is excited to introduce a specific library of technical resources that summarize the configurations and customizations available for adapter generation and integration, along with customized authentication, testing and troubleshooting the install and use of your newly built adapter. At Itential, the information we make available is frequently expanded and updated, so be sure to bookmark this site and check back often. Lastly, go over to the Itential Open Source repository to check out all the adapters that are available and to our product site to see how network connectivity to everything using IAP can enable your business.

Authentication

This resource describes some of the common ways to set-up adapter authentication to ensure two-way communication between your adapter and the other system. Additional supporting information and examples are also provided for complex methods such as OAUTH and encoding.

View Resource

Security

This resource describes some of the security methods and authentication protocols that users will use to establish secure forms of communication between devices when making a request to an external system.

View Resource

IAP Service Instance Configurations

Most of the flexibility that’s needed to configure your adapter is found in the property definition file, which is a JSON schema file that provides all your property data. This resource will guide you in making changes to your adapter properties, which is done through the Itential Automation Platform. Each property is defined and several examples are given on how properties are used.

View Resource

Endpoint Configurations

To understand the integrations, endpoints and various actions your adapter can take with a system entity, use the resource information provided here on the action.json file. This section covers the field definitions used to define actions within an adapter, and gives you examples on how to modify the file for unique schemas and mock data that can be tested in standalone mode.

Also, the adapter schema is used in defining the data that flows to and from an adapter. Since every action in an adapter can have a unique input and output, use the information in this resource to configure the data for each action in your adapter.

View Resource

Headers

Sometimes external systems require certain headers on the API calls. The below article describes how these headers can be added to some or all calls. It also discusses the difference between static and dynamic headers.

View Resource

Mock Data

Mock data is captured and stored in your adapter for purposes of standalone testing, but it won’t test for true authentication. To learn more about using mock data, use the information in this resource to format the mock data files and understand how best to capture responses (data) from the other system.

View Resource

Code Files

The adapter code files provide the Runtime Libraries required for many instant capabilities such as translation, consistent error handling, metrics and encryption. The adapter.js file contains the methods which are exposed to the Itential Automation Platform. This resource will provide details on what’s in the adapter.js, as well as provide examples to help you understand how to make modifications to an adapter call.

View Resource

Linting & Testing

The purpose of testing your adapter is to expose faults in the interactions that take place between the adapter components and the other system. Included in this resource is information on the test files utilized for unit testing and integration testing, as well as the linting script used to find and fix runtime errors. Additional guidance and best practices for adapter testing are presented for you to follow and incorporate when adding tests or test data.

View Resource

Build an Adapter

To create your own adapter, use the Adapter Builder – an interactive, easy-to-use tool that allows you to custom build adapters that integrate with select network applications via the Itential Automation Platform. Once you upload your Swagger, OpenAPI, or Postman Collection document, Adapter Builder will guide you step-by-step to help define your adapter, set properties, and create entities. Adapter Builder even tells you how to install the adapter after it’s built.

View Resource

Troubleshooting

Do you need help with your newly built adapter? Are you unsure of how to make a change to a property to get your adapter working? The Itential Adapter Team is available to help! We have provided resource information on some of the more common troubleshooting areas you may encounter as well as those complex scenarios where additional detail is needed.

View Resource

Support

If you experience any problems or can’t figure out how to make a change, don’t hesitate to contact us. The Itential Adapters Team is here to help. We will often communicate through tickets/issues however, we can also get on consultations with you when needed.

View Resource