class EnsPortal.Dialog.ExportMessages extends EnsPortal.Dialog.standardDialog

Property Inventory

Method Inventory


parameter APPLYBUTTON = 0;
Inherited description: If true, then this dialog displays an Apply button.
parameter BACKGROUNDPROCESSOR = EnsLib.Background.Process.ExportMessageSearch;
This is the BP(L) that will process the background request
parameter DOMAIN = Ensemble;
Inherited description: Localization domain
parameter PRIVATE = 1;
Inherited description: Controls the access to the page, it can be set to one of the following:

  • PRIVATE=0 - Page can be linked to/bookmarked
  • PRIVATE=1 - Can only be referenced from another CSP page
The user needs initially to enter the site through a PUBLIC page.
parameter RESOURCE = %Ens_MessageExport:USE;
Users must have USE permissions on the %Ens_MessageExport resource to use this page.


property BackgroundWFRole [ InitialExpression = "%ProductionMessageExport" ];
This is the Workflow Role that will process the background request
Property methods: BackgroundWFRoleDisplayToLogical(), BackgroundWFRoleGet(), BackgroundWFRoleIsValid(), BackgroundWFRoleLogicalToDisplay(), BackgroundWFRoleLogicalToOdbc(), BackgroundWFRoleNormalize(), BackgroundWFRoleSet()
property cleanedUp as %ZEN.Datatype.string;
Property methods: cleanedUpDisplayToLogical(), cleanedUpGet(), cleanedUpIsValid(), cleanedUpLogicalToDisplay(), cleanedUpLogicalToOdbc(), cleanedUpNormalize(), cleanedUpSet()
property msgNotOK as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Not permitted. Please see the reason above.") ];
Property methods: msgNotOKDisplayToLogical(), msgNotOKGet(), msgNotOKIsValid(), msgNotOKLogicalToDisplay(), msgNotOKLogicalToOdbc(), msgNotOKNormalize(), msgNotOKSet()
property msgQuantity as %ZEN.Datatype.integer (ZENURL = "QUANTITY");
Property methods: msgQuantityDisplayToLogical(), msgQuantityGet(), msgQuantityIsValid(), msgQuantityLogicalToDisplay(), msgQuantityLogicalToOdbc(), msgQuantityNormalize(), msgQuantitySet()
property permittedForBackground as %ZEN.Datatype.boolean;
Property methods: permittedForBackgroundDisplayToLogical(), permittedForBackgroundGet(), permittedForBackgroundIsValid(), permittedForBackgroundLogicalToDisplay(), permittedForBackgroundLogicalToOdbc(), permittedForBackgroundLogicalToXSD(), permittedForBackgroundNormalize(), permittedForBackgroundSet(), permittedForBackgroundXSDToLogical()
property queuedSessionId as %ZEN.Datatype.string;
Property methods: queuedSessionIdDisplayToLogical(), queuedSessionIdGet(), queuedSessionIdIsValid(), queuedSessionIdLogicalToDisplay(), queuedSessionIdLogicalToOdbc(), queuedSessionIdNormalize(), queuedSessionIdSet()
property savedSearch as %ZEN.Datatype.string (ZENURL = "SAVEDSEARCH");
Property methods: savedSearchDisplayToLogical(), savedSearchGet(), savedSearchIsValid(), savedSearchLogicalToDisplay(), savedSearchLogicalToOdbc(), savedSearchNormalize(), savedSearchSet()
property searchClass as %String [ InitialExpression = "EnsPortal.MsgFilter.SavedSearch" , ReadOnly ];
Property methods: searchClassDisplayToLogical(), searchClassGet(), searchClassIsValid(), searchClassLogicalToDisplay(), searchClassLogicalToOdbc(), searchClassNormalize()
property tempKey as %ZEN.Datatype.string (ZENURL = "KEY");
This starts off being the id in IRIS.Temp.ResendIDs but is then updated to be the id in SessionEvents to ensure it can be cleaned up when user logs out.
Property methods: tempKeyDisplayToLogical(), tempKeyGet(), tempKeyIsValid(), tempKeyLogicalToDisplay(), tempKeyLogicalToOdbc(), tempKeyNormalize(), tempKeySet()


method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Inherited description: Avoid writing out the session cookie if we are in a Studio session.
method %OnGetSubtitle() as %String [ Language = objectscript ]
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String [ Language = objectscript ]
Get the (localized) title string for the dialog. This should be implemented in a subclass.
method CheckFileStatus(pDocName, pKey) [ Language = objectscript, ZenMethod ]
classmethod CleanupExportIDs(pKey As %String) as %String [ Language = objectscript, ZenMethod ]
Cleanup temp of saved ids.
classmethod CleanupTemporaryServerFile(pDocName As %String, pKey As %String) as %Integer [ Language = objectscript, ZenMethod ]
Cleanup temporary server side file
classmethod CreateTempFile(pDocName, pKey, pCharSet, pMsgSep, pRS, pUsername=$username) as %String [ Language = objectscript, ZenMethod ]
This method is also called from background business process as well as SMP. throws error if error status encountered
method DoSearchDelete() as %Status [ Language = objectscript, ZenMethod ]
Server side method to delete the temporary search
classmethod DownloadStream(pDocName As %String, pCharSet As %String, pKey As %String) [ Language = objectscript, ZenMethod ]
method DrawInfo(pSeed As %String) as %Status [ Language = objectscript ]
Draw contents of description box.
method QueueSearchForExport() as %Status [ Language = objectscript, ZenMethod ]
clientmethod doDownload() [ Language = javascript ]
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod ondialogCancel() [ Language = javascript ]
This callback, if defined, is called when the user presses the Cancel button. If this returns false, then the dialog is not cancelled.
clientmethod ondialogFinish(action) as %Boolean [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.
classmethod tempServerDirectory() as %String [ Language = objectscript ]
classmethod tempServerFilename(pDocName, pKey, pUsername=$username) as %String [ Language = objectscript ]
method userPermittedForBackgroundRequest(Output pReason) as %Boolean [ Language = objectscript ]

Inherited Members

Inherited Properties

Inherited Methods