Page tree
Skip to end of metadata
Go to start of metadata

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.

Key/Values

keyexampledescriptionfriggbraga
acceptContactUrlhttps://host/frigg/login/#/contactsthe url for accepting contact requests (Contact page)X 
accept_terms_settingstruetrue or false, if terms and conditions have to be accepted before signing as a guest / in standalone viewerX 
activate_hash_dialogtruetrue or false, activates the hash dialog during signing with StepOver PadsX 
adhoc_html_signer_onlytruetrue or false, determines if adhoc viewer (QR code scanned) can be signed exclusively with the HTML SignerX 
adhoc_length10the character length of the adhoc code (default ist 10)X 
adhoc_lifetime_minutes15defines the validity period of the adhoc code or a generated QR Code (default is 5 minutes)X 
admin_email_notifiersomebody@host.com;someoneelse@host.coma list of recipients who are informed when accounts are charged with help of the admin functions or when user bought creditsX 
always_mobile_viewer_on_mobile_devicetruetrue or false, determines whether on mobile devices can be signed exclusively with the HTML Signer (no matter if 'desktop browser' is set or not)X 
app_signature_certificate_filenamed:\frigg\data\app_signature_public.derthe certificate path for the app signature with token authentication X
app_signature_certificate_passworddsf433dreE&%the certificate password for the app signature with token authentication X

app_signature_certificate_private_key_filename

d:\frigg\data\app_signature_certificate.pfxthe certificate private key path for the app signature with token authentication X
atmosphere_servlethttps://127.0.0.1:8443/atmosphereServletthe url for the atmosphere servlet used by the adhoc functionalityX 
axis_request_timeout240000the braga request timeout in millisecondsX 
axis_server_ip192.168.5.56the IP or hostname of the braga serverX 
axis_server_port8080the braga server portX 
axis_server_protocolhttpshttps or https, the protocol used for the braga serverX 
braga_create_copytruecreates a copy of the PDF without biodata (if flag is true)X 
braga_render_dpi200the dpi with which pages are rendered (default is 200)XX
cash_account_namestepover_cash_accountthe name of the cash account, matches db name column in accounting_account table (for credit handling)X 
context_sign_modetruetrue or false, shows an overview of the context in combination with signing with HTML-signerX 
cookie_nameSOSESSIONIDthe cookie name for the session cookieX 
cookie_path/the cookie pathX 
credit_eur_value0.85the vlaue of one credit in EURX 
credit_usd_value0.95the value of one credit in USDX 
credit_free3how many free credits are given initially (after registration)X 
credit_free_monthly3the amount of free credits per monthX 
credit_signature_request1value how many credits one signature request costs ('0' for no credit charge)X 
credit_mail_identification10value how many credits a mail identification costsX 
credit_sms_identification1value how many credits a sms identification costsX 
database_host192.168.5.57the database host (IP or hostname)XX
database_jndijava:comp/env/jdbc/FriggDbthe jndi database sourceXX
database_namefriggthe database schema nameXX
database_passwordkjssdduiwe832//6?!the database passwordXX
database_port
1521the database portXX
database_service_name 
FRIGGthe database service name (for Oracle connection)XX
database_sid
xethe database SID (for Oracle connection)XX
database_typemysqlmysql or oracle, the database typeXX
database_userdbuserthe database userXX
deactivate_document_downloadtruetrue or false, deactivates the download button on the viewer (for finished or failed requests)X 
deactivate_final_status_popuptruetrue or false, deactivates the final status popup shown after all fields have been signedX 
deactivate_geolocationtruetrue or false, deactivates the geolocation query in the browserX 
deactivate_optional_fields_popuptruetrue or false, deactivates the appearance of the popup after skipping the last optional field of a signature request which asks for ignoring the field (sign later) or finishing the request (only if there are no mandatory fields!)X 
deactivate_reject_buttontruetrue or false, deactivates the reject button during signingX 

deactivate_remember_sign_type

truedeactivates the "remember sign type" checkbox of the signature type selection popupX 
emailFromsystem@webSignatureOffice.comthe from mail header added to emails sent by the systemX 
emailPort25the smtp portX 
emailRetries5how many times the mailer retries to sent an emailX 
emailSmtphostname.domainthe smtp server used to sent mailsX 
emailSmtpPasswordpasswordthe smtp server passwordX 
emailSmtpUsersmtpuserthe login for the smtp serverX 
emailTlsfalsetrue or false, enable or disable TLS (encryption)X 
enduser_certificate_duration36the lifetime of user certificates in months X
enduser_certificate_key_length2048the length of the create user certificates X

extra_password_prompt

truetrue or false, activates an extra password prompt in the iSignatureOffice / aSignatureOffice app (authentication with fingerprint or face ID).
see also flag 'password_interval'
X 
file_upload_max_file_size20480the maximum upload size in bytesX 
file_upload_urlhttps://host/fileUpload/fileUploadthe url for the file upload (via tyrservice)X 

formfields_writable_for_others

falsetrue or false, allows other signers to edit formfieldsX 
guest_certificate_passwordkkwJk34$ldP%the guest certificate password (for non-registered webSignatureOffice user certificates)XX
guest_email
guest@websignatureoffice.comthe email pattern for guest email addressesX 

has_license

falsetrue or false, usage for licence model (valid license file required)X 
html_signer_signature_field_width10defines the signature field width for signing with html-signer in cm, default is 14cm.X 
intermediate_certificate_filename/frigg/data/cert.pemthe full path to the intermediate certificate for user certificate creation X
intermediate_certificate_passwordsduiSUm7$%&hJthe intermediate certificate password X
intermediate_certificate_private_key_filename/frigg/data/cert_private.pemthe full path to the internmediate certificate private key X
invitationUrlhttps://host/frigg/Registration.htmlthe url for user registration and invitationX 
invoice_mail_recipientssomebody@host.com;someoneelse@host.coma list of recipients who receive a copy of all invoices created by the system (for credit purchase)X 
mail_passwordoekopostpasswordthe password for the mail verification account (seperate provider)X 
mail_useroekopostuserthe user for the mail verification account (seperate provider)X 
max_message_size20480the max tyrservice message size (optional value)X 
memcached_port11211the memcached portXX
memcached_server192.168.5.57the ip or hostname of the memcached server if memcahe is usedXX
memcached_sessionstruetrue or false, the switch if memcached should be used for session managemeantXX
notaryInfo\n======================( NotaryInfo )====================== \n \nSomebody the notary info added to a biometric signatureX 
notary_public_key

dshkskdhNSSKhjadsbndskKJHKHSAK \
DGHgdhjdsgJHDDSHJGdshdshdJDHDSJH \

the public key base64 encoded that is assigned new registered users. This key is used by the web signature office apps.X 
notary_public_key_hashdskhdksjhds89s8djdshkjhsd7987987dsdssda md5 hash of the public keyX 
org_quartz_propertiesquartz.propertiesthe name of the quartz scheduler configuration file in the classpath (for the automated jobs)X 
openssl_run_directoryc:/tempthe path to a folder in which openssl can run X
otp_lifetime_seconds
30

the validity for the One-time password (OTP) for an auto-login via webservice-API

X 
password_intervalALWAYSIf extra_password_prompt is activated, you can use password_interval to specify how often the query should appear. Possible values: ALWAYS, DAILYX 
passwordResetUrlhttps://host/frigg/PasswordReset.htmlthe url for the password reset pageX 
pdf_render_max_render_threads4the max number of render threads X
process_encrypted_urlsfalseIf the value is "true", the adhoc URL (option "SHOW LINK") is displayed encryptedX 
process_pool_timeout120000timeout for a process from the process pool in milliseconds X
rabbitmq_server192.168.4.55the IP or hostname of the rabbittmq server used by the adhoc functionality (message broker)X 

render_strategy

AllPagesthe strategy used to render the pdf pages, possible values are OnlyPagesWithSignatures, AllPages, FirstTwoAndPagesWithSignatures. Default is FirstTwoAndPagesWithSignaturesX 
request_lifetime7200the request lifetime in seconds.X 
rest_api_allowed_hostslocalhost,192.168.5.2,192.168.5.5the allowed hosts for the communication with the REST API (Cross-Origin-Requests)X 
rsa_encryptor_urlhttps://host:8444/RsaEncryptor/encodethe url of the RSA encryptor used by the html signer, if no value is set the default RSA encryptor of the frigg module is takenX 
session_sync60session sync interval in seconds (memcached)X 
session_timeout6000session timout in milleseconds (browser session)XX
show_pages_preview1handles the page preview display in the document viewer (in apps and browser)
0 = deactivated, 1 = activated
X 

show_selection_capture

trueactivates/deactivates the "SMARTPHONE/TABLET" option of the signature type selection popup (default = true)X 

show_selection_display

trueactivates/deactivates the "ON THIS DISPLAY" option of the signature type selection popup (default = true)X 

show_selection_pad

trueactivates/deactivates the "SIGNATURE PAD" option of the signature type selection popup (default = true)X 
show_toc1handles the table of contents display in the document viewer (in apps and browser)
0 = deactivated, 1 = activated
X 
signatureRequestUrlhttps://host/frigg/login/#signature_requestthe url for signature requestsX 
signature_timeout_ms3000defines the timeout/pause in milliseconds before a pad signature is automatically completed (without pressing confirm button)X 
smsPasswordsmspasswordthe sms account password (for the sms delivery feature)X 
smsSenderstepoverthe name displayed as sms sender (for the sms delivery feature)X 
smsUserId / authToken4327634 / 1ED33261VI0I6659347456Bthe sms account user id or authToken (for the sms delivery feature)X 
storage_homeX:/data/the full path for storage of documents and certificates (BRAGA) X
support_emailsupport@websignatureoffice.comthe email address for support notifications / inquiriesX 
tracking-headerx-idheaderthe name of the http header used for the additional tracking id logging. Default is x-trackingX 
tyrservice_debuggingtruetrue or false, enables an extended logging for tyrservice classes (if no value is set the default is false)X 
tyrservice_publicfalsetrue or false, wether the public tyrservice services should be available, public services only use the adhoc code for authenticationX 
verificationUrlhttps://host/frigg/Verification.htmlthe url for the verification pageX 
webso_events_urlhttps://www.testserver.com/CallbackServlet

WebSignatureOffice can be configured to call an URL on certain events. This functionality is activated by setting the URL to be called in the config.ini

Further configuration options are:

webso_events_filter:  a comma separated list of events that should be fired, if this option is not set, all events are fired.
webso_events_retry: the time waited in milli seconds untill the event call is repeated.


For more information, please check: e) Callback-API

X 

 

 
 
 
 
 
 
 
 
  • No labels