f) Configuration file
Frigg and braga use a configuration file (config.ini) with which is loaded at startup.
Format
Braga and Frigg both use a versatile configuration file based on the windows ini format. The config file contains the following sections:
[default]
[dev]
[stage]
[live]
Properties are mapped as strings: key=value. All values are first searched in the vm security properties.
The values in the default section are used as base values when no values are found in dev, stage or live. The stage and live sections are used according to the ip mappings contained in the default section:
stage_ips=192.168.4.55|192.168.5.55|192.168.5.56|192.168.5.57
live_ips=172.31.0.0/16|172.30.0.0/16
Dev is used when the IP does not match any stage or live server.
Ips are separted by | and ranges can be defined with /
A section (stage or live) for a specific IP can be defined as:
[stage:192.168.4.55]
The values here override the values in the respective section.
Loading
The config file resides in com.stepover.frigg.util, filename is config.ini. If a file named myconfig.ini is present this is taken instead (this can be used during development). A root config file can be set by setting a Java system property: so_config_ini pointing to a file per absolute path or url. A root config can also be placed somewhere on the classpath. The values in this root config override any values set in a config at com.stepover.frigg.util.
Audittrail
Audittrail configuration is only necessary for braga except for audit_active.
key | example | description | frigg | braga |
|---|---|---|---|---|
audit_active | true | activates the audittrail feature, default false | X | |
audit_report_documentPageNumberField | 9 | Number of the text field of the template where the page number will be written | X | |
audit_report_documentTotalFieldsForTrails | 8 | Number of fields in the document template to show audit trails | X | |
audit_report_envelopePageNumberField | 15 | Number of the text field of the envelope template where the page number will be written | X | |
audit_report_envelopeTotalFieldsForTrails | 14 | Number of fields in the envelope overview template to show the audit trails | X | |
audit_report_name_of_signer | the webSignatureOffice system | The name of the signer of the audit report | X | |
audit_report_servername_to_show | webso | To show the name of the server which generated the audit report | X | |
audit_report_signature_image_file_path | /var/data/audit/auditReportSignatureImage.bmp | In the Audit report, there is an image for the signature, give the path of the signature file here | X | |
audit_report_signature_image_x_location | 420 | The X location of the 1st page of the report where you want to show the signature image | X | |
audit_report_signature_image_y_location | 750 | The Y location of the 1st page of the report where you want to show the signature image | X | |
audit_report_template_envelop_overview_de | /var/data/audit/StepOverInternational_envelope_overview_template_de.pdf | This template will be used to for envelope audit report's overview page for DE locale | X | |
audit_report_template_envelop_overview_en | /var/data/audit/StepOverInternational_envelope_overview_template_en.pdf | This template will be used to for envelope audit report's overview page for EN locale | X | |
audit_report_template_page_de | /var/data/audit/StepOverInternational_document_de.pdf | This template will be used to generate audit report in DE locale | X | |
audit_report_template_page_en | /var/data/audit/StepOverInternational_document_en.pdf | This template will be used to generate audit report in EN locale | X |
Adhoc-Viewer / Capture Function
When selecting "smartphone/tablet" (signature type 4) the adhoc-viewer is used, when the qr-code is scanned or the link in the sms or pop-up window is opened. Capture function (QR code scan)
key | example | description | frigg | braga |
|---|---|---|---|---|
adhoc_html_signer_only | true | true or false, determines if adhoc viewer (QR code scanned) can be signed exclusively with the HTML Signer (default true) | X | |
adhoc_length | 10 | the character length of the adhoc code (default ist 10) | X | |
adhoc_lifetime_minutes | 15 | defines the validity period of the adhoc code or a generated QR Code (default is 5 minutes) | X | |
atmosphere_fallback_transport | streaming | defines the fallback transport type for the message transfer (message broker). | X | |
atmosphere_idle_time | 2 | maximum time in minutes that an atmosphere connection can be idle before it is closed (default 5) | X | |
atmosphere_servlet | the url for the atmosphere servlet used by the adhoc functionality | X | ||
atmosphere_suspend_time | 30 | maximum time that an atmosphere connection is kept alive (default 10) | X | |
atmosphere_transport | long-polling | defines the transport type for the message transfer (message broker). | X | |
jms_jndi_factory | atmosphereFactory | the jms broadcaster factory jndi name | X | |
jms_jndi_namespace | java:comp/env/jms/ | the namespace used for the jndi lookup of the jms components | X | |
jms_jndi_topic | the name of the topic created on the jms broadcaster for the adhoc code messaging | |||
jms_topic | atmosphere | the name of the topic created on the jms broadcaster for the adhoc code messaging | X | |
qr_code_host | localhost:3000 | host and port of the qrcode url | X | |
qr_code_servlet_path | /process | Path to the servlet of the QR-Code | ||
qr_code_path | /qrcodepath/ | path of the qrcode url | X | |
rabibtmq_port | 5672 | the port of the rabbitmq server (default 5672) | ||
rabbitmq_server | 192.168.4.55 | the IP or hostname of the rabbittmq server used by the adhoc functionality (message broker) | X |
URLs
The configured URLs are used to construct the links for emails or browser redirects
key | example | description | frigg | braga |
|---|---|---|---|---|
acceptContactUrl | the url for accepting contact requests (Contact page) | X | ||
invitationUrl | the url for user registration and invitation | X | ||
loginUrl | the login url (used for redirecting) | X | ||
passwordResetUrl | the url for the password reset page | X | ||
process_url | The url for the process servlet which redirects to the timelimited viewer: TimeLimitedDocumentViewer, TimeLimitedEnvelopeViewer, AdhocDocumentViewer, AdhocEnvelopeViewer, AdhocCodeHandler (redirects adhoc-codes to the adhoc viewer) | X | ||
signatureRequestUrl | Deprecated! Replaced by viewer_url and process_url; (the url for signature requests) | (X) | ||
verificationUrl | the url for the verification page | X | ||
viewer_url | The url of the viewer (document and envelope) | X |
Database
key | example | description | frigg | braga |
|---|---|---|---|---|
database_connection_properties | database_connection_properties=sslMode=trust database_connection_properties=sslMode=trust;someOtherProperty=false | These properties are used to enable SSL encryption for the connection. sslMode can be trust, verify-ca or verify-full. Several connection properties can be added as a semicolon seperated list. These properties are appended to the JDBC URL, as shown below:
https://mariadb.com/docs/server/connect/programming-languages/java/tls/ | X | X |
database_host | 192.168.5.57 | the database host (IP or hostname) | X | X |
database_jndi | java:comp/env/jdbc/FriggDb | the jndi database source | X | X |
database_master | frigg_master | Name of the master database, which manages sequences and tenants in multitenant mode. Default: frigg_master | X | X |
database_migrate | true/false | true or false. If true, flyway database management is activated | X | |
database_name | frigg | the database schema name | X | X |
database_password | kjssdduiwe832//6?! | the database password | X | X |
database_port | 1521 | the database port | X | X |
database_service_name | FRIGG | the database service name (for Oracle connection) | X | X |
database_sid | xe | the database SID (for Oracle connection) | X | X |
database_type | mysql | mysql or oracle, the database type (default mysql) | X | X |
database_user | dbuser | the database user | X | X |
db_pool_max_wait_millis | 5000 | specifies the maximum time in milliseconds that the connection pool should wait for a connection to be returned before throwing an exception. The default value is 5000. | X | X |
db_pool_max_total | 100 | specifies the maximum number of connections that the database pool can have simultaneously open. The default is 100. | X | X |
db_pool_max_idle | 20 | specifies the maximum number of idle database connections to be maintained in the pool at any given time. The default value is 20. | X | X |