Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [EnsPortal] >  [Template] >  [base]
Private  Storage   

abstract class EnsPortal.Template.base

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 1 13


Summary

Properties
keepAliveInterval

Methods
%AddCSPShareHyperevents %AddEnsExceptionHandler SimpleKeepAlive addPopupSuffix
clientKeepAlive inResizeLoop initPopupSuffix onServerMethodError
removePopupSuffix startKeepAlive stopKeepAlive

Subclasses
EnsPortal.Dialog.standardDialog EnsPortal.Template.standardPage

Parameters

• parameter DOMAIN = "Ensemble";
• parameter USEKEEPALIVE = 0;
Control whether we use a KeepAlive in subclasses of this page. [DEPRECATED] - the InterSystems IRIS UI now uses a lookup against ^EnsPortal("DisableInactivityTimeout","Portal") for the main Ensemble management portal, and ^EnsPortal("DisableInactivityTimeout","Studio") for the editors that run embedded in Studio.

Properties

• property keepAliveInterval as %ZEN.Datatype.integer [ InitialExpression = ..GetKeepAliveInterval() * 1000 ];
The interval in milliseconds at which keepalive events should be triggered. The value is determed in the GetKeepAliveInterval() method.

Methods

• classmethod %AddCSPShareHyperevents() as %Status
Add a modified version of cspIntHttpServerMethod to the page to force hyperevents to specify CSPSHARE in requests to the server.
• classmethod %AddEnsExceptionHandler(pIsModal As %Boolean = 0) as %Status
Add centralised error handling for standard pages and dialogue windows.
• classmethod SimpleKeepAlive(pString As %String = "") as %String [ ZenMethod ]
Simple method for the client to call.
• method addPopupSuffix(popupName) [ Language = javascript ]
Add a suffix to the popup name to avoid name collisions.
• method clientKeepAlive() [ Language = javascript ]
Simple call back to the server.
• method inResizeLoop() [ Language = javascript ]
Helper method to allow pages to detect when they are in a resize loop under IE8.
• method initPopupSuffix() [ Language = javascript ]
• method onServerMethodError(err, errObject) [ Language = javascript ]
Override onServerMethodError to funnel HyperEvent errors through the central exception handling code. If session pollution occurs while in Studio mode, alert the user to the problem instead of reloading. The method sets zenPage._staleStudioSession to true to ensure that an alert is displayed only once and subsequent hyperevent failures will not trigger a reload of the page.
• method removePopupSuffix(popupName) [ Language = javascript ]
Strip the suffix from a popup name created by addPopupSuffix().
• method startKeepAlive() [ Language = javascript ]
Start the client keepalive.
• method stopKeepAlive() [ Language = javascript ]
Stop the client keepalive.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.