4 Using APIs to Create Required Metadata Objects
Adapter Domains and the objects they contain are not accessible through the user interface. There is a public PL/SQL API for creating each of the objects required by an adapter.
Oracle Life Sciences Data Hub stores all the program code, parameters, and tables required for an adapter as defined objects within an Adapter Area which itself is contained in an Adapter Domain. Figure 1-1 shows the defined objects.
Additional information on APIs is available in the Oracle Life Sciences Data Hub Application Programming Interface Guide.
Call these APIs in the following order:
- Retrieving IDs
Many APIs require IDs as input parameter values. You can retrieve these IDs from the database. - Creating a Technology Type
To create a technology type, you must use an API. - Modifying a Technology Type
If you need to modify your Technology Type, use the public API CDR_PUB_ATK_ADAPTER. MODIFYTECHTYPE. - Creating an Adapter Domain
An Adapter Domain is a container object that holds all the definitional objects required for an adapter. - Modifying an Adapter Domain
If you need to modify your Adapter Domain, use the public API CDR_PUB_ATK_ADAPTER. MODIFYADAPTERDOMAIN. - Creating an Adapter Area
An Adapter Area is a container object that can hold all the definitional objects required for an adapter. - Modifying an Adapter Area
If you need to modify your Adapter Area, use public API CDR_PUB_ATK_ADAPTER.MODIFYADAPTERAREA. - Assigning a User Group to the Adapter Area
In order to create the rest of the required objects, you must belong to a user group that is assigned to the Adapter Area, and you must have a role within the user group that allows you to create and modify each of the required objects. - Creating a Work Area
A Work Area contains instances of all the object definitions required for the adapter. - Creating a Program Definition and Instance
You must create a Program definition in the Adapter Area to store the source code required for the adapter. You must create an instance of the Program definition in the Work Area. - Creating a Source Code Definition and Instance
You must create at least one Source Code object definition inside the Program definition to contain the PL/SQL packages you write. - Creating a Variable
If you need user input to create a Load Set, Data Mart, Program, or Business Area—for example, an Oracle Remote Location name and connection—you must define a Parameter to collect the information. For each Parameter, you must define a Variable for the Parameter to reference. - Creating a Parameter
Use Parameters to allow users to enter values during the definition or execution of a Load Set, Data Mart, Program, or Business Area. You must create a defined Parameter object for each parameter required and handle the user input in your source code. - Creating a Parameter Set
You may create one, two, or three Parameter Sets to collect user input during the definition, installation, or execution of a Load Set, Data Mart, or Program, or the launch of a visualization tool. - Creating a Parameter Instance in a Parameter Set
For each Parameter definition you have created, create a Parameter instance in the appropriate Parameter Set. - Creating a Table Definition
If you are creating a Load Set adapter and the external source data system has fixed data structures, you may want to define those data structures as Tables in the Adapter Area rather than uploading them or forcing the user to create them manually each time a user creates a Load Set. - Installing the Work Area
After you have created the Adapter Domain and all the definitional objects within it, install the Work Area by calling the API CDR_PUB_DF_WORKAREA.INSTALLWACONTROLLER and the Program instance it contains.