Class Reference
IRIS for UNIX 2024.1.2
 InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [Ens] >  [Enterprise] >  [Portal] >  [MessageResend]
Private  Storage   

class Ens.Enterprise.Portal.MessageResend extends EnsPortal.MessageResend, Ens.Enterprise.Portal.base

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
7 17 17


Summary

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

Properties
%Targets %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
clients composite contactPage containerStyle
cssLevel currSortMode currStep currViewMode
disabled doCollective doIndividual 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
newTargetConfig nodeIndex onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onrefresh onshow onupdate pageModified
parent resendResultPage searchKey showLabel
slice targetingClass 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
BuildClientData BuildItemData BuildMenu CheckAllBlanks
CheckContextLinks CheckEnterpriseManager CleanUpIDs ConvertParameter
Decrypt DoLogout DrawBodyInfo DrawDetailsContent
DrawHTMLFields DrawLocator DrawRibbon DrawTitle
Encrypt EscapeHTML EscapeURL EvalResult
GetCSPURL GetContextLinks GetDocURL GetHomePage
GetHyperEventResources GetNewURL GetQuickLinks HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsPrivate JavaInstalled Link OnDrawRibbon
OnGetRibbonInfo OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Page PrepareResults QuoteJS ReallyResend
RegisterRecent RenderClientData 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 chooseTargetItem
clientKeepAlive correctIELayering createComponent createComponentNS
createTimeWarning deleteComponent disableCommandButton displayCountDown
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler editResend enableCommandButton
endModal exposeComponent findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getClient getComponent getComponentById getEditURL
getEnclosingDiv getHidden getHintElement getLabelElement
getOpener getPageTitle getProperty getSettings
getTitleAreaHeight getType goHome goMenu
gotoNamespace gotoPage hideCommandButton hideTimeoutWarning
hideWarnContinue inResizeLoop initPopupSuffix invokeSuper
isOfType launchPopupWindow launchQueue logout
makeId manualKeepAlive navigate onCreate
onDelete onDisplayHandler onEndModalHandler onPopupAction
onRefreshContents onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler ondisabledHandler onhandleAutoLogoutWarn
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler popupActionHandler refreshContents removeChild
removePopupSuffix render renderContents renderSVG
reportResendMessage resendMessages searchBlur searchBoxHandler
searchFocus searchKeyDown searchKeyPress setComponentId
setConnectivityStatusMsg setHidden setModified setOverlayMode
setPageTitle setProperty setPropertyAll setSortMode
setSortModeHandler setTraceOption setViewMode setViewModeHandler
setWarnInnerHTML showAbout showBody showCommandButton
showContact showDocumentation showHeader showHelp
showNodeHomePage showTimeoutWarning showTrace startKeepAlive
startModal startProgressBar stopKeepAlive stopProgressBar
switchNamespace updateTargetItemList updateTargets warnclickListener


Parameters

• parameter AssistantClass = "Ens.Enterprise.Portal.MsgFilter.Assistant";
Name of the Assistant class to use for filtered results.
• parameter EDITRESOURCE = "%Ens_MsgBank_MessageEditResend:USE";
User needs USE permissions on the %Ens_MsgBank_MessageEditResend resource to edit and resend messages.
• parameter IDColumn = 2;
Numeric column of the resultset which contains the ID column.
• parameter MessageClass = "Ens.Enterprise.MsgBank.MessageHeader";
Type of header messages.
• parameter PAGENAME = "Message Bank Resend";
Displayed name of this page.
• parameter RESOURCE = "%Ens_MsgBank_MessageResend:USE";
User needs USE permissions on the %Ens_MsgBank_MessageResend resource to view this page.
• parameter TABLECOLUMNS = 9;
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 %Targets as %String [ MultiDimensional ];
Multidimensional array used to cache known targets while drawing the contents of the table.
• property canViewContents as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MsgBank_MessageContent","USE") ];
Flag to indicate whether the user may view message contents.
• property canViewHeaders as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MsgBank_MessageHeader","USE") ];
Flag to indicate whether the user may view Header data.
• property canViewQueues as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to indicate whether the user may view Queue information. There are no queues in the Message Bank archive.
• property canViewTrace as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MsgBank_MessageTrace","USE") ];
Flag to indicate whether the user may view Trace messages.
• property clients as array of %ZEN.proxyObject;
All available Clients listed by client name.
• property doCollective as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to indicate whether Collective Targeting is in use.
• property doIndividual as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to indicate whether Individual Targeting is in use.
• property editResendPage as %ZEN.Datatype.string [ InitialExpression = "Ens.Enterprise.Portal.MessageResendEdit.zen" ];
Page for editing and resending messages.
• property filterClass as %ZEN.Datatype.className [ InitialExpression = "Ens.Enterprise.Portal.MsgFilter.Filter",ReadOnly ];
Name of the Filter class used for filtered results.
• property messageDisplayPage as %ZEN.Datatype.string [ InitialExpression = "Ens.Enterprise.Portal.Dialog.MessageBodyDisplay.zen" ];
Page to use for displaying message content.
• property messageTracePage as %ZEN.Datatype.string [ InitialExpression = "Ens.Enterprise.Portal.VisualTrace.zen" ];
Page for displaying the visual trace.
• property newTargetConfig as %ZEN.Datatype.string;
Name of the new config item to resend messages to. NewTarget is overriden to refer to the target client.
• property nodeIndex as array of %String;
Index of node ID to client name.
• property resendResultPage as %ZEN.Datatype.string [ InitialExpression = "Ens.Enterprise.Portal.MessageResendAfter.zen" ];
Page to use for displaying the results of the resend.
• property targetingClass as %ZEN.Datatype.className;
Name of the Targeting class to use.
• property viewerPage as %ZEN.Datatype.string [ InitialExpression = "Ens.Enterprise.Portal.MsgBankViewer.zen" ];

Methods

• method %OnAfterCreatePage() as %Status
Decorate the page.
• method BuildClientData() as %Status
Build the list of available clients and nodes.
• method BuildItemData(pClientName As %String, pUpdateClient As %Boolean = 0) as %String [ ZenMethod ]
Build the list of available config items for a given client. pUpdateClient indicates whether the update should be sent to the client using Javascript or whether data should be stored in the multidimensional %Targets property while displaying the table on the server.
• method DrawHTMLFields(tSessionId As %String) as %Status
Provide HTML for selected messages.
• method OnDrawRibbon() as %Status
Add Resend options to the toolbar.
• method ReallyResend() as %String [ ZenMethod ]
• method RenderClientData(ByRef pParameters As %String) as %Status
Represent the client array using JSON.
• method chooseTarget() [ Language = javascript ]
Select the client to resend messages to, and trigger an update of the available config items.
• method chooseTargetItem(itemName) [ Language = javascript ]
The user has chosen a target configuration item.
• method getClient(nodeName) [ Language = javascript ]
Get the named client data.
• method getEditURL() [ Language = javascript ]
• method onloadHandler() [ Language = javascript ]
Initialise the _configItems object
• method reportResendMessage() [ Language = javascript ]
Inform the user about the current targeting state.
• method showNodeHomePage(nodeName) [ Language = javascript ]
• method updateTargetItemList() [ Language = javascript ]
Refresh the list of available configuration items based on the currently selected client system.
• method updateTargets() [ Language = javascript ]

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