Best Practices
  • 05 Dec 2022
  • Dark
    Light
  • PDF

Best Practices

  • Dark
    Light
  • PDF

Article Summary

This article presents the best practices to follow when you are downloading or building an adapter.

  1. Install the adapter into the directory where IAP will run it. This should be in IAPHome/node_modules/@/adapter-.

For example: /opt/pronghorn/current/node_modules/@itentialopensource/adapter-sevone.

  1. Go into the adapter directory and install the adapter dependencies.

run npm install

  1. Run linting on the adapter.

npm run lint

  1. Run unit tests on the adapter.

npm run test:unit

  1. Run standalone integration tests on the adapter.

npm run test:integration

  1. If there is an instance of the other system that you can test, attempt to run integration tests with that system.

    a. Edit the properties in the integration test file accordingly.
    b. Run integration tests — npm run test:integration
    c. If there are any issues, turn debug logging on and attempt to determine what the issues are.

    If you need assistance, please don't hesitate to contact the Itential Adapters Team.


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.