Ignition 8.3

https://docs.inductiveautomation.com/docs/8.3/
Admin
Ignition is an industrial automation software platform that provides tools for system architectures,...
Tokens:1,640,387
Snippets:13,815
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Windows Command Line Installer

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

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

```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.3/getting-started/installing-and-upgrading/command-line-installations

Examples for running the Linux installer with text mode or unattended mode arguments.

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

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

### Auto Start Argument

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

Example of the autoStart argument to control Gateway startup behavior.

```text
"autoStart=true"
```

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

### Installation Location Argument

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

Example of the location argument to override the default installation directory.

```text
"location=/usr/local/ignition"
```

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

### Mac Command Line Installer

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

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

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

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

### User Ownership Argument

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

Example of the user argument to set installation ownership.

```text
"user=myUser"
```

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

### Start a SECS/GEM Simulator Event Run

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

This example demonstrates how to start an event run named 'myEventRun' on a simulator named 'simulator1'. It requires that both the simulator and the event run are already 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)
```

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

### Gitignore for Additive Configuration

Source: https://docs.inductiveautomation.com/docs/8.3/tutorials/version-control-guide

Example .gitignore file to exclude runtime-specific files and local resources when using the additive approach.

```text
**/config/local  
**/config/resources/local  
  
**/conversion-report.txt  
**/.resources/  
```

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

### Docker Compose Configuration for Ignition

Source: https://docs.inductiveautomation.com/docs/8.3/tutorials/version-control-guide

Example of using bind-mounts in a Docker Compose file to selectively include configuration and project directories.

```yaml
services:  
  ignition:  
    image: inductiveautomation/ignition:8.3.0  
    volumes:  
      - ./services/ignition/config:/usr/local/bin/ignition/data/config  
      - ./services/ignition/projects:/usr/local/bin/ignition/data/projects  
```

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

### Git Auto-Commit Script Path

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

Example path for the auto-commit script on a Linux system.

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

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

### Configure readPermissions JSON

Source: https://docs.inductiveautomation.com/docs/8.3/platform/tags/tag-properties

Example of a readPermissions JSON object requiring either an Administrator role or Zone A security zone access.

```json
"readPermissions": {  
    "type": "AnyOf",  
    "securityLevels": [  
      {  
        "name": "Authenticated",  
        "children": [  
          {  
            "name": "Roles",  
            "children": [  
              {  
                "name": "Administrator",  
                "children": []  
              }  
            ]  
          }  
        ]  
      },  
      {  
        "name": "SecurityZones",  
        "children": [  
          {  
            "name": "Zone A",  
            "children": []  
          }  
        ]  
      }  
    ]  
  }  
```

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

### Setting a Screen's Index

Source: https://docs.inductiveautomation.com/docs/8.3/appendix/scripting-functions/system-vision/system-vision-setScreenIndex

This example demonstrates how to move the client to a second monitor, which could be implemented in a startup script.

```python
# This example could be used on a startup script to move the client to a 2nd monitor.  
    
system.vision.setScreenIndex(1)  
```

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

### Download Example for Perspective Workstation

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

An example URL to download the 8.1.0 version of the Perspective Workstation launcher for Windows.

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

```

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

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

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

Use the batch script located in the installation directory to start the Gateway service on Windows.

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

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

### Example Deployment Mode Configuration

Source: https://docs.inductiveautomation.com/docs/8.3/platform/gateway/web-interface/platform/gateway-deployment-modes

An example of setting the active deployment mode to 'Dev' using the fourth additional Java parameter.

```text
wrapper.java.additional.4=-Dignition.config.mode=Dev  
```

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

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

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

Use the ignition.sh script to start the Gateway service on a typical Mac installation.

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

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

### GET request with API Token headers

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

Example of sending a GET request to a REST API endpoint while including an authentication token in the headers.

```python
# Define the API Key URL to connect to.  
url = 'http://localhost:8088/data/api/v1/resources/names/com.inductiveautomation.opcua/device'  
  
# Add the API Token.   
headers = {   
	'X-Ignition-API-Token': 'API:KZFH8OAhqIInsGeFku7xw9eyJE2N940B_EbxtDHd1Vc',  
}  
  
# # Print the details of each item returned from the REST API, in this case describing device connections.   
response = system.net.httpClient.get(url, headers=headers)  
print response.json["items"]
```

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

### Initial Docker Container Run

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

Starts the initial Ignition container named example-gw.

```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.3.0 \
    -n example-gw  
```

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

### Gateway Network Configuration Example

Source: https://docs.inductiveautomation.com/docs/8.3/appendix/reference-pages/platform-environment-variables

Example showing how to configure multiple Gateway Network connections using the indexed '#' placeholder syntax.

```text
GATEWAY_NETWORK_0_HOST=1.2.3.4  
GATEWAY_NETWORK_0_PORT=8088  
GATEWAY_NETWORK_0_DESCRIPTION="For tag server"  
   
GATEWAY_NETWORK_1_HOST=5.6.7.8  
GATEWAY_NETWORK_1_PORT=8089  
GATEWAY_NETWORK_1_DESCRIPTION="For edge server"  
```

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

### Get Roster Names Example

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

This example demonstrates how to retrieve the list of rosters from the Gateway and print the result to the browser console when triggered by 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)  
```

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

### Example init.properties configuration

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

This file defines network settings for an agent, including the system name, local interface, and gateway network connection 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  
```

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

### Unattended Installation Argument

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

Example of the unattended argument for minimal feedback.

```text
"unattended=minimal"
```

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

### Complete Builder Example

Source: https://docs.inductiveautomation.com/docs/8.3/ignition-modules/alarm-notification/alarm-notification-pipelines/pipeline-blocks/notification-block

A full implementation example that filters specific alarms and builds a user list from database records.

```python
# get the alarm name property  
alarmName = event["name"]  
   
# don't send notification for some alarms  
if alarmName in ["Diagnostic Alarm", "Joe's Test Alarm"]:  
    # return an empty list so no one will be emailed  
    return []  
   
else:  
    # get user information from the database  
    data = system.db.runPrepQuery(  
        "SELECT username, emailaddress, smsnumber FROM user_info_table",  
        [],  
        "DB"  
    )  
   
    # loop through the returned query data  
    for row in data:  
        # add each user to the builder  
        builder.username(row["username"]).email([row["emailaddress"]]).sms([row["smsnumber"]]).add()  
   
    # use the builder object's build() function to create the finished list of data  
    userList = builder.build()  
    return userList  
```

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

### SQLite Connect URL Examples by OS

Source: https://docs.inductiveautomation.com/docs/8.3/platform/database-connections/connecting-to-databases/connecting-to-sqlite

Examples of full Connect URLs for Windows, Mac, and Linux environments.

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

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

### Compare dates with system.date.isBetween

Source: https://docs.inductiveautomation.com/docs/8.3/appendix/scripting-functions/system-date/system-date-isBetween

This example demonstrates comparing a target date against a start and end date range. Note that if the end date is before the start date, the function will return False.

```python
# This will compare if the first date is between the other dates, which it is not.  
# Note that if the end date is before the start date, this function will always return False  
    
target = system.date.getDate(2017, 4, 28)  
start = system.date.getDate(2017, 3, 22)  
end = system.date.getDate(2017, 4, 22)  
print system.date.isBetween(target, start, end) #Will print false.  
```

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

### Get Sibling Component Example

Source: https://docs.inductiveautomation.com/docs/8.3/appendix/scripting-functions/system-vision/system-vision-getSibling

This example demonstrates how to retrieve a sibling component named 'TextField (1)' and access its text property, including a check to ensure the component exists.

```python
# This example gets its sibling Text Field's text, and uses it.  
    
textField = system.vision.getSibling(event, 'TextField (1)')  
if textField is None:  
   system.vision.showError("There is no text field!")  
else:  
   system.vision.showMessage("You typed: %s" % textField.text)
```

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

### Log Level Argument

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

Example of the logLevel argument to set the installer logging level.

```text
"logLevel=trace"
```

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

### Create a Roster

Source: https://docs.inductiveautomation.com/docs/8.3/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)  
```

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

### HTTP Request with API Key

Source: https://docs.inductiveautomation.com/docs/8.3/platform/security/api-keys

An example of a GET request authenticated with an API key.

```http
GET /api/resource HTTP/1.1
Host: your.gateway.address
X-Ignition-API-Token: <your-api-token>
```

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

### Windows Command Line Installation

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

Use the --% argument before passing installer arguments on Windows.

```bash
--%
```

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

### Get Screen Index Example

Source: https://docs.inductiveautomation.com/docs/8.3/appendix/scripting-functions/system-vision/system-vision-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.vision.getScreenIndex()  
```
Tokens:
Raw