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.