finWorkflowItem Class

Represents a Workflow Item.
Implements I_ISDirty, I_ISObjectName

Methods

Name Description
CanAction Checks to see if the User can Action or set the Outcome of this Item.
CanReset Checks to see if the User can Reset this Item from the User Interface or, in the case of Version 1 type Workflows, from the business layer also.
Clear Clear details.
Clone Clone this Workflow Item but not certain state properties, e.g., the primary key and Status details.
CreateHtmlWidgetApplicationShortcut Create an Application Shortcut to run this HTML Widget type Workflow Item.
CreateParameters Create a Parameters collection.
GetActionDescription Get a Description of the Action that this Workflow Item will perform.
GetDocumentRecipients Get a collection of recipients to which an SMS or Email type Document is to be sent.
GetHelpNotesAsHtml Gets the notes in HTML format for display on Summary Pages.
GetHelpNotesAsWikiText Gets the notes in Wiki Text format for display on Summary Pages (Version 2).
GetLogSubjectParts Retrieves the various parts of a Workflow Item Log Subject which can contain both the Subject and an Information List.
GetObjectName
GetOutcomeItemsForOutcome Get a list of Outcome Items that match the specified Outcome.
GetSourceObject Get the Source Object for this Workflow Item based on SourceObjectType.
GetSourceObjectForDecisionCard Get the Source Object to use for a Decision Card. This will be from either this Workflow Item or the Workflow's Target object.
GetSourceObjectForDocument Get the Source Object to use for a Document. This will be from either this Workflow Item or the Workflow's Target object.
GetStatusCompleteIcon Get the Icon to display for completed Workflow Items.
GetUserDataAsSummaryTables Get the User Data as a Summary Tables collection providing this Workflow Item's Status Notes Entry Method defines Parameters for entry.
HasCompletedItems Checks to see whether this Item Group has Completed items.
HasIncompleteItems Checks to see whether this Item Group has items above it that are incomplete.
IsCurrentItem Checks to see if this is the Current Item, i.e., the first unactioned (or open) item in the first Item Group that is not yet Complete.
IsCurrentItemGroup Checks to see if this is the Current Item Group, i.e., the first Item Group that is not yet Complete.
IsInCurrentItemGroup Checks to see if this item is in the Current Item Group.
IsKeepTogether Checks to see if this Item is part of a 'Keep Together' group.
IsValid Check to see if this Item is valid.
LogsRefresh Forces the Logs collection to be reloaded from the Workflow's Logs collection the next time it is accessed.
SourceObjectSetAccountAppApplicantPk Set the Source Object to a Account Application Applicant for a Workflow Item that has not yet been started.
SourceObjectSetAccountAppId Set the Source Object to an Account Application for a Workflow Item that has not yet been started.
SourceObjectSetAccountAppPk Set the Source Object to a Account Application for a Workflow Item that has not yet been started.
SourceObjectSetAccountId Set the Source Object to a Account for a Workflow Item that has not yet been started.
SourceObjectSetAccountPk Set the Source Object to a Account for a Workflow Item that has not yet been started.
SourceObjectSetClientId Set the Source Object to a Client for a Workflow Item that has not yet been started.
SourceObjectSetClientPk Set the Source Object to a Client for a Workflow Item that has not yet been started.
StatusOutcomeIsSuccess Checks to see if the Status Outcome is a 'Success' item as defined by certain Item Types, e.g., Decision Cards, Question, Tests or Item Group's, based on the Outcome Items collection.
StatusOutcomeIsValid Checks to see if the Status Outcome is valid, i.e., it exists in this Question or Item Group's Outcome Items collection.
StatusSet Set the Status of this Item.
UpdateFromWorkflowTypeItem System Use Only
ValidateDocumentRecipients Validate a collection of Document Recipients (created via the GetDocumentRecipients method) to which an SMS or Email type Document is to be sent to ensure the collection is valid according to this Workflow Item's rules.

Properties

Name Description
AccountAppStatusSub The value to update an Account Application's Sub-Status to.
AccountAppStatusSubUpdate Indicates whether to update an Account Application's Sub-Status upon successful completion of this item.
AllocateToSupervisor Indicates whether this 'Allocate to User' type Item should allocate to the Workflow User's Supervisor.
AllowActionsWithOutcomes Read-Only Indicates whether this Workflow Item supports Outcome Items.
AllowNotApplicable Indicates whether this Item can be flagged as 'Not Applicable'.
AllowNotApplicableResolved Read-Only Indicates whether this Item can be flagged as 'Not Applicable'.
AllowResetResolved Read-Only Indicates whether the User can Reset this Workflow Item. This check is made in the User Interface only and is not enforced in the business layer.
AllowSkipUnskipResolved Read-Only Indicates whether the User can Skip or Unskip this Workflow Item. This check is made in the User Interface only and is not enforced in the business layer.
AllowUserEdit Indicates whether this Item can be Edited by Users.
AutoAction Indicates whether this Workflow Item should 'Auto Action'.
AutoActionOutcome The Status Outcome to set when this 'Auto Action' Workflow Item is actioned.
AutoActionStatusNotes The Status Notes to set when this 'Auto Action' Workflow Item is actioned.
AutoActionTag The Tag property that can be used by Script code when this 'Auto Action' Workflow Item is actioned.
Automatic Indicates whether this Item will be run Automatically ie. the User does not initiate running of it.
BalanceFrom The Value the Account Balance must be FROM.
BalanceFromIsBlank Indicates there is no From Balance defined (the equivalent of -999999999999999).
BalanceTest Indicates whether the Rule should carry out a Balance test.
BalanceTo The Value the Account Balance must be TO.
BalanceToIsBlank Indicates there is no To Balance (the equivalent of 999999999999999).
BankAccountEnquiryDocumentType The Document Type to generate for Bank Account Enquiries.
BankAccountEnquiryDocumentTypeText The Document Type to generate for Bank Account Enquiries in its String representation.
BankAccountEnquiryReviewPreventActionIfNotAvailable Indicates whether this Bank Account Enquiry Review Item can be actioned if no Bank Account Enquiry report is available.
CompletedDate Read-Only The Date (in Local time for this Windows computer) this item was completed.
CompletedUserId Read-Only The Id of the User who Completed this item.
CompletedUserPk The primary key of the User who Completed this item or zero if this item is not complete or the item was completed automatically by processing the Workflow.
CompletedUtcDate The UTC Date and Time this item was Completed.
ContractualOverdueApplySmallOverdueThreshold Indicates whether the Rule should apply the small ContractualOverdue threshold to the ContractualOverdue calculations.
ContractualOverdueDaysFrom The number of Days the Account must be Contractual Overdue FROM.
ContractualOverdueDaysFromIsBlank Indicates there is no from Contractual Overdue Days defined (the equivalent of 0).
ContractualOverdueDaysTo The number of Days the Account must be Contractual Overdue TO.
ContractualOverdueDaysToIsBlank Indicates there is no To Contractual Overdue Days defined (the equivalent of 9999).
ContractualOverdueTest Indicates whether the Rule should carry out Contractual Overdue tests
ContractualOverdueValueFrom The Value the Account must be Contractual Overdue FROM.
ContractualOverdueValueFromIsBlank Indicates there is no From Contractual Overdue Value defined (the equivalent of -999999999999999).
ContractualOverdueValueTo The Value the Account must be Contractual Overdue TO.
ContractualOverdueValueToIsBlank Indicates there is no To Contractual Overdue Value defined (the equivalent of 999999999999999).
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.
CreditLimitFrom The Value the Account Credit Limit 1 must be FROM.
CreditLimitFromIsBlank Indicates there is no From Credit Limit defined (the equivalent of -999999999999999).
CreditLimitTest Indicates whether the Rule should carry out a Credit Limit test.
CreditLimitTo The Value the Account Credit Limit 1 must be TO.
CreditLimitToIsBlank Indicates there is no To Credit Limit (the equivalent of 999999999999999).
CurrentItemIndex Read-Only The Index of the Current Item in this Item Group.
DecisionCardId The Id of this Item's Decision Card.
DecisionCardPk The primary key of this Item's Decision Card.
Description The Description of this Item.
DescriptionShort A Short Description of this Item.
DescriptionShortResolved Read-Only A Short Description of this Item, primarily used as a caption when generating a Train Stops Diagram.
DocumentClients The Account Clients that this Email or SMS type Document must be able to be sent to for this item to be completed.
DocumentClientsText The Account Clients in its String representation.
DocumentId The Id of this Item's Document.
DocumentPk The primary key of this Item's Document.
DocumentPublishImmediately Indicates whether this Document should be published immediately if possible (this is only possible when the Workflow is running via the User Interface).
DocumentSendToBranch Indicates whether this Email or SMS type Document should be sent to the associated Branch.
DocumentSendToBroker Indicates whether this Email or SMS type Document should be sent to the associated Broker.
DocumentSendToBrokerEmployee Indicates whether this Email or SMS type Document should be sent to the associated Broker Employee (Workflow Type Version 2 and above only).
DocumentSendToDealer Indicates whether this Email or SMS type Document should be sent to the associated Dealer.
DocumentSendToDealerEmployee Indicates whether this Email or SMS type Document should be sent to the associated Dealer Employee (Workflow Type Version 2 and above only).
EmailHtml Indicates whether this Email type Document should be sent in HTML format.
EmailMessageTarget The Message Target for Email type Documents.
EmailMessageTargetText The Message Target for Email type Documents in its String representation.
FlagColour The new Flag Colour for the Workflow upon successful completion of this item.
FlagColourUpdate Indicates whether to update the Flag Colour for the Workflow upon successful completion of this item.
GeneralUpdatesPerformed Indicates whether General Updates (e.g., flag colour and monitor category changes) where applied when this Item was completed.
GroupItemsClearRecallDate Indicates whether, when completed, items in this Item Group clear the Workflow's Recall Date (Version 2 type Workflows only; Version 1 type Workflows clear the Recall Date regardless).
GroupWithPrevious Indicates whether this Item should be Grouped with the Previous item i.e. it will only be executed if the previous item could not.
HasUnclearedFunds Indicates whether the to test whether an Account has Uncleared Funds when performing an Uncleared Funds test.
Hidden Indicates whether this item should be hidden in Summary Pages.
HiddenResolved Read-Only Indicates whether this item should be hidden in Summary Pages.
HiddenWhenComplete Indicates whether this item should be hidden in Summary Pages, even when Complete.
HtmlWidgetCustomise Indicates whether this HTML Widget's Parameters are Customised.
HtmlWidgetId The Id of this HTML Widget type Menu Item (the Id of a system-supplied HTML Widget).
HtmlWidgetParameters Read-Only A collection of HTML Widget Script Parameters.
HtmlWidgetScriptId The Id of this Item's HTML Widget Script.
HtmlWidgetScriptPk The primary key of this Item's HTML Widget Script.
IsDirty Read-Only Indicates whether this object has been modified since being created, loaded or refreshed.
IsNew Read-Only Indicates whether this is a new record.
ItemGroupNaSequential Indicates whether items in this Item Group must be flagged as 'Not Applicable' Sequentially, i.e., only when they are the current item.
ItemGroupSequential Indicates whether items in this Item Group must be completed Sequentially.
ItemId The Id of this Item.
ItemIdOriginal The Original Id of this Item when it was created from the Workflow Type.
ItemParameters Read-Only A collection of Item Parameters, e.g. for an HTML Widget type Script or Document.
ItemParametersCustomise Indicates whether Item Parameters are used.
ItemType The Item Type.
ItemTypeText The Item Type in its String representation.
Items Read-Only ' Checks to see whether this Question or Item Group has any Outcome Items that have an Action. '
LogActionPeriod The Period to after which to Action Logs.
LogDelegateAction The Log Delegation Action.
LogDelegateActionText The Log Delegation Action in its String representation.
LogDelegateToRoleId The Id of the Role to Delegate Logs to.
LogDelegateToRolePk The primary key of the Role to Delegate Logs to.
LogDelegateToUserId The Id of the User to Delegate Logs to.
LogDelegateToUserPk The primary key of the User to Delegate Logs to.
LogNotes The Log Notes for Log and Document type items.
LogSeverityId The Id of this Document or Log type item's Log Severity.
LogSeverityPk The primary key of this Document or Log type item's Log Severity.
LogSubject The Log Subject for Log and Document type items.
Logs Read-Only A collection of Logs.
MonitorCategoryAId The Id of the new Monitor Category A.
MonitorCategoryAMonitored Indicates whether the Rule should test whether Monitor Category A is currently Monitored.
MonitorCategoryAMonitoredDays The number of days since Monitor Category A was moved into the current Category.
MonitorCategoryAMonitoredRange The Range into which Monitor Category A must fall for this Rule to pass.
MonitorCategoryANotMonitored Indicates whether the Rule should test whether Monitor Category A is currently Not Monitored.
MonitorCategoryAPk The Primary Key of the new Monitor Category A.
MonitorCategoryATest Indicates whether the Rule should carry out Monitor Category A tests.
MonitorCategoryAUpdate Indicates whether to update Monitor Category A for the Account upon successful completion of this item.
MonitorCategoryBId The Id of the new Monitor Category B.
MonitorCategoryBMonitored Indicates whether the Rule should test whether Monitor Category B is currently Monitored.
MonitorCategoryBMonitoredDays The number of days since Monitor Category B was moved into the current Category.
MonitorCategoryBMonitoredRange The Range into which Monitor Category B must fall for this Rule to pass.
MonitorCategoryBNotMonitored Indicates whether the Rule should test whether Monitor Category B is currently Not Monitored.
MonitorCategoryBPk The Primary Key of the new Monitor Category B.
MonitorCategoryBTest Indicates whether the Rule should carry out Monitor Category B tests.
MonitorCategoryBUpdate Indicates whether to update Monitor Category B for the Account upon successful completion of this item.
MonitorCategoryCId The Id of the new Monitor Category C.
MonitorCategoryCMonitored Indicates whether the Rule should test whether Monitor Category C is currently Monitored.
MonitorCategoryCMonitoredDays The number of days since Monitor Category C was moved into the current Category.
MonitorCategoryCMonitoredRange The Range into which Monitor Category C must fall for this Rule to pass.
MonitorCategoryCNotMonitored Indicates whether the Rule should test whether Monitor Category C is currently Not Monitored.
MonitorCategoryCPk The Primary Key of the new Monitor Category C.
MonitorCategoryCTest Indicates whether the Rule should carry out Monitor Category C tests.
MonitorCategoryCUpdate Indicates whether to update Monitor Category C for the Account upon successful completion of this item.
Notes Notes.
OutcomeItems Read-Only A collection of Outcome Items for certain Item types such as Decision Cards, Questions, Tests and Item Groups.
OverdueApplySmallOverdueThreshold Indicates whether the Rule should apply the small overdue threshold to the Overdue calculations
OverdueDaysFrom The number of Days the Account must be Overdue FROM.
OverdueDaysFromIsBlank Indicates there is no from Days defined (the equivalent of 0).
OverdueDaysTo The number of Days the Account must be Overdue TO.
OverdueDaysToIsBlank Indicates there is no To Days defined (the equivalent of 9999).
OverdueTest Indicates whether the Rule should carry out Overdue tests
OverdueValueFrom The Value the Account must be Overdue FROM.
OverdueValueFromIsBlank Indicates there is no From Value defined (the equivalent of -999999999999999).
OverdueValueTo The Value the Account must be Overdue TO.
OverdueValueToIsBlank Indicates there is no To Value defined (the equivalent of 999999999999999).
PageSetId The Id of this Item's Page Set.
PageSetPk The primary key of this Item's Page Set.
Parameters Read-Only A collection of Parameters to use in place of Status Notes.
Parent The object's parent collection.
ParentItemGroup Read-Only This Workflow item's parent Item Group or Nothing if this is an Item Group.
Period The Period to wait for Wait and Review type items or the Period to set the Recall Date to when Allocating to a User.
PeriodDescription Read-Only A text description of the Wait/ Review Period.
PeriodWorkingDays Indicates whether the Period, if specified as a number of days, refers to 'Working Days'.
PeriodWorkingDaysCalendarType The Calendar Type to use if PeriodWorkingDays is True.
PeriodWorkingDaysCalendarTypeText The Period Calendar Type in its String representation.
PermissionKeyAction The Permission Key required to Action this Item.
PermissionKeyReset The Permission Key required to Reset this Item.
PermissionKeySkip The Permission Key required to Skip/ Unskip this Item (User Interface only).
Pk This record's primary key.
ProcessWorkflowOnNotApplicable Indicates whether to Process the Workflow (from the User Interface only) if this Item is flagged as 'Not Applicable' and the item was the Current Item.
ServiceAlwaysUseIndividual Indicates whether Services such as Credit Enquiries should always perform an Individual Enquiry, even on Organisation type Clients.
ServiceId The Service Id to use by default for the following item types: Bank Account Enquiry, Credit Enquiry, Security Enquiry.
ShowLogFeePage Indicates whether to show the Log Fee Page for Log-type items.
SourceObjectId Read-Only The Id of the Source Object, e.g., the Account Client that this item relates to.
SourceObjectPk The primary key of the Source Object, e.g., the Account Client that this item relates to.
SourceObjectType The Source Object Type that this item applies to. This is only applicable to items that have been generated for multiple target object, e.g., Account Clients.
Status This Item's Status.
StatusNotes Status Notes.
StatusNotesEntryMethod The Entry Method for Status Notes.
StatusNotesEntryMethodText The Status Notes Entry Method in its String representation.
StatusNotesTemplate The Template Status Notes used if StatusNotesEntryMethod is 'TextNotes'.
StatusOutcome The Status Outcome.
StatusOutcomeResolved Read-Only The Status Outcome including any Outcome Description.
StatusText Read-Only This Item's Status in its text representation.
StatusUpdatedFromScript Indicates whether this Item's Status was updated from a finWorkflowExecutor function, i.e., generally from the Workflow Type (Version 2) Script.
Tag The Tag property can be used to attach another value or object to this object.
TemplateMessage The Template Message used for SMS and Email Documents.
TemplateSubject The Template Text used for Email Documents.
Timestamp This record's Timestamp.
UnclearedFundsTest Indicates whether the Rule should carry out an Uncleared Funds test.
UpdatedDate Read-Only The Local date and time this record was last updated.
UpdatedUserPk The primary key of the User that last updated this record.
UpdatedUtcDate The UTC date and time this record was last updated.
UserData Read-Only User Defined data.
UserId The Id of this Item's User.
UserIdResolved Read-Only The Id of the User to Allocate to. Returns the Id of the current Workflow User's Supervisor is AllocateToSupervisor is True.
UserPk The primary key of this Item's User.
UserPkResolved Read-Only The primary key of the User to Allocate to. Returns the primary key of the current Workflow User's Supervisor is AllocateToSupervisor is True.
WaitPeriodBase The Base Period for Wait and Review items.
WaitPeriodBaseText The Period Type in its String representation.
Workflow Read-Only The Workflow that this Item belongs to.
WorkflowItemGroup Read-Only This Workflow item's parent Item Group or Nothing if this is an Item Group.
WorkflowItems Read-Only The Workflow Items that this Item belongs to.
Namespace:
Intersoft.finSupport6
Assembly:
finSupport6, Version=6.0.3
Target Framework:
.NET 9.0