WorkflowManager Class |
Service for managing workflows.
Inheritance HierarchySystemObject
  System.ComponentModelMarshalByValueComponent
    System.Web.ServicesWebService
      FileHold.LibraryManagerWorkflowManager
  System.ComponentModelMarshalByValueComponent
    System.Web.ServicesWebService
      FileHold.LibraryManagerWorkflowManager
Namespace: Â FileHold.LibraryManager
Assembly: Â FileHold.LibraryManager (in FileHold.LibraryManager.dll) Version: 17.0.0.0
SyntaxC#
public class WorkflowManager : WebService
The WorkflowManager type exposes the following members.
Constructors| Â | Name | Description |
|---|---|---|
 | WorkflowManager | Initializes a new instance of the WorkflowManager class |
Methods| Â | Name | Description |
|---|---|---|
| AddDocumentsToWorkflow |
Add documents to existing active workflow.
|
| AddDocumentVersionsToWorkflow |
Add document versions to existing active workflow.
|
| AddSelectionToWorkflow |
Add selection to existing active workflow.
|
| AddWorkflowTemplate |
Add new workflow template.
|
| AllowWorkflowDueDateExtension |
Return true if workflow due date can be extended when adding a one-time review.
|
| ApproveDocumentVersion | |
| CalculateEligibleObservers |
Calculate eligible workflow observers for given documents.
|
| CalculateEligibleObserversForSelection |
Calculate eligible workflow observers for selection.
|
| CalculateEligibleParticipants |
Calculate eligible workflow participants for given documents.
|
| CalculateEligibleParticipantsForSelection |
Calculate eligible workflow participants for selection.
|
| CanAddOneTimeReviewForUser | |
| CancelWorkflow |
Cancel specified workflow instance.
|
| CanInitiateWorkflow |
Check if workflow with given template can be started for selection
|
| CanRestartWorkflow |
Check if specified workflow can be restarted.
|
| CanRestartWorkflowV2 |
Check if specified workflow can be restarted.
|
| ChangeWorkflowTemplate |
Change a workflow template.
|
| ClearAllCancelledWorkflows |
Clear all cancelled workflows for all users.
|
| ClearAllCompletedWorkflows |
Clear all completed workflows for all users.
|
| ClearAllCompletedWorkflowsByApprovalStatus |
Clear all completed workflows for all users.
|
| ClearCancelledWorkflows |
Clear cancelled workflows for current user.
|
| ClearCompletedWorkflows |
Clear completed workflows for current user.
|
| ClearCompletedWorkflowsByApprovalStatus |
Clear completed workflows for current user.
|
| CreateActivity | |
| CreateTasks |
Method allow to create tasks associated with activity
|
| DelegateTasks |
Delegate specified tasks.
|
| DelegateTasksFromSelection |
Delegates all tasks related to selected documents.
|
| DelegateWorkflowInitiators |
Delegate the initiators of selected workflows.
|
| DisposeExternalSignedDocuments | |
| ExpandParticipants | |
| FindAvailableParticipants |
Find all available workflow participants who fulfill specified criteria.
|
| FindAvailableParticipantsExceptSelf |
Find all available workflow participants who fulfill specified criteria except current user.
|
| FindAvailableParticipantsStartWith | |
| FindAvailableWorkflowInitiators |
Find all available workflow initiators who fulfill specified criteria.
|
| FindFinalParticipants | |
| FindTaskInList |
Find the index of a task with given guid in the list.
|
| GenerateWorkflowName |
Generate workflow name from naming pattern for given document.
|
| GetActiveAndPostponedWorkflows |
Return all active and postponed workflows to which user can add documents.
|
| GetActiveAndPostponedWorkflowsCount |
Return the number of active and postponed workflows.
|
| GetActiveWorkflows |
Return all active workflows to which user can add documents.
|
| GetActiveWorkflowsCount |
Return the number of active workflows.
|
| GetAdminStatusReport |
Return all workflows which fulfills specifed criteria
|
| GetAdminStatusReportCount |
Return number of entries in administrator's status report.
|
| GetAdminStatusReportWithDocumentCount |
Return all workflows which fulfills specifed criteria
|
| GetAllWorkflowDocuments |
Return main and supporting document versions for given instance.
|
| GetAttachmentLink |
Returns the URL of the attachment from specified task.
|
| GetAvailableAutoDelegateUsers |
Find all users that can be selected for automatic delegation.
|
| GetAvailableObservers |
Find all users that can observe a workflow for specified document.
STEPS:
- get members and owner of the document's cabinet
- get members (+owner) of the document's folder
- get members of the document's schema
- invoke method GetEligibleUsers which calculates users which are eligible
NOTE: if documentVersionId is less than 0 then location is not taken into consideration
|
| GetAvailableObserversForDocuments |
Find all users that can observe a workflow for all specified documents.
|
| GetAvailableObserversForSelection |
Find all users that can observe a workflow for selection.
|
| GetAvailableParticipants |
Find all users that can participate in a workflow for specified document.
STEPS:
- get members and owner of the document's cabinet
- get members (+owner) of the document's folder
- get members of the document's schema
- invoke method GetEligibleUsers which calculates users which are eligible
NOTE: if documentVersionId is less than 0 then location is not taken into consideration
|
| GetAvailableParticipantsForDocuments |
Find all users that can participate in a workflow for all specified documents.
|
| GetAvailableParticipantsForSelection |
Find all users that can participate in a workflow for selection.
|
| GetCertificates | |
| GetDocumentStatusReport |
Return all workflows associated with given document versions.
|
| GetDocumentStatusReportCount |
Return number of entries in document status report.
|
| GetEligibleUsers | |
| GetExistingWorkflowSettings |
Get "add to existing" workflow settings.
|
| GetMyTasks |
Return the tasks for current user.
|
| GetMyTasksCount |
Return the number of tasks for current user.
|
| GetMyTasksCount(String, Boolean, Database, DbTransaction) | |
| GetMyTasksCountForWorkflowTemplate | |
| GetNewTasksCount |
Return the number of new tasks. Equivalent to GetMyTasksCount().
|
| GetOneWorkflowStatusReport |
Return all workflows associated with given tasks.
|
| GetRestartedWorkflows |
Return all workflows ids that RestartedWorkflowId equals given parameter.
|
| GetRestartedWorkflowsReport |
Return all workflows that were restarted from given workflow.
|
| GetRestartedWorkflowsReportCount |
Return the number of workflows that were restarted from given workflow.
|
| GetSignOffSheet |
Return all approval tasks associated with specified document versions.
|
| GetSignOffSheetCount |
Return number of entries in sign off sheet.
|
| GetTaskAttachmentToken |
Create a download token for attachment for the given task.
|
| GetTaskForDocumentVersion |
Return information about current user's task for a document version.
|
| GetTaskOwnerId |
Get task owner user id
|
| GetTaskParticipantsReport |
Return all workflow tasks and their participants.
|
| GetTaskParticipantsReportCount |
Return the number of workflow tasks and their participants.
|
| GetTaskParticipantsReportWithCount |
Return all workflow tasks and their participants.
|
| GetTasksFromActivity |
Return all active tasks that belong to activity related to given task.
The given task identifier is not returned.
|
| GetTaskStatusReport |
Return all workflows associated with given tasks.
|
| GetTaskStatusReportCount |
Return number of entries in task status report.
|
| GetTaskWorkflowAndState |
Return workflow identifier for given task and current state of this task.
|
| GetTemplatesToAppendToDocument | |
| GetUserId |
Get user id by user guid
|
| GetUserStatusReport |
Return all workflows which user is allowed to review.
|
| GetUserStatusReportCount |
Return the number of entries in status report.
|
| GetUserStatusReportCriteria |
Get user's status report criteria used by Workflow Status Report
|
| GetUserStatusReportWithDocumentCount |
Return all workflows which user is allowed to review with the number of all workflows.
|
| GetWorkflowApprovalStatus(Guid) |
Return the approval status of given workflow.
|
| GetWorkflowApprovalStatus(Guid, Database, DbTransaction) | |
| GetWorkflowDashboardStatusReportWithDocumentCount |
Return workflows selected in Workflow dashboard.
|
| GetWorkflowDashboardSummary |
Return dashboard summary of all workflows.
|
| GetWorkflowDefinition |
Return the workflow definition for given instance.
|
| GetWorkflowDocumentOwners | |
| GetWorkflowDocuments(Guid) |
Return main document versions for given instance.
|
| GetWorkflowDocuments(Guid, Database, DbTransaction) | |
| GetWorkflowDocumentsCount |
Returns workflow main documents count
|
| GetWorkflowForDocumentVersion |
Return identifier and name of current workflow associated with given document version.
|
| GetWorkflowForTask | |
| GetWorkflowHistoryChangesList(Guid) |
Get Workflow History Changes List for the specific workflow
|
| GetWorkflowHistoryChangesList(Guid, Database, DbTransaction) | |
| GetWorkflowHistoryDetails | |
| GetWorkflowHistoryReport |
Return the history of operations on the given workflow.
|
| GetWorkflowHistoryReportCount |
Return number of records in the history of the given workflow.
|
| GetWorkflowInitiationDefinition | |
| GetWorkflowInitiator | |
| GetWorkflowInitiatorsReport |
Return all workflows and their initiators.
|
| GetWorkflowInitiatorsReportCount |
Return the number of workflows and their initiators.
|
| GetWorkflowInstanceDetails |
Gets workflow instance details.
|
| GetWorkflowObserverGuids(Guid) | |
| GetWorkflowObserverGuids(Guid, Database, DbTransaction) | |
| GetWorkflowsGuidsWithHistory |
Return all workflows that have a workflow history.
|
| GetWorkflowStatus |
Return the status of given workflow.
|
| GetWorkflowsToDownload |
This method is obsolete.
|
| GetWorkflowSupportingDocumentsCount |
Returns workflow supporting documents count
|
| GetWorkflowTaskDetails |
Return details of given task.
|
| GetWorkflowTasks(Guid) |
Return all tasks associated with given workflow.
|
| GetWorkflowTasks(Guid, Database, DbTransaction) | |
| GetWorkflowTemplate |
Return the definition of specified workflow template.
|
| GetWorkflowTemplateNamesFromMyTasks | |
| GetWorkflowTemplates |
Return information about all workflow templates in the system
|
| GetWorkflowTemplatesInfo |
Return information about chosen workflow templates in the system
|
| HasCheckedOutDocuments |
Check if any documents associated with workflow are checked out.
|
| IncrementTotalStepsCount | |
| InitiateWorkflow(Int32, WorkflowTemplateDefinition, Int32) |
Start workflow instance based on given template and associated with given document version
|
| InitiateWorkflow(Int32, WorkflowTemplateDefinition, Int32, WorkflowDetails, NullableInt32, NullableGuid, NullableInt32, Boolean, Database, DbTransaction) | |
| InitiateWorkflowForDocuments |
Start workflow based on given template and associated with given document versions.
|
| InitiateWorkflowForSelection |
Start workflow based on given template and associated with selection
|
| IsWorkflowDocumentsChanged |
Returns true if documents from workflow was changed
|
 | IsWorkflowStatusSpeedUpWithStoredProcedureCache | |
| MarkTasksAsNotNew |
Obsolete method.
|
| PrepareWorkflowForDocument |
Prepare a workflow template for the document version.
|
| PrepareWorkflowForDocuments(Int32, Int32, ADAMObject, ADAMObject, Boolean) |
Prepare workflow template for selected document versions.
|
| PrepareWorkflowForDocuments(Int32, Int32, ADAMObject, ADAMObject, Boolean, Database, DbTransaction) | |
| PrepareWorkflowForSelection |
Prepare workflow template for selection.
|
| PrepareWorkflowsToDownload |
This method is obsolete.
|
| RaiseTaskCompletedEvent |
Completes specified task.
|
| RaiseTaskCompletedEventV2 |
Completes specified task.
|
| RaiseTaskDelegated |
Delegates task to specified user.
|
| RaiseTaskOverriden(Guid, Guid) |
Override specified task.
|
| RaiseTaskOverriden(Guid, Guid, Database, DbTransaction) | |
| RemoveDocumentsFromWorkflow |
Remove documents from active workflow.
|
| RemoveSelectionFromWorkflow |
Remove selection from active workflow.
|
| RemoveWorkflowTemplate |
Remove specified workflow template.
|
| RenameWorkflow |
Rename a workflow instance.
|
| RestartWorkflow |
Restart specified workflow instance from the given task.
|
| RestoreTaskDelegation |
Restore the original participant of selected workflow task.
|
| RestoreWorkflowInitiators |
Restore original initiators of selected workflows.
|
| SetDocumentTaskReserved |
Reserve or undo reservation of a 1 of X task associated with a document.
|
| SetExistingWorkflowSettings |
Set "add to existing" workflow settings.
|
| SetTaskReserved |
Reserve or undo reservation of a 1 of X task.
|
| SetUserStatusReportCriteria |
Set user's status report criteria used by Workflow Status Report
|
| SetUserStatusReportCriteriaPin |
Set user's status report criteria pin used by Workflow Status Report
|
| StartActivity(Guid, WorkflowTemplateDefinition, ListWorkflowTaskDetails, Activity, String, NullableWorkflowActionTypes, String, Database, DbTransaction) | |
| StartActivity(Guid, WorkflowTemplateDefinition, ListWorkflowTaskDetails, Activity, String, NullableWorkflowActionTypes, String, DateTime, Database, DbTransaction) | |
| TaskCompleted(Guid, Guid, TaskApprovalStatus, NullableDateTime, String, Guid, String, Database, DbTransaction) | |
| TaskCompleted(Int32, TaskApprovalStatus, String, Guid, String, String, NullableInt32, NullableGuid, String) |
Completes task associated with specified document.
|
| TaskCompletedV2 |
Completes task associated with specified document.
|
| TaskDelegated |
Delegate task associated with specified document.
|
| ValidateTemplateForSchema |
Check whether template observers and participants have access to specified schema.
|
Extension Methods|  | Name | Description |
|---|---|---|
 | Convert | (Defined by ObjectExtension.) |
| ToJson | (Defined by ObjectExtension.) |
See Also