Ignition

https://docs.inductiveautomation.com
Admin
Ignition is a comprehensive software platform that serves as a central hub for industrial...
Tokens:1,944,587
Snippets:15,182
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Linux command line installer examples

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

Runs the Ignition installer on Linux from the command line. The first command requires user interaction; the second uses unattended text mode and changes the install directory to /home/yourUser/Desktop/test. Replace yourUser and 8.1.14 with your values, and remove the x from x64 if needed.

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

```

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

### Windows command line installer examples

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

Runs the Ignition installer on Windows from the command line. The first command requires user interaction; the second uses unattended text mode and changes the install directory to C:\Ignition. Replace yourUser and 8.1.14 with your values, and remove the x from x64 if needed.

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

```

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

### Mac command line installer examples

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

Runs the Ignition installer on macOS from the command line. The first command requires user interaction; the second uses unattended text mode and changes the install directory to /Users/yourUser/Desktop/test. Replace yourUser and 8.1.14 with your values.

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

```

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

### Run initial container as root (command line)

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

Starts the example-gw container with a data volume, environment variables, and port mapping. This is the initial setup before 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.3.0 \  
    -n example-gw  

```

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

### Complete Builder Example: Returning a User List

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

A complete example that gets the alarm name, skips certain alarms, queries the database for user information, adds each user to the builder, and returns the built user list. This is the final step after adding all contact information to the builder.

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

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

### Start and Stop Ignition Service on Windows

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

Use these commands to start and stop the Ignition service on Windows. The examples assume the service name is 'Ignition', which is the default. Modify the service name if you used a different one during installation.

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

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

### Example init.properties

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

Configuration file for agent network settings, including local interface, SSL, and gateway network 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  

```

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

### Start, Stop, and Restart Ignition on Linux

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

Use these commands to control the Ignition service on Linux. The examples use the default installation directory /usr/local/bin/ignition.

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

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

### Example Controller Configuration (eam-install.properties)

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

Configuration for setting the gateway as a controller, including archive path, archive location, low disk threshold, and data source.

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

```

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

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

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

Run the ignition.sh script from the install directory to start the Gateway service on Mac OS X. The full command assumes a typical dmg installer location.

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

```

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

### Get OPC HDA attributes and description

Source: https://docs.inductiveautomation.com/docs/8.3/appendix/scripting-functions/system-opchda/system-opchda-getAttributes

This example gets the attributes from a Matrikon OPC HDA server and prints the results. It then uses the getDesc() method to get the description of an attribute and prints it. Note that the example uses 'hda[1]' which is not defined in the snippet, so it may be a typo.

```python
# This example gets the description of a Matrikon OPC HDA explorer  
# Declare a OPC HDA variable using the system function and prints out the results  
opcHda = system.opchda.getAttributes('Matrikon HDA')  
print opcHda  
   
# Use the getDesc() method to get the description of the attribute and print out the result  
getDesc = hda[1].getDesc()  
print getDesc  
```

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

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

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

Run from the Ignition installation directory (e.g., C:\Program Files\Inductive Automation\Ignition) to start the Gateway service on Windows.

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

```

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

### Example #1: Use getUsername in a startup script

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

This example runs on a startup script and uses the returned username to open a different window for Bob versus other users. It demonstrates the function's return value and typical usage in a Vision Client.

```python
# This code would run on a startup script based on who was logging in.  
name = system.vision.getUsername()  
if name == 'Bob':  
   system.vision.openWindow("BobsHomepage")  
else:  
   system.vision.openWindow("NormalHomepage")  

```

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

### Launch Perspective Workstation with application and debugPort

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

Command line example showing how to launch Perspective Workstation with the application and debugPort arguments. The application argument is required when specifying debugPort.

```text
.\perspectiveworkstation.exe application=test debugPort=9224
```

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

### Union of Users and Customers

Source: https://docs.inductiveautomation.com/docs/8.3/platform/sql-in-ignition/writing-sql-queries/sql-select-statements

SQL example of UNION to get distinct values from two tables.

```sql
SELECT username FROM users  
UNION  
SELECT name FROM customers  
```

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

### Example #6 - UDT Parameters and Bindings

Source: https://docs.inductiveautomation.com/docs/8.3/appendix/scripting-functions/system-tag/system-tag-configure

Demonstrates how to configure a UDT definition with parameters and bindings using the system.tag.configure function.

```APIDOC
## system.tag.configure

### Description
Configures a UDT definition with parameters and bindings. The example shows how to define a UDT type with parameters and a tag that uses those parameters in bindings.

### Method
system.tag.configure

### Signature
system.tag.configure(path, tags, collisionPolicy)

### Parameters
- **path** (String) - Required - The path to the parent folder where the UDT definition will be created. In the example, it is "[default]".
- **tags** (List) - Required - A list of tag configuration dictionaries. The example shows a UDT definition with parameters and a child tag.
- **collisionPolicy** (String) - Required - The collision policy to use when a tag already exists. In the example, "o" is used (overwrite).

### Request Example
```python
tag = {  
  "name": "UDTName",  
  "parameters": {  
    "device": {  
      "dataType": "String",  
      "value": "[Sample_Device]"  
    },  
    "opcPath": {  
      "dataType": "String",  
      "value": "_Meta:Ramp/Ramp0"  
    },  
    "opcServer": {  
      "dataType": "String",  
      "value": "Ignition OPC UA Server"  
    }  
  },  
  "tagType": "UdtType",  
  "tags": [  
    {  
    # Creating a binding involves change the key to an object, with a "bindType" key set to "parameter", and a  
    #  "binding" key set to the binding. Note that the actual binding can consist multiple parameters and characters  
      "opcItemPath": {  
        "bindType": "parameter",  
        "binding": "{device}{opcPath}"  
      },  
      "opcServer": {  
        "bindType": "parameter",  
        "binding": "{opcServer}"  
      },  
      "valueSource": "opc",  
      "name": "New Tag",  
      "tagType": "AtomicTag"  
    }  
  ]  
}  
   
path = "[default]"  
system.tag.configure(path, [tag], "o")  
```

### Response
No explicit response is documented. The function performs the configuration and may raise an exception on failure.
```

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

### Compare dates with system.date.isBetween

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

This example compares a target date against a start and end date. It prints false because the target date is not between the range. Note that if the end date is before the start date, the function always returns 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.  
```

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

### Example Agent Configuration (eam-install.properties)

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

Configuration for setting the gateway as an agent, specifying the controller server name and stats interval.

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

```

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

### GET Request Using an API Token

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

Sends a GET request to a local Ignition REST API endpoint with an API token in the headers. The example uses the X-Ignition-API-Token header and prints the JSON items from the response.

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

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

### Launch Perspective Workstation with config.json override

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

Command line example showing how to launch Perspective Workstation with a configuration file override. The config.json argument must be a JSON export from the Workstation Settings menu.

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

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

### Select Distinct Countries

Source: https://docs.inductiveautomation.com/docs/8.3/platform/sql-in-ignition/writing-sql-queries/sql-select-statements

SQL example of using SELECT DISTINCT to get unique countries from the Customers table.

```sql
SELECT DISTINCT country FROM Customers  
```

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

### Example #5 - Adding Folders in other Folders

Source: https://docs.inductiveautomation.com/docs/8.3/appendix/scripting-functions/system-tag/system-tag-configure

Demonstrates how to create a folder structure with nested folders using the system.tag.configure function.

```APIDOC
## system.tag.configure

### Description
Creates a folder structure with nested folders. The example shows how to define a folder with a subfolder that is empty.

### Method
system.tag.configure

### Signature
system.tag.configure(basePath, tags, collisionPolicy)

### Parameters
- **basePath** (String) - Required - The base path where the tags will be created. In the example, it is an empty string.
- **tags** (List) - Required - A list of tag configuration dictionaries. Each dictionary defines a tag or folder.
- **collisionPolicy** (String) - Required - The collision policy to use when a tag already exists. In the example, "o" is used (overwrite).

### Request Example
```python
Tags={'tagType': 'Folder',  
        'name': 'NewFolderName',  
        'tags' : [  
                    {  
                    'name': 'anotherfolder',  
                    'tagType': 'Folder',  
                    'tags': [{}]            # There aren't any objects defined here, so this will just be an empty folder.                   
                    }  
                ]  
        }  
   
system.tag.configure(   basePath = '',  
                        tags = Tags,  
                        collisionPolicy = "o"  
                    )  
```

### Response
No explicit response is documented. The function performs the configuration and may raise an exception on failure.
```

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

### len(string) - Get string length

Source: https://docs.inductiveautomation.com/docs/8.3/platform/scripting/python-scripting/variables-datatypes-and-objects/strings

Returns the length of the string. Example prints the length of 'Inductive Automation'.

```python
a = "Inductive Automation"   
print len(a)
```

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

### Example HTTP Request with API Key

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

Example HTTP GET request to a Gateway resource, including the required X-Ignition-API-Token header. This method is required for all routes documented in the Gateway's API Documentation interface (/openapi).

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

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

### Launch client from command line (Windows and Linux)

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

Shows how to launch a client from the command line on Windows and Linux, overriding application properties such as application name, window mode, and screen.

```bash
Windows:   
"C:\ClientLauncher\visionclientlauncher.exe" application=myproject window.mode=window  
     
Linux:   
./visionclientlauncher.sh application=myterminal window.mode=fullscreen screen=0  

```

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

### Start Ignition on Linux using ignition.sh start

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

Run the ignition.sh script with the start parameter to start the Gateway service on Linux.

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

```

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

### timeBetween spanning midnight

Source: https://docs.inductiveautomation.com/docs/8.3/appendix/expression-functions/date-and-time/timeBetween

Checks if a time is between a start and end time that spans midnight. Returns true for the given example.

```expression
timeBetween(toDate("2003-9-14 20:00:00"), toDate("2003-9-14 18:00:00"), toDate("2003-9-15 2:00:00")) //Returns true.  
```
Tokens:
Raw