Skip to navigation
Install

Install adapters

Follow these best practices when installing or building an adapter. For Itential Platform adapter installation and migration, see Install and migrate adapters and custom applications.

Best practices for a new adapter installation

Follow these steps whenever you install or build a new adapter:

1

Install the adapter in the correct directory

Install to <IAP-Home>/node_modules/@<namespace>/adapter-<name>.

Example: /opt/pronghorn/current/node_modules/@itentialopensource/adapter-sevone

For Platform 6, install to /opt/itential/platform/services/adapter-name instead. See Install and migrate adapters and custom applications.

2

Install adapter dependencies

Run npm install from inside the adapter directory — not from the Itential Platform home directory.

3

Lint the adapter

npm run lint
4

Run unit tests

npm run test:unit
5

Run standalone integration tests

npm run test:integration
6

Run true integration tests (if an instance is available)

Update the connection properties in the integration test file, then run:

npm run test:integration

If any tests fail, enable debug logging and review the OPTIONS, REQUEST, CALL RETURN, and RESPONSE log entries to identify the issue.

What’s next

Configure adapter

Set connection and auth

Test adapter

Verify functionality

Customize code

Add custom logic

Troubleshoot

Fix issues