AutomationManager Class

Class for managing the marketing automation.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractManager
    CMS.WorkflowEngine.AbstractWorkflowManager<BaseInfo, AutomationStateInfo, AutomationActionEnum>
      CMS.Automation.AbstractAutomationManager<BaseInfo>
        CMS.Automation.AutomationManager

Namespace: CMS.Automation
Assembly: CMS.Automation (in CMS.Automation.dll) Version: 8.2.23

Syntax

public class AutomationManager : AbstractAutomationManager<BaseInfo>

The AutomationManager type exposes the following members.

Constructors

	Name	Description
Public method	AutomationManager()	Obsolete. Constructor
Protected method	AutomationManager(UserInfo)	Constructor - Creates automation manager.

Methods

	Name	Description
Protected method	CreateActionArgumentsInternal	Creates action arguments. (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Protected method	CreateActionsExecutorInternal	Creates action executor with prefilled parameters. (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Protected method	EvaluateSourcePointsInternal	Evaluates source points with given macro resolver (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	EvaluateTransitions(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 AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	EvaluateTransitions(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 AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	GetActionStatus	Gets action state (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	GetActionStatusInternal	Gets action state (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	GetBasicResolverInternal	Gets basic resolver for evaluation of transitions and source points (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	GetEmailResolver	Get resolver for e-mail sending. (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	GetEmailResolverInternal	Get resolver for e-mail sending. (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	GetEvalResolverInternal	Gets resolver for evaluation of transitions and source points (Inherited from AbstractAutomationManager<InfoType>.)
Public method	GetFinishedStep	Returns finished step for given object. (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	GetFinishedStepInternal	Returns finished step for given object. (Inherited from AbstractAutomationManager<InfoType>.)
Public method	GetFirstStep	Returns start step for given object. (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	GetFirstStepInternal	Returns first step for given object. (Inherited from AbstractAutomationManager<InfoType>.)
Public method Static member	GetInstance	Gets the instance of the manager.
Protected method	GetNextStepInfoInternal	Returns list of next steps for given object. (Inherited from AbstractAutomationManager<InfoType>.)
Public method	GetNextSteps	Returns list of next steps. (Inherited from AbstractAutomationManager<InfoType>.)
Public method	GetObjectProcess	Returns the process for the specified object. (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	GetObjectProcessInternal	Returns the process for the specified object. (Inherited from AbstractAutomationManager<InfoType>.)
Public method	GetPreviousStepInfo	Returns previous step information. (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	GetPreviousStepInfoInternal	Returns previous step information for given object. (Inherited from AbstractAutomationManager<InfoType>.)
Public method	GetPreviousSteps	Returns list of previous steps for current process (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	GetPreviousStepsInternal	Returns list of previous steps for current cycle (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	GetStepInboundTransitionsInternal	Gets transitions leading into given step (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	GetStepInfo	Gets step information for given object. (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	GetStepInfoInternal	Gets step information for given object. (Inherited from AbstractAutomationManager<InfoType>.)
Public method	GetStepTransitions(WorkflowStepInfo)	Gets all workflow step transitions (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	GetStepTransitions(WorkflowStepInfo, WorkflowTransitionTypeEnum)	Gets workflow step transitions (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	GetUsersWhoCanMove(InfoType, AutomationStateInfo, SourcePoint)	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 AbstractAutomationManager<InfoType>.)
Public method	GetUsersWhoCanMove(InfoType, AutomationStateInfo, SourcePoint, Boolean, Boolean, Boolean)	Returns list of all the users who can move object to the next step. (Inherited from AbstractAutomationManager<InfoType>.)
Public method	GetUsersWhoCanMove(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 AbstractAutomationManager<InfoType>.)
Public method	GetUsersWhoCanMove(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 AbstractAutomationManager<InfoType>.)
Protected method	GetUsersWhoCanMoveInternal(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 AbstractAutomationManager<InfoType>.)
Protected method	GetUsersWhoCanMoveInternal(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 AbstractAutomationManager<InfoType>.)
Protected method	HandleStepInternal	Handles step additional actions (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Protected method	HandleStepTimeoutInternal	Handles step timeout (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Protected method	ChangeManagerType<OriginalType>	Changes the default manager type to the given type (Inherited from AbstractManager.)
Public method	ChangeManagerTypeTo	Changes the manager type to the given type (Overrides AbstractManager.ChangeManagerTypeTo(Type).)
Protected method	CheckRecurrenceInternal	Check automation process recurrence settings (Inherited from AbstractAutomationManager<InfoType>.)
Public method	CheckStepPermissions	Returns true if given user can move given object to the previous/next step. (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	CheckStepPermissionsInternal	Returns true if given user can move given object to previous/next step. (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	LogHopsReachedWarningInternal	Logs warning about maximum hops reached (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	LogMessage	Logs custom message to event log. (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Protected method	LogMessageInternal	Logs message to the event log (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Protected method	LogMissingConnectionWarningInternal	Logs warning about missing connection (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	LogProcessHistory	Logs specified action in the object workflow history record. (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	MoveStepInternal(InfoType, AutomationStateInfo, WorkflowStepInfo)	Moves the specified object to the first step without automatic transition and returns the final step. (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	MoveStepInternal(InfoType, StateInfoType, WorkflowStepInfo, UserInfo)	Moves the specified object to the first step without automatic transition in the workflow and returns the final step. (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	MoveToFinishedStep	Moves object directly to finished step. (Finishes the process without going through all the steps.) (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	MoveToFinishedStepInternal	Moves object directly to finished step. (Finishes the process without going through all the steps.) (Inherited from AbstractAutomationManager<InfoType>.)
Public method	MoveToFirstStep	Moves the specified object to the first step and returns the step. (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	MoveToFirstStepInternal	Moves the specified object to the first step and returns the step. (Inherited from AbstractAutomationManager<InfoType>.)
Public method	MoveToNextStep	Moves the specified object to the next step and returns new step. (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	MoveToNextStepInternal	Moves the specified object to the next step and returns new step. (Inherited from AbstractAutomationManager<InfoType>.)
Public method	MoveToPreviousStep(InfoType, AutomationStateInfo, String)	Moves the specified object to the previous step and returns the step. (Inherited from AbstractAutomationManager<InfoType>.)
Public method	MoveToPreviousStep(InfoType, AutomationStateInfo, WorkflowStepInfo, String)	Moves the specified object to the specified previous step and returns the step. (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	MoveToPreviousStepInternal	Moves the specified object to the previous step and returns the new step. (Inherited from AbstractAutomationManager<InfoType>.)
Public method	MoveToSpecificNextStep	Moves the specified object to the specified next step and returns workflow step. (Inherited from AbstractAutomationManager<InfoType>.)
Public method	MoveToSpecificStep	Moves the specified object to the specified step and returns workflow step. (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	MoveToSpecificStepInternal	Moves the specified object to the specified step and returns workflow step. (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	MoveToStepInternal	Moves the specified object to the specified step and returns the step. (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	ProcessActionInternal	Processes action connected to given step. (Inherited from AbstractAutomationManager<InfoType>.)
Public method	ProcessActions	Processes all actions in scope. (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Protected method	ProcessActionsInternal	Processes all actions in scope. (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	RemoveProcess	Removes process from given object. (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	RemoveProcessInternal	Removes process from given object. (Inherited from AbstractAutomationManager<InfoType>.)
Public method	SendWorkflowEmails	Sends the workflow e-mails to given recipients. (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Protected method	SendWorkflowEmailsInternal	Sends the workflow e-mails to given recipients. (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	SetActionStatus	Sets action state (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	SetActionStatusInternal	Sets action state (Inherited from AbstractAutomationManager<InfoType>.)
Public method	StartProcess	Starts process on given object. (Inherited from AbstractAutomationManager<InfoType>.)
Protected method	StartProcessInternal	Starts process on given object. (Inherited from AbstractAutomationManager<InfoType>.)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	ApplicationUrl	Application URL for macro resolver (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Protected property	CurrentHops	Number of currently processed hops (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public property	EventLogSource	Event log source name. (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public property	CheckPermissions	Indicates if step permissions should be checked when the step is moved. (Inherited from AbstractAutomationManager<InfoType>.)
Public property	MacroResolver	Macro resolver instance. (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public property	SendEmails	Indicates if notification e-mails should be sent (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public property	User	User (Inherited from AbstractAutomationManager<InfoType>.)