Work Areas

Create a Work Area

Use this API to create a new Work Area.

Name

CDR_PUB_DF_WORKAREA.CreateWorkArea

Signature

PROCEDURE CREATEWORKAREA( 
  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, 
  PIO_WORKAREAOBJTYPE  IN OUT    CDR_WORKAREA_OBJ_TYPE, 
  PI_DEFCLASSIFICATIONCOLL  IN    CDR_CLASSIFICATIONS_COLL 
);

Parameters

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

PIO_WORKAREAOBJTYPE (Mandatory) This is a parameter of table type CDR_WORKAREA_OBJ_TYPE that contains object attributes specific to Work Areas. Enter values for the Work Area that you want to create.
The following attributes are required: COMPANY_ID, OBJ_ID, OBJ_VER. For OBJECT_TYPE_RC enter $OBJTYPES$WORKAREA. By default, new Work Areas receive a Usage Intent value of Development.
PIO_SOURCECDRNAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE. Enter values to identify the Work Area that you want to create.
The following attributes are required: COMPANY_ID,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER,OBJECT_TYPE_RC. FOR OBJECT_TYPE_RC ENTER $OBJTYPES$WORKAREA.
PI_DEFCLASSIFICATIONCOLL (Optional) By default the new Work Area 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 Work Area to inherit its classifications for a particular level from its parent Application Area, 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 Work Areas. Do not enter any values for them.

Parent topic: Define and Modify Work Areas

Install a Work Area

Use this API to install a Work Area and the instance objects in it that you specify. The API first tries to check in the Work Area and all the object instances included in the installation. If any object included in the installation is checked out by another user, the installation fails.

Name

CDR_PUB_DF_WORKAREA.InstallWAController

Signature

PROCEDURE INSTALLWACONTROLLER( 
  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_OWABASENAMING  IN OUT    CDR_BASE_OBJ_TYPE, 
  PI_VINSTALLMODE  IN    CDR_INSTALLATIONS.INSTALLATION_MODE_RC%TYPE, 
  PI_VFORCEREGEN  IN    CDR_INSTALLATIONS.FORCE_REGEN_FLAG_RC%TYPE, 
  PI_VBATCH  IN    CDR_INSTALLATIONS.BATCH_FLAG_RC%TYPE, 
  PI_VACTION  IN    CDR_INST_ELEMENTS.INSTALL_ACTION_RC%TYPE, 
  PI_COINSTDETAILS  IN    CDR_INSTALLATION_DETAILS_COLL 
);

Parameters

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

PIO_OWABASENAMING (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Work Area that you want to install. The following attributes are required: COMPANY_ID,OBJECT_ID,OBJECT_VER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER, OBJECT_VERSION_NUMBER.
PI_VINSTALLMODE (Mandatory) Specify the installation mode you want to use: Enter FULL, UPGRADE, or PARTIAL.
PI_VFORCEREGEN (Optional) If you selected Upgrade mode, enter $YESNO$YES to force the system to generate new install scripts (and reinstall) all objects, whether or not they have been modified since the last installation of this Work Area. Enter $YESNO$NO to generate install scripts only for objects and object versions that have never been successfully installed.
PI_VBATCH (Mandatory) Enter $YESNO$YES to perform installation in batch mode. Enter $YESNO$NO to perform installation in interactive mode.
PI_VACTION (Mandatory) Enter COMPLETE if this is the first time the Work Area is being installed, or if the last installation was successful, or if the last installation failed and you want to continue from the last successfully completed phase. Enter CANCEL if the last installation failed and you want to begin the installation process from the beginning.
PI_COINSTDETAILS (Mandatory) This is a collection of CDR_INST_DET_OBJ_TYPEs. For each object in the Work Area that you want to install, initialize a CDR_INST_DET_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.

For OMIT_FROM_INSTALL_FLAG_RC, enter $YESNO$NO to include the object in the installation, subject to the rules for the installation type (Full, Partial, or Upgrade). If you are performing installation in PARTIAL mode, you must provide a value for each object for INSTALL_ACTION_RC of to indicate if you want to drop and replace or upgrade each object.

Parent topic: Define and Modify Work Areas

Check In a Work Area

Use this API to check in a Work Area and all the object instances it contains.

Name

CDR_PUB_DF_WORKAREA.CheckInWorkArea

Signature

PROCEDURE CHECKINWORKAREA( 
  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_BASENAMING  IN OUT    CDR_BASE_OBJ_TYPE, 
  PI_COMMENT  IN    VARCHAR2 
);

Parameters

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

PIO_BASENAMING (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Work Area that you want to check in.
The following attributes are required: COMPANY_ID,OBJECT_ID,OBJECT_VER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER, OBJECT_VERSION_NUMBER.
PI_COMMENT (Optional) Enter the reason you are checking in the Work Area.

Parent topic: Define and Modify Work Areas

Modify a Work Area

Use this API to modify the name and/or description of an existing Work Area. (Use CDR_PUB_DF_WORKAREA.UPDATEUSAGEINTENT to modify a Work Area's Usage Intent attribute.)

Name

CDR_PUB_DF_WORKAREA.ModifyWorkArea

Signature

PROCEDURE MODIFYWORKAREA( 
  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, 
  PIO_WORKAREAOBJTYPE  IN OUT    CDR_WORKAREA_OBJ_TYPE 
);

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_VERSION_OBJ_TYPE. Enter values to identify the Work Area that you want to modify and the values you want to change. All attributes are required.
PIO_WORKAREAOBJTYPE (Mandatory) This is a parameter of table type CDR_WORKAREA_OBJ_TYPE that contains object attributes specific to Work Areas. Enter values to identify the Work Area that you want to modify and enter new values for the attributes you want to modify.

Parent topic: Define and Modify Work Areas

Clone a Work Area

Use this API to clone a Work Area. If you specify another Work Area as the target, this API overwrites that Work Area with the source Work Area. If you specify an Application Area as the target, this API creates a new Work Area identical to the source Work Area in the Application Area you specify.

Name

CDR_PUB_DF_WORKAREA.CloneWorkArea

Signature

PROCEDURE CLONEWORKAREA( 
  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_SOURCEOBJECT  IN OUT    CDR_BASE_OBJ_TYPE, 
  PIO_TARGETOBJECT  IN OUT    CDR_BASE_OBJ_TYPE, 
  PI_VLABEL  IN    CDR_WORKAREAS.LABEL%TYPE, 
  PI_VUSAGEINTENTRC  IN    CDR_WORKAREAS.USAGE_INTENT_RC%TYPE 
);

Parameters

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

PIO_SOURCEOBJECT (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Work Area that you want to clone.
The following attributes are required: COMPANY_ID, OBJECT_ID, OBJECT_VER, NAMESPACE_OBJ_ID, NAMESPACE_OBJ_VER, OBJECT_VERSION_NUMBER.
PIO_TARGETOBJECT (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Work Area or Application Area to serve as the target of the clone. If you specify a Work Area, this API overwrites it with the source Work Area. If you specify an Application Area, this API creates a new Work Area identical to the source Work Area in the Application Area.
The following attributes are required: COMPANY_ID, OBJ_ID,OBJ_VER, OBJECT_VERSION_NUMBER, NAMESPACE_OBJ_ID, NAMESPACE_OBJ_VER.
PI_VLABEL (Mandatory) Enter text for the label you want to assign to the source and target Work Areas.
PI_VUSAGEINTENTRC (Optional) Enter a value for the Usage Intent attribute of the target Work Area. If you do not enter a value, the API assigns the Usage Intent value of the source Work Area to the target Work Area.

Parent topic: Define and Modify Work Areas

Copy Objects into a Work Area

Use this API to copy one or more objects into a Work Area.

Name

CDR_PUB_DF_WORKAREA.CopyObjectsIntoWA

Signature

PROCEDURE COPYOBJECTSINTOWA( 
  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_CDRPRREFOBJCOLL  IN    CDR_PRREF_OBJ_COLL, 
  PI_CDRTARGETCONTAINEROBJECT  IN OUT    CDR_PRREF_OBJ_TYPE, 
  PI_CHECKINFLAG  IN    VARCHAR, 
  PI_COPYPRGASSGNMT  IN    VARCHAR 
);

Parameters

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

PI_CDRPRREFOBJCOLL (Mandatory) This is a collection of Prref objects that contains information about the instance objects you want to copy into the Work Area.
Provide values for the attributes COMPANY_ID, OBJ_ID, OBJ_VER, PRREF_ID, PRREF_VER, NAMESPACE_OBJ_ID, NAMESPACE_OBJ_VER,OBJECT_VERSION_NUMBER for each instance object. The PRREF_ID and PRREF_VER attributes store the hierarchy information for objects.
PI_CDRTARGETCONTAINEROBJECT (Mandatory) This is a parameter of Prref object type that describes the target Work Area.
Enter values for the attributes COMPANY_ID, OBJ_ID, OBJ_VER, PRREF_ID, PRREF_VER, NAMESPACE_OBJ_ID, NAMESPACE_OBJ_VER,OBJECT_VERSION_NUMBER.
PI_CHECKINFLAG (Mandatory) Enter 'Y' for this flag.
PI_COPYPRGASSGNMT (Optional) This parameter is not applicable.

Parent topic: Define and Modify Work Areas

Clone an Object

Use this API to clone one or more instance objects in a Work Area.

Name

CDR_PUB_DF_WORKAREA.CloneObjects

Signature

PROCEDURE CLONEOBJECTS( 
  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_SRCINSTBASEOBJCOLL  IN OUT    CDR_BASE_OBJ_COLL, 
  PI_TGTWABASEOBJTYPE  IN OUT    CDR_BASE_OBJ_TYPE 
);

Parameters

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

PI_SRCINSTBASEOBJCOLL (Mandatory) This is a collection of base objects that you want to clone in the Work Area.
Enter the attributes COMPANY_ID, OBJ_ID, OBJ_VER, PRREF_ID, PRREF_VER, NAMESPACE_OBJ_ID, NAMESAPCE_OBJ_VER,OBJECT_VERSION_NUMBER for each instance object.
PI_TGTWABASEOBJTYPE (Mandatory) This is a parameter of base object type that describes the Work Area.
Enter the Work Area's COMPANY_ID, OBJ_ID, OBJ_VER, NAMESPACE_OBJ_ID, NAMESPACE_OBJ_VER,OBJECT_VERSION_NUMBER.

Parent topic: Define and Modify Work Areas

Remove a Work Area

Use this API to remove a Work Area and all the instance objects it contains.

Name

CDR_PUB_DF_WORKAREA.RemoveWorkArea

Signature

PROCEDURE REMOVEWORKAREA( 
  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 parameters:

PIO_SOURCECDRNAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE. Enter values to identify the Work Area that you want to remove. The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.

Parent topic: Define and Modify Work Areas

Get the Usage Intent RC of a Work Area

Use this API to retrieve the current value of the Usage Intent attribute for a particular Work Area.

Name

CDR_PUB_DF_WORKAREA.GetUsageIntentRC

Signature

PROCEDURE GETUSAGEINTENTRC( 
  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_COMPANY_ID  IN    CDR_NAMINGS.COMPANY_ID%TYPE, 
  PI_OBJ_ID  IN    CDR_NAMINGS.OBJ_ID%TYPE, 
  PI_OBJ_VER  IN    CDR_NAMING_VERSIONS.OBJ_VER%TYPE, 
  PO_USAGEINTENT  OUT    CDR_WORKAREAS.USAGE_INTENT_RC%TYPE 
);

Parameters

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

PI_COMPANY_ID (Mandatory) Enter company ID
PI_OBJ_ID (Mandatory) Enter the object ID of the Work Area.
PI_OBJ_VER (Mandatory) Enter the object version (OBJ_VER) of the Work Area.
PO_USAGEINTENT This output parameter returns the current value of the Work Area's Usage Intent attribute.

Parent topic: Define and Modify Work Areas

Update a Work Area's Usage Intent

Use this API to modify the value of the Usage Intent attribute of a Work Area.

Name

CDR_PUB_DF_WORKAREA.UpdateUsageIntent

Signature

PROCEDURE UPDATEUSAGEINTENT( 
  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, 
  PIO_WORKAREAOBJTYPE  IN OUT    CDR_WORKAREA_OBJ_TYPE 
);

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_VERSION_OBJ_TYPE. Enter values to identify the Work Area whose Usage Intent attribute you want to modify.
The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER.
PIO_WORKAREAOBJTYPE (Mandatory) This is a parameter of table type CDR_WORKAREA_OBJ_TYPE that contains object attributes specific to Work Areas. For USAGE_INTENT_RC, enter the new value for the Usage Intent attribute.
The allowed values are: $SYSVALDNSTEPS$DEVELOPMENT, $SYSVALDNSTEPS$PRODUCTION, $SYSVALDNSTEPS$QUALITYCONTROL.

Parent topic: Define and Modify Work Areas

Install a Program

Use this API to install a single Program and the Table instances to which it is mapped. You must install a Program and its source Table instances before you can work on it in an Integrated Development Environment (IDE).

Name

CDR_PUB_DF_WORKAREA.InstallIDEcomponents

Signature

PROCEDURE INSTALLIDECOMPONENTS( 
  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_NCOMPANYID  IN    NUMBER, 
  PI_NWAOBJID  IN    NUMBER, 
  PI_NWAOBJVER  IN    NUMBER, 
  PI_NPRREFID  IN    NUMBER, 
  PI_NPRREFVER  IN    NUMBER, 
  PO_VINSTLOGTYPE  OUT    VARCHAR2, 
  PO_VINSTLOG  OUT    VARCHAR2 
);

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_NWAOBJID (Mandatory) Enter the object ID of the Work Area where the Program instance is located.
PI_NWAOBJVER (Mandatory) Enter the object version (OBJ_VER) of the Work Area.
PI_NPRREFID (Mandatory) Enter the object ID of the Program instance that you want to install.
PI_NPRREFVER PrrefVer of the Program Instance to be installed
PO_VINSTLOGTYPE This output parameter returns one of the following values to indicate whether the installation ended with a status of Warning (G_RET_IDE_INST_WARNING) or Success (G_RET_IDE_INST_INFO).
PO_VINSTLOG This output parameter returns the installation log file (maximum length 32000 characters).

Parent topic: Define and Modify Work Areas

Apply or Move a Snapshot Label

Use this API to apply a snapshot label to some or all tables and/or views in a Work Area.

Name

CDR_PUB_EXE_SNAPSHOT.SetOrMoveLabel

Signature

PROCEDURE SETORMOVELABEL( 
  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_WA_COMPANY_ID   IN CDR_NAMINGS.COMPANY_ID%TYPE,   
  PI_WA_OBJ_ID       IN CDR_NAMINGS.OBJ_ID%TYPE,
  PI_WA_OBJ_VER      IN CDR_NAMING_VERSIONS.OBJ_VER%TYPE,
  PI_LABEL           IN CDR_TAB_REF_LABELS.LABEL%TYPE,
  PI_FORCE_FLAG       IN CDR_SUBMISSIONS.FORCE_EXECUTION_FLAG_RC%TYPE,
  PI_BLIND_FLAG IN CDR_TABLE_REF_JOBS.BLIND_BREAK_FLAG_RC%TYPE,
  PI_DATE IN DATE DEFAULT NULL,
  PI_SRC_TAB_COLL CDR_SRC_TABLE_COLL DEFAULT NULL,
  PI_WA_TABLES_COLL  IN OUT NOCOPY CDR_WA_TABLES_COLL,
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
);

Parameters

This API has standard parameters (see Standard Parameters) and the following parameters. See Functional Rules below for more information.

PI_WA_COMPANY_ID (Mandatory) Enter the Company ID.
PI_WA_OBJ_ID (Mandatory) Enter the Work Area object ID.
PI_WA_OBJ_VER (Mandatory) Enter the latest object version.
PI_LABEL (Mandatory) Label text.
PI_FORCEFLAG (Mandatory)
- If set to $YESNO$YES, the API overwrites the previous snapshot label.
- If set to $YESNO$NO the label is not applied.
PI_BLIND_FLAG (Mandatory) The Blind Break flag ($YESNO$YES, $YESNO$NO).
PI_DATE (Optional) If this value is used, the API labels only those tables with latest data loads less than or equal to entered value.
PI_SCR_TAB_COL (Optional) Naming details of source table(s) of view in given Work Area and corresponding view naming details (to match value with CDR_WA_TABLES_COLL).
This parameter is of type CDR_SRC_TABLE_OBJ_TYPE and contains the following naming attributes:
- SRC_TI_COMPANY_ID NUMBER(6) Enter the Table or view Company ID.
- SRC_TI_OBJ_ID NUMBER(22) Enter the Table or view object ID.
- SRC_TI_OBJ_VER NUMBER(7) Enter the Table or view object version.
- SRC_TI_LABEL VARCHAR2(4000) Source table's already applied label to any given load.
- VW_TI_COMPANY_ID NUMBER(6) Enter the view Company ID.
- VW_TI_OBJ_ID NUMBER(22) Enter the view object ID.
- VW_TI_OBJ_VER NUMBER(7) Enter the view object version.
PI_WA_TABLES_COLL (Optional) This is a parameter of type CDR_WA_TABLES_TYPE that contains table naming attributes.
Use this parameter if the API call is intended to set the label for only a subset of table(s) of an Work Area. It contains following naming attributes:
- TI_COMPANY_ID NUMBER(6) Table COMPANY_ID to which label need to be set.
- TI_OBJ_ID NUMBER(22) Enter the object ID for the Table for which the label needs to be set.
- TI_OBJ_VER NUMBER(7) Enter the object version for the Table for which the label needs to be set.
- TI_RET_STATUS VARCHAR2(4000) This is return status, should be passed as null.

Functional Rules

The following rules outline the API's behavior depending on parameter usage in the API call:

If PI_WA_TABLES_COLL is used, it will apply the label only to the entered table(s) and/or view(s).
If PI_WA_TABLES_COLL is null, the label is applied to all table(s)/view(s) in the Work Area.
Multiple labels cannot be applied to the same table/view in one API call.
If PI_DATE is used, the label is applied to the latest Table data load, less than equals to the used date.
If PI_DATE is not used, the label is applied to latest Table data load.
If PI_FORCEFLAG is set to $YESNO$YES, the API overwrites the Snapshot Label if already applied, otherwise the label is not applied.
If PI_FORCEFLAG is set to $YESNO$YES, non-blinded Tables are always included to be labeled.
If PI_SRC_TAB_COLL is null, and PI_WA_TABLES_COLL has view information or is null (if view exists), the view is loaded and labeled with latest loaded data from the source table.
If PI_SRC_TAB_COLL has a partial set of source table or views, and PI_WA_TABLES_COLL has view information, the view is loaded and labeled with the latest loaded data from the source table that has non-passed source information.
If PI_SRC_TAB_COLL is used, the view details should be part of PI_WA_TABLES_COLL.
If PI_SRC_TAB_COLL is null label will be applied to all table(s) in given Work Area.
If collection PI_SRC_TAB_COLL is passed with source table's label then view will be loaded and labeled with that data of source table.
If PI_SRC_TAB_COLL is used with the source table's label as null, then the view is loaded and labeled with latest loaded data of source table.

Parent topic: Define and Modify Work Areas

Remove a Snapshot Label from a Work Area

Use this API to remove a snapshot label from the passing Work Area.

Name

CDR_PUB_EXE_SNAPSHOT.RemoveLabel

Signature

PROCEDURE REMOVELABEL( 
  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_WA_COMPANY_ID   IN CDR_NAMINGS.COMPANY_ID%TYPE,   
  PI_WA_OBJ_ID       IN CDR_NAMINGS.OBJ_ID%TYPE,
  PI_WA_OBJ_VER      IN CDR_NAMING_VERSIONS.OBJ_VER%TYPE,
  PI_WA_TABLES_COLL  in OUT NOCOPY CDR_WA_TABLES_COLL,
  PI_LABEL           IN CDR_TAB_REF_LABELS.LABEL%TYPE,
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
);

Parameters

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

PI_WA_COMPANY_ID (Mandatory) Enter the Company ID.
PI_WA_OBJ_ID (Mandatory) Enter the Work Area object ID.
PI_WA_OBJ_VER (Mandatory) Enter the latest object version.
PI_WA_TABLES_COLL (Optional) User can pass the collection of table instance of the same Work Area on which user want remove the Snapshot Label.
PI_LABEL (Mandatory) Label value.

Parent topic: Define and Modify Work Areas