Class Ens.Enterprise.Portal.MsgBankEventLog

class Ens.Enterprise.Portal.MsgBankEventLog extends EnsPortal.EventLog, Ens.Enterprise.Portal.base

This is the Message Bank Event Log page of the ZEN application.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
3	2	12

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	canEdit	canPurge
canViewFileSystem	canViewTrace	cellAlign	cellSize
cellStyle	cellVAlign	children	composite
contactPage	containerStyle	cssLevel	currSortMode
currStep	currViewMode	currentPage	currentPageStart
detailsHidden	detailsWidth	disabled	dragAndDrop
dragEnabled	dropEnabled	enableAutoRefresh	enclosingClass
enclosingStyle	endId	error	groupClass
groupStyle	height	hidden	hideDetailsMsg
hideSearchMsg	hint	hintClass	hintStyle
home	homePage	id	index
isFirstPage	isLastPage	keepAliveInterval	label
labelClass	labelDisabledClass	labelPosition	labelStyle
layout	lblDetails	lblTitle	limitPopups
logCount	matchSource	msgCloseDetail	msgNotPermitted
name	onafterdrag	onbeforedrag	onclick
ondrag	ondrop	onhide	onrefresh
onshow	onupdate	pageId	pageModified
pageNumberId	pageSizeId	parent	queryAtEnd
resultsTableId	searchCriteria	searchJob	searchKey
searchQuery	selectedId	sessionLinkTitle	showDetailsMsg
showLabel	showSearchMsg	slice	startId
tablePaneUsesSQLAttrib	tempPortalNode	title	tracePage
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	%OnGetTableLinkMenu	%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	CheckConditions	CheckContextLinks
CheckEnterpriseManager	ConvertParameter	Decrypt	DoExportInBackground
DoLogout	DoPurge	DownloadStream	DrawDetailsContent
DrawEventDetails	DrawLocalType	DrawLocator	DrawMethodCell
DrawRibbon	DrawSessionCell	DrawTextCell	DrawTitle
Encrypt	EscapeHTML	EscapeURL	EvalResult
FileExists	GetAndUseDefaults	GetCSPURL	GetColumnsAndFrom
GetContextLinks	GetCount	GetDefaultDir	GetDirectory
GetDocURL	GetFilename	GetHomePage	GetHyperEventResources
GetNewURL	GetQuickLinks	GetRemoteSearchJob	GetTempFileName
GetWhereClause	GiveAdviceString	HyperEventCall	HyperEventHead
Include	InsertHiddenField	InsertHiddenFields	IsPrivate
JavaInstalled	Link	MultiTypeClose	MultiTypeExecute
MultiTypeFetch	OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader
OnPage	OnPageError	OnPostHTTP	OnPostHyperEvent
OnPreHTTP	OnPreHyperEvent	Page	PrepareCancel
QuoteJS	RegisterRecent	RemoveTempData	ResetQuery
RewriteURL	SaveDefaults	SetDefaultDir	ShowError
SignalCancel	SimpleKeepAlive	StartTimer	StopTimer
ThrowError	UnescapeHTML	UnescapeURL	XMLDTD
XMLExport	XMLExportToStream	XMLExportToString	XMLNew
XMLSchema	XMLSchemaNamespace	XMLSchemaType	addChild
addChildAfter	addChildBefore	addPopupSuffix	adjustExpanderText
arrowClick	cancelPopup	cancelSearch	changePassword
changeRefresh	changeURLNamespace	checkEdit	childrenMutated
clientKeepAlive	correctIELayering	countReset	createComponent
createComponentNS	createTimeWarning	deleteComponent	disableCommandButton
displayCountDown	doExportStatus	doExportToFile	doSearch
dragFinishHandler	dragHandler	dragNotifyHandler	dragStartHandler
dropHandler	dropStartHandler	enableCommandButton	endModal
enterKey	executeSearch	expandoState	exportToFile
exposeComponent	findElement	fireOnResizeEvent	fireOnUnloadEvent
fireOnUpdateEvent	firePopupAction	formReset	getChildIndex
getComponent	getComponentById	getContentAreaHeight	getEnclosingDiv
getHidden	getHintElement	getLabelElement	getNextData
getOpener	getPageTitle	getProperty	getResultsTable
getSearchForm	getSettings	getTitleAreaHeight	getType
goHome	goMenu	gotoNamespace	gotoPage
hideCommandButton	hideTimeoutWarning	hideWarnContinue	inResizeLoop
indicateIfCancelled	initPopupSuffix	invokeSuper	isOfType
launchPopupWindow	logout	makeId	manualKeepAlive
navigate	onAfterPageChange	onAfterSearch	onChangeResultsPage
onCreate	onDelete	onDisplayHandler	onEndModalHandler
onEnsException	onPopupAction	onRefreshContents	onSearchHandler
onSelectItem	onSerialize	onServerMethodCall	onServerMethodError
onServerMethodReturn	onStartModalHandler	onToggleDetails	onToggleSearch
ondisabledHandler	onhandleAutoLogoutWarn	onkeydownHandler	onkeyupHandler
onlayoutHandler	onloadHandler	onlogoutHandler	onoverlayHandler
onresizeHandler	onunloadHandler	onupdateHandler	popupActionHandler
refreshContents	removeChild	removePopupSuffix	render
renderContents	renderSVG	searchBlur	searchBoxHandler
searchFocus	searchKeyDown	searchKeyPress	selectItem
setComponentId	setConnectivityStatusMsg	setHidden	setModified
setOverlayMode	setPageTitle	setProperty	setPropertyAll
setSortMode	setSortModeHandler	setTraceOption	setViewMode
setViewModeHandler	setWarnInnerHTML	showAbout	showCommandButton
showContact	showDocumentation	showHelp	showQuery
showTimeoutWarning	showTrace	startKeepAlive	startModal
startProgressBar	startPurge	stopKeepAlive	stopProgressBar
switchNamespace	timeout	toggleCancelState	toggleDetails
toggleSearch	toggleSearchState	updateNavigationButtons	updatePageData
updatePageNumber	updatePageSize	warnclickListener

Parameters

• parameter JSINCLUDES = "ensemble/Ensemble_Utils.js";

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

• parameter PAGENAME = "Message Bank Event Log";

Displayed name of this page.

• parameter RESOURCE = "%Ens_MsgBank_EventLog:USE";

User needs USE privilege on the %Ens_MsgBank_EventLog resource to view this page.

Properties

• property canViewTrace as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MsgBank_MessageTrace","USE") ];

• property tracePage as %ZEN.Datatype.string [ InitialExpression = "Ens.Enterprise.Portal.VisualTrace.zen" ];

Methods

• method %OnAfterCreatePage() as %Status

Fill search criteria defaults

• method %OnGetPageName() as %String

Get the (localized) name of the page.

• method %OnGetTitle() as %String

Get the (localized) title string for the page.

• classmethod DoPurge(keep As %Integer) as %String [ ZenMethod ]

Perform the purge operation and if there is an error, return the message to JavaScript by prepending the message with a '-'. If no error then return the zero or positive number of entries deleted, as a string.

• classmethod DrawEventDetails(pSeed As %String) as %Status

Server-side callback to provide data for the details table

• method DrawSessionCell(table As %ZEN.Component.tablePane, name As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status

Server-side method to write out the content for the SessionId column. The main purpose is to ensure that links to the Visual Trace diagram are only included for events which occurred as part of a session.

• method GetColumnsAndFrom(timeFormat As %String) as %String

For tablePanes which require a constructed SQL query when paging, this callback supplies the columns and FROM portions of the query.

• classmethod GetCount() as %Integer [ ZenMethod ]

• 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 startPurge() [ Language = javascript ]

User clicked the Purge button


[USER] > [Ens] > [Enterprise] > [Portal] > [MsgBankEventLog]		Private Storage