User Manual

GETTING STARTED


OTHER EDITIONS


LAUNCHERS


MODULES


PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support

ALL USER MANUAL VERSIONS

Ignition 8.1. Offline Version (04/2021)
Ignition 8 Online Version
Ignition 7.9 Online Version
Ignition 7.8 Online Version

Deprecated Pages

SDK Documentation

Employees

Sign In

Skip to end of metadata
Go to start of metadata

This function is used in Python Scripting.

Description

Returns a PyDataSet holding information about all of the open Designer sessions and Vision Clients. Optional regular-expression based filters can be provided to filter the username or the username and the project returned. 

 The PyDataSet returned has these columns:

  • username (String)
  • project (String)
  • address (String)
  • isDesigner (Boolean)
  • clientId (String)
  • creationTime (Date)

This function will not return all sessions across a cluster - only the cluster node that is being communicated with by the client who makes the call.

Note: This function accepts keyword arguments.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.util.getSessionInfo([usernameFilter], [projectFilter])

  • Parameters

String usernameFilter - A regular-expression based filter string to restrict the list by username. [optional]

String projectFilter - A regular-expression based filter string to restrict the list by project. [optional]

  • ReturnsNice

PyDataset - A dataset representing the Gateway's current sessions.

  • Scope

Gateway, Vision Client, Perspective Session

Code Examples
Code Snippet
# This code gets the entire table of sessions and puts it in an adjacent table.
table = event.source.parent.getComponent("Table")
sessions = system.util.getSessionInfo()
table.data = system.db.toDataSet(sessions)
Code Snippet
# This code counts the number of times a user named "billy" is logged in.
sessions = system.util.getSessionInfo("billy")
system.gui.messageBox("Billy has %d sessions" % len(sessions))
Code Snippet
# This code returns session info on all users starting with the letters "bi".
sessions = system.util.getSessionInfo("bi.*")
Code Snippet
# This code uses a single character wildcard in the username.
sessions = system.util.getSessionInfo("bi.ly")
Code Snippet
# This code returns session info on a user named "bill.smith".
sessions = system.util.getSessionInfo("bill\.smith")
Keywords

system util getSessionInfo, util.getSessionInfo