Ignition Expression Functions

https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions
Admin
Ignition Expression Functions provide a language for defining dynamic values for component...
Tokens:1,023,573
Snippets:6,056
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Ignition Installer Command Line Arguments Reference

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/getting-started/installing-and-upgrading/command-line-installations

Detailed reference for command-line arguments supported by the Ignition installer, including their purpose, possible values, and examples for configuring installation behavior.

```APIDOC
Command Line Arguments:
- unattended:
    Description: The unattended install mode to run the installer in. It runs with all default values unless otherwise specified. The unattended upgrades remove known IA modules that are deprecated, leaves third party as they are, and upgrades currently installed bundled modules. Additionally, unattended upgrades do not trigger the Ignition service to start automatically. The Ignition service *must* be started by a user. The argument also works with the uninstaller, allowing for unattended uninstalls.
    Possible Values:
      - graphical: run with full size installer window but no interaction
      - minimal: shows a progress bar only unless errors occur
      - text: feedback on the command line only, no GUI
      - none: completely silent, no feedback except for the log file when complete regardless of success or fail
    Example: "unattended=minimal"
- textMode:
    Description: Whether to run this installer in *interactive* text mode regardless of graphical support. Note that *unattended* supersedes this value.
    Possible Values:
      - true: run in text mode
    Example: "textMode=true"
- location:
    Description: Overrides the default installation directory, allowing you to specify where Ignition should be installed.
    Possible Values: A fully qualified file path
    Example: "location=/usr/local/ignition"
- logLevel:
    Description: The logging level for the installer. The default is INFO, however more detail can be provided, revealing more information about the install process, as wells as the installer's internal operations.
    Possible Values: (from most granular to least granular): trace, debug, info, warn, error
    Example: "logLevel=trace"
- user:
    Description: Sets the ownership of the install to this user.
    Possible Values: The username (as recognized by the operating system) that should be the owner of the installation.
    Example: "user=myUser"
- serviceName:
    Description: Sets the service name for the Gateway. Defaults to "Ignition". When running the graphical installer, the service is installed immediately on Windows and set for optional future installs on Linux/Mac. When using this key with the unattended key during an upgrade, the existing service on windows will be removed, and replaced by a new service.
    Possible Values: my-gateway (custom service name)
    Example: "serviceName=my-gateway"
- autoStart:
    Description: New in 8.1.22 Boolean that specifies whether or not to automatically start the Gateway after installing or upgrading is complete. By default, clean installs will automatically start the Gateway, but upgrades will not. Will revert to default behavior if this argument is not specified.
    Possible Values:
      - true: starts the Gateway without any user input after installing/upgrading.
      - false: forces the install/upgrade to not automatically start the Gateway after install/upgrade is complete.
    Example: "autoStart=true"
```

--------------------------------

### Create New commissioning.json for Automated Setup

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/getting-started/installing-and-upgrading/zip-file-installations

This JSON snippet defines the content for a newly created `commissioning.json` file. It pre-configures the system as 'COMMISSIONING', accepts the EULA, and sets up an initial 'admin' user with a default password, allowing the Gateway to start without interactive setup.

```JSON
{
"isCommissioned": "COMMISSIONING",
"connections.useSsl": "false",
"eulaSetup.accepted": "true",
"eulaSetup.eula": "xxxxxxxxxxxxxxxxxxxxx",
"authSetup.username": "admin",
"authSetup.password": "[e811cfc7]fc3b28ad5f73331c94790129f0931437ac31d59376b0e4b15df580a8841ba165"
}
```

--------------------------------

### Run Ignition Installer in Interactive Text Mode

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/getting-started/installing-and-upgrading/command-line-installations

Commands to execute the Ignition installer in an interactive text-based mode, suitable for environments without a graphical user interface but requiring user input during the installation process.

```Windows Command Line
# Runs the installer on command line only and requires user interaction.
C:\Users\yourUser\Downloads\ignition-8.1.14-windows-x64-installer.exe --% "textMode=true"
```

```Mac Command Line
# Runs the installer on command line only and requires user interaction.
open -a /Volumes/IgnitionInstaller/ignition-8.1.14-osx-installer.app --args "textMode=true"
```

```Linux Command Line
# Runs the installer on command line only and requires user interaction."/home/yourUser/Downloads/ignition-8.1.14-linux-x64-installer.run" -- "textMode=true"
```

--------------------------------

### Example ignition.conf for Standard Edition

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/getting-started/installing-and-upgrading/zip-file-installations

This snippet provides an example of the `ignition.conf` file configured for the Standard edition of Ignition Gateway. It shows how the `-Dedition` parameter is included without a specific value for standard edition.

```Configuration
# Java Additional Parameters
wrapper.java.additional.1=-Ddata.dir=data
#wrapper.java.additional.2=-Xdebug
#wrapper.java.additional.3=-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=*:8000
wrapper.java.additional.2=-Dedition
```

--------------------------------

### Run Ignition Installer in Unattended Text Mode with Custom Location

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/getting-started/installing-and-upgrading/command-line-installations

Commands to perform an unattended installation of Ignition in text mode, allowing for automated deployment and specifying a custom installation directory without user interaction.

```Windows Command Line
# Runs the installer on command line, changes the default install directory, and uses the "text" unattended mode.
C:\Users\yourUser\Downloads\ignition-8.1.14-windows-x64-installer.exe --% "unattended=text" "location=C:\Ignition"
```

```Mac Command Line
# Runs the installer on command line, changes the default install directory, and uses the "text" unattended mode.
open -a /Volumes/IgnitionInstaller/ignition-8.1.14-osx-installer.app --args "unattended=text" "location=/Users/yourUser/Desktop/test"
```

--------------------------------

### Example ignition.conf for Edge Edition

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/getting-started/installing-and-upgrading/zip-file-installations

This snippet provides an example of the `ignition.conf` file configured for the Edge edition of Ignition Gateway. It demonstrates how the `-Dedition=edge` parameter is used to specify the edition.

```Configuration
# Java Additional Parameters
wrapper.java.additional.1=-Ddata.dir=data
#wrapper.java.additional.2=-Xdebug
#wrapper.java.additional.3=-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=*:8000
wrapper.java.additional.2=-Dedition=edge
```

--------------------------------

### Python Example: Running a Query Using Query Transactions

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-db/system-db-commitTransaction

This incomplete Python code snippet illustrates the beginning of an example that starts a database transaction and then performs update calls. It highlights the initial setup for transaction management in Ignition.

```Python
# This example starts a transaction with a 5 second timeout against the project's default database, using the default isolation level. Then it executes a series of update calls,
```

--------------------------------

### Run Ignition Installer with Unattended Text Mode and Custom Directory

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/getting-started/installing-and-upgrading/command-line-installations

This command executes the Ignition installer from the command line. It configures the installer to run in 'text' unattended mode, which means no graphical interface will be presented, and specifies a custom installation directory for the Ignition files.

```shell
"/home/yourUser/Downloads/ignition-8.1.14-linux-x64-installer.run" -- "unattended=text" "location=/home/yourUser/Desktop/test"
```

--------------------------------

### Start SFC Chart with Parameters in Python

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-sfc/system-sfc-startChart

Example Python script demonstrating how to use `system.sfc.startChart` to initiate a new SFC chart instance, passing a dictionary of variables that will be available within the chart's scope.

```Python
# The following will start an SFC with a dictionary of values to use inside the chart
args= {"var1":10, "Var2":15,"Var3":1}
path = "ChartFolder/ChartName"
sfcID = system.sfc.startChart(path, args)
```

--------------------------------

### Run Ignition installer on Linux

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/getting-started/installing-and-upgrading

After making the Ignition installer executable, you can initiate the installation process by running it from the terminal.

```bash
$ ./ignition-x.x.x-linux-x64-installer.run
```

--------------------------------

### Realtime Tag Path Example

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/tutorials/tutorials-and-helpful-tricks/scale-out-architecture-guide

An example of a realtime tag path, which is the default format for tags within a tag provider. These paths are typically used when the Front-End server accesses tag history via Gateway Network.

```Ignition Tag Path
[Sample_Tags]Realistic/Realistic0]
```

--------------------------------

### Python Example: Start SECS/GEM Simulator Event Run

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-secsgem/system-secsgem-startSimEventRun

This Python snippet demonstrates how to use `system.secsgem.startSimEventRun` to initiate a pre-configured event run within a specified SECS/GEM simulator in the Ignition Gateway. It assumes the existence of 'simulator1' and 'myEventRun' configured in the Gateway.

```Python
# This examples requires that the Gateway has a simulator named "simulator1", and
# an Event Run in that same simulator named "myEventRun".
mySimulator = "simulator1"
eventRun = "myEventRun"

system.secsgem.startSimEventRun(mySimulator, eventRun)
```

--------------------------------

### Historical Tag Path Example

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/tutorials/tutorials-and-helpful-tricks/scale-out-architecture-guide

An example of a historical tag path, which includes the database connection name, original Gateway, and original tag provider. These paths are required when the Front-End server accesses tag history directly from a database connection.

```Ignition Tag Path
[PostgreSQL/originalignition:sample_tags]realistic/realistic0]
```

--------------------------------

### Start Ignition Gateway Service on Mac OS X

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/platform/gateway/gateway-command-line-utility-gwcmd

Explains how to start the Ignition Gateway service on Mac OS X using the `ignition.sh` script, typically found in the `/usr/local/ignition/` directory for standard installations.

```Bash
/usr/local/ignition/ignition.sh start
```

--------------------------------

### Restore Gateway Backup via Command Line

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/getting-started/installing-and-upgrading/zip-file-installations

This command-line snippet shows how to restore an Ignition Gateway backup file (`.GWBK`) using the `gwcmd` utility. This is typically done after the Gateway has started up and bypassed the initial commissioning.

```Shell
gwcmd --restore /path/to/your/GWBK
```

--------------------------------

### Python Example: Get OPC HDA Servers List

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-opchda/system-opchda-getServers

This Python code snippet demonstrates how to use the `system.opchda.getServers()` function to retrieve a list of configured OPC HDA servers within an Ignition script.

```Python
# This example will get a list of OPC HDA servers
system.opchda.getServers()
```

--------------------------------

### Deploying Ignition to AWS Outposts

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/system-architectures/aws-outposts-architecture

This guide outlines the steps to deploy Inductive Automation's Ignition platform on AWS Outposts, covering network setup, EC2 instance provisioning, Ignition installation, security group configuration, and database integration.

```Procedural
1. Create a new VPC with private subnets and public subnets.
2. Set up a NAT Gateway if your EC2 instances need Internet access.
3. Spin up an EC2 instance on AWS Outposts. You can use a Windows or Linux OS. It is recommended to use Microsoft Windows Server 2019 Base or Ubuntu Server 20.04 LTS, as they are tested by Inductive Automation's Quality Assurance team. The recommended minimum specs of an EC2 instance is:
   * 4 vCPUs
   * 8 GiB Memory
4. Download and install Ignition on the EC2 instances.
5. Make sure to set up proper security groups to only allow ports 22 (SSH), 8088 (Ignition HTTP), 8043 (Ignition HTTPS), and 3306 or 5432 (database).
6. Spin up a MySQL or PostgreSQL database in RDS. You can also install a database in an EC2 instance and manage yourself. It is recommended to use RDS.
7. Connect Ignition to SQL database.
8. Build your project and have fun!
```

--------------------------------

### Example Direct Download URL for Perspective Workstation (Windows)

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/launchers-and-workstation

A concrete example demonstrating how to download the 8.1.0 version of the Perspective Workstation launcher for Windows using its direct URL.

```URL
https://files.inductiveautomation.com/launchers/8.1.0/perspectiveworkstation.exe

```

--------------------------------

### Get Installed Modules Info (system.util.getModules)

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-util

Returns a dataset of information about each installed module. This can be used to programmatically inspect the installed Ignition modules and their versions.

```APIDOC
system.util.getModules: Returns a dataset of information about each installed module.
```

--------------------------------

### Initial Java Additional Parameters in ignition.conf

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/getting-started/installing-and-upgrading/zip-file-installations

This snippet shows the default or common `wrapper.java.additional` parameters found in the `ignition.conf` file. These parameters control Java Virtual Machine settings for the Ignition Gateway.

```Configuration
# Java Additional Parameters
wrapper.java.additional.1=-Ddata.dir=data
#wrapper.java.additional.2=-Xdebug
#wrapper.java.additional.3=-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=*:8000
```

--------------------------------

### Python Example for system.gui.showTouchscreenKeyboard

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-gui/system-gui-showTouchscreenKeyboard

A Python code example demonstrating the usage of `system.gui.showTouchscreenKeyboard`, noting its backward compatibility context.

```Python
# This function is a holdover for backwards compatibility. Input components now know when the client is in Touch Screen mode and respond accordingly.
```

--------------------------------

### system.sfc.startChart API Reference

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-sfc/system-sfc-startChart

Detailed API documentation for the `system.sfc.startChart` function, including its signature, parameters, return type, and execution scopes.

```APIDOC
system.sfc.startChart(projectName: String, chartPath: String, parameters: Dictionary[String, Any])
  Description: Starts a new instance of a chart. The chart must be set to "Callable" execution mode.
  Parameters:
    projectName: The name of the project that the chart was created in.
    chartPath: The path to the chart, for example "ChartFolder/ChartName".
    parameters: A dictionary of arguments. Each key-value pair in the dictionary becomes a variable in the chart scope and will override any default.
  Returns:
    String: The unique ID of this chart.
  Scope:
    Gateway, Vision Client, Perspective Session
```

--------------------------------

### Execute Ignition Cloud Edition Installer

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/other-editions/ignition-cloud-edition/upgrading-ignition-within-cloud-services

This command runs the Ignition Cloud Edition installer. The `./` prefix indicates that the executable is located in the current directory. The installer will then guide the user through the upgrade process, prompting for the installation directory and module confirmations.

```Bash
./ignition-cloud-8.1.29-SNAPSHOT-linux-64-installer.run
```

--------------------------------

### Get Roster Names and Print to Console (Python)

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-roster/system-roster-getRosterNames

This example gets a list of rosters from the Gateway when a Button is pressed and prints the list to the browser console.

```Python
# This example gets a list of rosters from the Gateway when a Button is pressed and prints the list to the browser console.

roster = system.roster.getRosterNames()
system.perspective.print(roster)

```

--------------------------------

### Extracting Substring from Start Index

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/expression-functions/string/substring

Example demonstrating the `substring` function when only the start index is provided, extracting the remainder of the string.

```Expression Language
substring("unhappy", 2) //returns "happy"
```

--------------------------------

### Execute and Distribute Report (Initial)

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/tutorials/tutorials-and-helpful-tricks/scale-out-architecture-guide

This snippet demonstrates the basic usage of system.report.executeAndDistribute to run a report and save it. It specifies the report path, project, parameters, and action settings for saving the output.

```Python
system.report.executeAndDistribute(path="Test Report", project="Test_Project", parameters=parameters, action="save", actionSettings=settings)
```

--------------------------------

### Python Example: Get Current Date at Midnight

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-date/system-date-midnight

This Python example demonstrates how to use `system.date.midnight` to get the current date and set its time components (hour, minute, second, millisecond) to zero. It first obtains the current date and time using `system.date.now()` and then applies `system.date.midnight()` to it before printing the result.

```Python
# This example prints out the current date with the time set to midnight.

date = system.date.now()
print system.date.midnight(date)
```

--------------------------------

### Print 'Hello World' in Ignition Script Console

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/platform/scripting/scripting-in-ignition/getting-started-with-scripting

This snippet demonstrates how to print 'Hello World' using the Python Script Console in Ignition Designer. It's a basic example for testing or learning Python without needing to create UI components, providing immediate output in the Interactive Interpreter.

```Python
print 'Hello World'
```

--------------------------------

### Python Example: Get Timezone Offset for a Specific Date

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-date/system-date-getTmezoneOffset

This Python example demonstrates how to use system.date.getTimezoneOffset to find the timezone offset for a specific date (February 22, 2021) relative to UTC, based on the computer's current timezone. It shows how to get a date object and then pass it to the function.

```Python
# This example will give the time zone offset using the date February 22, 2021
# and the computers current time zone.

date = system.date.getDate(2021, 1, 22)
print system.date.getTimezoneOffset(date) # returns -8.0 (if you are in Pacific Daylight Time)

```

--------------------------------

### Pseudocode - Beginning a System Function Call

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/platform/scripting/scripting-in-ignition/getting-started-with-scripting

This snippet illustrates the initial syntax for invoking a built-in Ignition system function. It shows the 'system.' prefix, which is the starting point for accessing various system-level functionalities, often followed by autocompletion to select specific modules and functions.

```Pseudocode
system.
```

--------------------------------

### Extracting Substring with Start and End Indexes

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/expression-functions/string/substring

Example demonstrating the `substring` function with both start and end indexes, highlighting that the end index is exclusive.

```Expression Language
substring("hamburger", 4, 8) //Returns "urge" - note 8 is the index of "r", but the end index is exclusive.
```

--------------------------------

### Example: Get Raw Timezone Offset in Ignition Expression

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/expression-functions/date-and-time/getTimezoneRawOffset

An example demonstrating the usage of the `getTimezoneRawOffset()` function in Ignition's Expression language to retrieve the timezone offset.

```Ignition Expression
getTimezoneRawOffset() //Returns -8.0 if you are in the Pacific Timezone, regardless of time of year.
```

--------------------------------

### Browse Ignition OPC UA server with system.opc.browse

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-opc/system-opc-browse

This example shows how to use `system.opc.browse` to specifically browse the 'Ignition OPC UA Server' by passing the `opcServer` keyword argument.

```Python
# Browse Ignition OPC UA server

tags = system.opc.browse(opcServer="Ignition OPC UA Server")
```

--------------------------------

### Get Current Month using Ignition Expression

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/expression-functions/date-and-time/get

This example demonstrates how to use the `getMonth` function to retrieve the current month from the system's current date and time.

```Ignition Expression
getMonth(now()) //This returns the current month.
```

--------------------------------

### system.gui.desktop API Reference

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-gui/system-gui-desktop

Detailed API documentation for the `system.gui.desktop` function, including its syntax, parameters, return type, and scope within the Vision Client.

```APIDOC
system.gui.desktop(handle)

Parameters:
  handle (String): The handle for the desktop to use. The screen index cast as a string may be used instead of the handle. If omitted, this will default to the primary desktop. Alternatively, the handle "primary" can be used to refer to the primary desktop.

Returns:
  WindowUtilities: A copy of system.gui (WindowUtilities) that will be relative to the desktop named by the given handle.

Scope:
  Vision Client
```

--------------------------------

### Python Example: Starting a Transaction for Queries

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-db/system-db-closeTransaction

An example demonstrating how to initiate a database transaction with a timeout and default isolation level in Python scripting, intended for executing a series of update calls.

```Python
# This example starts a transaction with a 5 second timeout against the project's default database, using the default isolation level. Then it executes a series of update calls,
```

--------------------------------

### Browse all OPC servers with system.opc.browse

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-opc/system-opc-browse

This example demonstrates how to use `system.opc.browse` without any parameters to browse every available OPC server and print details for each returned tag, including server, item path, type, display name, display path, and data type.

```Python
# Browse every OPC server

tags = system.opc.browse()
for row in tags:
    print row.getOpcServer(), row.getOpcItemPath(), row.getType(),
    print row.getDisplayName(), row.getDisplayPath(), row.getDataType()
```

--------------------------------

### Get Quarter from Specific Date in Ignition Expression

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/expression-functions/date-and-time/get

This example shows how to use `getQuarter` to determine the quarter of a specific date (April 15th, 2017), which falls into the second quarter.

```Ignition Expression
getQuarter(getDate(2017, 3, 15)) //The date, April 15th, is in the second quarter, so this returns 2.
```

--------------------------------

### API Reference: system.secsgem.startSimEventRun

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-secsgem

Starts a configured simulator event run in the Gateway.

```APIDOC
system.secsgem.startSimEventRun
```

--------------------------------

### Download Ignition Cloud Edition Linux Installer

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/other-editions/ignition-cloud-edition/upgrading-ignition-within-cloud-services

This command downloads the Ignition Cloud Edition Linux installer from the specified URL using `wget`. The `--referer` flag is used to mimic a browser request from the Inductive Automation website, which might be required by the server. The URL is a placeholder and will vary depending on the actual link copied from the Inductive Automation downloads page.

```Bash
wget --referer https://inductiveautomation.com/* https://files.inductiveautomation.com/builds/nightly/8.1.29-SNAPSHOT/20230523-1027/ignition-cloud-8.1.29-SNAPSHOT-linux-64-installer.run
```

--------------------------------

### Python Example: Getting Desktop Handles and Printing to Console

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-gui/system-gui-getDesktopHandles

This example demonstrates how to use `system.gui.getDesktopHandles()` to retrieve a list of all secondary desktop handles (excluding the main client) and print them to the client console for debugging or inspection.

```Python
# The following example list all handles (except the main client)
# in the client console (Help -> Diagnostics -> Console)

print system.gui.getDesktopHandles()

```

--------------------------------

### Get Day of Week from Component Property in Ignition Expression

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/expression-functions/date-and-time/get

This example illustrates how to extract the day of the week from a date property bound to a UI component, specifically a calendar component, using `getDayOfWeek`.

```Ignition Expression
getDayOfWeek({Root Container.Calendar.date}) //Will return the day of the week of the selected date of the calendar component.
```

--------------------------------

### system.math.product API Reference

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-math/system-math-product

Detailed API documentation for the `system.math.product` function, including its parameters, return type, and supported scopes within the Ignition environment.

```APIDOC
system.math.product(values)

Parameters:
  values:
    Type: List[Float]
    Description: A sequence of numerical values. Accepts both integers and floats. The sequence may not contain None type values. However, passing a None type object instead of a sequence of numerical values will return NaN.

Returns:
  Type: Float
  Description: The product of all values in the values parameter, or NaN if the input was empty or null.

Scope: Gateway, Vision Client, Perspective Session
```

--------------------------------

### Example: Print Message to Gateway Logs

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-perspective/system-perspective-print

Demonstrates a basic usage of system.perspective.print to output 'Hello World' to the Ignition gateway logs. This is a common method for debugging and tracing within Ignition's scripting environment.

```Python
system.perspective.print(message="Hello World", destination="gateway")
```

--------------------------------

### Python Example: Get and Print Project Report Names

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-report/system-report-getReportNamesAsList

This Python script demonstrates how to use `system.report.getReportNamesAsList` to retrieve all report names for the current project and print them to the console. It also shows an example of the expected output format.

```Python
# Gets a list of reports for the current project and prints it.
reports = system.report.getReportNamesAsList()
for report in reports:
    print report

"""Output from the above example looks like the following:
Comparisons
Line Reports/Line 1/Defect rates
Line Reports/Line 1/Production
Line Reports/Line 2/Defect Rates
"""
```

--------------------------------

### Python Example: Populating a Table with Desktop Handles

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-gui/system-gui-getDesktopHandles

This example shows how to retrieve secondary desktop handles using `system.gui.getDesktopHandles()` and format them into a list of lists suitable for populating a table component in Ignition, with a predefined header.

```Python
# Create the header and fetch handle names
header = ["Desktop Names"]
handleList = system.gui.getDesktopHandles()

# change the handle name list into a column
handleColumn = [[name] for name in handleList]

```

--------------------------------

### Start Ignition Gateway Service on macOS

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/platform/gateway

This snippet provides the command to start the Ignition Gateway service on macOS using the "ignition.sh" script from the installation directory.

```Shell
/usr/local/ignition/ignition.sh start
```

--------------------------------

### Perform Asynchronous HTTP GET Request with Jython

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-net/system-net-httpClient

This example shows how to send a non-blocking GET request using getAsync and continue execution while waiting for the response. It then demonstrates how to block and retrieve the response using promise.get() and process it if successful.

```Jython
client = system.net.httpClient()

# Send a non-blocking request to an endpoint that will wait 3 seconds.
promise = client.getAsync("https://httpbin.org/delay/3", params={"a": 1, "b": 2})

# This will print before we get a response from the endpoint.
print "doing something while waiting..."
# do more work here...

# After the work on the previous lines, we can now block and wait for a response.
response = promise.get()
if response.good:
    print response.json['args']['a']
```

--------------------------------

### Initialize and Push Git Repository

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/tutorials/ignition-8-deployment-best-practices

This command sequence initializes a new Git repository, adds a remote origin, stages all current files, performs an initial commit with a message, and pushes the committed changes to the 'main' branch of the remote repository. Replace URL, TOKEN, and PROJECT with your repository details.

```bash
git init git remote add origin http(s)://root:TOKEN@URL/root/PROJECT.git git add . git commit -m "Initial commit" git push -u origin main
```

--------------------------------

### system.nav.desktop API Reference

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-nav/system-nav-desktop

Detailed API documentation for the `system.nav.desktop` function, including its syntax, parameters, return type, and scope within the Vision Client.

```APIDOC
system.nav.desktop(handle)

Parameters:
  handle:
    Type: String
    Description: The handle for the desktop to use. May be omitted for the primary desktop. [optional]

Returns:
  Type: INavUtilities
  Description: A copy of system.nav (INavUtilities) that will alter the desktop named by the given handle.

Scope:
  Vision Client
```

--------------------------------

### Perform Synchronous HTTP GET Request with Jython

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-net/system-net-httpClient

This example demonstrates how to create an httpClient instance and send a synchronous GET request to a specified URL with parameters. It then validates the response and prints a specific argument from the JSON response if the request was successful.

```Jython
# Create the JythonHttpClient.
client = system.net.httpClient()

# Sent a GET request.
response = client.get("https://httpbin.org/get", params={"a": 1, "b": 2})

# Validate the response.
if response.good:
    # Do something with the response
    print response.json['args']['a']
```

--------------------------------

### Initial Docker Run Command for Ignition Gateway

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/platform/docker-image

This command initializes an Ignition Gateway container named 'example-gw' with a data volume, standard edition, EULA acceptance, admin password, and port mapping. It uses Ignition version 8.1.25.

```bash
docker run --name example-gw -v example-gw-data:/usr/local/bin/ignition/data \
    -e IGNITION_EDITION=standard -e ACCEPT_IGNITION_EULA=Y -e GATEWAY_ADMIN_PASSWORD=password \
    -p 8088:8088 \
    inductiveautomation/ignition:8.1.25 \
    -n example-gw
```

--------------------------------

### Manage Ignition Service on Windows, Mac, and Linux

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/getting-started/installing-and-upgrading

Provides terminal commands to manually start, stop, and restart the Ignition service on various operating systems after installation. These commands are specific to Windows, Mac, and Linux environments.

```Windows Command Prompt
## The examples below assume "Ignition" is the service named used during installation
## (which also happens to be the default service name).
## You may need to modify the examples below using your system's service name.

net start Ignition
net stop Ignition
```

```Bash
/usr/local/ignition/ignition.sh start
/usr/local/ignition/ignition.sh stop
/usr/local/ignition/ignition.sh restart
```

```Linux Shell
## The examples below use the default installation directory

/usr/local/bin/ignition/ignition.sh start
/usr/local/bin/ignition/ignition.sh stop
/usr/local/bin/ignition/ignition.sh restart
```

--------------------------------

### system.nav.goHome() API Reference

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-nav/system-nav-goHome

API documentation for the `system.nav.goHome()` function, detailing its signature, parameters, return type, and execution scope within the Ignition Vision Client.

```APIDOC
system.nav.goHome()

Parameters:
  Nothing

Returns:
  Window - A reference to window that was navigated to.

Scope:
  Vision Client
```

--------------------------------

### Python Example: Get Mode from a List of Values

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-math/system-math-mode

This example demonstrates how to use the system.math.mode function in Python scripting to find the most frequent value(s) in a given list of numbers. It shows how to create a list, call the function, and print the first mode found.

```Python
# Create a list of values.
values = [3.5, 5.6, 7.8, 7.4, 7.8]

# Return the most common values.
modes = system.math.mode(values)

# Print the first item in the result.
print modes[0]
```

--------------------------------

### Example: Configuring Multiple Outgoing Gateway Network Hosts

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/ignition-modules/enterprise-administration/agent-management/automated-agent-installation

Illustrates how to define multiple outgoing Gateway Network connections by assigning unique numerical identifiers to each host setting in the `init.properties` file.

```Configuration Properties
gateway.network.0.Host=10.20.11.18
gateway.network.1.Host=10.20.15.23
```

--------------------------------

### Python Examples for system.util.getSessionInfo

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-util/system-util-getSessionInfo

Various Python code examples demonstrating how to use the `system.util.getSessionInfo` function to retrieve and filter session information, including getting all sessions, counting sessions for a specific user, and using regular expressions for filtering.

```Python
# This code would get the entire table of sessions and put it in an adjacent table
table = event.source.parent.getComponent("Table")
sessions = system.util.getSessionInfo()
table.data = system.db.toDataSet(sessions)

```

```Python
# This code would count 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))

```

```Python
# This code would return session info on all users starting with the letters "bi"
sessions = system.util.getSessionInfo("bi.*")

```

```Python
# This code uses a single character wildcard in the username
sessions = system.util.getSessionInfo("bi.ly")

```

```Python
# This code would return session info on a user named "bill.smith"
sessions = system.util.getSessionInfo("bill\.smith")

```

--------------------------------

### Open a new desktop with specified windows, title, and handle

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/ignition-modules/vision/common-tasks-in-vision/multi-monitor-clients

Illustrates how to open a new desktop and immediately load specific windows into it, while also assigning a custom title and a unique handle for easier programmatic reference. This is the recommended approach for opening functional secondary desktops.

```Python
#Create a list of window paths to open in the new desktop
windowToOpen = ["Main Window"]

#Defines a name for the Desktop, which will be used as both the the title and handle of the window.
name = "Secondary Desktop"

#Creates a new desktop. The desktop will open the windows listed above.
system.gui.openDesktop(windows=windowToOpen, title=name, handle=name)
```

--------------------------------

### Example: Get Oldest Alarm Time from Table Dataset

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/expression-functions/aggregates/minDate

This example demonstrates how to use the `minDate` expression function to retrieve the earliest 'AlarmTime' from a dataset located in a Table component within an Ignition project. It targets a specific column in the dataset.

```Ignition Expression
minDate({Root Container.Table.data}, "AlarmTime") //You could use this expression to get the date and time for the oldest alarm
```

--------------------------------

### Add Edition Selection Parameter to ignition.conf

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/getting-started/installing-and-upgrading/zip-file-installations

This configuration snippet demonstrates how to explicitly set the Ignition Gateway edition (e.g., 'edge', 'maker', or 'standard') by adding a `wrapper.java.additional` parameter to the `ignition.conf` file. This bypasses the interactive edition selection during installation.

```Configuration
wrapper.java.additional.2=-Dedition=%value%
```

--------------------------------

### Python Example: Get Raw Timezone Offset

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-date/system-date-getTimezoneRawOffset

This Python example demonstrates how to use `system.date.getTimezoneRawOffset()` to retrieve the current computer's raw timezone offset from UTC, without considering daylight savings. It prints the resulting double value, for instance, -8.0 for the Pacific Timezone.

```Python
# This example will give the Raw timezone offset (ignoring daylight savings) for the computers current timezone.

print system.date.getTimezoneRawOffset() # returns -8.0 (if you are in the Pacific Timezone)
```

--------------------------------

### system.perspective.download API Reference

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-perspective/system-perspective-download

Detailed API documentation for the system.perspective.download function, outlining its parameters, their types and descriptions, return values, and the applicable scope.

```APIDOC
system.perspective.download(
  filename: String,
  data: String | byte[] | InputStream,
  contentType: String (optional),
  sessionId: String (optional),
  pageId: String (optional)
)

Parameters:
  filename (String): Suggested name for the downloaded file.
  data (String | byte[] | InputStream): The data to be downloaded. Strings will be written in UTF-8 encoding.
  contentType (String, optional): Value for the "Content-Type" header, for example: "text/plain; charset=utf-8".
  sessionId (String, optional): Identifier of the Session to target. If omitted, the current Session will be used automatically. When targeting a different session, then the pageId parameter must be included in the call.
  pageId (String, optional): Identifier of the page to target. If omitted, the current page will be used automatically.

Returns: Nothing

Scope: Perspective Session
```

--------------------------------

### Create IBM DB2 Database on Windows Command Line

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/platform/database-connections/installing-databases/installing-ibm-db2

This snippet outlines the sequence of commands to open the DB2 Command Line Tool and Processor, and then execute an SQL command to create a new database. Ensure Command Prompt is run with administrator privileges.

```Shell
db2cmd
db2
```

```SQL
CREATE DATABASE database_name
```

--------------------------------

### ControlNet Connection Path Example: PLC5 via ControlLogix Gateway

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/ignition-modules/opc-ua/opc-ua-drivers/allen-bradley-ethernet/allen-bradley-connection-paths

Illustrates a specific connection path (1,4,2,12,1,0) for connecting to a PLC5 through a ControlNet module. This example clarifies the meaning of each number in the context of a setup involving a ControlLogix Gateway and a ControlNet module routing to a processor.

```APIDOC
Example Connection Path: 1,4,2,12,1,0 (PLC 1 to PLC 2)
  1: Move out of ENBT Module to the backplane.
  4: Move to ControlNet Module in Slot 4.
  2: Move out ControlNet Port.
  12: Move in ControlNet Module at ControlNet Address 12.
  1: Move out of ControlNet to the backplane.
  0: Move to the Processor in Slot 0.
```

--------------------------------

### API Reference: system.secsgem.copyEquipment

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-secsgem

Creates a copy of an equipment connection.

```APIDOC
system.secsgem.copyEquipment
```

--------------------------------

### Python Example: Get Default Printer Name

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-print/system-print-getDefaultPrinterName

This Python code snippet demonstrates how to use the `system.print.getDefaultPrinterName()` function to retrieve the name of the local default printer.

```Python
# This code will return the name of the local default printer.
system.print.getDefaultPrinterName()
```

--------------------------------

### Example Gateway XML Property Format

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/reference-pages/gateway-xml-file-reference

Illustrates the typical format for properties within the `gateway.xml` configuration file, showing a key-value pair for a gateway port setting.

```XML
<entry key="gateway.port">8088</entry>
```

--------------------------------

### Python Scripting: Get Max Value from a List

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-math/system-math-max

This example demonstrates how to use `system.math.max` to find the maximum value within a predefined Python list of numbers.

```Python
# Create a List of values.
values = [3.5, 5.6, 7.8, 7.4, 3.8]

# Prints the resulting value.
print system.math.max(values)
```

--------------------------------

### Example Perspective Component Property Configuration

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/components/perspective-components/perspective-input-palette/perspective-one-shot-button

Illustrates an example configuration of component properties, including text, icon path, icon color, and background style, demonstrating how to set various states for a component.

```APIDOC
Property: props.readyState.text
Value: Start Process
Style Category: N/A

Property: props.readyState.icon.path
Value: material/trending_flat
Style Category: N/A

Property: props.readyState.icon.color
Value: #008000
Style Category: N/A

Property: props.writingState.text
Value: Starting
Style Category: N/A

Property: props.writingState.style.backgroundColor
Value: #8AFF8A
Style Category: background
```

--------------------------------

### Python Example: Adjusting Date Range Component's Selected Range

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/components/vision-components/calendars/date-range/date-range-scripting-functions

This Python example demonstrates how to adjust the selected start and end dates of an Ignition Date Range component by moving them back 8 hours using `java.util.Calendar` and then applying the new range with `setRange`.

```Python
# This example moves the existing Start Date and End Date
# of a Date Range component ahead 8 hours
from java.util import Calendar

# Get the current start and end
dateRangeComponent = event.source.parent.getComponent('Date Range')
startDate = dateRangeComponent.startDate
endDate = dateRangeComponent.endDate

# Calculate the new start and end dates
cal = Calendar.getInstance();
cal.setTime(startDate);
cal.add(Calendar.HOUR, -8);
newStart = cal.getTime();

cal.setTime(endDate);
cal.add(Calendar.HOUR, -8);
newEnd = cal.getTime();

# Set the new range for the component. The outer range will
# automatically expand if needed.
dateRangeComponent.setRange(newStart, newEnd)
```

--------------------------------

### Synchronous Blocking with sendRequestAsync and get()

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-util/system-util-sendRequestAsync

This example demonstrates how to use `system.util.sendRequestAsync` to initiate an asynchronous request and then immediately block the script's execution using the `get()` method of the returned Request handle. This effectively makes the operation synchronous, waiting for the message handler's response or an exception.

```Python
# This will call the message handler 'test', and will return a handle into myHandle.
# We then call get() on myHandle, which will block the script and will wait for a return or throw an exception on failure.
myHandle = system.util.sendRequestAsync(project='ACME', messageHandler='test', payload={'number':55})
myHandle.get()
```

--------------------------------

### Python - Displaying a Message Box with system.gui.messageBox

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/platform/scripting/scripting-in-ignition/getting-started-with-scripting

This Python code demonstrates how to use Ignition's `system.gui.messageBox` function to display a modal window containing a specified string message. This function is commonly used in component scripts, such as on a Button, to provide immediate feedback or information to the user.

```Python
system.gui.messageBox('Hello World')
```

--------------------------------

### Python Example: Adjusting Date Range Component's Outer Range

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/components/vision-components/calendars/date-range/date-range-scripting-functions

This Python example demonstrates how to adjust the outer start and end dates of an Ignition Date Range component by moving them forward two days using `java.util.Calendar` and then applying the new outer range with `setOuterRange`.

```Python
# This example moves the existing Outer Date Range
# of a Date Range component back two days
from java.util import Calendar

# Get the current start and end of the outer range
dateRangeComponent = event.source.parent.getComponent('Date Range')
startDate = dateRangeComponent.outerRangeStartDate
endDate = dateRangeComponent.outerRangeEndDate

# Calculate the new start and end dates for the outer range
cal = Calendar.getInstance();
cal.setTime(startDate);
cal.add(Calendar.DAY_OF_MONTH, 2);
newStart = cal.getTime();

cal.setTime(endDate);
cal.add(Calendar.DAY_OF_MONTH, 2);
newEnd = cal.getTime();

# Set the new outer range for the component.
dateRangeComponent.setOuterRange(newStart, newEnd)
```

--------------------------------

### Python Example: Adding a New User with system.user.addUser

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-user/system-user-addUser

This Python example demonstrates how to use the system.user.addUser function to create and add a new user. It shows the steps to obtain a new user object, add contact information, set a password, and prepare the user for addition to a user source.

```Python
# Get new user.
userToGet = system.user.getNewUser("AcmeWest", "mTrejo")

# Add some contact info.
contactInfo = {"email":"mTrejo@acmewest.com","sms": "5551234"}
userToGet.addContactInfo(contactInfo)
userToGet.set("password", "thisIsMyPassword")
```

--------------------------------

### Launch and Initial Configuration for FX Configurator-EN

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/ignition-modules/opc-ua/opc-ua-drivers/mitsubishi-tcp-driver

Provides the first steps for setting up FX Configurator-EN, including launching the utility and entering the initial FX3U-ENET configuration details required for MELSEC-F series device connections.

```Configuration
1. Click Tools from the menu bar to select FX Special Function Utility > FX Configurator-EN.
2. Enter the minimum required FX3U-ENET configuration information.
```

--------------------------------

### Example Modbus Address Mapping for DL240 Devices

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/ignition-modules/opc-ua/opc-ua-drivers/modbus/modbus-address-mapping

This table provides a comprehensive example of Modbus address mapping for a DL240 device, illustrating various Modbus types such as Holding Register (Int16), Discrete Input, Coil, and Input Register (BCD16), along with their corresponding prefix, start, end, unit ID, and Modbus address ranges.

```APIDOC
| Prefix | Start | End | Unit ID | Modbus Type | Modbus Address |
| --- | --- | --- | --- | --- | --- |
| V | 2000 | 3777 | 0 | Holding Register (Int16) | 1024 |
| X | 2000 | 477 | 0 | Discrete Input | 2028 |
| Y | 0 | 477 | 0 | Coil | 2048 |
| TAO | 0 | 127 | 0 | Input Register (BCD16) | 0 |
```

--------------------------------

### Python Example: Getting Mouse Click Location

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-gui/system-gui-convertPointToScreen

This Python code snippet illustrates how to obtain the screen coordinates of the mouse pointer using `system.gui.convertPointToScreen` and suggests displaying them in a label.

```Python
# This example gets the coordinates where the mouse is (from the corner of the monitor) and displays them in a label.
# Get the screen coordinates of the pointer and write them to a label.
```

--------------------------------

### Vision Client Launcher Configuration File Location

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/launchers-and-workstation/vision-client-launcher/vision-client-launcher-settings

Path to the 'vision-client-launcher.json' file, which can be manually edited for advanced launcher configurations.

```Text
{user folder}\.ignition\clientlauncher-data\vision-client-launcher.json
```

--------------------------------

### Close Window by Object Reference with Error Handling

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-nav/system-nav-closeWindow

This example demonstrates how to get a window named 'Overview' and then close it using its object reference. It includes error handling to warn the user if the window is not open.

```Python
# This example gets the window named 'Overview' and then closes it.
# If the window isn't open, a warning is shown.
try:
   window = system.gui.getWindow('Overview')
   system.nav.closeWindow(window)
except ValueError:
   system.gui.warningBox("The Overview window isn't open")
```

--------------------------------

### system.gui.showTouchscreenKeyboard API Reference

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-gui/system-gui-showTouchscreenKeyboard

Detailed API documentation for the `system.gui.showTouchscreenKeyboard` function, including its syntax, parameters, return type, and scope.

```APIDOC
system.gui.showTouchscreenKeyboard(initialText, [fontSize], [passwordMode])

Parameters:
- initialText (String): The text to start the on-screen keyboard with.
- fontSize (Integer, optional): The font size to display in the keyboard.
- passwordMode (Boolean, optional): A True value will activate password mode, where the text entered is not echoed back in cleartext.

Returns:
- String: The text that was entered in the on-screen keyboard.

Scope: Vision Client
```

--------------------------------

### Retrieve and Print MongoDB Collection Names

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-mongodb/system-mongodb-listCollectionNames

This example demonstrates how to use `system.mongodb.listCollectionNames` to retrieve and print the names of all collections for each available MongoDB connector. It first gets a list of all connectors using `system.mongodb.listConnectorInfo` and then iterates through them.

```Python
# Retrieve a connector name to query from.

connectorList = system.mongodb.listConnectorInfo()

# Iterate through the list of connectors and print out all collection names found.
for connector in connectorList:
    print system.mongodb.listCollectionNames(connector['name'])
```

--------------------------------

### Initiate Calls, Texts, and Emails

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-perspective/system-perspective-navigate

Examples of using `system.perspective.navigate` with URL schemes to initiate phone calls, send text messages, and compose emails directly from a Perspective session.

```Python
# Initiating a call.
system.perspective.navigate(url= "tel:+1999-999-9999")

# Initiating a text with message contents.
system.perspective.navigate(url= "sms:+1-999-999-9999?&body=My%20Message")

# Initiating an email.
system.perspective.navigate(url= "mailto:someone@example.com?subject=This%20is%20the%20subject&cc=someone_else@example.com&body=This%20is%20the%20body")
```

--------------------------------

### Python Example: Download File to User Session

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-perspective/system-perspective-download

This Python code snippet demonstrates how to use the system.perspective.download function to transfer a file from the Gateway to the user running the current Perspective Session. It reads a PDF file from a specified path and initiates the download.

```python
# Downloads the file "myFile.pdf" (located on the Gateway) to the user running the current Session.

filename = 'myFile.pdf'
data = system.file.readFileAsBytes('C:\\'+filename)
system.perspective.download(filename, data)
```

--------------------------------

### Get Quarter from Specific Date in Python

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-date/system-date-get

This example creates a specific date object using system.date.getDate() and then prints the quarter of that date using system.date.getQuarter(). It illustrates how to extract a quarter from a user-defined date.

```Python
# This example would create a date object, and print out the quarter of that date.

date = system.date.getDate(2017, 3, 15) #This would print "Mon April 15 00:00:00 PDT 2016"
print system.date.getQuarter(date) #This will print 2
```

--------------------------------

### Get Current Month in Python

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-date/system-date-get

This example grabs the current time using system.date.now() and prints the current month using system.date.getMonth(). It demonstrates extracting a specific time component from the current date.

```Python
# This example would grab the current time, and print the current month.

date = system.date.now()
print system.date.getMonth(date) #This would print the current month.
```

--------------------------------

### Open Notepad with License File using `system.util.execute` (Python)

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/appendix/scripting-functions/system-util/system-util-execute

Shows how to open Notepad and load the Ignition license file using `system.util.execute`. Similar to other external program launches, this might not function as expected within a Perspective Session due to security limitations.

```Python
# This code runs the Notepad program and opens the Ignition license text file.
# Although system.util.execute() is also Perspective Session scoped, the following code snippet
# will not work in a Perspective Session due to limitations of launching programs from a web environment.
system.util.execute(['notepad.exe', 'C:\\Program Files\\Inductive Automation\\Ignition\\license.txt'])
```
Tokens:
Raw