GetStorageLocationsByFilter(String,String,Nullable<Boolean>,String) Method
- Last UpdatedNov 06, 2025
- 3 minute read
The GetStorageLocationsByFilter() method retrieves a list of storage entities and where each one is ultimately located for the specified entity.
For this overload of the method, the entity is identified by its entity name and site name.
'Declaration
Public Overloads Shared Function GetStorageLocationsByFilter( _
ByVal entName As String, _
ByVal siteName As String, _
ByVal currentInventory As Nullable(Of Boolean), _
ByVal filter As String _
) As DataSet
'Usage
Dim entName As String
Dim siteName As String
Dim currentInventory As Nullable(Of Boolean)
Dim filter As String
Dim value As DataSet
value = StorageExec.GetStorageLocationsByFilter(entName, siteName, currentInventory, filter)
public static DataSet GetStorageLocationsByFilter(
string entName,
string siteName,
Nullable<bool> currentInventory,
string filter
)
Parameters
- entName
- Required. Holds the name of the entity.
- siteName
- Optional. Holds the site name of the entity.
- currentInventory
- Optional filter parameter. Holds a flag that specifies whether the entity is a current inventory location. The default setting is false.
- filter
Optional filter parameter. Holds a string that includes several inventory filter criteria. See Remarks for the available filter criteria.
Return Value
Returns a DataSet that contains a record for each movable and non-movable storage entity that is contained within the specified entity. The returned DataSet records also identify where each entity is ultimately located. If no matching records are found, an empty DataSet is returned.
The columns of the returned DataSet are described below.
|
Column Name |
Description |
|---|---|
|
ent_id |
An integer that is the ID of the entity that contains other movable entities located at this entity, from the Storage_Exec.ent_id column. |
|
ent_name |
A string that is the name of the entity, from the ent.ent_name column linked to the Storage_Exec.ent_id column. |
|
movable |
A Boolean that is a flag that indicates whether this entity is movable or not. |
|
located_at_ent_id |
An integer that is the ID of the storage entity where this entity is located, from the Storage_Exec.storage_ent_id column. |
|
located_at_ent_name |
A string that is the storage entity name where this entity is located, from the ent.ent_name linked to the Storage_Exec.storage_ent_id column. |
For input parameters that are not to be included as a filter, pass a null.
The following sample filter parameter string indicates the string format and the available filter criteria. Each filter criterion is enclosed by the delimiters '$'.
$item_id=$$item_desc=$$item_class_id=$$item_class_desc=$
$lot_no=$$grade_cd =$$status_cd=$$expiry_date_utc=$$wo_id=$
$oper_id=$$seq_no=$$serial_no=$$serialized_items=$
The value for each filter criterion follows the equal sign.
If the current inventory flag is set to true, and if a non-null work order and operation is supplied, then the entity list is restricted by the serial numbers produced based on the criteria below:
- If linear flow (wo.may_override_route) is enabled for this work order, and the current user accessing this method does not have a privilege to override the route, and the current job is hard pegged, then the inventory is restricted to a job that is immediately upstream to the supplied job.
- Additionally, a list of all uncompleted serial numbers for the BOM 0 item and its substitutes, and all job BOM component serial numbers located at the selected location that are flagged for inheritance at the selected operation Not a sentence.
None of the filter criteria except wo_id, oper_id, serial_no, and serialized_items from the filter string are used in the case above.
If the current inventory flag is set to false, then all non-null values in the filter string are applied to filter the DataSet.