This guide describes the configuration properties for all the eagle-i applications, with the following exceptions:
- Repository application (configuration properties can be found here)
- Repository for the public SPARQL endpoint (configuration properties can be found Public SPARQL Endpoint)
- Note: There are optional properties for this component listed in this guide.
The properties described here are to be used in the eagle-i-apps.properties
file. This file should be located in the eagle-i configuration directory, e.g. /opt/eaglei/conf
. Properties that are listed in red contain sensitive information, such as credentials. We strongly recommend that these properties be placed in eagle-i-apps-credentials.properties
and the file should be placed in a directory within the classpath and only accessible by a root
user, e.g. /opt/eaglei/.config
.
There are two main sections to this guide, #Description of Properties and #Applications Affected by Properties.
The first section, #Description of Properties, lists the properties, description, expected value type (e.g. String, Boolean), default value (if applicable) and if it is required. Most users will be interested in the #Basic Properties.
The second section, #Applications Affected by Properties, is an alphabetical table of all the properties described here, along with the application(s) they affect for reference.
This guide has been updated to reflect changes with the 2.0 MS 3.07 release.
Description of Properties
Basic Properties
These are the basic properties that are all applicable to all eagle-i nodes (with the above mentioned exception of the repository).
Unknown macro: {align} Property Name |
Unknown macro: {align} Description ---- Expected Value |
Unknown macro: {align} Default Value |
Unknown macro: {align} Required? |
---|---|---|---|
|
The location of the html snippet used as the top navigation on pages served from the central site. If none is provided, a backup file is used. This file may not represent the latest links. |
Unknown macro: {align} n/a |
Unknown macro: {align} no |
|
The location of the html snippet used as the top navigation on pages served from the central site. If none is provided, a backup file is used. This file may not represent the latest links. |
Unknown macro: {align} n/a |
Unknown macro: {align} no |
|
The location of the html snippet used as the top navigation on pages served from certain institution applications site. If none is provided, a backup file is used. This file may not represent the latest links. |
Unknown macro: {align} n/a |
Unknown macro: {align} no |
|
The location of the html snippet used as the top navigation on pages served from certain institution applications site. If none is provided, a backup file is used. This file may not represent the latest links. |
Unknown macro: {align} n/a |
Unknown macro: {align} no |
|
The location of the html snippet used as the top navigation on pages served from the SWEET application. If none is provided, a backup file is used. This file may not represent the latest links. |
Unknown macro: {align} n/a |
Unknown macro: {align} no |
|
The location of the html snippet used as the top navigation on pages served from the SWEET application. If none is provided, a backup file is used. This file may not represent the latest links. |
Unknown macro: {align} n/a |
Unknown macro: {align} no |
|
Indicates if the search application is an instance of an Institution Search or a Central Search. For Central Search this should be set to true. |
Unknown macro: {align} FALSE |
Unknown macro: {align} no |
|
Specifies if the SWEET application should retrieve data from the Centrally Curated Resources repository. Data retrieved will be cached. True if SWEET should. See optional Basic for additional configuration options. |
Unknown macro: {align} FALSE |
Unknown macro: {align} no |
|
A repository user who has add, remove and read access to the graph used for caching the centrally curated resource data (NG_GlobalProxy). This user is used in the automated synchronization of the centrally curated resources. |
Unknown macro: {align} n/a |
Unknown macro: {align} maybe |
|
The password for the repository user who has add, remove and read access to the graph used for caching the centrally curated resource data (NG_GlobalyProxy). |
Unknown macro: {align} n/a |
Unknown macro: {align} maybe |
|
Configures the email server hostname to be used for sending feedback via the 'Give us feedback' button. |
Unknown macro: {align} n/a |
Unknown macro: {align} yes |
|
The email address that will be used as the sender of the feedback emails when using the 'Give us feedback' button. Note: This must be a well formed email address. |
Unknown macro: {align} n/a |
Unknown macro: {align} yes |
|
The email address that will receive the feedback emails when using the 'Give us feedback' button. |
Unknown macro: {align} n/a |
Unknown macro: {align} yes |
|
Configures the port to use for the email server when sending feedback via the 'Give us feedback' button. |
Unknown macro: {align} 25 |
Unknown macro: {align} no |
|
Specifies if the email server should use SSL when sending feedback via the 'Give us feedback' button. Set to true to use SSL. |
Unknown macro: {align} FALSE |
Unknown macro: {align} no |
|
The username for sending emails via the email server for sending feedback via the 'Give us feedback' button, if required. Depending on the email server configuration, credentials may or may not be required. |
Unknown macro: {align} n/a |
Unknown macro: {align} no |
|
The password for the user for sending emails via the email server for sending feedback via the 'Give us feedback' button, if required. Depending on the email server configuration, credentials may or may not be required. |
Unknown macro: {align} n/a |
Unknown macro: {align} no |
Optional Properties
These are optional properties that may be set by an eagle-i node. If the optional properties are used for a specific feature, the description of that feature will be listed in the row above the properties. Please note that the required column here refers to if the property is required for the feature, not the basic node.
Unknown macro: {align} Property Name |
Unknown macro: {align} Description ---- Expected Value |
Unknown macro: {align} Default Value |
Unknown macro: {align} Required for feature? |
---|---|---|---|
|
Specify the google analytics ID that should be used, if any. |
Unknown macro: {align} n/a |
Unknown macro: {align} no |
|
Specifies how frequently SWEET should synchronize its cache of centrally curated resource data with the Centrally Curated Resources repository. |
Unknown macro: {align} 24 |
Unknown macro: {align} no |
|
Specifies the unit of how frequently SWEET should synchronize its cache of centrally curated |
Unknown macro: {align} HOURS |
Unknown macro: {align} no |
|
The base url for the source repository that is used to supply the data for the public SPARQL endpoint. This is the repository that the Sparqler repository should synchronize with. |
Unknown macro: {align} n/a |
Unknown macro: {align} yes |
|
The url for the public SPARQL endpoint. This is the url that is used for accessing the public SPARQL endpoint and is also the destination of the data from the source repository. |
Unknown macro: {align} n/a |
Unknown macro: {align} yes |
Enable login for Institution Search |
|||
|
Indicates if the search application should require a login. When set to true in an institution search, users are authenticated with their SWEET credentials. Note: Do not set for Central Search. |
Unknown macro: {align} FALSE |
Unknown macro: {align} yes |
|
Specify the url that users should be redirected to when they logout of the search application. Note: This should not be set if not using login. |
Unknown macro: {align} n/a |
Unknown macro: {align} yes |
|
Specifies the IRI (Internationalized URI) for the institution specific ontology. Used when specifiying institution specific annotations. |
Unknown macro: {align} n/a |
Unknown macro: {align} yes |
|
The source file containing the institution specific ontology. |
Unknown macro: {align} n/a |
Unknown macro: {align} yes |
Log search queries to a relational database |
|||
|
Specifies the base jdbc url to be used in the logging database connection string. |
Unknown macro: {align} jdbc:mysql:// |
Unknown macro: {align} yes |
|
Specifies the hostname (and port number if applicable) to be used in the logging database connection string. |
Unknown macro: {align} localhost:3306 |
Unknown macro: {align} yes |
|
Specifies the name of the database to be used in the logging database connection string. |
Unknown macro: {align} searchlogdb |
Unknown macro: {align} yes |
|
Specifies the user name for accessing the logging database. |
Unknown macro: {align} n/a |
Unknown macro: {align} yes |
|
Specifies the password for accessing the logging database. |
Unknown macro: {align} n/a |
Unknown macro: {align} yes |
Advanced Properties
The following properties have defaults that are used by the eagle-i applications. They are listed here for completeness and as a guide for contributors. Please do not override the defaults unless you are sure of what you are doing.
Unknown macro: {align} Property Name |
Unknown macro: {align} Description ---- Expected Value |
Unknown macro: {align} Default Value |
Unknown macro: {align} Required? |
---|---|---|---|
|
The frequency that search should harvest data from the repository for indexing. In Institution Search, this will determine how frequently data is to be harvested from the institution's repository. In Central Search, this will determine how frequently data is to be harvested from each of the institutions in the network. Harvesting is the process of getting any new or changed data from the repository. Resources are only found by search if they have been harvested by the search application. |
Unknown macro: {align} 30000 |
Unknown macro: {align} no |
|
The frequency that central search should check the repositories on the network for their current status. |
Unknown macro: {align} 30000 |
Unknown macro: {align} no |
|
Used for tiered option. See advanced configurations for more details |
Unknown macro: {align} n/a |
Unknown macro: {align} no |
|
Used for tiered option. See advanced configurations for more details |
Unknown macro: {align} n/a |
Unknown macro: {align} no |
|
Length of allowed idleness for a user. If a user is not active for this amount of time (default is 4 hours), the application will log the user out. |
Unknown macro: {align} 14400000 |
Unknown macro: {align} no |
|
Location of the content site. Used to build links within various applications. |
Unknown macro: {align}
|
Unknown macro: {align} no |
|
The location of the javascript for the search bar. This location should be at the root. A pre-determined folder structure to the script is used. |
Unknown macro: {align}
|
Unknown macro: {align} no |
|
URL of where the javascript search bar should perform its searches. |
Unknown macro: {align}
|
Unknown macro: {align} no |
|
The endpoint to access the node registry from applications other than central serarch. |
Unknown macro: {align}
|
Unknown macro: {align} no |
|
Specifies the location of the ontology webservice that is used by SWEET for certain drop downs. Also used by other applications to build the URL to click through to the entry in the ontology browser. |
Unknown macro: {align}
|
Unknown macro: {align} no |
|
Specifies the IRI (Internationalized URI) of the core eagle-i application layer owl file |
Unknown macro: {align}
|
Unknown macro: {align} no |
|
Accepts all certificates, including self-signed certificates for http communications that are handled programatically (i.e. between sweet/search and the repository). This is intended for use during development or while evaluating the software, without having to obtain a real certificate. To avoid possible security risks, this property must not exist in production or else it should be set to FALSE. |
Unknown macro: {align} FALSE |
Unknown macro: {align} no |
|
This flag specifies whether or not the application should be run in developer mode. Developer mode allows for bypassing certain lengthy processes that are necessary during development. To determine what bypasses are done, please look in the code. To specify developer mode should be active, set this to true. |
Unknown macro: {align} FALSE |
Unknown macro: {align} no |
|
The email address for the recipient of term requests. These are requests made by the user while using the SWEET application. The expectation for the recipient is that they will be able to resolve or delegate for resolution the term request. |
Unknown macro: {align} term-requests@eagle-i.net |
Unknown macro: {align} no |
Applications Affected by Properties
The properties are listed in alphabetical order. The applications that are affected by the property are indicated with an 'x'. Other applications refers to applications that do not currently have a user facing component, such as the ETL tool.
Unknown macro: {align} Property Name |
Unknown macro: {align} SWEET |
Unknown macro: {align} Institution Search |
Unknown macro: {align} Central Search |
Unknown macro: {align} Ontology Browser |
Unknown macro: {align} Other* |
---|---|---|---|---|---|
|
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
|
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
|
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
|
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
|
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
|
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
|
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
|
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
|
Unknown macro: {align} |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
|
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} x |
|
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} x |
|
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} x |
|
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} x |
|
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} |
|
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} x |
|
Unknown macro: {align} |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} x |
|
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} x |
|
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} |
|
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} |
|
Unknown macro: {align} |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} |
Unknown macro: {align} |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} |
|
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} x |
Unknown macro: {align} |
Unknown macro: {align} x |