A project's General properties apply to the project as a whole, across all module functionality. For a new project, there are many default settings that you can use. For example, there are default settings for the Tag provider, database, publish mode, initial comm mode, window editing, and Client launching.
When properties in a section have been updated but not saved yet, the section heading will change to italicized text.
There are a few properties of a project, such as its name, description, and title that are not available from the Designer and you need to set them in the Gateway. To do so, go to the Gateway, under the Configuration > Projects section, click on the edit link next to the project. You cannot edit these settings while the project is open in the Designer.
Important Concept: Defaults
Under Project > General is where you set the project's Default Database and its Default Tag Provider. It is important to understand how to use defaults effectively for proper project design.
Wherever you use a database connection or a Tag in a project, you are always given the option to use the project's default, or an explicitly named connection or provider. If your project is like most typical projects, it primarily uses a single database and a single Tag provider. By consistently using the default option, you make your project more resilient to change.
For example, suppose you have a project, and it has a database connection named
Production_DB. Now you want to adapt the project to a new, similar plant, while leaving the existing project intact. You copy the project and create a new database connection, named
New_DB. If your project consistently used its default database connection, the switchover will be as simple as changing the copied project's default database. However, if you used the explicit
Production_DB connection in your groups and screens, you will need to laboriously switch the bindings over to
The Tag provider chosen here will act as the project's default Tag provider. To use the default provider, simply omit the source section of a Tag path, or leave it blank, for example:
|Client Poll Rate||The Client poll rate (in milliseconds) is the rate at which a Client, Session, or Ignition Designer polls the Gateway for updates to its subscribed Tags.|
|Default Database||This is the default database connection to use for this project. To use the default database connection, use the special |
The default Identity Provider (IdP) for this project. Choose from a dropdown list of IdPs.
|Always ask the IdP to re-authenticate users by default|
When enabled, authenticated uses will always need to re-enter their credentials on login. When false, if a user is already authenticated, then they will not be required to re-type their credentials when an action in the session triggers a login (such as a call to system.perspective.login).
Allowing re-authentication is entirely determined by the Identity Provider. This setting simply makes the Gateway send the re-authentication request. Consult your Identity Provider's documentation for information on re-authentication support.
|User Source||Choose the User Source that governs this project's security: specifically, which group of users (User Sources) is allowed to log into the client. The User Sources are all defined in Gateway's Configure section under the Security > User, Roles page. Note that this is for Vision projects only.|
|Required Client Roles|
This property is for Client logins, and determines what role(s) a user must have before they can log into the Client. You can optionally specify a list of roles that are required for a user to log into this project. Use commas to separate the roles. Users must have at least one of the roles in order to log in. If no roles are specified, the user only needs to correctly authenticate with the User Source in order to log in. To define the roles, go to the Gateway's Configure section under the Security > User, Roles page, click the manage users link, and then go to the Roles tab.
|Enable Auditing||If auditing is enabled, audit events that relate to this project will be stored in the chosen audit profile.|
|Audit Profile||The audit profile stores the audit events when auditing is enabled.|
When opening the project in the Designer, these properties determine which roles are required when making certain changes to the project. More details can be found on the Project Security in Designer and Gateway page.
|Required Designer Roles|
Users must have at least one of these roles to view the project in the Designer.
|Save||Users must have at least one of these roles to save the project.|
|Delete||Users must have at least one of these roles to delete the project.|
|Protected Resources||Users must have at least one of these roles to access protected resources.|
These preferences are saved on a per-project basis.
|Initial Gateway Comm Mode|
The Designer starts up in the default Comm Read-Only mode. The property allows you to change the mode the Designer starts in when viewing the project. The options are: Comm Off, Comm Ready-Only, Comm Read/Write.
For more information, see the Communication Modes page.
Vision Project Properties
There are many project properties that apply to Vision Clients. You can find more information at Vision Project Properties.
There are many project properties that apply to Perspective Sessions. You can find more information at Perspective Project Properties.