Appboard/old/data adapter checklist: Difference between revisions
imported>Mike.berman (created page) |
imported>Cmace (added content from pdf) |
||
| Line 2: | Line 2: | ||
== Adapter Checklist == | == Adapter Checklist == | ||
'''Environment:''' | |||
* List version(s) of server application tested | |||
* List OS and locale of server application | |||
* Document configuration changes made to server | |||
* Document requirements to connect to server (credentials, libraries, etc.) | |||
* Document options for API connectivity to server and chosen approach | |||
* Provide developer documentation used | |||
* Provide other relevant documentation or procedures used to develop adapter | |||
'''Adapter basics:''' | |||
* Document parameters for connecting to server (IP, port, etc.) | |||
* Log common connectivity errors and document behavior/troubleshooting: | |||
** Server unreachable (disconnect network) | |||
** Server reachable but not configured properly (if configuration required) | |||
** Server reachable but missing credentials | |||
** Other common errors | |||
* Log data source entity/attribute/association discovery if applicable | |||
** Does discovery occur at system startup? | |||
** Does discovery block adapter load? | |||
** Does adapter recover if server unavailable at startup but availability returns? | |||
** How long to timeout if discovery fails? | |||
** Does discovery set attribute types / id? | |||
'''Data retrieval:''' | |||
* Log data retrieval start/finish | |||
* Log number of records retrieved | |||
* Document options for data retrieval | |||
** Always retrieve all data? | |||
** Can data be filtered on server? Did you implement findByQuery? Limitations? | |||
* Briefly describe entities / attributes if non-obvious | |||
* Document how to validate entities / records retrieved in application UI if possible | |||
'''Support''' | |||
* Provide application server access for testing | |||
* Provide support for customer problems with adapter | |||
Revision as of 14:31, 24 June 2011
The adapter checklist is a list of items for the adapter developer to complete in order to formalize a data adapter.
Adapter Checklist
Environment:
- List version(s) of server application tested
- List OS and locale of server application
- Document configuration changes made to server
- Document requirements to connect to server (credentials, libraries, etc.)
- Document options for API connectivity to server and chosen approach
- Provide developer documentation used
- Provide other relevant documentation or procedures used to develop adapter
Adapter basics:
- Document parameters for connecting to server (IP, port, etc.)
- Log common connectivity errors and document behavior/troubleshooting:
- Server unreachable (disconnect network)
- Server reachable but not configured properly (if configuration required)
- Server reachable but missing credentials
- Other common errors
- Log data source entity/attribute/association discovery if applicable
- Does discovery occur at system startup?
- Does discovery block adapter load?
- Does adapter recover if server unavailable at startup but availability returns?
- How long to timeout if discovery fails?
- Does discovery set attribute types / id?
Data retrieval:
- Log data retrieval start/finish
- Log number of records retrieved
- Document options for data retrieval
- Always retrieve all data?
- Can data be filtered on server? Did you implement findByQuery? Limitations?
- Briefly describe entities / attributes if non-obvious
- Document how to validate entities / records retrieved in application UI if possible
Support
- Provide application server access for testing
- Provide support for customer problems with adapter
