Skip to main content


abstract class EnsPortal.Dialog.ProductionAddHost extends EnsPortal.Dialog.standardDialog

Add a new component to a production

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 RESOURCE = %Ens_ProductionConfig:WRITE;
User needs WRITE permissions on the %Ens_ProductionConfig resource to view this page and its subclasses.


property LinkHelp as %String [ Calculated ];
Property methods: LinkHelpDisplayToLogical(), LinkHelpIsValid(), LinkHelpLogicalToDisplay(), LinkHelpLogicalToOdbc(), LinkHelpNormalize()
property ProductionName as %ZEN.Datatype.string (ZENURL = "PRODUCTION");
Name of production that is displayed.
Property methods: ProductionNameDisplayToLogical(), ProductionNameGet(), ProductionNameIsValid(), ProductionNameLogicalToDisplay(), ProductionNameLogicalToOdbc(), ProductionNameNormalize(), ProductionNameSet()
property canViewFileSystem as %Boolean [ InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];
Is the user permitted to access the fileSelect popup.
Property methods: canViewFileSystemDisplayToLogical(), canViewFileSystemGet(), canViewFileSystemIsValid(), canViewFileSystemLogicalToDisplay(), canViewFileSystemLogicalToXSD(), canViewFileSystemNormalize(), canViewFileSystemSet(), canViewFileSystemXSDToLogical()
property defaultSettingsHTML as %ZEN.Datatype.string;
HTML info of possible default settings
Property methods: defaultSettingsHTMLDisplayToLogical(), defaultSettingsHTMLGet(), defaultSettingsHTMLIsValid(), defaultSettingsHTMLLogicalToDisplay(), defaultSettingsHTMLLogicalToOdbc(), defaultSettingsHTMLNormalize(), defaultSettingsHTMLSet()
property retValue as %ZEN.Datatype.string;
Holder for return value.
Property methods: retValueDisplayToLogical(), retValueGet(), retValueIsValid(), retValueLogicalToDisplay(), retValueLogicalToOdbc(), retValueNormalize(), retValueSet()


classmethod AddNewItem(pForm As %String, prefix As %String, production As Ens.Config.Production, Output item As Ens.Config.Item, poolSize As %Integer = "") as %Status
Generic method for adding a new host
classmethod AddOperationSettings(pForm As %String, prefix As %String, item As Ens.Config.Item) as %Status
classmethod AddServiceSettings(pForm As %String, prefix As %String, item As Ens.Config.Item) as %Status
classmethod DeriveRuleNames(pProdId As %String, pFieldValue As %String, pUserRequestedPackage As %String) as %String [ ZenMethod ]
This method checks to see if the supplied field value is a simple name or a full class name. If a simple name this method prepends the package for the identified production to the simple name.

This method also determines if the field value supplied in the wizard is going to have to be made into an alias and if so, returns the corresponding alias name and class name that it is going to use when it creates the rule. This gives the user the chance to accept/decline creating a rule with that alias and/or class name.

The return value of this method is a string that provides a class name and/or alias name, in one of the following comma-separated formats:

First position: "+" if we needed to prepend a package name to a simple rule name but it was otherwise fine, blank if we did not prepend anything
Second position: <aliasName> if a suitable class name had to be derived from an alias name, and this is the alias
Third position: <className> giving the class name (in any case)
Fourth position: "-" if a rule with this class name already exists, otherwise blank

method GetFrom() as %String [ ZenMethod ]
method GetHelp(pSeed As %String) as %String [ ZenMethod ]
method GetTo() as %String [ ZenMethod ]
classmethod ItemAlreadyExists(production As %String, name As %String, cls As %String, busType As %String, enabled As %ZEN.Datatype.boolean = 0) as %String [ ZenMethod ]
classmethod RuleAlreadyExists(pClassName As %String) as %Boolean [ ZenMethod ]
This method returns a value that JavaScript can understand as 1 (true) or 0 (false).
method SubmitRoutingRule(protocol As %String, serviceName As %String = "", schema As %String = "", itemRouter As Ens.Config.Item, ruleAlias As %String, ruleClass As %String, validation As %String = "", novalidation As %Boolean = 0) as %Status
Add new routing rule to complete a new HL7 or X12 service that has created its own "dedicated" router.
clientmethod changeTarget(formName) [ Language = javascript ]
If "auto-create service target" is true, disable the dataCombo field for choosing a service.
clientmethod changeType(host, edi) [ Language = javascript ]
Choose the correct adapter class and hide/show the correct fields for the selected protocol type. host = Service,Operation; edi = HL7,X12; type = TCP,File,FTP,HTTP,SOAP
clientmethod hideAll(host, edi) [ Language = javascript ]
Hide all form fields in response to the choice of protocol/adapter (Input Type).
clientmethod hideRow(fieldName) [ Language = javascript ]
Hide a form field; this usually happens based on the choice of protocol/adapter (Input Type).
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
clientmethod selectDirectory(controlName) [ Language = javascript ]
clientmethod showPossibleDefault(prefix, setting) [ Language = javascript ]
clientmethod showPossibleDefaults(hosttype, edi) [ Language = javascript ]
clientmethod showRow(fieldName) [ Language = javascript ]
Show a form field; this usually happens based on the choice of protocol/adapter (Input Type).
clientmethod toggleDefaultForEmpty(host, tab) [ Language = javascript ]
clientmethod validateAll(host, type) [ Language = javascript ]
Do validation of all fields on the form.

Inherited Members

Inherited Properties

Inherited Methods


FeedbackOpens in a new tab