9 Planned Outputs
This is a public interface for all Planned Output related functions including creating, modifying, removing, and copying Planned Outputs.
This chapter contains the following section:
Parent topic: Object APIs
Create and Modify Planned Outputs
This section contains the following topics:
- Create a Planned Output
- Get a New Position Number
- Get a Planned Output Object
- Modify a Planned Output
- Identify whether a SAS Object
- Remove a Planned Output Object
Parent topic: Planned Outputs
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
Get a New Position Number
Use this API to get a unique position number for a Planned Output within a parent object. This API is used from within the CREATEPLANNEDOUTPUT API, which is used to create a new Planned Output. You can also reorder Planned Outputs using this API.
Name
CDR_PUB_DF_PLANNED_OUTPUT.GetNewPositionNumber
Signature
FUNCTION GETNEWPOSITIONNUMBER( 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, PI_NCOMPANYID IN CDR_NAMINGS.COMPANY_ID%TYPE, PI_NOBJID IN CDR_NAMINGS.OBJ_ID%TYPE, PI_NOBJVER IN CDR_NAMING_VERSIONS.OBJ_VER%TYPE ) RETURN NUMBER;
Parameters
This API has standard parameters (see Standard Parameters) and the following parameters:
- PI_NCOMPANYID (Mandatory) Enter the COMPANY_ID of the parent object.
- PI_NOBJID (Mandatory) Enter the OBJ_ID of the parent object.
- PI_NOBJVER (Mandatory) Enter the OBJ_VER of the parent object.
Parent topic: Create and Modify Planned Outputs
Get a Planned Output Object
Use this API to retrieve a Planned Output object for an LSH object.
Name
CDR_PUB_DF_PLANNED_OUTPUT.GetPlannedOutputObject
Signature
FUNCTION GETPLANNEDOUTPUTOBJECT( 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, PI_NCOMPANYID IN CDR_NAMINGS.COMPANY_ID%TYPE, PI_NOBJID IN CDR_NAMINGS.OBJ_ID%TYPE, PI_NOBJVER IN CDR_NAMING_VERSIONS.OBJ_VER%TYPE, PO_PLANNEDOUTPUT OUT CDR_PLANNEDOUTPUT_OBJ_TYPE ) RETURN BOOLEAN;
Return
Type BOOLEAN
Parameters
This API has standard parameters (see Standard Parameters) and the following parameters:
- PI_NCOMPANYID (Mandatory) Enter your company ID. To get your company ID, use CDR_DF_PUB_DEF_CONSTANTS.CURRENT_COMPANY_ID.
- PI_NOBJID (Mandatory) Enter the OBJ_ID value of the object for which you want to retrieve the Planned Output object.
- PI_NOBJVER (Mandatory) Enter the OBJ_VER value of the object for which you want to retrieve the Planned Output's object.
- PO_PLANNEDOUTPUT This is the output parameter of the API returning the Planned Output Object.
Parent topic: Create and Modify Planned Outputs
Modify a Planned Output
Use this API to modify an existing Planned Output.
Name
CDR_PUB_DF_PLANNED_OUTPUT.ModifyPlannedOutput
Signature
PROCEDURE MODIFYPLANNEDOUTPUT( 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_SOURCECDRNAMING IN OUT CDR_NAMING_VERSION_OBJ_TYPE, PI_POUTOBJTYPE IN OUT CDR_PLANNEDOUTPUT_OBJ_TYPE );
Parameters
This API has standard parameters (see Standard Parameters) and the following parameters:
- PI_SOURCECDRNAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE. Enter values to identify the Planned Output.
- PI_POUTOBJTYPE (Mandatory) This is a parameter of table
CDR_PLANNEDOUTPUT_OBJ_TYPE that contains attributes specific to Planned Outputs. Enter
values for the Planned Output and enter new values for the attributes you want to modify.
You can change the name or description of a Planned Output.
Note:
Use separate APIs for modifying the validation status and the version label: CDR_PUB_VL_VALIDATION.UPDATE VAL STATUS and CDR_PUB_DF_NAMING.UPDATEVERSIONLABEL.
Parent topic: Create and Modify Planned Outputs
Identify whether a SAS Object
Use this API to check if the parent object of the Planned Output is a SAS object. SAS objects are: SAS programs, SAS load Sets, SAS Tables.
Name
CDR_PUB_DF_PLANNED_OUTPUT.IsSASObject
Signature
FUNCTION ISSASOBJECT( 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, PI_NCOMPANYID IN CDR_NAMINGS.COMPANY_ID%TYPE, PI_NOBJID IN CDR_NAMINGS.OBJ_ID%TYPE, PI_NOBJVER IN CDR_NAMING_VERSIONS.OBJ_VER%TYPE, PI_NSOBJTYPE IN CDR_NAMINGS.OBJECT_TYPE_RC%TYPE ) RETURN VARCHAR2;
Return
Type VARCHAR2 Description
Parameters
This API has standard parameters (see Standard Parameters) and the following parameters:
- PI_NCOMPANYID (Mandatory) Enter your company ID.
To get your company ID, use CDR_PUB_DEF_FACTORY_UTILS.GetCompanyId.
- PI_NOBJID (Mandatory) Enter the object ID of the Planned Output's parent object.
- PI_NOBJVER (Mandatory) Enter the version number of the Planned Output's parent object.
- PI_NSOBJTYPE (Mandatory) Enter the OBJ_TYPE value for the Planned Output's parent object.
Parent topic: Create and Modify Planned Outputs
Remove a Planned Output Object
Use this API to delete one or more Planned Outputs.
Name
CDR_PUB_DF_PLANNED_OUTPUT.RemovePlannedOutput
Signature
PROCEDURE REMOVEPLANNEDOUTPUT( 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_CDRBASEOBJCOLL IN OUT CDR_BASE_OBJ_COLL, PI_GETLOCK IN VARCHAR := 'T' );
Parameters
This API has standard parameters (see Standard Parameters) and the following parameters:
- PIO_CDRBASEOBJCOLL (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs.
For each Planned Output 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.
- PI_GETLOCK (Optional) Do not enter a value for this attribute. The default and only acceptable value is 'T'.
Parent topic: Create and Modify Planned Outputs