| 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 Load Set-related operations, including creating, modifying, and removing Load Sets. It also includes APIs for checking Load Sets in and out, undoing a Load Set checkout, and computing the status of a Load Set.
This section contains the following topics:
Use this API to create a Load Set definition, Load Set instance or both.
Name CDR_PUB_DF_LOADSET.CreateLoadSet
PROCEDURE CREATELOADSET( 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_CDRLOADSETOBJTYPE IN CDR_LOAD_SET_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 creating a new definition only or a new definition and an instance of it, enter values for the new definition. If you are creating an instance of an existing definition, enter values to identify the existing definition.
For OBJECT_TYPE_RC enter $OBJTYPES$LOADSET if you are creating a definition only; $OBJTYPES$LOADSETREF if you are creating an instance of an existing definition; and NULL if you are creating a new definition and an instance of it.
PI_CDRLOADSETOBJTYPE (Mandatory) This is a parameter of table type CDR_LOAD_SET_OBJ_TYPE that contains object attributes specific to Load Sets. Enter values for the Load Set that you want to create.
The following attributes are required: COMPANY_ID, ADAPTER_COMPANY_ID, ADAPTER_OBJ_ID, ADAPTER_OBJ_VER.
PI_CREATEOBJECT (Mandatory) Enter DEFN to create a definition only; INST to create an instance of an existing definition; or BOTH to create a definition and an instance of it
PI_INSTANCE_SUBTYPE_ID (Optional) If you are creating a new instance, enter the subtype ID that 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 Load Sets. Do not enter any values for them.
If you are not creating a new definition, do not enter values here.
PI_INSTCLASSIFICATIONCOLL 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 Load Sets. 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 out a Load Set definition.
Name CDR_PUB_DF_LOADSET.CheckOutLoadSet
PROCEDURE CHECKOUTLOADSET( 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. You can enter values to identify either the Load Set definition or an instance of it:
Pass the Load Set definition details if you want to check out and subsequently modify only the definition.
Pass the details of an instance of the Load Set definition if you want the instance to point to the new version of the Load Set definition.
The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.
To get the OBJECT_VERSION_NUMBER, enter the following query: select Max(OBJECT_VERSION_NUMBER) from cdr_vl_val_docs_v where OBJ_ID = <objid> and OBJ_VER = <objver> and DOC_STATUS_RC ='$VALINFOSTATUS$ACTIVE';
NAMESPACE_OBJ_ID. If you are entering information about the Load Set definition, enter the object ID of its containing Application Area. If you are entering information about the Load Set instance, enter the object ID of its containing Work Area.
NAMESPACE_OBJ_VER. If you are entering information about the Load Set, definition, enter the object version number of its containing Application Area. If you are entering information about the Load Set instance, enter the object version number of its containing Work Area.
PI_COMMENT (Optional) Enter the reason you are checking out the Load Set.
PI_ISINSTONLY Enter $YESNO$NO if you are checking out only the definition. Enter $YESNO$YES if you are checking out the definition through its instance.
Use this API to modify a Load Set definition or instance. You can change the name, description, or version label.
Note:
If you are modifying a definition, you must first check it out.Name CDR_PUB_DF_LOADSET.ModifyLoadSet
PROCEDURE MODIFYLOADSET( 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 Load Set and enter new values for the attributes you want to modify. All attributes are required.
Use this API to check in a Load Set definition.
Name CDR_PUB_DF_LOADSET.CheckInLoadSetDefinition
PROCEDURE CHECKINLOADSETDEFINITION( 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 Load Set 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 for checking in the Load Set.
Use this API to remove one or more Load Set definitions or instances.
Name CDR_PUB_DF_LOADSET.RemoveLoadSet
PROCEDURE REMOVELOADSET( 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 parameter:
PIO_CDRBASEOBJCOLL (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs.
For each Load Set definition or instance 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.
Use this API to synchronize all the existing table descriptors in a Loadset with the Table Definition at the source. When you use this API, it performs different tasks according to the situation:
If the API finds no changes to be synchronized, it displays a message indicating that there are no changes to the table descriptors.
If the API finds changes to be synchronized and the Load Set definition is checked out, it synchronizes the changes and displays a message indicating that changes were identified and synchronized.
If the API finds changes to be synchronized and the Load Set definition is checked in, then it checks out the Load Set, completes synchronization and leaves the Load Set checked out.
Table descriptors (and corresponding Table definitions) are checked out only if changes are detected. After synchronization is complete, the API returns a collection of Table descriptor objIDs and obj versions that were changed.
The API does not create a new table descriptor in the Load Set but only synchronizes the existing Table Descriptors in the LS. The updated Table Descriptor generates the same outcome as when columns are uploaded for a Table Descriptor.
Name CDR_PUB_DF_LOADSET.SychronizeTablesWithinLS
PROCEDURE SYCHRONIZETABLESWITHINLS( P_API_VERSION IN NUMBER, P_INIT_MSG_LIST IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_COMMIT IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE, P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, X_RETURN_STATUS OUT NOCOPY VARCHAR2, X_MSG_COUNT OUT NOCOPY NUMBER, X_MSG_DATA OUT NOCOPY VARCHAR2, PI_NLSDEFCOMPID IN NUMBER, PI_NLSDEFID IN NUMBER, PI_VFILENAME IN VARCHAR2, PI_BFILEBLOB IN BLOB, PO_TDESCLIST OUT NOCOPY CDR_BASE_OBJ_COLL, PO_OUTMSG OUT NOCOPY VARCHAR2 );
Parameters This API has standard parameters (see "Standard Parameters") and the following parameter:
PARAM P_API_VERSION (Mandatory). Enter the current version of the API you are calling. The API compares the version numbers of incoming calls to its current version number and returns an error if they are incompatible.
PARAM P_INIT_MSG_LIST (Optional). Accept the default value (FND_API.G_FALSE) to ensure that this individual API does not initialize the message list upon completion. Pass FND_API.G_TRUE to override the default behavior.
PARAM P_COMMIT (Optional). Accept the default value (FND_API.G_FALSE) to ensure that this individual API does not commit upon completion. Pass FND_API.G_TRUE to override the default behavior.
PARAM P_VALIDATION_LEVEL (Optional). Accept the default value to perform full validation. No other values are currently supported.
PARAM X_RETURN_STATUS. This output parameter returns the end status of the API: (S) Success, (E) Error or (U) Unexpected Error
PARAM X_MSG_COUNT. This output parameter returns the count of error messages if the return status is other than Success.
PARAM X_MSG_DATA. If the message count is 1, this output parameter returns the text of the error message. If there are more than one message, use cdr_pub_msg_pub.get to retrieve the messages.
PARAM PI_NLSDEFCOMPID. Enter the Company Id.
PARAM PI_NLSDEFID. Provide the Load Set Definition Id
PARAM PI_VFILENAME (Optional). If the Load Set is a SAS or TEXT type, provide the file name.
For SASâcport. xport, cprt, xprt and .sas*dat files are allowed.
For TXTâzip and mdd files are allowed. The zip should only contain mdd files. The mdd file name should be the same as the Table Descriptor it needs to update. For other types, it can be sent as null.
PARAM PI_BFILEBLOB (Optional). Provide the BLOB that holds the file content for SAS and TEXT Load Sets.
PARAM PO_TDESCLIST. This list contains the table descriptors that were updated.
PARAM PO_OUTMSG. Returns the error/confirmation messages.
|
 Copyright © 2013, 2014, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|
