oracle.hsgbu.hdr.message.mtk

Interface MtkProductionLoadService

All Known Subinterfaces:

MtkProductionLoadServiceLocalCMT, MtkProductionLoadServiceRemoteCMT

public interface MtkProductionLoadService

MtkProductionLoadService interface provides APIs to manage repository for custom artifacts. MtkProductionLoadService interface provides APIS for:

• Loading all the XSDs and Mifs, associated with a custom Message Type into server.
• Creating Composite schemas.
• Uploading schemas into server.
• Downloading Composite schemas based on a Payload Id.
• Downloading CMETs based on a Payload Id.
• Downloading CMETs, Payloads, Interaction schemas based on partial searching.
• Deleting CMETs, Payload schemas and associated information from database.
• Deleting a Composite schema and associated information from database.

Method Summary

Modifier and Type	Method and Description
String	createCompositeMessageSchema(InteractionDetail interactionDetail) Creates Composite Message Schema for the given Interaction detail.
void	deleteInteractionSchema(String interactionId) This API will delete the Interaction Schema from the file system.
void	deleteSchemas(String[] schemas) The only purpose of this API is to clean up orphaned CMETs or unused Payloads created by the user.
SchemaInformation[]	fetchCompositeMessageShemasByPayload(String payloadId) Fetches all the Composite Message Schemas that refer to the given Payload Id.
SchemaInformation[]	fetchCustomCMETsForPayload(String payloadId) Fetches all the CMETs created by user that are referred by the given Payload Id.
SchemaInformation[]	fetchSchemas(String[] schemaName) Returns the Schema and corresponding MIF contents, matching the given schema names.
void	loadCustomMessageTypeToProductionServer(SchemaInformation[] schemaInformation) This API allows the user to load tested Message Types into the server.
void	loadSchemas(SchemaInformation[] schemaInformation) Loads the schemas into server, updates Artifacts Registry and updates Metadata associated with the schemas.

Method Detail

loadCustomMessageTypeToProductionServer

void loadCustomMessageTypeToProductionServer(SchemaInformation[] schemaInformation)
                                      throws HDRRimException

This API allows the user to load tested Message Types into the server. It is expected that artifacts associated with Message Type are properly tested in using testCustomMessageType() API of MtkTestService. Only Custom Message Type can be uploaded using this API and Oracle artifacts can not be uploaded.

When invoking this API, the following artifacts associated with the Message Type must be passed.

• Payload XSD and MIF.
• All custom CMET XSDs and MIFs required by the Payload that are not loaded into server already.
• Updated cmetinfo.coremif(Optional, if the Payload does not refer to any CMET).

The API does the following tasks:

• Validates input parameters.
• Writes XSDs and MIFs into file system.
• Merges the updated cmetinfo.coremif with existing cmetinfo.coremif file in server.
• Loads Metadata.
• Creates Artifact Entries.
• Validates Payload XSD.

If there is a failure in loading the data or files, then the database updates will be rolled back and the existing files on server will not be overwritten.

Following core mif validation rules are applied when loading the Custom Message Type into production server:

• If user passed cmetinfo.coremif has additional CMET entries, then the additional entries are ignored.
• If user passed cmetinfo.coremif has insufficient CMET entries, then exception is thrown.
• If user passed cmetinfo.coremif has conflicting CMET names or ids with that of server side CMET entries, then exception is thrown.
• If the Payload has reference to any CMET (either Oracle CMET or custom CMET), then cmetinfo.coremif should be passed with the required CMET entries.
• If the Payload does not have reference to any CMETs, then the cmetinfo.coremif does not need to be passed to this API.

Parameters:

schemaInformation - Payload XSD and MIF, all the CMET XSDs and MIFs associated with the Payload, updated cmetinfo.coremif

Throws:

HDRRimException - This exception is thrown, if

• Uploading Artifacts have same name as the Oracle Artifacts.
• Payload XSD is missing in the uploading oracle.hsgbu.hdr.hl7.message.mtk.SchemaInformation list.
• More than one Payload XSDs are present in the uploading oracle.hsgbu.hdr.hl7.message.mtk.SchemaInformation list.
• XSD does not have a corresponding MIF.
• cmetinfo.coremif is not present in uploading oracle.hsgbu.hdr.hl7.message.mtk.SchemaInformation list, when at least one CMET is present in the list.
• Updated cmetinfo.coremif file cannot be merged with the existing cmetinfo.coremif present in the server.
• Payload XSD has invalid references to CMETs or all CMETs associated with the Payload are not loaded.
• Uploading artifact type is not supported (other than Payload or CMET or cmetinfo.coremif).
• One or more MIF is invalid.
• One or more XSD is invalid.
• Unable to load Metadata into database.
• Unable to create Artifact Entries in database.
• Unable to write files into file system.

createCompositeMessageSchema

String createCompositeMessageSchema(InteractionDetail interactionDetail)
                             throws HDRRimException

Creates Composite Message Schema for the given Interaction detail. The API configures the given Interaction detail in database first. If the Interaction detail already exists in database, then exception is thrown.

If the Interaction detail can be configured successfully, then it creates a new Composite Message Schema based on the given Interaction Id. Using this API, user can create Composite Schema for a custom Payload and as well as for an Oracle Payload.

The Composite Message schema is loaded into memory, validated and Metadata for the newly created Composite Message Schema is loaded. In case of any failure in loading the data or creating Composite Message schema, HDRRimException is thrown. In this case, the database updates are rolled back, and the Composite Message Schema is not created.

Parameters:

interactionDetail - oracle.hsgbu.hdr.hl7.message.mtk.InteractionDetail should contain the following data.

• Interaction Id.
• Message Type Id (Payload Id).
• Trigger Event ETS Id.
• Control Act Wrapper Id.
• Transmission Wrapper Id.

Returns:

The file path of generated Composite Message Schema.

Throws:

HDRRimException - This exception is thrown if,

• Interaction detail already exist in database.
• Unable to configure the Interaction detail in database.
• Loading of Composite Message Schema into memory fails.
• Metadata for the new Composite Message Schema can not be loaded.

fetchCompositeMessageShemasByPayload

SchemaInformation[] fetchCompositeMessageShemasByPayload(String payloadId)
                                                  throws HDRRimException

Fetches all the Composite Message Schemas that refer to the given Payload Id. This API retrieves Interaction Ids from database, using the given payload Id. Then, it searches for the Composite Message Schemas matching the Interaction Ids. All the Composite Message Schemas (user created schemas, and Oracle schemas) matching the Interaction Ids will be returned, if they are present on the file system.

Parameters:

payloadId - Payload Id e.g. PRPA_MT04000HT02. The API does an exact match for the Payload Id. There is no support for partial match.

Returns:

oracle.hsgbu.hdr.hl7.message.mtk.SchemaInformation List of Composite Message Schema XSDs.

Throws:

HDRRimException - This exception is thrown if

• Unable to query the Interaction Ids.
• Unable to read Composite Message Schemas from file system.

fetchCustomCMETsForPayload

SchemaInformation[] fetchCustomCMETsForPayload(String payloadId)
                                        throws HDRRimException

Fetches all the CMETs created by user that are referred by the given Payload Id. A zero length array will be returned, if no custom CMET is referred by the given Payload.

Parameters:

payloadId - Payload Id e.g. PRPA_MT04000HT02. It does an exact match. There is no support for partial match.

Returns:

oracle.hsgbu.hdr.hl7.message.mtk.SchemaInformation list of CMET XSD and corresponding MIF.

Throws:

HDRRimException - This exception is thrown if,

• Payload does not exist.
• Payload is not created by user (it is pre-seeded).
• Loading of Payload XSD into memory fails.
• If one or more CMET(s) referred by the Payload does not exist.

fetchSchemas

SchemaInformation[] fetchSchemas(String[] schemaName)
                          throws HDRRimException

Returns the Schema and corresponding MIF contents, matching the given schema names. The API returns both custom schema and pre-seeded schema contents. The input schema name can be either a complete or partial string e.g COCT_MT0001.xsd or COCT. No regular expression or special search strings are supported. If the input search string array is null or zero length, then exception is thrown. If no matching search result is found, then zero length result array is returned.

Parameters:

schemaName - partial or complete schema names.

Returns:

oracle.hsgbu.hdr.hl7.message.mtk.SchemaInformation list of XSD and MIF for the schema(s).

Throws:

HDRRimException

deleteSchemas

void deleteSchemas(String[] schemas)
            throws HDRRimException

The only purpose of this API is to clean up orphaned CMETs or unused Payloads created by the user. There is no facility to restore a deleted CMET or Payload. Deleting Payloads and CMETs incorrectly may make the server become unusable to process messages. If any of the schemas passed to API cannot be deleted, then none of the schemas are deleted. Only CMETs and Payloads are allowed to be deleted. Interaction Schemas cannot be deleted. Only CMETs and Payloads created by the user can be deleted. No seeded Payloads or CMETs can be deleted.

If the given Payload schema is referred by any Interaction Schema, then no schema is deleted. If the given CMET is referred by any Payload, then no schema is deleted. Also, if Sender or Receiver details are already configured for any Interaction schema referring to the given Payload, then exception is thrown, and no schema is deleted.

Following actions are carried out while deleting a CMET:

• All Payloads are loaded into memory, to find out if the CMET is referred by any of the Payloads.
• If no Payload refers to the CMET, then the API deletes the CMET XSD and MIF from the file system, deletes Metadata for the CMET, deletes corresponding entry from Artifact Registry, and deletes the CMET entry from cmetinfo.coremif.
• If a CMET is referred by any of the Payload, then exception is thrown and none of the schemas will be deleted.
• If a Payload is referred by any of the Interaction schemas, then exception is thrown and none of the schemas will be deleted.

Following actions are carried out while deleting a Payload:

• If the Payload, that needs to be deleted, is referred by an Interaction Schema, then exception is thrown and the Payload is not deleted.
• Payload XSD and MIF are removed from the file system.
• Entries from Artifact Registry for Payload and Interaction Id are deleted.
• Metadata for Payload and Interaction ID is deleted.

The API deletes either all schemas or none of the schemas. If any exception occurs, then none of the input schemas is deleted. The API first deletes the database entries for the schemas and then deletes the schemas from the file system.

Parameters:

schemas - The exact name of the XSD of the artifacts. More than one artifact names can be passed. The schema names should be strictly complete names. No partial matching is supported.

Throws:

HDRRimException - This exception is thrown if

• Schema does not exist
• Schema is not created by the user. It is pre-seeded.
• Schema is neither a CMET or Payload.
• If the CMET schema is referred by atleast one Payload.
• If the Payload is referred by atleast one Interaction schema.
• If Sender or Receiver details configured for the Interaction schema referring to the given Payload.
• Unable to query Interaction detail for a Payload.
• Unable to delete files from the system.
• Unable to delete the metadata.
• Unable to delete entries from Artifact Registry.

loadSchemas

void loadSchemas(SchemaInformation[] schemaInformation)
          throws HDRRimException

Loads the schemas into server, updates Artifacts Registry and updates Metadata associated with the schemas. The oracle.hsgbu.hdr.hl7.message.mtk.SchemaInformation list will be validated before uploading. Artifact entries for the uploading schemas will be created.

The loadCustomMessageTypeToProductionServer() API is used to load all the necessary artifacts associated with a Message Type. But, the loadSchema() API is used to load a particular CMET or cmetinfo.coremif. The loadSchema() API can not be used to load Payload. This API also loads the Metadata for the CMETs.

Following core mif validation rules are applied when loading the Custom Message Type into production server:

• If user passed cmetinfo.coremif has additional CMET entries, then the additional entries are ignored.
• If user passed cmetinfo.coremif has insufficient CMET entries, then exception is thrown.
• If user passed cmetinfo.coremif has conflicting CMET names or ids with that of server side CMET entries, then exception is thrown.
• If the Payload has reference to any CMET (either Oracle CMET or custom CMET), then cmetinfo.coremif should be passed with the required CMET entries.
• If the Payload does not have 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.SchemaInformation list of XSD and MIFs for CMETs, or cmetinfo.coremif

Throws:

HDRRimException - This exception is thrown if

• Schema name matches with any of the seeded artifact names.
• oracle.hsgbu.hdr.hl7.message.mtk.SchemaInformation object has insufficient information.
• Both MIF and XSD do not exist for a CMET.
• Uploading artifact type is a Payload.
• Uploading artifact type is not supported (other than CMET or cmetinfo.coremif).

deleteInteractionSchema

void deleteInteractionSchema(String interactionId)
                      throws HDRRimException

This API will delete the Interaction Schema from the file system. No pre-seeded Interaction schemas can be deleted using this API. If Sender or Receiver details configured for this Interaction Schema, then exception is thrown. Also, the API will delete the following data associated with the Interaction Schema.

• Interaction Id detail in the database.
• Metadata for the Interaction Schema.

First, the Metadata and Interaction detail entries are deleted . Then, the Interaction Schema is deleted from the file system to maintain the consistency.

Parameters:

interactionId - Exact Interaction Id, matching the Interaction Schema.

Throws:

HDRRimException - This exception is thrown if,

• Interaction Schema does not exist on the file system.
• Unable to delete Interaction Id detail.
• Unable to delete Metadata.
• If Sender or Receiver configuration detail associated with this Interaction Id exist.