Session Class Members
- Last UpdatedNov 06, 2025
- 9 minute read
The following tables list the members exposed by Session.
| Name | Description | |
|---|---|---|
  | DoAutoShiftChanges | The DoAutoShiftChanges() method performs an automatic shift change on all entities that can schedule shifts. |
| DoDailyTasks | The DoDailyTasks() method performs daily system maintenance. |
| DoHourlyTasks | The DoHourlyTasks() method performs hourly system maintenance. |
| DoMinutelyTasks | The DoMinutelyTasks() method performs system maintenance that is required every minute. |
| EndSession | The EndSession() method ends an active session and logs off any users that are logged on to entities within this session if they have not already logged off manually. |
| GetAllDBStatus | The GetAllDBStatus() method retrieves one or more database status records from the Db_Status table, as specified by the filter parameters. |
| GetDBStatus | The GetDBStatus() method retrieves all database status records from the Db_Status table, as specified by the filter parameters. |
| GetDSbySQL | The GetDSbySQL() method retrieves a new DataSet based on the SQL statement passed as a parameter. The SQL statement must be a single SELECT statement. |
| GetEntLogonList | Overloaded. The GetEntLogonList() method retrieves the entities available for control by the specified user and that are included in the specified entity list, from the Ent_Logon_List table. The list can be all the entities to which the user has access, all the entities in the user's default list, or all the entities last used by the user. If optionally filtering the results by a specific entity, this overload of the method specifies the entity by its ID. |
| GetEntLogons | Overloaded. The GetEntLogons() method retrieves entities that users are logged on to, from the Ent_Logon table. If optionally filtering the results by a specific entity, this overload of the method specifies the entity by its ID. |
| GetEnts | The GetEnts() method retrieves a list of entities that the user has logged on to, from the Ent_Logon table. |
| GetJobExecEnts | The GetJobExecEnts() method retrieves a list of all the entities that can run jobs and that the specified user is currently logged on to. |
| GetLastEntLogOnTime | Overloaded. The GetLastEntLogOnTime() method is called when a user logs on to multiple entities. The method retrieves the last logon time from the Ent_Logon table. The last logon time can be filtered by a user and/or an entity. If optionally filtering the results by a specific entity, the overload of this method specifies the entity by its ID. |
| GetModulesLicensed | The GetModulesLicensed() method returns an XML string that details which modules (options) of the product have been licensed. |
| GetOeeExecEnts | The GetOeeExecEnts() method retrieves records from Oee_Exec table of the OEE exec entities that the user has logged on to. |
| GetServerTime | The GetServerTime() method retrieves the current date and time on the database server. This method is used to synchronize clocks. |
| GetSessions | The GetSessions() method retrieves the records from the Sessn table that match the specified filter parameters. |
| GetUniqueEntsByUser | The GetUniqueEntsByUser() method retrieves the records of all unique entities from the Ent_Logon table for the specified user. |
| GetUtilExecEnts | The GetUtilExecEnts() method retrieves the records from the Util_Exec table for the utilization exec entities that the user has logged on to. |
| GetVerInfo | The GetVerInfo() method retrieves database and version information to client applications for display and possible validation checks. |
| KillStaleSessions | The KillStaleSessions() method terminates any sessions that have not been refreshed for a period of time, for example, when a client application terminates abnormally. |
| LogIn | The Login() method authenticates a user and, if successful, logs them on to a session. The UserID parameter is by reference. When used within System Platform, this must be a locally declared string. For examples, see Logging into Sessions. |
| LogOff | Overloaded. The LogOff() method logs the user off a specific entity or all entities that they are logged on to within a session. If an entity is being specified, this overload of the method specifies the entity by its ID. |
| LogOffJob | Overloaded. The LogOffJob() method logs the active user off a job and, optionally, off the entity on which the job is running. If an entity is being specified, this overload of the method specifies the entity by its ID. |
| LogOnEnt | Overloaded. The LogOnEnt() method logs the active user on to a specific entity within a session. If an entity is being specified, this overload of the method specifies the entity by its ID. |
| LogOnEntList | Overloaded. The LogOnEntList() method logs the specified user within a session on to their default entities, last saved entities, or a specified list of entities. If an entity list is being specified, this overload of the method specifies the list of entities by the list ID enumeration. |
| LogOnJob | Overloaded. The LogOnJob() method logs the active user onto the specified entity and job. If an entity is being specified, this overload of the method specifies the entity by its ID. |
| RefreshHeartbeat | The RefreshHeartbeat() method refreshes the heartbeat of an active session to avoid it being terminated automatically. |
| SaveEntList | The SaveEntList() method saves the current entities logged on to by the specified user and session as the user’s default or last saved entity list. |
| SetMiddlewareDbUser | The SetMiddlewareDbUser() method sets the db_status mw_db_user field used by audit trails based on the current database connection. |
| StartBGSession | Overloaded. The StartBGSession() method starts a background session for the background service without requiring a user to log on after creating the session. The active user for the session is instead obtained from the preconfigured system attribute for this purpose. The method checks that a license of this type is available and, if so, uses the license for this session. |
| StartSession | Overloaded. The StartSession() method starts a session of a specified client type. The method checks that a license of the specified type is available and, if so, uses the license for this session. If session information is being specified, this overload of the method returns session information via output parameters. |
| SwitchSession | The SwitchSession() method switches an authenticated user to a different active session. |
| SwitchUser | The SwitchUser() method changes the active user of a session. |
| TransferUserSession | The TransferUserSession() method transfers a user's Ent_Logon table records to a new session. |
| ValidPW | The ValidPW() method checks whether the supplied user and password is valid. |