Planning Parameters and Parameter Sets

You must plan parameters and parameter sets to get information from the user.

If you need information from the user during Load Set, Data Mart, Program, or Business Area definition, installation, or execution, you must do the following:

• Define a Parameter Set in the Adapter Area with one of three required names and usage settings, depending on whether the Parameter value is required in order to define or install the object in general, to define Table Descriptors for the object, or to collect information at runtime.
• When you run the Create Adapter Area API, set a flag to indicate that this type of Parameter Set exists (although you must create the Adapter Area before you can create the Parameter Set).
• Define a Parameter for each piece of information you need to collect, and create an instance of it in the appropriate Parameter Set.

The system then displays the Parameters you define in the proper place in the user interface and uses their values at the correct time.

Note:

If you are developing an adapter for use in other locations and need to collect information about the Oracle Life Sciences Data Hub installation or the external system installation, you can use the Details field of the service defintion; see Planning Services.

For more information, see the following:

• General Define-Time Parameters
  If you need information from the user during Load Set, Data Mart, Program, or Business Area definition, create a Parameter Set named PARAMETERSET_LOADSETLEVEL_DEF and set its Usage attribute to DEFINITION.
• Table Descriptor Define-Time Parameters
  (Load Set adapters only) Load Sets' Table Descriptors are based on data structures in the external system.
• Runtime Parameters
  If you need information from the user when he or she runs the Load Set, Data Mart, or Program, or launches a visualization tool, create a Parameter Set named PARAMETERSET_LOADSETLEVEL_RUN and set its Usage attribute to EXECUTION.