Quick start guide - bluesoft-rnd/aperte-workflow-core GitHub Wiki

This article presents three basic ways of installing and starting Aperte Workflow. When facing problems with installation it might be good to take a look at [list of external documentation resources](External Documentation).

Aperte Workflow runtime bundle

By downloading this bundle one will get preconfigured Liferay with Aperte Workflow (with sample plugins) and Aperte Workflow Modeler. No changes have been made to Liferay's data. That way it's very easy to setup new runtime environment, consisting of:

  • Liferay 6.0.6
  • Tomcat 6
  • HSQL Database
  • Aperte Workflow (on top of jBPM 5.4)
  • Aperte Workflow Modeler
  • Vaadin Control Panel

Please note, that it is advised, to configure datasources and connection pool for Aperte Workflow and Liferay. Hypersonic DB is useful for demoing and development purposes only.

Step by step instructions

  1. Download latest bundle from https://sourceforge.net/projects/aperteworkflow/files/AW2.0/.
  2. Unpack to a new directory.
  3. Make sure nothing runs on local port 8080.
  4. Run $INSTALLATION_DIR/aperteworkflow-bundle/tomcat-6.0.29/bin/startup.bat (on Windows) or $INSTALLATION_DIR/aperteworkflow-bundle/tomcat-6.0.29/bin/startup.sh (on Linux/UNIX/*BSD/AIX/etc.).
  5. Navigate to http://localhost:8080.
  6. Log in to Liferay Portal. The default username is: [email protected] and password is: test.
  7. You can create pages using menu on top of the portal site or add Aperte Workflow portlets.
  8. To access Aperte Workflow Modeler - please navigate to http://localhost:8080/apertemodeler. Modeler uses Liferay API to authenticate users by screen name/email/id, so you for default, the username for modeler is joebloggs and password is test (but [email protected]/test will work too).

Credentials

To log in use default Liferay Portal credentials. Please use [email protected]/test to log in to Liferay Portal and joebloggs/test to access the Modeler.

User name User email Password Role
joebloggs [email protected] test Administrator

Aperte Workflow DEMO bundle

This bundle provides all the functionality included in Aperte Workflow bundle while also providing a sample process and preconfigured Liferay main page. If you plan to demonstrate Aperte Workflow to others you probably want to download this bundle, consisting of:

  • Liferay 6.0.6
  • Tomcat 6
  • HSQL Database
  • Aperte Workflow (on top of jBPM 5.4)
  • Sample process developed with Aperte Workflow
  • Aperte Workflow Modeler
  • Vaadin Control Panel

Step by step instructions

  1. Download latest demo bundle from https://sourceforge.net/projects/aperteworkflow/files/AW2.0/.
  2. Unpack to a new directory.
  3. Make sure nothing runs on local port 8080.
  4. Run $INSTALLATION_DIR/aperteworkflow-bundle/tomcat-6.0.29/bin/startup.bat (on Windows) or $INSTALLATION_DIR/aperteworkflow-bundle/tomcat-6.0.29/bin/startup.sh (on Linux/UNIX/*BSD/AIX/etc.).
  5. Navigate to http://localhost:8080.

Credentials

To log in use default Liferay Portal credentials.

User name User email Password Role
joebloggs [email protected] test Administrator

Standalone WAR archive

This approach assumes one has previously installed and configured Liferay Portal 6.0.X with portlet autodeploy functionality. Although the instruction provided below was prepared only for Apache Tomcat 6 chances are, that no additional steps will be required on Your application server of choice.

Step by step instructions

  1. Update Vaadin version inside your Liferay installation. You can install Vaadin Control Panel portlet to do that.
  2. Make sure that there is a JDBC DataSource defined by the JNDI name jdbc/aperte-workflow-ds. Aperte Workflow can detect lack of correct DataSource and will fall back to HSQLDB configuration. But such approach is useful for development and demoing purposes only.
  3. Download the latest aperteworkflow.war archive from http://sourceforge.net/projects/aperteworkflow/files/AW1.0/.
  4. Copy the WAR archive into $LIFERAY_HOME/deploy directory. The portlet should be installed by Liferay shortly after this.
  5. Navigate to Liferay page inside browser.
  6. From the top bar select Add > More. Now You should see new Aperte Workflow group with four portlets, as on the picture below /images/liferay/aperte-workflow-portlets-adding.png
  7. Drag or add the Aperte Workflow Activities portlet to the page.
  8. You can put any additional Aperte Workflow plugins (widgets, mule plugin, process definitions) into osgi-plugins directory - they should be detected and deployed automatically. Or you can use administrative portlets from Liferay Control Panel to manage plugins, process definitions and process instances.
  9. To install Aperte Modeler, follow these instructions .
  10. Please note, that in this configuration, no plugins have been installed. You can download ready-to-use plugins from https://sourceforge.net/projects/aperteworkflow/files/AW1.0/plugins/ and deploy them using Aperte Workflow Plugin Manager portlet available in Liferay Control Panel or by putting them inside of $LIFERAY_HOME/osgi-plugins directory. (Since 2.0, you can change OSGI default folder: Changing osgi plugins and felix-cache directory )