Settings Properties
The settings.properties file is provided as part of your 1Integrate package and can be edited to configure some of the functionality of your 1Integrate installation.
Required
Property |
Type |
Description |
---|---|---|
|
string |
The database type. Defaults to a H2 database, but Oracle, SQLserver or PostGresql are also supported. Define using the values: Note: Do not use the default H2 database in production environments. See the other database options for recommended repository servers. |
|
string |
The URL for the database in which to store 1Integrate metadata and entities (Rules, Actions, Sessions and so on), and files that are uploaded to the server used by the data store (such as MapInfo Tab files). By default, his will be populated by the H2 database details. For other supported databases the format is:
|
|
string |
Username to connect to the repository schema, in which to store 1Integrate metadata and entities (e.g. Rules, Actions, Sessions) as well as files that are uploaded to the server used by the data store (e.g. MapInfo Tab files). |
|
string |
Password for the user described by |
|
string |
The location and name of the provided product licence file. |
|
string |
This is a temporary folder location for files that are eventually stored in the database. |
|
string |
The location of the cache directory. When a Session is run, a folder is created called "1Integratecache", within which the cache is stored. Note: This stores the data cache from data read by 1Integrate . This may require large amounts of disk space depending on the size of data being read into Sessions and the number of concurrent Sessions. Note: Multiple engines need to share the same cache location to allow a paused Session to be picked up and continued/rewound without restarting it. For Linux, if left blank this will default to /tmp. For Windows, if left blank this will default to Note: It is recommended that you change the default |
|
integer |
The port to use for the interface. Note: If possible, use the default port number specified in the file. If there is a clash with another application that already uses this port number, increment the value by 1 until an unused port number is found. |
|
integer |
The port to use for the engine. Note: If possible, use the default port number specified in the file. If there is a clash with another application that already uses this port number, increment the value by 1 until an unused port number is found. |
Configuration
Property |
Type |
Description |
---|---|---|
|
integer |
Configure the number of times 1Integrate will retry failed interactions with repository folders. Such failures can occur due to failed cache syncing under intense load, for example. Defaults to 3. |
|
enum |
Define where to store file-based Data Store data. Must be either ' |
|
string |
If your |
|
string |
Define the folder to load 1Integrate extension JAR files from (Data Stores, Built-ins, etc). |
|
string |
You can configure the log in screen for 1Integrate to feature a custom Login Banner Configuration. Enter a file path to a HTML document you have defined. Example: Note: The HTML file must be accessible by each Interface server. |
|
integer |
Set the default number of features in a transaction. |
|
integer |
Only necessary when |
|
string |
In the event you have multiple Data Stores utilising the same classes and attributes. 1Integrate will check that certain attributes match. By default validation will fail if there are differences in the following attributes:
Set to true to skip this validation.
|
|
enum |
Used to configure Logging Levels which control the levels of detail available in 1Integrate log files. |
|
integer |
Repository Transaction Timeouts are used to abort stuck database updates. The transaction timeout value can be tuned on your production environment to ensure you don't hit false transaction rollbacks, caused by transactions aborting too soon. |
|
integer |
The minimum number of connections to create for the repository database connection pool. Defaults to 0. |
|
integer |
The maximum number of connections to create for the repository database connection pool. More available connections in the pool will allow 1Integrate to handle more simultaneous user requests. (Ensure your database can handle the given number of simultaneous open connections). Defaults to 20. |
|
boolean |
Enabled by default, set to Repository validation checks each repository connection in your pool and will attempt to re-establish broken connections. This will enable the application to recover from network connectivity issues or a repository restart without performing a full 1Integrate restart. |
|
long |
Set the time, in milliseconds, between repository validation checks. Default to 10000. Note: When changing the setting it is important that you find the right balance between network load on the repository database and the delay on re-establishing the connection. A smaller number will recover the connection more rapidly (fewer errors will be seen), but increase the network load on the database. A larger number will take longer to recover the connection (more errors will be seen), but will reduce the network load on the database. |
|
integer |
Set the maximum number of object errors encountered before a Session is paused. Defaults to 4000. |
Security
Property |
Type |
Description |
---|---|---|
|
boolean |
Set to true to enable SSO authentication. |
|
boolean |
Set Enabling Cross Origin Resource Sharing to true if you are going to be accessing 1Integrate from a web-based application. |
|
string |
The location of the web-based application accessing 1Integrate. The Enabling Cross Origin Resource Sharing page has further information on format and examples. |
|
string |
Set to configure AES with custom key.1 |
|
integer |
Zip bomb threshold is enabled by default to prevent the uploading of heavily compressed archives to avoid these files destabilising the server. Edit this to allow uploading heavily compressed archives, with a compressed/uncompressed ratio of greater than 1:100. The default value is 0.01.” |
|
boolean |
Set to true to let 1Integrate know a proxy is in use. See 1Integrate and Reverse Proxies. |
|
string |
The name of the keystore file (including the extension) you have placed in your SETTINGS directory.1 |
|
string |
The password for the keystore you have placed in your SETTINGS directory.1 |
|
enum |
Your keystore type: PKCS12 or JKS.1 |
|
string |
The unique identifier for the key you will be using.1 |
|
string |
The password for the key you will use in the Keystore.1 |
|
boolean |
Set to false to disable the unsecure HTTP listener. 1 |
|
boolean |
Set to true to enable the HTTPS listener. 1 |
|
string |
The address that 1Integrate should listen on, this should match the common name protected by your certificate.1 |
|
int |
Change the secure HTTPS port, defaults to 8443.1 |
|
boolean |
This enables the The attribute instructs the browser to only send cookies when the request is an HTTPS one, thus cookies will not be included on HTTP requests. Note: Cookies are only used when OIDC Auth is enabled. |
|
enum |
Used to configure the level of detail available in Security log files. The following levels are supported, from highest detail to lowest:
Note: Setting a higher level will automatically set all levels under it. |
|
boolean |
Set to true to enable LDAP authentication.2 |
|
string |
The hostname for the LDAP server.2 |
|
string |
The principal (username) used for authentication with the LDAP server.2 |
|
string |
The credential (password) used for authentication with the LDAP server.2 |
|
string |
The LDAP attribute to be used for 1Integrate login names e.g. samAccountName.2 |
|
string |
The LDAP search root for users. |
|
string |
The group name attribute to be used from your LDAP server e.g. samAccountName. |
|
string |
The LDAP search root for groups.2 |
|
enum |
The protocol the connection will use (ldap or ldaps).2 |
|
integer |
The port number for your LDAP.2 |
|
enum |
Set to FOLLOW if you have multiple LDAP servers that refer to each other.2 |
|
boolean |
Set to FALSE if 1Integrate should query the users password out of the LDAP server for user credential verification.2 Note: For most installations direct verification will be sufficient. |
|
boolean |
Recursive search will search through nested groups. If this setting is unnecessary for your environment, setting to false may improve performance.2 |
|
string |
The attribute on the group object that contains the members of that group.2 |
|
enum |
Set to none if you want to bind to the LDAP server anonymously.2 Note: For security we would recommend all connections are authenticated. |
|
string |
The URL for your OIDC provider. 3 Note: Only the Keycloak OIDC provider is supported. Note: If you set |
|
enum |
Set to have the OpenID provider communicate over HTTPS.3 Valid options are:
Note: This option defaults to " |
|
string |
Set the claim value from the ID token. This will be used as the principal for the identity. Defaults to |
|
string |
The Client ID. This value will need to match the Cient ID in your OIDC Provider. Defaults to |
|
boolean |
Default to |
|
string |
The key store containing your private key and signing certificate. Must be placed in the SETTINGS folder. It must be called Alternatively, you can override the default location of the keystore by setting |
1 For more information please refer to Security Settings.
2 For more information please refer to Configuring Users and Permissions.
3 For more information please refer to OIDC Authentication
Data stores
Property |
Type |
Description |
---|---|---|
|
integer |
Defaults to 100. The number of features to write to an ESRI ArcGIS Service per batch. This affects both Commit and Copy To Tasks. |
|
integer |
The number of rows to retrieve from the Data Store in each query. Lower values will use less memory, but will take longer to retrieve all the features. Higher values will be faster, but use more memory. |
|
boolean |
Defaults to false which has a 4GB Zip file size limit. If set to true then all Data Store output files will be zipped using Zip64, meaning files lager than 4GB can be created. |
|
integer |
The number of nonconformances to retrieve at a time. Lower values will use less memory, but will take longer to retrieve all the features. Higher values will be faster, but use more memory. |
|
integer |
The maximum number of retries to make when querying features and being rate limited. |
|
integer |
The sleep (wait time) between each of the above retries when being rate limited. |
Sessions
Property |
Type |
Description |
---|---|---|
|
integer |
Set how many times to retry when attempting to change the Session state (i.e. from paused to running). Defaults to 10. |
|
long |
Set how long to delay between Session state retries. |
|
long |
Set how often to submit Sessions to Engines. Used in conjunction with Engine Labels. |
|
long |
The maximum timeout for a Session to wait for a valid engine. Used in conjunction with Engine Labels. |
|
integer |
The number of attempts to take to build a topology. Defaults to 1. |
Built-ins
Property |
Type |
Description |
---|---|---|
|
integer |
The maximum number of retries to make when using the |
|
integer |
The sleep (wait time) between the above retries. Defaults to 5000ms. |
|
integer |
The maximum number of retries to make when using the |
|
integer |
The sleep (wait time) between each of the above retries when being rate limited. Defaults to 5000ms.1 |
1See Built-in Functions for more.
MS Office 365
Property |
Type |
Description |
---|---|---|
|
string |
The webhook URL provide by Office 365.1 |
|
boolean |
Optionally set to true to receive a notification when a session is paused.1 |
|
boolean |
Optionally set to true to receive a notification when a session errors.1 |
|
boolean |
Optionally set to true to receive a notification when a session is running.1 |
|
boolean |
Optionally set to true to receive a notification when a session has finished.1. |
|
boolean |
Optionally set to true to receive a notification when a session has stopped.1 |
|
string |
The 1Integrate URL for building the Teams card. |
1See Office 365 Webhook Configuration for more.