Properties in Higson

Higson gives user a possibility to configure and overwrite internal application properties. They are stored in dedicated file, named application.yml . File should be placed in container or may be pass using environment properties

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


  studio-api:
    image: decerto/higson:4.0.0
    container_name: higson-studio-api
    ports:
      - "48282:8282"
    volumes:
      - ./application.yml:/application.yml  # << here properties are passed from host in yaml file
    environment:
      - "HIGSON_DATABASE_URL=jdbc:postgresql..." # << this section let us define environment properties which has precedence over the yaml file.
      - "HIGSON_DATABASE_USERNAME=higson"
      - "HIGSON_DATABASE_PASSWORD=higson"
      - "HIGSON_DATABASE_DIALECT=postgresql" 

Configurable properties#

Property	Description	Default value
Database
higson.database.dialect	Database dialect to use. Predefined dialects available in Higson: oracle,hsqldb, h2, mssql2012, postgresql, mysql	oracle
higson.database.hbm2ddl-mode	proxy for hibernate property hibernate.hbm2ddl.auto	validate
higson.database.autoddl-action	Action to be taken during Higson Studio startup with respect to database schema update:check - verify whether schema is correctupdate - chcek database schema and update, if neededskip - do nothing	update
higson.database.url	JDBC connection url	THIS PROPERTY MUST BE SET AT SYSTEM START BY THE USER
higson.database.username	Username that Higson will use to connect to database defined in mpp.database.url	THIS PROPERTY MUST BE SET AT SYSTEM START BY THE USER
higson.database.password	Password that Higson will use to connect to database defined in mpp.database.url	THIS PROPERTY MUST BE SET AT SYSTEM START BY THE USER
higson.database.schema	Database schema wherein Higson tables exist
Environment
higson.studio.instance-name	Id identifying specific Higson Studio Instance. It is visible in Higson Studio below menu toolbar	1.5.0
higson.studio.url	Higson Studio url used in few places, for example to create url for authentication token reset, CAS authentication etc.	http://localhost:8080/higson/app
higson.studio.ui.header-color	CSS style (e.g. rgb(27, 140, 204)) defining Studio header color. If not set, default color is used
higson.studio.ui.text-color	CSS color (e.g. #7f8c8d) used on text existing in start pages.
higson.studio.ui.chart-colors	Collection of rgb colors separated by semicolon used in Higson 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
higson.studio.region.updater.task-cron	CRON expression used to schedule job updating system region versions in Higson Studio	0 1 0 * * *
higson.studio.session.require-message	Flag determining whether session message is required when publishing session	false
Security
higson.security.password-encoder.name	Name of using password encoder	bcrypt
higson.security.password-encoder.complexity	Password encoder complexity	5
higson.security.jwt.authentication-server	Determines if studio server works as authentication provider	true
higson.security.jwt.secret-key	Secret to sign and decode JWT token (up to 256-bytes chars). To communicate with UI and Runtime Rest client.	THIS PROPERTY MUST BE SET AT SYSTEM START BY THE USER
higson.security.jwt.algorithm	Determines JWT token sign algorithm (only HMAC256 supported)	HMAC256
higson.security.jwt.access-token-lifetime.value	Access token lifetime value	5
higson.security.jwt.access-token-lifetime.unit	Access token lifetime unit	Minutes
higson.security.jwt.refresh-token-lifetime.value	Refresh token lifetime value	7
higson.security.jwt.refresh-token-lifetime.unit	Refresh token lifetime unit	Minutes
higson.security.jwt.persist-refresh-token	Should persist refresh token to database (session idempotent)	true
Features
higson.studio.mail.host	Mailer server host. If host and port are not set - mailer is not loaded	""
higson.studio.mail.port	Mailer server port. If host and port are not set - mailer is not loaded	""
higson.studio.mail.username	Mailer server username	""
higson.studio.mail.password	Mailer server username’s password	""
higson.studio.mail.from	Mailer from metadata	""
higson.studio.global-search.history-limit	limit of history searches to keep in Higson Studio memory	60
higson.studio.external-environments.codes	Name for the connected environment, to SEND snapshots and Superpacks to	prod
higson.studio.external-environments.%s.url	Url to the connected environment API
higson.studio.external-environments.%s.username	Username to data source. %s is env code from property above.	admin
higson.studio.external-environments.%s.password	Password to data source. %s is env code from property above.	admin
higson.studio.snapshot.param.matrix.writer.order-by-all-level	Should sort by all levels during export decision table to file. Available: true/false	true
higson.studio.max-file-size	Specifies the size of the snapshot that can be uploaded	100MB

RUNTIME#

Available for runtime or runtime-rest apps

Property name	Description	Default Value
Database
higson.database.dialect	Database dialect to use. Available values: oracle, hsqldb, h2, mssql2012, postgresql, mysql	oracle
higson.database.url	JDBC connection url	THIS PROPERTY MUST BE SET AT SYSTEM START BY THE USER
higson.database.username	Username that Higson will use to connect to database defined in mpp.database.url	THIS PROPERTY MUST BE SET AT SYSTEM START BY THE USER
higson.database.password	Password that Higson will use to connect to database defined in mpp.database.url	THIS PROPERTY MUST BE SET AT SYSTEM START BY THE USER
higson.database.schema	Database schema wherein Higson tables exist
Environement
higson.runtime-rest.url	URL of Higson Runtime Rest
Authentication
higson.runtime-rest.security.type	Defines security type for runtime rest. Possible values: jwt, active-directory. When not set basic authentication is enabled
higson.security.jwt.secret-key	Secret key to decrypt runtime rest token	THIS PROPERTY MUST BE SET AT SYSTEM START BY THE USER
higson.security.active-directory.domain	Active Directory main root
higson.security.active-directory.url	Active Directory server url
higson.security.active-directory.root-dn	AD root domain
Other
higson.runtime.function.validate-arguments	flag determining whether function arguments data types should be validated before execution	false
higson.runtime.normalization.throw-on-exception	flag determining whether an exception should be thrown when matrix value can’t be normalized	false
higson.runtime.external-datasource.sql.names	Names of data sources list.
higson.runtime.external-datasource.sql.%s.url	Url to data source. %s is name of datasource from property above.
higson.runtime.external-datasource.sql.%s.username	Username to data source. %s is name of datasource from property above.
higson.runtime.external-datasource.sql.%s.password	Password to data source. %s is name of datasource from property above.
higson.runtime.parameter.value-never-null	Flag responsible for managing global support of nullable decision table’s results in Higson Engine. If true, decision table will return instance of pl.decerto.higson.runtime.core.EmptyParamValue when no match found. If set to false, decision table return null.	true
higson.runtime.watchers.enabled	Flag determining whether runtime watchers should start automatically	true
higson.runtime-rest.openapi.servers	Comma separated list of servers URLs used in `try it` function in OpenAPI GUI. If not filled, URL will be generated automatically.