Home > Class Reference > ENSLIB namespace > EnsPortal.RuleLog
Private  Storage   

EnsPortal.RuleLog


class EnsPortal.RuleLog extends EnsPortal.Template.viewerPage

This is the RuleLog page of the ZEN Ensemble application.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
6 7 33


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 canViewRules
canViewTrace cellAlign cellSize cellStyle
cellVAlign children composite containerStyle
cssLevel currSortMode currStep currViewMode
currentPage currentPageStart detailsHidden detailsWidth
disabled dragAndDrop dragEnabled dropEnabled
enclosingClass enclosingStyle 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
msgCloseDetail msgDays msgNotPermitted name
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onrefresh onshow
onupdate pageId pageModified pageNumberId
pageSizeId parent queryAtEnd resultsTableId
searchCriteria searchJob searchKey searchQuery
selectedId showDetailsMsg showLabel showSearchMsg
slice tablePaneUsesSQLAttrib tempPortalNode 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
%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 BreakUpText
BuildMenu CheckAllBlanks CheckContextLinks CheckEnterpriseManager
ConvertParameter CreateDataSet CreateResultSet Decrypt
DoLogout DoPurge DrawDetailsContent DrawLocator
DrawRibbon DrawTimeExecuted DrawTitle DrawYesNo
Encrypt EscapeHTML EscapeURL EvalResult
GetAndUseDefaults GetCSPURL GetClassName GetColumnsAndFrom
GetContextLinks GetCount GetDocPage GetDropDownMenus
GetHomePage GetHyperEventResources GetNewURL GetQuickLinks
GetRemoteSearchJob GiveAdviceString HyperEventCall HyperEventHead
Include InsertHiddenField InsertHiddenFields IsPrivate
Link OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page PrepareCancel
QuoteJS RegisterRecent RemoveTempData ResetQuery
RewriteURL SaveDefaults 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
deleteComponent disableCommandButton doSearch dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler dropHandler
dropStartHandler enableCommandButton endModal enterKey
executeSearch expandoState exposeComponent findElement
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
formReset getChildIndex getComponent getComponentById
getContentAreaHeight getEnclosingDiv getHidden getHintElement
getLabelElement getNextData getOpener getProperty
getResultsTable getSearchForm getSettings getTitleAreaHeight
getType goHome goMenu gotoNamespace
gotoPage hideCommandButton inResizeLoop indicateIfCancelled
initPopupSuffix invokeSuper isOfType launchPopupWindow
logout makeId navigate onAfterPageChange
onAfterSearch onChangeResultsPage onCreate onDelete
onDisplayHandler onEndModalHandler onEnsException onPopupAction
onRefreshContents onSearchHandler onSelectItem onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
onToggleDetails onToggleSearch ondisabledHandler 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 setProperty setPropertyAll
setSortMode setSortModeHandler setTraceOption setViewMode
setViewModeHandler showAbout showCommandButton showDocumentation
showHelp showQuery showRule showTrace
startKeepAlive startModal startProgressBar startPurge
stopKeepAlive stopProgressBar switchNamespace timeout
toggleCancelState toggleDetails toggleSearch toggleSearchState
updateNavigationButtons updatePageData updatePageNumber updatePageSize


Parameters


• parameter CANCANCELSEARCH = 1;
Indicate if can cancel search. This defines whether tempPortalNode is set.
• parameter EDITRESOURCE = "%Ens_Purge:USE";
User needs USE permissions on the %Ens_Purge resource to start a purge from this page.
• parameter JSINCLUDES = "ensemble/Ensemble_Utils.js";
Comma-separated list of additional JS include files for the page.
• parameter PAGENAME = "Rule Log";
Displayed name of this page.
• parameter RESOURCE = "%Ens_RuleLog:USE";
User needs USE permissions on the %Ens_RuleLog resource to view this page.
• parameter SETUPTEMPPORTALNODE = 1;
Indicate if ought to create tempPortalNode when page created. Used by Cancel feature for example.

Properties


• property canViewRules as %ZEN.Datatype.boolean [ InitialExpression = ##class(EnsPortal.Utils).CheckResourceList("%Ens_Code:READ,%Ens_Rules:READ,%Ens_RoutingRules:READ,%Ens_BusinessRules:READ") ];
• property canViewTrace as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageTrace","USE") ];
• property detailsWidth as %ZEN.Datatype.integer(MAXVAL=80,MINVAL=5) [ InitialExpression = 29 ];
Value to indicate the percentage of the horizontal screen which should be devoted to the details panel (if it is visible). This is exposed as a client-side property for the layout code to use the value.
• property msgDays as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Days") ];
• property pageNumberId as %ZEN.Datatype.id [ InitialExpression = "pageTotal" ];
Id of the page number field
• property pageSizeId as %ZEN.Datatype.id [ InitialExpression = "MaxRows" ];
Id of the page size field
• property resultsTableId as %ZEN.Datatype.id [ InitialExpression = "table" ];
Id of the results tablePane

Methods


• method %OnAfterCreatePage() as %Status
This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
• method %OnDrawHTMLHead() as %Status
This callback is called at the end of the HTML HEAD section of the page.
(default implementation is a simple expression).
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• classmethod BreakUpText(pText As %String) as %String [ ZenMethod ]
Strategically insert spaces or carriage return line feed as needed to keep the return text inside the boundaries of the display.
• method CreateDataSet(pSeed As %String) as %Status
Server-side callback to provide data for the details table
• method CreateResultSet(Output pSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
Callback used to construct the query for the current page based on the values in searchCriteria. The custom resultset creation is required to ensure that optimised queries are used to retrieve results.
• 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.
• method DrawTimeExecuted(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
Write out the formatted TimeExecuted value along with the unformatted value inside a custom "timeexecuted" tag.
• method DrawYesNo(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
Draw Yes or No in place of 1 or 0
• method GetAndUseDefaults() as %String
Method called from %OnAfterCreatePage to get defaults and build up the initial display
• classmethod GetClassName(id As %String) as %String [ ZenMethod ]
Get the class name (in case what's been selected is an alias, which is invalid as a class name). If the id is already a class name, that class name will be returned as the return value.
• classmethod GetCount() as %Integer [ ZenMethod ]
• method GetDropDownMenus() as %String
Method called from %OnAfterCreatePage to build up drop-down menus for the search criteria panel
• 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.
• method GiveAdviceString(pSeed As %String) as %Status
Server-side callback to provide localized string introducing the details table
• 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.
• classmethod SaveDefaults(SortOrder, TimeFormat, Defaults, MaxRows, States, AutoRefresh) [ ZenMethod ]
Save user's last search criteria into global for page default
• method changeRefresh() [ Language = javascript ]
User chose a new Auto-Refresh value; set a new timeout value and start the timer
• method countReset() [ Language = javascript ]
Reset the current count of Rule Log entries
• method enterKey() [ Language = javascript ]
Use with certain fields so user can hit Enter to indicate that an entry in the field is done and ready to use
• method expandoState() [ Language = javascript ]
Build the current expando state into a string concatenated with commas
• method formReset() [ Language = javascript ]
Reset the "Search Rules By..." form fields to blank, reset other fields to defaults
• method onAfterPageChange() [ Language = javascript ]
Callback invoked after the next/previous page has been loaded.
• method onChangeResultsPage(next, pageSize, currentPage) [ Language = javascript ]
Callback to set up the resultset/query for paging.
• method onSearchHandler() [ Language = javascript ]
User clicked the Search button, user changed a Quick Search criterion, or we have completed a non-zero Purge.
• method onSelectItem() [ Language = javascript ]
toggle detailTable for a selected row.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method showRule(rule, evt, ruleSet, path) [ Language = javascript ]
User clicked a link for Definition. Display the Rule View page. Display the rule definition in a popup, so the user doesn't lose the current page in the rule list.
• method showTrace(session, evt) [ Language = javascript ]
User clicked a link for Trace. Display the Visual Trace page in a popup, so user can click the arrows to go from session to session without losing his/her place in the Rule Log.
• method startPurge() [ Language = javascript ]
User clicked the Purge button
• method timeout(timer) [ Language = javascript ]
If auto-refresh is still on, refresh table and restart the timer
• method updatePageData() [ Language = javascript ]
Helper method to record the ExecutionID and TimeExecuted values for first and last rows on the current page.