| WoProcedureStep Class |
Procedure Steps (formerly known as Punch List Items) are attached to Procedures; they are copied from Procedure Template when it gets attached to Work Order.
Procedure Steps have specific order and get executed according to that order.
Each task is supposed to be “done” eventually; also for some steps users might need to enter additional data and/or attach documents.
Inheritance HierarchySystemObject
CorrigoService.EntitiesCorrigoEntity
CorrigoServiceCorrigoEntityWithOptimisticLock
CorrigoServiceRemovableCorrigoEntity
CorrigoService.EntitiesWoProcedureStep
CorrigoService.EntitiesCorrigoEntity
CorrigoServiceCorrigoEntityWithOptimisticLock
CorrigoServiceRemovableCorrigoEntity
CorrigoService.EntitiesWoProcedureStep
Namespace: CorrigoService.Entities
Assembly: ClientXMLDoc (in ClientXMLDoc.exe) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
[SerializableAttribute] public class WoProcedureStep : RemovableCorrigoEntity
The WoProcedureStep type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AttrDescriptor |
Asset Attribute Metadata linked to Procedure Step.
Value is required when Procedure Step type is Attribute (ProcedureStepType.Attribute), otherwise NULL.
This reference controls data type required for Procedure Step value and pick list.
If at the time of Procedure Step execution asset no longer supports specified attribute, Step will receive status N/A.
|
| Comment |
Optional comment which might be entered by user.
Max Length = 512
|
| DataLabel |
Data label; required when Step is received from WON (IsWon == True), otherwise NULL.
This field is not expected to be edited by end user.
Its value is used as replacement for Custom Field/Asset Attribute Metadata name because these are no available when Step is received from WON.
Max Length = 256
|
| DataTypeId |
Data type for Step value.
Value is required when Procedure Step type is Field or Attribute (ProcedureStepType.Attribute or ProcedureStepType.Field), otherwise NULL.
|
| DataValue |
Step value stored as free-text; must be validated according to its data type DataTypeID.
Value is required when Procedure Step type is Field or Attribute (ProcedureStepType.Attribute or ProcedureStepType.Field), otherwise NULL.
Max Length = 1024
|
| Description |
Step description.
Value is required when Step came from WON (i.e. IsWon == True), otherwise NULL.
This field is not expected to be edited by end user.
Its value is used as replacement for Custom Field/Asset Attribute Metadata name because these are no available when Step is received from WON.
Max Length = 512
|
| FieldDescriptor |
Custom Field Metadata linked to Procedure Step.
Value is required when Procedure Step type is Field (ProcedureStepType.Field), otherwise NULL.
This reference controls data type required for Procedure Step value and pick list.
|
| Flag |
Flag Reason ID.
This value always references Procedure Flag Reasons from the local database, even when Step is received from WON (IsWon == True).
Corrigo Enterprise doesn’t synchronize Procedure flags between provider and requestor.
|
| Index |
Index defining order of steps inside parent Procedure;
value is unique for specific Procedure, 1-based, values are sequential without gaps.
Only positive values are allowed.
|
| IsNotApplicable |
Boolean flag; True means Step of type Attribute can’t be executed as intended because Asset no longer supports Attribute in question or locked. This affects Step status. This field is supported only when Step type is Attribute; and it’s computed by BO under normal circumstances.
|
| IsRequired |
Boolean flag. True means Procedure won’t be “done” until this Step is “done”. True is not if Procedure Step type is Document (ProcedureStepType.Document).
|
| IsWon |
Boolean flag. True means Procedure Step was received from WON Requestor, which changes validation rules and data availability.
|
| MoneyId |
Currency type associated with DataValue.
Required when DataTypeID == DataType.Money; otherwise ignored.
|
| ProcedureTemplateStep |
Reference to Procedure Template Step from which this Procedure Step was created.
This field is required when IsWon == False, otherwise NULL.
|
| StatusId |
Status ID.
Only Open and Done statuses are supported.
For Steps of type Field and Attribute Status ID is calculated by BO; when Step type is Text it’s set by end user.
|
| TypeId |
Procedure Step type.
Type controls validation rules and data availability.
|
| WoProcedureId |
Reference to parent Procedure.
|
| WorkOrderId |
Reference to parent WO.
This field is redundant; value provided by parent Procedure.
|
See Also