This section contains definitions and brief descriptions about system fields.
Field name and how used | Data type | Corresponding database field required in roster? | Corresponding database field required in queue? | Corresponding database field required in event log? |
---|---|---|---|---|
F_BindPending Whether a BindToStation or BindToUser system instruction is pending for the
work item. If binding is pending, also indicates the type:
|
integer | N/A | yes | N/A |
F_BoundMachine Whether the work item is bound to a workstation or server. If the work item is bound, lists the machine ID of the binding workstation or server; 0 means that the work item is not bound. For work items processed by a web-based system, the machine ID is always -2. |
integer | N/A | yes | N/A |
F_BoundUser Whether the work item is bound to a user. If the work item is bound, lists the user ID of the binding user; 0 means that the work item is not bound. |
integer | N/A | yes, in a work queue N/A in a user queue | N/A |
F_BoundUserId The internal identifier of the user to whom a work item is bound. |
integer | N/A | N/A | yes |
F_CaseFolder The instance ID of a case folder. |
guid | no | no | no |
F_CaseTask The instance ID of a case task. |
guid | no | no | no |
F_Class The name of the work class. |
string | no | no | no |
F_Comment This field is initialized to null every time that a step starts. It allows the users participating in a step to share information about the step. For example, when a user reassigns the step, he can write a comment for the user receiving the step. |
string | N/A | no | no * |
F_CreateTime The time at which the work item was created. |
time | N/A | yes | N/A |
F_Deadline The time assigned to the step deadline. |
time | no | no | no |
F_Duration The duration of the event, such as the amount of time from the beginning to the end of an operation. Most events do not have a duration. |
integer | N/A | N/A | yes |
F_EnqueueTime The time at which the work item entered the queue or was updated in the queue. |
time | N/A | yes | no * † |
F_EventType The number of the event. See Event logging categories for more information about event numbers. |
integer | N/A | N/A | yes † |
F_InstrSheetId Whether an instruction sheet (also known as a workflow map) is currently being executed to process the work item. If so, identifies the instruction sheet; -1 means that no instruction sheet under execution for this work item. |
integer | N/A | yes | yes † |
F_InstrSheetName The name of the current instruction sheet or map. |
string | N/A | N/A | N/A |
F_LastErrorNumber The error number associated with the last exception that occurred. |
integer | N/A | N/A | N/A |
F_LastErrorText The text associated with the last exception that occurred. |
string | N/A | N/A | N/A |
F_LockedF_Locked The work item's lock status:
|
integer | N/A | yes | N/A |
F_LockMachine Whether the work item is locked. If so, lists the machine ID of the locking workstation or server; 0 means that the work item is not locked. |
integer | N/A | yes | N/A |
F_LockTime The time at which the work item was locked. |
time | N/A | yes | N/A |
F_LockUser Whether the work item is locked. If so, lists the user ID of the locking user; null means that the work item is not locked. |
integer | N/A | yes | N/A |
F_MachineId The internal identifier of a workstation or server. If the F_EventType is 125 (F_WOMilestoneMsg), this field contains the milestone level. |
integer | N/A | N/A | yes |
F_MaxMilestone The maximum milestone level for the work class. |
integer | N/A | N/A | N/A |
F_MinMilestone The minimum milestone level for the work class. |
integer | no * | no * | N/A |
F_OccurrenceId An identifier that correlates all the events that occur on a particular step. |
integer | N/A | N/A | yes † |
F_Operation The name of the operation that is either in process or (if no operation is currently in process) is next to be executed for the work item. Derived from F_OperationId. |
string | N/A | N/A | no |
F_OperationId The internal identifier of the operation that is executing the current instruction. If the F_EventType is 125 (F_WOMilestoneMsg), this field contains the milestone ID. |
integer | N/A | yes | yes † |
F_Originator The user ID of the user that started the workflow. |
integer | no * | no | no * |
F_Overdue Whether the work item is overdue:
|
integer | no | no * | no |
F_ParentWobNum The F_WobNum of the parent of this work item. |
string | N/A | N/A | yes † |
F_QueueWPClassId The ID of the queue that will store this work item. Note: This field should not be used as the first or only field for an index on a queue because the system
already uses this index internally for cases where two queues share the same physical table.
|
integer | N/A | yes | N/A |
F_Reminder The time assigned to the step reminder. |
time | no | no | no |
F_Response Transient field. It only has a value if the work item has been saved with a response. Derived from F_Responses. |
string | N/A | no | no * |
F_ResponseCount A count of the number of responses on a multi-participant step. Derived from F_Responses. |
integer | N/A | no | no |
F_Responses Lists each response in a step with a count of the number of participants choosing the response. |
integer[] | N/A | N/A | N/A |
F_SeqNumber Appended to F_TimeStamp to create a unique identifier for each event. |
integer | N/A | N/A | yes |
F_ServerId Indicates the workflow system server where the work item is currently processing. A value of -1 indicates the work item is in the local server. |
integer | yes | N/A | N/A |
F_ServerSeqNum Used to correctly sequence events between workflow system servers s in a multi-server system. |
integer | N/A | N/A | yes |
F_SortOrder An internal field used to assist in processing large queries in the correct order. |
string | N/A | yes | N/A |
F_SourceDoc The document specification of the workflow definition in an object store or library. |
string | no | no | no |
F_SplitLeg The step ID in each leg in a split or in a multi-participant step. |
integer | N/A | N/A | N/A |
F_StartTime The time the workflow was created. With the exception of the initial work item of the workflow, it is different than F_CreateTime. |
time | no * † | no | no * † |
F_StepDescription The description or instructions associated with the current step. |
string | N/A | N/A | N/A |
F_StepName The name of the step that is either in process or (if no step is currently in process) is next to be executed for the work item. |
string | N/A | N/A | N/A |
F_StepStatus The status of the step. Valid values are Complete, In progress, or Deleted. |
integer | no | no | no |
F_Subject The subject entered by the user when a workflow is launched. This field is used in the out-of-the-box Workplace application to populate the Name field on the Tasks page. |
string | no * | no * | no * |
F_Tag The work object tag, a machine-readable string form of a work object ID (a user-defined value that uniquely identifies a work item). |
string | yes | yes | yes † |
F_Text Contains user-defined text. If the F_EventType is 125 (F_WOMilestoneMsg), this field contains the milestone text. |
string | N/A | N/A | yes |
F_TimeOut The next timeout to occur for this work item, which might be a reminder or a deadline or a timeout. |
time | no | no * | no |
F_TimeStamp Indicates the time at which an event occurred. |
time | N/A | N/A | yes |
F_Trackers This field is to collect the trackers when the workflow starts; after the tracker work items are created, the field is emptied. |
string[] | N/A | N/A | N/A |
F_TrackerStatus Whether a work item is a tracker work item:
|
integer | no * † | no | no * † |
F_TransferUser The ID of the user that transferred the workflow definition to the workflow database. |
integer | N/A | N/A | N/A |
F_UniqueId A unique ID for a work item. In a queue record only, the value changes each time the work item is updated. |
float | no | no | no * † |
F_UserId The internal identifier of a user. |
integer | N/A | N/A | yes |
F_WCRevision The revision number of the work class to which the work item belongs. |
integer | N/A | N/A | yes |
F_WFDeadline The workflow deadline information. It is used to set the tracker's deadline, which corresponds to the workflow deadline. |
integer | N/A | N/A | no † |
F_WFReminder The workflow reminder information. It is used to set the tracker reminder, which corresponds to the workflow deadline. |
integer | N/A | N/A | N/A |
F_WobNum A 16-byte binary field that is actually a GUID (global unique identifier). It uniquely identifies a single work item. |
string | yes | yes | yes † |
F_WorkClassId Internal identifier of the work class to which the work item belongs. |
integer | yes | yes | yes † |
F_WorkFlowNumber The F_WobNum of the work item that initiated the workflow. |
string | no * † | no | no * † |
F_WorkOrderId Internal identifier of the current instruction. |
integer | N/A | yes | yes † |
F_WorkSpaceId The workspace used by the work item. |
integer | N/A | yes | yes † |
F_WPClassId Internal identifier of the work performer class of the queue that contains the work item. |
integer | N/A | N/A | yes |
F_WsCorrelation Web Service correlation value. This exists on in a Receive work item. |
string | N/A ‡ | N/A | N/A |
F_WsOperation Web Service operation name. |
string | N/A ‡ | N/A | N/A |
F_WsPortType Web Service port type name |
string | N/A ‡ | N/A | N/A |
N/A Not applicable
† Required by Case Analyzer
‡ Exist only when the work item is an Invoke, Receive, or Reply instruction (Ws_Correlation for Receive only) and in the WSRequest queue. The corresponding database fields are for the WSRequest queue.