Click or drag to resize
AutomationManager Class
Class for managing the marketing automation.
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractManager
    CMS.WorkflowEngineAbstractWorkflowManagerBaseInfo, AutomationStateInfo, AutomationActionEnum
      CMS.AutomationAbstractAutomationManagerBaseInfo
        CMS.AutomationAutomationManager

Namespace: CMS.Automation
Assembly: CMS.Automation (in CMS.Automation.dll) Version: 11.0.0
Syntax
C#
public class AutomationManager : AbstractAutomationManager<BaseInfo>

The AutomationManager type exposes the following members.

Constructors
  NameDescription
Public methodAutomationManager Obsolete.
Constructor
Protected methodAutomationManager(UserInfo)
Constructor - Creates automation 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.
(Inherited from AbstractAutomationManagerInfoType.)
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.)
Public propertySendEmails
Indicates if notification e-mails should be sent
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public propertyUser
User
(Inherited from AbstractAutomationManagerInfoType.)
Top
Methods
  NameDescription
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).)
Protected methodCheckRecurrenceInternal
Check automation process recurrence settings
(Inherited from AbstractAutomationManagerInfoType.)
Public methodCheckStepPermissions
Returns true if given user can move given object to the previous/next step.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodCheckStepPermissionsInternal
Returns true if given user can move given object to previous/next step.
(Inherited from AbstractAutomationManagerInfoType.)
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.)
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 state
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodGetActionStatusInternal
Gets action state
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodGetBasicResolverInternal
Gets basic resolver for evaluation of transitions and source points
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public methodGetEmailResolver
Get resolver for e-mail sending.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodGetEmailResolverInternal
Get resolver for e-mail sending.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodGetEvalResolverInternal
Gets resolver for evaluation of transitions and source points
(Inherited from AbstractAutomationManagerInfoType.)
Public methodGetFinishedStep
Returns finished step for given object.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodGetFinishedStepInternal
Returns finished step for given object.
(Inherited from AbstractAutomationManagerInfoType.)
Public methodGetFirstStep
Returns start step for given object.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodGetFirstStepInternal
Returns first step for given object.
(Inherited from AbstractAutomationManagerInfoType.)
Public methodStatic memberGetInstance
Gets the instance of the manager for the given user.
Protected methodGetNextStepInfoInternal
Returns list of next steps for given object.
(Inherited from AbstractAutomationManagerInfoType.)
Public methodGetNextSteps
Returns list of next steps.
(Inherited from AbstractAutomationManagerInfoType.)
Public methodGetObjectProcess
Returns the process for the specified object.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodGetObjectProcessInternal
Returns the process for the specified object.
(Inherited from AbstractAutomationManagerInfoType.)
Public methodGetPreviousStepInfo
Returns previous step information.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodGetPreviousStepInfoInternal
Returns previous step information for given object.
(Inherited from AbstractAutomationManagerInfoType.)
Public methodGetPreviousSteps
Returns list of previous steps for current process
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodGetPreviousStepsInternal
Returns list of previous steps for current cycle
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodGetStepInboundTransitionsInternal
Gets transitions leading into given step
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public methodGetStepInfo
Gets step information for given object.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodGetStepInfoInternal
Gets step information for given object.
(Inherited from AbstractAutomationManagerInfoType.)
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 methodGetUsersWhoCanMove(InfoType, AutomationStateInfo, SourcePoint, String, String, Int32, String)
Returns list of users who can move object to the next step. Users who are approved due to generic roles are not included to the result.
(Inherited from AbstractAutomationManagerInfoType.)
Public methodGetUsersWhoCanMove(InfoType, AutomationStateInfo, SourcePoint, Boolean, Boolean, Boolean, String, String, Int32, String)
Returns list of all the users who can move object to the next step.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodGetUsersWhoCanMoveInternal(InfoType, AutomationStateInfo, SourcePoint, String, String, Int32, String)
Returns list of users who can move object to the next step. Users who are approved due to generic roles are not included to the result.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodGetUsersWhoCanMoveInternal(InfoType, AutomationStateInfo, SourcePoint, Boolean, Boolean, Boolean, String, String, Int32, String)
Returns list of all the users who can move object to the next step.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodHandleStepInternal
Handles step additional actions
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
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 methodLogProcessHistory
Logs specified action in the object workflow history record.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodMoveStepInternal(InfoType, AutomationStateInfo, WorkflowStepInfo, String)
Moves the specified object to the first step without automatic transition and returns the final step.
(Inherited from AbstractAutomationManagerInfoType.)
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 methodMoveToFinishedStep
Moves object directly to finished step. (Finishes the process without going through all the steps.)
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodMoveToFinishedStepInternal
Moves object directly to finished step. (Finishes the process without going through all the steps.)
(Inherited from AbstractAutomationManagerInfoType.)
Public methodMoveToFirstStep
Moves the specified object to the first step and returns the step.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodMoveToFirstStepInternal
Moves the specified object to the first step and returns the step.
(Inherited from AbstractAutomationManagerInfoType.)
Public methodMoveToNextStep(IEnumerableAutomationStateInfoInfoType)
Moves the specified object's collection to the next step.
(Inherited from AbstractAutomationManagerInfoType.)
Public methodMoveToNextStep(InfoType, AutomationStateInfo, String, WorkflowTransitionTypeEnum)
Moves the specified object to the next step and returns new step.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodMoveToNextStepInternal
Moves the specified object to the next step and returns new step.
(Inherited from AbstractAutomationManagerInfoType.)
Public methodMoveToPreviousStep(InfoType, AutomationStateInfo, String)
Moves the specified object to the previous step and returns the step.
(Inherited from AbstractAutomationManagerInfoType.)
Public methodMoveToPreviousStep(InfoType, AutomationStateInfo, WorkflowStepInfo, String)
Moves the specified object to the specified previous step and returns the step.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodMoveToPreviousStepInternal
Moves the specified object to the previous step and returns the new step.
(Inherited from AbstractAutomationManagerInfoType.)
Public methodMoveToSpecificNextStep
Moves the specified object to the specified next step and returns workflow step.
(Inherited from AbstractAutomationManagerInfoType.)
Public methodMoveToSpecificStep
Moves the specified object to the specified step and returns workflow step.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodMoveToSpecificStepInternal
Moves the specified object to the specified step and returns workflow step.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodMoveToStepInternal
Moves the specified object to the specified step and returns the step.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodProcessActionInternal
Processes action connected to given step.
(Inherited from AbstractAutomationManagerInfoType.)
Public methodProcessActions
Processes all actions in scope.
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Protected methodProcessActionsInternal
Processes all actions in scope.
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public methodRemoveProcess
Removes process from given object.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodRemoveProcessInternal
Removes process from given object.
(Inherited from AbstractAutomationManagerInfoType.)
Public methodSendWorkflowEmails
Sends the workflow e-mails to given recipients.
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Protected methodSendWorkflowEmailsInternal
Sends the workflow e-mails to given recipients.
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public methodSetActionStatus
Sets action state
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodSetActionStatusInternal
Sets action state
(Inherited from AbstractAutomationManagerInfoType.)
Public methodStartProcess(InfoType, Int32, ObjectWorkflowTriggerInfo)
Starts process on given object.
(Inherited from AbstractAutomationManagerInfoType.)
Public methodStartProcess(IEnumerableAutomationProcessItemInfoType, Int32, ObjectWorkflowTriggerInfo)
Starts process on given objects.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodStartProcessInternal(InfoType, Int32, ObjectWorkflowTriggerInfo)
Starts process on given object.
(Inherited from AbstractAutomationManagerInfoType.)
Protected methodStartProcessInternal(IEnumerableAutomationProcessItemInfoType, Int32, ObjectWorkflowTriggerInfo)
Starts process on given object.
(Inherited from AbstractAutomationManagerInfoType.)
Top
See Also