GetByFilter Method (Process)
- Last UpdatedMar 17, 2026
- 4 minute read
The GetByFilter() method retrieves one or more process records from the Process table, as specified by the passed string of filter parameters. Passing no filter parameters will retrieve all process records from the table.
'Declaration
Public Shared Function GetByFilter( _
ByVal filterOption As Integer, _
ByVal processFilters As String, _
ByVal criteria As String _
) As DataSet
public static DataSet GetByFilter(
int filterOption,
string processFilters,
string criteria
)
Parameters
- filterOption
- Required. Holds an integer that specifies which columns should be included in the returned DataSet.
- processFilters
- Optional. Holds a string that contains filter criteria. Each filter criterion is enclosed by the delimiters ‘$’. See Remarks for a description of the filter criteria.
- criteria
- Optional. Holds the criteria for filtering the records to be retrieved by a specific element. The criteria will be interpreted according to the filterOption value.
Return Value
Returns a DataSet that contains all the process records in the Process table that satisfy the specified filters. If no matching records are found, an empty DataSet is returned.
The DataSet is optimized for building a tree for displaying process data.
The columns of the returned DataSet are described in the following tables, based on the filterOption value that was passed.
filterOption = 0
|
Column Name |
Description |
|---|---|
|
item_class_id |
The ID of the item class, from the Item_Class table. |
|
item_class_desc |
The description of the item class, from the Item_Class table. |
|
item_id |
The ID of the item, from the Item table. |
|
item_desc |
The description of the item, from the Item table. |
|
process_id |
The ID for this version of the process, from the Process table. |
|
process_desc |
The description of this version of the process, from the Process table. |
|
checked_out_by |
The ID of the user who currently has this version of the process checked out, from the Process table. |
filterOption = 1
|
Column Name |
Description |
|---|---|
|
process_level |
An enumeration value for the process level. |
|
process_id |
The ID for this version of the process, from the Process table. |
|
process_desc |
The description of this version of the process, from the Process table. |
|
checked_out_by |
The ID of the user who currently has this version of the process checked out, from the Process table. |
|
oper_id |
The ID of the operation for this process, from the Oper table. |
|
oper_desc |
The operation description, from the Oper table. |
filterOption = 2
|
Column Name |
Description |
|---|---|
|
process_status |
An enumeration value for the process status. |
|
process_id |
The ID for this version of the process, from the Process table. |
|
process_desc |
The description of this version of the process, from the Process table. |
|
checked_out_by |
The ID of the user who currently has this version of the process checked out, from the Process table. |
|
oper_id |
The ID of the operation for this process, from the Oper table. |
|
oper_desc |
The operation description, from the Oper table. |
filterOption = 3
|
Column Name |
Description |
|---|---|
|
process_class_id |
The ID of the process class to which the process belongs, a process class from the Process_Class table. |
|
process_id |
The ID for this version of the process, from the Process table. |
|
process_desc |
The description of this version of the process, from the Process table. |
|
checked_out_by |
The ID of the user who currently has this version of the process checked out, from the Process table. |
filterOption = 100
|
Column Name |
Description |
|---|---|
|
item_id |
The ID of the item, from the Item table. |
|
process_id |
The ID for this version of the process, from the Process table. |
|
process_desc |
The description of this version of the process, from the Process table. |
|
oper_id |
The ID of the operation for this process, from the Oper table. |
|
oper_desc |
The operation description, from the Oper table. |
|
display_seq |
The display sequence of operations, from the Oper table. |
|
checked_out_by |
The ID of the user who currently has this version of the process checked out, from the Process table. |
filterOption = 101
|
Column Name |
Description |
|---|---|
|
process_id |
The ID for this version of the process, from the Process table. |
|
oper_id |
The ID of the operation for this process, from the Oper table. |
|
oper_desc |
The operation description, from the Oper table. |
|
ent_id |
The ID of the entity on which the operation could be done, from the Oper_Ent_Link table. |
|
ent_name |
The unique name of the entity on which the operation could be done, from the Ent table. |
|
display_seq |
The display sequence of operations, from the Oper table. |
filterOption = 102
|
Column Name |
Description |
|---|---|
|
process_id |
The ID for this version of the process, from the Process table. |
|
process_desc |
The description of this version of the process, from the Process table. |
|
oper_id |
The ID of the operation for this process, from the Oper table. |
|
oper_desc |
The operation description, from the Oper table. |
|
display_seq |
The display sequence of operations, from the Oper table. |
filterOption = 1001
|
Column Name |
Description |
|---|---|
|
item_class_id |
The ID of the item class, from the Item_Class table. |
|
item_class_desc |
The description of the item class, from the Item_Class table. |
|
item_id |
The ID of the item, from the Item table. |
|
item_desc |
The description of the item, from the Item table. |
|
process_id |
The ID for this version of the process, from the Process table. |
|
process_desc |
The description of this version of the process, from the Process table. |
|
checked_out_by |
The ID of the user who currently has this version of the process checked out, from the Process table. |
The filterOption parameter is used to determine the level of information returned. The information can begin at that process class, or can be filtered down to start at that process level, operation level, etc.
An example of an empty processFilters parameter filter string is shown below.
$PROCESS_ID=$$OPER_ID=$$ENTITY=$$PROCESS_LEVEL=$$PROCESS_STATUS=$$CREATOR=$$APPROVER=$$LASTEDITOR=$$CHECKEDOUTBY=$ $SHOW_STEPS=$$SHOW_SPECS=$$($$8001=$$8002=$$)$$ICF:$$ITEM_CLASS_DESC=$$CONSUMED=$$OBSOLETE=$$($$4003=$$8144=$ $4001=$$4002=$$4003=$$8147=$$)$$IF:$$ITEM_DESC=$$UNITS=$$TEMPLATE=$$LIFETIME=$$UNIT_COST=$$OBSOLETE=$$NUM_DECIMALS=$ $($$1002=$$1003=$$1004=$$1005=$$1006=$$1001=$$8068=$$)$
The filter string is divided into three sections:
- The process filters are first;
- The item class filters, starting at the ICF: string, are next;
- The item filters, starting at the IF: string, are last.
Any attributes defined for processes, item classes, or items will appear at the end of the section enclosed in parenthesis with the attribute ID used to represent the attribute in the filter string.
The criteria string allows the returned records to be filtered even further by specifying a specific element by which to filter. For example, a specific process class for which the process records should be returned.