Session info

Session info* ( sessionId : Integer ) : Object

Parameter	Type		Description
sessionID	Integer	→	Session ID
Result	Object	←	Information about the session

History

Release	Changes
20 R8	Support of standalone sessions
20 R7	Added

Description

The Session info command returns an object describing the session whose ID you pass in the sessionID parameter.. If you pass an invalid sessionID, the command returns a null object.

The returned object contains the following properties:

Property	Type	Description
type	Text	Session type: "remote", "storedProcedure", "standalone"
userName	Text	4D user name (same value as Session.userName)
machineName	Text	Remote sessions: name of the remote machine. Stored procedures session: name of the server machine. Standalone session: name of the machine
systemUserName	Text	Remote sessions: name of the system session opened on the remote machine.
IPAddress	Text	IP address of the remote machine
hostType	Text	Host type: "windows" or "mac"
creationDateTime	Date ISO 8601	Date and time of session creation. Standalone session: date and time of application startup
state	Text	Session state: "active", "postponed", "sleeping"
ID	Text	Session UUID (same value as Session.id)
persistentID	Text	Remote sessions: Session's persistent ID

note

This command returns the .info property of the sessionID session. To get information about the current session, you can directly call Session.info.

Here is an example of output object:

{
    "ID": "3C81A8D7AFE64C2E9CCFFCDC35DC52F5",
    "userName": "Designer",
    "machineName": "My Computer",
    "systemUserName": "John Doe",
    "IPAddress": "localhost",
    "hostType": "mac",
    "type": "remote",
    "state": "active",
    "creationDateTime: "2024-09-10T09:55:54.787Z",
    "persistentID:"8FFDAE519F1F4DCDB81E8E8DB00AD101"
}

Example

 var $session : Object
 var $id : Integer
 $session:=Session info($id)

See also

Session class Session Session storage
Process info

Properties

Command number	1844
Thread safe	✓