GetAll Method (JobSchedExec)
- Last UpdatedNov 06, 2025
- 3 minute read
The GetAll() method retrieves zero or more work order file records from the Job_Sched_Exec table, as specified by the filter parameters. Passing no filter parameters will retrieve all standard work order records from the table.
'Declaration
Public Shared Function GetAll( _
ByVal entId As Nullable(Of Integer), _
ByVal operType As String, _
ByVal spare1 As String, _
ByVal spare2 As String, _
ByVal spare3 As String, _
ByVal spare4 As String, _
ByVal lastEditBy As String, _
ByVal lastEditAt As Nullable(Of Date) _
) As DataSet
'Usage
Dim entId As Nullable(Of Integer)
Dim operType As String
Dim spare1 As String
Dim spare2 As String
Dim spare3 As String
Dim spare4 As String
Dim lastEditBy As String
Dim lastEditAt As Nullable(Of Date)
Dim value As DataSet
value = JobSchedExec.GetAll(entId, operType, spare1, spare2, spare3, spare4, lastEditBy, lastEditAt)
public static DataSet GetAll(
Nullable<int> entId,
string operType,
string spare1,
string spare2,
string spare3,
string spare4,
string lastEditBy,
Nullable<DateTime> lastEditAt
)
Parameters
- entId
- Optional filter parameter. Holds the ID of the entity to which the job sched exec record belongs
- operType
- Optional filter parameter. Holds the type of operation.
- spare1
- Optional filter parameter. Holds the contents of the user-defined spare1 field.
- spare2
- Optional filter parameter. Holds the contents of the user-defined spare2 field.
- spare3
- Optional filter parameter. Holds the contents of the user-defined spare3 field.
- spare4
- Optional filter parameter. Holds the contents of the user-defined spare4 field.
- lastEditBy
- Optional filter parameter. Holds the ID of a user who added or last updated a work order.
- lastEditAt
- Optional filter parameter. Holds a date/time when a work order file record was added or last updated.
Return Value
Returns a DataSet that contains all the records in the Job_Sched_Exec table that satisfy the specified filters. If no matching records are found, an empty DataSet is returned.
The columns of the returned DataSet are described below.
|
ColumnName |
Description |
|---|---|
|
ent_id |
An integer that is the ID of the entity to which the job sched exec records belongs. |
|
oper_type |
A string that is the type of operation. |
|
queue_time |
A double that is the number of hours of queue time required before a scheduled job can be started. |
|
sort_order |
A string that is sort order used on the operator client when displaying the entities queue. See Remarks for the format of this string. |
|
filtr_ |
A string that is the filter which restricts the records shown in the operator queue. See Remarks for the format of this string. |
|
ent_name |
A string that is the name of the entity (from the ent table). |
|
spare1 |
A user defined string value (may be null). |
|
spare2 |
A user defined string value (may be null). |
|
spare3 |
A user defined string value (may be null). |
|
spare4 |
A user defined string value (may be null). |
|
last_edit_comment |
A string that contains comments about why the record was added or updated. |
|
last_edit_by |
A string that is the ID of the user who added or last updated this record. |
|
last_edit_at |
A date/time that indicates when the record was added or last updated. |
For input parameters that are not to be included as a filter, pass a null.
In the returned dataset, the format of the sort_order column string is:
$SortColumn=req_finish_time_utc$$SortType=ASC$$SecondarySortColumn=job_priority$
$SecondarySortType=ASC$$TertiarySortColumn=wo_id$$TertiarySortType=ASC$
where the secondary and tertiary sort information is optional.
In the returned dataset, the format of the filtr_ column string is:
$1,2,3,4,5,6,7$$CANCELLED=0$$COMPLETED=0$$WO_ID=$
$OPER_ID=$$SEQ_NO=$$ITEM_ID=$$ITEM_DESC=$$FIRST_JOB=0$
- The first filter criterion of the format is a comma-separated list of job states. Only jobs with one of those states will be fetched. The job states are:
1 = NEW
2 = READY
3 = RUNNING
4 = COMPLETE
5 = SUSPEND
6 = ONHOLD
7 = CANCELLED
- The CANCELLED filter criterion is the number of hours old a cancelled job may be and still get fetched; 0 means fetch all cancelled jobs.
- The COMPLETED filter criterion is the number of hours old a completed job may be and still get fetched; 0 means fetch all completed jobs.
- The following parameter filter criteria can be specified: wo_id, oper_id, seq_no, item_id, and item_desc. The values for these parameters can be partial entries, specified using the % wildcard character.
- The FIRST_JOB filter criterion is a flag that, if true (1), specifies to fetch only the first jobs of the work orders.