finDocumentCreate Class

Functionality to Create a Document, e.g., send a Document to a Client.

Methods

Name Description
AccountAppLoad Loads an Account Application.
AccountLoad Loads an Account.
ClientLoad Loads a Client.
ExecuteCreateLog Create a Document Log and optionally Publish it immediately.
GenerateMessage Generate Message etc for Email and SMS Documents.
GetContactDetails Get a list of either Email or SMS Contact Details and optionally default the 'EmailTo' or 'PhoneNumber' property.
GetDocumentShowApplicationShortcutUrl Get an Application Shortcut URL to display the newly created Document in the User Interface.
GetDocumentsList Get a List of all Documents that can be created for this record.
GetDocumentsListAsHtmlWidgetJsonObject Get a List of all Documents that can be created for this record as a JSON object for use in HTML Widgets.
GetEmailMessageResolved Get the Email Message with any tags resolved.
GetEmailSubjectResolved Get the Email Subject with any tags resolved.
GetMessagePreviewHtml Get a full HTML document previewing an Email or SMS message.
GetMessagingContactFromContactValue Get a Messaging Contact (as produced by the GetContactDetails method) based on a supplied Contact Value, e.g., an Email Address.
GetSmsInformation Get Information about the currently configured SMS details.
GetSmsMessageResolved Get the SMS Message with any tags resolved.
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.
ResolveMessage Uses the target object, e.g., an Account, in conjunction with any Messaging Contact object (set using the MessagingContactSet method) to resolve tags.
SetMessagingContact Sets the Messaging Contact which is used primarily for resolving certain Tags in Email and SMS Documents.
SetMessagingContactFromContactValue Sets the Messaging Contact (used primarily for resolving certain Tags in Email and SMS Documents) by matching a Contact Value, e.g., an Email or Phone Number.
UserLoad Loads a User.

Properties

Name Description
Account Read-Only The Account.
AccountApp Read-Only The Account Application.
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 and Email Cost Centre charging).
BranchPk The primary key of the Branch (used for SMS Cost Centre charging).
Client Read-Only The Client.
Document Read-Only The Document that this object has been initialised with via the InitialiseDocument method.
EmailAccountRecipientDetailsItems Read-Only Populated are the Generate Document method is called and this is an Account Email Document. Used only in conjunction with the UseDocumentExecute flag.
EmailBcc The Email 'BCC' recipient(s).
EmailCc The Email 'CC' recipient(s).
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 The Email Target. I.e. Send, Save As Draft, etc.
EmailTo The Email 'To' recipient(s).
ExternalPartyId The Id of the External Party to link an Account Log to.
ExternalPartyPk The primary key of the External Party to link an Account Log to.
Fee The Fee to be charged for an Account Document.
Log Read-Only The Log that was created as the result of the ExecuteCreateLog method.
LogObjectType Read-Only The Object Type of the Log that has been/ will be created.
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.
Logs Read-Only The Logs that was created as the result of the ExecuteCreateLog method when UseDocumentExecute was set to True.
Notes Notes to record against the Document Log.
Parameters Read-Only The Document Parameters that this object has been initialised with via the InitialiseDocument method.
ParentLogPk The primary key of the Parent Log used when creating a Log via ExecuteCreateLog.
PublishOnDate The Publish On Date (in Local time for this Windows computer).
PublishOnDbDate The Publish On Date (in the Database Time Zone). Setting the Log Publish On Date will update the Publish On Time Zone to the Database Time Zone.
PublishOnTimeZone Read-Only The Time Zone associated with the Publish On Date.
PublishOnTimeZoneId The Id of the Time Zone associated with the Publish On Date.
PublishOnTzDate The Publish On Date (in the Time Zone defined by the PublishOnTimeZone property or, if this is undefined, the Database Time Zone defined under Global Settings).
PublishOnUtcDate The UTC Date on which a Document Type Log is to be Published.
RecordCaption Read-Only The Record Caption to display in the User Interface, e.g., "Account".
RecordCode Read-Only The Record Code to display in the User Interface, e.g., the Account Id.
RecordDescription Read-Only The Record Description to display in the User Interface, e.g., the Account Name.
ServiceLogBranchPk System Use Only The primary key of the Branch the Service Log that the Document links to.
ServiceLogPk System Use Only The primary key of the Service Log that the Document links to.
SmsMessage The SMS Message for creating SMS-type Documents.
SmsPhoneNumber The SMS Phone Number.
SmsServciceId System Use Only Obsolete The Id of the SMS Service to use for SMS Documents.
SmsServiceId The Id of the SMS Service to use for SMS Documents.
Target Read-Only The Target object type.
UseDocumentRecipientsList Indicates that, for an Account Email Document, a Recipients List (as generated from the Document) will be used to send multiple Emails.
User Read-Only The User.
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