h1. Flowable User Interface

Flowable provides several web applications to demonstrate and leverage the functionality provided by the Flowable project. These web applications can be used with a Petals-SE-Flowable instance.

h2. UI Applications

* Flowable-IDM: an Identity Management application that provides single sign-on authentication functionality for all the Flowable UI applications, and, for users with the IDM administrative privilege, it also provides functionality to manage users, groups and privileges.

h3. Required configuration

* Working Apache Tomcat install. Apache Tomcat can be downloaded at : [http://tomcat.apache.org/].
* Flowable distribution whose the version is the same than Petals-SE-Fowable (6.1.2). This version can be downloaded at : [https://github.com/flowable/flowable-engine/releases/download/flowable-6.1.2/flowable-6.1.2.zip].

h3. Installation

h4. Connection between API REST and Flowable UI

# Go to the Flowable directory previously downloaded, then go inside the "wars" subdirectory.
# Copy "flowable-admin.war" and "flowable-idm.war" files in "/var/lib/tomcatX/webapps" where X is the number of your Apache Tomcat install.
# Go to "/var/lib/tomcatX/lib/".
# In this directory, create a file named "flowable-ui-app.properties". Edit this file copying the texts which is available at this address : [https://github.com/flowable/flowable-engine/blob/master/modules/flowable-ui-admin/src/main/resources/META-INF/flowable-ui-app/flowable-ui-app.properties].
# Edit the following property:
#* rest.process.app.host: DEFAULT_ENGINE_REST_API_ADDRESS (0.0.0.0 by default)
#* rest.process.app.port: DEFAULT_ENGINE_REST_API_PORT (8089 by default)
#* rest.process.app.contextroot: flowable-rest-api
#* rest.process.app.restroot: /
#* rest.process.app.user: api-user
#* rest.process.app.password: user-api-password
#* idm.admin.user: kermit
#* idm.admin.password: kermit

h4. Connection between database and Flowable UI

# Go to "/var/lib/tomcatX/lib/".
# Edit "flowable-ui-app.properties" file:
## Comment all datasource.driver properties which does not refer to the type of yout database and uncomment the convenient datasource.driver property.
## Uncomment the datasource.url property and change the value property by the path/address to your database. Comment others database.url properties which are uncommented.
## Assign database login and database password to the datasource.username and database.password properties.
# In "/var/lib/tomcatX/lib/", create a file called db.properties.
# Edit this file copying the text which is available at this address : [https://github.com/flowable/flowable-engine/blob/master/modules/flowable-app-rest/src/main/resources/db.properties].
# Like in "flowable-ui-app.properties" edit the properties of this file :
* db: assign the type of your database (h2, mysql, oracle, postgres, db2, mssql).
* datasource.driver, datasource.url, datasource.username, datasource.password: assign the values that you gave to these properties in "flowable-ui-app.properties" file.

h4. Access to Flowable UI

# Go to "/var/lib/tomcatX/bin and execute startup.sh (startup.bat on Windows) script to start Tomcat.
# Go to [http://localhost:8080/flowable-idm] and you will have access to Flowable IDM, and [http://localhost:8080/flowable-admin] for Flowable-Admin.