Modify a Model's Name and Description

Use this API to modify a study clinical data model's name and description.

Name

DME_PUB_DF_DATA_MODEL.ModifyStudyDataModel

Signature

PROCEDURE ModifyStudyDataModel
(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,
PIO_STDYMODOBJ     IN OUT NOCOPY CDR_NAMING_VERSION_OBJ_TYPE,
PIO_DMOBJ          IN OUT 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:

• PIO_STDYMODOBJ (Mandatory). This is a parameter of type CDR_NAMING_VERSION_OBJ_TYPE. Enter values for the new name and description.
• PIO_DMOBJ (Mandatory). This is a parameter of type CDR_DATA_MODEL_OBJ_TYPE. Enter values for the following attributes for the new clinical data model:
  • DM_NAME Enter a name for the model.
  • DM_NAMESPACE_OBJ_ID Enter the object ID of the study or library domain.
  • DM_DESCRIPTION Enter a description for the model.
  • DM_TABLE_COLL Leave empty. To add tables see Add a Table to a Clinical Data Model.
  • LIBRARY_FLAG_RC Enter $YESNO$NO if this is a study model or $YESNO$YES if it is a library model.
  • MODEL_TYPE_RC Enter the value for the model: $MODELTYPE$TARGET or $MODELTYPE$INPUT.
  • MODEL_SUBTYPE_RC Enter the model's subtype:

    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.
• PIFILETYPE (Mandatory). If you are modifying a target model or an InForm input model, enter NULL. If you are modifying a file-type input model, enter either SAS or TEXT.