Class Ens.Enterprise.Portal.EnterpriseSearch

class Ens.Enterprise.Portal.EnterpriseSearch extends EnsPortal.Template.filteredViewer, Ens.Enterprise.Portal.base

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	4	25

Summary

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

Properties
%Clients	%condition	%import	%includeFiles
%page	%resource	HelpAddress	ISREADONLY
LocatorHeader	ParentURL	StdTitle	aboutPage
align	assistantClass	aux	backgroundTimerInterval
canEdit	canResend	cellAlign	cellSize
cellStyle	cellVAlign	children	composite
contactPage	containerStyle	criteriaDialog	cssLevel
currSortMode	currStep	currViewMode	currentPage
currentPageStart	currentSearch	detailsHidden	detailsWidth
disabled	dragAndDrop	dragEnabled	dropEnabled
enableAutoRefresh	enclosingClass	enclosingStyle	error
filterClass	groupClass	groupStyle	headerClass
height	hidden	hideDetailsMsg	hideSearchMsg
hint	hintClass	hintStyle	home
homePage	id	ignoreSearchWarnings	index
isFirstPage	isLastPage	keepAliveInterval	label
labelClass	labelDisabledClass	labelPosition	labelStyle
layout	lblDetails	lblTitle	limitPopups
msgCloseDetail	msgNotPermitted	msgViewTrace	msgViewTraceHover
name	onafterdrag	onbeforedrag	onclick
ondrag	ondrop	onhide	onrefresh
onshow	onupdate	pageId	pageModified
pageNumberId	pageSizeId	parent	queryAtEnd
resendPage	resultsTableId	savedSearchClass	searchCriteria
searchJob	searchKey	searchQuery	searchWarnings
selectedId	sessionLinkTitle	showDetailsMsg	showLabel
showSearchMsg	slice	tablePaneUsesSQLAttrib	tempPortalNode
tipAddCriterion	tipAddCriterionTitle	tipAddOR	tipAddORTitle
tipDelete	tipSave	tipSaveAs	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	%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	CheckContextLinks	CheckEnterpriseManager
Condition	ConvertParameter	CreateResultSet	Decrypt
DoLogout	DoSearchDelete	DoSearchSave	DrawBodyInfo
DrawDetailsContent	DrawFullContentLinks	DrawLocator	DrawRibbon
DrawSessionCell	DrawSystemCell	DrawTimeCreated	DrawTitle
DrawWarnings	Encrypt	EscapeHTML	EscapeURL
EvalResult	Filter	GetAssistantClass	GetCSPURL
GetColumnsAndFrom	GetContextLinks	GetDocURL	GetHomePage
GetHyperEventResources	GetNewURL	GetQueryHistory	GetQuickLinks
GetRemoteSearchJob	GetSavedSearch	HyperEventCall	HyperEventHead
Include	InitSearchCriteria	InsertHiddenField	InsertHiddenFields
IsPrivate	JavaInstalled	Link	LoadFilter
OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader	OnPage
OnPageError	OnPostHTTP	OnPostHyperEvent	OnPreHTTP
OnPreHyperEvent	Page	PrepareCancel	QuoteJS
RegisterRecent	RemoveTempData	ResetQuery	RewriteURL
SaveResendIDs	SetSavedSearch	SetSearchCriteria	ShowError
SignalCancel	SimpleKeepAlive	StartTimer	StopTimer
SubmitFilter	Term	ThrowError	UnescapeHTML
UnescapeURL	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	addChild	addChildAfter	addChildBefore
addCriterion	addOR	addPopupSuffix	adjustExpanderText
arrowClick	cancelPopup	cancelSearch	changePassword
changeURLNamespace	checkEdit	checkForSearchErrors	checkSearchWarnings
childrenMutated	clientKeepAlive	clone	correctIELayering
createArray	createComponent	createComponentNS	createCondition
createTimeWarning	deleteComponent	deleteSearch	disableCommandButton
displayCountDown	doExport	doResend	doSearch
dragFinishHandler	dragHandler	dragNotifyHandler	dragStartHandler
drawDetails	drawExtendedCriteria	dropHandler	dropStartHandler
editCriterion	enableCommandButton	endModal	executeSearch
exposeComponent	findElement	fireOnResizeEvent	fireOnUnloadEvent
fireOnUpdateEvent	firePopupAction	getChildIndex	getComponent
getComponentById	getContentAreaHeight	getEnclosingDiv	getFilter
getFullTimeCreated	getHidden	getHintElement	getLabelElement
getNextData	getOpener	getPageTitle	getProperty
getResendURL	getResultsTable	getSearchForm	getSettings
getTitleAreaHeight	getType	goHome	goMenu
gotoNamespace	gotoPage	hideCommandButton	hideTimeoutWarning
hideWarnContinue	inResizeLoop	indicateIfCancelled	initPopupSuffix
invokeSuper	isOfType	launchPopupWindow	layoutTabGroup
loadSearch	logout	makeId	manualKeepAlive
navigate	onAfterPageChange	onAfterSearch	onChangeResultsPage
onCreate	onDelete	onDisplayHandler	onEndModalHandler
onEnsException	onPopupAction	onRefreshContents	onSearchHandler
onSelectItem	onSerialize	onServerMethodCall	onServerMethodError
onServerMethodReturn	onStartModalHandler	onTabChange	onToggleDetails
onToggleSearch	onTraceSVGLoad	onWarningsUpdate	ondisabledHandler
onhandleAutoLogoutWarn	onkeydownHandler	onkeyupHandler	onlayoutHandler
onloadHandler	onlogoutHandler	onoverlayHandler	onresizeHandler
onunloadHandler	onupdateHandler	popupActionHandler	refreshContents
removeChild	removeCriterion	removePopupSuffix	render
renderContents	renderSVG	saveSearch	scaleSVGTrace
searchBlur	searchBoxHandler	searchFocus	searchIfValidPageSize
searchKeyDown	searchKeyPress	selectItem	setComponentId
setConnectivityStatusMsg	setHidden	setModified	setOverlayMode
setPageTitle	setProperty	setPropertyAll	setSortMode
setSortModeHandler	setTraceOption	setViewMode	setViewModeHandler
setWarnInnerHTML	shiftTerm	showAbout	showCommandButton
showContact	showDocumentation	showFullContent	showHelp
showOtherSystemHome	showQuery	showTimeoutWarning	showTrace
startKeepAlive	startModal	startProgressBar	stopKeepAlive
stopProgressBar	submitFilterUpdate	switchNamespace	toggleCancelState
toggleCriterion	toggleDetails	toggleSaveAs	toggleSearch
toggleSearchState	updateFilterFromForm	updateFormFromFilter	updateNavigationButtons
updatePageData	updatePageNumber	updatePageSize	updateSearchState
warnclickListener

Parameters

• parameter CANCANCELSEARCH = 1;

Indicate if can cancel search. This defines whether tempPortalNode is set.

• parameter PAGENAME = "Enterprise Message Viewer";

Name of this page.

• parameter RESOURCE = "%Ens_MsgBank_MessageHeader:USE";

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

• parameter SETUPTEMPPORTALNODE = 1;

Indicate if ought to create tempPortalNode when page created. Used by Cancel feature for example.

• parameter SessionSubscripts = "Enterprise,SavedSearch";

Comma separated list of subscripts to use in the %session object for saved searches.

Properties

• property %Clients as array of Ens.Enterprise.MonitorClient;

• property assistantClass as %String [ InitialExpression = ..GetAssistantClass(),ReadOnly ];

Name of the Assistant class to use.

• property filterClass as %String [ InitialExpression = "Ens.Enterprise.Portal.MsgFilter.EnterpriseFilter",ReadOnly ];

Name of Filter class to use for filtering searches.

• property savedSearchClass as %String [ InitialExpression = "Ens.Enterprise.Portal.MsgFilter.SavedEnterpriseSearch",ReadOnly ];

Name of SavedSearch class to use for saving searches.

Methods

• method %OnAfterCreatePage() as %Status

Show/hide the toggle buttons

• method %OnGetPageName() as %String

Get the (localized) name of the page.

• method %OnGetTitle() as %String

Get the (localized) title string for the page.

• method CreateResultSet(Output pSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet

Create and execute the result set used to drive the results table. Note that ignoreSearchWarnings controls whether the warnings in searchWarnings should be displayed to the user or ignored.

• 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 cells. The main purpose is to include a link to the trace on the client system when the session ID is known.

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

Draw the name of the client system, and include a link to the Message Viewer page on the current client.

• method DrawTimeCreated(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status

Draw the TimeCreated HTML using an embedded tag to ensure that the full timestamp is always available to the client code for paging purposes.

• method DrawWarnings(pTempNode As %String) as %Status

Method to draw the contents of warningsDiv in the output for a supplied temp node. If the temp node doesn't exist, or there are no errors, nothing is drawn.

• classmethod GetAssistantClass() as %String

• method LoadFilter(ByRef pParms, Output pObject As Ens.Enterprise.Portal.MsgFilter.EnterpriseFilter) as %Status

Load Filter object from the session, or from a saved search if requested.

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

Method that gets the current TempNode from the filter and triggers a refresh of the Warnings panel.

• method doResend() [ Language = javascript ]

Don't allow resend.

• method drawDetails(messageId) [ Language = javascript ]

Update the details for a selected message.

• method getFullTimeCreated(rowIndex) [ Language = javascript ]

Helper method to extract the full value for TimeCreated from the timecreated element in the HTML row data. rowIndex is the index of the row according to the main table's selectedIndex property.

• method onAfterSearch() [ Language = javascript ]

Make sure we check for errors that occurred during the search.

• method onChangeResultsPage(next, pageSize, currentPage) [ Language = javascript ]

Callback to set up the resultset/query for paging

• method onWarningsUpdate() [ Language = javascript ]

• method onlayoutHandler(load) [ Language = javascript ]

Adjust for the possibility of the warning div being populated.

• method onloadHandler() [ Language = javascript ]

Check for errors that occurred while the table was first being populated.

• method showOtherSystemHome(link, evt) [ Language = javascript ]

• method showTrace(session, evt) [ Language = javascript ]

• method updateFilterFromForm(updateSearchCriteria) [ Language = javascript ]

Update the current Filter based on the form's contents. Extended criteria are saved separately.

• method updateFormFromFilter() [ Language = javascript ]

Update the form on the page based on an updated Filter object.

• method updatePageData() [ Language = javascript ]

Helper method to record the first and last ID values for the current page.


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