| 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 creating, modifying, and removing Data Marts.
This section contains the following topics:
Use this API to create a new Data Mart definition, a new instance of an existing Data Mart definition, or a new definition and an instance of it.
Name CDR_PUB_DF_DATAMART.CreateDataMart
PROCEDURE CREATEDATAMART( 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_CDRDATAMARTOBJTYPE IN CDR_DATA_MART_OBJ_TYPE, PI_CREATEOBJECT IN VARCHAR2, PI_INSTANCE_SUBTYPE_ID IN CDR_NAMINGS.OBJECT_SUBTYPE_ID%TYPE, PI_DEFCLASSIFICATIONCOLL IN CDR_CLASSIFICATIONS_COLL, PI_INSTCLASSIFICATIONCOLL 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 table type CDR_NAMING_VERSIONS_OBJ_TYPE that contains CDR Naming Version attributes.
If you are only creating a new definition or a new definition and an instance of it, enter values for the new definition. If you are creating a definition enter $OBJTYPES$DATAMART for OBJECT_TYPE_RC. Enter NULL if you are creating a new definition and an instance of it.
If you are creating an instance of an existing definition, enter values to identify the definition. If you are creating an instance of an existing definition enter $OBJTYPES$DATAMARTREF for OBJECT_TYPE_RC.
PI_CDRDATAMARTOBJTYPE (Optional) This is a parameter of table type CDR_DATA_MART_OBJ_TYPE that contains object attributes specific to Data Marts.
If you are creating a new definition, enter values for the new Data Mart. The following attributes are required: COMPANY_ID, ADAPTER_COMPANY_ID, ADAPTER_OBJ_ID, ADAPTER_OBJ_VER.
If you are creating an instance of an existing Data Mart, do not enter any values here.
PI_CREATEOBJECT (Mandatory) Enter DEFN to create a definition only; INST to create a instance of an existing definition; or BOTH to create a new definition and an instance of it.
PI_INSTANCE_SUBTYPE_ID (Optional) If you are creating a new instance, enter the ID for the subtype you want to give the instance. If you are creating a definition only, do not enter a value for this parameter.
PI_DEFCLASSIFICATIONCOLL (Optional) By default the new definition 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. The PAR_ attributes are not relevant to Data Marts. Do not enter any values for them. If you are not creating a new definition, do not enter values here.
PI_INSTCLASSIFICATIONCOLL The definition is classified according to the subtype you assigned it in the PI_INSTANCE_SUBTYPE_ID. 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 instance to inherit its classifications for a particular level from its parent Work 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 Data Marts. Do not enter any values for them. If you are not creating a new instance, do not enter values here.
Use this API to check in a Data Mart definition.
Name CDR_PUB_DF_DATAMART.CheckInDataMartDefinition
PROCEDURE CHECKINDATAMARTDEFINITION( 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_BASEOBJECT IN OUT CDR_BASE_OBJ_TYPE, PI_COMMENT IN VARCHAR2 );
Parameters This API has standard parameters (see "Standard Parameters") and the following parameters:
PIO_BASEOBJECT (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Data Mart definition that you want to check in. The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.
PI_COMMENT (Optional) Enter the reason you are checking in the Data Mart.
Use this API to modify a Data Mart definition or instance. You can modify the name and description. If you are modifying an instance object, you can also change the 3 REF attribute values to select a different source definition.
Note: If you are modifying a definition, you must first check it out.
Name CDR_PUB_DF_DATAMART.ModifyDataMart
PROCEDURE MODIFYDATAMART( 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_CDRNAMING IN OUT CDR_NAMING_VERSION_OBJ_TYPE );
Parameters This API has standard parameters (see "Standard Parameters") and the following parameters:
PIO_CDRNAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE. Enter values to identify the Data Mart and enter new values for the attributes you want to modify. You can change the name or description for either a definition or instance. For an instance you can also change to a different underlying source definition by entering values for the new definition in the three REF attributes. All attributes are required.
NOTE: Use separate APIs for modifying the validation status and the version label: CDR_PUB_VL_VALIDATION. UpdateValStatus and CDR_PUB_DF_NAMING. UpdateVersionLabel.
Use this API to check out a Data Mart definition, either directly or through an instance of it.
Name CDR_PUB_DF_DATAMART.CheckOutDataMart
PROCEDURE CHECKOUTDATAMART( 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_BASEOBJECT IN OUT CDR_BASE_OBJ_TYPE, PI_COMMENT IN VARCHAR2, PI_ISINSTONLY IN VARCHAR2 );
Parameters This API has standard parameters (see "Standard Parameters") and the following parameters:
PIO_BASEOBJECT (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Data Mart that you want to do check out. I
f you are checking out the Data Mart definition directly, enter values to identify the definition. If you are checking out a Data Mart definition through an instance of it, enter values to identify the instance.
The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.
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.
PI_COMMENT (Optional) Enter the reason you are checking out the Data Mart.
PI_ISINSTONLY (Mandatory) Enter $YESNO$NO.
Use this API to remove one or more Data Mart definitions or instances.
Name CDR_PUB_DF_DATAMART.RemoveDataMart
PROCEDURE REMOVEDATAMART( 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 );
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 Data Mart 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.
|
 Copyright © 2013, 2014, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|
