TransferUserSession Method
- Last UpdatedNov 06, 2025
- 3 minute read
'Declaration
Public Shared Function TransferUserSession( _
ByVal userId As String, _
ByVal newSessionId As Integer, _
ByVal existingSessionId As Nullable(Of Integer) _
) As DataSet
'Usage
Dim userId As String
Dim newSessionId As Integer
Dim existingSessionId As Nullable(Of Integer)
Dim value As DataSet
value = Session.TransferUserSession(userId, newSessionId, existingSessionId)
public static DataSet TransferUserSession(
string userId,
int newSessionId,
Nullable<int> existingSessionId
)
Parameters
- userId
- Required. Holds the ID of the user whose Ent_Logon records are being transferred.
- newSessionId
- Required. Holds the ID of the session to which the user is being transferred.
- existingSessionId
- Optional. Holds the ID of the user's current session.
Return Value
Returns a DataSet that contains columns from the Ent_Logon and Ent tables. If no matching records are found for the specified input parameters, an empty DataSet is returned.
The columns of the returned DataSet are described below.
|
Column Name |
Description |
|---|---|
|
session_id |
An integer that is the session ID, from the Ent_Logon table. |
|
ent_id |
An integer that is the entity ID, from the Ent_Logon table. |
|
user_id |
A string that is the ID of the user who is logged on to each entity, from the Ent_Logon table. |
|
start_time |
A datetime that is the logon start time, from the Ent_Logon table. |
|
ent_name |
A string that is entity name, from the Ent table. |
|
cur_lab_cd |
A string that is labor code for the user, from the Ent_Logon table. |
|
pct_lab_to_apply |
A double that is the percentage of labor time, from the Ent_Logon table. |
|
cur_lab_dept_id |
A string that is the current labor department ID, from the Ent_Logon table. |
|
cur_lab_usage_log_id |
An integer that is the ID of the current active row in the Labor_Usage table, from the Ent_Logon table. |
|
cur_lab_desc |
A string that is labor description, from the labor_cat.lab_desc column. |
|
color |
An integer that indicates the background color, from the labor_cat.color column. |
|
cur_lab_dept_desc |
A string that is the current labor department description, from the labor_dept.dept_desc column. |
|
site |
An integer that is the ID of the ancestor entity that defines site of the entity, from the ent.site column. |
|
site_name |
A string that is the site name, from the site.site_name column. |
|
can_sched_jobs |
A Boolean that is a flag that indicates whether jobs can be scheduled to this entity, from the Ent table. |
|
can_run_jobs |
A Boolean that is a flag that indicates whether jobs can be run on the entity, from the Ent table. |
|
can_capture_util |
A Boolean that is a flag that indicates whether utilization data can be captured on this entity, from the Ent table. |
|
can_capture_labor |
A Boolean that is a flag that indicates whether labor data can be captured on the entity, from the Ent table. |
|
can_capture_util |
A Boolean that is a flag that indicates whether utilization data be captured on this entity, from the Ent table. |
|
can_do_dnc |
Not used. Will always return False. |
|
can_track_oee |
A Boolean that is a flag that indicates whether OEE statistics be captured on the entity, from the Ent table. |
|
can_sched_shifts |
A Boolean that is a flag that indicates whether shifts be scheduled for the entity, from the Ent table. |
|
can_store |
A Boolean that is a flag that indicates whether material can be stored at the entity, from the Ent table. |
|
can_log_data |
A Boolean that is a flag that indicates whether this entity can log data, from the Ent table. |
|
can_ship |
A Boolean that is a flag that indicates whether shipments be made from the entity, from the Ent table. |
|
can_Receive |
A Boolean that is a flag that indicates whether material be received at the entity, from the Ent table. |
|
can_copy_folders |
A Boolean that is a flag that indicates whether folders be copied at the entity, from the Ent table. |
|
cur_shift_id |
An integer that is the current shift on the entity, from the Ent table. |
|
cur_shift_start_time_utc |
A date/time that is the current shift start time on this entity, from the Ent table. |
|
cur_shift_start_time_local |
A date/time that is the current shift start time on this entity, from the Ent table. |
|
shift_desc |
A string that is the shift description, from the Ent table. |
|
last_domain_change |
A date/time that is the time domain information (job or shift) last changed, from the Ent table. |
|
tree_icon |
A string that is the graphic to use for the tree icon/image, from the Ent table. |
|
flow_diag_img |
A string that is the graphic to use for the flow diagram image, from the Ent table. |
|
identical_Job_Exec |
An integer that is the identical job execution, from the Ent table. |
|
show_in_dsp_tree |
A Boolean that is a flag that indicates whether this entity should appear in the data source plug-in tree, from the Ent table. |