Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [EnsPortal] >  [MessageResend]
Private  Storage   

class EnsPortal.MessageResend extends EnsPortal.Template.standardPage

This is the page shown to confirm the actions of the Message Resend page of the ZEN application.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
8 18 25


Summary

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

Properties
%condition %import %includeFiles %page
%resource HeadOfQueue HelpAddress ISREADONLY
Key LocatorHeader Messages NewTarget
Number ParentURL SortOrder StdTitle
UseFilter aboutPage align aux
backgroundTimerInterval canEdit canViewContents canViewHeaders
canViewQueues canViewTrace cellAlign cellSize
cellStyle cellVAlign children composite
contactPage containerStyle cssLevel currSortMode
currStep currViewMode disabled dragAndDrop
dragEnabled dropEnabled editResendPage enableAutoRefresh
enclosingClass enclosingStyle error filterClass
groupClass groupStyle height hidden
hint hintClass hintStyle home
homePage id index keepAliveInterval
label labelClass labelDisabledClass labelPosition
labelStyle layout lblTitle limitPopups
messageDisplayPage messageTracePage msgNotPermitted name
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onrefresh onshow
onupdate pageModified parent resendResultPage
searchKey showLabel slice title
tuple useSVG useSoftModals valign
viewerPage 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 %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 AddMessage
BuildMenu CheckAllBlanks CheckContextLinks CheckEnterpriseManager
CleanUpIDs ConvertParameter Decrypt DoLogout
DrawBodyInfo DrawDetailsContent DrawHTMLFields DrawLocator
DrawRibbon DrawTitle Encrypt EscapeHTML
EscapeURL EvalResult GetCSPURL GetContextLinks
GetDocPage GetHomePage GetHyperEventResources GetNewURL
GetQuickLinks HyperEventCall HyperEventHead Include
InsertHiddenField InsertHiddenFields IsPrivate Link
OnDrawRibbon OnGetRibbonInfo OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page PrepareResults QuoteJS
ReallyResend RegisterRecent RewriteURL ShowError
SimpleKeepAlive StartTimer StopTimer ThrowError
UnescapeHTML UnescapeURL XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType addChild addChildAfter
addChildBefore addPopupSuffix arrowClick cancelPage
cancelPopup changePassword changeURLNamespace checkEdit
childrenMutated chooseHead chooseTarget clientKeepAlive
correctIELayering createComponent createComponentNS deleteComponent
disableCommandButton dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler editResend
enableCommandButton endModal exposeComponent findElement
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
getChildIndex getComponent getComponentById getEditURL
getEnclosingDiv getHidden getHintElement getLabelElement
getOpener getPageTitle getProperty getSettings
getTitleAreaHeight getType goHome goMenu
gotoNamespace gotoPage hideCommandButton inResizeLoop
initPopupSuffix invokeSuper isOfType launchPopupWindow
launchQueue logout makeId navigate
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondisabledHandler
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler popupActionHandler refreshContents removeChild
removePopupSuffix render renderContents renderSVG
resendMessages searchBlur searchBoxHandler searchFocus
searchKeyDown searchKeyPress setComponentId setConnectivityStatusMsg
setHidden setModified setOverlayMode setPageTitle
setProperty setPropertyAll setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler showAbout
showBody showCommandButton showContact showDocumentation
showHeader showHelp showTrace startKeepAlive
startModal startProgressBar stopKeepAlive stopProgressBar
switchNamespace

Subclasses
Ens.Enterprise.Portal.MessageResend EnsPortal.MessageResendAfter

Parameters

• parameter AssistantClass = "EnsPortal.MsgFilter.Assistant";
Name of the Assistant class to use for filtered results.
• parameter EDITRESOURCE = "%Ens_MessageEditResend:USE";
User needs USE permissions on the %Ens_MessageEditResend resource to edit and resend messages.
• parameter IDColumn = 1;
Numeric column of the resultset which contains the ID column.
• parameter MAXDISPLAYROWS = 500;
Maximum number of rows to display.
• parameter MessageClass = "Ens.MessageHeader";
Type of header messages.
• parameter PAGENAME = "Message Resend";
Displayed name of this page.
• parameter RESOURCE = "%Ens_MessageResend:USE";
User needs USE permissions on the %Ens_MessageResend resource to view this page.
• parameter TABLECOLUMNS = 7;
Number of columns drawn in the result table. This is used by some of the helper functions to add messages to the table.

Properties

• property HeadOfQueue as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to indicate whether messages should be resent as the head of the queue.
• property Key as %ZEN.Datatype.string(ZENURL="KEY");
Index of ^IRIS.Temp.ResendIDs in use for this resend
• property Messages as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
• property NewTarget as %ZEN.Datatype.string;
• property Number as %ZEN.Datatype.string(ZENURL="NUM") [ InitialExpression = ..#MAXDISPLAYROWS ];
Number of messages to resend.
• property SortOrder as %ZEN.Datatype.string(ZENURL="SORT");
Order in which to iterate over the messages.
• property UseFilter as %ZEN.Datatype.string(ZENURL="FILTER");
Whether to use the current Filter to fetch more results.
• property canViewContents as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageContent","USE") ];
Flag to indicate whether the user may view message contents.
• property canViewHeaders as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageHeader","USE") ];
Flag to indicate whether the user may view Header data.
• property canViewQueues as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_Queues","READ") ];
Flag to indicate whether the user may view Queue information.
• property canViewTrace as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageTrace","USE") ];
Flag to indicate whether the user may view Trace messages.
• property editResendPage as %ZEN.Datatype.string [ InitialExpression = "EnsPortal.MessageResendEdit.zen" ];
Page for editing and resending messages.
• property filterClass as %ZEN.Datatype.className [ InitialExpression = "EnsPortal.MsgFilter.Filter",ReadOnly ];
Name of the Filter class used for filtered results.
• property messageDisplayPage as %ZEN.Datatype.string [ InitialExpression = "EnsPortal.Dialog.MessageBodyDisplay.zen" ];
Page to use for displaying message content.
• property messageTracePage as %ZEN.Datatype.string [ InitialExpression = "EnsPortal.VisualTrace.zen" ];
Page for displaying the visual trace.
• property resendResultPage as %ZEN.Datatype.string [ InitialExpression = "EnsPortal.MessageResendAfter.zen" ];
Page to use for displaying the results of the resend.
• property viewerPage as %ZEN.Datatype.string [ InitialExpression = "EnsPortal.MessageViewer.zen" ];

Methods

• method %GetLocatorLinks(Output pLink) as %Status
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• method AddMessage(pNewMessage As %String = "", pType As %String = "error", pClearOldMessage As %Boolean = 1, pClass As %String = "") as %String [ ZenMethod ]
• method CleanUpIDs() as %String [ ZenMethod ]
• method DrawBodyInfo(pHeaderID As %String) as %Status
Write out contents of body details panel. pHeaderID is the message id.
• method DrawDetailsContent(pID As %String) as %Status
Write out contents of details panel. pID is the message id.
• method DrawHTMLFields(tSessionId As %String) as %Status
Provide HTML for selected messages.
• method OnDrawRibbon() as %Status
Add to the contents of the tool ribbon.
• 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 PrepareResults() as %String [ ZenMethod ]
Perform any processing based on the incoming request.
• method ReallyResend() as %String [ ZenMethod ]
• method cancelPage() [ Language = javascript ]
• method chooseHead() [ Language = javascript ]
Set the HeadOfQueue property of the page based on the value in the "Resubmit at head of queue" checkbox.
• method chooseTarget() [ Language = javascript ]
Set the NewTarget property of the page based on the value in the "New target" drop-down list.
• method editResend() [ Language = javascript ]
• method getEditURL() [ Language = javascript ]
• method launchQueue(name) [ Language = javascript ]
User clicked a link for a Config item. Show the queues page sorted for that queue.
• method onloadHandler() [ Language = javascript ]
Ensure that tab behaviour is initialised correctly.
• method onunloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is unloaded. If this method returns a string value, then that is used as the return value of the HTML page's onbeforeunload handler (if more than one component returns a string, the first one encountered is used).
• method resendMessages() [ Language = javascript ]
Resend the messages and then display the Confirm Resend page.
• method showBody(messageId) [ Language = javascript ]
Update the details for a selected message.
• method showHeader(messageId) [ Language = javascript ]
Update the details for a selected message.
• 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 display.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.