GetSrcInvLocsTree(String,String,Nullable<Int32>,String,String,String,String,String,String,String) Method
- Last UpdatedNov 06, 2025
- 4 minute read
The GetSrcInvLocsTree() method retrieves a list of all entities identified by entities that contain items of serialized parts. This method is similar to the GetSrcInvLocs() method, except that it returns additional parent, child, and entity tree information about the entities.
For this overload of the method, the optional entity filters are identified by their entity names and site names.
'Declaration
Public Overloads Shared Function GetSrcInvLocsTree( _
ByVal entName As String, _
ByVal siteName As String, _
ByVal jobPos As Nullable(Of Integer), _
ByVal fromEntName As String, _
ByVal fromSiteName As String, _
ByVal itemId As String, _
ByVal serialNo As String, _
ByVal itemGradeDesc As String, _
ByVal woId As String, _
ByVal operId As String _
) As DataSet
'Usage
Dim entName As String
Dim siteName As String
Dim jobPos As Nullable(Of Integer)
Dim fromEntName As String
Dim fromSiteName As String
Dim itemId As String
Dim serialNo As String
Dim itemGradeDesc As String
Dim woId As String
Dim operId As String
Dim value As DataSet
value = StorageExec.GetSrcInvLocsTree(entName, siteName, jobPos, fromEntName, fromSiteName, itemId, serialNo, itemGradeDesc, woId, operId)
public static DataSet GetSrcInvLocsTree(
string entName,
string siteName,
Nullable<int> jobPos,
string fromEntName,
string fromSiteName,
string itemId,
string serialNo,
string itemGradeDesc,
string woId,
string operId
)
Parameters
- entName
- Required. Holds the name of the entity by which to filter the locations being retrieved.
- siteName
- Optional filter parameter. Holds the site name of the entity by which to filter the locations being retrieved.
- jobPos
- Optional filter parameter. Holds a job position. If the value is > 1, this indicates that jobs are running on this entity.
- fromEntName
- Optional filter parameter. Holds the name of an entity to filter the retrieved locations by movable storage entities ultimately located at this entity.
- fromSiteName
- Optional filter parameter. Holds the site name of an entity to filter the retrieved locations by movable storage entities ultimately located at this entity.
- itemId
- Optional filter parameter. Holds the ID of an item.
- serialNo
- Optional filter parameter. Holds a serial number.
- itemGradeDesc
- Optional filter parameter. Holds an item grade description.
- woId
- Optional filter parameter. Holds a work order ID.
- operId
- Optional filter parameter. Holds an operation ID.
Return Value
Returns a DataSet that contains a record for each movable and/or non-movable entity that contains inventory of serialized items. If no matching records are found, an empty DataSet is returned.
The columns of the returned DataSet are described below.
|
Column Name |
Description |
|---|---|
|
root_ent_id |
An integer that is the ID of the root entity, from the ent.ent_id column. The entity returned in this column does not have any parents. Hence, this entity is always considered as the topmost entity in the entity hierarchy. |
|
ent_id |
An integer that is the ID of the entity, from the ent.ent_id column. |
|
ent_name |
A string that is the name of the entity, from the ent.ent_name column. |
|
parent_ent_id |
An integer that is the ID of the immediate parent entity for the ent_id column retrieved, from the ent.parent_ent_id column. |
|
parent_ent_name |
A string that is the name of the parent entity, from the ent.ent_name column linked to this parent_ent_id column. |
|
child_level |
An integer that is the entity hierarchy. For example: 1 represents the top level entity, which does not have any parent; 2 represents the first child entity, whose parent is the topmost entity; 3 represents the grandchild for the topmost entity; and so on. |
|
ent_tree |
A string that represents a list of ancestor entities, from the topmost entity but excluding this entity separated by hyphen. For example: 1-101-1001 represents 1 being the topmost entity, 101 represents the child for 1, 1001 represents the child for 101, and 1001 represents the parent entity for this entity. |
|
selectable |
An integer that indicates whether this storage entity is a non-movable entity. 1 indicates that this storage entity is non-movable; otherwise, the entity is movable. |
For input parameters that are not to be included as a filter, pass a null.
If a non-null value for the work order parameter is supplied, then the entities retrieved will be limited to those directly containing inventory made by a job with this work order. If the work order contains a null value, and if the job is configured as a hard-pegged job and the user does not have the privilege to override hard pegged and linear flow, the entities retrieved will be limited to those directly containing inventory that was not made by any work order.
If a non-null value for the operation is supplied, then the entities returned will be limited to those directly containing inventory made by a job with that operation. If the operation contains a null value, and if the job is configured as a hard pegged job and the user does not have the privilege to override hard pegged and linear flow, then the entities retrieved will be limited to those directly containing inventory that was not made by any operation.
If a non-null value is supplied for the item, then the entities retrieved will be limited to those directly containing this item. If a non-null grade code is supplied as filter, then the entities retrieved will be limited to those directly containing an item of this grade. Similarly, if the serial number is supplied as filter, then the entities retrieved will be limited to those directly containing inventory with serial numbers matching the supplied serial number.
If a non-null value for from_entity is supplied, then the entities listed will be limited movable storage entities ultimately located at that (non-movable) entity. This method returns a list of all entities identified by movable storage entity.
For each case above, if movable storage entities are included in the list, so are the non-movable storage entities at which they are ultimately located.