Programming Mechworks PDM > .NET API > MwPDMApi Namespace > Workflow Class > Workflow Methods

Move a document to the current workflow state to a specific one.

Namespace: MwPDMApi
Assembly: MwPDMApi (in MwPDMApi.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

Visual Basic
Public Function WorkflowGoToState ( _ docUid As String, _ processName As String, _ stateName As String, _ Optional isLastDoc As Boolean = False, _ Optional silentMode As Boolean = True _ ) As Boolean

Visual Basic

Public Function WorkflowGoToState ( _

docUid As String, _
processName As String, _
stateName As String, _
Optional isLastDoc As Boolean = False, _
Optional silentMode As Boolean = True _
) As Boolean

C#
public bool WorkflowGoToState( string docUid, string processName, string stateName, bool isLastDoc = false, bool silentMode = true )

public bool WorkflowGoToState(

string docUid,
string processName,
string stateName,
bool isLastDoc = false,
bool silentMode = true
)

Visual C++
public: bool WorkflowGoToState( String^ docUid, String^ processName, String^ stateName, bool isLastDoc = false, bool silentMode = true )

Visual C++

public:

bool WorkflowGoToState(
String^ docUid,
String^ processName,
String^ stateName,
bool isLastDoc = false,
bool silentMode = true
)

JavaScript
function workflowGoToState(docUid, processName, stateName, isLastDoc, silentMode);

Parameters

docUid

Type: System.String
unique id of the document in workflow

processName

Type: System.String
name of the process

stateName

Type: System.String
name of the state where to jump (special values are: "WORKFLOW_BOF" to jump before the first state (ABORT condition), "WORKFLOW_EOF" to jump after the last state (APPROVED condition)

isLastDoc (Optional)

Type: System.Boolean
if TRUE the document is the last document of the group of documents assigned to the same ECO_ID, FALSE otherwise

silentMode (Optional)

Type: System.Boolean
if TRUE acts in silent mode (not ask the confirmation for the activation of the assigned state), FALSE otherwise

Return Value

TRUE if the operation succeeded, FALSE otherwise

Remarks