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 an integer that represents a bit field containing information about the currently running system. Each bit corresponds to a specific flag as defined in the bitmask below. The integer return will be a total of all of the bits that are currently active. See the example for tips on how to extract the information in this bit field. Note that the tag[System]Client/System/SystemFlags contains the same value.

FlagFlag DescriptionBit Value
Designer FlagSet if running in the Designer.1
Preview FlagSet if running in the Designer, and the Designer is in preview mode.2
Client FlagSet if running as a Client.4
Webstart FlagSet if running as a Client in Web Start mode.8
Applet FlagSet if running as a Client in Applet mode.16
Fullscreen FlagSet if running as a Client in full screen mode.32
SSL FlagSet if communication to the Gateway is encrypted with SSL.64
Mobile FlagSet if currently running a mobile-launched client.128

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.util.getSystemFlags()

  • Parameters

Nothing

  • Returns

Integer - A total of all the bits that are currently active. A full-screen Client launched from the Gateway webpage with no SSL will have a value of 44 (Fullscreen flag + Webstart Flag + Client Flag).

  • Scope

Vision Client

Code Examples
# The first part of the script takes the integer representing the system flags, converts it to bits, places it in a list, and then prints it out. 
# The second part of the script takes the list of bits, and places it in a table showing what each of the bits represent.
 
myList = []
flags = system.util.getSystemFlags()
for i in range(7,-1,-1):
	myList.insert(0, flags >> i & 1)
print myList

headers = ["Designer Flag", "Preview Flag", "Client Flag", "Webstart Flag", "Applet Flag", "Fullscreen Flag", "SSL Flag", "Mobile Flag"]
data = system.dataset.toDataSet(headers, [myList])
table = event.source.parent.getComponent("Table")
table.data = data
Keywords

system util getSystemFlags, util.getSystemFlags