Deploying Hyperon

Configurable application properties in Hyperon Studio

Hyperon Studio gives user a possibility to configure and overwrite many internal system properties. They are stored in dedicated file, named application.properties or hyperon.properties, in specified format. File should be placed in one of the listed locations:

  • Hyperon Studio classpath
  • ${user.home}/conf/application.properties
  • ${catalina.base}/conf/application.properties
  • ~/application.properties
  • ${catalina.base}/conf/hyperon.properties
  • ${hyperon.config.path}

Most important properties to configure are:

  • hyperon.database.dialect
  • hyperon.database.url
  • hyperon.database.username
  • hyperon.database.password

Configurable properties

Database dialect
Property
DESCRIPTION
DEFAULT VALUE
SINCE VERSION
hyperon.database.dialect
Database dialect to use. User can use predefined dialect (listed below) or use full class name for existing dialects (e.g. org. hibernate. dialect. H2Dialect) Predefined dialects available in Hyperon: oracle, hsqldb, h2, mssql2012, postgresql, mysql
oracle
1.21.0
hyperon.database.hbm2ddl.mode
proxy for hibernate property hibernate. hbm2ddl. auto
oracle
1.21.0
Database schema update
Property
Description
Default value
Since version
hyperon.database.autoddl.action
Action to be taken during Hyperon Studio startup with respect to database schema update: check - verify whether schema is correct; update - check database schema and update, if needed; skip - do nothing
update
1.21.0
Database connection
Property
Description
Default value
Since version
hyperon.database.schema
Database schema wherein Hyperon tables exist
1.21.0
hyperon.database.url
JDBC connection url
1.21.0
hyperon.database.username
Username that Hyperon will use to connect to database defined in mpp.database.url
1.21.0
hyperon.database.password
Password that Hyperon will use to connect to database defined in mpp.database.url
1.21.0
Environment
Property
Description
Default value
Since version
hyperon.studio.instance-name
Id identifying specific Hyperon Studio Instance visible in Hyperon Studio below menu toolbar
1.21.0
hyperon.studio.url
Hyperon Studio url used in few places, for example to create url for authentication token reset, CAS authentication etc.
1.21.0
hyperon.studio.ui.header-color
CSS style (e.g. rgb(27, 140, 204)) defining Studio header color. If not set, default color is used
1.21.0
hyperon.studio.ui.text-color
CSS color (e.g. #7f8c8d) used on text existing in start pages.
1.21.0
hyperon.studio.ui.chart-colors
Collection of RGB colors separated by semicolon used in Hyperon Studio Simulation View to differentiate datasets
190, 210, 250; 110, 150, 240; 20, 80, 220; 170, 230, 250; 70, 200, 240; 15, 150, 190; 190, 250, 205; 60, 240, 110; 10, 150, 50
1.21.0
Authentication
Property
Description
Default value
Since version
hyperon.studio.security.password.send-reset-token
Flag determining whether reset password tokens are sent: true - reset password tokens are sent; false - tokens are not sent
false
1.21.0
hyperon.studio.security.login.auto-login
Flag determining whether try to auto login user without password
false
1.21.0
hyperon.studio.security.login .attempts-limit
Number of login attempts after which cooldown, specified in property hyperon.studio.security.login.attempts-cooldown happens, is forced
3
1.21.0
hyperon.studio.security.login.attempts-cooldown
Cooldown in seconds after specified number of unsuccessful login attempts controlled by property hyperon.studio.security .login.attempts-limit
20
1.21.0
hyperon.runtime-rest.security.user-cache-enabled
flag determining whether optional user cache should be working or not
false
1.21.0
hyperon.security.basic. bcrypt.complexity
change bcrypt complexity
5
1.21.0
hyperon.setup.password-generator.enabled
set to generate if random password for admin user should be generated
1.21.0
hyperon.security.basic.password-encoder
set a password encoder (bcrypt/Pbkdf2)
bcrypt
2.0.2
CAS Authentication
Property
Description
Default value
Since version
hyperon.studio.security.cas.server-url
CAS ticket validation url
1.21.0
hyperon.studio.security.cas.login-url
CAS login url
1.21.0
hyperon.studio.security.cas.logout-url
CAS logout url
1.21.0
hyperon.studio.security.cas.logged-out-url
CAS url to go after successful logout action
1.5.0
Active Directory Authentication
Property
Description
Default value
Since version
hyperon.security.active-directory.domain
Active Directory main root (usually server domain, for example: domain.local)
1.21.0
hyperon.security.active-directory.url
Active Directory server url, for example: ldap://192.168.0.156:389/
1.21.0
hyperon.security.active-directory.root-dn
Optional DN root
1.21.0
Azure Active Directory Authentication
Property
Description
Default value
Since version
hyperon.studio.security.azure-active-directory.client-id
Azure client Id
1.21.0
hyperon.studio.security.azure-active-directory.tenant-id
Azure tenant Id
1.21.0
hyperon.studio.security.azure-active-directory.client-secret
Azure client Secret
1.21.0
hyperon.studio.security.azure-active-directory.base-url
Azure base Url
1.21.0
hyperon.studio.security.azure-active-directory.username-attribute-name
Azure username's Attribute name
1.21.0
hyperon.studio.security.azure-active-directory.roles-origin
Azure roles origin
1.21.0
JWT
Property
Description
Default value
Since version
hyperon.security.jwt.secret-key
secret key to use for jwt generation
1.21.0
Runtime
Property
Description
Default value
Since version
hyperon.runtime.parameter.value-never-null
Flag responsible for managing global support of nullable parameter's results in Hyperon Engine. If set to true, parameters will return instance of pl. decerto. hyperon. runtime. core. EmptyParamValue when no match found. If set to false, parameters will return null.
true
1.21.0
hyperon.studio.region.updater.task-cron
CRON expression used to schedule job updating system region versions in Hyperon Studio
0 1 0 * * *
1.21.0
hyperon.studio.ui.show-stacktrace
Flag determining whether full stacktrace should be shown when GUI error happened
false
1.21.0
hyperon.studio.session.require-message
Flag determining whether session message is required while publishing session
false
1.21.0
hyperon.runtime.watchers.enabled
Flag determining whether runtime watchers should start automatically
true
1.21.0
Persistent action executor
Property
Description
Default value
Since version
mpp. persistentExecutor. pool. size
Number of threads in thread pool used by persistent action executor
1
1.6.14
Session publication notifications
Property
Description
Default value
Since version
mpp. session. notify. onPublish. betweenMillis
Time period between successive attempts to send notification, in milliseconds
10000
1.6.14
mpp. session. notify. onPublish. timeoutMillis
Timeout for single POST request with notification of session publication
1000
1.6.14
mpp. session. notify. onPublish. tryForMillis
Time period in milliseconds, starting from last session publication, during which attempts to send notification of session publication are made. If notification is not sent successfully during this period, further attempts are cancelled and message content is cleared. However, if new session is published during this period, information about session changes is updated and the countdown starts again
1200000
1.6.14
mpp. session. notify. onPublish. urlsWithPassword
Comma-separated list of urls, which receive POST requests with notifications of session publication. Each address can contain: user name and password in standard form, e.g. https://username:password@url.com only user name, e.g. https://username@url.com no user info at all e.g. https://url.com
1.6.14
Global search
Property
Description
Default value
Since version
hyperon.studio.global-search.history-limit
limit of history searches to keep in Hyperon Studio memory
60
1.21.0
Studio domain extensions
Property
Description
Default value
Since version
hyperon. extension. domain. element. button. {buttonId}. profile
profile code describing domain wherein given button will be visible
1.6.5
hyperon. extension. domain. element. button. {buttonId}. business.role
assigned domain role wherein given button will be visible
1.6.5
hyperon. extension. domain. element. button. {buttonId}. caption
button's caption to use
1.6.5
hyperon. extension. domain. element. button. {buttonId}. action.get
URL to perform HTTP GET call. Available placeholders to use in URL: path, regionCode, regionVersion, collectionCode, collectionTypeCode. Usage example: http://localhost:8080/domain-test?path={path}&code={regionCode}
1.6.5
hyperon. extension. domain. element. button. {buttonId}. action. redirect
flag determining whether redirect action to URL defined in property hyperon. extension. domain. element. button. {buttonId}. action. get should happen
false
1.6.5
hyperon. extension. domain. element. button. {buttonId}. action. response
Response action after successful HTTP call. Possible values: print, parse
parse
1.6.5
Studio schedule extensions
Property
Description
Default value
Since version
hyperon. extension. schedule. column. status. label. action. get
URL to perform HTTP GET schedule status call. Available placeholders to use in URL: number, validFrom, validTo, editableTo, regionCode. Usage example: http://localhost:8080/schedule-test?number={number}
1.6.5
hyperon. extension. schedule. column. status. label. action. response. {responseValue}. color
Color (string representation, for example black or green) to be used as a status color in schedule entry. ResponseValue variable might be any string returned from URL specified in property hyperon. extension. schedule. column. status. label. action. get
1.6.5
hyperon. extension. schedule. column. status. label. action. response. {responseValue}. caption
Caption to be used in specific schedule entry. ResponseValue variable might be any string returned from URL specified in property hyperon. extension. schedule. column. status. label. action. get
1.6.5
hyperon. extension. schedule. column. action. button. visibility. action.get
URL to perform HTTP GET schedule column action button visibility check. Available placeholders to use in URL: number, validFrom, validTo, editableTo, regionCode. Usage example: http://localhost:8080/schedule-test?number={number}
1.6.5
hyperon. extension. schedule. column. action. button. {buttonId}. icon
Icon code to use in specific button. Available codes: alias, pin, copy, history, save, import, export, edit, plus, eye, delete, search, sorting, lock, maximize, minus, settings, refresh, close, open, star, bullet, ellipsis, arrow-light-right, infotip, question, hamburger, clear, reorder, key, block, skip, warning, tag, detach-region, set-region, names-codes-export, compare, mass-export, mark-from-file, yes, arrow-down, sitemap, home, eye-outline
1.6.5
hyperon. extension. schedule. column. action. button. {buttonId}. action. get
URL to perform HTTP GET schedule column action button call. Available placeholders to use in URL: number, validFrom, validTo, editableTo, regionCode. Usage example: http://localhost:8080/schedule-test?number={number}
1.6.5
hyperon. extension. schedule. column. action. button. {buttonId}. action. redirect
flag determining whether redirect action to URL defined in property hyperon. extension. schedule. column. action. button. {buttonId}. action. get should happen
1.6.5
hyperon. extension. schedule. column. action. button. {buttonId}. action. response
Response action after successful HTTP call. Possible values: print, parse
1.6.5
Studio Send Extention
Property
Description
Default value
Since version
hyperon. superpack. environments = test

hyperon. superpack. test .url
hyperon. superpack. test .username
hyperon. superpack. test .password
Sets the environment for superpack to be SEND to. Detailed instruction can be found here: https://www.hyperon.io/tutorial/how-to-configure-send-functionality-for-superpack-and-snapshot
1.20.15
hyperon. superpack. environments = test

hyperon. external. environment. test. url
hyperon. external. environment. test. username
hyperon. external. environment. test. password
Sets the environment for snapshot to be SEND to. Detailed instruction can be found here: https://www.hyperon.io/tutorial/how-to-configure-send-functionality-for-superpack-and-snapshot
1.20.15