Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [EnsPortal] >  [JavaBusinessHosts]
Private  Storage   

class EnsPortal.JavaBusinessHosts extends EnsPortal.Template.standardPage

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


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 7 46 1


This is a Zen Page class. It belongs to the application EnsPortal.Application.

%condition %import %includeFiles %page
%resource HelpAddress HostType ISREADONLY
InSwitchProds LocatorHeader ParentURL StdTitle
aboutPage align aux backgroundTimerInterval
canEdit canEditDB canViewFileSystem cellAlign
cellSize cellStyle cellVAlign children
composite contactPage containerStyle cssLevel
currSortMode currStep currViewMode dbIsRO
disabled dragAndDrop dragEnabled dropEnabled
enableAutoRefresh enclosingClass enclosingStyle error
groupClass groupStyle height hidden
hint hintClass hintStyle home
homePage id index keepAliveInterval
label labelClass labelDisabledClass labelPosition
labelStyle layout lblTitle limitPopups
msgNoDBPermissions msgNotPermitted name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
pageModified parent searchKey showLabel
slice title tuple useSVG
useSoftModals valign visible width
window zenPersistentPopup

%AddCSPShareHyperevents %AddChild %AddChildAfter %AddChildBefore
%AddComponent %AddEnsExceptionHandler %AddImportedComponents %AddLocatorLinks
%AddToSaveSet %ApplyURLParms %Attr %BindExport
%ClassIsLatestVersion %ClassName %ConstructClone %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout %DrawClassDefinitions
%DrawComponentHTML %DrawHTML %DrawHTMLPage %DrawJSStrings
%DrawObjectDefinitions %EnclosingDivId %EndBackgroundMethod %EndScript
%Eval %EvalC %Extends %ForceClientRender
%GetChildIndex %GetComponent %GetComponentById %GetComponentByName
%GetEventHandlers %GetHomePage %GetHomeParam %GetLinks
%GetLocatorLinks %GetPageName %GetParameter %GetProductName
%GetRootLink %GetValueById %GetValueByName %GetXMLName
%IsA %IsModified %Link %LinkCSS
%LinkScript %MakeId %New %NormalizeObject
%ObjectModified %OnAddToPageAfter %OnAddToPageBefore %OnAfterCreatePage
%OnBeforeCreatePage %OnCreateApplication %OnCreatePage %OnDetermineCSSLevel
%OnDrawEnclosingDiv %OnDrawHTMLBody %OnDrawHTMLHead %OnDrawHTMLMeta
%OnDrawObjectProperties %OnFinishBackgroundTask %OnGetPageName %OnGetProductName
%OnGetSmallMenu %OnGetTitle %OnMonitorBackgroundTask %OnMutateChildren
%OnObjectSynch %OnPreHTTP %OnSubmit %OnUseSoftModals
%OnZENDeserialize %OriginalNamespace %PackageName %QuoteValue
%QuoteValueL10N %Register %RemoveChild %RemoveChildren
%RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod %Self
%SerializeObject %SetBackgroundMethodStatus %SetErrorById %SetErrorByName
%SetModified %SetValueById %SetValueByName %SetValuesByName
%StartScript %ValidateObject %ZENVersion BuildMenu
CheckAllBlanks CheckContextLinks CheckEnterpriseManager CheckFileExists
CheckJGStatus ConvertParameter Decrypt DetectIsJGRunning
DoEnableJGService DoLogout DrawLocator DrawRibbon
DrawTitle Encrypt EscapeHTML EscapeURL
EvalResult GetActiveProductionName GetCSPURL GetContextLinks
GetDefaultDir GetDocPage GetHomePage GetHyperEventResources
GetLink GetNewURL GetProductionState GetQuickLinks
GetSecurityHelper HyperEventCall HyperEventHead Include
InsertHiddenField InsertHiddenFields IsJavaBS IsPrivate
JavaClassesClose JavaClassesExecute JavaClassesFetch Link
OnDrawRibbon OnGenerate OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RegisterRecent RewriteURL SetDefaultDir ShowError
SimpleKeepAlive SingleJGService StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore addPopupSuffix adjustSizes
arrowClick browseSelect cancelPopup changeBtnState
changePassword changeURLNamespace checkEdit checkEditDB
checkHelper childrenMutated clientKeepAlive correctIELayering
createComponent createComponentNS deleteComponent determineHostType
disableCommandButton dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler enableCommandButton
enableJGService endModal exposeComponent findElement
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
genInitService genJGProduction getChildIndex getComponent
getComponentById getEnclosingDiv getHidden getHintElement
getLabelElement getOpener getPageTitle getProperty
getSettings getTitleAreaHeight getType goHome
goMenu gotoNamespace gotoPage hasDBPermissions
hideCommandButton inResizeLoop initPopupSuffix invokeSuper
isOfType launchPopupWindow logout makeId
navigate onChangeProductions onCreate onDelete
onDetermineHostType onDisplayHandler onEndModalHandler onFileSelect
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondisabledHandler
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler popupActionHandler refreshContents removeChild
removePopupSuffix render renderContents renderSVG
searchBlur searchBoxHandler searchFocus searchKeyDown
searchKeyPress setComponentId setConnectivityStatusMsg setDefaultName
setHidden setModified setOverlayMode setPageTitle
setProperty setPropertyAll setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler showAbout
showCommandButton showContact showCredentialsDetails showDocumentation
showHelp startKeepAlive startModal startProduction
startProgressBar stopKeepAlive stopProgressBar switchNamespace
updateProdPanel updateProduction updateSecurityHelper validate


• parameter PAGENAME = "Java Business Hosts";
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 InSwitchProds as %Boolean [ InitialExpression = 0 ];
Track whether we are in the middle of stopping one production and starting another one
• 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 canViewFileSystem as %Boolean [ Final,InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];
Is the user permitted to access the fileSelect popup.
• property dbIsRO as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to indicate if the default db is mounted R/O
• 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 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.


• method %OnAfterCreatePage() as %Status
Populate the controls as needed.
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• classmethod CheckFileExists(pFilename As %String) as %Boolean [ ZenMethod ]
• classmethod CheckJGStatus() as %String [ ZenMethod ]
• classmethod DetectIsJGRunning() as %String [ 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 [ ZenMethod ]
• classmethod GetActiveProductionName() as %String [ ZenMethod ]
• classmethod GetDefaultDir() as %String [ ZenMethod ]
• 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 GetLink() as %String [ ZenMethod ]
• classmethod GetProductionState() as %Integer [ ZenMethod ]
• classmethod GetSecurityHelper() as %ZEN.proxyObject [ ZenMethod ]
• classmethod IsJavaBS(pSuperClass) as %Boolean [ ZenMethod ]
• classmethod JavaClassesClose(ByRef qHandle As %Binary) as %Status
• classmethod JavaClassesExecute(ByRef qHandle As %Binary, pJarFile As %String) as %Status
• classmethod JavaClassesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• method 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
Get information to display in the ribbon bar.
• classmethod SetDefaultDir(pPathname As %String) [ ZenMethod ]
• classmethod SingleJGService() as %String [ ZenMethod ]
• method adjustSizes() [ Language = javascript ]
• method browseSelect() [ Language = javascript ]
User clicked the Browse button.
• method changeBtnState(btnName, enabled) [ Language = javascript ]
• method checkEditDB() [ Language = javascript ]
• method checkHelper(toCheck, noAlert) [ Language = javascript ]
• method determineHostType() [ Language = javascript ]
• method enableJGService(preSelected, selectedItem) [ Language = javascript ]
• method genInitService() [ Language = javascript ]
• method genJGProduction() [ Language = javascript ]
• classmethod hasDBPermissions(ByRef tOK, ByRef DB As %String = "") as %Status [ ZenMethod ]
• method onChangeProductions() [ Language = javascript ]
• method onDetermineHostType(isService) [ Language = javascript ]
• method onFileSelect(filename) [ Language = javascript ]
• method onPopupAction(popupName, action, value) [ Language = javascript ]
Returning from file select and setting the value into the appropriate field.
• method onlayoutHandler(load) [ Language = javascript ]
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.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method setDefaultName(oldValue) [ Language = javascript ]
Set a default ObjectScript class name based on the Java class name
• method showCredentialsDetails() [ Language = javascript ]
Launch the profile info dialog.
• method startProduction() [ Language = javascript ]
Start the Production.
• method updateProdPanel() [ Language = javascript ]
• method updateProduction(action, production) [ Language = javascript ]
This client method handles start / stop / update / recover Production. A popup is displayed containing progress messages.
• method updateSecurityHelper() [ Language = javascript ]
• method validate() [ Language = javascript ]
Validate the contents of the form.


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

Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.