oracle.hsgbu.hdr.message.mtk

Interface MtkTestService

All Known Subinterfaces:

MtkTestServiceLocalBMT, MtkTestServiceRemoteBMT

public interface MtkTestService

MtkTestService interface provides APIs for testing Message Types and downloading the test files. MtkTestService interface has APIs for

• Testing a Message Type.
• Downloading test files.
• Cleaning up a test data directory.
• Getting the descriptive status message for a test.
• Searching the Test Ids(generated when testing Message Types).

Method Summary

Modifier and Type	Method and Description
TestIdData	downloadTestFilesForATest(String testId) Downloads all information associated with the testing of a Message Type, based on the Test Id.
String[]	getMatchingTestIds(String testId) Searches the Test Ids matching the given pattern.If no match is found, a zero length array is returned.
String	getTestStatus(String testId) Gets step by step description of status of the processing a Message Type testing.
void	removeTestFilesForATest(String testId) Removes permanently all information associated with a Test Id.
String	testCustomMessageType(SchemaInformation[] schemaInformation, String testDesc, boolean generateReport) The API provides a mechanism for the user to test a custom RMIM.

Method Detail

testCustomMessageType

String testCustomMessageType(SchemaInformation[] schemaInformation,
                             String testDesc,
                             boolean generateReport)
                      throws HDRRimException

The API provides a mechanism for the user to test a custom RMIM. The user can create a new custom RMIM or modify an existing RMIM and save it as a new RMIM. After RMIM is developed, XSD and MIF are generated using HL7 ITS Tooling and cmetinfo.core mif file is updated for new CMETs. After XSD and MIFs are generated successfully, user should invoke the API with following information to test the RMIM.

• Payload XSD and MIF.
• XSD and MIF of all CMETs associated with the Message Type.
• cmetinfo.coremif file.

The API creates a folder in the test server and writes all XSDs/MIFs and test files into the folder. The folder is available at the location $CTB_TOP/oracle/apps/ctb/message/defs/customSchema/{TestId}. TestId is generated as following, TestId = MessageTypeId_UserId_YYYYMMDD_HHMMSS.

If the testing is successful, the API returns the Test ID. In case of any failure, the testing does not stop in the middle, the HDRRimException is thrown after passing all the steps. The exception instance contains the Test Id value in parameter "TEST_ID". Following code snippet demonstrates how to retrieve the TestId from the HDRRimException instance.

String testId = (String)ctbException.getParameter("TEST_ID")};

All the test data loaded into the test server are rolled back from data base, irrespective of whether the test is successful or unsuccessful. However, the test directory and test files will be available in the server. Use the following APIs to fetch the test files and remove the test files.

To fetch the test files:
oracle.hsgbu.hdr.hl7.message.mtk.TestIdData testIdData = mtkTestService.downloadTestFilesForATest(testId);

To remove the test files:
mtkTestService.removeTestFilesForATest(testId);

The step by step processing of the testing is as following:
Getting input parameters

• Getting XSD and MIF for Payload and CMETs, cmetinfo.coremif file.
• Finding Payload Id.
• Creating Test Id directory.
• Finding Payload Type.
• Finding Interaction Id.

Validating Artifacts

• Validating MIF against schema.
• Validating Artifacts.
• Uploading artifacts.
• Creating artifact entries.
• Loading Interaction Schema into memory(for validation).
• Extracting metadata from MIF.

Test Message Generation

• Generating test instances.

Testing ALL Test Messages

• Testing Message
• Configuring
• Trigger Event detail.
• Sender/Receiver detail.
• Interaction detail.
• Ambiguous complex types detail.
• MasterCatalog detail.
• Sender and Side Effect configuration detail.
• Act Concept Configuration detail.

Persisting message using IMP

• Persisting the test instance.

Generating message using OMP

• Generating Message.
• Validating message against schema.

If the testing is not successful, and to know at what step the processing has failed, use following API.

String status = mtkTestService.getTestStatus(testId);

Core Mif Validation Rules:

• While testing a Message Type, the user passed cmetinfo.coremif entries are validated against the cmetinfo.coremif entries present at the server side.
• If the user passed cmetinfo.coremif has conflicting CMET entries with server side CMET entries in coremif file, then warning message is printed in the status file, and the test continues.
• If user passed cmetinfo.coremif has insufficient CMET entries, then exception is thrown, and the testing fails.
• If the Payload has reference to any CMET (either Oracle CMET or custom CMET), then cmetinfo.coremif should be passed to this API, with the required CMET entries.
• If the Payload does not have any reference to any CMETs, then the cmetinfo.coremif does not need to be passed to this API.

Parameters:

schemaInformation - oracle.hsgbu.hdr.hl7.message.mtk.SchemaInformationlist of XSD and MIF of Payload, MIF and XSD of CMETS associated with the Payload and cmetinfo.coremif.

testDesc - Comments about the test created by the user.

generateReport - Flag, indicating whether the configuration report files should be generated for this testing. If the fag is set to true, then all configuration report files will be generated. Else, no configuration report files will be generated.

Returns:

Test Id - Test files are stored in the Test Id directory.

Throws:

HDRRimException - This exception is thrown if,

• Test Artifacts, in oracle.hsgbu.hdr.hl7.message.mtk.SchemaInformation, have same name as the Oracle Artifacts.
• Payload XSD is missing in the oracle.hsgbu.hdr.hl7.message.mtk.SchemaInformationlist.
• There are more than one Payloads in the oracle.hsgbu.hdr.hl7.message.mtk.SchemaInformationlist.
• All XSDs must have a corresponding MIFs.
• cmetinfo.coremif file should be present in oracle.hsgbu.hdr.hl7.message.mtk.SchemaInformation list, if one or more CMETs are passed in the input list.
• One or more input MIF is invalid.
• Artifact type is not supported (other than Payload or CMET or cmetinfo.coremif).
• One or more input XSD is invalid.
• Payload XSD cannot be loaded into memory, because there are invalid references, or all CMETS associated with the Payload are not loaded.
• MIF does not match with the XSD.
• XSD is not compliant with HL7 RIM standard.
• XSD has incorrect data types for certain attributes.
• Invalid values for structural attribute (Class Code, Mood Code, Type Code, Determiner Code).
• ETS records for the Trigger Event not found.
• ETS records for coded attributes not found.
• Unable to extract Metadata from MIF.
• Unable to construct a test instance for the Message Type.
• Unable to load any of the configurations for test instance.
• Unable to persist the test instance using IMP.
• Unable to persist the test instance using OMP.
• Unable to persist Metadata into database.
• Unable to persist Artifact Entries into database.
• Unable to write files into file system.

removeTestFilesForATest

void removeTestFilesForATest(String testId)
                      throws HDRRimException

Removes permanently all information associated with a Test Id. The Test Id directory, along with all the test files are removed.

Parameters:

testId - Test Id returned while testing a Message Type.

Throws:

HDRRimException - This exception is thrown if

• Test Id input is null.
• Test Id directory is not present on the server.
• Unable to delete the test files.

downloadTestFilesForATest

TestIdData downloadTestFilesForATest(String testId)
                              throws HDRRimException

Downloads all information associated with the testing of a Message Type, based on the Test Id. The Test Id value is returned when a Message Type testing completes successfully or unsuccessfully. This API does not support partial Test Id inputs, so the Test Id value should be a complete Id. If the test was not successful, then this API downloads partial information, based on the status of the test. If certain information is missing because of testing has not completed successfully, null value will be populated for the missing information. The downloaded (oracle.hsgbu.hdr.hl7.message.mtk.TestIdData) object contains the following data:

• Message Type Payload and CMET artifacts used for testing.
• One or many oracle.hsgbu.hdr.hl7.message.mtk.TestMessage(s). Each oracle.hsgbu.hdr.hl7.message.mtk.TestMessage has a pair of Test Message and Generated Message.
• Payload Id.
• Recommended configuration reports:
• Missing MasterCatalog entries Report.
• Side Effect Configuration Report.
• Ambiguous Complex Type for OMP Act Concept configuration Report.
• User comment passed while testing the Message Type.
• Status file content, that has descriptive testing stsep information.

Parameters:

testId - Test Id returned while testing a Message Type

Returns:

oracle.hsgbu.hdr.hl7.message.mtk.TestIdData, with the test files, including

• Payload XSDs and MIFs.
• Payload Id
• CMET XSDs and MIFs.
• cmetinfo.coremif.
• All report files (Mastercatalog, SideEffect and Ambiguous Complex Type Reports).
• Test messages.
• Generated messages.
• User comments.
• Status file content.

Throws:

HDRRimException - This exception is thrown if

• Test Id input is null.
• Test Id directory is not present on the server.
• Unable to read test files.

getMatchingTestIds

String[] getMatchingTestIds(String testId)
                     throws HDRRimException

Searches the Test Ids matching the given pattern.If no match is found, a zero length array is returned. The search pattern is case-insensitive. The search pattern can contain Oracle wildcards('%'symbol).
Example:

• PRTS% - Test Ids starting with 'PRTS'.
• PRTS%08 - Test Ids starting with 'PRTS' and ending with '08'.
• PRTS%MT%08 - Test Ids starting with 'PRTS', followed by 'MT ' and ending with '08'.
• %PRTS% - Test Ids having 'PRTS' as a part of their names.

If no matching Test Ids found, then zero length array is returned. If null or empty search pattern is passed, then exception is thrown.

Parameters:

testId - Test Id returned while testing a Message Type.

Returns:

Test Id array, matching the given search string.

Throws:

HDRRimException - This exception is thrown if,

• Test Id search string is null or empty.

getTestStatus

String getTestStatus(String testId)
              throws HDRRimException

Gets step by step description of status of the processing a Message Type testing. If the test has failed, the description provides an indication at what step of the processing, the testing failed, along with the exception message.

In case of test instance persistence failure, the IMP (InboundMessageProcessor) Acknowledgement is printed in status file. The status file will also contain warning messages for any CMET entry conflicts.

1. Sample Status file content, when the testing has passed successfully.

Parsing payload information from payload Mif.. successful

Payload Id : PRTS_MT000010TK01
Test Id : PRTS_MT000010TK01_SYSADMIN_20080317_070223
Payload Type : ACT

Validating Artifacts - started
Validating input parameters.. successful
Adding artifacts into server..
Adding artifacts into server successful
Extracting metadata from MIFs.. successful
Validating payload schema.. successful
Validating Artifacts - completed

Generating configuration reports - started
Generating MasterCatalog configuration report .. successful(oracle/apps/ctb/message/defs/customSchema/PRTS_MT000010TK01_SYSADMIN_20080317_070223/results/MastercatalogReport.csv)
Generating SideEffect configuration report.. successful (oracle/apps/ctb/message/defs/customSchema/PRTS_MT000010TK01_SYSADMIN_20080317_070223/results/SideEffectReport.csv)
Generating Act Concept configuration report.. successful (oracle/apps/ctb/message/defs/customSchema/PRTS_MT000010TK01_SYSADMIN_20080317_070223/results/AmbiguousComplexTypeReport.csv)
Generating configuration reports - completed

Test Message Generation - started
Generating message successful (oracle/apps/ctb/message/defs/customSchema/PRTS_MT000010TK01_SYSADMIN_20080317_070223/PRTS_MT000010TK01.ObservationGeneralIMP0.xml)
Generating message successful (oracle/apps/ctb/message/defs/customSchema/PRTS_MT000010TK01_SYSADMIN_20080317_070223/PRTS_MT000010TK01.ObservationGeneralIMP1.xml)
Generating message successful (oracle/apps/ctb/message/defs/customSchema/PRTS_MT000010TK01_SYSADMIN_20080317_070223/PRTS_MT000010TK01.ObservationGeneralIMP2.xml)
Test Message Generation - completed

Testing all Test Messages - started

Testing Message - started (PRTS_MT000010TK01.ObservationGeneralIMP1.xml)
Configuring - started
Trigger Event : CON-X2787564 (POXX_TE000003/HTB Supplemental)
Configuring Interaction.. successful
Configuring MasterCatalogs.. successful
Configuring Sender and SideEffects.. successful
Configuring Act Concepts.. successful
Configuring - completed

Persisting message using IMP .. successful
Persisted ControlAct: 1.2.3/2157037451

Generating message using OMP.. successful
Generated Message : oracle/apps/ctb/message/defs/customSchema/PRTS_MT000010TK01_SYSADMIN_20080317_070223/results/PRTS_MT000010TK01.ObservationGeneralOMP1.xml
Validating generated message against schema.. successful
Testing Message - completed (PRTS_MT000010TK01.ObservationGeneralIMP1.xml)

Testing Message - started (PRTS_MT000010TK01.ObservationGeneralIMP0.xml)
Configuring - started
Trigger Event : CON-X2787564 (POXX_TE000003/HTB Supplemental)
Configuring Interaction.. successful
Configuring MasterCatalogs.. successful
Configuring Sender and SideEffects.. successful
Configuring Act Concepts.. successful
Configuring - completed

Persisting message using IMP .. successful
Persisted ControlAct: 9.989898.5/2157039451

Generating message using OMP.. successful
Generated Message : oracle/apps/ctb/message/defs/customSchema/PRTS_MT000010TK01_SYSADMIN_20080317_070223/results/PRTS_MT000010TK01.ObservationGeneralOMP0.xml
Validating generated message against schema.. successful
Testing Message - completed (PRTS_MT000010TK01.ObservationGeneralIMP0.xml)

Testing Message - started (PRTS_MT000010TK01.ObservationGeneralIMP2.xml)
Configuring - started
Trigger Event : CON-X2787564 (POXX_TE000003/HTB Supplemental)
Configuring Interaction.. successful
Configuring MasterCatalogs.. successful
Configuring Sender and SideEffects.. successful
Configuring Act Concepts.. successful
Configuring - completed

Persisting message using IMP .. successful
Persisted ControlAct: 9.989898.5/2157039851

Generating message using OMP.. successful
Generated Message : oracle/apps/ctb/message/defs/customSchema/PRTS_MT000010TK01_SYSADMIN_20080317_070223/results/PRTS_MT000010TK01.ObservationGeneralOMP2.xml
Validating generated message against schema.. successful
Testing Message - completed (PRTS_MT000010TK01.ObservationGeneralIMP2.xml)

Testing all Test Messages - completed

Rolling Back all test data..

TESTING SUCCESSFUL

2. Sample Status file content, when the testing has failed.

Parsing payload information from payload Mif.. successful

Payload Id : POXX_MT110000TK03
Test Id : POXX_MT110000TK03_SYSADMIN_20080319_224053
Payload Type : ACT

Validating Artifacts - started
Validating input parameters.. successful
Adding artifacts into server..
Warning !!! a cmet name from cmetinfo.coremif referes to different cmet id in production environment
CMET_NAME : A_AccountPayeeUniversal EXISTING_CMET_ID :COCT_MT110200HT01 NEW_CMET_ID :COCT_MT110200TK01
Warning !!! a cmet name from cmetinfo.coremif referes to different cmet id in production environment
CMET_NAME : A_AccountPayorUniversal EXISTING_CMET_ID :COCT_MT110100HT01 NEW_CMET_ID :COCT_MT110100TK01
Warning !!! a cmet name from cmetinfo.coremif referes to different cmet id in production environment
CMET_NAME : A_ActMinimal EXISTING_CMET_ID :COCT_MT000110HT01 NEW_CMET_ID :COCT_MT000110TK01
Warning !!! a cmet name from cmetinfo.coremif referes to different cmet id in production environment
CMET_NAME : R_SupplyItemUniversal EXISTING_CMET_ID :COCT_MT940010HT02 NEW_CMET_ID :COCT_MT940010TK02
Adding artifacts into server successful
Extracting metadata from MIFs.. successful
Validating payload schema.. successful
Validating Artifacts - completed

Generating configuration reports - started
Generating MasterCatalog configuration report .. successful (oracle/apps/ctb/message/defs/customSchema/POXX_MT110000TK03_SYSADMIN_20080319_224053/results/MastercatalogReport.csv)
Generating SideEffect configuration report.. successful (oracle/apps/ctb/message/defs/customSchema/POXX_MT110000TK03_SYSADMIN_20080319_224053/results/SideEffectReport.csv)
Generating Act Concept configuration report.. successful (oracle/apps/ctb/message/defs/customSchema/POXX_MT110000TK03_SYSADMIN_20080319_224053/results/AmbiguousComplexTypeReport.csv)
Generating configuration reports - completed

Test Message Generation - started
Generating message successful (oracle/apps/ctb/message/defs/customSchema/POXX_MT110000TK03_SYSADMIN_20080319_224053/POXX_MT110000TK03.ObservationEventIMP0.xml)
Generating message successful (oracle/apps/ctb/message/defs/customSchema/POXX_MT110000TK03_SYSADMIN_20080319_224053/POXX_MT110000TK03.ObservationEventIMP1.xml)
Generating message successful (oracle/apps/ctb/message/defs/customSchema/POXX_MT110000TK03_SYSADMIN_20080319_224053/POXX_MT110000TK03.ObservationEventIMP2.xml)
Generating message successful (oracle/apps/ctb/message/defs/customSchema/POXX_MT110000TK03_SYSADMIN_20080319_224053/POXX_MT110000TK03.ObservationEventIMP3.xml)
Test Message Generation - completed

Testing all Test Messages - started

Testing Message - started (POXX_MT110000TK03.ObservationEventIMP0.xml)
Configuring - started
Trigger Event : CON-X2787188 (EncounterStatus/HTB Supplemental)
Configuring Interaction.. successful
Configuring MasterCatalogs.. successful
Configuring Sender and SideEffects.. successful
Configuring Act Concepts.. successful
Configuring - completed

Persisting message using IMP .. successful
Persisted ControlAct: 9.989898.5/286893102

Generating message using OMP.. successful
Generated Message : oracle/apps/ctb/message/defs/customSchema/POXX_MT110000TK03_SYSADMIN_20080319_224053/results/POXX_MT110000TK03.ObservationEventOMP0.xml
Validating generated message against schema.. failed
Testing Message - failed. (POXX_MT110000TK03.ObservationEventIMP0.xml)

ERROR: CTB_MTK_MS_SCM_VALIDATN_FAIL:CTB_MTK_MS_SCM_VALIDATN_FAIL: Message generated by OMP failed to validate against the schema. CAUSE: Element 'center' not expected.

Testing Message - started (POXX_MT110000TK03.ObservationEventIMP2.xml)
Configuring - started
Trigger Event : CON-X2787188 (EncounterStatus/HTB Supplemental)
Configuring Interaction.. successful
Configuring MasterCatalogs.. successful
Configuring Sender and SideEffects.. successful
Configuring Act Concepts.. successful
Configuring - completed

Persisting message using IMP .. successful
Persisted ControlAct: 9.989898.5/286902502

Generating message using OMP.. successful
Generated Message : oracle/apps/ctb/message/defs/customSchema/POXX_MT110000TK03_SYSADMIN_20080319_224053/results/POXX_MT110000TK03.ObservationEventOMP2.xml
Validating generated message against schema.. failed
Testing Message - failed. (POXX_MT110000TK03.ObservationEventIMP2.xml)

ERROR: CTB_MTK_MS_SCM_VALIDATN_FAIL:CTB_MTK_MS_SCM_VALIDATN_FAIL: Message generated by OMP failed to validate against the schema. CAUSE: Element 'center' not expected.

Testing Message - started (POXX_MT110000TK03.ObservationEventIMP1.xml)
Configuring - started
Trigger Event : CON-X2787188 (EncounterStatus/HTB Supplemental)
Configuring Interaction.. successful
Configuring MasterCatalogs.. successful
Configuring Sender and SideEffects.. successful
Configuring Act Concepts.. successful
Configuring - completed

Persisting message using IMP .. successful
Persisted ControlAct: 1.2.3/286882702

Generating message using OMP.. successful
Generated Message : oracle/apps/ctb/message/defs/customSchema/POXX_MT110000TK03_SYSADMIN_20080319_224053/results/POXX_MT110000TK03.ObservationEventOMP1.xml
Validating generated message against schema.. failed
Testing Message - failed. (POXX_MT110000TK03.ObservationEventIMP1.xml)

ERROR: CTB_MTK_MS_SCM_VALIDATN_FAIL:CTB_MTK_MS_SCM_VALIDATN_FAIL: Message generated by OMP failed to validate against the schema. CAUSE: Element 'center' not expected.

Testing Message - started (POXX_MT110000TK03.ObservationEventIMP3.xml)
Configuring - started
Trigger Event : CON-X2787188 (EncounterStatus/HTB Supplemental)
Configuring Interaction.. successful
Configuring MasterCatalogs.. successful
Configuring Sender and SideEffects.. successful
Configuring Act Concepts.. successful
Configuring - completed

Persisting message using IMP .. successful
Persisted ControlAct: 9.989898.5/286920602

Generating message using OMP.. successful
Generated Message : oracle/apps/ctb/message/defs/customSchema/POXX_MT110000TK03_SYSADMIN_20080319_224053/results/POXX_MT110000TK03.ObservationEventOMP3.xml
Validating generated message against schema.. failed
Testing Message - failed. (POXX_MT110000TK03.ObservationEventIMP3.xml)

ERROR: CTB_MTK_MS_SCM_VALIDATN_FAIL:CTB_MTK_MS_SCM_VALIDATN_FAIL: Message generated by OMP failed to validate against the schema. CAUSE: Element 'center' not expected.

Testing all Test Messages - failed

Rolling Back all test data..

TESTING FAILED

Parameters:

testId - - Test Id returned while testing a Message Type

Returns:

Descriptive text of the status of the processing.

Throws:

HDRRimException - This exception is thrown if

• Test Id directory is not found on the server.
• The status file is not found or unable to read the status file.