Class Workflow

Class that represent a workflow

Inheritance

System.Object

MesBase

Workflow

Inherited Members

MesBase.adminToken

MesBase.SetAdminCredentials(String, String)

MesBase.RESTGetJson<responseType>(String, Boolean)

MesBase.RESTPostJson<responseType>(String, Object, Boolean)

MesBase.RESTPutJson<responseType>(String, Object, Boolean)

MesBase.RESTDeleteJson<responseType>(String, Object, Boolean)

MesBase.CultureCode

MesBase.TranslateString(String, String, Object[])

MesBase.TranslateString(String, Object[])

MesBase.TranslateArray(String[])

MesBase.TranslateArray(String, String[])

MesBase.GetProcesses(Boolean, Boolean, Boolean)

MesBase.GetMesServerSettings(String[], Boolean[], Int32[], String[], String[], String[])

MesBase.GetCommonUserSettings(String)

MesBase.GetGeneralOptionString(String)

MesBase.GetGeneralOptionBool(String)

MesBase.GetGeneralOptionInt(String)

MesBase.DisplayMesTestGUI()

MesBase.GetStorageXml(String)

MesBase.GetStorageValue(String)

MesBase.PutStorageData(String, String, String)

MesBase.RemoveStorageData(String)

MesBase.RethrowException

MesBase.LastException

MesBase.LogExceptions

MesBase.Operator

MesBase.StartTraceToEventLog()

MesBase.StopTraceToEventLog()

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Virinco.WATS.Interface.MES.Workflow

Assembly: Virinco.WATS.Interface.MES.dll

Syntax

public class Workflow : MesBase

Properties

Service

For internal testing only. This property getter wil be removed in a forthcoming release!

Declaration

public IWorkflowService Service { get; }

Property Value

Type	Description
Virinco.WATS.Service.MES.Contract.IWorkflowService

Methods

AddUnit(String, String, String, String, String, Dictionary<String, Object>, StatusEnum)

Adds unit in a boxbuild

Declaration

public WorkflowResponse AddUnit(string SerialNumber, string PartNumber, string ChildSerialNumber, string ChildPartNumber, string ActivityName, Dictionary<string, object> inputValues, StatusEnum workflowDefinitionStatus)

Parameters

Type	Name	Description
System.String	SerialNumber
System.String	PartNumber
System.String	ChildSerialNumber
System.String	ChildPartNumber
System.String	ActivityName
System.Collections.Generic.Dictionary<System.String, System.Object>	inputValues
Virinco.WATS.Service.MES.Contract.StatusEnum	workflowDefinitionStatus

Returns

Type	Description
Virinco.WATS.Service.MES.Contract.WorkflowResponse

Cancel(String, String, StatusEnum)

Cancels an active workflow

Declaration

public WorkflowResponse Cancel(string SerialNumber, string PartNumber, StatusEnum workflowDefinitionStatus = StatusEnum.Released)

Parameters

Type	Name	Description
System.String	SerialNumber
System.String	PartNumber
Virinco.WATS.Service.MES.Contract.StatusEnum	workflowDefinitionStatus

Returns

Type	Description
Virinco.WATS.Service.MES.Contract.WorkflowResponse

CheckIn(String, String, String, Dictionary<String, Object>, Boolean, Boolean, StatusEnum)

Performs a Check-In on a workflow

Declaration

public WorkflowResponse CheckIn(string SerialNumber, string PartNumber, string Operation, Dictionary<string, object> inputValues, bool promptOperator = false, bool AlwaysOnTop = true, StatusEnum workflowDefinitionStatus = StatusEnum.Released)

Parameters

Type	Name	Description
System.String	SerialNumber
System.String	PartNumber
System.String	Operation
System.Collections.Generic.Dictionary<System.String, System.Object>	inputValues
System.Boolean	promptOperator
System.Boolean	AlwaysOnTop
Virinco.WATS.Service.MES.Contract.StatusEnum	workflowDefinitionStatus

Returns

Type	Description
Virinco.WATS.Service.MES.Contract.WorkflowResponse

CheckOut(String, String, String, Dictionary<String, Object>, Boolean, Boolean, StatusEnum)

Performs a Check-Out on a workflow

Declaration

public WorkflowResponse CheckOut(string SerialNumber, string PartNumber, string Operation, Dictionary<string, object> inputValues, bool promptOperator = false, bool AlwaysOnTop = true, StatusEnum workflowDefinitionStatus = StatusEnum.Released)

Parameters

Type	Name	Description
System.String	SerialNumber
System.String	PartNumber
System.String	Operation
System.Collections.Generic.Dictionary<System.String, System.Object>	inputValues
System.Boolean	promptOperator
System.Boolean	AlwaysOnTop
Virinco.WATS.Service.MES.Contract.StatusEnum	workflowDefinitionStatus

Returns

Type	Description
Virinco.WATS.Service.MES.Contract.WorkflowResponse

EndRepair(String, String, String, String, Dictionary<String, Object>, Boolean, Boolean, StatusEnum)

End repair

Declaration

public WorkflowResponse EndRepair(string SerialNumber, string PartNumber, string Operation, string UserInput, Dictionary<string, object> inputValues, bool promptOperator = false, bool AlwaysOnTop = true, StatusEnum workflowDefinitionStatus = StatusEnum.Released)

Parameters

Type	Name	Description
System.String	SerialNumber
System.String	PartNumber
System.String	Operation
System.String	UserInput
System.Collections.Generic.Dictionary<System.String, System.Object>	inputValues
System.Boolean	promptOperator
System.Boolean	AlwaysOnTop
Virinco.WATS.Service.MES.Contract.StatusEnum	workflowDefinitionStatus

Returns

Type	Description
Virinco.WATS.Service.MES.Contract.WorkflowResponse

EndTest(String, String, String, ActivityTestResult, Boolean, Dictionary<String, Object>, Boolean, Boolean, StatusEnum)

End test with result

Declaration

public WorkflowResponse EndTest(string SerialNumber, string PartNumber, string Operation, ActivityTestResult Result, bool ForceExit, Dictionary<string, object> inputValues, bool promptOperator = false, bool AlwaysOnTop = true, StatusEnum workflowDefinitionStatus = StatusEnum.Released)

Parameters

Type	Name	Description
System.String	SerialNumber
System.String	PartNumber
System.String	Operation
Virinco.WATS.Service.MES.Contract.ActivityTestResult	Result
System.Boolean	ForceExit
System.Collections.Generic.Dictionary<System.String, System.Object>	inputValues
System.Boolean	promptOperator
System.Boolean	AlwaysOnTop
Virinco.WATS.Service.MES.Contract.StatusEnum	workflowDefinitionStatus

Returns

Type	Description
Virinco.WATS.Service.MES.Contract.WorkflowResponse

Initialize(String, String, Dictionary<String, Object>, Boolean, Boolean, StatusEnum)

Initialize a workflow

Declaration

public WorkflowResponse Initialize(string SerialNumber, string PartNumber, Dictionary<string, object> inputValues, bool promptOperator = false, bool AlwaysOnTop = true, StatusEnum workflowDefinitionStatus = StatusEnum.Released)

Parameters

Type	Name	Description
System.String	SerialNumber
System.String	PartNumber
System.Collections.Generic.Dictionary<System.String, System.Object>	inputValues
System.Boolean	promptOperator
System.Boolean	AlwaysOnTop
Virinco.WATS.Service.MES.Contract.StatusEnum	workflowDefinitionStatus

Returns

Type	Description
Virinco.WATS.Service.MES.Contract.WorkflowResponse

isConnected()

True if connected to server

Declaration

public bool isConnected()

Returns

Type	Description
System.Boolean

RemoveUnit(String, String, String, String, String, Dictionary<String, Object>, StatusEnum)

Removes a sub unit

Declaration

public WorkflowResponse RemoveUnit(string SerialNumber, string PartNumber, string ChildSerialNumber, string ChildPartNumber, string ActivityName, Dictionary<string, object> inputValues, StatusEnum workflowDefinitionStatus)

Parameters

Type	Name	Description
System.String	SerialNumber
System.String	PartNumber
System.String	ChildSerialNumber
System.String	ChildPartNumber
System.String	ActivityName
System.Collections.Generic.Dictionary<System.String, System.Object>	inputValues
Virinco.WATS.Service.MES.Contract.StatusEnum	workflowDefinitionStatus

Returns

Type	Description
Virinco.WATS.Service.MES.Contract.WorkflowResponse

Resume(String, String, StatusEnum)

Resumes a suspended workflow

Declaration

public WorkflowResponse Resume(string SerialNumber, string PartNumber, StatusEnum workflowDefinitionStatus = StatusEnum.Released)

Parameters

Type	Name	Description
System.String	SerialNumber
System.String	PartNumber
Virinco.WATS.Service.MES.Contract.StatusEnum	workflowDefinitionStatus

Returns

Type	Description
Virinco.WATS.Service.MES.Contract.WorkflowResponse

Scrap(String, String, String, String, Dictionary<String, Object>, Boolean, Boolean, StatusEnum)

Scrap a unit under repair

Declaration

public WorkflowResponse Scrap(string SerialNumber, string PartNumber, string Operation, string UserInput, Dictionary<string, object> inputValues, bool promptOperator = false, bool AlwaysOnTop = true, StatusEnum workflowDefinitionStatus = StatusEnum.Released)

Parameters

Type	Name	Description
System.String	SerialNumber
System.String	PartNumber
System.String	Operation
System.String	UserInput
System.Collections.Generic.Dictionary<System.String, System.Object>	inputValues
System.Boolean	promptOperator
System.Boolean	AlwaysOnTop
Virinco.WATS.Service.MES.Contract.StatusEnum	workflowDefinitionStatus

Returns

Type	Description
Virinco.WATS.Service.MES.Contract.WorkflowResponse

StartRepair(String, String, String, String, Dictionary<String, Object>, Boolean, Boolean, StatusEnum)

Start repair

Declaration

public WorkflowResponse StartRepair(string SerialNumber, string PartNumber, string Operation, string UserInput, Dictionary<string, object> inputValues, bool promptOperator = false, bool AlwaysOnTop = true, StatusEnum workflowDefinitionStatus = StatusEnum.Released)

Parameters

Type	Name	Description
System.String	SerialNumber
System.String	PartNumber
System.String	Operation
System.String	UserInput
System.Collections.Generic.Dictionary<System.String, System.Object>	inputValues
System.Boolean	promptOperator
System.Boolean	AlwaysOnTop
Virinco.WATS.Service.MES.Contract.StatusEnum	workflowDefinitionStatus

Returns

Type	Description
Virinco.WATS.Service.MES.Contract.WorkflowResponse

StartTest(String, String, String, Dictionary<String, Object>, Boolean, Boolean, StatusEnum)

Start automated test

Declaration

public WorkflowResponse StartTest(string SerialNumber, string PartNumber, string Operation, Dictionary<string, object> inputValues, bool promptOperator = false, bool AlwaysOnTop = true, StatusEnum workflowDefinitionStatus = StatusEnum.Released)

Parameters

Type	Name	Description
System.String	SerialNumber
System.String	PartNumber
System.String	Operation
System.Collections.Generic.Dictionary<System.String, System.Object>	inputValues
System.Boolean	promptOperator
System.Boolean	AlwaysOnTop
Virinco.WATS.Service.MES.Contract.StatusEnum	workflowDefinitionStatus

Returns

Type	Description
Virinco.WATS.Service.MES.Contract.WorkflowResponse

Suspend(String, String, StatusEnum)

Suspends a workflow

Declaration

public WorkflowResponse Suspend(string SerialNumber, string PartNumber, StatusEnum workflowDefinitionStatus = StatusEnum.Released)

Parameters

Type	Name	Description
System.String	SerialNumber
System.String	PartNumber
Virinco.WATS.Service.MES.Contract.StatusEnum	workflowDefinitionStatus

Returns

Type	Description
Virinco.WATS.Service.MES.Contract.WorkflowResponse

UserInput(String, String, String, String, Dictionary<String, Object>, Boolean, Boolean, StatusEnum)

Performs a UserInput on a workflow

Declaration

public WorkflowResponse UserInput(string SerialNumber, string PartNumber, string Operation, string UserInput, Dictionary<string, object> inputValues, bool promptOperator = false, bool AlwaysOnTop = true, StatusEnum workflowDefinitionStatus = StatusEnum.Released)

Parameters

Type	Name	Description
System.String	SerialNumber
System.String	PartNumber
System.String	Operation
System.String	UserInput
System.Collections.Generic.Dictionary<System.String, System.Object>	inputValues
System.Boolean	promptOperator
System.Boolean	AlwaysOnTop
Virinco.WATS.Service.MES.Contract.StatusEnum	workflowDefinitionStatus

Returns

Type	Description
Virinco.WATS.Service.MES.Contract.WorkflowResponse

Validate(String, String, ActivityMethod, String, Dictionary<String, Object>, StatusEnum, Boolean)

Validate workflow

Declaration

public WorkflowResponse Validate(string SerialNumber, string PartNumber, ActivityMethod Method, string Name, Dictionary<string, object> inputValues, StatusEnum workflowDefinitionStatus = StatusEnum.Released, bool generateImage = false)

Parameters

Type	Name	Description
System.String	SerialNumber
System.String	PartNumber
Virinco.WATS.Service.MES.Contract.ActivityMethod	Method
System.String	Name
System.Collections.Generic.Dictionary<System.String, System.Object>	inputValues
Virinco.WATS.Service.MES.Contract.StatusEnum	workflowDefinitionStatus
System.Boolean	generateImage

Returns

Type	Description
Virinco.WATS.Service.MES.Contract.WorkflowResponse