Skip to main content

EnsPortal.SuspendedMsg

class EnsPortal.SuspendedMsg extends EnsPortal.Template.listPage

This is the Suspended Messages page of the ZEN application.

Property Inventory

Method Inventory

Parameters

parameter PAGENAME = Suspended Messages;
Displayed name of this page.
parameter RESOURCE = %Ens_MessageHeader:USE;
User needs USE permissions on the %Ens_MessageHeader resource to view this page.

Properties

property Discarded as %Boolean [ InitialExpression = 0 ];
Property methods: DiscardedDisplayToLogical(), DiscardedGet(), DiscardedIsValid(), DiscardedLogicalToDisplay(), DiscardedLogicalToXSD(), DiscardedNormalize(), DiscardedSet(), DiscardedXSDToLogical()
property Status as %String;
Property methods: StatusDisplayToLogical(), StatusGet(), StatusIsValid(), StatusLogicalToDisplay(), StatusLogicalToOdbc(), StatusNormalize(), StatusSet()
property canDiscard as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageDiscard","USE") ];
Flag to indicate whether a user may discard or delete messages.
Property methods: canDiscardDisplayToLogical(), canDiscardGet(), canDiscardIsValid(), canDiscardLogicalToDisplay(), canDiscardLogicalToOdbc(), canDiscardLogicalToXSD(), canDiscardNormalize(), canDiscardSet(), canDiscardXSDToLogical()
property canEditResend as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageEditResend","USE") ];
Flag to indicate whether a user may edit and resend messages.
Property methods: canEditResendDisplayToLogical(), canEditResendGet(), canEditResendIsValid(), canEditResendLogicalToDisplay(), canEditResendLogicalToOdbc(), canEditResendLogicalToXSD(), canEditResendNormalize(), canEditResendSet(), canEditResendXSDToLogical()
property canResend as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageResend","USE") ];
Flag to indicate whether a user may resend messages.
Property methods: canResendDisplayToLogical(), canResendGet(), canResendIsValid(), canResendLogicalToDisplay(), canResendLogicalToOdbc(), canResendLogicalToXSD(), canResendNormalize(), canResendSet(), canResendXSDToLogical()
property canViewTrace as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageTrace","USE") ];
Flag to indicate whether a user may access the Visual Trace pages.
Property methods: canViewTraceDisplayToLogical(), canViewTraceGet(), canViewTraceIsValid(), canViewTraceLogicalToDisplay(), canViewTraceLogicalToOdbc(), canViewTraceLogicalToXSD(), canViewTraceNormalize(), canViewTraceSet(), canViewTraceXSDToLogical()

Methods

method %OnGetPageName() as %String
Get the (localized) name of the page.
method DeleteMessage(allIDs As %String) as %String [ ZenMethod ]
WARNING: This method will attempt to delete any message header passed in, irrespective of its Status. This method taken in a comma separated list of headerIDs (without spaces) and deletes them and their associated bodies (if possible), search tables and updates affected bitmaps. It also ensures that no journaling is done for these deletes
method DiscardMessage(pHeaderId As %String) as %String [ ZenMethod ]
Adapted from the old CSP page
method DrawStatus(seed As %ZEN.Datatype.string) as %Status [ ZenMethod ]
Draw current import status; intended for use with background purge jobs.
classmethod GetCompletionValue() as %Boolean [ 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.
classmethod GetJobStatus() as %String [ ZenMethod ]
Use when the purge job is running in the background to check on error status. An empty string means no error; otherwise it is an error message.
classmethod GetPurgeStatus() as %String [ ZenMethod ]
Use when the purge job is running in the background to check on running status. Returns either "running" or "idle" or "done".
classmethod GetRunningStartTime() as %String [ ZenMethod ]
Use when the purge job is running in the background to check on status.
classmethod GetRunningStatus() as %String [ ZenMethod ]
Use when the purge job is running in the background to check on running status. Returns either "running" or "idle" or "done".
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 ResubmitMessage(pHeaderId As %String) as %String [ ZenMethod ]
Adapted from the old CSP page
classmethod SetCompletionValue(pValue As %Integer) [ ZenMethod ]
classmethod backgroundMethodForDelete() as %String [ ZenMethod ]
This method deletes all the suspended message headers, their associated bodies (if possible), search tables and updates affected bitmaps. It also ensures that no journaling is done for these deletes
classmethod backgroundMethodForDiscard() as %String [ ZenMethod ]
This method discards all the suspended messages and is aborted even if one discard fails.
clientmethod doDelete() [ Language = javascript ]
User selected a new row in the table
clientmethod doDeleteAllInBackground() [ Language = javascript ]
This is the method called from the SMP when the user clicks the "Delete All Suspended Messages" button
clientmethod doDiscard() [ Language = javascript ]
User selected a new row in the table
clientmethod doDiscardAllInBackground() [ Language = javascript ]
This is the method called from the SMP when the user clicks the "Discard All Suspended Messages" button
clientmethod doEdit() [ Language = javascript ]
User selected a new row in the table
clientmethod doResubmit() [ Language = javascript ]
User selected a new row in the table
clientmethod doStatus() [ Language = javascript ]
This method calls server method to get current background import job status and update the UI.
clientmethod onlayoutHandler(load) [ Language = javascript ]
The layout for this page is different from that for other list pages because of the iframe
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded. Start the timer so we can check the status. If there is a background import job currently running, you will see a periodic update until the job is finished.
clientmethod refreshDiagramHeaderStates(disableButtons) [ Language = javascript ]
Update ribbon buttons based on current Production status.
clientmethod showItem(msgId) [ Language = javascript ]
show detailTable for a selected task
clientmethod 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 Event Log.
classmethod startBackgroundJobForDelete() as %String [ ZenMethod ]
classmethod startBackgroundJobForDiscard() as %String [ ZenMethod ]
method totalSuspendedMessages() as %String [ ZenMethod ]
Returns the total number of suspended messages. By default we display only a maximum of 2000

Queries

query Enumerate(Filter As %String = "", QueryMethod As %String, QueryClass As %String)
Selects ID, TimeCreated, SessionId, Error, Source, Target
Class query with filter added. Override this in order to add rowspec specific to the list being displayed
query InitQuery()
SQL Query:
SELECT TOP 2000 ID, TimeCreated, SessionId, CASE IsError WHEN 1 THEN 'Yes' ELSE 'No' END As Error, SourceConfigName As Source, TargetConfigName As Target FROM Ens.MessageHeader WHERE Status = 'Suspended'

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab