Skip to main content


class EnsPortal.HL7.Dialog.CustomDocumentStructure 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,ensemble/Ensemble_EDI.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 Structure 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 current as %String);
Current contents of text edit box
Property methods: currentDisplayToLogical(), currentGet(), currentIsValid(), currentLogicalToDisplay(), currentLogicalToOdbc(), currentNormalize(), currentSet()
property customStruct as %String (ZENURL = "MS");
Message structure being worked on
Property methods: customStructDisplayToLogical(), customStructGet(), customStructIsValid(), customStructLogicalToDisplay(), customStructLogicalToOdbc(), customStructNormalize(), customStructSet()
property nextKey as %Integer [ InitialExpression = 0 ];
Property methods: nextKeyDisplayToLogical(), nextKeyGet(), nextKeyIsValid(), nextKeyLogicalToDisplay(), nextKeyNormalize(), nextKeySet(), nextKeyXSDToLogical()
property nextSave as %Integer [ InitialExpression = 0 ];
Property methods: nextSaveDisplayToLogical(), nextSaveGet(), nextSaveIsValid(), nextSaveLogicalToDisplay(), nextSaveNormalize(), nextSaveSet(), nextSaveXSDToLogical()
property retValue as %ZEN.Datatype.string;
Holder for return value.
Property methods: retValueDisplayToLogical(), retValueGet(), retValueIsValid(), retValueLogicalToDisplay(), retValueLogicalToOdbc(), retValueNormalize(), retValueSet()


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.
method DeleteStructure(pSchema As %String, pMessageStructure As %String) as %ZEN.Datatype.string [ ZenMethod ]
The user does not do a delete on this page; this is in case we need to do a cancel and return to previous state.
method DrawContent(pSeed As %String) as %Status
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.
method GetMessageStructUpdateFromServer(pCustomSchema As %String, pMessageStruct As %String) as %String [ ZenMethod ]
Get all the necessary data about the message structure from the server in one call and use it later.

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

classmethod GetValidationDataFromServer(pCustomSchema As %String, pNewMS As %String) as %String [ ZenMethod ]
Get all the necessary data from the server in one call and use it later. pCustomSchema and pNewMS are without prefix or suffix.

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

classmethod OnWizardCompletion(pSchemaName 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.
classmethod PutNewMessageOnServer(pCategory As %String, pStructure As %String, pRawDescription As %String, pTextDescription As %String) as %String [ ZenMethod ]
method SetUpSchemaComboboxList(pCombo As %ZEN.Component.combobox, pCategory As %String, pQuery As %String, pColumn As %String, pBlankChoice As %Boolean)
method StripOutSchemas(pRaw As %String) as %String
clientmethod backToPreviousSave() [ Language = javascript ]
clientmethod chooseCopyStruct() [ Language = javascript ]
clientmethod clearKeyBuffer() [ Language = javascript ]
clientmethod clearSaveBuffer() [ Language = javascript ]
clientmethod decrementKeyBuffer() [ Language = javascript ]
clientmethod doOriginal() [ Language = javascript ]
This method is not currently used on this page. This method returns the raw text and description to the original, when in edit mode, bypassing the need for multiple undo operations.
clientmethod doTrySave() [ Language = javascript ]
clientmethod doUndoKey() [ Language = javascript ]
clientmethod doUndoSave() [ 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 incrementKeyBuffer(raw) [ Language = javascript ]
clientmethod incrementSaveBuffer(raw, desc) [ Language = javascript ]
clientmethod ondialogCancel() [ Language = javascript ]
This callback, if defined, is called when the user presses the Cancel button. If this returns false, then the dialog is not cancelled.
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 ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
clientmethod refreshVisual(schema, name) [ Language = javascript ]
clientmethod showSyntax() [ Language = javascript ]
clientmethod sortOutEntityName(name, msg) [ Language = javascript ]
clientmethod switchToVisual(schema, name, label) [ Language = javascript ]
clientmethod textKeyUp() [ Language = javascript ]
clientmethod validateAll() [ Language = javascript ]
clientmethod validateRaw(raw) [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab