Ignition System Functions

https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions
Admin
Ignition System Functions provide a comprehensive set of built-in scripting functions for the...
Tokens:1,072,173
Snippets:6,767
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Run Ignition Installer with Command Line Arguments

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

Demonstrates how to execute the Ignition installer from the command line using various arguments for different operating systems. Examples include running in text mode, changing installation directories, and using unattended modes.

```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"

# 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 only and requires user interaction.
open -a /Volumes/IgnitionInstaller/ignition-8.1.14-osx-installer.app --args "textMode=true"

# 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"
```

```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"
```

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

### Installer Command Line Argument: autoStart

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions/new-in-this-version

Introduces the `autoStart` command line argument for Ignition installers, allowing the Gateway to automatically start after installation or upgrade.

```APIDOC
Argument: autoStart
Description: Automatically starts the Gateway after installing or upgrading.
```

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

### Ignition Installer Command Line Arguments Reference

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

Defines the supported command-line arguments for the Ignition installer, including their purpose, accepted values, and example usage for configuration and automation.

```APIDOC
Command Line Argument Key: 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"

Command Line Argument Key: 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"

Command Line Argument Key: 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"

Command Line Argument Key: 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: Options are (from most granular to least granular):- trace - debug - info - warn - error
  Example: "logLevel=trace"

Command Line Argument Key: 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"

Command Line Argument Key: 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
  Example: "serviceName=my-gateway"

Command Line Argument Key: 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"
```

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

### Example Direct Download URL for Perspective Workstation

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

A specific example demonstrating how to download the 8.1.0 version of the Perspective Workstation launcher for Windows directly from the hosted servers using the provided URL pattern.

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

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

### Docker Compose Example for Ignition Gateway

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

This is an example of a docker-compose.yml file for starting an Ignition Gateway container, demonstrating how to bundle its configuration with other services. This snippet is incomplete but shows the start of a Docker Compose file.

```yaml
# Docker Compose Example for inductiveautomation/ignition
```

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

### Pseudocode - Starting a System Function Call

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

This snippet illustrates the initial 'system.' prefix used when calling built-in Ignition functions, often followed by autocompletion to explore available modules and functions.

```Pseudocode
system.
```

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

### Configure ignition.conf for Standard Edition

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

This example shows how to modify the `ignition.conf` file to explicitly set the Ignition Gateway to the Standard edition. The `-Dedition` parameter is added without a value to achieve this, bypassing the edition selection during installation.

```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 on Linux

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

After making the Ignition installer executable, this command initiates the installation process from the terminal. Replace `ignition-x.x.x-linux-x64-installer.run` with the actual installer filename.

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

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

### SQL Server JDBC Connection URL Examples

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions/platform/database-connections/connecting-to-databases/connecting-to-microsoft-sql-server-express

Examples of JDBC connection URLs for connecting to SQL Server databases, demonstrating generic, localhost, and IP address specifications with a port.

```APIDOC
jdbc:sqlserver://Hostname:Port
jdbc:sqlserver://localhost:1433
jdbc:sqlserver://10.10.1.5:1433
```

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

### Python Example: Get OPC HDA Servers

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

This Python code snippet demonstrates how to use `system.opchda.getServers()` to retrieve a list of configured OPC HDA servers.

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

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

### Ignition Database Connection String Examples for SQL Server

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions/platform/database-connections/connecting-to-databases/connecting-to-microsoft-sql-server-express

Examples of connection URLs for Microsoft SQL Server JDBC driver in Ignition, including formats for hostname, instance name, and IP address, along with an example for specifying the database name in extra connection properties.

```SQL
Connect URL examples:
jdbc:sqlserver://Hostname\InstanceName
jdbc:sqlserver://localhost\SQLEXPRESS
jdbc:sqlserver://10.10.1.5\MSSQLSERVER

Extra Connection Properties:
databaseName=test
```

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

### Python Example: Get User-Specified OPC-HDA Attributes

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

This Python example demonstrates how to use `system.opchda.readAttributes` to retrieve user-specified attributes over a period of time from a Matrikon OPC HDA explorer. It initializes start and end dates for the query.

```Python
# This example will get user-specified attributes over a period of time from a Matrikon OPC HDA explorer.
# Declare start and end dates
start = system.date.getDate(2022, 10, 24)
end = system.date.getDate(2022, 10, 24)
```

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

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

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

This Python code snippet demonstrates how to invoke `system.secsgem.startSimEventRun` to begin a specific event run within a designated simulator. It assumes a simulator named 'simulator1' and an event run 'myEventRun' are pre-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)

```

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

### Start or Stop Ignition Service

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

Provides terminal commands to manually start, stop, or restart the Ignition service on Windows, Mac, and Linux operating systems. The service name 'Ignition' is assumed for Windows examples.

```Shell
## 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
```

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

```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
```

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

### Python Example: Getting Mouse Click Coordinates

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

An example demonstrating how to use `system.gui.convertPointToScreen` to get the screen coordinates of a mouse click and display them.

```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.
```

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

### Perspective Workstation Command Line Arguments API and Example

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

Documents the available command-line arguments for launching and configuring Perspective Workstation applications, along with an example demonstrating how to use the 'config.json' argument to apply a custom configuration file.

```APIDOC
Arguments:
  application:
    Description: The name of the workstation application to launch.
  debugPort:
    Description: Allows specifying a specific debug port for the launched application. Default is 9224.
  launch.mode:
    Description: Override the launch mode to launch the application in.
    Options: WINDOWED, KIOSK
  browser.tab.mode:
    Description: Override the Tab/Window mode for the launched application.
    Available options: BLOCKED, IN_WINDOW, SYSTEM
  config.json:
    Description: Allows you to point Perspective Workstation to a configuration file from command line. Doing so will start running an instance of workstation using the configurations in the file as a temporary override. The argument expects a path to a JSON export file, specifically the same file that's created by the Export Launcher Config button under workstation's Settings menu.
```

```Shell
"C:\\Launchers\\Perspective\\Workstation.exe" config.json="C:\\Users\\MyUser\\Desktop\\workstation.json"
```

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

### Filtered Tag Browse Example (Incomplete)

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

An incomplete Python script demonstrating the start of a filtered tag browse operation. This snippet shows the initial setup for browsing a Tag provider with a filter, but the code block only contains a descriptive comment.

```Python
# This simple script will browse a given Tag path, in this case the root of the provider called default, and print the results.
```

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

### Run Initial Ignition Container

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

Demonstrates how to run an initial Ignition Docker container named `example-gw` with specified data volume, edition, EULA acceptance, admin password, and port mapping. This command sets up the base container before user migration.

```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
```

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

### Execute Ignition Cloud Edition Installer

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

Run the downloaded and permission-updated installer from the command line. The installer will guide you through the upgrade process, prompting for the installation directory and confirmation of module upgrades.

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

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

### Download Ignition Cloud Edition Installer with wget

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

Use the `wget` command to download the Ignition Cloud Edition installer from the Inductive Automation downloads page. The `--referer` flag is included to mimic a browser request. Remember to replace the placeholder URL with the actual, current download link.

```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
```

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

### Get Max Date from Dataset Column Example

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

This example demonstrates how to use the `maxDate` function to find the maximum date within the 'AlarmTime' column of a dataset referenced from a UI component. This expression can be used to get the date and time for the most recent alarm.

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

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

### Python Example: Browse OPC Server with system.opc.browseSimple

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

This Python example demonstrates how to use `system.opc.browseSimple` to retrieve OPC items from a specific server and device, filtering by a folder path. It shows how to set up the server, device, and folder path parameters, and how to handle the `opcItemPath` when no specific filter is needed by passing `None`.

```Python
# This example will print out the the OPC item path for each item in a specific folder,

# Browse Ignition's OPC UA Server. This can be changed to match any connected OPC server.
server = "Ignition OPC UA Server"

# Focus on the "SLC" device connection. This must match a valid device connection in the OPC server.
device = "SLC"

# Specify that the folder path should contain "B3".
folderPath = "*B3*"

# This example is not filtering on a specific OPCItemPath, so it pass Python's None for this parameter
opcItemPath = None

# Call browseSimple and store the results in a variable. Note that it may take some time to complete the browse.
OpcObjects = system.opc.browseSimple(server, device, folderPath, opcItemPath)

```

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

### Open Notepad with Ignition License File using system.util.execute

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

Shows how to run the Notepad program and open the Ignition license text file using `system.util.execute`. Similar to launching browsers, this action is not supported within a Perspective Session due to web environment restrictions.

```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'])
```

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

### Retargeting to an SSL/TLS Enabled Gateway

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

This example demonstrates how to retarget to a Gateway with SSL/TLS enabled by specifying 'https://' at the start of the address, similar to the previous example but for secure connections.

```Python
# This example is similar to the previous, except it could be used to retarget to a gateway that
# has SSL/TLS enabled. Simply specify "https://" at the start of the address.
system.util.retarget("TankControl", "https://10.30.2.33:8043", {"retargetOccured":1}, ["Graph"])
```

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

### Python Example: Get Mode from List

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-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 values in a given list of numbers and print the first result.

```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]
```

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

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

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

This example demonstrates how to use `system.opc.browse` without any parameters to retrieve and print details of all available OPC tags across all servers.

```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()
```

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

### Python Example: Swap to a window with parameters (incomplete)

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

This example shows the beginning of a `system.nav.swapTo` call that includes passing parameters to the new window, typically from a dropdown menu selection. The provided code snippet is incomplete.

```Python
# This code would go in a button's ActionPerformed event to swap out of the current window and into a window named MyWindow.
# It also looks at the selected value in a dropdown menu and passes that value into the new window.

```

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

### Python Example: Reading Processed Data from OPC-HDA Server

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

This Python example demonstrates how to initiate reading processed data from a Matrikon OPC-HDA server by declaring start and end dates for the query.

```Python
# This example will read processed data from a Matrikon server between two specified dates.
# Declare start and end dates
start = system.date.getDate(2022, 3, 14)
end = system.date.now()
```

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

### Python Example: Get Raw Timezone Offset

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

This Python example demonstrates how to use `system.date.getTimezoneRawOffset()` to retrieve the raw timezone offset for the computer's current timezone, ignoring daylight savings.

```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)
```

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

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

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-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 shows the basic usage of the `print` function and how to execute it to see immediate output in the Interactive Interpreter.

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

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

### Ignition Default Installation Directories

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

Lists the default installation paths for Ignition across different operating systems.

```Plaintext
C:\Program Files\Inductive Automation\Ignition
```

```Plaintext
/usr/local/ignition
```

```Plaintext
/usr/local/bin/ignition
```

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

### Python - Requesting Focus from a Text Area

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions/ignition-modules/vision/scripting-in-vision/focus-manipulation

This example shows the specific approach required to correctly request focus for Text Area components in Ignition. Directly calling requestFocusInWindow() on a Text Area does not allow immediate typing. The solution involves first getting the component's viewport and then its view before requesting focus, enabling the user to start typing immediately.

```Python
# Create a reference to the Text Area. This step could be skipped and combined with the line below, but is segregated in this example for clarity.
textArea = event.source.parent.getComponent('Text Area')
```

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

### SQLite Connect URL Examples for Different Operating Systems

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions/platform/database-connections/connecting-to-databases/connecting-to-sqlite

Examples demonstrating how to specify the database file path for Windows, Mac, and Linux operating systems in a SQLite Connect URL.

```Text
# On Windows
jdbc:sqlite:C:/Path/To/File.db

# On Mac
jdbc:sqlite:/path/on/mac/File.db

# On Linux
jdbc:sqlite:/path/on/linux/File.db
```

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

### Crontab Example: Multiple Values (,)

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions/appendix/reference-pages/crontab-formatting-reference

Illustrates using the comma (,) to specify multiple discrete values for a unit of time. The example runs at the start of every hour and at the 25th minute of every hour.

```Crontab
0,25 * * * *
```

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

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

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

An example demonstrating how to start a transaction with a 5-second timeout against the project's default database, using the default isolation level, and then 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,
```

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

### system.sfc.startChart API Reference

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

Detailed API documentation for the system.sfc.startChart function, including its syntax, parameters, return type, and execution scopes within Ignition.

```APIDOC
Function: system.sfc.startChart
Syntax: system.sfc.startChart(projectName, chartPath, parameters)

Parameters:
  projectName (String): The name of the project that the chart was created in.
  chartPath (String): The path to the chart, for example "ChartFolder/ChartName".
  parameters (Dictionary[String, Any]): 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
```

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

### Okta SAML Metadata Import URL Example

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions/platform/security/identity-provider-authentication-strategy/configuring-identity-providers/saml-example

An example URL for importing SAML metadata from an Okta Identity Provider into Ignition. This URL defines how to communicate with the IdP and can be used for automatic configuration, eliminating the need for manual input.

```URL
https://dev-123456.okta.com/app/esdfsdf7886sd6723hjkdf/sso/saml/metadata
```

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

### JSON: Example Raw OpenWeather API Response

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions/platform/scripting/scripting-in-ignition/web-services-suds-and-rest/http-methods

An example of the complete JSON string returned by the OpenWeather API after a successful GET request, containing various weather and location-related data.

```JSON
{"coord":{"lon":-121.1898,"lat":38.6523},"weather":[{"id":800,"main":"Clear","description":"clear sky","icon":"01d"}],"base":"stations","main":{"temp":310.34,"feels_like":310.11,"temp_min":308.88,"temp_max":312.74,"pressure":1013,"humidity":26},"visibility":10000,"wind":{"speed":4.12,"deg":290},"clouds":{"all":0},"dt":1654893775,"sys":{"type":2,"id":2006213,"country":"US","sunrise":1654864794,"sunset":1654918128},"timezone":-25200,"id":5349705,"name":"Folsom","cod":200}
```

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

### Python Example: Create Roster with system.roster.createRoster

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

Demonstrates how to create new rosters using the `system.roster.createRoster` function in Python, showing examples with and without a description.

```Python
# Create an empty roster with a description.
system.roster.createRoster("rosterEast", "East plant user roster")

# Create an empty roster roster without a description.
system.roster.createRoster("rosterWest", None)
```

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

### Initialize Git Repository and Publish Ignition Project

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

This sequence of commands initializes a new Git repository, adds a remote origin, stages all files (including a .gitignore for .resources), performs an initial commit, and pushes the project to the remote 'main' branch. This is typically done for the first time a project is version-controlled.

```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
```

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

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

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

An example demonstrating how to start a transaction with a timeout against the project's default database, using the default isolation level, followed by 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,
```

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

### system.gui.desktop() API Reference

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

API documentation for the system.gui.desktop() function and its associated methods, detailing its usage, parameters, return types, and scope within Ignition's Vision Client.

```APIDOC
Function: system.gui.desktop(name: str = None)
  Description: Provides access to Ignition's desktop environments.
  Parameters:
    name (str, optional): The handle or name of the specific desktop to access. If omitted, the primary desktop is returned.
  Returns:
    DesktopObject: An object representing the specified desktop.
  Scope: Vision Client

Method: DesktopObject.getOpenedWindows()
  Description: Retrieves a tuple of all currently open windows within the specific desktop.
  Parameters: None
  Returns:
    tuple: A tuple containing references to the open window objects.
```

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

### Example: Calling getTimezoneRawOffset in Ignition Expression

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

Demonstrates how to invoke the `getTimezoneRawOffset` function in Ignition's Expression language to get the raw UTC offset. The example shows the expected output for a Pacific Timezone.

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

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

### Example Tag Browse Path for Programmable Device Simulator

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions/ignition-modules/opc-ua/opc-ua-drivers/programmable-device-simulator

This snippet provides an example of a tag browse path used within the Programmable Device Simulator, demonstrating the inclusion of the legacy '_Meta:' prefix for compatibility with older simulator versions.

```Tag Path Configuration
ns=1;s=[Testing]_Meta:Writeable/Agitator1Mode
```

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

### Initial Java Additional Parameters in ignition.conf

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

This snippet displays the default or existing 'Java Additional Parameters' section within the `ignition.conf` file. This section is where additional Java arguments for the Ignition Gateway wrapper are defined, and where the edition parameter will be added.

```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: Download File to Perspective Session

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

This Python code snippet demonstrates how to use the system.perspective.download function to initiate a file download from the Gateway to the user's browser within the current Perspective Session. It reads a specified file as bytes and then passes it to the download function.

```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)
```

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

### Configure ignition.conf for Edge Edition

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

This example demonstrates how to modify the `ignition.conf` file to explicitly set the Ignition Gateway to the Edge edition. The `-Dedition=edge` parameter is added to the 'Java Additional Parameters' section, bypassing the edition selection during installation.

```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 - Displaying a Message Box with system.gui.messageBox

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

This Python code snippet demonstrates how to use the system.gui.messageBox function in Ignition to display a simple 'Hello World' message in a modal window. This function takes a string as an argument, which will be the message displayed to the user.

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

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

### Get Installed Module Names using system.util.getModules()

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

This Python script retrieves the names of all installed modules in the Ignition system using `system.util.getModules()`. It then iterates through the results and prints each module's name. This function is available in the Gateway scope.

```Python
#Return the names of all installed modules

results = system.util.getModules()
for row in range(results.rowCount):
    names = results.getValueAt(row, "Name")
    print names
```

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

### Ignition Expression: Substring with Start Index Only

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

Demonstrates how to use the `substring` function to extract a portion of a string from a specified `startIndex` to the end of the string. The example shows extracting 'happy' from 'unhappy' starting at index 2.

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

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

### SECS/GEM Function: startSimEventRun

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

Starts a configured simulator event run in the Gateway.

```APIDOC
startSimEventRun()
  Description: Starts a configured simulator event run in the Gateway.
```

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

### Example Java Additional Parameters in ignition.conf

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

An illustrative example showing the structure of Java additional parameters within the `ignition.conf` file, demonstrating common configurations such as data directory, debug mode, and JDWP settings.

```Java
# 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
```

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

### Perform Synchronous HTTP GET Request with JythonHttpClient

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

This example demonstrates how to create a JythonHttpClient, send a synchronous GET request to a specified URL with parameters, and then validate and process the JSON response. It shows basic error handling by checking the 'good' property of the response.

```Python
# 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']
```

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

### Python Example: Get and Print Schedule Information

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

This example demonstrates how to use `system.user.getSchedule` to retrieve a schedule and then recursively print information about it, handling different schedule types like basic and composite schedules.

```Python
# This example will get a schedule and print info about it.

# This function handles recursive printing of the different schedule types. Modules can register more types than listed here.
def printScheduleInfo(aSchedule):
    if aSchedule.getType() == "basic schedule":
        print "Basic schedule type: ",aSchedule.getName(), aSchedule.getDescription(), aSchedule.isAllDays(), aSchedule.isObserveHolidays()
    elif aSchedule.getType() == "composite schedule":
        compositePieces = aSchedule.getModels()
        print "Composite schedule type:",aSchedule.getName(), aSchedule.getDescription(), " which is made up of..."
        for piece in compositePieces:
            printScheduleInfo(piece)
    else:
        print "Other schedule type: ", aSchedule.getName(), aSchedule.getDescription(), aSchedule.getType(), aSchedule.isObserveHolidays()
```

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

### system.nav.swapTo API Reference

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

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

```APIDOC
system.nav.swapTo(path, [params])
  Parameters:
    path (String): The path of a window to swap to.
    params (Dictionary[String, Any], optional): A dictionary of parameters to pass into the window. The keys in the dictionary must match dynamic property names on the target window's root container. The values for each key will be used to set those properties.
  Returns:
    Window: A reference to window that was navigated to.
  Scope: Vision Client
```

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

### Python Example: Get and Print Roster Names

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

This Python example demonstrates how to use the `system.roster.getRosterNames()` function to retrieve a list of roster names from the Ignition Gateway and then print this list to the browser console, typically triggered by a UI event like a button press.

```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)
```

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

### system.perspective.download API Reference

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

Detailed API documentation for the system.perspective.download function, outlining its required and optional parameters, their types, descriptions, and the function's return type and applicable scope.

```APIDOC
system.perspective.download
  Parameters:
    filename (String): Suggested name for the downloaded file.
    data (String | byte[] | InputStream): The data to be downloaded. May be a string, a byte[], or an InputStream. Strings will be written in UTF-8 encoding.
    contentType (String): Value for the "Content-Type" header, for example: "text/plain; charset=utf-8". [optional]
    sessionId (String): 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. [optional]
    pageId (String): Identifier of the page to target. If omitted, the current page will be used automatically. [optional]
  Returns: Nothing
  Scope: Perspective Session
```

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

### system.math.product API Reference

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

Detailed API documentation for the `system.math.product` function, including its syntax, parameters, return type, and execution scope within Ignition's scripting environment.

```APIDOC
Function: 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
```

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

### Get Max Date from Multiple Dates Example

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

This example illustrates how to use the `maxDate` function to determine the latest date among a list of provided date values. It shows how to compare the current time with a time 5 minutes in the future.

```Ignition Expression
maxDate(now(0), addMinutes(now(0), 5)) // This would return the Date that is 5 minutes from now.
```

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

### Python Example: Getting a Desktop's Handle

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

A Python code example demonstrating the usage of `system.gui.getCurrentDesktop` to obtain the handle of the active desktop. This function is typically called without arguments and returns a string representing the desktop's unique identifier.

```Python
desktop_handle = system.gui.getCurrentDesktop()
```

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

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

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-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 details each step of the path, starting from the ENBT module in the ControlLogix Gateway to the processor in Slot 0 of the PLC5.

```APIDOC
ControlNet Connection Path Example: 1,4,2,12,1,0
(from PLC 1 to PLC 2)

Path Breakdown:
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.
```

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

### Python Code Example for showTouchscreenKeyboard

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

A Python code snippet demonstrating a note about the system.gui.showTouchscreenKeyboard function's historical context and current relevance.

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

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

### Correctly Ordering Java Additional Parameters in Configuration

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

Provides examples of the recommended practice for ordering 'wrapper.java.additional' parameters, emphasizing the importance of listing uncommented entries in ascending numerical order without skipping numbers.

```Configuration File
# Add parameters like this:
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=-some.thing=foo
wrapper.java.additional.3=-some.other.thing=bar

# Avoid skipping commented numbers:
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.4=-some.thing=foo

```

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

### Perform Asynchronous HTTP GET Request with JythonHttpClient

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

This example illustrates how to send a non-blocking GET request using `getAsync` with JythonHttpClient, allowing other operations to proceed while waiting for the response. It demonstrates how to retrieve the response later using the `promise.get()` method, ensuring the application remains responsive during network delays.

```Python
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']
```

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

### Get Current Date at Midnight in Ignition Python

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

This example demonstrates how to use system.date.midnight to obtain the current date with its time components (hour, minute, second, millisecond) reset to zero. It first gets the current date and time using system.date.now() and then applies system.date.midnight() to it, printing the resulting date.

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

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

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

### system.gui.desktop API Reference

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

Detailed API specification for the `system.gui.desktop` function, including its parameters, return values, and scope within the Ignition 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
```

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

### system.nav.openWindowInstance API Reference

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

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

```APIDOC
system.nav.openWindowInstance(path, [params])

Parameters:
- path (String): The path to the window to open.
- params (Dictionary[String, Any]): A dictionary of parameters to pass into the window. The keys in the dictionary must match dynamic property names on the target window's root container. The values for each key will be used to set those properties. [optional]

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

Scope:
- Vision Client
```

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

### Python Example: Running Named Query with Transaction Control

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

This Python example demonstrates how to start a database transaction using `system.db.beginNamedQueryTransaction`, execute a named query within that transaction using `system.db.runNamedQuery`, and then either commit or roll back the transaction based on a user-selected checkbox. It assumes screen components for input and a pre-existing named query.

```Python
# This example starts a transaction and checks a screen to see if the transaction should be completed or reversed (rolled back).
# The example assumes you have several components on screen, including a Checkbox and two input components, and a Named Query that takes in an ID and a string value.

# Get details from the screen: Numeric Text Field, Text Field, Checkbox
idEntry = event.source.parent.getComponent('ID Field').intValue
valueEntry = event.source.parent.getComponent('Value Field').text
shouldRollback = event.source.parent.getComponent('CheckBox').selected

# Begin the transaction.
datasource = "MYSQL"
isolationLevel = system.db.READ_COMMITTED
timeout = 60000
txNumber = system.db.beginNamedQueryTransaction(datasource, isolationLevel, timeout)

# Start by running a Named Query against the transaction.
namedQueryPath = "InsertQueries/AddValues"
params = {"id":idEntry, "value":valueEntry}
system.db.runNamedQuery(namedQueryPath, params, txNumber)

# Check the window to see if the user selected to cancel the transaction.
if shouldRollback:
    # cancel the transaction
    system.db.rollbackTransaction(txNumber)
    print "Transaction rolled back"
else:
    # complete the transaction
    system.db.commitTransaction(txNumber)
    print "Transaction committed"
```

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

### Listing Specific Client Launcher Log Files

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions/launchers-and-workstation/deploying-pre-configured-launchers

Provides the names of the individual log files generated by the Designer Launcher, Perspective Workstation, and Vision Client Launcher for debugging purposes.

```Text
Designer Launcher: designerlauncher.log
Perspective Workstation: workstation.log
Vision Client Launcher: visionclientlauncher.log
```

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

### Get Current Month in Ignition Python

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

This Python example demonstrates how to obtain the current date and time using `system.date.now()` and then extract and print the current month using `system.date.getMonth()`.

```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.
```

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

### system.nav.goHome API Reference

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

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

```APIDOC
system.nav.goHome()
  Parameters: None
  Returns: Window - A reference to the window that was navigated to.
  Scope: Vision Client
```

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

### Get Modules Information with System Utility

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

Retrieves information about installed modules in the Ignition system. This function can be used to inspect the available functionality and versions of modules.

```APIDOC
system.util.getModules()
```

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

### Example: Simple Function Usage with Explicit Parameters

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions/ignition-modules/opc-ua/opc-ua-drivers/programmable-device-simulator

This example demonstrates how to configure a tag's value source using the 'sine' function with all parameters explicitly defined. It shows the structure for setting TimeInterval, BrowsePath, ValueSource, and DataType for a tag.

```Configuration
TimeInterval: 0
BrowsePath: TagA
ValueSource: sine(0,100,10,true)
DataType: Double
```

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

### Getting the Min Value from List using system.math.min

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

This Python example demonstrates how to use `system.math.min` to find the minimum value from a hardcoded list of floating-point numbers. The result is then printed to the console.

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

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

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

### Identifying User Home Directories for Client Launcher Deployment

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions/launchers-and-workstation/deploying-pre-configured-launchers

Outlines the standard user home directory paths on Windows and Linux where the packaged client launcher ZIP file should be unzipped for proper deployment.

```Shell
C:\Users\userName
```

```Shell
/home/user/
```

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

### Get Table Headers from Vision Table Component in Python

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions/appendix/scripting-functions/system-dataset/system-dataset-getColumnHeaders

This Python example demonstrates how to retrieve a dataset from a Vision Table component and print its column headers as a list using `system.dataset.getColumnHeaders`.

```Python
# This example fetches the dataset from a Vision table, and prints the table headers as a list.
# Fetch data from table component.
data = event.source.parent.getComponent('Table').data
# Print dataset headers.
print system.dataset.getColumnHeaders(data)
```

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

### Launching with a Configuration JSON File

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

Illustrates how to launch the Vision Client Launcher using a specified JSON configuration file, providing temporary overrides for launcher settings.

```Command Line
"C:\ClientLauncher\visionclientlauncher.exe" config.json="C:\Users\MyUser\Desktop\vision-client-launcher.json"
```

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

### Ignition Expression: Get Current Time with Custom Polling Rate

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

Illustrates using the `now()` function with a specified `pollRate` parameter. This example sets the update interval to 13,000 milliseconds (13 seconds).

```Ignition Expression
now(13000) //Returns the current time, updates every 13 seconds.
```

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

### OPC UA Endpoint URL Format Examples

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions/ignition-modules/opc-ua/opc-ua-client-connection-settings

Illustrates the standard URL format for connecting to an OPC UA server, showing examples with both IP addresses and hostnames.

```Configuration
opc.tcp://IpAddress:Port

opc.tcp://myServer:12345
```

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

### API Reference: system.perspective.login Function

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

Detailed API documentation for the `system.perspective.login` function, including its parameters and their types, descriptions, and optionality. This function initiates a login process using the project's configured Identity Provider.

```APIDOC
system.perspective.login(
  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.
  forceAuth: Boolean (optional) - Determines if Ignition should ask the IdP to re-authenticate the user, even if the user is already signed into the IdP. If set to true, then the IdP will ask the user to re-enter their credentials. If set to false, then the Gateway will request that the IdP use the last provided credentials for the Session, potentially allowing re-authentication without requiring the user to re-type their credentials. Note that support for this argument is determined by the IdP; the IdP may choose to ignore this request. If this parameter is omitted, then the function will use the re-authentication setting defined under Project properties.
)
```

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

### Demonstrating AttributeError for Non-Existent Properties

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions/platform/scripting/python-scripting/error-handling

Typically seen when a script tries to access a property that doesn't exist. Example: a script tries to get the value of a property on a component, but the property name is misspelled.

```Python
myVar = 10
# integers do not natively have a name variable, so this will fail with an AttributeError:
# there isn't an 'attribute' on an integer by the name of 'name'
print myVar.name
```

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

### Get RosterModel Object with system.roster.getRoster in Python

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

This example demonstrates how to retrieve a RosterModel object using `system.roster.getRoster` and print it to the browser console when a Button is pressed. It shows basic usage of the function.

```Python
# This example gets the RosterModel object from a roster called "some roster" when a Button is pressed and prints the object to the browser console.

roster = system.roster.getRoster("some roster")
system.perspective.print(roster)
```

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

### SECS/GEM Function: copyEquipment

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

Creates a copy of an equipment connection.

```APIDOC
copyEquipment()
  Description: Creates a copy of an equipment connection.
```
Tokens:
Raw