Oracle® Life Sciences Data Hub Application Programming Interface Guide Release 2.3.1 Part Number E35306-02 |
|
|
View PDF |
This is a public interface for validation-related operations.
This section contains the following topics:
This section contains one API for updating the validation status of an object.
Use this API to update an object's validation status. The API performs a cascade validation on this object and its related objects.
If this object is an instance, the API also validates its source definition. If this object contains other objects with a validation status, the API updates the validation status of all of them; and if they are instances, their source definitions.
The operation fails if any of the underlying definitions are checked out. If you are validating a Report Set, the operation also fails if any of the Program instances in the Report Set have a validation status lower than the one to which the Report Set is being upgraded.
Name CDR_PUB_VL_VALIDATION.UpdateValStatus
PROCEDURE UPDATEVALSTATUS( 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_VALOBJ IN CDR_VAL_STATUS_OBJ_TYPE, PO_CASCADEDOBJCOLL OUT CDR_BASE_OBJ_COLL, PO_ERRORNAMINGCOLL OUT CDR_BASE_OBJ_COLL );
Parameters This API has standard parameters (see "Standard Parameters") and the following parameters:
PI_VALOBJ (Mandatory) This is a parameter of table type CDR_VAL_STATUS_OBJ_TYPE that contains object attributes. Enter values to identify the object whose validation status you want to update.
The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJ_TYPE_RC,VALIDATION_STATUS_RC,OBJECT_VERSION_NUMBER.
PO_CASCADEDOBJCOLL This output parameter is a collection of all the objects whose validation status was updated due to cascading. If this parameter contains a value, the validation update operation succeeded.
PO_ERRORNAMINGCOLL This output parameter is a collection of objects whose validation status could not be updated. If this parameter contains a value, the validation update operation failed.
This section contains the following topics:
Use this API to create a validation supporting document.
Name CDR_PUB_VL_VALIDATION.CreateValDocument
PROCEDURE CREATEVALDOCUMENT( 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_VALDOCOBJ IN CDR_VAL_DOC_BLOB_OBJ_TYPE ) ;
Parameters This API has standard parameters (see "Standard Parameters") and the following parameter:
PI_VALDOCOBJ (Mandatory) This is a parameter of type CDR_VAL_DOC_BLOB_OBJ_TYPE that contains object attributes.
The following attributes are required: COMPANY_ID, OBJ_ID, OBJ_VER, DOCUMENT_NAME, DESCRIPTION, FILE_NAME, OS_FILE_PATH, FILE_BLOB, FILE_CONTENT_TYPE.
You can use this API to upload a new document, change attributes such as its description, or both.
Name CDR_PUB_VL_VALIDATION.UpdateValDocument
PROCEDURE UPDATEVALDOCUMENT( 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_VALDOCOBJ IN CDR_VAL_DOC_BLOB_OBJ_TYPE );
Parameters This API has standard parameters (see "Standard Parameters") and the following parameter:
PI_VALDOCOBJ (Mandatory) This is a parameter of type CDR_VAL_DOC_BLOB_OBJ_TYPE that contains object attributes. The following attributes of the document to be updated are required: DOCUMENT_ID, COMPANY_ID, OBJ_ID, OBJ_VER, DOCUMENT_NAME, DOC_STATUS_RC, DOCUMENT_VER, DESCRIPTION, CHANGE_REASON, FILE_ID, FILE_NAME, OS_FILE_PATH,FILE_BLOB, FILE_CONTENT_TYPE, OBJECT_VERSION_NUMBER.
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';
Use this API to remove a validation supporting document.
Name CDR_PUB_VL_VALIDATION.RemoveValDocument
PROCEDURE REMOVEVALDOCUMENT( 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_VALDOCOBJ IN CDR_VAL_DOC_BLOB_OBJ_TYPE );
Parameters This API has standard parameters (see "Standard Parameters") and the following parameter:
PI_VALDOCOBJ (Mandatory) This is a parameter of type CDR_VAL_DOC_BLOB_OBJ_TYPE that contains object attributes.
The following attributes of the document to be obsoleted are required: DOCUMENT_ID, COMPANY_ID, DOCUMENT_VER, OBJECT_VERSION_NUMBER.
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';