Click or drag to resize
AbstractAutomationManagerInfoType Class
Class for managing the marketing automation.
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractManager
    CMS.WorkflowEngineAbstractWorkflowManagerInfoType, AutomationStateInfo, AutomationActionEnum
      CMS.AutomationAbstractAutomationManagerInfoType
        CMS.AutomationAutomationManager

Namespace: CMS.Automation
Assembly: CMS.Automation (in CMS.Automation.dll) Version: 12.0.0
Syntax
C#
public abstract class AbstractAutomationManager<InfoType> : AbstractWorkflowManager<InfoType, AutomationStateInfo, AutomationActionEnum>
where InfoType : BaseInfo

Type Parameters

InfoType

The AbstractAutomationManagerInfoType type exposes the following members.

Constructors
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.)
Public propertySendEmails
Indicates if notification e-mails should be sent
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public propertyUser
User
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
(Inherited from AbstractManager.)
Protected methodCheckRecurrenceInternal
Check automation process recurrence settings
Public methodCheckStepPermissions
Returns true if given user can move given object to the previous/next step.
Protected methodCheckStepPermissionsInternal
Returns true if given user can move given object to previous/next 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.)
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
Protected methodGetActionStatusInternal
Gets action state
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeGetActionStatusInternal(InfoType, StateInfoType).)
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.
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeGetEmailResolver(InfoType, StateInfoType, UserInfo, WorkflowStepInfo, WorkflowStepInfo, WorkflowInfo, String, String).)
Protected methodGetEmailResolverInternal
Get resolver for e-mail sending.
Protected methodGetEvalResolverInternal
Gets resolver for evaluation of transitions and source points
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeGetEvalResolverInternal(InfoType, StateInfoType, WorkflowInfo, WorkflowStepInfo, UserInfo).)
Public methodGetFinishedStep
Returns finished step for given object.
Protected methodGetFinishedStepInternal
Returns finished step for given object.
Public methodGetFirstStep
Returns start step for given object.
Protected methodGetFirstStepInternal
Returns first step for given object.
Protected methodGetNextStepInfoInternal
Returns list of next steps for given object.
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeGetNextStepInfoInternal(InfoType, StateInfoType, WorkflowStepInfo, UserInfo).)
Public methodGetNextSteps
Returns list of next steps.
Public methodGetObjectProcess
Returns the process for the specified object.
Protected methodGetObjectProcessInternal
Returns the process for the specified object.
Public methodGetPreviousStepInfo
Returns previous step information.
Protected methodGetPreviousStepInfoInternal
Returns previous step information for given object.
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeGetPreviousStepInfoInternal(InfoType, StateInfoType, WorkflowStepInfo, Boolean).)
Public methodGetPreviousSteps
Returns list of previous steps for current process
Protected methodGetPreviousStepsInternal
Returns list of previous steps for current cycle
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeGetPreviousStepsInternal(InfoType, StateInfoType, WorkflowStepInfo).)
Protected methodGetStepInboundTransitionsInternal
Gets transitions leading into given step
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.)
Public methodGetStepInfo
Gets step information for given object.
Protected methodGetStepInfoInternal
Gets step information for given object.
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.
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.
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.
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.
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.
Protected methodMoveStepInternal(InfoType, AutomationStateInfo, WorkflowStepInfo, String)
Moves the specified object to the first step without automatic transition 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 methodMoveToFinishedStep
Moves object directly to finished step. (Finishes the process without going through all the steps.)
Protected methodMoveToFinishedStepInternal
Moves object directly to finished step. (Finishes the process without going through all the steps.)
Public methodMoveToFirstStep
Moves the specified object to the first step and returns the step.
Protected methodMoveToFirstStepInternal
Moves the specified object to the first step and returns the step.
Public methodMoveToNextStep(IEnumerableAutomationStateInfoInfoType)
Moves the specified object's collection to the next step.
Public methodMoveToNextStep(InfoType, AutomationStateInfo, String, WorkflowTransitionTypeEnum)
Moves the specified object to the next step and returns new step.
Protected methodMoveToNextStepInternal
Moves the specified object to the next step and returns new step.
Public methodMoveToPreviousStep(InfoType, AutomationStateInfo, String)
Moves the specified object to the previous step and returns the step.
Public methodMoveToPreviousStep(InfoType, AutomationStateInfo, WorkflowStepInfo, String)
Moves the specified object to the specified previous step and returns the step.
Protected methodMoveToPreviousStepInternal
Moves the specified object to the previous step and returns the new step.
Public methodMoveToSpecificNextStep
Moves the specified object to the specified next step and returns workflow step.
Public methodMoveToSpecificStep
Moves the specified object to the specified step and returns workflow step.
Protected methodMoveToSpecificStepInternal
Moves the specified object to the specified step and returns workflow step.
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeMoveToSpecificStepInternal(InfoType, StateInfoType, WorkflowStepInfo, String, WorkflowTransitionTypeEnum, ActionEnumType).)
Protected methodMoveToStepInternal
Moves the specified object to the specified step and returns the step.
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeMoveToStepInternal(InfoType, StateInfoType, WorkflowStepInfo, WorkflowStepInfo, String, WorkflowTransitionTypeEnum, Boolean).)
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.)
Public methodRemoveProcess
Removes process from given object.
Protected methodRemoveProcessInternal
Removes process from given object.
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
Protected methodSetActionStatusInternal
Sets action state
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeSetActionStatusInternal(InfoType, StateInfoType, String).)
Public methodStartProcess(InfoType, Int32, ObjectWorkflowTriggerInfo)
Starts process on given object.
Public methodStartProcess(IEnumerableAutomationProcessItemInfoType, Int32, ObjectWorkflowTriggerInfo)
Starts process on given objects.
Protected methodStartProcessInternal(InfoType, Int32, ObjectWorkflowTriggerInfo)
Starts process on given object.
Protected methodStartProcessInternal(IEnumerableAutomationProcessItemInfoType, Int32, ObjectWorkflowTriggerInfo)
Starts process on given object.
Top
See Also