Submit an Execution Setup for Compound Objects

Use this API to submit an Execution Setup for compound objects such as Report Sets and Workflows.

The API takes care of both, populating the temporary tables for execution and submitting the job, so that you do not need to invoke the loadESTempTable explicitly.

Name

CDR_PUB_DF_EXECUTIONSETUP.SubmitExecutionSetup

Signature

PROCEDURE SUBMITEXECUTIONSETUP(
P_API_VERSION IN NUMBER,
P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE
P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,
X_RETURN_STATUS OUT NOCOPY VARCHAR2,
X_MSG_COUNT OUT NOCOPY NUMBER,
X_MSG_DATA OUT NOCOPY VARCHAR2,
PI_EXECUTIONSETUP IN OUT NOCOPY CDR_BASE_OBJ_TYPE,
PIO_CHANGEDSYSTEMPARAMETERCOLL IN OUT NOCOPY CDR_SUBMISSION_DETAILS_COLL,
PI_TICOLL IN CDR_SNAPSHOT_TABLE_COLL,
PI_EXEPARAMCOLL IN OUT NOCOPY CDR_PARAMETER_COLL,
PI_EXEOBJCOLL IN OUT NOCOPY CDR_PARAMETER_COLL,
PI_NODEPRREFID IN NUMBER DEFAULT NULL,
PI_NODEPRREFVER IN NUMBER DEFAULT NULL,
PI_JOBID IN NUMBER DEFAULT NULL,
PO_JOBID OUT NOCOPY VARCHAR2,
PI_OUTPUTTITLE IN VARCHAR2,
PI_OUTPUTDESC IN VARCHAR2);

Parameters

This API has standard parameters (see Standard Parameters) and the following parameters:

• PARAM P_API_VERSION. The API uses this parameter to compare the version numbers of incoming calls to its current version number, and returns an unexpected error if the versions are incompatible.
• PARAM P_INIT_MSG_LIST. Use this parameter to request that the API initialize the message list. By default, this parameter is set to FND_API.G_FALSE, meaning that APIs do not initialize the message list unless specifically instructed by the user.
• PARAM P_COMMIT. Use this parameter to instruct the API to commit after performing its function. By default, this parameter is set to FND_API.G_FALSE, meaning that APIs do not commit unless instructed by the user.
• PARAM P_VALIDATION_LEVEL. This parameter helps the API to determine those validation steps to execute and those to skip. The curent behavior is that the API performs a full validation.
• PARAM PI_EXECUTIONSETUP. The base object type of Execution setup for which a Submit is requested.
• PARAM PIO_CHANGEDSYSTEMPARAMETERCOLL. The collection of SYSTEM parameters.
• PARAM PI_TICOLL. The collection of Table Instances referenced from the Object Instance hierarchy with the Currency information as specified by the user.
• PARAM PI_EXEPARAMCOLL. The collection of CDR_PARAMETER_OBJ_TYPE parameters. This can be passed as null, but if you want to overwrite a parameter's value for submission, then populate this with the Parameter object details and assign the DEFAULT_VALUE attribute to the overwritten parameter value.

  The other required attributes are COMPANY_ID, OBJ_ID, OBJ_VER and DEFAULT_VALE.

• PARAM PI_EXEOBJCOLL. This is a collection of CDR_PARAMETER_OBJ_TYPE parameters that contains the PRREF_IDs of Programs to be included in the Execution Setup.

  For Report Sets and Report Set Entries, enter the PRREF_IDs of those selected Report Sets that may be included for execution. Use PRREF_ID, PRREF_VER of Objects to OBJ_ID, OBJ_VER of CDR_PARAMETER_OBJ_TYPE. Set DEFAULT_VALE as 'Y'. You do not need to assign other attributes except COMPANY_ID, OBJ_ID, OBJ_VER and DEFAULT_VALUE.

• PARAM PI_NODEPRREFID. To submit only a single node(RSE), pass its PrrefId; else, pass this parameter as null.
• PARAM PI_NODEPRREFVER. To submit only a single node, pass its PrrefVer; else, pass as null.
• PARAM PI_JOBID. To resubmit a job, pass the previous JobId; else, pass as null.
• PARAM PO_JOBID. The Job ID that is created during the submission.
• PARAM PI_OUTPUTTITLE. The suffix of the output's title.
• PARAM PI_OUTPUTDESC. The suffix of the output's description.