Add a Table to a Clinical Data Model

Use this API to add a table to clinical data model. The table is created without columns or constraints. To add columns, see Add a Column to a Table in a Clinical Data Model. To add constraints, see Add a Constraint to a Clinical Data Model Table. Note that you can create a table with columns and constraints by uploading a metadata file through the user interface. See Oracle Health Sciences Data Management Workbench User's Guide for more information.

Name

DME_PUB_DF_DATA_MODEL.AddTableToDataModel

Signature

Procedure AddTableToDataModel (
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
pio_naming 	IN OUT NOCOPY	     cdr_naming_version_obj_type
pio_table		 IN OUT NOCOPY		 cdr_dm_table_obj_type
pi_defClassificationColl IN CDR_CLASSIFICATIONS_COLL);

Parameters

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

• PIO_NAMING (Mandatory): Enter values for the study clinical data model to which you want to add a table. This is a parameter of type CDR_NAMING_VERSION_OBJ_TYPE.
  • COMPANY_ID Company ID of the Data Model.
  • OBJECT_TYPE_RC Enter $OBJTYPES$TABLE.
  • NAME Name of the Table.
  • NAMESPACE_OBJ_ID Object ID of the Model.
  • NAMESPACE_OBJ_VER Object Version of the Model.
  • DESCRIPTION Description of the Table.
• PIO_TABLE (Mandatory): Enter values for the table:
  • COMPANY_ID To get your company ID, use CDR_PUB_DEF_FACTORY_UTILS.GetCompanyId.
  • ORACLE_NAME: Enter an Oracle name.
  • SAS_NAME: Enter a SAS name.
  • SAS_LABEL: Enter a SAS label.
  • SAS_V6_FLAG_RC: If you are using SAS version 6, enter '$YESNO$YES'. If you are using a more recent version, enter '$YESNO$NO'.
  • AUDIT_TABC_COMPANY_ID, AUDIT_TABC_OBJ_ID, AUDIT_TABC_OBJ_VER: Leave these three blank.
  • SNAPSHOT_FLAG_RC: To allow creating snapshots on this table, enter '$YESNO$YES'. To prevent creating snapshots on this table, enter '$YESNO$NO'.
  • PROCESS_TYPE_RC: Enter '$PROCESSTYPES$STAGINGWAUDIT'. This is the required type for newly created tables in Oracle DMW.
  • BLINDING_FLAG_RC: If this table may ever contain sensitive data that should be blinded or masked, enter '$YESNO$YES'. If not, enter '$YESNO$NO'.
  • REQUIRED_FLAG_RC: Enter '$YESNO$YES' or '$YESNO$NO'. This value is not used by the system.
  • DM_TAB_COL_COLL: Pass all null values to this collection. To add columns to the table, see Add a Column to a Table in a Clinical Data Model.
  • DM_TAB_CONS_COLL: Pass all null values to this collection. To add constraints to the table, see Add a Constraint to a Clinical Data Model Table.
  • STAGING_FLAG_RC: If this is a temporary staging table required for use in a transformation, enter '$YESNO$YES'. Otherwise enter '$YESNO$NO'.
  • USABLE_FLAG_RC: Enter '$YESNO$YES' or '$YESNO$NO'. This value is not used by the system.
  • IDENTIFIER_TAB_COMP_ID: If you are assigning an SDTM ID to the table, enter the company ID of SDTM identifier. To find this and related values, query public view DME_SDTM_TAB_IDENTIFIERS_V.
  • IDENTIFIER_TAB_OBJ_ID: If you are assigning an SDTM ID to the table, enter the object ID of SDTM identifier.
  • IDENTIFIER_TAB_OBJ_VER: If you are assigning an SDTM ID to the table, enter the object version of SDTM identifier.
  • BLINDING_CRITERIA: If the table has row-level blinding (set in the MASKING_TYPE_RC attribute below), enter the blinding criteria as a SQL expression.
  • ALIASES: Enter one or more alternate names for the column in a comma-separated list with no spaces, for use in automapping transformations.
  • INFORM_REF_PATH_NAME: Leave blank.
  • MASKING_TYPE_RC: If the table's BLINDING_FLAG_RC is set to '$YESNO$NO', enter '$MASKING_TYPE$NONE'.

    If the table's BLINDING_FLAG_RC is set to '$YESNO$YES', specify the type of blinding: '$MASKING_TYPE$COLUMN', '$MASKING_TYPE$ROW', or '$MASKING_TYPE$TABLE'.

  • BLINDING_CRITERIA_EXPR_ID: Enter null.
  • BLINDING_CRITERIA_EXPRESSION: This is a parameter of type DME_XFORM_EXPRESSION_OBJ_TYPE. Enter details for the blinding criteria:

    EXPRESSION_ID: Enter null (to create a new expression ID).

    POSITION: Position of component.

    COMPONENT_TYPE_RC: Enter '$EXPCOMPTYPE$OPERATOR' or '$EXPCOMPTYPE$CONSTANT'

    COMPONENT: Enter component STATIC_REFS: If the expression references an existing function, enter the function ID.

    For example, the expression:

    BLINDING_CRITERIA= 'ADDN_TABL1.DEPTNO>0';
    

    has three components:

    "ADDN_TABL1.DEPTNO"
     ">"
     "0"
    

    To create a collection of type DME_XFORM_EXPRESSION_OBJ_TYPE with these components:

    oExprType :=DME_XFORM_EXPRESSION_OBJ_TYPE(NULL,1,'$EXPCOMPTYPE$CONSTANT','ADDN_TABL1.DEPTNO',NULL);
    oExprColl.extend;
    oExprColl(oExprColl.last):=oExprType;
     
    oExprType :=DME_XFORM_EXPRESSION_OBJ_TYPE(NULL,2,'$EXPCOMPTYPE$OPERATOR','>',NULL);
    oExprColl.extend;
    oExprColl(oExprColl.last):=oExprType;
    oExprType                :=DME_XFORM_EXPRESSION_OBJ_TYPE(NULL,3,'$EXPCOMPTYPE$CONSTANT','0',NULL);
     
    oExprColl.extend;
    oExprColl(oExprColl.last)         :=oExprType;
     
    BLINDING_CRITERIA_EXPR_COLL:=oExprColl;
    

  • UOW_PROCESS_TYPE_RC:

    If programs writing to the table do not use Unit of Work processing, it uses Reload processing. Enter '$UOWPROCTYPES$NONUOW'.

    If programs writing to the table use Subject Visit Unit of Work processing, enter '$UOWPROCTYPES$SUBJ_VISIT'.

    If programs writing to the table use Subject Unit of Work processing, enter '$UOWPROCTYPES$SUBJ'.

• PI_DEFCLASSIFICATIONCOLL: This is a parameter of type CDR_CLASSIFICATIONS_COLL. Pass all null values to this collection.