Define_Time_Function

The system launches the Define-Time function from the Create page of a Load Set, Program, Data Mart, or Business Area when the user clicks Apply.

If all objects created using your adapter need the same Planned Output, or one or more Table Descriptors with a fixed structure, you can use the Define-Time function to create them automatically for every object of your adapter's type.

For example:

• Add a Planned Output as a placeholder for the log file or Data Mart file; call the public API CDR_PUB_DF_PLANNED_OUTPUT.CREATEPLANNEDOUTPUT.
• Add Parameters if you need to connect to a remote connection during definition
• If you are creating a Load Set adapter and your source data system has a fixed data structure, you may want to add Table definitions to the Adapter Area that match the source system's data structures and write code to use them to create target Table Descriptors at definition time.

Most shipped adapters use a Define-Time function.

The Define_Time_Function must have the following signature:

FUNCTION CreateLogFilePlannedOutput (pi_nCompanyID  IN NUMBER
  ,pi_nLSID       IN NUMBER
  ,pi_nLSVer      IN NUMBER) return BOOLEAN IS

The function's parameters take the following values:

• pi_nCompanyID see Getting Your Company ID
• pi_nLSID takes the Object ID of the Load Set definition
• pi_nLSVer takes the object version of the Load Set definition