Adapter Setup Worksheet

 

Use the worksheet beginning on the following page to help you identify and collect critical information about the adapter you are developing. The answers to the questions posed on the worksheet will help you conceptualize the adapter you are building before you actually began to code. They will help you define such components as the adapter logical name and the Java package base name and help you determine the locales for which you need to localize message bundles. If you are using the GenerateAdapterTemplate utility, the answers you provide on this worksheet are essential to its success.

 

---

Adapter Setup Worksheet

Before you begin developing an adapter, answer as many of the following questions as you can. Questions preceded by an asterisk (*) are required to use the GenerateAdapterTemplate utility.

1. *What is the name of the EIS for which you are developing an adapter?

2. *What is the version of the EIS?

3. *What is the type of EIS; for example, DBMS, ERP, etc.?

4. *Who is the vendor name for this adapter?

5. *What is the version number for this adapter?

6. *What is the adapter logical name?

7. Does the adapter need to invoke functionality within the EIS?

   If so, then your adapter needs to support services.

8. What mechanism/API is provided by the EIS to allow an external program to invoke functionality provided by the EIS?

9. What information is needed to create a session/connection to the EIS for this mechanism?

10. What information is needed to determine which function(s) will be invoked in the EIS for a given service?

11. Does the EIS allow you to query it for input and output requirements for a given function?

    If so, what information is needed to determine the input requirements for the service?

12. For all the input requirements, which ones are static across all requests? Your adapter should encode static information into an InteractionSpec object.

13. For all the input requirements, which ones are dynamic per request? Your adapter should provide an XML schema that describes the input parameters required by this service per request.

14. What information is needed to determine the output requirements for the service?

15. Does the EIS provide a mechanism to browse a catalog of functions your adapter can invoke? If so, your adapter should support browsing of services.

16. Does the adapter need to receive notifications of changes that occur inside the EIS? If so, then your adapter needs to support events.

17. What mechanism/API is provided by the EIS to allow an external program to receive notification of events in the EIS? The answer of this question will help determine if a pull or a push mechanism is developed.

18. Does the EIS provide a way to determine which events your adapter can support?

19. Does the EIS provide a way to query for metadata for a given event?

20. What locales (language/country) does your adapter need to support?