Install System

Perform basic installation

  • Download and install Java Development Kit 8
  • Stages installation on Windows: Execute Stages installer as administrator
  • Stages installation on Linux:
    • Install RPM package
    • A user with the name “stages” is needed to allow the command “stages start” to automatically start the Stages search engine. The user needs recursive read and execute permissions on the sub-direcory “elasticsearch” and additionally write permissions on “elasticsearch/data” and “elasticsearch/logs”.
  • Database installation with Oracle 11g or 12c:
    • Download Oracle JDBC connector for your Oracle version.
    • Copy JDBC connector to “<stages installation path>/stages/lib” and rename it to “ojdbc.jar”.
    • Get Oracle database dump and installation instructions from Stages Support.
  • Database installation with MySQL5.7:
    • Download MySQL JDBC connector (Connector/J 5.1 Platform Independent) and installer for MySQL 5.7.
    • Copy JDBC connector to “<stages installation path>/stages/lib” and rename the file mysql-connector-java-*-bin.jar to mysql.jar.
    • Install MySQL 5.7 (if not already installed):
      • Select Setup Type “Server only”
      • Install MySQL with Config Type “Server Machine”, default encoding “UTF-8” and servicename “mysql”.
      • Adapt/check the following properties within “[mysql]” and “[mysqld]” section in my.ini configuration file.
        (Windows: “\ProgramData\MySQL\MySQL Server 5.7\my.ini”)
[mysql]
default-character-set=utf8

[mysqld]
character-set-server=utf8
max_allowed_packet=500M
transaction-isolation=READ-COMMITTED
lower_case_table_names=1
sql-mode = "STRICT_TRANS_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"
  • Restart the mysql service.
  • MySQL: Create database user “stages” and grant privileges.
    • Start MySQL console within path “<MySQL installation path>/bin”: mysql -uroot -p<mysql-root-password>
    • Execute the following commands:
grant all privileges on *.* to 'stages'@'%' identified by '<stages-password>';
flush privileges;
exit;
mysqladmin -uroot -p<mysql-root-password> create stages
mysql -uroot -p<mysql-root-password> stages <[PATH TO DUMP FILE\stages72_mysql57_content.sql]
  • MySQL: Establish database connection: Edit “<Stages installation path>/stages/conf/database.properties” appropriately like in the following example:
torque.database.default.driver = org.gjt.mm.mysql.Driver
torque.database.default.url = jdbc:mysql://localhost:3306/stages?zeroDateTimeBehavior=round&jdbcCompliantTruncation=false
torque.database.default.username = stages
torque.database.default.password = <stages-password>
  • Oracle: Establish database connection: Edit “<Stages installation path>/stages/conf/database.properties” appropriately like in the following example:
## settings for oracle
torque.database.default.driver=oracle.jdbc.driver.OracleDriver
torque.database.default.url=jdbc:oracle:thin:@<IP/hostname>:<port>:<SID>
torque.database.default.username=<oracle-username>
torque.database.default.password=<oracle-password>
  • Activate the configuration
    • Windows Start Menu: Execute “Programs > Method Park > Stages > Update Configuration”
    • Linux: Execute “stages update”
  • Start Stages
    • Windows: Start the services “Stages Search” and then “Stages”
    • Linux: Execute “stages start”

Configure Virus Scanner

If you are using a virus scanner on your Stages server, please exclude all MySQL database files from analysis operations as this might corrupt your database. Also excluding Stages installation directory and Java installation directory might significantly improve Stages performance.

Adjust Java Heap Space

Depending on the desired performance and the purpose of your Stages Server, we strongly suggest to adjust the Java heap space according to the following values:

  • Low-range system: 4096 MB or more
  • Mid-range system: 8192 MB or more
  • High-range system: 16384 MB or more

Please check System Requirements for detailed information on the range levels.

To adjust the Java heap space settings please proceed as follows:

  • Windows:
    • Open file “<Stages installation path>\stages\config.bat”
    • Modify the red colored setting: set TOMCAT_OPTS=–JvmMx=<RAM in MB>
    • Open a cmd with administrative permissions and navigate to folder “<Stages installation path>\stages\bin”
    • Reinstall the Stages service: reinstallService.bat
    • Restart Stages service: net start stages
  • Linux:
    • Open file “<Stages installation path>/stages/bin/rc.conf”
    • Modify the red colored value: CONF_TOMCAT_OPTS=“-Xmx<RAM in MB>m -XX:+UseG1GC -XX_-OmitStackTraceInFastThrow”
    • Restart the Stages service: stages restart

Install customer specific metamodel (if available)

If a customer specific metamodel has been migrated from Stages V6 to V7 by a Method Park product consultant, this metamodel will be provided as *.mm file. To install the metamodel please proceed as follows:

  • Windows:
    • Copy the *.mm file to directory: “<Stages installation path>\stages\conf\model”
    • Open a CMD with administrative permissions
    • Stop the Stages service: net stop stages
    • Navigate to folder: “<Stages installation path>\stages\bin”
    • Execute command: update.bat
    • Restart the Stages service: net start stages
  • Linux:
    • Copy the *.mm file to directory: “<Stages installation path>/stages/conf/model”
    • Stop the Stages service: stages stop
    • Execute command: stages update
    • Restart the Stages service: stages start

Installing Fonts

If you want to work with international UTF-8 charsets (e.g. Chinese), we suggest to install and configure Stages to use dedicated fonts:

  • Windows:
    • Process visualizations: Arial Unicode MS (subject to add. license conditions)
    • PDF Print: Arial Unicode MS (subject to add. license conditions)
  • Linux:
    • Process visualizations: DejaVu Sans Condensed (license free)
    • PDF Print: Arial Unicode MS (subject to add. license conditions)

Configuring font for Stages process visualizations (metamodel: Unified Configuration):

  • Windows:
    • Open file: “ <Stages installation path>\stages\data-cache\generated\model\unified_configuration\diagram\trunk\configs\scriptconfig.js”
    • Adjust the following setting: var FONTNAME = “Arial Unicode MS”;
    • Repeat this step for file: “ <Stages installation path>\stages\data-cache\generated\model\unified_configuration\diagram\trunk\configs\scriptconfig-bpmn_classic.js”
  • Linux:
    • Open file: “<Stages installation path>/stages/data-cache/generated/model/unified_configuration/diagram/trunk/configs/scriptconfig.js”
    • Adjust the following setting according to the font to be used:
      var FONTNAME = “Arial Unicode MS”;
      var FONTNAME = “DejaVu Sans Condensed”;
    • Repeat this step for file: “<Stages installation path>/stages/data-cache/generated/model/unified_configuration/diagram/trunk/configs/scriptconfig-bpmn_classic.js”

Configuring font for Stages PDF printing:

  • Windows:
    • Open file: “<Stages installation path>\stages\conf\config.xml”
    • Adjust the following property: <property name=“pdf.font.list” value=“C:\WINDOWS\Fonts\ARIALUNI.TTF” />
  • Linux:
    • Open file: “<Stages installation path>/stages/conf/config.xml”
    • Adjust the following property: <property name=“pdf.font.list” value=“/usr/share/fonts/TTF/arialuni.ttf”/>

Installing Stages license

  • Windows:
    • Execute the Stages license installer with administrative permissions on the Stages server.
    • The Stages service will be restarted automatically.
  • Linux:
    • Extract the .tar.gz archive to folder “<Stages installation path>/stages/conf”.
    • Restart the Stages service: stages restart

Accessing Stages

After successful installation process - Stages is accessible via web browser by URL: http://localhost:8080