Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsPortal.BPInstances
Private  Storage   

EnsPortal.BPInstances


class EnsPortal.BPInstances extends
EnsPortal.Template.viewerPage

This is the BPInstances page of the ZEN application.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 8 30


Summary


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

Properties
%condition %import %includeFiles %page
%resource BusinessProcess BusinessTable HasContext
HelpAddress ISREADONLY LocatorHeader ParentURL
StdTitle aboutPage align aux
backgroundTimerInterval canEdit cellAlign cellSize
cellStyle cellVAlign children composite
contactPage containerStyle cssLevel currSortMode
currStep currViewMode currentPage currentPageStart
detailsHidden detailsWidth disabled dragAndDrop
dragEnabled dropEnabled enableAutoRefresh 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 linkHelper
msgCloseDetail 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
%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
ConvertParameter CreateDataSet Decrypt DoLogout
DoPurge DrawDetailsContent DrawLocator DrawRibbon
DrawTitle DrawYesNo Encrypt EscapeHTML
EscapeURL EvalResult GetAndUseDefaults GetBusinessProcess
GetCSPURL GetColumnsAndFrom GetContextLinks GetCount
GetDocURL GetHomePage GetHyperEventResources GetNewURL
GetQuickLinks GetRemoteSearchJob GetWhereClause 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
checkLink childrenMutated clientKeepAlive correctIELayering
countReset createComponent createComponentNS deleteComponent
disableCommandButton doSearch dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
enableCommandButton endModal executeSearch expandoState
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 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 setPageTitle setProperty setPropertyAll
setSortMode setSortModeHandler setTraceOption setViewMode
setViewModeHandler showAbout showCommandButton showContact
showDocumentation showHelp showJobs showMessage
showQuery showQueues showTrace startKeepAlive
startModal startProgressBar startPurge stopKeepAlive
stopProgressBar switchNamespace timeout toggleCancelState
toggleDetails toggleSearch toggleSearchState updateNavigationButtons
updatePageData updatePageNumber updatePageSize


Parameters


• parameter EDITRESOURCE = "%Ens_Purge:USE";
User must have USE permissions on %Ens_Purge to run the purge action on this page.
• parameter PAGENAME = "Business Process Instances";
Displayed name of this page.
• parameter RESOURCE = "%Ens_Jobs:READ";
User must have READ permissions on the "%Ens_Jobs" resource to view this page.

Properties


• property BusinessProcess as %String(ZENURL="BP");
The business process whose instances are of interest. The URL may supply this business process class name or it defaults to "" (empty string) for all business processes.
• property BusinessTable as %String(ZENENCRYPT=1);
The name of the SQL table that stores information about the business process whose instances are of interest. If this is a BPL business process, the value is Ens.BusinessProcessBPL; otherwise, it is Ens.BusinessProcess. This property is encrypted and only modifiable on the server
• property HasContext as %Boolean [ InitialExpression = 0 ];
True if the business process whose instances are of interest is a BPL business process. If so it has a context that is stored in an SQL table. Default is false.
• property detailsWidth as %ZEN.Datatype.integer(MAXVAL=80,MINVAL=5) [ InitialExpression = 30 ];
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 linkHelper as %ZEN.proxyObject;
• 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 %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• method CreateDataSet(pSeed As %String) as %Status
Server-side callback to provide data for the details table
• 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 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
• method GetBusinessProcess() as %String
Method called from %OnAfterCreatePage to get business process information
• method GetColumnsAndFrom(timeFormat As %String) as %String
Get the first part of the SQL statement.
• classmethod GetCount() as %Integer [ ZenMethod ]
• 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 GetWhereClause(Defaults) as %String [ ZenMethod ]
Method called from doSearch and %OnAfterCreatePage to build the where clause
• 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 checkLink(pageName) [ Language = javascript ]
• method countReset() [ Language = javascript ]
Reset the current count of Rule Log entries
• method expandoState() [ Language = javascript ]
Build the current expando state into a string concatenated with commas
• method formReset() [ Language = javascript ]
Reset the "Search 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 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 showJobs(session) [ Language = javascript ]
User clicked a link for Jobs. Display the Jobs page in a popup, so user can view queued messages without losing his/her place in the BP Log.
• method showMessage(context) [ Language = javascript ]
• method showQueues(session) [ Language = javascript ]
User clicked a link for Queues. Display the Queues page in a popup, so user can view queued messages without losing his/her place in the BP Log.
• method showTrace(session) [ 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 BP 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