Class %CSP.UI.Portal.ZenReportServer

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

Management Portal - Edit a Zen Report Render Server

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
7	5	24

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	HelpAddress	ISREADONLY	IsRunning
LocatorHeader	PID	ParentURL	StdTitle
XEPHOMEValue	aboutPage	align	aux
backgroundTimerInterval	cellAlign	cellSize	cellStyle
cellVAlign	children	composite	containerStyle
cssLevel	currSortMode	currStep	currViewMode
disabled	dragAndDrop	dragEnabled	dropEnabled
enclosingClass	enclosingStyle	error	groupClass
groupStyle	height	hidden	hint
hintClass	hintStyle	home	homePage
id	index	isNew	label
labelClass	labelDisabledClass	labelPosition	labelStyle
layout	lblTitle	msgConfirmRunning	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
%%OIDGet	%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
%Extends	%ForceClientRender	%GetChildIndex	%GetComponent
%GetComponentById	%GetComponentByName	%GetEventHandlers	%GetHomePage
%GetHomeParam	%GetLinks	%GetLocatorLinks	%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	CheckAllBlanks	ConvertParameter	Decrypt
DefaultConfigFile	DeleteRenderServer	DoLogout	DrawInfo
DrawLocator	DrawRibbon	DrawTitle	Encrypt
EscapeHTML	EscapeURL	GetCSPURL	GetContextLinks
GetDocPage	GetHomePage	GetNewURL	GetQuickLinks
HyperEventBody	HyperEventCall	HyperEventFrame	HyperEventHead
Include	InsertHiddenField	InsertHiddenFields	IsPrivate
Link	LoadData	OnDrawRibbon	OnGetRibbonInfo
OnHTTPHeader	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent	Page
QuoteJS	RegisterRecent	RewriteURL	SaveData
ShowError	StartTimer	StopTimer	ThrowError
UnescapeHTML	UnescapeURL	XMLDTD	XMLExport
XMLExportToStream	XMLExportToString	XMLNew	XMLSchema
XMLSchemaNamespace	XMLSchemaType	ZStripW	addChild
addChildAfter	addChildBefore	browseSelect	cancel
cancelPopup	changeLogLevel	changePassword	changeRenderer
checkIsRunning	childrenMutated	correctIELayering	createComponent
createComponentNS	deleteComponent	deleteServer	dragFinishHandler
dragHandler	dragNotifyHandler	dragStartHandler	dropHandler
dropStartHandler	endModal	exposeComponent	findElement
fireOnLoadEvent	fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent
firePopupAction	formValidationHandler	getChildIndex	getComponent
getComponentById	getEnclosingDiv	getHidden	getHintElement
getLabelElement	getOpener	getProperty	getSettings
getTitleAreaHeight	getType	goHome	goMenu
gotoNamespace	gotoPage	invokeSuper	isOfType
launchPopupWindow	logout	makeId	navigate
onCreate	onDelete	onDisplayHandler	onEndModalHandler
onPopupAction	onRefreshContents	onSerialize	onServerMethodCall
onServerMethodError	onServerMethodReturn	onStartModalHandler	ondisabledHandler
onkeydownHandler	onkeyupHandler	onlayoutHandler	onloadHandler
onlogoutHandler	onoverlayHandler	onresizeHandler	onunloadHandler
onupdateHandler	popupActionHandler	refreshContents	removeChild
render	renderContents	renderSVG	resetMsg
saveSettings	searchBlur	searchBoxHandler	searchFocus
searchKeyDown	searchKeyPress	setComponentId	setHidden
setModified	setOverlayMode	setProperty	setPropertyAll
setSortMode	setSortModeHandler	setTraceOption	setViewMode
setViewModeHandler	showAbout	showDocumentation	showHelp
showLog	showMsg	showStats	startModal
startProgressBar	startServer	stopProgressBar	stopServer
switchNamespace	validateRequired	verify

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.ZenReportServer.cls";

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 JSINCLUDES = "zenCSLM.js";

Comma-separated list of additional JS include files for the page.

• parameter PAGENAME = "Zen Report Render Server";

Displayed name of this page.

• parameter PARENTPAGE = "%CSP.UI.Portal.ZenReportServers.cls";

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 RESOURCE = "%Admin_Manage";

Security requirement

Properties

• property IsRunning as %Boolean [ InitialExpression = 0 ];

Is the current render server running

• property PID as %String(ZENURL="PID");

ID for edit.

• property XEPHOMEValue as %ZEN.Datatype.string [ InitialExpression = ..GetXEPHOMEValue() ];

• property isNew as %ZEN.Datatype.boolean(ZENURL="isNew") [ InitialExpression = 0 ];

• property msgConfirmRunning as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("This Zen Report Render Server is currently running! In order to edit, you must stop it first.") ];

Methods

• method %GetLocatorLinks(Output pLink) as %Status

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)

• method %OnAfterCreatePage() as %Status

Decorate the page.

• classmethod CheckAllBlanks(string) as %Boolean [ ZenMethod ]

• classmethod DefaultConfigFile(pEngine As %String = "FOP") as %String [ ZenMethod ]

• classmethod DeleteRenderServer(PID As %String) as %String [ ZenMethod ]

Delete Zen Report Render 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.

• classmethod SaveData(PID, Name, Server, Port, PingPort, NumThreads, NumPingThreads, Renderer, ConfigFile, LogLevel, LogFile, MaxLogFileSize, LogRotationCount, HowOftenToClean, NumFilesToClean, InitializationTimeout, ConnectionTimeout, InitQueueSize, MemoryThreshold, ThresholdPollingPeriod, JavaHome, JVMArgs) as %ZEN.proxyObject [ ZenMethod ]

Save Zen Report Render Server definition.

• method 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.

• method cancel() [ Language = javascript ]

User clicked Cancel. Return to list page.

• method changeLogLevel() [ Language = javascript ]

User changed the log level. Hide log options if no logging was selected.

• method changeRenderer() [ Language = javascript ]

User changed the selected Renderer.

• method checkIsRunning() [ Language = javascript ]

Check if render server is running.

• method deleteServer() [ Language = javascript ]

Delete render server definition and return to the list of render servers.

• method formValidationHandler() [ Language = javascript ]

Validation handler for form.

• method 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.

• method saveSettings() [ Language = javascript ]

Get user input and send to server to save settings.

• method showLog() [ Language = javascript ]

• method showStats() [ Language = javascript ]

• method startServer() [ Language = javascript ]

Start the Render Server.

• method stopServer() [ Language = javascript ]

Stop the Render Server.

• method validateRequired(ctl, pass, type) as %Boolean [ Language = javascript ]

Validate the control value. pass is either "true" or "false" indicating if there is already a field that failed validation.

• method verify() [ Language = javascript ]


[BASEXML] > [%CSP] > [UI] > [Portal] > [ZenReportServer]		Private Storage