Ignition 8.1

https://docs.inductiveautomation.com/docs/8.1/
Admin
Ignition is an industrial automation platform that allows users to build and deploy various control...
Tokens:1,484,294
Snippets:13,593
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Windows Command Line Installer

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

Examples for running the Windows installer with text mode or unattended installation parameters.

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

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

### Linux Command Line Installer

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

Examples for running the Linux installer script with text mode or unattended installation parameters.

```bash
# Runs the installer on command line only and requires user interaction.  
"/home/yourUser/Downloads/ignition-8.1.14-linux-x64-installer.run" -- "textMode=true"  
   
# Runs the installer on command line, changes the default install directory, and uses the "text" unattended mode.  
"/home/yourUser/Downloads/ignition-8.1.14-linux-x64-installer.run" -- "unattended=text" "location=/home/yourUser/Desktop/test"
```

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

### Mac Command Line Installer

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

Examples for running the macOS installer using the open command with text mode or unattended installation parameters.

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

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

### Get and Print Paths of Open Windows

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

This example demonstrates how to get all open windows and print the path of each one to the console. It first retrieves the tuple of window objects and then iterates through them to print their respective paths.

```Python
# This example prints out the path of each currently opened window to the console. 
    
windows = system.gui.getOpenedWindows()  
print 'There are %d windows open' % len(windows)  
for window in windows:  
    print window.getPath()  


```

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

### Example Agent Configuration in eam-install.properties

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

A sample eam-install.properties file configured for an agent, specifying the installation type and controller server name.

```properties
setup.installSelection=Agent  
agent.controllerServerName=Ubuntu-Controller  
agent.sendStatsInterval=5  
```

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

### Define Auto-Commit Script Path

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

Example path for the automated Git commit script on a Linux system.

```bash
/var/lib/ignition/data/git-auto-commit.sh  
```

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

### Get and Print All Available Terms

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

This example demonstrates how to retrieve all available translation terms and print each one to the console. It requires no special setup.

```Python
# This code will print out a list of all of the available terms to the console.  

collection = system.util.getAvailableTerms()  
for term in collection:  
    print term  

```

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

### Example init.properties configuration

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

A sample configuration file for initializing agent network settings, including host, port, and SSL parameters.

```properties
SystemName=Agent1  
AutoDetectLocal=false  
LocalInterface=10.20.11.17  
UseSSL=false  
gateway.network.0.PingRate=1000  
gateway.network.0.Enabled=true  
gateway.network.0.Host=10.20.11.18  
gateway.network.0.Port=8088  
gateway.network.0.EnableSSL=false  
gateway.network.0.PingTimeout=300  
gateway.network.0.PingMaxMissed=30  
gateway.network.0.EnableWebSockets=true  
gateway.network.0.WebsocketTimeout=10000  
gateway.network.0.HttpConnectTimeout=10000  
gateway.network.0.HttpReadTimeout=60000  
```

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

### Example Download URL for Perspective Workstation

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

A concrete example showing the download URL for the 8.1.0 version of the Perspective Workstation launcher for Windows.

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

```

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

### Create Table Syntax Example

Source: https://docs.inductiveautomation.com/docs/8.1/platform/database-connections/connecting-to-databases/jdbc-drivers-and-translators

This example shows the default syntax for creating a table, illustrating the use of tokens like {tablename}, {creationdef}, and {primarykeydef}.

```sql
CREATE TABLE {tablename} ({creationdef}{primarykeydef})
```

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

### Get Current Timezone

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

This example demonstrates how to get and print the current timezone using the system.date.getTimezone() function.

```APIDOC
## system.date.getTimezone()

### Description
Retrieves the current timezone as a string.

### Parameters
Nothing

### Returns
**String** - A representation of the current time zone.

### Scope
Gateway, Vision Client, Perspective Session

### Code Examples
```python
# This example will print out your current Timezone.  
print system.date.getTimezone()
```
```

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

### Start Ignition Service on Windows

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

Starts the Ignition service using the provided batch script in the installation directory.

```batch
C:\Program Files\Inductive Automation\Ignition> start-ignition.bat
```

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

### Initial Container Run

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

Starts the initial Ignition container named example-gw with standard configuration.

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

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

### Get Holiday Example

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

This example demonstrates how to retrieve a holiday by its name and print its details. If the holiday is not found, it indicates that.

```APIDOC
## system.user.getHoliday(holidayName)

### Description
Returns a specific holiday.

### Syntax
`system.user.getHoliday(holidayName)`

### Parameters
#### Path Parameters
- **holidayName** (String) - Required - The name of the holiday to return. Case-sensitive

### Returns
**HolidayModel** - The holiday, as a HolidayModel object, or None if not found.

### Scope
Gateway, Vision Client, Perspective Session

### Code Examples
```python
# This example will get a holiday and print info about it.  
holidayName = "Labor Day"  
holiday = system.user.getHoliday(holidayName)  
if holiday == None:  
    print holidayName, "not found"  
else:  
    print holiday.getName(), holiday.getDate(), holiday.isRepeatAnually()  
   
"""The example above outputs the following:  
Labor Day 2015-09-07 00:00:00.0 False  
"""
```
```

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

### Standard edition configuration example

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

Example of the ignition.conf file configured for the Standard edition.

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

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

### Start Ignition Gateway on Windows using start-ignition.bat

Source: https://docs.inductiveautomation.com/docs/8.1/platform/gateway

Use the start-ignition.bat script located in the installation directory to start the Gateway service.

```batch
C:\Program Files\Inductive Automation\Ignition> start-ignition.bat  
```

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

### Get Roster Names Example

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

This example demonstrates how to retrieve the list of rosters and print them to the browser console when triggered by a component event.

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

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

### Example Browse Path with _Meta Prefix

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

This example shows the format of a browse path when using preloaded simulator programs, which includes a '_Meta:' prefix for legacy compatibility.

```text
ns=1;s=[Testing]_Meta:Writeable/Agitator1Mode  
```

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

### Perspective Button GET EXAMPLE Script

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/web-dev/simple-web-server

This script sends an HTTP GET request to the Web Dev endpoint and prints the response to the Session Console.

```python
projectName = "MyProject"  
folderName = "testServer"  
doGetName = "getexample"  
url = "http://localhost:8088/system/webdev/%s/%s/%s" % (projectName, folderName, doGetName)  
  
client = system.net.httpClient()  
response = client.get(url)  
system.perspective.print(response)
```

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

### Retrieve System Properties and Write to File

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

This example demonstrates how to retrieve the user's home directory and the system file separator to construct a file path, then writes the text from a component to that location.

```python
# This script would store the contents of the Text Area component in the users home directory.  
homeDir = system.util.getProperty("user.home")  
sep = system.util.getProperty("file.separator")  
path = "%s%smyfile.txt" %(homeDir, sep)  
system.file.writeFile(path, event.source.parent.getComponent("Text Area").text)   
```

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

### Get Installed Module Names

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

Iterates through the dataset returned by system.util.getModules to print the name of each installed module. Ensure the Gateway scope is used when executing this script.

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

```

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

### Create a Roster

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

Examples showing how to create a roster with a description and how to create one without a description by passing None.

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

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

### Example Usage

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

Demonstrates how to use the system.date.get* functions with different scenarios.

```APIDOC
## Example #1: Get Current Month
```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.
```

## Example #2: Get Quarter of a Specific 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
```

## Example #3: Get Day of Week from Calendar Component
```python
# This example can be placed on the action performed event of a button.
# It will then grab the day of the week of the calendar component, 
# and enter the value returned into a numeric text field.
date = event.source.parent.getComponent('Calendar').date
event.source.parent.getComponent('Numeric Text Field').intValue = system.date.getDayOfWeek(date)
```
```

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

### Start Ignition Gateway on Mac OS X using ignition.sh

Source: https://docs.inductiveautomation.com/docs/8.1/platform/gateway

Use the ignition.sh script from the installation directory to start the Gateway service on Mac OS X.

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

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

### Get Screen Index Example

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

Prints an integer representing the screen from which the function was called.

```python
# Prints an integer representing the screen from which the function was called.   
print system.gui.getScreenIndex()  
```

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

### Open Desktop on Specific Screen with One Window

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

This example demonstrates opening a new desktop on a specific monitor (screen index) and pre-loading a single window. Ensure the screen index corresponds to an available monitor.

```Python
# Creates a new desktop on monitor 0 (primary) with only the Overview window open.  
system.gui.openDesktop(screen=0, windows=["Overview"])

```

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

### Full Mounted Path Example

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/web-dev

An example of a complete URL for a web development resource, including the gateway address, port, and mounted path.

```pseudocode
"http://10.10.10.150:8088/system/webdev/MyProject/newfile.html"

```

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

### Get Current Timezone

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

This example prints the current time zone. No parameters are required.

```python
# This example will print out your current Timezone.  
    
print system.date.getTimezone()
```

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

### Example Controller Configuration in eam-install.properties

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

A sample eam-install.properties file configured for a controller, including archive path and data source settings.

```properties
setup.installSelection=Controller  
controller.archivePath=path/to my backups  
controller.archiveLocation=Manual  
controller.lowDiskThresholdMB=1234  
controller.dataSource=MyDB  
```

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

### .setRange(start, end) usage

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

This example demonstrates how to move the existing Start Date and End Date of a Date Range component ahead 8 hours using the setRange function.

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

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

### Example commissioning.json structure

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

The structure of the commissioning.json file found in the Gateway's installation directory.

```json
{
"isCommissioned": "COMMISSIONED",
"connections.useSsl": "false",
"eulaSetup.eula": "XXXXX"
}
```

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

### Create a simple dataset

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

This example demonstrates how to create a single-column dataset using a list of headers and a list of rows.

```python
# This example create a single column dataset.  
header = ['myColumn']  
rows = [[1], [2]]  
dataset = system.dataset.toDataSet(header, rows)  
```

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

### Crontab 'Comma' Special Character Example

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

The comma (,) allows for multiple specific values to be listed for a time unit. This example schedules an execution at the start of every hour and at the 25th minute of every hour.

```crontab
0,25 * * * *

```

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

### toBorder matte example

Source: https://docs.inductiveautomation.com/docs/8.1/appendix/expression-functions/type-casting/toBorder

Example of creating a matte border.

```text
toBorder("matte;red;10;1;1;1") //returns this...
```

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

### Browse All OPC Servers

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

This example demonstrates how to perform a full recursive browse of all OPC servers and print the details of each tag found. Use with caution on large systems.

```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()
```
Tokens:
Raw