Skip to main content


class EnsPortal.HL7.Dialog.CustomMessageType extends EnsPortal.Dialog.standardDialog

Create a new production and add components to it.

Property Inventory

Method Inventory


parameter APPLYBUTTON = 0;
Inherited description: If true, then this dialog displays an Apply button.
parameter CSSINCLUDES = ensemble/Ensemble_Wizards.css;
Inherited description: Comma-separated list of additional CSS include files for the page. If this page is using CSS3 then the CSS3INCLUDES parameter is used (if defined).
parameter PAGENAME = Custom Message Type Wizard;
Inherited description: Optional. This is the display name used for this page. If not provided, the class name is used.
parameter RESOURCE = %Ens_EDISchema:WRITE;
User needs WRITE permissions on the %Ens_EDISchema resource to view this page.


property baseSchema as %ZEN.Datatype.string (ZENURL = "BASE");
Immediate base schema of the schema being edited
Property methods: baseSchemaDisplayToLogical(), baseSchemaGet(), baseSchemaIsValid(), baseSchemaLogicalToDisplay(), baseSchemaLogicalToOdbc(), baseSchemaNormalize(), baseSchemaSet()
property caseType as %ZEN.Datatype.string (ZENURL = "TYPE");
"newFromSchemaMain", "copyFromSchemaMain", and "edit" are the valid values. Identifies the context in which the dialog is being used.
Property methods: caseTypeDisplayToLogical(), caseTypeGet(), caseTypeIsValid(), caseTypeLogicalToDisplay(), caseTypeLogicalToOdbc(), caseTypeNormalize(), caseTypeSet()
property category as %ZEN.Datatype.string (ZENURL = "CAT");
Schema being edited
Property methods: categoryDisplayToLogical(), categoryGet(), categoryIsValid(), categoryLogicalToDisplay(), categoryLogicalToOdbc(), categoryNormalize(), categorySet()
property copyStruct as %ZEN.Datatype.string;
In schema:name form, the name of the base message structure to copy to create the custom message structure for the message type.
Property methods: copyStructDisplayToLogical(), copyStructGet(), copyStructIsValid(), copyStructLogicalToDisplay(), copyStructLogicalToOdbc(), copyStructNormalize(), copyStructSet()
property createStruct as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Whether or not to create a new message structure for this message type.
Property methods: createStructDisplayToLogical(), createStructGet(), createStructIsValid(), createStructLogicalToDisplay(), createStructLogicalToOdbc(), createStructLogicalToXSD(), createStructNormalize(), createStructSet(), createStructXSDToLogical()
property messageType as %ZEN.Datatype.string (ZENURL = "MT");
Name of the message type being edited. Provided only when caseType = "edit".
Property methods: messageTypeDisplayToLogical(), messageTypeGet(), messageTypeIsValid(), messageTypeLogicalToDisplay(), messageTypeLogicalToOdbc(), messageTypeNormalize(), messageTypeSet()
property retValue as %ZEN.Datatype.string;
Holder for return value.
Property methods: retValueDisplayToLogical(), retValueGet(), retValueIsValid(), retValueLogicalToDisplay(), retValueLogicalToOdbc(), retValueNormalize(), retValueSet()
property returnMT as %ZEN.Datatype.string;
In schema:name form, the name of the return message type
Property methods: returnMTDisplayToLogical(), returnMTGet(), returnMTIsValid(), returnMTLogicalToDisplay(), returnMTLogicalToOdbc(), returnMTNormalize(), returnMTSet()
property sendingName as %ZEN.Datatype.string;
The name of the message structure for the message type.
Property methods: sendingNameDisplayToLogical(), sendingNameGet(), sendingNameIsValid(), sendingNameLogicalToDisplay(), sendingNameLogicalToOdbc(), sendingNameNormalize(), sendingNameSet()


method %OnAfterCreatePage() as %Status
Inherited description: Avoid writing out the session cookie if we are in a Studio session.
method %OnGetPageName() as %String
Get the (localized) name of the page.
method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the page.
classmethod GetHyperEventResources(pMethod As %String = "") as %String
Callback to return a list of resources required for a specific HyperEvent. The user must have sufficient privileges on one of the resource/permission pairs to be permitted to execute the hyperevent. An empty string implies the user already has sufficient privileges for the ZenMethod specified in pMethod.
classmethod GetMessageTypeUpdateFromServer(pCustomSchema As %String, pMessageType As %String) as %String [ ZenMethod ]
Get all the necessary data about the message type from the server in one call and use it later.

Here is the format of the comma and semi-colon separated string (values shown in angle brackets which are not really there):

classmethod GetValidationDataFromServer(pCustomSchema As %String, pNewMT As %String, pFirstMSName As %String) as %String [ ZenMethod ]
Get all the necessary data from the server in one call and use it later. pCustomSchema and pNewMT are without prefix or suffix. pFirstMS and pSecondMT are in the form schema:name.

Here is the format of the comma separated string (values shown in angle brackets which are not really there):

classmethod OnWizardCompletion(pSchemaName As %String, pNewTypeName As %String, pDescription As %String, pSendingName As %String, pCreateStructure As %Boolean, pCopyStructure As %String, pReturnType As %String) as %String [ ZenMethod ]
This method is invoked when the user completes the Wizard pressing "OK". Returns a null string if it succeeds, or an error message otherwise. pCopyStructure and pReturnType are in schema:name format.
method SetUpSchemaComboboxList(pCombo As %ZEN.Component.combobox, pCategory As %String, pQuery As %String, pColumn As %String, pBlankChoice As %Boolean)
classmethod ValidateReturnMT(pSchemaName As %String, pRetMTName As %String) as %String [ ZenMethod ]
Check to make sure that the message type pRetMTName is defined in the schema pSchemaName or one of its base schemas. For message types beginning with "ACK_", it is enough for message type ACK to be defined in the schema. Returns the message type in schema:name format if found or empty string otherwise
clientmethod chooseCopyType() [ Language = javascript ]
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod ondialogFinish(action) as %Boolean [ Language = javascript ]
This callback is called when the user presses the OK button. If this returns false, then the action is canceled.
clientmethod sortOutEntityName(name, msg) [ Language = javascript ]
clientmethod validateAll() [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab