Class Reference
%CSP.UI.Portal.ExternalLanguageServers
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [%CSP] >  [UI] >  [Portal] >  [ExternalLanguageServers]
Private  Storage

class %CSP.UI.Portal.ExternalLanguageServers extends %CSP.UI.Portal.Utils

Zen page for System Management Portal - External Language Servers

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 1 22


Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition %import %includeFiles %page
%resource CurrentColumn CurrentSort Filter
FirstFailed HelpAddress ISREADONLY InvalidParam
IsEMSReadOnly IsEditForm JobNumber LocatorHeader
OnclickArray PID ParentURL StdTitle
TableMaxRows TablePageSize ValidationErrorMsg aboutPage
align aux backgroundTimerInterval captionLastUpdate
cellAlign cellSize cellStyle cellVAlign
children composite contactPage containerStyle
cssLevel currSortMode currStep currViewMode
disabled dragAndDrop dragEnabled dropEnabled
enableAutoRefresh enclosingClass enclosingStyle error
groupClass groupStyle height hidden
hint hintClass hintStyle home
homePage id index label
labelClass labelDisabledClass labelPosition labelStyle
layout lblTitle limitPopups name
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onrefresh onshow
onupdate pageModified parent searchKey
showLabel slice title tuple
useSVG useSoftModals valign visible
width window zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%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 %GetNavTableState
%GetPageName %GetParameter %GetProductName %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 BuildMeter CheckAllBlanks
CheckContextLinks CheckEnterpriseManager CheckServerStatus ConvertParameter
Decrypt DeleteItem DoLogout DrawAutoRefresh
DrawDelete DrawDots DrawLocator DrawName
DrawRibbon DrawStart DrawStop DrawTitle
Encrypt EscapeHTML EscapeURL EvalResult
GetCSPURL GetContextLinks GetDocURL GetHomePage
GetNewURL GetQuickLinks HyperEventCall HyperEventHead
Include InsertHiddenField InsertHiddenFields IsPrivate
JavaInstalled LastUpdateTime Link OnDrawRibbon
OnGetRibbonInfo OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Page QuoteJS RegisterRecent RewriteURL
ShowError StartTimer StopTimer ThrowError
UnescapeHTML UnescapeURL UpdateAutoRefreshRate UpdateAutoRefreshState
UpdateServerStatuses UpdateTableNavState UpdateTableState XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore afterSave afterValidate
cancelPopup changePassword checkStatus childrenMutated
columnSort correctIELayering createComponent createComponentNS
deleteComponent disableCommandButton doActivities doCancel
doDelete doEdit doModified doNew
doStart doStop dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
enableCommandButton endModal endTimer exposeComponent
filterChanged findElement fireOnResizeEvent fireOnUnloadEvent
fireOnUpdateEvent firePopupAction getChildIndex getComponent
getComponentById getEnclosingDiv getHidden getHintElement
getLabelElement getOpener getPageTitle getProperty
getSettings getTime getTitleAreaHeight getType
goHome goMenu gotoNamespace gotoPage
hideCommandButton invokeSuper isButtonDisabled isOfType
launchPopupWindow logout makeId navMaxRowsChanged
navPageSizeChanged navigate onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onServerMethodCall onServerMethodError onServerMethodReturn
onStartModalHandler ondisabledHandler onhandleAutoLogoutWarn onkeydownHandler
onkeyupHandler onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onunloadHandler onupdateHandler
popupActionHandler refreshContents refreshHandler refreshkeyUp
removeChild render renderContents renderSVG
resetMsg searchBlur searchBoxHandler searchFocus
searchKeyDown searchKeyPress setComponentId setConnectivityStatusMsg
setHidden setModified setOverlayMode setPageTitle
setProperty setPropertyAll setRefreshMode setRefreshRate
setSortMode setSortModeHandler setTraceOption setViewMode
setViewModeHandler showAbout showCommandButton showContact
showDocumentation showHelp showMsg startModal
startProgressBar stopProgressBar switchNamespace trimSpace
updateTime updateView validateRequired zeroFill


Parameters

• parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
• parameter CSPURL = "/csp/sys/mgr/%CSP.UI.Portal.ExternalLanguageServers.zen";
This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
• parameter HELPADDRESS = "System Administration, Configuration, Connectivity, External Language Servers";
Each SMP page should set this link which points to the documentation anchor name.
• parameter PAGENAME = "External Language Servers";
Displayed name of this page.
• parameter RESOURCE;
Security requirement

Properties

• property JobNumber as %Integer;
$J of the background job number. Used to check whether the backjob is finished. When it is finished we stop the javascript timer.

Methods

• method %OnAfterCreatePage() as %Status
Be sure to do ##super() when overriding.
• method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
• method CheckServerStatus(pJob) as %Boolean [ ZenMethod ]
Return whether the background job of status checking is done.
• classmethod DeleteItem(Name) as %String [ ZenMethod ]
Call server delete method.
• method DrawDelete(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
Check to see if the server is running. Show link if it is not.
• method DrawDots(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
During the time a server's status is being checked, we draw gray and green dots with the green dot moving from left to right and repeat. When the server is inactive, we draw all black dots. When the server is active, we draw all green dots. When unexpected error occure to the background job, we draw a red dot at the end. During any other times, for example when the page is loading before the background job is started all dots are gray.
• method DrawName(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
• method DrawStart(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
Check to see if the server is running. Show link if it is not.
• method DrawStop(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
Check to see if the server is running. Show link if it is not.
• method OnDrawRibbon() as %Status
This is called in the middle of rendering the tool ribbon. Subclasses can inject their own content into the ribbon by writing it out in this method. This content is best wrapped within a single td element. It can also consist of multiple td elements.

To achieve a fixed position for elements within the ribbon, for a fixed width page you can use a single enclosing td that contains a table and a single tr, with td elements inside that single tr that contain your content for the ribbon.

To achieve a fixed position for elements within the ribbon, for a page whose width varies depending on its contents (thereby stretching the ribbon) you can use multiple td elements to contain your content and then a final td element that is empty and has width 40% (or so) to push your contents towards the left and keep them in their proper locations.

• 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.
• method UpdateServerStatuses() as %Status [ ZenMethod ]
• method checkStatus() [ Language = javascript ]
Timeout Method used by the checkStatusTimer
• method doActivities(PID) [ Language = javascript ]
User clicked Activities link. Goto to Activities page.
• method doDelete(Name) [ Language = javascript ]
Delete existing gateway connection.
• method doEdit(Name, editable) [ Language = javascript ]
User clicked the "Edit" link.
• method doNew() [ Language = javascript ]
User clicked Start link. Goto to Start page.
• method doStart(PID) [ Language = javascript ]
User clicked Start link. Goto to Start page.
• method doStop(PID, softTimeout) [ Language = javascript ]
User clicked Stop link. Goto to Stop page. PID : the name of the external language server softTimeout : optional soft shutdown timeout in seconds
• method endTimer() [ Language = javascript ]
• method filterChanged(value, tableID) [ Language = javascript ]
User entered something in to the filter. Re-load the table with filter value.
• method updateView() [ Language = javascript ]
Update / Reload table. Subclass may override this method. Do not modify this method unless you are going to take care of all pages that use it.


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