33 Validation Checks

This is a public interface for all operations related to Validation Checks Batch(es), including creation, deletion, modification, and checking in and out of these objects. It also includes information on how to create or modify expressions.

This section includes the Validation Checks APIs from the following package: DME_PUB_VALIDATION_CHECK.

See Refresh Static Packages for information about the API you must run whenever you add, change, or delete a static package to be used in validation checks.

This chapter contains the following section:

• Create and Modify Validation Checks and Batches
  

Create and Modify Validation Checks and Batches

This section contains the following public APIs:

• Create a Validation Check Batch
  
• Modify a Validation Check Batch
  
• Remove Validation Check Batch
  
• Create a Validation Check
  
• Update a Validation Check
  
• Install a Validation Check Batch
  
• Submit a Validation Check Batch
  
• Check In a Validation Check Batch
  
• Check Out a Validation Check Batch
  
• Undo Checkout For a Validation Check Batch
  
• Update Validation Status of a Validation Check Batch
  
• Upgrade a Validation Check Batch
  
• Remove Validation Check(s)
  
• Enable or Disable Validation Checks
  
• Reorder Validation Checks
  

Create a Validation Check Batch

Use this API to create a validation check batch.

Name

DME_PUB_VALIDATION_CHECK.CreateValidationCheckBatch

Signature

PROCEDURE CREATEVALIDATIONCHECKBATCH,
( P_API_VERSION IN VARCHAR2,  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_SOURCEMODELCOMPID IN OUT NOCOPY CDR_NAMINGS.COMPANY_ID%TYPE,  PI_SOURCEMODELOBJID IN OUT NOCOPY CDR_NAMINGS.OBJ_ID%TYPE,  PI_SOURCEMODELOBJVER IN OUT NOCOPY CDR_NAMING_VERSIONS.OBJ_VER%TYPE,  PI_BATCHNAME IN OUT NOCOPY CDR_NAMINGS.NAME%TYPE,  PI_BATCHDESCRIPTION IN CDR_NAMING_VERSIONS.DESCRIPTION%TYPE,  PI_ISORDEREDFOREXECUTION IN VARCHAR2,  PI_CANBETRIGGERED  IN VARCHAR DEFAULT '$YESNO$NO',
  );

Parameters

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

• PI_SOURCEMODELCOMPID (Mandatory). Enter COMPANY_ID of Source Data Model.
• PI_SOURCEMODELOBJID (Mandatory). Enter the obj_id of the table instance which contains the data record.
• PI_SOURCEMODELOBJVER (Mandatory). Enter OBJ_VER of Source Data Model.
• PI_BATCHNAME (Mandatory). Enter Batch Name for new VC Batch.
• PI_BATCHDESCRIPTION (Optional). Enter Batch Description if you want for new VC Batch.
• PI_ISORDEREDFOREXECUTION (Optional). Enter $YESNO$YES, if Validation Checks under new Batch must be executed in particular order. Otherwise enter $YESNO$NO. If entered as NULL, systems defaults it to $YESNO$NO.
• PI_CANBETRIGGERED (Mandatory). Enter $YESNO$YES. This allows the successful completion of a transformation writing to the clinical data model that this batch runs against to trigger the execution of this batch. Entering a different value may result in unexpected behavior.

Modify a Validation Check Batch

Use this API to modify a validation check batch.

Name

DME_PUB_VALIDATION_CHECK.UpdateValidationCheckBatch

Signature

PROCEDURE UPDATEVALIDATIONCHECKBATCH
( P_API_VERSION IN VARCHAR2,  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_BATCHMAPCOMPID IN OUT NOCOPY CDR_NAMINGS.COMPANY_ID%TYPE,  PI_BATCHMAPOBJID IN OUT NOCOPY CDR_NAMINGS.OBJ_ID%TYPE,  PI_BATCHMAPOBJVER IN OUT NOCOPY CDR_NAMING_VERSIONS.OBJ_VER%TYPE,  PI_BATCHNAME IN OUT NOCOPY CDR_NAMINGS.NAME%TYPE,  PI_BATCHDESCRIPTION IN CDR_NAMING_VERSIONS.DESCRIPTION%TYPE,  PI_ISORDEREDFOREXECUTION IN VARCHAR2,  PI_CANBETRIGGERED  IN VARCHAR DEFAULT '$YESNO$NO'
);

Parameters

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

• PI_BATCHMAPCOMPID (Mandatory). Enter COMPANY_ID of Validation Checks Batch Map.
• PI_BATCHMAPOBJID (Mandatory). Enter OBJ_ID of Validation Checks Batch Map.
• PI_BATCHMAPOBJVER (Mandatory). Enter OBJ_VER of Validation Checks Batch Map.
• PI_BATCHNAME (Mandatory). Enter Batch Name for new Validation Checks Batch
• PI_BATCHDESCRIPTION (Optional). Enter Batch Description for new Validation Checks Batch.
• PI_ISORDEREDFOREXECUTION (Optional). Enter $YESNO$YES, if Validation Checks under new Batch must be executed in particular order. Otherwise enter $YESNO$NO. If entered as NULL, systems defaults it to $YESNO$NO.
• PI_CANBETRIGGERED (Optional). Enter $YESNO$YES to allow the successful completion of a transformation writing to the clinical data model that this batch runs against to trigger the execution of this batch. Otherwise enter $YESNO$NO. If entered as NULL, systems defaults it to $YESNO$NO.

Remove Validation Check Batch

Use this API to remove Validation Check batch(es).

Name

DME_PUB_VALIDATION_CHECK.RemoveValidationCheckBatches

Signature

PROCEDURE REMOVEVALIDATIONCHECKBATCHES
  (P_API_VERSION IN VARCHAR2,    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_VC_BATCH_COLL IN OUT NOCOPY CDR_NAMING_LIST_COLL
);

Parameters

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

• PIO_VC_BATCH_COLL (Mandatory). This is a parameter of collection type CDR_NAMING_LIST_COLL that contains CDR Naming Version attributes. The following attributes are required for Validation Checks Batch maps:
  • COMPANY_ID
  • OBJ_ID
  • OBJ_VER

Create a Validation Check

Use this API to create a validation check.

Name

DME_PUB_VALIDATION_CHECK.CreateValidationCheck

Signature

PROCEDURE CREATEVALIDATIONCHECK
(  P_API_VERSION IN VARCHAR2,    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_XFORMMAPCOLL IN OUT NOCOPY DME_XFORM_MAP_EX_COLL,    PI_VCBATCHMODELOBJ IN CDR_BASE_OBJ_TYPE
);

Parameters

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

• PI_XFORMMAPCOLL (Mandatory). This is a parameter of collection type DME_XFORM_MAP_EX_COLL. DME_XFORM_MAP_EX_COLL is a table of DME_XFORM_MAP_EX_OBJ_TYPE.

  This collection is prepared with both Table level amd Column Level maps. Validation Checks Details are set at Table level mapping.

  The following attributes from DME_XFORM_MAP_EX_OBJ_TYPE are required for this API:

  • NAMING: Table type CDR_NAMING_VERSION_OBJ_TYPE

  For Table Level mapping and Validation Checks Create, mandatory attributes are:

  • COMPANY_ID
  • NAME - it refers to Validation Checks name
  • OBJECT_TYPE_RC - Enter the value: '$OBJTYPES$XFORMMAP'.

  For Column Level mapping and Validation Checks Create, mandatory attributes are:

  • COMPANY_ID
  • OBJECT_TYPE_RC - Enter the value: '$OBJTYPES$XFORMMAP'.
  • MAP_TYPE. Enter '$MAPTYPE$VC
  • XFORM_TYPE. Enter '$XFORMTYPE$DIRECT 'for single source table and '$XFORMTYPE$JOIN' for multiple source table.
  • PROGRAM_ID. If the validation check uses a custom program, enter the Program obj_id, else leave blank.
  • PROGRAM_VER. If the validation check uses a custom program, enter the Program obj_ver, else leave blank.
  • PROGRAM_TYPE. 'CUSTOM' for Custom program. Else leave blank. When creating Validation Checks using Custom Program, column level maps are not required in the collection parameter (PI_XFORMMAPCOLL).
  • AUTH_FLAG_RC. Enter '$YESNO$YES' to authorize Validation Checks listing to read blinded data. Otherwise leave blank. It defaults to '$YESNO$NO'.
  • OPERATION_TYPE. '$OPER$CREATE' for Validation Checks create.
  • MAP_ENTITY_COLL. Its collection type DME_MAP_ENTITY_COLL which is table of DME_MAP_ENTITY_OBJ_TYPE type.

    For table level mapping, only source entities are required in MAP_ENTITY_COLL collection. Enter COMPANY_ID, DATAENTITY_ID, DATAENTITY_VER, MAP_RELATION as SOURCE, expression details (see Create or Modify an Expression,) and OPERATION_TYPE as '$OPER$CREATE'.

    For column level mapping, both source and target entities are required in MAP_ENTITY_COLL collection. For source entities, enter company_id, dataentity_id,dataentity_ver, map_relation as SOURCE,expresion details and operation_type as '$OPER$CREATE' and for target entity, enter ALIAS, map_relation as TARGET and operation_type as '$OPER$CREATE'.

  • JOIN_COLL. Required only for VC using multiple source tables. This is a collection of type CDR_DM_JOIN_OBJ_COLL. Set only in table level mapping.

    CDR_DM_JOIN_OBJ_COLL is table of type CDR_DM_JOIN_OBJ_TYPE.

    CDR_DM_JOIN_OBJ_TYPE is for Table Joins and set the source and target table ids. This object type has an attibute of collection type DM_JOIN_COL_OBJ_COLL for column joins.

    DM_JOIN_COL_OBJ_COLL is table of type CDR_DM_JOIN_COL_OBJ_TYPE. Table and Column related fields are required along with JOIN_OPERATOR_RC. For POSITION enter 1.

  • VC_DETAILS. Table of dme_val_check_details_obj_type. Set only in table level mapping.

    COMPANY_ID, DISC_OPEN_STATE, DISCREPANCY_TEXT, PRIMARY_SOURCE_COLUMN_ID are mandatory. AUTO_CLOSE_FLAG,CATEGORY_ID and INITIAL_DISC_ACTION_ID are optional.

    • DISC_OPEN_STATE. Possible values are '$DISC_STATES$OPEN' and '$DISC_STATES$CANDIDATE'.
    • DISCREPANCY_TEXT. Enter a text as comment for created discrepancies from Validation Checks.
    • PRIMARY_SOURCE_COLUMN_ID. Source Column OBJ_ID on which discrepancy is created.
    • AUTO_CLOSE_FLAG. Possible values are '$YESNO$YES' and '$YESNO$NO'. Enter '$YESNO$YES', if Validation Check can auto close the discrepancy.
    • CATEGORY_ID. Enter a valid Validation Check category Id from DME_CATEGORIES.
    • INITIAL_DISC_ACTION_ID. : If discrepancies need DM review, enter 31 when DISC_OPEN_STATE='$DISC_STATES$CANDIDATE' or enter 32 when DISC_OPEN_STATE='$DISC_STATES$OPEN'.
• PI_VCBATCHMODELOBJ (Mandatory). This is a parameter of table type CDR_BASE_OBJ_TYPE. Enter values to identify the Validation Checks Batch Model under which you want to create Validation Checks.

Update a Validation Check

Use this API to update a validation check.

Name

DME_PUB_VALIDATION_CHECK.UpdateValidationCheck

Signature

PROCEDURE UPDATEVALIDATIONCHECK
(P_API_VERSION IN VARCHAR2,  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_XFORMMAPCOLL IN OUT NOCOPY DME_XFORM_MAP_EX_COLL
);

Parameters

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

• PI_XFORMMAPCOLL (Mandatory). This is a parameter of collection type DME_XFORM_MAP_EX_COLL and DME_XFORM_MAP_EX_COLL is table of DME_XFORM_MAP_EX_OBJ_TYPE.

  This collection is prepared with both Table level and Column Level maps. Validation Check Details are set at Table level mapping.

  The attributes required for this API from DME_XFORM_MAP_EX_OBJ_TYPE are:

  • For Table Level mapping, all the attributes are required. Name refers to Validation Checks name and enter OBJECT_TYPE_RC = '$OBJTYPES$XFORMMAP'.
  • For Column Level mapping all the attributes are required. Enter OBJECT_TYPE_RC = '$OBJTYPES$XFORMMAP'.
  • MAP_TYPE. Enter '$MAPTYPE$VC'.
  • XFORM_TYPE. Enter '$XFORMTYPE$DIRECT'for single source table and '$XFORMTYPE$JOIN' for multiple source table.
  • PROGRAM_ID. Enter Custom Program Obj_Id when Create Validation Checks using custom program. In other cases leave blank.
  • PROGRAM_VER. Enter Custom Program Obj_Ver when Create Validation Checks using custom program. In other cases leave blank.
  • PROGRAM_TYPE. Write 'CUSTOM' for Custom program, else leave blank. When creating Validation Checks using Custom Program, column level maps are not required in the collection parameter (PI_XFORMMAPCOLL).
  • AUTH_FLAG_RC. Enter '$YESNO$YES' to authorize Validation Checks listing to read blinded data. Otherwise leave blank. It defaults to '$YESNO$NO'.
  • OPERATION_TYPE. '$OPER$MODIFY' for Validation Checks modify.
  • MAP_ENTITY_COLL. It'ss collection type DME_MAP_ENTITY_COLL which is table of DME_MAP_ENTITY_OBJ_TYPE type. Leave blank, if you do not want to update anything.

    For table level, enter both source and target entities with entity identifiers, data_entity indentyfiers, map_relation as SOURCE or TARGET, expression details (see Create or Modify an Expression,) for source and operation type as '$OPER$MODIFY'.

    For column level:

    1. Adding a new column, both source and target entities are required in MAP_ENTITY_COLL collection. For source entities, enter COMPANY_ID, DATAENTITY_ID, DATAENTITY_VER, MAP_RELATION as SOURCE, expresion details (see Create or Modify an Expression,) and operation_type as '$OPER$CREATE' and for target entity, enter ALIAS, map_relation as TARGET and operation_type as '$OPER$CREATE'.
    2. Updating a column, both source and target entities are required in MAP_ENTITY_COLL collection. For source entities, enter COMPANY_ID, MAP_ENTITY_ID, MAP_ENTITY_VER, DATAENTITY_ID, DATAENTITY_VER, MAP_RELATION as SOURCE, expresion details (see Create or Modify an Expression,) and operation_type as '$OPER$MODIFY' and for target entity, COMPANY_ID, MAP_ENTITY_ID, MAP_ENTITY_VER, DATAENTITY_ID, DATAENTITY_VER , enter ALIAS, MAP_RELATION as TARGET and operation_type as '$OPER$ MODIFY'.
    3. Removing a column, both source and target entities are required in MAP_ENTITY_COLL collection. For both source and target entity, enter COMPANY_ID, MAP_ENTITY_ID, MAP_ENTITY_VER, DATAENTITY_ID, DATAENTITY_VER, MAP_RELATION as SOURCE or TARGET and OPERATION_TYPE as '$OPER$ REMOVE'.
  • JOIN_COLL. Leave blank, if you do not want to update anything. Required only for Validation Checks using multiple source tables. This is a collection of type CDR_DM_JOIN_OBJ_COLL. Set only in table level mapping.

    CDR_DM_JOIN_OBJ_COLL is table of type CDR_DM_JOIN_OBJ_TYPE.

    CDR_DM_JOIN_OBJ_TYPE is for Table Joins and set the source and target table ids. This object type has an attribute of collection type DM_JOIN_COL_OBJ_COLL for column joins.

    DM_JOIN_COL_OBJ_COLL is table of type CDR_DM_JOIN_COL_OBJ_TYPE. Table and Column related fields are required along with JOIN_OPERATOR_RC. For POSITION enter 1.

  • VC_DETAILS. Table of DME_VAL_CHECK_DETAILS_OBJ_TYPE. Set only in table level mapping. COMPANY_ID,DISC_OPEN_STATE, DISCREPANCY_TEXT, PRIMARY_SOURCE_COLUMN_ID are mandatory. AUTO_CLOSE_FLAG, CATEGORY_ID and INITIAL_DISC_ACTION_ID are optional. OBJ_ID and OBJ_VER are required only in case of Validation Checks update.
    • DISC_OPEN_STATE: Possible values are '$DISC_STATES$OPEN' and '$DISC_STATES$CANDIDATE'.
    • DISCREPANCY_TEXT: Enter a text as comment for created discrepancies from Validation Checks.
    • PRIMARY_SOURCE_COLUMN_ID: Source Coloumn OBJ_ID on which discrepancy is created.
    • AUTO_CLOSE_FLAG: Possible values are '$YESNO$YES' and '$YESNO$NO'. Enter '$YESNO$YES', if Validation Checks can auto close the discrepancy.
    • CATEGORY_ID: Enter a valid Validation Checks category ID from DME_CATEGORIES.
    • INITIAL_DISC_ACTION_ID : If discrepancies need DM review, enter 31 when DISC_OPEN_STATE='$DISC_STATES$CANDIDATE' or enter 32 when DISC_OPEN_STATE='$DISC_STATES$OPEN'.

Install a Validation Check Batch

Use this API to install a validation check batch.

Name

DME_PUB_VALIDATION_CHECK.InstallValidationCheckBatch

Signature

PROCEDURE INSTALLVALIDATIONCHECKBATCH
(P_API_VERSION IN VARCHAR2,
 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_BATCHMAPCOMPID IN CDR_NAMINGS.COMPANY_ID%TYPE,
 PI_BATCHMAPOBJID IN CDR_NAMINGS.OBJ_ID%TYPE,
 PI_BATCHMAPOBJVER IN CDR_NAMING_VERSIONS.OBJ_VER%TYPE,
 PI_CONTEXT IN VARCHAR2 DEFAULT NULL,
 PI_TESTMODE IN VARCHAR2 DEFAULT NULL,
 PO_JOBID OUT NOCOPY VARCHAR2
);

Parameters

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

• PI_BATCHMAPCOMPID (Mandatory). Enter COMPANY_ID of Validation Checks Batch Map.
• PI_BATCHMAPOBJID (Mandatory). Enter OBJ_ID of Validation Checks Batch Map.
• PI_BATCHMAPOBJVER (Mandatory). Enter OBJ_VER of Validation Checks Batch Map.
• PI_CONTEXT (Optional). Enter values as $LIFECYCLE$DEV, $LIFECYCLE$QC or $LIFECYCLE$PROD. If entered as null, system tries to find out the SYTEM_CONTEXT. If SYTEM_CONTEXT is not set, it defaults to $LIFECYCLE$DEV.
• PI_TESTMODE (Optional). Leave blank
• PO_JOBID (Optional). Installation of Validation Checks Batch submits a job. So this output parameter returns a JOB_ID for Validation Checks Batch installation.

Submit a Validation Check Batch

Use this API to submit a validation check batch.

Name

DME_PUB_VALIDATION_CHECK.submitValidationCheckBatch

Signature

FUNCTION SUBMITVALIDATIONCHECKBATCH
(P_API_VERSION IN VARCHAR2,
 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_VCBATCHMODELCOMPANYID IN CDR_NAMINGS.COMPANY_ID%TYPE
PI_VCBATCHMODELOBJID IN CDR_NAMINGS.OBJ_ID%TYPE,
PI_VCBATCHMODELOBJVER IN CDR_NAMING_VERSIONS.OBJ_VER%TYPE,
PI_SUBMISSION_TYPE IN VARCHAR2 DEFAULT '$SUBMISSTYPES$IMMEDIATE',
PI_CONTEXT IN VARCHAR2 DEFAULT '$LIFECYCLE$DEV',
PI_SCHED_START_TS IN DATE DEFAULT NULL,
PI_SCHED_END_TS  IN DATE DEFAULT NULL,
PI_SCHED_REPEAT_INTERVAL IN VARCHAR2 DEFAULT NULL,
PI_SCHED_REPEAT_LIST IN VARCHAR2 DEFAULT NULL,
PI_FORCE_EXECUTION_FLAG_RC IN VARCHAR2 DEFAULT '$YESNO$NO',
PI_RUN_MODE_RC IN VARCHAR2
) RETURN CDR_JOBS.JOB_ID%TYPE;

Parameters

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

• PI_VCBATCHMODELCOMPANYID (Mandatory). Company ID of Validation Checks Batch Model.
• PI_VCBATCHMODELOBJID (Mandatory). OBJ_ID of Validation Checks Batch Model.
• PI_VCBATCHMODELOBJVER (Mandatory). OBJ_VER of Validation Checks Batch Model.
• PI_RUN_MODE_RC (Mandatory). Enter '$RUNMODES$FULL' or '$RUNMODES$INCREMENT'.
• PI_SUBMISSION_TYPE. Enter '$SUBMISSTYPES$IMMEDIATE 'or '$SUBMISSTYPES$SCHEDULED' or '$SUBMISSTYPES$DEFERRED'.
• PI_CONTEXT. Lifecycle context values like $LIFECYCLE$DEV, $LIFECYCLE$QC or $LIFECYCLE$PROD.
• PI_SCHED_START_TS. Enter start time if submission is scheduled/deferred.
• PI_SCHED_END_TS. Enter end time if submission is scheduled.
• PI_SCHED_REPEAT_INTERVAL. Enter interval time if submission is scheduled.
• PI_SCHED_REPEAT_LIST. Enter if submission is scheduled. Accepted values are $SUBMISSTYPES$HOURLY, $SUBMISSTYPES$DAILY, $SUBMISSTYPES$WEEKLY, $SUBMISSTYPES$MONTHLY.
• PI_FORCE_EXECUTION_FLAG_RC. Enter '$YESNO$NO ' or '$YESNO$YES'.

This API returns the Job Id.

Check In a Validation Check Batch

Use this API to check in a validation check batch.

Name

DME_PUB_VALIDATION_CHECK.CheckinValidationCheckBatch

Signature

PROCEDURE CHECKINVALIDATIONCHECKBATCH
(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, PI_COMMENT IN VARCHAR2,
);

Parameters

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

• PIO_NAMING (Mandatory). This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE. Enter values to identify the Validation Checks Batch that you want to check in.

  The following attributes are required:

  • COMPANY_ID
  • OBJ_ID
  • OBJ_VER
• PI_COMMENT (Optional). Enter the reason you are checking in the Validation Checks Batch.

Check Out a Validation Check Batch

Use this API to check out a validation check batch.

Name

DME_PUB_VALIDATION_CHECK.CheckoutValidationCheckBatch

Signature

PROCEDURE checkoutValidationCheckBatch
(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,  PI_COMMENT IN VARCHAR2
);

Parameters

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

• PIO_NAMING (Mandatory). This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE. Enter values to identify the Validation Checks Batch that you want to check in.

  The following attributes are required:

  • COMPANY_ID
  • OBJ_ID
  • OBJ_VER
• PI_COMMENT (Optional). Enter the reason you are checking out the Validation Check Batch.

Undo Checkout For a Validation Check Batch

Use this API to undo check out for a Validation Check Batch.

Name

DME_PUB_VALIDATION_CHECK.UncheckValidationCheckBatch

Signature

PROCEDURE DELETEFLAG 
(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,  PI_COMMENT IN VARCHAR2
);

Parameters

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

• PIO_NAMING (Mandatory). This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE. Enter values to identify the Validation Check Batch that you want to check in.

  The following attributes are required:

  • COMPANY_ID
  • OBJ_ID
  • OBJ_VER
• PI_COMMENT (Optional). Enter the reason you are checking in the Validation Checks Batch.

Update Validation Status of a Validation Check Batch

Use this API to update validation status of a Validation Check Batch.

Name

DME_PUB_VALIDATION_CHECK.UpdateValStatus

Signature

PROCEDURE UPDATEVALSTATUS
( 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,   PI_TESTMODE IN VARCHAR2 DEFAULT NULL
);

Parameters

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

• PIO_NAMING (Mandatory). This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE. Enter values to identify the Validation Checks Batch that you want to update validation status.

  All the attributes are required.

• PI_TESTMODE (Optional). Leave blank.

Upgrade a Validation Check Batch

Use this API to upgrade a validation check batch.

Name

DME_PUB_VALIDATION_CHECK.UpgradeValidationCheckBatch

Signature

PROCEDURE UPGRADEVALIDATIONCHECKBATCH
(P_API_VERSION IN VARCHAR2,  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_BATCHMAPCOMPID IN CDR_NAMINGS.COMPANY_ID%TYPE,  PI_BATCHMAPOBJID IN CDR_NAMINGS.OBJ_ID%TYPE,  PI_BATCHMAPOBJVER IN CDR_NAMING_VERSIONS.OBJ_VER%TYPE
);

Parameters

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

• PI_BATCHMAPCOMPID (Mandatory). Enter COMPANY_ID of Validation Checks Batch Map.
• PI_BATCHMAPOBJID (Mandatory). Enter OBJ_ID of Validation Checks Batch Map.
• PI_BATCHMAPOBJVER (Mandatory). Enter OBJ_VER of Validation Checks Batch Map.

Remove Validation Check(s)

Use this API to remove validation check(s).

Name

DME_PUB_VALIDATION_CHECK.RemoveValidationChecks

Signature

PROCEDURE REMOVEVALIDATIONCHECKS
(P_API_VERSION IN VARCHAR2,  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_VC_COLL IN OUT NOCOPY CDR_NAMING_LIST_COLL
);

Parameters

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

• PIO_VC_COLL (Mandatory). This is a parameter of collection type CDR_NAMING_LIST_COLL that contains CDR Naming Version attributes.

  The attributes required for this API are:

  • COMPANY_ID
  • OBJ_ID
  • OBJ_VER

Enable or Disable Validation Checks

Use this API to enable or disable Validation Checks.

Name

DME_PUB_VALIDATION_CHECK.EnableDisableValidationChecks

Signature

PROCEDURE ENABLEDISABLEVALIDATIONCHECKS
(P_API_VERSION IN VARCHAR2,  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_VC_MAP_COLL IN CDR_BASE_OBJ_COLL,  PI_ENABLE_FLAG IN VARCHAR2,
);

Parameters

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

• PI_VC_MAP_COLL (Mandatory). This is a parameter of collection type CDR_BASE_OBJ_COLL that contains CDR base object attributes. The following attributes are required: COMPANY_ID, OBJ_ID, OBJ_VER for Validation Checks maps.
• PI_ENABLE_FLAG (Mandatory). Enter '$YESNO$YES' for enabling and '$YESNO$NO' for disabling.

Reorder Validation Checks

Use this API to re-order validation checks.

Name

DME_PUB_VALIDATION_CHECK.ReorderValidationChecks

Signature

PROCEDURE REORDERVALIDATIONCHECKS
(P_API_VERSION IN VARCHAR2,  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_VC_MAP_COLL IN OUT NOCOPY DME_XFORM_MAP_COLL
);

Parameters

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

• PI_VC_MAP_COLL (Mandatory). This is a parameter of collection type DME_XFORM_MAP_COLL which is a table of DME_XFORM_MAP_OBJ_TYPE type. The attributes required for this API from DME_XFORM_MAP_OBJ_TYPE are:
  • COMPANY_ID
  • OBJ_ID
  • OBJ_VER
  • EXECUTION_ORDER_NUMBER