Class EnsPortal.Dialog.TestingService

class EnsPortal.Dialog.TestingService extends EnsPortal.Dialog.standardDialog

The first page for testing services

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	9	21

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	FirstFailed	HostName	HostType
InvalidParam	IsEMSReadOnly	IsTestError	Production
RequestId	RequestType	SessionId	ValidationErrorMsg
align	aux	backgroundTimerInterval	canEdit
cellAlign	cellSize	cellStyle	cellVAlign
children	closeOnEnter	closeOnEsc	composite
containerStyle	cssLevel	dialogTitle	disabled
disabledStyle	dragAndDrop	dragEnabled	dropEnabled
enclosingClass	enclosingStyle	error	eventCounter
groupClass	groupStyle	hasButtons	height
hidden	hideApplyButton	hideCancelButton	hideOKButton
hint	hintClass	hintStyle	id
index	keepAliveInterval	label	labelClass
labelDisabledClass	labelPosition	labelStyle	layout
msgNotPermitted	name	onafterdrag	onbeforedrag
onclick	ondrag	ondrop	onhide
onrefresh	onshow	onupdate	parent
showLabel	slice	studioMode	timerMax
title	tuple	useSVG	useSoftModals
valign	visible	width	window
zenPersistentPopup

Methods
%AddCSPShareHyperevents	%AddChild	%AddChildAfter	%AddChildBefore
%AddComponent	%AddEnsExceptionHandler	%AddImportedComponents	%AddToSaveSet
%ApplyURLParms	%Attr	%BindExport	%ClassIsLatestVersion
%ClassName	%ConstructClone	%DispatchClassMethod	%DispatchGetModified
%DispatchGetProperty	%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty
%DispatchSetProperty	%DrawAutoLogout	%DrawClassDefinitions	%DrawComponentHTML
%DrawHTML	%DrawHTMLPage	%DrawJSStrings	%DrawObjectDefinitions
%DrawTitle	%EnclosingDivId	%EndBackgroundMethod	%EndScript
%Eval	%EvalC	%Extends	%ForceClientRender
%GetChildIndex	%GetComponent	%GetComponentById	%GetComponentByName
%GetEventHandlers	%GetLinks	%GetPageName	%GetParameter
%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	%OnGetSubtitle	%OnGetTitle
%OnMonitorBackgroundTask	%OnMutateChildren	%OnObjectSynch	%OnPreHTTP
%OnSubmit	%OnUseSoftModals	%OnZENDeserialize	%OriginalNamespace
%PackageName	%QuoteValue	%QuoteValueL10N	%RemoveChild
%RemoveChildren	%RemoveComponent	%RemoveFromSaveSet	%RunBackgroundMethod
%Self	%SerializeObject	%SetBackgroundMethodStatus	%SetErrorById
%SetErrorByName	%SetModified	%SetValueById	%SetValueByName
%SetValuesByName	%StartScript	%ValidateObject	%ZENVersion
CheckStatus	ConvertParameter	Decrypt	DoSaveRequestMessage
DrawRequestForm	DrawResponseFields	DrawResponseInfo	DrawStatusBar
Encrypt	EscapeHTML	EscapeURL	EvalResult
GetHyperEventResources	GetTime	GetValidRequestTypeList	HyperEventCall
HyperEventHead	Include	InsertHiddenField	InsertHiddenFields
IsPrivate	JavaInstalled	Link	OnHTTPHeader
OnPage	OnPageError	OnPostHTTP	OnPostHyperEvent
OnPreHTTP	OnPreHyperEvent	Page	PopulateListOfRequestTypes
QuoteJS	RewriteURL	SaveRequestMessage	SendTestRequestToTarget
ShowError	SimpleKeepAlive	StartTimer	StopTimer
ThrowError	UnescapeHTML	UnescapeURL	XMLDTD
XMLExport	XMLExportToStream	XMLExportToString	XMLNew
XMLSchema	XMLSchemaNamespace	XMLSchemaType	addChild
addChildAfter	addChildBefore	addPopupSuffix	adjustSize
btnApply	btnOK	cancelPopup	changeRequestType
checkEdit	childrenMutated	clientKeepAlive	correctIELayering
createComponent	createComponentNS	ctrlKeyDown	deleteComponent
dialogApply	dialogCancel	dialogFinish	dialogTitleGet
disableButtons	dragFinishHandler	dragHandler	dragNotifyHandler
dragStartHandler	dropHandler	dropStartHandler	endModal
exposeComponent	findElement	fireOnResizeEvent	fireOnUnloadEvent
fireOnUpdateEvent	firePopupAction	getChildIndex	getComponent
getComponentById	getDialogValue	getEnclosingDiv	getHidden
getHintElement	getLabelElement	getOpener	getProperty
getSettings	getType	gotoPage	inResizeLoop
initPopupSuffix	invokeSuper	invokeTest	isOfType
launchPopupWindow	makeId	onCreate	onDelete
onDisplayHandler	onEndModalHandler	onPopupAction	onRefreshContents
onSerialize	onServerMethodCall	onServerMethodError	onServerMethodReturn
onStartModalHandler	ondialogCancel	ondialogFinish	ondialogStart
ondisabledHandler	onhandleAutoLogoutWarn	onkeydownHandler	onkeyupHandler
onlayoutHandler	onloadHandler	onlogoutHandler	onoverlayHandler
onresizeHandler	onunloadHandler	onupdateHandler	popupActionHandler
refreshContents	removeChild	removePopupSuffix	render
renderContents	renderSVG	resetMsg	setComponentId
setHidden	setOverlayMode	setProperty	setPropertyAll
setTraceOption	showMsg	startKeepAlive	startModal
startProgressBar	stopKeepAlive	stopProgressBar	updateStatusBar
validateRequired

Parameters

• parameter APPLYBUTTON = 0;

If true, then this dialog displays an Apply button.

• parameter JSINCLUDES = "zenCSLM.js";

JavaScript debug library Usage: ZLM.dumpObj(object);

• parameter PAGENAME = "Testing Service";

Optional. This is the display name used for this page. If not provided, the class name is used.

• parameter PRIVATE = 1;

Controls the access to the page, it can be set to one of the following:

PRIVATE=0 - Page can be linked to/bookmarked

PRIVATE=1 - Can only be referenced from another CSP page

The user needs initially to enter the site through a PUBLIC page.

• parameter RESOURCE = "%Ens_TestingService:USE";

User needs USE permissions on the %Ens_TestingService resource to view this page.

Properties

• property HostName as %String(MAXLEN=128,ZENURL="HOSTNAME");

• property HostType as %String(ZENURL="HOSTTYPE");

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

• property Production as %String(MAXLEN=128,ZENURL="PRODUCTION");

• property RequestId as %String;

• property RequestType as %String(MAXLEN=128);

• property SessionId as %String;

• property eventCounter as %ZEN.Datatype.integer [ InitialExpression = 0 ];

Counter to keep track of how many timer events have fired.

• property timerMax as %Integer [ InitialExpression = 60 ];

Maximum number of timer intervals to wait for a response. Each timer interval is half second. The default is 30 seconds.

Methods

• method %OnAfterCreatePage() as %Status

Avoid writing out the session cookie if we are in a Studio session.

• method %OnGetPageName() as %String

Get the (localized) name of the page.

• method %OnGetSubtitle() as %String

Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.

• method %OnGetTitle() as %String

Get the (localized) title string for the page.

• classmethod CheckStatus(pCounter As %Integer, pMax As %Integer, pSession As %String) as %Integer [ ZenMethod ]

Check if a response was received or the maximum wait time has been reached.

• method DoSaveRequestMessage(ByRef pProps As %ListOfDataTypes, ByRef pVals As %ListOfDataTypes) as %ZEN.proxyObject [ ZenMethod ]

• method DrawRequestForm(pSeed As %String) as %Status

Draw input data form for selected request type.

• method DrawResponseFields(pSeed As %String) as %Status

Draw response form data.

• method DrawResponseInfo() [ ZenMethod ]

Draw results info.

• method DrawStatusBar(pSeed As %String) as %Status

Draw the progress bar.

• classmethod GetTime() as %String [ ZenMethod ]

• classmethod GetValidRequestTypeList(pProduction As %String, pTarget As %String, ByRef pReqClasses)

• method PopulateListOfRequestTypes()

Populate control with the list of request types for this target config item.

• classmethod SaveRequestMessage(pRequestType As %String, pReqClass As %String, ByRef Props As %ListOfDataTypes, ByRef Vals As %ListOfDataTypes) as %ZEN.proxyObject

Create and save a new request object with the property values obtained from the request form data. Return null if successful or otherwise an error message.

• method SendTestRequestToTarget() as %Boolean [ ZenMethod ]

Fire the actual testing request and populate results data.

• method changeRequestType() [ Language = javascript ]

User selected a request type.

• method getDialogValue() [ Language = javascript ]

Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.

• method invokeTest() [ Language = javascript ]

Send the testing request to the target and start the waiting timer.

• method ondialogFinish(action) as %Boolean [ Language = javascript ]

This callback is called when the user presses the OK button. If this returns false, then the dialog stays open.

• method ondialogStart() [ Language = javascript ]

This callback, if defined, is called when the dialog page is loaded.

• method updateStatusBar() [ Language = javascript ]

Wait for the response and update the progress bar; draw response when done.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search