20 Execution Setups
This is a public interface for Execution Setup-related operations, including creating, modifying, and removing Execution Setups. It also includes functions for checking Execution Setups in and out.
This chapter contains this section:
Parent topic: Common APIs
Create and Modify Execution Setups
This section contains the following topics:
- Create an Execution Setup
- Check Out an Execution Setup
- Modify an Execution Setup
- Modify a Parameter
- Modify an Execution Setup Parameter
- Load Parameter Details
- Copy an Execution Setup
- Check In an Execution Setup
- Submit an Execution Setup
- Submit an Execution Setup for Instances
- Submit an Execution Setup for Compound Objects
- Upgrade an Execution Setup
- Upgrade All Execution Setups
- Make an Execution Setup Active
- Remove an Execution Setup
Parent topic: Execution Setups
Create an Execution Setup
Use this API to create a new Execution Setup.
Name
CDR_PUB_DF_EXECUTIONSETUP.CreateExecutionSetup
Signature
PROCEDURE CREATEEXECUTIONSETUP( P_API_VERSION IN NUMBER, P_INIT_MSG_LIST IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT VARCHAR2, X_MSG_COUNT OUT NUMBER, X_MSG_DATA OUT VARCHAR2, PIO_SOURCECDRNAMING IN OUT CDR_NAMING_VERSION_OBJ_TYPE, PO_DEFCLASSIFICATIONCOLL IN CDR_CLASSIFICATIONS_COLL );
Parameters
This API has standard parameters (see Standard Parameters) and the following parameters:
- PIO_SOURCECDRNAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSIONS_OBJ_TYPE that contains CDR Naming Version attributes. For OBJECT_TYPE_RC enter $OBJTYPES$EXECSETUP.
- PO_DEFCLASSIFICATIONCOLL (Optional) By default the new definition is
classified according to the subtype you assigned it in the CDR_NAMING_VERSION_OBJ_TYPE.
If you want to override the default classifications for one or more classification levels, use this parameter. This is a collection of CDR_CLA_OBJ_TYPEs, which have 5 attributes, including CLA_LEVEL_ID and CLASSIFICATION_ID.
If you want the definition to inherit its classifications for a particular level from its parent, enter the classification level ID and, for the CLASSIFICATION_ID, enter 0 (zero).
If you want to explicitly assign one or more terms for a particular level, initialize a CDR_CLA_OBJ_TYPE for each term, entering the classification level ID and, for the CLASSIFICATION_ID, the term ID. The PAR_ attributes are not relevant to Execution Setups. Do not enter any values for them. If you are not creating a new definition, do not enter values here.
Parent topic: Create and Modify Execution Setups
Check Out an Execution Setup
Use this API to check out an Execution Setup.
Name
CDR_PUB_DF_EXECUTIONSETUP.CheckOutExecutionSetup
Signature
PROCEDURE CHECKOUTEXECUTIONSETUP( P_API_VERSION IN NUMBER, P_INIT_MSG_LIST IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT VARCHAR2, X_MSG_COUNT OUT NUMBER, X_MSG_DATA OUT VARCHAR2, PIO_BASEOBJECT IN OUT CDR_BASE_OBJ_TYPE, PI_COMMENT IN VARCHAR2, PI_ISINSTONLY IN VARCHAR2 );
Parameters
This API has standard parameters (see Standard Parameters) and the following parameters:
- PIO_BASEOBJECT (Mandatory) This is a parameter of table type
CDR_BASE_OBJ_TYPE. Enter values to identify the Execution Setup that you want to check
out.
The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.
- PI_COMMENT (Optional) Enter the reason you are checking out the Execution Setup.
- PI_ISINSTONLY (Mandatory) Enter $YESNO$NO.
Parent topic: Create and Modify Execution Setups
Modify an Execution Setup
Use this API to modify an Execution Setup. You can change an Execution Setup's name and description. You must check out the Execution Setup before modifying it.
Name
CDR_PUB_DF_EXECUTIONSETUP.ModifyExecutionSetup
Signature
PROCEDURE MODIFYEXECUTIONSETUP( P_API_VERSION IN NUMBER, P_INIT_MSG_LIST IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT VARCHAR2, X_MSG_COUNT OUT NUMBER, X_MSG_DATA OUT VARCHAR2, PIO_SOURCECDRNAMING IN OUT CDR_NAMING_VERSION_OBJ_TYPE );
Parameters
This API has standard parameters (see Standard Parameters) and the following parameter:
- PIO_SOURCECDRNAMING (Mandatory) This is a parameter of table type
CDR_NAMING_VERSION_OBJ_TYPE. Enter values to identify the Execution Setup and enter new
values for the attributes you want to modify. All attributes are required.
Note:
Use separate APIs for modifying the validation status and the version label: CDR_PUB_VL_VALIDATION.UPDATEVALSTATUS and CDR_PUB_DF_NAMING.UPDATEVERSIONLABEL.
Parent topic: Create and Modify Execution Setups
Modify a Parameter
Use this API to modify Execution Setup parameters.
Name
CDR_PUB_DF_EXECUTIONSETUP.ModifyParameter
Signature
PROCEDURE MODIFYPARAMETER( P_API_VERSION IN NUMBER, P_INIT_MSG_LIST IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT VARCHAR2, X_MSG_COUNT OUT NUMBER, X_MSG_DATA OUT VARCHAR2, PI_CHANGEDPARAMETERCOLL IN CDR_SUBMISSION_DETAILS_COLL );
Parameters
This API has standard parameters (see Standard Parameters) and the following parameter:
PI_CHANGEDPARAMETERCOLL (Mandatory) This is a collection of CDR_SUBMISSION_DETAILS.Collection of Parameter Instances on which the modify operation has been requested.
Parent topic: Create and Modify Execution Setups
Modify an Execution Setup Parameter
Use this API to modify the parameters of an Execution Setup.
Name
CDR_PUB_DF_EXECUTIONSETUP.ModifYesParameters
Signature
PROCEDURE MODIFYESPARAMETERS( P_API_VERSION IN NUMBER, P_INIT_MSG_LIST IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT VARCHAR2, X_MSG_COUNT OUT NUMBER, X_MSG_DATA OUT VARCHAR2, PIO_PARAMETERCOLL IN OUT CDR_PARAMETER_COLL );
Parameters
This API has standard parameters (see Standard Parameters) and the following parameter:
PIO_PARAMETERCOLL (Mandatory) This is a collection of cdr_parameter_coll. Enter the values for parameters you want to change.
The attributes you can change are: read_only_flag_rc, mandatory_flag_rc, and visible_flag_rc. Enter $yesno$yes for yes, and $yesno$no for no.
Parent topic: Create and Modify Execution Setups
Load Parameter Details
Use this API to insert all parameters into a CDR_ES_TEMP table before submitting Report Set instance and Work Flow instance jobs.
Name
CDR_PUB_DF_EXECUTIONSETUP.LoadESTempTable
Signature
PROCEDURE LOADESTEMPTABLE( P_API_VERSION IN NUMBER, P_INIT_MSG_LIST IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT VARCHAR2, X_MSG_COUNT OUT NUMBER, X_MSG_DATA OUT VARCHAR2, PI_BASEOBJ IN CDR_BASE_OBJ_TYPE, PI_NODEPRREFID IN NUMBER := NULL, PI_NODEPRREFVER IN NUMBER := NULL, PI_JOBID IN NUMBER := NULL );
Parameters
This API has standard parameters (see Standard Parameters) and the following parameters:
- PI_BASEOBJ (Mandatory) This is a parameter of cdr_base_obj type for the Execution Setup. Enter the necessary attributes.
- PI_NODEPRREFID (Mandatory) If you are submitting a single RSE, enter the prref_id of that RSE, else enter NULL.
- PI_NODEPRREFVER (Mandatory) If you are submitting a single RSE, enter the prref_ver of that RSE, else enter NULL.
- PI_JOBID (Mandatory) If you are re-submitting an existing job, enter the previous job_id, else enter NULL.
Parent topic: Create and Modify Execution Setups
Copy an Execution Setup
Use this API to duplicate one or more Execution Setups for an object.
Name
CDR_PUB_DF_EXECUTIONSETUP.CopyExecutionSetup
Signature
PROCEDURE COPYEXECUTIONSETUP( P_API_VERSION IN NUMBER, P_INIT_MSG_LIST IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT VARCHAR2, X_MSG_COUNT OUT NUMBER, X_MSG_DATA OUT VARCHAR2, PI_EXECUTIONSETUP IN OUT CDR_BASE_OBJ_COLL );
Parameters
This API has standard parameters (see Standard Parameters) and the following parameter:
- PI_EXECUTIONSETUP (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs. For
each Execution Setup that you want to copy, initialize a CDR_BASE_OBJ_TYPE and then extend
the collection.
The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.
Parent topic: Create and Modify Execution Setups
Check In an Execution Setup
Use this API to check in an Execution Setup.
Name
CDR_PUB_DF_EXECUTIONSETUP.CheckInExecutionSetup
Signature
PROCEDURE CHECKINEXECUTIONSETUP( P_API_VERSION IN NUMBER, P_INIT_MSG_LIST IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT VARCHAR2, X_MSG_COUNT OUT NUMBER, X_MSG_DATA OUT VARCHAR2, PIO_BASEOBJECT IN OUT CDR_BASE_OBJ_TYPE, PI_COMMENT IN VARCHAR2 );
Parameters
This API has standard parameters (see Standard Parameters) and the following parameters:
- PIO_BASEOBJECT (Mandatory) This is a parameter of table type
CDR_BASE_OBJ_TYPE. Enter values to identify the Execution Setup that you want to check in.
The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER
- PI_COMMENT (Optional) Enter the reason you are checking in the Execution Setup.
Parent topic: Create and Modify Execution Setups
Submit an Execution Setup
Use this API to submit an Execution Setup.
Name
CDR_PUB_DF_EXECUTIONSETUP.SubmitExecutionSetup
Signature
PROCEDURE SUBMITEXECUTIONSETUP( P_API_VERSION IN NUMBER, P_INIT_MSG_LIST IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT VARCHAR2, X_MSG_COUNT OUT NUMBER, X_MSG_DATA OUT VARCHAR2, PI_EXECUTIONSETUP IN CDR_BASE_OBJ_TYPE, PI_CHANGEDSYSTEMPARAMETERCOLL IN CDR_SUBMISSION_DETAILS_COLL, PI_TICOLL IN CDR_SNAPSHOT_TABLE_COLL, PI_INCLUDEDOBJCOLL IN CDR_SUBMISSION_DETAILS_COLL, PI_CURRENTJOBID OUT VARCHAR2, PI_OUTPUTTITLE IN VARCHAR2, PI_OUTPUTDESC IN VARCHAR2 );
Parameters
This API has standard parameters (see Standard Parameters) and the following parameters:
- PI_EXECUTIONSETUP (Mandatory) This is a parameter of table type
CDR_BASE_OBJ_TYPE. Enter values to identify the Execution Setup that you want to submit.
The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.
- PIO_CHANGEDSYSTEMPARAMETERCOLL (Mandatory) This is a parameter of
cdr_submission_details_coll type.
You must provide values for the following system parameters: company_id (use CDR_DF_PUB_DEF_CONSTANTS.CURRENT_COMPANY_ID); submission_id (enter null); prref_id (enter -1), prref_ver (enter -1), parameter_ref_obj_id, and parameter_ref_obj_id. Query cdr_parameters on company_id, obj_id, and obj_ver to find values for the default_value attribute. Use this value to set the attribute parameter_value.
- PI_TICOLL (Mandatory) This is a collection of CDR_SNAPSHOT_TABLE_OBJ_TYPE.
- PI_INCLUDEDOBJCOLL (Mandatory) This is a collection of CDR_SUBMISSION_DETAILS_OBJ_TYPE that contains PRREF_IDs of Programs to include in the Execution Setup. For Report Sets and Report Set Entries, the user can include only selected Report Sets for execution. Enter only those PRREF_IDs.
- PI_CURRENTJOBID (Mandatory) Enter the JOB_ID of the Job that this Execution Setup submission created. This parameter is used to generate user's feedback.
- PI_OUTPUTTITLE (Mandatory) Enter a title for the output from this Execution Setup.
- PI_OUTPUTDESC (Mandatory) Enter the description for the output from this Execution Setup.
Parent topic: Create and Modify Execution Setups
Submit an Execution Setup for Instances
Use this API to submit an Execution Setup for Report Set instances and Workflow instances. You must call the loadESTempTable API before calling this API.
Name
CDR_PUB_DF_EXECUTIONSETUP.SubmitExecutionSetup
Signature
PROCEDURE SUBMITEXECUTIONSETUP( P_API_VERSION IN NUMBER, P_INIT_MSG_LIST IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT VARCHAR2, X_MSG_COUNT OUT NUMBER, X_MSG_DATA OUT VARCHAR2, PI_EXECUTIONSETUP IN OUT CDR_BASE_OBJ_TYPE, PIO_CHANGEDSYSTEMPARAMETERCOLL IN OUT CDR_SUBMISSION_DETAILS_COLL, PI_TICOLL IN CDR_SNAPSHOT_TABLE_COLL, PO_CURRENTJOBID OUT VARCHAR2, PI_OUTPUTTITLE IN VARCHAR2, PI_OUTPUTDESC IN VARCHAR2 );
Parameters
This API has standard parameters (see Standard Parameters) and the following parameters:
- PI_EXECUTIONSETUP (Mandatory) This is a parameter of cdr_base_obj_type.
Enter values for attributes that describe the Execution Setup: COMPANY_ID, OBJ_ID, OBJ_VER, NAMESPACE_OBJ_ID, NAMESPACE_OBJ_VER,OBJECT_VERSION_NUMBER.
- PIO_CHANGEDSYSTEMPARAMETERCOLL (Mandatory) This is a parameter of
cdr_submission_details_coll type.
You must provide values for the following system parameters: company_id (use CDR_DF_PUB_DEF_CONSTANTS.CURRENT_COMPANY_ID); submission_id (enter null); prref_id (enter -1), prref_ver (enter -1), parameter_ref_obj_id, and parameter_ref_obj_id. Query cdr_parameters on company_id, obj_id, and obj_ver to find values for the default_value attribute. Use this value to set the attribute parameter_value.
- PI_TICOLL (Mandatory) This is a collection of data snapshots. This value may
be null if you want to use current data.
Otherwise the required attributes are: TI_OBJ_ID,TI_OBJ_VER,SRC_MASTER_JOB_ID,SRC_COMPANY_ID
- PO_CURRENTJOBID (Mandatory) This is an output parameter. The system generates a Job ID for the submitted Execution Setup. You can print this parameter through your program.
- PI_OUTPUTTITLE (Mandatory) Enter a title for the Execution Setup. It is easy to track an Execution Setup with a meaningful title.
- PI_OUTPUTDESC (Mandatory) Enter a description for the Execution Setup output.
Parent topic: Create and Modify Execution Setups
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.
Parent topic: Create and Modify Execution Setups
Upgrade an Execution Setup
Use this API to upgrade one single Execution Setup.
Name
CDR_PUB_DF_EXECUTIONSETUP.UpgradeExecSetup
Signature
PROCEDURE UPGRADEEXECSETUP( P_API_VERSION IN NUMBER, P_INIT_MSG_LIST IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT VARCHAR2, X_MSG_COUNT OUT NUMBER, X_MSG_DATA OUT VARCHAR2, PI_ESCOMPID IN NUMBER, PI_ESOBJID IN NUMBER, PI_ESOBJVER IN NUMBER, PO_UPGRADESTATUS IN OUT VARCHAR2 );
Parameters
This API has standard parameters (see Standard Parameters) and the following parameters:
- PI_ESCOMPID (Mandatory) Enter the COMPANY_ID of the Execution Setup.
- PI_ESOBJID (Mandatory) Enter the OBJ_ID of the Execution Setup.
- PI_ESOBJVER (Mandatory) Enter the OBJ_VER of the Execution Setup.
- PO_UPGRADESTATUS This is an output parameter that indicates whether or not the Execution Setup's upgrade was successful.
Parent topic: Create and Modify Execution Setups
Upgrade All Execution Setups
Use this API to upgrade all the Execution Setups associated with an object.
Name
CDR_PUB_DF_EXECUTIONSETUP.UpgradeExecSetups
Signature
PROCEDURE UPGRADEEXECSETUPS( P_API_VERSION IN NUMBER, P_INIT_MSG_LIST IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT VARCHAR2, X_MSG_COUNT OUT NUMBER, X_MSG_DATA OUT VARCHAR2, PI_EOICOMPID IN NUMBER, PI_EOIOBJID IN NUMBER, PI_EOIOBJVER IN NUMBER, PO_NOTRUNNABLEESLIST OUT CDR_BASE_OBJ_COLL );
Parameters
This API has standard parameters (see Standard Parameters) and the following parameters:
- PI_EOICOMPID (Mandatory) Enter the COMPANY_ID of the executable object instance for which the Execution Setup is intended.
- PI_EOIOBJID (Mandatory) Enter the OBJ_ID of the executable object instance for which the Execution Setup is intended.
- PI_EOIOBJVER (Mandatory) Enter the OBJ_VER of the executable object instance for which the Execution Setup is intended.
- PO_NOTRUNNABLEESLIST This is an output parameter that returns a collection of CDR_BASE_OBJ_TYPE containing Execution Setups whose status has changed from Runnable to Not-Runnable.
Parent topic: Create and Modify Execution Setups
Make an Execution Setup Active
Use this API to set the status of an Execution Setup to Active.
Name
CDR_PUB_DF_EXECUTIONSETUP.SetActive
Signature
PROCEDURE SETACTIVE( P_API_VERSION IN NUMBER, P_INIT_MSG_LIST IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT VARCHAR2, X_MSG_COUNT OUT NUMBER, X_MSG_DATA OUT VARCHAR2, PI_ESCOMPID IN NUMBER, PI_ESOBJID IN NUMBER, PI_ESOBJVER IN NUMBER );
Parameters
This API has standard parameters (see Standard Parameters) and the following parameters:
- PI_ESCOMPID (Mandatory) Enter the COMPANY_ID of the Execution Setup.
- PI_ESOBJID (Mandatory) Enter the OBJ_ID of the Execution Setup.
- PI_ESOBJVER (Mandatory) Enter the OBJ_VER of the Execution Setup.
Parent topic: Create and Modify Execution Setups
Remove an Execution Setup
Use this API to delete an Execution Setup.
Name
CDR_PUB_DF_EXECUTIONSETUP.RemoveExecutionSetup
Signature
PROCEDURE REMOVEEXECUTIONSETUP( P_API_VERSION IN NUMBER, P_INIT_MSG_LIST IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT VARCHAR2, X_MSG_COUNT OUT NUMBER, X_MSG_DATA OUT VARCHAR2, PI_EXECUTIONSETUP IN OUT CDR_BASE_OBJ_COLL );
Parameters
This API has standard parameters (see Standard Parameters) and the following parameter:
PI_EXECUTIONSETUP (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs. For each Execution Setup that you want to remove, initialize a CDR_BASE_OBJ_TYPE and then extend the collection.
The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.
Parent topic: Create and Modify Execution Setups