MES Stateless API

SwitchSession Method

Save PDF

Save selected topic Save selected topic and subtopics Save all topics

Share to email Copy topic URL

Welcome to the MES Stateless API
Legal Information
Introduction to Stateless API Scripts in System Platform
Using the Stateless API
Fact.Common Assembly
- Overview
- Namespaces
FactMES.API.Commerce Assembly
- Overview
- Namespaces
  - FactMES.API.Commerce Namespace
FactMES.API.Core Assembly
- Overview
- Namespaces
  - FactMES.API.Core Namespace
FactMES.API.EnProd Assembly
- Overview
- Namespaces
  - FactMES.API.EnProd Namespace
FactMES.API.Labor Assembly
- Overview
- Namespaces
  - FactMES.API.Labor Namespace
    - Overview
    - Classes
FactMES.API.Prod Assembly
- Overview
- Namespaces
  - FactMES.API.Prod Namespace
FactMES.API.Quality Assembly
- Overview
- Namespaces
  - FactMES.API.Quality Namespace
FactMES.API.Util Assembly
- Overview
- Namespaces
  - FactMES.API.Util Namespace
Technical Support

TABLE OF CONTENTS

SwitchSession Method

Save PDF

Save selected topic Save selected topic and subtopics Save all topics

Share to email Copy topic URL

Last UpdatedNov 06, 2025
2 minute read

Operations and Execution
Manufacturing Execution System 2023 R2

The SwitchSession() method switches an authenticated user to a different active session.

Syntax

Visual Basic
C#

'Declaration
 
Public Shared Sub SwitchSession( _
   ByVal newSessionId As Integer, _
   ByVal userId As String, _
   ByVal userPw As String _
)

'Usage
 
Dim newSessionId As Integer
Dim userId As String
Dim userPw As String
 
Session.SwitchSession(newSessionId, userId, userPw)

public static void SwitchSession( 
   int newSessionId,
   string userId,
   string userPw
)

Parameters

newSessionId: Required. Holds the ID of the session to which the user is being switched.
userId: Required. Holds the ID of the user being switched. This user must already have logged on to an existing session and thus be authenticated.
userPw: Optional. Holds the password to authenticate the user. If the system parameter ‘Password Required for SwitchSession’ is set, then this parameter is required every time this method is invoked.

Remarks

The purpose of this method is to allow a user to easily use a different computer (and thus session) to enter data for all the entities they have already have logged on to from a different computer. This feature is applicable only from Operator clients.

The user must already have logged on to at least one session at this time and have logged on to at least one entity. The user remains logged on to all the entities that they were previously logged on to, but they are now all listed under the new session. The current user on all sessions is left unchanged.

If the userPw parameter is included, authentication will always be performed. This prevents switching sessions without password authentication for those sites that wish to operate this way. In the ‘unique passwords’ case, there is no way for the new session to know the existing user_id on the other session, so the userPw field must be included each time and the userId parameter must be the empty string. This method has no effect on the labor capture module if it is licensed, as all users are still logged on and labor hours are being captured against them.

MES Stateless API