Adapter Development Process

The adapter development process is detailed. You should understand this process before beginning your development.

The following diagram depicts the process required to create an adapter.

Figure 3-1 Adapter Development Process

Description of "Figure 3-1 Adapter Development Process"

To develop an adapter, work in SQL Developer or a similar tool, using your own Oracle Life Sciences Data Hub user account that is linked to a database account with Execute privileges on the API security package CDR_PUB_API_INITIALIZATION.

1. Design your adapter, following instructions in this guide.
2. Create one or more service types and extend lookups as required; see Planning Services and Adding Lookup Values.
3. In your own schema, create two PL/SQL packages:
   • Package A: API Calls to Create metadata Objects. This package must call the APIs described in Using APIs to Create Required Metadata Objects. Package A must create an Adapter Domain, Adapter Area, technology type, and all the required Oracle LSH objects (metadata) including a Program, upload Package B as source code for the Program, assign a user group to the Adapter Area, and install the Adapter Work Area.

     Note:

     When you run the APIs to create a technology type and an Adapter Area, you must enter the names of all your custom functions and procedures as input parameter values, and set flags to indicate whether or not you are using any of the three possible Parameter Sets.

     Therefore you must determine which custom functions and procedures and Parameter Sets you need, and give the functions and procedures names, before you can complete Package A. See Designing an Adapter.

   • Package B: Custom Functions and Procedures. This package contains the functions and procedures that you write to do the work of the adapter; see Planning PL/SQL Functions and Procedures.
4. Run Package A. The system creates the required metadata objects, including the technology type, and uploads Package B as the source code for the adapter.
5. Follow the steps in Checking In Objects and Setting Their Validation Status, and Setting Up an Adapter to set up your adapter in your Oracle LSH instance.
6. In Oracle LSH, create an object definition and instance of the type relevant for your adapter: a Load Set, Data Mart, Program, or Business Area.

   You may need to create an Oracle LSH Domain, Application Area, and Work Area to contain the object (Load Set, Program, Data Mart, or Business Area) definition and instance; Table definitions and instances for the object to read from or write to; install the Work Area, and load data.

7. Test the adapter by checking that the required UI elements appear on screen and that it is possible to define, install and run the object.
8. You can debug and modify your functions and procedures in your own schema. Use APIs to check out the Program in the Adapter Area, upload the revised source code, and reinstall the Adapter Area's Work Area, and then test again. See the Oracle Life Sciences Data Hub Application Programming Interface Guide.
9. Modify Package B as required. Upload the modified package using the Modify Source Code public API.
10. Set the validation status of your objects to Quality Control and then to Production according to your standard operating procedures; see Checking In Objects and Setting Their Validation Status.