InterSystems IRIS Data Platform 2020.4 > Class Reference > ENSLIB namespace > EnsPortal.JavaBusinessHosts


class EnsPortal.JavaBusinessHosts extends EnsPortal.Template.standardPage

Page for generating a Java Business Host (either type Business Service or Business Operation)

Property Inventory

Method Inventory


parameter PAGENAME = Java Business Hosts;
Inherited description: Displayed name of this page.
parameter RESOURCE = %Ens_Code:WRITE,%Ens_JBH:WRITE;
User needs WRITE permissions on either the %Ens_Code resource or the %Ens_JBH resource to view this page.


property HostType as %String (VALUELIST = "Service,Operation") [ InitialExpression = "Operation" ];
Property methods: HostTypeDisplayToLogical(), HostTypeGet(), HostTypeIsValid(), HostTypeLogicalToDisplay(), HostTypeLogicalToOdbc(), HostTypeNormalize(), HostTypeSet()
property InSwitchProds as %Boolean [ InitialExpression = 0 ];
Track whether we are in the middle of stopping one production and starting another one
Property methods: InSwitchProdsDisplayToLogical(), InSwitchProdsGet(), InSwitchProdsIsValid(), InSwitchProdsLogicalToDisplay(), InSwitchProdsLogicalToXSD(), InSwitchProdsNormalize(), InSwitchProdsSet(), InSwitchProdsXSDToLogical()
property canEditDB as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to indicate whether the user has WRITE permissions on the Databases used by this production
Property methods: canEditDBDisplayToLogical(), canEditDBGet(), canEditDBIsValid(), canEditDBLogicalToDisplay(), canEditDBLogicalToOdbc(), canEditDBLogicalToXSD(), canEditDBNormalize(), canEditDBSet(), canEditDBXSDToLogical()
property canViewFileSystem as %Boolean [ Final , 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 dbIsRO as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to indicate if the default db is mounted R/O
Property methods: dbIsRODisplayToLogical(), dbIsROGet(), dbIsROIsValid(), dbIsROLogicalToDisplay(), dbIsROLogicalToOdbc(), dbIsROLogicalToXSD(), dbIsRONormalize(), dbIsROSet(), dbIsROXSDToLogical()
property msgNoDBPermissions as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("This action writes to a database that you do not have WRITE permissions on.") ];
Message to inform user they don't have WRITE permissions on the DB required to perform an action
Property methods: msgNoDBPermissionsDisplayToLogical(), msgNoDBPermissionsGet(), msgNoDBPermissionsIsValid(), msgNoDBPermissionsLogicalToDisplay(), msgNoDBPermissionsLogicalToOdbc(), msgNoDBPermissionsNormalize(), msgNoDBPermissionsSet()
property msgNotPermitted as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("You are not permitted to perform this action") ];
Message to inform the user they may not perform a given action.
Property methods: msgNotPermittedDisplayToLogical(), msgNotPermittedGet(), msgNotPermittedIsValid(), msgNotPermittedLogicalToDisplay(), msgNotPermittedLogicalToOdbc(), msgNotPermittedNormalize(), msgNotPermittedSet()


method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Populate the controls as needed.
method %OnGetPageName() as %String [ Language = objectscript ]
Get the (localized) name of the page.
method %OnGetTitle() as %String [ Language = objectscript ]
Get the (localized) title string for the page.
classmethod CheckFileExists(pFilename As %String) as %Boolean [ Language = objectscript, ZenMethod ]
classmethod CheckJGStatus() as %String [ Language = objectscript, ZenMethod ]
classmethod DetectIsJGRunning() as %String [ Language = objectscript, ZenMethod ]
Returns status of the current active production wrt Java Gateway Returns 0 if there is no active production Returns error text if an error is encountered Otherwise returns 3 digit integer which is the concatenation of 3 booleans: Is the production running?, Is there a Java Gateway Service?, If so is that running?
classmethod DoEnableJGService(pConfigName) as %String [ Language = objectscript, ZenMethod ]
classmethod GetActiveProductionName() as %String [ Language = objectscript, ZenMethod ]
classmethod GetDefaultDir() as %String [ Language = objectscript, ZenMethod ]
classmethod GetHyperEventResources(pMethod As %String = "") as %String [ Language = objectscript ]
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 GetProductionState() as %Integer [ Language = objectscript, ZenMethod ]
classmethod GetSecurityHelper() as %ZEN.proxyObject [ Language = objectscript, ZenMethod ]
classmethod IsJavaBS(pSuperClass) as %Boolean [ Language = objectscript, ZenMethod ]
classmethod JavaClassesClose(ByRef qHandle As %Binary) as %Status [ Language = objectscript ]
classmethod JavaClassesExecute(ByRef qHandle As %Binary, pJarFile As %String) as %Status [ Language = objectscript ]
classmethod JavaClassesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status [ Language = objectscript ]
clientmethod OnGenerate() [ Language = javascript ]
Generate the requested business host
method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status [ Language = objectscript ]
Get information to display in the ribbon bar.
classmethod SetDefaultDir(pPathname As %String) [ Language = objectscript, ZenMethod ]
classmethod SingleJGService() as %String [ Language = objectscript, ZenMethod ]
clientmethod adjustSizes() [ Language = javascript ]
clientmethod browseSelect() [ Language = javascript ]
User clicked the Browse button.
clientmethod changeBtnState(btnName, enabled) [ Language = javascript ]
clientmethod checkEditDB() [ Language = javascript ]
clientmethod checkHelper(toCheck, noAlert) [ Language = javascript ]
clientmethod determineHostType() [ Language = javascript ]
clientmethod enableJGService(preSelected, selectedItem) [ Language = javascript ]
clientmethod genInitService() [ Language = javascript ]
clientmethod genJGProduction() [ Language = javascript ]
classmethod hasDBPermissions(ByRef tOK, ByRef DB As %String = "") as %Status [ Language = objectscript, ZenMethod ]
clientmethod onChangeProductions() [ Language = javascript ]
clientmethod onDetermineHostType(isService) [ Language = javascript ]
clientmethod onFileSelect(filename) [ Language = javascript ]
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
Returning from file select and setting the value into the appropriate field.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is first loaded or whenever it is resized.
If this is called at load time, then load will be true.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod setDefaultName(oldValue) [ Language = javascript ]
Set a default ObjectScript class name based on the Java class name
clientmethod showCredentialsDetails() [ Language = javascript ]
Launch the profile info dialog.
clientmethod startProduction() [ Language = javascript ]
Start the Production.
clientmethod updateProdPanel() [ Language = javascript ]
clientmethod updateProduction(action, production) [ Language = javascript ]
This client method handles start / stop / update / recover Production. A popup is displayed containing progress messages.
clientmethod updateSecurityHelper() [ Language = javascript ]
clientmethod validate() [ Language = javascript ]
Validate the contents of the form.


query JavaClasses(pJarFile As %String)
Selects ClassAndType As %String, Class As %String

Inherited Members

Inherited Properties

Inherited Methods