FileHold 17.0 API Documentation
FileHold 17.0 API Reference
FileHold.LibraryManager
WorkflowManager Class
WorkflowManager Methods
AddDocumentsToWorkflow Method
AddDocumentVersionsToWorkflow Method
AddSelectionToWorkflow Method
AddWorkflowTemplate Method
AllowWorkflowDueDateExtension Method
ApproveDocumentVersion Method
CalculateEligibleObservers Method
CalculateEligibleObserversForSelection Method
CalculateEligibleParticipants Method
CalculateEligibleParticipantsForSelection Method
CanAddOneTimeReviewForUser Method
CancelWorkflow Method
CanInitiateWorkflow Method
CanRestartWorkflow Method
CanRestartWorkflowV2 Method
ChangeWorkflowTemplate Method
ClearAllCancelledWorkflows Method
ClearAllCompletedWorkflows Method
ClearAllCompletedWorkflowsByApprovalStatus Method
ClearCancelledWorkflows Method
ClearCompletedWorkflows Method
ClearCompletedWorkflowsByApprovalStatus Method
CreateActivity Method
CreateTasks Method
DelegateTasks Method
DelegateTasksFromSelection Method
DelegateWorkflowInitiators Method
DisposeExternalSignedDocuments Method
ExpandParticipants Method
FindAvailableParticipants Method
FindAvailableParticipantsExceptSelf Method
FindAvailableParticipantsStartWith Method
FindAvailableWorkflowInitiators Method
FindFinalParticipants Method
FindTaskInList Method
GenerateWorkflowName Method
GetActiveAndPostponedWorkflows Method
GetActiveAndPostponedWorkflowsCount Method
GetActiveWorkflows Method
GetActiveWorkflowsCount Method
GetAdminStatusReport Method
GetAdminStatusReportCount Method
GetAdminStatusReportWithDocumentCount Method
GetAllWorkflowDocuments Method
GetAttachmentLink Method
GetAvailableAutoDelegateUsers Method
GetAvailableObservers Method
GetAvailableObserversForDocuments Method
GetAvailableObserversForSelection Method
GetAvailableParticipants Method
GetAvailableParticipantsForDocuments Method
GetAvailableParticipantsForSelection Method
GetCertificates Method
GetDocumentStatusReport Method
GetDocumentStatusReportCount Method
GetEligibleUsers Method
GetExistingWorkflowSettings Method
GetMyTasks Method
GetMyTasksCount Method
GetMyTasksCountForWorkflowTemplate Method
GetNewTasksCount Method
GetOneWorkflowStatusReport Method
GetRestartedWorkflows Method
GetRestartedWorkflowsReport Method
GetRestartedWorkflowsReportCount Method
GetSignOffSheet Method
GetSignOffSheetCount Method
GetTaskAttachmentToken Method
GetTaskForDocumentVersion Method
GetTaskOwnerId Method
GetTaskParticipantsReport Method
GetTaskParticipantsReportCount Method
GetTaskParticipantsReportWithCount Method
GetTasksFromActivity Method
GetTaskStatusReport Method
GetTaskStatusReportCount Method
GetTaskWorkflowAndState Method
GetTemplatesToAppendToDocument Method
GetUserId Method
GetUserStatusReport Method
GetUserStatusReportCount Method
GetUserStatusReportCriteria Method
GetUserStatusReportWithDocumentCount Method
GetWorkflowApprovalStatus Method
GetWorkflowDashboardStatusReportWithDocumentCount Method
GetWorkflowDashboardSummary Method
GetWorkflowDefinition Method
GetWorkflowDocumentOwners Method
GetWorkflowDocuments Method
GetWorkflowDocumentsCount Method
GetWorkflowForDocumentVersion Method
GetWorkflowForTask Method
GetWorkflowHistoryChangesList Method
GetWorkflowHistoryDetails Method
GetWorkflowHistoryReport Method
GetWorkflowHistoryReportCount Method
GetWorkflowInitiationDefinition Method
GetWorkflowInitiator Method
GetWorkflowInitiatorsReport Method
GetWorkflowInitiatorsReportCount Method
GetWorkflowInstanceDetails Method
GetWorkflowObserverGuids Method
GetWorkflowsGuidsWithHistory Method
GetWorkflowStatus Method
GetWorkflowsToDownload Method
GetWorkflowSupportingDocumentsCount Method
GetWorkflowTaskDetails Method
GetWorkflowTasks Method
GetWorkflowTemplate Method
GetWorkflowTemplateNamesFromMyTasks Method
GetWorkflowTemplates Method
GetWorkflowTemplatesInfo Method
HasCheckedOutDocuments Method
IncrementTotalStepsCount Method
InitiateWorkflow Method
InitiateWorkflowForDocuments Method
InitiateWorkflowForSelection Method
IsWorkflowDocumentsChanged Method
IsWorkflowStatusSpeedUpWithStoredProcedureCache Method
MarkTasksAsNotNew Method
PrepareWorkflowForDocument Method
PrepareWorkflowForDocuments Method
PrepareWorkflowForSelection Method
PrepareWorkflowsToDownload Method
RaiseTaskCompletedEvent Method
RaiseTaskCompletedEventV2 Method
RaiseTaskDelegated Method
RaiseTaskOverriden Method
RemoveDocumentsFromWorkflow Method
RemoveSelectionFromWorkflow Method
RemoveWorkflowTemplate Method
RenameWorkflow Method
RestartWorkflow Method
RestoreTaskDelegation Method
RestoreWorkflowInitiators Method
SetDocumentTaskReserved Method
SetExistingWorkflowSettings Method
SetTaskReserved Method
SetUserStatusReportCriteria Method
SetUserStatusReportCriteriaPin Method
StartActivity Method
TaskCompleted Method
TaskCompletedV2 Method
TaskDelegated Method
ValidateTemplateForSchema Method
Click or drag to resize

WorkflowManagerPrepareWorkflowForDocument Method

Prepare a workflow template for the document version.

Namespace:  FileHold.LibraryManager
Assembly:  FileHold.LibraryManager (in FileHold.LibraryManager.dll) Version: 17.0.0.0
Syntax
C#
Copy
public WorkflowTemplateDefinition PrepareWorkflowForDocument(
	int workflowTemplateId,
	int documentVersionId,
	ref ADAMObject[] invalidObservers,
	ref ADAMObject[] invalidParticipants
)

Parameters

workflowTemplateId
Type: SystemInt32
documentVersionId
Type: SystemInt32
invalidObservers
Type: ADAMObject
invalidParticipants
Type: ADAMObject

Return Value

Type: WorkflowTemplateDefinition
See Also