Home > Class Reference > ENSLIB namespace > Ens.Background.Request.ExportMessage

Ens.Background.Request.ExportMessage

persistent class Ens.Background.Request.ExportMessage extends Ens.Background.Request

SQL Table Name: Ens_Background_Request.ExportMessage

Used for export message request background processing

Property Inventory

Parameters

parameter XMLTYPE = BackgroundMessageExport;
Inherited description: Prevent this class from having the same default XML Type and Name as any of its subclasses that have the short classname "Request".

Properties

property CharSet as %String (MAXLEN = 128);
This is the character set to use when creating the export - the default is the system default
Property methods: CharSetDisplayToLogical(), CharSetGet(), CharSetGetStored(), CharSetIsValid(), CharSetLogicalToDisplay(), CharSetLogicalToOdbc(), CharSetNormalize(), CharSetSet()
property LocalFilename as %String);
This is used to suggest to the browser what filename to use in the download
Property methods: LocalFilenameDisplayToLogical(), LocalFilenameGet(), LocalFilenameGetStored(), LocalFilenameIsValid(), LocalFilenameLogicalToDisplay(), LocalFilenameLogicalToOdbc(), LocalFilenameNormalize(), LocalFilenameSet()
property MsgSeperators as %String (MAXLEN = 10);
This is used to specify how the messages in the export will be separated
CRLF,CR,LF,MLLP,Tab,None
Property methods: MsgSeperatorsDisplayToLogical(), MsgSeperatorsGet(), MsgSeperatorsGetStored(), MsgSeperatorsIsValid(), MsgSeperatorsLogicalToDisplay(), MsgSeperatorsLogicalToOdbc(), MsgSeperatorsNormalize(), MsgSeperatorsSet()
property SavedSearch as %String (MAXLEN = 128);
This is the name of the saved search details that are saved temporarily with a unique name
Property methods: SavedSearchDisplayToLogical(), SavedSearchGet(), SavedSearchGetStored(), SavedSearchIsValid(), SavedSearchLogicalToDisplay(), SavedSearchLogicalToOdbc(), SavedSearchNormalize(), SavedSearchSet()
property SearchClass as %String (MAXLEN = 128);
This is the name of the message viewer search class that will be invoked with the SavedSearch
Property methods: SearchClassDisplayToLogical(), SearchClassGet(), SearchClassGetStored(), SearchClassIsValid(), SearchClassLogicalToDisplay(), SearchClassLogicalToOdbc(), SearchClassNormalize(), SearchClassSet()

Inherited Members

Inherited Properties

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (Ens.MessageBody)

^Ens.MessageBodyD(ID)
=
%%CLASSNAME

Storage Model: Storage (Ens.Background.Request)

^Ens.MessageBodyD(ID,"Request")
=
WorkFlowRole
RequestedByUsername
BackgroundProcessor

Storage Model: Storage (Ens.Background.Request.ExportMessage)

^Ens.MessageBodyD(ID,"ExportMessage")
=
LocalFilename
CharSet
MsgSeperators
SearchClass
SavedSearch