Installing the Work Area
After you have created the Adapter Domain and all the definitional objects within it, install the Work Area by calling the API CDR_PUB_DF_WORKAREA.INSTALLWACONTROLLER and the Program instance it contains.
This API also checks in the Program instance and its definition.
Note:
If the Program is checked out, which it normally is at this point, and the person running this API is different from the person who created the Program, Work Area installation fails. The person who created(or most recently checked out) the Program definition must either explicitly check in the Program or run the Work Area installation. See Checking In Objects and Setting Their Validation Status for further information.To create a Work Area, call the API CDR_PUB_DF_WORKAREA.CREATEWORKAREA. Its signature is:
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 );
Enter values as follows:
- PIO_OWABASENAMING. Enter CDR_BASE_OBJ_TYPE values as follows:
- company_id =
Enter_your_company_ID
- obj_id =
Enter_the_Work_Area's_obj_ID
- obj_ver =
Enter_the_Work_Area's_obj_ver
- object_version_number =
Get_this_value_from_cdr_df_naming_v
- namespace_obj_id =
Enter_your_Adapter_Area's_object_ID
- namespace_obj_ver =
Enter_your_Adapter_Area's_obj_ver
- company_id =
- PI_VINSTALLMODE. Enter
'$INSTALLMODE$UPGRADE'
- PI_VFORCEREGEN. Enter
'$YESNO$YES'
- PI_VBATCH. Enter
'$YESNO$NO'
- PI_VACTION. Enter one of the following values:
'$INSTALLCMD$COMPLETE'
Enter this value 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.'$INSTALLCMD$CANCEL'
Enter this value if the last installation failed and you want to begin the installation process from the beginning.Note:
You must then run the API again with PI_VACTION set to'$INSTALLCMD$COMPLETE'
.
- PI_COINSTDETAILS. 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. Normally an adapter has only a single Program instance in the Work Area. Enter values to identify it as follows:
- company_id =
Enter_your_company_ID
- obj_id = null
- obj_ver = 1
- object_type_rc = For Programs, enter
'$OBJTYPES$PROGRAMINST'
. - omit_from_install_flag_rc =
'$YESNO$NO'
- install_action_rc =
'$INSTOBJACT$REPLACE'
- company_id =
Parent topic: Using APIs to Create Required Metadata Objects