NotifierConfigurationGuide

From RunaWFE

Jump to: navigation, search

Notifier configuration guide

Version 4.3.0

© 2015-2018, "Process Technologies" Ltd, this document is available under GNU FDL license. RUNA WFE is an open source system distributed under a LGPL license (http://www.gnu.org/licenses/lgpl.html).

Source code moved from https://sourceforge.net/p/runawfe to https://github.com/processtech.

Contents

# Application configuration (application.properties)

All non-latin values must be set in UTF-8.

Name Description Default value
authentication.type
The type of authentication used via WebServices API. To use login/password authentication set this parameter value to userinput, for Kerberos authentication set value to kerberos or sspiKerberos. userinput


server.name
Host name or IP (for server interaction via WebServices API and HTTP) localhost
server.port
Port (for server interaction via WebServices API and HTTP) 8080
server.version
Server version (is used in URL for interaction via WebServices API) auto (automatically detected)
application.server.type
Server application type is used in URL for interaction via WebServices API:
  • jboss4 - when Jboss 4 is used
  • jboss7 - when Jboss 7 is used
  • auto - application server type is detected automatically and a call to http://server:8080/version is used, that returns one of the values named above (Place version.war alongside with runawfe.ear from File:Determine appserver type.zip)
jboss7
login.relative.url
Starting page on system start up (browser authentication)
  • /login.do – form for login and password input
  • /ntlmlogin.do – NTLM authentication
  • /krblogin.do - Kerberos authentication
/login.do
check.tasks.timeout
A pause between checks if there are any new tasks (in seconds) 15
popup.autoclose.timeout
A pause between displaying message about new tasks (in seconds) 6
userinput.login.silently
When login/password authentication is used Task Notifier asks for login/password input when it starts. To make authentication automatic (without login/password dialog) this parameter value must be set to true. false
userinput.default.login
A name that is displayed in user login dialog by default Administrator
userinput.default.password
A password that is displayed in user login dialog by default wf
restart.rtn.onclose
Restart when window is closed. To save memory resources it's possible to switch on mode of restarting the application when window is closed (memory used by built-in IE cannot be freed by demand) false
start.rtn.command
A command for restarting the application, example java -Xmx64m -jar "C:/Program Files/TaskNotifier/RTN.JAR" -
sounds.enabled
Turns on sound effects on events onAppStart, onAppShutdown, onNewTask. Wav files are located in Task Notifier home directory. They are onAppStart (for application start), onAppShutdown (for application shutdown), onNewTask (for a new task arrival). It's possible to turn off sound effect for any of these events simply by deleting corresponding .wav file. true
onNewTask.trigger.command
A command to start any other application when new task arrives -
unread.tasks.notification.timeout
A periodical sound announcement about unread tasks (in seconds) 600
application.name, popup.newtasks, user.name, user.password, login.message, retry.message, error.login, error.internal, popup.no.tasks, popup.tease, popup.error, menu.open, menu.exit
user message localization

# Authentication configuration

Authentication type selection

Task Notifier authentication consists of 2 parts:

  • Authentication via WebServices API . It is used by Task Notifier to get information about new tasks. (For correct icon to display in the tray and for new task popup messages)
  • Authentication in built-in web browser. It's necessary for correct work of Runa WFE web-interface.

# Kerberos authentication (kerberos)

Create/edit configuration file krb5.ini.

This file must be located in %SystemRoot% and be named krb5.ini.

See detailed instructions for Kerberos configuration http://web.mit.edu/kerberos/www/krb5-1.4/krb5-1.4.3/doc/krb5-admin/krb5.conf.html.

Configuration file example.

Configure kerberos.properties

Name Description Default value
appName
login module name com.sun.security.jgss.initiate
moduleClassName
login module class com.sun.security.auth.module.Krb5LoginModule
useTicketCache
if cache for Kerberos tickets is used true
keyTab
use keytab file form here C:/krb5.keytab
doNotPrompt
not to use user input in any case true
debug
authentication debug mode false
serverPrincipal
SPN (login from server side) HTTP/wfserver.test.com

# Kerberos authentication (sspiKerberos)

Kerberos protocol is also used for this type of authentication, but ticket is received by Windows OS means and no additional configuration is needed.

Personal tools