Home > Class Reference > ENSLIB namespace > EnsPortal.Dialog.TestingService


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

The first page for testing services

Property Inventory

Method Inventory


parameter APPLYBUTTON = 0;
Inherited description: If true, then this dialog displays an Apply button.
parameter JSINCLUDES = zenCSLM.js;
JavaScript debug library Usage: ZLM.dumpObj(object);
parameter PAGENAME = Testing Service;
Inherited description: Optional. This is the display name used for this page. If not provided, the class name is used.
parameter PRIVATE = 1;
Inherited description: 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.


property HostName as %String (MAXLEN = 128, ZENURL = "HOSTNAME");
Property methods: HostNameDisplayToLogical(), HostNameGet(), HostNameIsValid(), HostNameLogicalToDisplay(), HostNameLogicalToOdbc(), HostNameNormalize(), HostNameSet()
property HostType as %String (ZENURL = "HOSTTYPE");
Property methods: HostTypeDisplayToLogical(), HostTypeGet(), HostTypeIsValid(), HostTypeLogicalToDisplay(), HostTypeLogicalToOdbc(), HostTypeNormalize(), HostTypeSet()
property IsTestError as %Boolean [ InitialExpression = 0 ];
Property methods: IsTestErrorDisplayToLogical(), IsTestErrorGet(), IsTestErrorIsValid(), IsTestErrorLogicalToDisplay(), IsTestErrorLogicalToXSD(), IsTestErrorNormalize(), IsTestErrorSet(), IsTestErrorXSDToLogical()
property Production as %String (MAXLEN = 128, ZENURL = "PRODUCTION");
Property methods: ProductionDisplayToLogical(), ProductionGet(), ProductionIsValid(), ProductionLogicalToDisplay(), ProductionLogicalToOdbc(), ProductionNormalize(), ProductionSet()
property RequestId as %String;
Property methods: RequestIdDisplayToLogical(), RequestIdGet(), RequestIdIsValid(), RequestIdLogicalToDisplay(), RequestIdLogicalToOdbc(), RequestIdNormalize(), RequestIdSet()
property RequestType as %String (MAXLEN = 128);
Property methods: RequestTypeDisplayToLogical(), RequestTypeGet(), RequestTypeIsValid(), RequestTypeLogicalToDisplay(), RequestTypeLogicalToOdbc(), RequestTypeNormalize(), RequestTypeSet()
property SessionId as %String;
Property methods: SessionIdDisplayToLogical(), SessionIdGet(), SessionIdIsValid(), SessionIdLogicalToDisplay(), SessionIdLogicalToOdbc(), SessionIdNormalize(), SessionIdSet()
property eventCounter as %ZEN.Datatype.integer [ InitialExpression = 0 ];
Counter to keep track of how many timer events have fired.
Property methods: eventCounterDisplayToLogical(), eventCounterGet(), eventCounterIsValid(), eventCounterLogicalToDisplay(), eventCounterLogicalToOdbc(), eventCounterNormalize(), eventCounterSet()
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.
Property methods: timerMaxDisplayToLogical(), timerMaxGet(), timerMaxIsValid(), timerMaxLogicalToDisplay(), timerMaxNormalize(), timerMaxSet(), timerMaxXSDToLogical()


method %OnAfterCreatePage() as %Status
Inherited description: 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.
clientmethod changeRequestType() [ Language = javascript ]
User selected a request type.
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod invokeTest() [ Language = javascript ]
Send the testing request to the target and start the waiting timer.
clientmethod 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.
clientmethod ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
clientmethod updateStatusBar() [ Language = javascript ]
Wait for the response and update the progress bar; draw response when done.

Inherited Members

Inherited Properties

Inherited Methods