User Manual

Getting Started

Modules and Platform


Tutorials & Helpful Tricks


Strategic Partner Links

Sepasoft - MES Modules
Cirrus Link - MQTT Modules


Inductive University
Ignition Demo Project
Knowledge Base Articles
IA Support
SDK Documentation
SDK Examples

All Manual Versions

Ignition 8
Ignition 7.9
Ignition 7.8

Deprecated Pages

Skip to end of metadata
Go to start of metadata


Gateway Configuration

Once you have the Gateway up and running, you start by configuring some or all of the general services in Ignition. You make the configuration changes from the Config section of the Gateway Webpage. The different broad categories of what you can configure are as follows:

  • System  (Overview, Backup/Restore, Licensing, Modules, Projects, Redundancy and Gateway Settings)
  • Networking (Web Server, Gateway Network and Email Settings)
  • Security (Auditing ,Users, Roles, Service Security, Identity Providers, Security Levels, and Security Zones)
  • Databases (Connections, Drivers, and Store and Forward)
  • Alarming (General, Journal, Notification, On-Call Rosters, and Schedules)
  • Tags (History and Realtime)
  • OPC Client (OPC Connections and OPC Quick Client)
  • OPC UA (Device Connections, Security, and Server Settings)
  • Enterprise Administration (Event Thresholds, Controller Settings, Agent Management, License Management, and Agent Tasks)
  • Sequential Function Charts (Settings)

Depending on what modules you have installed, some categories may be missing.

Important Gateway Settings

The Gateway is at the heart of the Ignition software. It runs as a web server and you can access it through a web browser. Once running, you can get various status information about the Gateway and access important functions. You can customize the Gateway's Homepage to fit your needs.  Here's a description of all the settings and list of all the their associated properties that you will need to setup based on your Gateway configuration and preferences. 

On this page ...

Required Roles

There are several properties that are required to access certain sections of the Gateway.  

Gateway Config Role(s)Allows you to enter roles to control access to the Gateway Config section.
Status Page Role(s)Allows you to enter roles to control access to the Gateway Status section.
Home Page Role(s)Allows you to enter roles to control access to the Gateway Home section.
Designer Role(s)Allows you to enter roles to control access to the Designer.

Web-Launch Settings

Web-launching technology lets you launch a full-fledged application with zero installation just by clicking a link on a webpage. This is how both the Designer, where you'll configure your projects, the Ignition Vision Client and Perspective Sessions, where you can view your projects.   

Local Client Fallback Settings

Ignition provides a Local Vision Client Fallback mechanism that lets you use a Gateway running on the local machine. If the Gateway is lost, the Client can automatically retarget to a project that you specify in the local in the local Gateway. 

Scheduled Backups

The Scheduled Backup Settings control the Gateway's scheduled backup system. This system is capable of automatically making a Gateway backup and storing it to a folder path, which can be a network path. 

When you enable this system, you must specify a destination folder. This can be a local folder, for example C:\backups or /var/backups , or a network path such as \\fileserver\backups.

The scheduled backup system works on a schedule that is specified using UNIX Crontab syntax. This is a standard format for specifying a basic schedule. The format consists of five space-separated fields, one for minute, hour, day-of-month, month, and day-of-week. The special Gateway Configuration 72 character * means all. Slashes can be used to indicate that values should be stepped, for example, */5 in the minutes field means "every 5 minutes", or 0:00, 0;05, 0:10, etc.

To learn more on how to schedule Gateway Backups, refer the page on Gateway Scheduled Backups

Error Reporting Settings

When an error occurs in the Client or Designer, the users can click a link on the Details tab to report the error via email.


These settings define how the errors are reported.

Multicast Settings

These properties allow the Gateway to broadcast information about itself via multicast UDP packets. This allows the Gateway to be discoverable by any components that are also listening to the same multicast address. For example, native client launchers listen on a multicast address to provide a list of available Gateways on the network. Verify that the send ports and receive ports are open on the Gateway machine in order to be able to broadcast multicast message.

Gateway Property Reference

 After you launch the Gateway, you can define the high-level settings that apply to the entire Gateway by going to the Config > Gateway Settings on the Gateway Webpage. From this page, you can use the default values or define a new setting.

Gateway Settings

System Name

Is a unique name for this Ignition installation. It is used to distinguish this server from others on the network when working with multiple Ignition installations.

System User Source

Is the user source used to secure access to the Gateway, as well as to the Designer.

Gateway Config Role(s)

Is a comma-separated list of roles, one of which is required to log into the Gateway's configuration section. These roles must be defined in the System User Source.

Status Page Role(s)

The required roles to access the Gateway's Status section. Leave blank to remove security restrictions for this section.

Home Page Role(s)

The required roles to access the Gateway's Home section. Leave blank to remove security restrictions for this section. Note that this is only used to limit the access to the homepage itself, each project has its own user source for limiting access to the runtimes.

Designer Role(s)

Users must belong to one of these roles in order to have access for logging into the Designer. Multiple roles can be specified by separating them with commas.

Create Project Role(s)Users must belong to one of these roles in order to create a new Designer project. Multiple roles can be specified by separating them with commas.
Global Resource Protection

The roles required to protect or modify a protected global resource such as an alarm pipeline. If blank, anyone that can log into the Designer can protect global resources.

Allow User Admin

Allows the administration of the Gateway's system user source from the Designer and Client. Unless this is enabled, anything outside of the Gateway Configure page is prevented from altering the Gateway's system user source.

Allow Designer SSOAllows single-sign-on authentication for logging into the Designer if the Gateway user source supports it.


  This feature was removed from Ignition in version 8.0.3

As of version 8.0.3 this setting has been moved to the Networking > Web Server page.

Forces the clients to use SSL encrypted communication when talking to the Gateway. It is highly recommended that you purchase and install a genuine SSL certificate if you use this option. See Installing a Genuine SSL Certificate.

Persist Alarms

Whether or not alarm properties such as acknowledgment should persist across Gateway restarts.

Homepage Redirect URLThe URL this gateway will redirect to when http://ip:port/ is visited. Can either be a relative path (e.g., /web/home), or fully qualified (e.g.,

Launch Settings

Designer Memory

The maximum amount of memory that the Designer has access to.

Disable Direct3D

Disables the Direct3D rendering pipeline launched clients. Direct3D can cause performance problems with XOR painting. (affects clients on Windows only)

Disable DirectDraw

Disables the DirectDraw system for launched clients. Can be useful for some video cards that don't support DirectDraw well. (affects clients on Windows only)

Disable Direct3D/Disable DirectDraw

These properties affect launched Clients and Designers on Windows OS only. These flags control whether or not the Java Swing windowing subsystem may use Direct3D and/or DirectDraw. Disabling these features can incur a performance penalty, but might be required for some video cards that have faulty DirectX drivers.

Local Vision Client Fallback

Enable Local Fallback

Enables a client to fall back to a project in a local Gateway if communication is lost to the central Gateway. Note that port 6501 must be open on the local machine.

Seconds Before Failover

The number of seconds to wait before switching to the local Gateway project after communication loss.

Fallback Project

The local project to use during fallback.

Scheduled Backup Settings

Enable Scheduled Backups

Enables the scheduled backup system which automatically makes backups at a scheduled time.

Backup Folder

A path to a folder in which to put the scheduled backups.

Backup Schedule

A UNIX 'crontab' format scheduling string representing when to make the backups.

Retention Count

The number of backups to keep in the backup folder.

Error Reporting

SMTP Server

When not blank, user-reported errors are emailed using this SMTP server.

To Address

The email address(es) that will receive the error notification. Separate multiple email addresses with a semicolon (;)

From Address

The email address that the error notification is from.

SMTP Username

A username for the SMTP server, if required.

Change Password?

Check this box to change the existing password.


A password for the SMTP server, if required.


Re-type password for verification.

Multicast Settings

Enable Multicast

Allows this Gateway to be discoverable on your local network.

Multicast IP Address

Gateway messages are broadcast on this address.

Send Port

This port must be open on this machine to send multicast messages.

Receive Port

This port must be open on any machine that will receive multicast messages.

Message Interval

The interval in milliseconds at which multicast messages will be sent.

Gateway Scripting

Gateway Scripting ProjectThe name of the Project that gateway-scoped scripts with no project affiliation can access user script libraries in.

Gateway Status Pages

You can monitor the Ignition Gateway from the Status section of the Gateway. The Status section of the Gateway Webpage provides detailed information relating to the following parts:


OverviewProvides a top-down view of many of the components of your Gateway. This view is also useful for determining what step might be next when setting up your Ignition Gateway for the first time. You can view the status of your database connections, device connections, OPC connections, the number of open Clients and the number of open Designers.
PerformanceDisplays the performance status for the Ignition system such as CPU, Memory and Threads.
Alarm PipelinesShows the status details about the alarm pipelines. You can see the status of an alarm and where the alarm is in the pipeline.
Gateway ScriptsShows status details about all the scripts that are running in Gateway. You can see information such as their execution status, whether the scripts are running or not, and so on.
ModulesA list of installed modules, their status, as well information about their version and current license state.
RedundancyLists information about the current state of Redundancy in Ignition. This information is only helpful when connected to another redundant Ignition server.
ReportsDisplays information about the current and scheduled reports on the Gateway if you are using the Reporting module.
SFCsDisplays information about SFC instances.
TagsLists information and statistics about all configured Tag Providers as well as a view into the Tag subscription model, scan classes, and what tags it is currently subscribed to.
Transaction GroupsDisplays information about the current Transaction Groups.


DatabasesDisplays a list of configured databases, and if they have a valid connection or not. Shows active queries, long running queries, the number of queries a second that are running, as well as a trend showing the percentage of queries that completed in that time.
DesignersDisplays information on currently running Designer sessions along with some information about each session.
DevicesDisplays a list of currently configured OPC UA devices and which are connected and which have a faulty connection. It also shows how many Tags Ignition is requesting from the device along with how often it is requesting them. This information is used to determine if the device is overloaded with too many requests too quickly, or if the device is being under utilized.
Gateway NetworkShows an overview of the status of all Gateways within the Gateway Network. It also provides some metrics for each Gateway, giving an idea of the rate of data transfer between two Gateways, as well as a list of connection events.
Store & ForwardDisplays a list of Store and Forward engines, including status, as well as the number of records currently in each Store and Forward system.
OPC ConnectionsDisplays a list of all current OPC connections and their status.
Perspective SessionsShows a list of current Perspective sessions and details about each session.
Vision ClientsShows a list of current Vision Clients and details about each client.


ExecutionDisplays a status of all tasks that your Gateway runs on a schedule, such as duration and execution time of an alarm journal update or the average time ti takes a Gateway to execute a Tag Group.
LogsDisplays errors caused by Gateway events like database or device connections, authentication profiles, alarm journals, and pipelines. Logs include a wealth of information about the running state of the Gateway.
ThreadsShows what each thread is doing in the Gateway, including their state and CPU usages.

Starting and Stopping the Gateway

After installation, the Gateway starts automatically. You can manually stop and start the service. Depending on the platform you are using, the following is how you can manually start and stop the Gateway.
The Gateway runs as a service, so you can use your operating system's normal mechanisms to start or stop the service. 

Command-Line Utility

The Gateway Command-line Utility provides a list of commands you can use to perform specific functions in the Gateway such as starting and stopping the Gateway.


Ignition's installation directory contains start-ignition.bat and stop-ignition.bat, which can start or stop the service. Example:

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

However, you can also use Windows native service commands to control the running state of the Gateway:

net start ignition
net stop ignition


You can control the service using the script. It can be called with the start and stop parameters to perform the relevant operations.

For example:

/usr/local/bin/ignition/ start

Additionally, you can use native terminal commands to start or stop the service:

service ignition start
service ignition stop

Mac OS X

You can access the service from the install directory using the "" script. On a typical Mac install using the dmg installer, the full command (without a custom location specified) is the following: 

/usr/local/ignition/ start



  • No labels