finWorkflow Class

Represents a Workflow.
Implements I_ISDirty, I_ISObjectName, I_ISSummaryText, I_finExtendedAuditInformation, I_finSummaryPages

Methods

Name Description
AccountAppLoad Loads the Account Application object.
AccountAppRefresh Forces the Account Application object to be reloaded from the database the next time it is accessed.
AccountLoad Loads the Account object.
AccountRefresh Forces the Account object to be reloaded from the database the next time it is accessed.
AuditItemsLoad Loads the Audit Items collection.
AuditItemsRefresh Forces the Audit Items collection to be reloaded from the database the next time it is accessed.
CanDelete Indicates whether the Workflow can be deleted.
CanUpdate Indicates whether the Workflow can be updated.
Clear Clears this object and sets all of its properties to their defaults.
ClientLoad Loads the Client object.
ClientRefresh Forces the Client object to be reloaded from the database the next time it is accessed.
Delete Deletes the current record.
DirtySet System Use Only
Duplicate Duplicates the current object.
GetAuditItemsByWorkflowItemPk Get a list of Audit Items for a Workflow Item.
GetCountResetsByWorkflowItemPk Get a count of the number of times a Workflow Item has been reset.
GetCurrentItem Get the Current Workflow Item (this may be an Item or Item Group).
GetCurrentItemGroup Get the Current Workflow Item Group (this may or may not be the actual current item).
GetEvents System Use Only
GetItemByPk Get a Workflow Item based on the supplied primary key.
GetLogCountIncomplete A Count of Incomplete Logs.
GetNextItem Get the Next Workflow Item that has a Status of 'Not Started'.
GetObjectName
GetOpenItem Get the first 'Open' Workflow Item if one exists.
GetSummaryText Get Summary Text.
GetTrainStops Get Train Stops for use when generating a Train Stops diagram.
GetUserDataAsSummaryTables Get the User Data as a Summary Tables collection providing this Workflow's Workflow Type defines Parameters for entry.
GetUserDataByIndex Retrieves User Defined Data by its Index.
GetWarnings Get Warnings.
HasAutoActionItems Checks to see if the Current Item Group has any incomplete 'Auto Action' Items.
HasOpenItem Checks to see if this Workflow has a currently 'Open' Workflow Item.
HistoryItemsLoad Loads the History Items collection.
HistoryItemsRefresh Forces the History Items collection to be reloaded from the database the next time it is accessed.
Initialise Initialise this Workflow from the specified Workflow Type.
InitialisePk Initialise this Workflow from the specified Workflow Type.
IsInTaskManager Checks to see if this Workflow will be included in the Task Manager for the current User.
ItemGroupsLoad Loads the Items collection.
ItemGroupsRefresh Forces the Item Groups collection to be reloaded from the database the next time it is accessed.
Load Loads a record from the database.
LoadPk Loads a record from the database.
LogsLoad Loads the Logs collection.
LogsRefresh Forces the Logs collection to be reloaded from the database the next time it is accessed.
Publish Publish Logs linked to this Workflow.
RecallDateSet Set the Local Recall Date as if the User has manually changed it, i.e., an Audit Log will be recorded if necessary.
RecallImmediateClear Clear the Recall Immediate details for this Workflow.
RecallTzDateSet Set the Recall Time Zone Date as if the User has manually changed it, i.e., an Audit Log will be recorded if necessary.
RecallUtcDateSet Set the Recall UTC Date as if the User has manually changed it, i.e., an Audit Log will be recorded if necessary.
Refresh Refreshes this object from the database.
Save Save this record.
SetUserDataByIndex Sets User Defined Data by its Index.
SummaryPagesLoad Loads the Summary Pages collection.
SummaryPagesRefresh Forces the Summary Pages collection to be rebuilt the next time it is accessed.
UserDataInitialiseFromParameterSet Initialise User Data from a Parameter Set, i.e., create User Data entries and defaults.

Properties

Name Description
Account Read-Only The Account or Nothing if this Workflow Type does not target Accounts.
AccountApp Read-Only The Account Application or Nothing if this Workflow Type does not target Account Applications.
AccountAppId The Id of the Account Application that this Workflow relates to.
AccountAppLoaded Read-Only Indicates whether the Account Application has been loaded.
AccountAppPk The primary key of the Account Application that this Workflow relates to.
AccountId The Id of the Account that this Workflow relates to.
AccountLoaded Read-Only Indicates whether the Account has been loaded.
AccountPk The primary key of the Account that this Workflow relates to.
AllocatedUserId The Id of the User to whom this Workflow is Allocated.
AllocatedUserPk The primary key of the User to whom this Workflow is Allocated.
AuditItems Read-Only A collection of Audit Items.
AuditItemsLoaded Read-Only Indicates whether the Audit Items collection has been loaded.
AutoSuspendUntilDate The Database Date until which Workflows of this category (Workflow Type has the same Category or Id if there is no Category) should not be created Automatically, e.g. via Account Rules.
BranchPkResolved Read-Only Returns the Branch Pk from the Account, AccountApp or Client - or 0 if not found.
Client Read-Only The Client or Nothing if this Workflow Type does not target Clients.
ClientId The Id of the Client that this Workflow relates to.
ClientLoaded Read-Only Indicates whether the Client has been loaded.
ClientPk The primary key of the Client that this Workflow relates to.
ClosedDate Read-Only The Local date and time this Workflow was Closed.
ClosedNotes Read-Only Close Notes.
ClosedOutcome Read-Only Close Outcome.
ClosedSource Read-Only Closed Source.
ClosedToWorkflowId Read-Only The Id of the Workflow to which this Workflow was closed.
ClosedToWorkflowPk The primary key of the Workflow to which this Workflow was closed.
ClosedType Read-Only Closed Type.
ClosedTypeText Read-Only The Workflow's Closed Type in its text representation.
ClosedUserPk Read-Only The primary key of the User that Closed this Workflow.
ClosedUtcDate Read-Only The UTC date and time this Workflow was Closed.
CreatedDate Read-Only The Local date and time this record was created.
CreatedUserPk Read-Only The primary key of the User that created this record.
CreatedUtcDate Read-Only The UTC date and time this record was created.
Description Workflow Description.
DocumentManagerFolderName Read-Only The Document Manager Folder Name based on the Target Object, e.g., the Account.
DocumentManagerItemId Read-Only The Document Manager Item Id, e.g., L10000 or C10000.
DocumentManagerItemType Read-Only The Document Manager Item Type, e.g., Account or Client.
FlagColour The Flag Colour.
FlagNotes The Flag Notes.
HistoryItems Read-Only A collection of Workflow History Items.
HistoryItemsLoaded Read-Only Indicates whether the History Items collection has been loaded.
HoldAllocatedUser Indicates whether to Hold the Currently Allocated User.
IsDirty Read-Only ' A collection of Individual Client Statistics. '
IsNew Read-Only Indicates whether this is a new record.
IsOnHold Read-Only Indicates whether this Workflow is 'On Hold'.
ItemGroups Read-Only A collection of Workflow Item Groups.
ItemGroupsChanged Read-Only Indicates whether the ItemGroups collection has been loaded and has had changes made to it.
ItemGroupsLoaded Read-Only Indicates whether the Item Groups collection has been loaded.
Logs Read-Only A collection of Logs.
LogsLoaded Read-Only Indicates whether the Logs collection has been loaded.
Notes Notes about the Workflow.
OnHoldDate Read-Only The Local date and time this Workflow was put 'On Hold'.
OnHoldUserPk Read-Only The primary key of the User that put this Workflow 'On Hold'.
OnHoldUtcDate Read-Only The UTC date and time this Workflow was put 'On Hold'.
OpenedDate Read-Only The Local date and time this Workflow was Opened.
OpenedFromWorkflowId Read-Only The Id of the Workflow from which this Workflow was opened.
OpenedFromWorkflowPk The primary key of the Workflow from which this Workflow was opened.
OpenedUserPk Read-Only The primary key of the User that Opened this Workflow.
OpenedUtcDate Read-Only The UTC date and time this Workflow was Opened.
PendingAllocatedUserId The Id of the User to whom this Workflow is Pending Allocation.
PendingAllocatedUserPk The primary key of the User to whom this Workflow is Pending Allocation.
Pk Read-Only This record's primary key.
RecallDate The Recall Date (in Local time for this Windows computer).
RecallDbDate The Recall Date (in the Database Time Zone).
RecallEventAccountPaymentArrangementCreated Read-Only Indicates whether the 'Recall Immediate' flag was set due to a Payment Arrangement being made for the Account.
RecallEventAccountPaymentDueTransactionCreated Read-Only Indicates whether the 'Recall Immediate' flag was set due to a Payment Due Transaction being created for the Account.
RecallEventAccountPaymentMethodUpdated Read-Only Indicates whether the 'Recall Immediate' flag was set due to the Account's Payment Method being updated.
RecallEventAccountPaymentReceivedTransactionCreated Read-Only Indicates whether the 'Recall Immediate' flag was set due to a Payment being Received for this Account.
RecallEventAccountRestructured Read-Only Indicates whether the 'Recall Immediate' flag was set due to an Account being Restructured.
RecallEventAccountSuspensionUpdate Read-Only Indicates whether the 'Recall Immediate' flag was set due to a Suspension Update being performed for this Account.
RecallEventAccountTransactionCreated Read-Only Indicates whether the 'Recall Immediate' flag was set due to a Transaction being Created for this Account.
RecallEventBankAccountEnquiryReportDownloaded Read-Only Indicates whether the 'Recall Immediate' was set due to a Bank Account Enquiry Report being downloaded or deleted for the Target Object.
RecallEventElectronicSignatureCompletedDeleted Read-Only Indicates whether the 'Recall Immediate' was set due to an Electronic Signature being completed or deleted for the Target Object.
RecallEventLogCreated Read-Only Indicates whether the 'Recall Immediate' was set due to a Log being Created for the Target Object.
RecallImmediate Read-Only Indicates whether this Workflow should be recalled regardless of the Recall Date.
RecallImmediateDetails Read-Only An auto-generated message (vbCrLf separated) of reasons why the RecallImmediate flag was set.
RecallNotes The Recall Notes.
RecallTimeZone Read-Only The Time Zone associated with the Recall Date.
RecallTimeZoneDescription Read-Only
RecallTimeZoneId The Id of the Time Zone associated with the Recall Date.
RecallTzDate The Recall Date (in the Time Zone defined by the RecallTimeZone property or, if this is undefined, the Database Time Zone defined under Global Settings).
RecallUtcDate The Recall Date in UTC.
ReviewDate The Review Date.
Status Read-Only The Workflow Status.
StatusText Read-Only The Workflow Status in its text representation.
StatusTextResolved Read-Only The Workflow Status in its text representation including '(Cancelled)' if this is a closed, Cancelled Workflow.
SummaryPages Read-Only A collection of Summary Pages.
SummaryPagesLoaded Read-Only Indicates whether the Summary Pages collection has been loaded.
Tag The Tag property can be used to attach another value or object to this object.
Timestamp Read-Only This record's Timestamp.
UpdatedDate Read-Only The Local date and time this record was last updated.
UpdatedUserPk Read-Only The primary key of the User that last updated this record.
UpdatedUtcDate Read-Only The UTC date and time this record was last updated.
User Indexed User Defined data.
UserData Read-Only User Defined data.
UserDataWeb Read-Only Web User Defined data is not implemented for this class.
WorkflowId The Id of this Workflow.
WorkflowType Read-Only The Workflow Type or Nothing if this Workflow has not yet been initialised.
WorkflowTypeId Read-Only The Id of the Workflow Type that this Workflow is based upon.
WorkflowTypePk The primary key of the Workflow Type that this Workflow is based upon.
Namespace:
Intersoft.finSupport6
Assembly:
finSupport6, Version=6.0.3
Target Framework:
.NET 9.0