Class EnsPortal.FindMsgBank

class EnsPortal.FindMsgBank extends EnsPortal.Template.standardPage

Page for configuring the link to the Message Bank for the current namespace. The data required to build the link are stored in ^Ens.MsgBank("Link"). If no data is present in that node, the code will attempt to retrieve the data from the nodes used by the Message Bank client code, and copy those values into the "Link" data location.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
3	1	16

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	HelpAddress	ISREADONLY	LocatorHeader
ParentURL	StdTitle	aboutPage	align
aux	backgroundTimerInterval	bankLocation	canEdit
cellAlign	cellSize	cellStyle	cellVAlign
children	composite	contactPage	containerStyle
cssLevel	currSortMode	currStep	currViewMode
disabled	dragAndDrop	dragEnabled	dropEnabled
enableAutoRefresh	enclosingClass	enclosingStyle	error
groupClass	groupStyle	height	hidden
hint	hintClass	hintStyle	home
homePage	id	index	keepAliveInterval
label	labelClass	labelDisabledClass	labelPosition
labelStyle	layout	lblTitle	limitPopups
msgNotPermitted	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
%AddCSPShareHyperevents	%AddChild	%AddChildAfter	%AddChildBefore
%AddComponent	%AddEnsExceptionHandler	%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	%EvalC	%Extends	%ForceClientRender
%GetChildIndex	%GetComponent	%GetComponentById	%GetComponentByName
%GetEventHandlers	%GetHomePage	%GetHomeParam	%GetLinks
%GetLocatorLinks	%GetPageName	%GetParameter	%GetProductName
%GetRootLink	%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	CheckContextLinks	CheckEnterpriseManager	ConvertParameter
Decrypt	DoLogout	DrawLocator	DrawRibbon
DrawTitle	Encrypt	EscapeHTML	EscapeURL
EvalResult	GetBankLink	GetCSPURL	GetContextLinks
GetDocURL	GetHomePage	GetHyperEventResources	GetNewURL
GetQuickLinks	HyperEventCall	HyperEventHead	Include
InsertHiddenField	InsertHiddenFields	IsPrivate	JavaInstalled
Link	MakeLink	OnDrawRibbon	OnGetRibbonInfo
OnHTTPHeader	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent	Page
QuoteJS	RegisterRecent	RewriteURL	SaveLinkData
SetBankAddress	ShowError	SimpleKeepAlive	StartTimer
StopTimer	ThrowError	UnescapeHTML	UnescapeURL
XMLDTD	XMLExport	XMLExportToStream	XMLExportToString
XMLNew	XMLSchema	XMLSchemaNamespace	XMLSchemaType
addChild	addChildAfter	addChildBefore	addPopupSuffix
arrowClick	cancelPopup	changePassword	changeURLNamespace
checkEdit	childrenMutated	clientKeepAlive	correctIELayering
createComponent	createComponentNS	createTimeWarning	deleteComponent
disableCommandButton	displayCountDown	dragFinishHandler	dragHandler
dragNotifyHandler	dragStartHandler	dropHandler	dropStartHandler
enableCommandButton	endModal	exposeComponent	findElement
fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction
getChildIndex	getComponent	getComponentById	getEnclosingDiv
getHidden	getHintElement	getLabelElement	getOpener
getPageTitle	getProperty	getSettings	getTitleAreaHeight
getType	goHome	goMenu	goToBank
gotoNamespace	gotoPage	hideCommandButton	hideTimeoutWarning
hideWarnContinue	inResizeLoop	initPopupSuffix	invokeSuper
isOfType	launchPopupWindow	logout	makeId
manualKeepAlive	navigate	onCreate	onDelete
onDisplayHandler	onEndModalHandler	onPopupAction	onRefreshContents
onSerialize	onServerMethodCall	onServerMethodError	onServerMethodReturn
onStartModalHandler	ondisabledHandler	onhandleAutoLogoutWarn	onkeydownHandler
onkeyupHandler	onlayoutHandler	onloadHandler	onlogoutHandler
onoverlayHandler	onresizeHandler	onunloadHandler	onupdateHandler
popupActionHandler	refreshContents	removeChild	removePopupSuffix
render	renderContents	renderSVG	saveValues
searchBlur	searchBoxHandler	searchFocus	searchKeyDown
searchKeyPress	setComponentId	setConnectivityStatusMsg	setHidden
setModified	setOverlayMode	setPageTitle	setProperty
setPropertyAll	setSortMode	setSortModeHandler	setTraceOption
setViewMode	setViewModeHandler	setWarnInnerHTML	showAbout
showCommandButton	showContact	showDocumentation	showHelp
showTimeoutWarning	startKeepAlive	startModal	startProgressBar
stopKeepAlive	stopProgressBar	switchNamespace	updateGoButton
validate	validatePort	warnclickListener

Parameters

• parameter EDITRESOURCE = "%Ens_MsgBankConfig:WRITE";

User needs WRITE permissions on the %Ens_MsgBankConfig resource to make changes on this page.

• parameter PAGENAME = "Configure Message Bank Link";

Displayed name of this page.

• parameter RESOURCE = "%Ens_MsgBankConfig:READ";

User needs READ permissions on the %Ens_MsgBankConfig resource to view this page.

Properties

• property bankLocation as %ZEN.Datatype.uri [ InitialExpression = ..GetBankLink() ];

Full URL of the Message Bank Status Monitor. If this is the empty string, the bank is not correctly configured.

Methods

• method %OnAfterCreatePage() as %Status

Populate the controls as needed.

• method %OnGetPageName() as %String

Get the (localized) name of the page.

• method %OnGetTitle() as %String

Get the (localized) title string for the page.

• classmethod GetBankLink() as %String

Return the current link

• classmethod GetHyperEventResources(pMethod As %String = "") as %String

Callback to return a list of resources required for a specific HyperEvent. The user must have sufficient privileges on one of the resource/permission pairs to be permitted to execute the hyperevent. An empty string implies the user already has sufficient privileges for the ZenMethod specified in pMethod.

• classmethod MakeLink(pWebServer As %String, pPort As %String = 80, pInstancePrefix As %String = "", pBankNS As %String, pUseSSL As %Boolean = 0) as %String

Build the constituent parts of the link into a single URL.

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

• method SaveLinkData(pData As %ZEN.proxyObject) as %String [ ZenMethod ]

Save the values and update the value of bankLocation.

• classmethod SetBankAddress(pWebServer As %String, pWebPort As %String, pInstancePrefix As %String, pBankNS As %String, pUseSSL As %Boolean) as %Status

Physically set the values into the ^Ens.MsgBank("Link") node. This method is the API for changing this.

• method goToBank() [ Language = javascript ]

Redirect the client to the Message Bank.

• method onloadHandler() [ Language = javascript ]

This client event, if present, is fired when the page is loaded.

• method saveValues() [ Language = javascript ]

Actually save the values to the server.

• method updateGoButton() [ Language = javascript ]

• method validate() [ Language = javascript ]

Validate the contents of the form.

• method validatePort() [ Language = javascript ]

Ensure that the port is a positive integer.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search