%CSP.UI.Portal.ExternalLanguageServers

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

Zen page for System Management Portal - External Language Servers

Property Inventory (Including Private)

Method Inventory (Including Private)

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;
Inherited description: 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;
Inherited description: 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 = %Admin_Manage;
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.
Property methods: JobNumberDisplayToLogical(), JobNumberGet(), JobNumberIsValid(), JobNumberLogicalToDisplay(), JobNumberNormalize(), JobNumberSet(), JobNumberXSDToLogical()

Methods

method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Inherited description: Be sure to do ##super() when overriding.
method %OnGetPageName() as %String [ Language = objectscript ]
Inherited description: Get the (localized) name of the page. This should be implemented in a subclass.
method CheckServerStatus(pJob) as %Boolean [ Language = objectscript, ZenMethod ]
Return whether the background job of status checking is done.
classmethod DeleteItem(Name) as %String [ Language = objectscript, ZenMethod ]
Call server delete method.
method DrawDelete(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status [ Language = objectscript ]
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 [ Language = objectscript ]
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 [ Language = objectscript ]
method DrawStart(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status [ Language = objectscript ]
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 [ Language = objectscript ]
Check to see if the server is running. Show link if it is not.
method OnDrawRibbon() as %Status [ Language = objectscript ]
Inherited description: 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 [ Language = objectscript ]
Get information to display in the ribbon bar.
clientmethod checkStatus() [ Language = javascript ]
Timeout Method used by the checkStatusTimer
clientmethod doActivities(PID) [ Language = javascript ]
User clicked Activities link. Goto to Activities page.
clientmethod doDelete(Name) [ Language = javascript ]
Delete existing gateway connection.
clientmethod doEdit(Name, editable) [ Language = javascript ]
User clicked the "Edit" link.
clientmethod doNew() [ Language = javascript ]
User clicked Start link. Goto to Start page.
clientmethod doStart(PID) [ Language = javascript ]
User clicked Start link. Goto to Start page.
clientmethod doStop(PID) [ Language = javascript ]
User clicked Stop link. Goto to Stop page.
clientmethod endTimer() [ Language = javascript ]
clientmethod filterChanged(value, tableID) [ Language = javascript ]
User entered something in to the filter. Re-load the table with filter value.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Feedback