Create a Study Clinical Data Model from a Library Model

Use this API to create a study clinical data model in a study domain from a clinical data model in a library. The complete model is copied, including all tables, columns, and constraints. The system maintains a relationship between the library model and the study model. If the library model is modified, you can upgrade the study model to the new version—see Upgrade a Clinical Data Model to the Latest Library Model Version. However, any local changes you have made to the study model are lost.

Name

DME_PUB_DF_DATA_MODEL.CreateStudyDMFromLibDM

Signature

PROCEDURE CreateStudyDMFromLibDM
(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,
PI_LIBMODOBJ     IN NOCOPY CDR_NAMING_VERSION_OBJ_TYPE,
PI_STDYMODOBJ    IN NOCOPY CDR_NAMING_VERSION_OBJ_TYPE,
PIO_DMOBJ        IN CDR_DATA_MODEL_OBJ_TYPE,
X_RETURN_STATUS OUT NOCOPY VARCHAR2,
X_MSG_COUNT OUT NOCOPY     NUMBER,
X_MSG_DATA OUT NOCOPY      VARCHAR2,
  );

Parameters

This API has standard parameters (see Standard Parameters) and the following parameters:

• PI_LIBMODOBJ (Mandatory). This is a parameter of type CDR_NAMING_VERSION_OBJ_TYPE. Enter values for the following attributes for the library model and its namespace, which is the library domain for the therapeutic area or other category. Use CDR_PUB_DEF_FACTORY_SUPPORT.GetNamingObject to get the naming version attributes.
  • COMPANY_ID To get your company ID, use CDR_PUB_DEF_FACTORY_UTILS.GetCompanyId.
  • NAME Enter a name for the library clinical data model.
  • NAMESPACE_OBJ_ID Enter the object ID of the parent library domain.
  • NAMESPACE_OBJ_VER Enter the object version of the library domain.
  • NAMESPACE_START_OBJ_VER Enter 1
  • NAMESPACE_END_OBJ_VER Enter 999999
  • DESCRIPTION Enter a description for the library clinical data model.
  • OBJECT_TYPE_RC Enter '$OBJTYPES$DATAMODEL'
• PI_STDYMODOBJ (Mandatory). This is a parameter of type CDR_NAMING_VERSION_OBJ_TYPE. Enter values for the following attributes for the new study model and its namespace, which is the study domain.
  • COMPANY_ID To get your company ID, use CDR_PUB_DEF_FACTORY_UTILS.GetCompanyId.
  • NAME Enter a name for the study clinical data model.
  • NAMESPACE_OBJ_ID Enter the object ID of the parent study domain.
  • NAMESPACE_OBJ_VER Enter the object version of the study domain.
  • NAMESPACE_START_OBJ_VER Enter 1
  • NAMESPACE_END_OBJ_VER Enter 999999
  • DESCRIPTION Enter a description for the study clinical data model.
  • OBJECT_TYPE_RC Enter '$OBJTYPES$DATAMODEL'
• PIO_DMOBJ (Mandatory). This is a parameter of type CDR_DATA_MODEL_OBJ_TYPE. Enter values for the following attributes for the new study clinical data model:
  • DM_NAME Enter null.
  • DM_NAMESPACE_OBJ_ID Enter the object ID of the parent study domain.
  • DM_DESCRIPTION Enter null.
  • DM_TABLE_COLL Leave empty. To add tables use Add a Table to a Clinical Data Model.
  • LIBRARY_FLAG_RC Enter $YESNO$NO because this is a study model, not a library model.
  • MODEL_TYPE_RC
    • To create a target model, enter $MODELTYPE$TARGET.
    • To create an input model, enter $MODELTYPE$INPUT.
  • MODEL_SUBTYPE_RC
    • If the model type is $MODELTYPE$TARGET, then model subtype is null.
    • If the model type is $MODELTYPE$INPUT, then model subtype can be either $INPUTMODTYPE$INFORM or $INPUTMODTYPE$FILE.
  • CREATE_BA_FLAG_RC Enter $YESNO$YES to create a Business Area to enable visualizations of data in the model or $YESNO$NO.
  • BA_SCHEMA_NAME By default, the schema uses the model name. If you want a different schema name, enter it. It must be unique across the DMW instance.