finDocumentExecute Class

Functionality to Execute a Document, e.g., send a bulk Document to a range of Clients.

Methods

Name Description
CreateExecuteSummaryPdf Generates a summary for Documents that use Recipients, e.g., Email and SMS.
Execute Execute, i.e., create the Documents.
GenerateRecipientMessages
GetDocumentsList ' Generate Message etc for Email and SMS Documents. '
GetDocumentsListAsHtmlWidgetJsonObject Get a List of all Documents that can be created for this record as a JSON object for use in HTML Widgets.
GetEmailInformation Get Information about the currently configured Email details.
GetExecutionSummary Retrieves the Summary of the Document Execution.
GetMessagePreviewHtml Get a full HTML document previewing an Email or SMS message.
GetSmsInformation Get Information about the currently configured SMS details.
GetSourceTagList Get a list of available Tags that can be included in Email and SMS Documents including any 'Special' tags such as Bank Account Enquiry tokens defined in the ParentLogPk.
InitialiseDocument Initialise with a Document.
ParametersAsWsParameters Gets the Parameters as an ISWsParameters object which is used for Web Services and HTML Widgets.
ParametersUpdateFromHtmlWidgetJsonString Update Parameters from a simple JSON String.
RecipientsFromBackgroundProcessRefreshData Populate the Recipients collection from a Background Process Refresh Data FOR PREVIEWING MESSAGES ONLY.
RefreshRecipients Refresh to generate the Recipients collection for Email, SMS and Log type Documents.
ResolveMessage Uses the target object, e.g., an Account, in conjunction with any Messaging Contact object (set using the MessagingContactSet method) to resolve tags.
ToHtmlWidgetJsonObject Create a JSON Object for use with HTML Widget controls.
ToHtmlWidgetJsonString Create a JSON-formatted String for use with HTML Widget controls.

Properties

Name Description
ActionDate The Action Date (in Local time for this Windows computer).
ActionDbDate The Action Date (in the Database Time Zone). Setting the Log Action Date will update the Time Zone to the Database Time Zone.
ActionTimeZone Read-Only The Time Zone associated with the Action Date.
ActionTimeZoneDescription Read-Only
ActionTimeZoneId The Id of the Time Zone associated with the Action Date.
ActionTzDate The Action Date (in the Time Zone defined by the ActionTimeZone property or, if this is undefined, the Database Time Zone defined under Global Settings).
ActionUtcDate The Action Date in UTC.
Branch Read-Only The Branch (used for SMS Cost Centre charging).
BranchId The Id of the Branch (used for SMS Cost Centre charging).
BranchPk The primary key of the Branch (used for SMS Cost Centre charging).
BulkDocumentFileName Read-Only The Bulk Document File Name as returned in the Document Script's ReturnValues parameter.
Document Read-Only The Document that this object has been initialised with via the InitialiseDocument method.
DocumentId Read-Only The Id of the Document that this object has been initialised with via the InitialiseDocument method.
DocumentRequiresRecipientsRefresh Read-Only Indicates whether this Document, based on its File Type, requires that a list of Recipients is built.
EmailDocument Indicates whether a 'Word Document' or 'Excel Workbook' type Document should be emailed upon publish if this is possible.
EmailMessage The Email Message for creating Email-type Documents.
EmailSender The Email Sender address. By default, this is the address defined under User Preferences for the SMTP Email.
EmailSenderName The Email Sender display name. By default, this is the name defined under User Preferences for the SMTP Email.
EmailServiceId The Id of the Email Service to use for Email Documents.
EmailSubject The Email Subject for creating Email-type Documents.
EmailTarget
Fee The Fee to be charged for an Account Document.
GenerateLogs Indicates whether Logs should be generated when sending Email and SMS Documents.
LogDate The Log Date (in Local time for this Windows computer).
LogDbDate The Log Date (in the Database Time Zone). Setting the Log Publish On Date will update the Publish On Time Zone to the Database Time Zone.
LogMessage The Log Message (Notes but named Message for consistency with other file types) for creating Log-type Documents.
LogSeverityId The Id of the Log Severity to assign to the Log
LogSeverityPk The primary key of the Log Severity to assign to the Log.
LogSubject The Log Subject for creating Log-type Documents.
LogTimeZone Read-Only The Time Zone associated with the Log Date.
LogTimeZoneId The Id of the Time Zone associated with the Publish On Date.
LogTzDate The Log Date (in the Time Zone defined by the PublishOnTimeZone property or, if this is undefined, the Database Time Zone defined under Global Settings).
LogUtcDate The UTC Date for the Log.
Parameters Read-Only The Document Parameters that this object has been initialised with via the InitialiseDocument method.
Recipients Read-Only Recipients for Email, Log and SMS type Documents.
SmsMessage The SMS Message for creating SMS-type Documents.
SmsServiceId The Id of the SMS Service to use for SMS Documents.
WordDocument Read-Only The WordDocument as returned in the Document Script's ReturnValues parameter.
WordDocuments Read-Only The WordDocuments as returned in the Document Script's ReturnValues parameter.
Workflow Read-Only The Workflow if WorkflowPk is specified.
WorkflowId The Id of Workflow that the Log is to link to.
WorkflowItemPk The primary key of the Workflow Item that the Log is to link to.
WorkflowPk The primary key of the Workflow that the Log is to link to.
Namespace:
Intersoft.finSupport6
Assembly:
finSupport6, Version=6.0.3
Target Framework:
.NET 9.0