Planning PL/SQL Functions and Procedures

For each action a user performs in the user interface (UI) to define or install a Load Set, Data Mart, Program, or Business Area, or to run a Load Set, Data Mart, or Program or launch an IDE, you must write a PL/SQL function or procedure to do the work.

Oracle Life Sciences Data Hub designers have tried to anticipate every possible type of PL/SQL function or procedure that might be required by any adapter, and have added columns to the Adapter Areas table and the Tech Types table to store their names and call them at particular times for particular purposes. Each function and procedure has a required signature that is described in the following sections.

Note:

You are not required to supply every function and procedure. Write only those that are required for your adapter.

When you run the APIs to create an Adapter Area or Technology Type you enter the name of each function or procedure as the value for the the appropriate attribute.

Oracle LSH calls each function at the appropriate time (object definition, installation, or execution) if its name is in the Adapter Areas or Tech Types table, and automatically passes the required input parameter values to the function.

You include your functions and procedures in one or more PL/SQL packages and upload each package to a Source Code definition that you create inside the Program definition in the Adapter Area. If multiple people are coding your adapter at the same time, you may want to develop these functions and procedures in separate packages; see Planning Programs and Packages.

If you need user input for any of these functions, you need to define Parameter objects to collect the information in the user interface and refer to these Parameters in your source code. See Planning Parameters and Parameter Sets for further information.

For more information, see the following topics:

• Object Definition Functions and Procedures
  All object definition function and procedure names are stored in the adapter_areas table.
• Object Installation Functions
  Depending on the external system, you may need to write functions for use when a user installs a Load Set, Data Mart, Program, or Business Area. All object installation function names are stored in the tech_types table.
• Object Execution Functions and Procedures
  Execution-related functions are stored in either the tech_types table or the adapter_areas table.