Class Workflow
Inheritance
Inherited Members
Namespace: Virinco.WATS.Teststand.MES
Assembly: WATS_Teststand_Support.dll
Syntax
public static class Workflow
Methods
EndTest(String, String, String, ActivityTestResult, Boolean, Boolean, out String, out WorkflowInstanceStatus, out ActivityType, out String, out String, SequenceContext, StatusEnum, String, Boolean)
Declaration
public static bool EndTest(string SerialNumber, string PartNumber, string Operation, ActivityTestResult Result, bool forceExit, bool promptOperator, out string ErrorMessage, out WorkflowInstanceStatus wfStatus, out ActivityType activityType, out string Process, out string Description, SequenceContext SeqContext, StatusEnum workflowDefinitionStatus = StatusEnum.Released, string culture = "en", bool AlwaysOnTop = true)
Parameters
Type | Name | Description |
---|---|---|
System.String | SerialNumber | |
System.String | PartNumber | |
System.String | Operation | |
Virinco.WATS.Service.MES.Contract.ActivityTestResult | Result | |
System.Boolean | forceExit | |
System.Boolean | promptOperator | |
System.String | ErrorMessage | |
Virinco.WATS.Service.MES.Contract.WorkflowInstanceStatus | wfStatus | |
Virinco.WATS.Service.MES.Contract.ActivityType | activityType | |
System.String | Process | |
System.String | Description | |
NationalInstruments.TestStand.Interop.API.SequenceContext | SeqContext | |
Virinco.WATS.Service.MES.Contract.StatusEnum | workflowDefinitionStatus | |
System.String | culture | |
System.Boolean | AlwaysOnTop |
Returns
Type | Description |
---|---|
System.Boolean |
GetCustomValue(String)
Declaration
public static object GetCustomValue(string key)
Parameters
Type | Name | Description |
---|---|---|
System.String | key |
Returns
Type | Description |
---|---|
System.Object |
GetCustomValueDbl(String)
Declaration
public static double GetCustomValueDbl(string key)
Parameters
Type | Name | Description |
---|---|---|
System.String | key |
Returns
Type | Description |
---|---|
System.Double |
Initialize(String, String, out String, Boolean, SequenceContext, StatusEnum, String, Boolean)
Declaration
public static bool Initialize(string SerialNumber, string PartNumber, out string ErrorMessage, bool promptOperator, SequenceContext SeqContext, StatusEnum workflowDefinitionStatus = StatusEnum.Released, string culture = "en", bool AlwaysOnTop = true)
Parameters
Type | Name | Description |
---|---|---|
System.String | SerialNumber | |
System.String | PartNumber | |
System.String | ErrorMessage | |
System.Boolean | promptOperator | |
NationalInstruments.TestStand.Interop.API.SequenceContext | SeqContext | |
Virinco.WATS.Service.MES.Contract.StatusEnum | workflowDefinitionStatus | |
System.String | culture | |
System.Boolean | AlwaysOnTop |
Returns
Type | Description |
---|---|
System.Boolean |
isConnected(out Boolean)
Boolean value indicating connection to MES
Declaration
public static bool isConnected(out bool isConnected)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | isConnected |
Returns
Type | Description |
---|---|
System.Boolean |
SetCustomValue(String, Object)
Declaration
public static void SetCustomValue(string key, object value)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | |
System.Object | value |
StartTest(String, String, String, Boolean, out String, out WorkflowInstanceStatus, out ActivityType, out String, out String, out Int32, out Int32, out ActivityTestResult, SequenceContext, StatusEnum, String, Boolean)
Start test operation if workflow is attached and valid to go
Declaration
public static bool StartTest(string SerialNumber, string PartNumber, string Operation, bool promptOperator, out string ErrorMessage, out WorkflowInstanceStatus wfStatus, out ActivityType activityType, out string Process, out string Description, out int testCount, out int maxFailCount, out ActivityTestResult lastTestResult, SequenceContext SeqContext, StatusEnum workflowDefinitionStatus = StatusEnum.Released, string culture = "en", bool AlwaysOnTop = true)
Parameters
Type | Name | Description |
---|---|---|
System.String | SerialNumber | Serial number |
System.String | PartNumber | Part number (optional) |
System.String | Operation | Name of Workflow Activity (Operation Type, Process/ |
System.Boolean | promptOperator | True if the API should provide user interface |
System.String | ErrorMessage | The error message if function returns false. It can also contain info if function returns true |
Virinco.WATS.Service.MES.Contract.WorkflowInstanceStatus | wfStatus | Workflow Instance StatusVirinco.WATS.Service.MES.Contract.WorkflowInstanceStatus |
Virinco.WATS.Service.MES.Contract.ActivityType | activityType | Next activity typeVirinco.WATS.Service.MES.Contract.ActivityType |
System.String | Process | Next Process |
System.String | Description | Next Process description |
System.Int32 | testCount | How many times test has been run so far (counted on EndTest) |
System.Int32 | maxFailCount | How many times test are allowed to fail |
Virinco.WATS.Service.MES.Contract.ActivityTestResult | lastTestResult | Last test result |
NationalInstruments.TestStand.Interop.API.SequenceContext | SeqContext | |
Virinco.WATS.Service.MES.Contract.StatusEnum | workflowDefinitionStatus | Witch version of workflow to use Virinco.WATS.Service.MES.Contract.StatusEnum default is Released |
System.String | culture | Culture code for wanted language (default is English, en) |
System.Boolean | AlwaysOnTop | If true, dialog is always on top |
Returns
Type | Description |
---|---|
System.Boolean | true if it is ok to start test |
Validate(String, String, out String, out WorkflowInstanceStatus, out ActivityType, out String, out String, SequenceContext, StatusEnum, String, Boolean)
Declaration
public static bool Validate(string SerialNumber, string PartNumber, out string ErrorMessage, out WorkflowInstanceStatus wfStatus, out ActivityType activityType, out string Process, out string Description, SequenceContext SeqContext, StatusEnum workflowDefinitionStatus = StatusEnum.Released, string culture = "en", bool generateImage = false)
Parameters
Type | Name | Description |
---|---|---|
System.String | SerialNumber | |
System.String | PartNumber | |
System.String | ErrorMessage | |
Virinco.WATS.Service.MES.Contract.WorkflowInstanceStatus | wfStatus | |
Virinco.WATS.Service.MES.Contract.ActivityType | activityType | |
System.String | Process | |
System.String | Description | |
NationalInstruments.TestStand.Interop.API.SequenceContext | SeqContext | |
Virinco.WATS.Service.MES.Contract.StatusEnum | workflowDefinitionStatus | |
System.String | culture | |
System.Boolean | generateImage |
Returns
Type | Description |
---|---|
System.Boolean |