Click or drag to resize
WorkflowManager Class
Class for managing the workflow procedure.
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractManager
    CMS.WorkflowEngineAbstractWorkflowManagerTreeNode, BaseInfo, WorkflowActionEnum
      CMS.DocumentEngineWorkflowManager

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 13.0.131
Syntax
C#
public class WorkflowManager : AbstractWorkflowManager<TreeNode, BaseInfo, WorkflowActionEnum>

The WorkflowManager type exposes the following members.

Constructors
  NameDescription
Public methodWorkflowManager Obsolete.
Constructor
Protected methodWorkflowManager(TreeProvider)
Constructor - Creates workflow manager.
Top
Properties
  NameDescription
Public propertyApplicationUrl
Application URL for macro resolver
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public propertyCheckPermissions
Indicates if step permissions should be checked when the step is moved.
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeCheckPermissions.)
Protected propertyCurrentHops
Number of currently processed hops
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public propertyEventLogSource
Event log source name.
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public propertyMacroResolver
Macro resolver instance.
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Protected propertyScopesOrderBy
Default scopes order by expression to handle scope priorities.
Public propertySendEmails
Indicates if notification e-mails should be sent
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public propertyTreeProvider
TreeProvider instance.
Protected propertyVersionManager
Version manager instance.
Top
Methods
  NameDescription
Public methodArchiveDocument
Archives the document, returns the last step info.
Protected methodArchiveDocumentInternal
Archives the document, returns the last step info.
Public methodCanUserManageWorkflow
Indicates if user can manage workflow.
Protected methodCanUserManageWorkflowInternal
Indicates if user can manage workflow.
Protected methodChangeManagerTypeOriginalType
Changes the default manager type to the given type
(Inherited from AbstractManager.)
Public methodChangeManagerTypeTo
Changes the manager type to the given type
(Overrides AbstractManagerChangeManagerTypeTo(Type).)
Public methodCheckStepPermissions(TreeNode, WorkflowActionEnum)
Returns true if current user can approve or reject given node in its current workflow step.
Public methodCheckStepPermissions(TreeNode, UserInfo, WorkflowActionEnum)
Returns true if given user can approve or reject given node in its current workflow step.
Protected methodCheckStepPermissionsInternal
Returns true if given user can approve or reject given node in its current workflow step.
Protected methodCreateActionArgumentsInternal(InfoType, StateInfoType, UserInfo, WorkflowStepInfo, WorkflowStepInfo, String)
Creates action arguments with prefilled parameters.
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Protected methodCreateActionArgumentsInternal(InfoType, StateInfoType, UserInfo, WorkflowStepInfo, WorkflowStepInfo, WorkflowInfo, AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType, String)
Creates action arguments.
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public methodEnsureStepInfo
Ensures workflow step for given document.
Protected methodEnsureStepInfoInternal
Ensures workflow step for given document.
Protected methodEvaluateSourcePointsInternal
Evaluates source points with given macro resolver
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public methodEvaluateTransitions(WorkflowStepInfo, UserInfo, Int32, MacroResolver)
Evaluates list of existing transitions for given workflow step and returns either one best match or multiple transitions matched
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public methodEvaluateTransitions(WorkflowStepInfo, UserInfo, Int32, MacroResolver, WorkflowTransitionTypeEnum)
Evaluates list of existing transitions for given workflow step and returns either one best match or multiple transitions matched
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public methodGetActionStatus
Gets action status
Protected methodGetActionStatusInternal
Gets action status
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeGetActionStatusInternal(InfoType, StateInfoType).)
Protected methodGetBasicResolverInternal
Gets basic resolver for evaluation of transitions and source points
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Protected methodGetCurrentStepInternal
Always gets instance of current workflow step. (Also checks document for required settings.)
Protected methodGetEditorEmailInternal
Gets the document editor e-mail
Public methodGetEmailResolver
Get resolver for e-mail sending.
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeGetEmailResolver(InfoType, StateInfoType, UserInfo, WorkflowStepInfo, WorkflowStepInfo, WorkflowInfo, String, String).)
Protected methodGetEmailResolverInternal
Get resolver for e-mail sending.
Protected methodGetEmailTemplateInternal
Gets e-mail template name and default subject to be used for given action
Protected methodGetEvalResolverInternal
Gets resolver for evaluation of transitions and source points
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeGetEvalResolverInternal(InfoType, StateInfoType, WorkflowInfo, WorkflowStepInfo, UserInfo).)
Public methodGetFirstWorkflowStep
Returns first workflow step for given node.
Protected methodGetFirstWorkflowStepInternal
Returns first workflow step for given node.
Public methodStatic memberGetInstance
Gets the instance of the manager.
Public methodGetNextStepInfo
Returns list of next steps for given node.
Protected methodGetNextStepInfoInternal(TreeNode, WorkflowStepInfo)
Returns list of next steps for given node.
Protected methodGetNextStepInfoInternal(TreeNode, BaseInfo, WorkflowStepInfo, UserInfo)
Returns list of next steps for given object.
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeGetNextStepInfoInternal(InfoType, StateInfoType, WorkflowStepInfo, UserInfo).)
Public methodGetNextSteps(TreeNode)
Returns list of next steps for given node.
Public methodGetNextSteps(TreeNode, WorkflowStepInfo)
Returns list of next steps for given node.
Public methodGetNodeWorkflow
Returns the workflow for the specified node.
Protected methodGetNodeWorkflowInternal
Returns the workflow for the specified node.
Public methodGetNodeWorkflowScope
Returns the workflow scope info for the given node, or null when the node does not support workflow.
Protected methodGetNodeWorkflowScopeInternal
Returns the workflow scope info for the given node, or null when the node does not support workflow.
Protected methodGetNotificationEmailRecipientsInternal
Gets list of user e-mail addresses to send the general notification e-mail
Protected methodGetPreviousStepInfoFromManualInboundTransitionInternal
Tries to get previous step info from manual transition leading into given step.
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Protected methodGetPreviousStepInfoInternal
Returns previous step information for given node.
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeGetPreviousStepInfoInternal(InfoType, StateInfoType, WorkflowStepInfo, Boolean).)
Public methodGetPreviousSteps
Returns list of previous steps for current workflow cycle
Protected methodGetPreviousStepsInternal
Returns list of previous steps for current workflow cycle
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeGetPreviousStepsInternal(InfoType, StateInfoType, WorkflowStepInfo).)
Public methodGetPublishedWorkflowStep
Returns published workflow step for given node.
Protected methodGetPublishedWorkflowStepInternal
Returns published workflow step for given node.
Protected methodGetStepInboundTransitionsInternal
Gets transitions leading into given step.
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public methodGetStepInfo
Gets step information for given document.
Protected methodGetStepInfoInternal
Gets step information for given document.
Public methodGetStepTransitions(WorkflowStepInfo)
Gets all workflow step transitions
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public methodGetStepTransitions(WorkflowStepInfo, WorkflowTransitionTypeEnum)
Gets workflow step transitions
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public methodGetUsersWhoCanApprove(TreeNode, SourcePoint, String, String, Int32, String)
Returns list of users who can approve node in the current workflow step. Users who are approved due to generic roles are not included to the result.
Public methodGetUsersWhoCanApprove(TreeNode, SourcePoint, Boolean, Boolean, Boolean, String, String, Int32, String)
Returns list of all the users who can approve node in the current workflow step.
Protected methodGetUsersWhoCanApproveInternal(TreeNode, SourcePoint, String, String, Int32, String)
Returns list of users who can approve node in the current workflow step. Users who are approved due to generic roles are not included to the result.
Protected methodGetUsersWhoCanApproveInternal(TreeNode, SourcePoint, Boolean, Boolean, Boolean, String, String, Int32, String)
Returns list of all the users who can approve node in the current workflow step.
Public methodGetWorkflowEmailRecipients
Gets list of user e-mail addresses to send the workflow e-mail
Protected methodGetWorkflowEmailRecipientsInternal
Gets list of user e-mail addresses to send the workflow e-mail
Protected methodHandleStepInternal
Handles step additional actions
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public methodHandleStepTimeout
Handles step timeout
Protected methodHandleStepTimeoutInternal
Handles step timeout
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Protected methodLogHopsReachedWarningInternal
Logs warning about maximum hops reached
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public methodLogMessage
Logs custom message to event log.
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Protected methodLogMessageInternal
Logs message to the event log
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Protected methodLogMissingConnectionWarningInternal
Logs warning about missing connection
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public methodLogWorkflowHistory
Logs specified action in the workflow history record.
Public methodMoveDocument
Moves the document to the next step until the given condition is satisfied, returns the last step info.
Protected methodMoveDocumentInternal
Moves the document to the next step until the given condition is satisfied, returns the last step info.
Protected methodMoveStepInternal(TreeNode, WorkflowStepInfo, String)
Moves the specified node to the first step without automatic transition in the workflow and returns the final step.
Protected methodMoveStepInternal(InfoType, StateInfoType, WorkflowStepInfo, UserInfo, String)
Moves the specified object to the first step without automatic transition in the workflow and returns the final step.
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public methodMoveToFirstStep
Moves the specified node to the first step in the workflow and returns the step.
Protected methodMoveToFirstStepInternal
Moves the specified node to the first step in the workflow and returns the step.
Public methodMoveToNextStep
Moves the specified node to the next step in the workflow and returns new step.
Protected methodMoveToNextStepInternal
Moves the specified node to the next step in the workflow and returns new step.
Public methodMoveToPreviousSpecificStep
Moves the specified node to the specified previous step in the workflow and returns the step.
Public methodMoveToPreviousStep
Moves the specified node to the previous step in the workflow and returns the step.
Protected methodMoveToPreviousStepInternal
Moves the specified node to the previous step in the workflow and returns StepID of the new step.
Public methodMoveToPublishedStep
Automatically publishes given document. (Moves document to published step.)
Protected methodMoveToPublishedStepInternal
Moves document directly to published step. (Publishes the document without going through all the steps.)
Public methodMoveToSpecificNextStep
Moves the specified node to the specified next step in the workflow and returns workflow step.
Public methodMoveToSpecificStep(TreeNode, WorkflowStepInfo, String, WorkflowTransitionTypeEnum)
Moves the specified node to the specified step in the workflow and returns workflow step.
Public methodMoveToSpecificStep(TreeNode, WorkflowStepInfo, String, Boolean, WorkflowTransitionTypeEnum)
Moves the specified node to the specified step in the workflow and returns workflow step.
Protected methodMoveToSpecificStepInternal(TreeNode, BaseInfo, WorkflowStepInfo, String, WorkflowTransitionTypeEnum, WorkflowActionEnum)
Moves the specified node to the specified step in the workflow and returns workflow step.
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeMoveToSpecificStepInternal(InfoType, StateInfoType, WorkflowStepInfo, String, WorkflowTransitionTypeEnum, ActionEnumType).)
Protected methodMoveToSpecificStepInternal(TreeNode, WorkflowStepInfo, String, Boolean, WorkflowTransitionTypeEnum, WorkflowActionEnum)
Moves the specified node to the specified step in the workflow and returns workflow step.
Protected methodMoveToStepInternal(TreeNode, WorkflowStepInfo, WorkflowStepInfo, String, WorkflowTransitionTypeEnum)
Moves the specified node to the specified step in the workflow and returns the step.
Protected methodMoveToStepInternal(TreeNode, BaseInfo, WorkflowStepInfo, WorkflowStepInfo, String, WorkflowTransitionTypeEnum, Boolean)
Moves the specified node to the specified step in the workflow and returns the step.
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeMoveToStepInternal(InfoType, StateInfoType, WorkflowStepInfo, WorkflowStepInfo, String, WorkflowTransitionTypeEnum, Boolean).)
Protected methodMoveToStepInternal(TreeNode, WorkflowStepInfo, WorkflowStepInfo, String, Boolean, WorkflowTransitionTypeEnum, Boolean)
Moves the specified node to the specified step in the workflow and returns the step.
Protected methodProcessActionInternal
Processes action connected to given step.
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeProcessActionInternal(WorkflowActionEventArgsInfoType, StateInfoType, ActionEnumType).)
Public methodProcessActions
Processes all actions in scope.
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Protected methodProcessActionsInternal
Processes all actions in scope.
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Protected methodPropagateTreeProviderInternal
Propagates tree provider
Public methodPublishDocument
Publishes the document, returns the last step info.
Protected methodPublishDocumentInternal
Publishes the document, returns the last step info.
Public methodSendWorkflowEmails(WorkflowEmailSettings)
Sends the workflow e-mails to given recipients.
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public methodSendWorkflowEmails(TreeNode, UserInfo, WorkflowStepInfo, WorkflowStepInfo, WorkflowActionEnum, String)
Sends the workflow email for the specified document node.
Protected methodSendWorkflowEmailsInternal(WorkflowEmailSettings)
Sends the workflow e-mails to given recipients.
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Protected methodSendWorkflowEmailsInternal(TreeNode, UserInfo, WorkflowStepInfo, WorkflowStepInfo, WorkflowActionEnum, String)
Sends the workflow email for the specified document node.
Public methodSetActionStatus
Sets action status
Protected methodSetActionStatusInternal
Sets action status
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeSetActionStatusInternal(InfoType, StateInfoType, String).)
Top
See Also