IWorkflowManager Interface

Ingeniux CMS Content Store API

Represents the manager object that provides the means to query and manage Workflow Definitions, Work States, and Workflow Log entry collections.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public interface IWorkflowManager : ITransactionalEntity, 
	IDisposable

Public Interface IWorkflowManager
	Inherits ITransactionalEntity, IDisposable

public interface class IWorkflowManager : ITransactionalEntity, 
	IDisposable

type IWorkflowManager =  
    interface
        interface ITransactionalEntity
        interface IDisposable
    end

The IWorkflowManager type exposes the following members.

Properties

	Name	Description
	ContentStore	Gets the Content Store. (Inherited from ITransactionalEntity.)
	CurrentUser	Gets the Operating User for the Session . (Inherited from ITransactionalEntity.)
	Session	Gets the User Session that this manager instance was initiated from. (Inherited from ITransactionalEntity.)

Top

Methods

	Name	Description
	AddWorkflow	Adds a Page to a Workflow.
	AddWorkflowDefinition	Creates a new Workflow Definition.
	AddWorkState	Creates a new Work State. The name of the new workstate cannot match that of any existing workstates.
	CloneWorkflowsByMasterPage	Retrieves all the Workflows that belong to the the provided Page's lingual clone pages.
	DeepCloneT, TManager	Duplicates an object instance, not including its unique ID. (Inherited from ITransactionalEntity.)
	GetAttributesForWorkflowAction	Retrieves collection of required Attributes for a given Workflow Action type.
	GetInitialWorkflowDefinitionsForGroup	Retrieves all Workflow Definitions with their initial Transition's Next Group matching the given Group.
	QuickWrite	Creates a temporary Write Session to quickly write something outside the current Session and transaction. This is a way to bypass the transaction and quickly put something into the content store. (Inherited from ITransactionalEntity.)
	RemoveWorkflow	Removes a Workflow. This method will take the Page that is in this workflow out of workflow state.
	RemoveWorkflowDefinition	Removes a Workflow Definition from collection.
	RemoveWorkState	Removes a Work State from the collection.
	SerializeWorkflows
	Workflow	Retrieves a Workflow by its unique ID.
	WorkflowByPage(String)	Retrieves a Workflow by its containing Page.
	WorkflowByPage(IPage)	Retrieves a Workflow by its containing Page.
	WorkflowDefinition	Retrieves a Workflow Definition by its unique ID.
	WorkflowDefinitions(String)	Retrieves Workflow Definitions by their IDs.
	WorkflowDefinitions(Int32, Int32, Int32)	Retrieves all Workflow Definitions in a paginated fashion.
	WorkflowDefinitionsCount	Gets the count of all Workflow Definitions.
	Workflows	Retrieves the collection of Workflows in a paginated fashion. It can retrieve the entire collection or filter workflows by Workflow Definition.
	WorkflowsByPages	Retrieves an array of Workflows by the Ids of the Pages they are associated with.
	WorkflowsCount(String)	Gets the count of Workflows. It can retrieve all workflows or filter them by Workflow Definition.
	WorkflowsCount(IWorkflowDefinition)	Gets the count of Workflows. It can retrieve all workflows or filter them by Workflow Definition.
	WorkState	Gets a single Work State by its unique ID.
	WorkStateByName	Gets a single Work State by its name. Workstate names are unique to the collection.
	WorkStates	Retrieves all Work States in collection, in a paginated fashion.
	WorkStatesCount	Gets the count of all Work States.

Top

Remarks

Like all manager objects, instances of this manager are retrieved from an IUserSession object and only work within that session.

Copy

using (IUserSession session = store.OpenReadSession(currentUser))
{
       IWorkflowManager workflowManager = session.WorkflowAdministrator;
       ...
}

Examples

Serialization of the Workflow Manager matches the serialization of workflowdefinitions.xml in previous-generation CMS content:

Copy

<WorkFlowDefs>
  <WorkStates>
    <WorkState ID="WorkStates/1" Name="Initial"/>
    <WorkState ID="WorkStates/2" Name="Incomplete"/>
    <WorkState ID="WorkStates/3" Name="Complete"/>
  </WorkStates>
  <WorkFlowDefinitions>
    <WorkFlowDefinition Description="Used to track News Articles submitted through the website's entry form." ID="WorkflowDefintions/1" Name="Anonymous News Submission">
      <Transitions>
        <Transition AllowNextGroupToAdvance="false" CurrentStateID="WorkStates/1" DefaultUserID="" Description="" ID="WorkflowTransition_WorkflowDefinitions/1_1" 
            IsDefault="true" Name="Initial" NextGroupID="UserGroups/3" NextStateID="WorkStates/2" ToolbarIcon="" Trigger="OnCreate">
          <Actions NextID="1"/>
        </Transition>
        <Transition CurrentStateID="WorkStates/2" Description="" ID="WorkflowTransition_WorkflowDefinitions/33_1" IsDefault="true" Name="Initial" 
            NextGroupID="UserGroups/4" NextStateID="WorkStates/3" Trigger="OnCreate">
          <Actions NextID="4">
            <Action ID="action_1" Type="MarkForPublish"/>
            <Action ID="action_2" Type="CheckIn"/>
            <Action ID="action_3" Type="Republish"/>
          </Actions>
        </Transition>
      </Transitions>
    </WorkFlowDefinition>
  </WorkFlowDefinitions>
</WorkFlowDefs>

Reference

Ingeniux.CMS Namespace

Ingeniux.CMSIWorkflowDefinition

Ingeniux.CMSIWorkState

Ingeniux.CMSITransition

Ingeniux.CMSIAction

Ingeniux.CMSIWorkflowLogEntry