Apromore - an online business process analytics platform
Java JavaScript CSS QML HTML SQLPL Other
Switch branches/tags
Nothing to show
Clone or download
Permalink
Failed to load latest commit information.
APM-Comp-Guards-Logic Addition of a new plugin: Verify compliance with transition guards Mar 23, 2018
APM-Comp-Guards-Portal-Plugin Re-naming of plugins for compliance and extraction of rules Apr 4, 2018
APM-Compliance-Logic Updated log-visualizer Mar 7, 2018
APM-Compliance-Portal-Plugin Re-naming of plugins for compliance and extraction of rules Apr 4, 2018
APM-Logic Updated log-visualizer Mar 7, 2018
APM-Portal-Plugin Re-naming of plugins for compliance and extraction of rules Apr 4, 2018
APQL-Portal-Plugin Updated log-visualizer Mar 7, 2018
Activity-Filter-Logic Updated log-visualizer Mar 7, 2018
Activity-Filter-Portal-Plugin Updated log-visualizer Mar 7, 2018
Apromore-Assembly Added Kotlin OSGI library to support nirdizati-training-ui portal plu… May 29, 2018
Apromore-Clients Fixed problem with logs not being public Apr 26, 2018
Apromore-Editor Updated log-visualizer Mar 7, 2018
Apromore-Extras Updated log-visualizer Mar 7, 2018
Apromore-FileStore Updated webpages Mar 12, 2018
Apromore-Manager-WS Fixed problem with logs not being public Apr 26, 2018
Apromore-Manager Fixed problem with logs not being public Apr 26, 2018
Apromore-OSGI-Bundles Merge remote-tracking branch 'origin/master' Jul 17, 2018
Apromore-PQL-Indexer Updated log-visualizer Mar 7, 2018
Apromore-Plugins Update of the BProVe plugin according to update of the BProVe Web-Ser… Mar 15, 2018
Apromore-Portal-UI-Test Updated log-visualizer Mar 7, 2018
Apromore-Portal Fixed problem with logs not being public Jun 8, 2018
Apromore-Schema Updated log-visualizer Mar 7, 2018
BEBoP-Logic Update of the BEBoP web service address in BEBoP-Logic and bug fix fo… Mar 8, 2018
BEBoP-Portal-Plugin Updated log-visualizer Mar 7, 2018
BIMP-Editor-Plugin Updated log-visualizer Mar 7, 2018
BIMP-Portal-Plugin Updated log-visualizer Mar 7, 2018
BPMNDiagramImporter-Logic Updated log-visualizer Mar 7, 2018
BPMNMiner-Logic Updated webpages Mar 15, 2018
BPMNMiner-Portal-Plugin new param for Split Miner, to enforce priority of parallelisms discov… Jul 17, 2018
BProVe-Logic Update of the BProVe plugin according to update of the BProVe Web-Ser… Mar 15, 2018
Cmapper-Portal-Plugin Updated log-visualizer Mar 7, 2018
Compare-Logic Merge branch 'master' of https://github.com/apromore/ApromoreCode Mar 7, 2018
Compare-Portal-Plugin Updated log-visualizer Mar 7, 2018
IBPStruct-Logic Updated log-visualizer Mar 7, 2018
IBPStruct-Portal-Plugin Updated log-visualizer Mar 7, 2018
Infrequent-Behaviour-Filter-Logic Updated webpages Mar 15, 2018
Infrequent-Behaviour-Filter-Portal-Plugin Updated log-visualizer Mar 7, 2018
LTL-Conf-Logic Updated log-visualizer Mar 7, 2018
LTL-Conf-Portal-Plugin Re-naming of plugins for compliance and extraction of rules Apr 4, 2018
Log-Animation-Logic Updated log-visualizer Mar 7, 2018
Log-Animation-Portal-Plugin Fixed problem with layout generator May 23, 2018
Log-Visualizer-Logic-WS Updated log-visualizer Mar 7, 2018
Log-Visualizer-Logic Fixed problem with logs not being public Jun 8, 2018
Log-Visualizer-Portal-Plugin Minor changes log visualizer May 23, 2018
Metrics-Logic Updated log-visualizer Mar 7, 2018
Metrics-Portal-Plugin Updated log-visualizer Mar 7, 2018
PQL-Indexer-Portal-Plugin Updated log-visualizer Mar 7, 2018
PQL-Logic-WS Updated log-visualizer Mar 7, 2018
PQL-Logic Updated log-visualizer Mar 7, 2018
PQL-Portal-Plugin Updated log-visualizer Mar 7, 2018
PerformanceMiner-Logic Updated log-visualizer Mar 7, 2018
PerformanceMiner-Portal-Plugin Fixed problem with logs not being public Apr 12, 2018
Predictive-Monitor-Logic There was a bug in the predictive monitor logic, in which newly-creat… May 16, 2018
Predictive-Monitor-Portal-Plugin There was a bug in the predictive monitor logic, in which newly-creat… May 16, 2018
ProDrift-Logic Added drift detection sensitivity Mar 27, 2018
ProDrift-Portal-Plugin ProDrift: setting parameters. Apr 13, 2018
Process-Plugin-API Updated log-visualizer Mar 7, 2018
Quaestio-Portal-Plugin Updated log-visualizer Mar 7, 2018
Similarity-Clusters-Portal-Plugin Updated log-visualizer Mar 7, 2018
StageMining-Logic Updated log-visualizer Mar 7, 2018
StageMining-Portal-Plugin Fixed problem with logs not being public Apr 12, 2018
Supplements Fixed problem with logs not being public Jun 8, 2018
src/site Updated webpages Mar 8, 2018
.gitignore Updated log-visualizer Mar 7, 2018
LICENSE.txt Updated log-visualizer Mar 7, 2018
Log.mxml.gz Added drift detection sensitivity Mar 27, 2018
Maven.txt Updated log-visualizer Mar 7, 2018
README Updated webpages Mar 8, 2018
build-APFS.xml BProVe Apromore plugin for Business Process Verification. Correctness… Mar 12, 2018
build.bat Updated log-visualizer Mar 7, 2018
build.sh Aris Canoniser - Cameron James Feb 4, 2013
build.xml Preditive-Monitor-Portal-Plugin wasn't starting because Predictive-Mo… Jun 7, 2018
codesigning.properties Updated codesigning Apr 13, 2018
init-FileStore.sh Corrections to Samia's model of airport departure processes. Jun 6, 2014
lgpl-3.0.txt Updated log-visualizer Mar 7, 2018
pom.xml Added Kotlin OSGI library to support nirdizati-training-ui portal plu… May 29, 2018
site.properties New version of the predictive monitor. Nirdizati is now entirely exte… Apr 18, 2018

README

Apromore Installation instructions

There are two distributions of Apromore: a *one-click* distribution, which you can simply copy/paste somewhere and run, and a *full-fledged* distribution, which requires you to manually install and configure Apromore.
The one-click distribution runs on the H2 database by default and does not support the PQL query language.
The full-fledged distribution is for developers and advanced users.  It can work on H2 or MySQL and allows greater flexibility (e.g. you can decide whether to have PQL, configure the DB root...).


ONE-CLICK INSTALLATION
=======================

REQUIREMENTS
- Windows 7 or Mac OSX 10.8 to 10.11
- Java Server Edition 1.8 (available at http://www.oracle.com/technetwork/java/javase/downloads/index.html)

* Download Apromore from http://http://apromore.org/platform/download
* Unzip the file and open the folder Apromore-Server.
* Start Apromore by executing the apromore.sh file in a Terminal if using Mac, or double-click on apromore.bat if using Windows.
* Open Apromore by clicking on the apromore.html file.


FULL-FLEDGED INSTALLATION
=========================

REQUIREMENTS
- Windows 7 or Mac OSX 10.8 to 10.11

Ensure the following software is installed:
- Java Server Edition 1.8 (available at http://www.oracle.com/technetwork/java/javase/downloads/index.html)
- Maven 3.3.9
- Ant 1.9.2
- Git 2.3.5

Additional software required for PQL support:
- MySQL 5.6.x (https://dev.mysql.com/downloads/)
- LoLA 2.0 (http://service-technology.org/lola/)


* Check out the Apromore source tree using git: 'git clone https://github.com/apromore/ApromoreCode.git'
* Change to the root of the project you checked out of git.  'cd ApromoreCore'
* Run the maven command 'mvn clean install'.  This will build the Apromore manager, portal and editor and all the extra plugins.
* Create an empty H2 database 'ant create-h2'.  Only do this once, unless you just want to reset to a blank database later on.
* Run the ant command 'ant start-virgo'.  This will install, configure and start Eclipse Virgo, and deploy Apromore.
* Apromore runs on all modern browsers.  Browse http://localhost:9000
* Ctrl-C on the command line will shut the server down.


CONFIGURATION
=============

Almost all configuration occurs in the top level site.properties file.  The default version of this file from a fresh git
checkout contains reasonable defaults that use H2 as the main database, but disable PQL (which requires MySQL or Postgres and
more intricate configuration).

H2 running from a flat file is the default database for the sake of zero-configuration.
However our development is done chiefly on MySQL; instructions for reconfiguring Apromore to use MySQL appear below.
We do have plugins for Postgres and Oracle, but some extra setup will be required since we only have sql scripts to create the
database for H2 and MySQL.

Some of Apromore's features are implemented as Java applets running client-side in the browser.  If you possess an code-signing
certificate (not an SSL certificate), you can edit the top-level codesigning.properties file to use your certificate rather
than the self-signed certificate included in the source tree.  This will avoid browser warnings.


DATABASE SETUP (MySQL)
======================

Ensure MySQL is configured to accept local TCP connections on port 3306 in its .cnf file; "skip-networking" should not be present.

Start MySQL
$ sudo mysqld_safe

Set the root password of MySQL to the default used by Apromore
$ mysqladmin -u root password MAcri

Create a database named 'apromore' in your MySQL server
$ mysqladmin --user=root --password=MAcri create apromore

Create a user named 'apromore' with the required permissions
$ mysql --user=root --password=MAcri
	CREATE USER 'apromore'@'localhost' IDENTIFIED BY 'MAcri';
	GRANT SELECT, INSERT, UPDATE, DELETE, LOCK TABLES, EXECUTE, SHOW VIEW ON apromore.* TO 'apromore'@'localhost';

Create and populate the database tables.
$ mysql --user=root --password=MAcri < Supplements/database/db-mysql.sql

At the end of the db-mysql.sql script is where we populate some of the system data including user information.  Currently, we have a few users setup that are developers or affiliates and they can be used or you can choose to add your own.  All passwords are encrypted but they are 'password' for the time being and we don't have a facility just yet to allow a user to change their password.  This is coming soon as well as a setup utility to allow the creation of a user on first running.

Edit the top-level site.properties file, replacing the H2 declarations in "Database and JPA" with the commented-out MySQL properties.
Stop and restart the server so that it picks up the changes to site.properties.


PQL SETUP
=========

PQL queries over the process store are only supported on MySQL.  Create and populate the database with additional tables for PQL:
$ mysql --user=root --password=MAcri < Supplements/database/PQL.MySQL-1.2.sql

In site.properties, perform the following changes:
* Change pql.numberOfIndexerThreads to at least 1
* Change pql.numberOfQueryThreads to at least 1
* Change pql.lola.dir to the location of your LoLA 2.0 executable
* Change the various pql.mysql.* properties to match your MySQL database

In build.xml, uncomment the inclusion of the following PQL components in the "pickupRepo" fileset:
* APQL-Portal-Plugin/target/apql-portal-plugin-1.1.war
* Apromore-Assembly/PQL-Indexer-Assembly/src/main/resources/103-pql-indexer.plan
* PQL-Logic/target/pql-logic-1.1.jar
* PQL-Logic-WS/target/pql-logic-ws-1.1.war
* PQL-Portal-Plugin/target/pql-portal-plugin-1.1.jar

Also, uncomment the following component in the "copy-virgo" target:
* PQL-Indexer-Portal-Plugin/target/pql-indexer-portal-plugin-1.1.jar


ACCESSING THE PORTAL
====================
* go to [apromore_domain]:9000/portal/login.zul
* use "admin”/“password” to access as administrator, or create a new account.


ACCESSING THE WEBDAV
====================
* go to [apromore_domain]:9000/filestore/login.html
* use "admin”/“password” to access as administrator, or create a new account.


SAMPLE DATA
===========

You can upload some sample data into the system with the following command:
$ ant install-sample-data

/airport contains a Configurable BPMN process models which demonstrate configurability
/pql contains Petri nets in PNML format from the PQL test suite
/repair contains a BPMN model which demonstrates log animation


COMMON PROBLEMS
===============

Out of memory while building.
* Either invoke "mvn" as "mvn -Xmx1G -XX:MaxPermSize=256m" or set the system property MAVEN_OPTS to "-Xmx1G -XX:MaxPermSize=256m"

Server fails to start.
* If either Apromore or PQL are configured to use MySQL, confirm that the database server is running.
* If you already run another server (e.g. OS X Server) may need to change the port number 8443 in Supplements/Virgo/tomcat-server.xml.

Login screen appears, but "admin" / "password" doesn't work.
* You may need to run "ant create-h2" to populate the H2 database.

Can't view models by clicking them in the summary list.
* Model diagrams are opened in new tabs/windows; you may need to disable popup blocking for Apromore in your browser settings.

Models always show up in the log as unable to be indexed.
* Check that LoLA executable is correctly configured.

Where is the server log?
* Apromore-Assembly/virgo-tomcat-server-3.6.4.RELEASE/serviceability/logs/log.log

I grabbed the PQL.MySQL-1.2.sql file directly from the PQL sources and it doesn't work!
* Edit the file and change the uuid attribute of the jbpt_petri_nodes table from VARCHAR(50) to VARCHAR(100) in two places