Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%CSP.UI.Portal.ZenReportExcelServer

class %CSP.UI.Portal.ZenReportExcelServer extends %CSP.UI.Portal.Template

Management Portal - Create or edit/manage a Zen Report Excel Server.

Property Inventory

Method Inventory

Parameters

parameter APPLICATION = %CSP.UI.Portal.Application;
Class name of application this page belongs to.
parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
parameter CSPURL = /csp/sys/mgr/%CSP.UI.Portal.ZenReportExcelServer.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 = Home,Configuration,Zen Report Excel Servers,New Zen Report Excel Server;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter JSINCLUDES = zenCSLM.js;
Inherited description: Comma-separated list of additional JS include files for the page.
parameter PAGENAME = Zen Report Excel Server;
Displayed name of this page.
parameter PARENTPAGE = /csp/sys/mgr/%CSP.UI.Portal.ZenReportExcelServers.zen;
Inherited description: This parameter defines the parent page for this page.
If the name ends in .csp, then the parent is assumed to be an autopage-enabled CSP page.
If the name ends in .cls, then the parent is assumed to be a Zen page.
This is used to automate the construction of the locator bar for this page and to build the index between portal pages and documentation.
The %GetLocatorInfo method is used to get this information.
parameter RECENT = 0;
Inherited description: If true, register visits to this page in the recent list.
parameter RESOURCE = %Admin_Manage;
Security requirement
parameter TYPE = 3;
Indicates an Excel Server

Properties

property IsEditForm as %Boolean [ InitialExpression = 1 ];
Inherited description: If set to 1 then the generic Save and Cancel button will be shown on the ribbon bar.
Property methods: IsEditFormDisplayToLogical(), IsEditFormGet(), IsEditFormIsValid(), IsEditFormLogicalToDisplay(), IsEditFormLogicalToXSD(), IsEditFormNormalize(), IsEditFormSet(), IsEditFormXSDToLogical()
property IsRunning as %Boolean [ InitialExpression = 0 ];
Is the current print server running
Property methods: IsRunningDisplayToLogical(), IsRunningGet(), IsRunningIsValid(), IsRunningLogicalToDisplay(), IsRunningLogicalToXSD(), IsRunningNormalize(), IsRunningSet(), IsRunningXSDToLogical()
property isNew as %ZEN.Datatype.boolean (ZENURL = "isNew") [ InitialExpression = 0 ];
Property methods: isNewDisplayToLogical(), isNewGet(), isNewIsValid(), isNewLogicalToDisplay(), isNewLogicalToOdbc(), isNewLogicalToXSD(), isNewNormalize(), isNewSet(), isNewXSDToLogical()
property msgConfirmRunning as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("This Zen Report Excel Server is currently running! In order to edit, you must stop it first.") ];
Property methods: msgConfirmRunningDisplayToLogical(), msgConfirmRunningGet(), msgConfirmRunningIsValid(), msgConfirmRunningLogicalToDisplay(), msgConfirmRunningLogicalToOdbc(), msgConfirmRunningNormalize(), msgConfirmRunningSet()

Methods

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
method %OnAfterCreatePage() as %Status
Inherited description: Be sure to do ##super() when overriding.
method %OnGetTitle() as %String
Inherited description: Get the (localized) title string for the page. Subclass can override.
classmethod DeleteExcelServer(PID As %String) as %String [ ZenMethod ]
Delete Zen Report Excel Server definition.
method DrawInfo(pSeed As %String) as %Status
Provide additional information below the settings form, according to the button pressed.
method LoadData(PID As %String) as %String
Load values into fields.
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 SaveData(PID, Name, Server, Port, PingPort, NumThreads, NumPingThreads, LogLevel, LogFile, MaxLogFileSize, LogRotationCount, InitializationTimeout, ConnectionTimeout, JavaHome, JVMArgs) as %ZEN.proxyObject [ ZenMethod ]
Save Zen Report Excel Server definition.
clientmethod browseSelect(name, wildcard) [ Language = javascript ]
User clicked one of the Browse buttons. Save the name of the textfield so that when you return you know which textfield to update.
clientmethod changeLogLevel() [ Language = javascript ]
User changed the log level. Hide log options if no logging was selected.
clientmethod checkIsRunning() [ Language = javascript ]
Check if print server is running.
clientmethod deleteServer() [ Language = javascript ]
Delete print server definition and return to the list of print servers.
clientmethod doSave() [ Language = javascript ]
Get user input and send to server to save settings.
clientmethod formValidationHandler() [ Language = javascript ]
Validation handler for form.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when the a popup page launched from this page fires an action.
clientmethod onloadHandler() [ Language = javascript ]
Inherited description: Disable save button for EMS-managed pages. Be sure to use this.invokeSuper('onloadHandler',arguments); when overriding.
clientmethod showLog() [ Language = javascript ]
clientmethod showStats() [ Language = javascript ]
clientmethod startServer() [ Language = javascript ]
Start the Excel Server.
clientmethod stopServer() [ Language = javascript ]
Stop the Excel Server.
clientmethod verify() [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab