- 05 Apr 2023
-
DarkLight
-
PDF
Adapter Builder Process & Important Information
- Updated on 05 Apr 2023
-
DarkLight
-
PDF
Each step of Adapter Builder attempts to gather information about the adapter and the system it is connecting to, such as :
- Adapter ownership
- System integration
- Authentication
- Determining if the system is running
- API calls usage
- Use cases
- Other properties
Use of Default Values
Adapter Builder attempts to simplify the process by defaulting much of this information above ,however, it’s important to be aware that accepting all the defaults is not best practice and will result in you doing more work later. For example:
- Accepting the default authentication means that when you deploy the adapter you will have to configure the authentication method. This includes updating several files and adapter properties.
- Accepting the default namespace instead of applying a custom namespace will require you to update the namespace in many files.
- Accepting the default adapter name incorrectly may result in you needing to change the adapter name in several locations.
Important Information to Review and Complete
Know how to change the data you enter.
- Many of the fields provide information that tells you how to change the data after the adapter is built.
Review the information that is provided to you.
- For the information involved in the API call (e.g. protocol, host, base path, version, etc.), the Adapter Builder shows you the current API call as it would be made. Verify that information is correct before proceeding.
Determine how API calls can be completed to:
- Give you 100% API coverage.
- Reduce the size of the adapter by only selecting the API calls you know you will use.
Building use cases can be very useful when integrating with IAP.
Adapter use cases can provide workflows that can be:
- Used to test the adapter.
- Enhanced to build automations.