| Oracle® Health Sciences Life Sciences Warehouse Application Programming Interface Guide Release 2.4 E53659-01 |
|
|
PDF · Mobi · ePub |
| Oracle® Health Sciences Life Sciences Warehouse Application Programming Interface Guide Release 2.4 E53659-01 |
|
|
PDF · Mobi · ePub |
This is a public interface for Work Area-related operations, including creating, modifying, removing, cloning, checking in and installing Work Areas. It also includes an API to copy instance objects into a Work Area and an API to install a single Program.
This section contains the following topics:
Use this API to create a new Work Area.
Name CDR_PUB_DF_WORKAREA.CreateWorkArea
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.
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
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.
Use this API to check in a Work Area and all the object instances it contains.
Name CDR_PUB_DF_WORKAREA.CheckInWorkArea
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.
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
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.
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
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.
Use this API to copy one or more objects into a Work Area.
Name CDR_PUB_DF_WORKAREA.CopyObjectsIntoWA
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.
Use this API to clone one or more instance objects in a Work Area.
Name CDR_PUB_DF_WORKAREA.CloneObjects
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.
Use this API to remove a Work Area and all the instance objects it contains.
Name CDR_PUB_DF_WORKAREA.RemoveWorkArea
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.
Use this API to retrieve the current value of the Usage Intent attribute for a particular Work Area.
Name CDR_PUB_DF_WORKAREA.GetUsageIntentRC
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.
Use this API to modify the value of the Usage Intent attribute of a Work Area.
Name CDR_PUB_DF_WORKAREA.UpdateUsageIntent
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.
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
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).
|
 Copyright © 2013, 2014, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|
