Create a Planned Output
Use this API to create a Planned Output.
Name
CDR_PUB_DF_PLANNED_OUTPUT.CreatePlannedOutput
Signature
PROCEDURE CREATEPLANNEDOUTPUT( 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, PI_PLANNEDOUTPUTOBJTYPE IN OUT CDR_PLANNEDOUTPUT_OBJ_TYPE, PI_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 type
CDR_NAMING_VERSIONS_OBJ_TYPE.
The following attributes are required: COMPANY_ID, OBJECT_TYPE_RC, NAME, NAMESPACE_OBJ_ID, NAMESPACE_OBJ_VER, OWNING_LOCATION_RC, OBJECT_SUBTYPE_ID, DESCRIPTION, REF_COMPANY_ID, REF_OBJ_ID, REF_OBJ_VER.
For OBJECT_TYPE_RC enter $OBJTYPES$PLANNEDOUT.
- PI_PLANNEDOUTPUTOBJTYPE (Mandatory) This is a parameter of table type
CDR_PLANNEDOUTPUT_OBJ_TYPE.
You need to pass the following attributes: COMPANY_ID, OBJ_ID, OBJ_VER,TITLE, POSITION, FILEREF, FILE_NAME, PRIMARY_FLAG_RC, ERROR_FILE_FLAG_RC, REQ_FILE_FLAG_RC.
For the POSITION attribute, use the GETNEWPOSITIONNUMBER API.
- PI_DEFCLASSIFICATIONCOLL (Optional) By default the new PLANNED OUTPUT 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.
If you want to use a Parameter to classify the actual output, use the PAR attributes to identify the Parameter. The Parameter's list of values must be based on a classification hierarchy level.
Parent topic: Create and Modify Planned Outputs