Stages Documentation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
72:install [2020/04/20 07:28] – [Install Fonts \\] pklr72:install [2024/02/15 00:00] (current) – external edit 127.0.0.1
Line 4: Line 4:
  
   * Download and install Java Development Kit 8 (see [[:73:system_requirements|System Requirements]] for supported variants)   * Download and install Java Development Kit 8 (see [[:73:system_requirements|System Requirements]] for supported variants)
-  * Stages installation on Windows: Execute Stages installer as administrator (will be sent to you by [[stages-support@methodpark.de?subject=Stages installation package - Windows|Stages Support]])+  * Stages installation on Windows: Execute Stages installer as administrator (will be sent to you by [[stages-support@ul.com?subject=Stages installation package - Windows|Stages Support]])
   * Stages installation on Linux:   * Stages installation on Linux:
-      * Install RPM package (will be sent to you by [[stages-support@methodpark.de?subject=Stages installation package - Linux|Stages Support]])+      * Install RPM package (will be sent to you by [[stages-support@ul.com?subject=Stages installation package - Linux|Stages Support]])
       * 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".       * 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:   * Database installation with Oracle 11g or 12c:
-      * Get Oracle database dump and installation instructions from [[stages-support@methodpark.de?subject=Stages database dump - Oracle|Stages Support]].+      * Get Oracle database dump and installation instructions from [[stages-support@ul.com?subject=Stages database dump - Oracle|Stages Support]].
       * Download Oracle JDBC connector for your Oracle version.       * Download Oracle JDBC connector for your Oracle version.
       * Copy JDBC connector to "<stages installation path>/stages/lib" and rename it to "ojdbc.jar".       * Copy JDBC connector to "<stages installation path>/stages/lib" and rename it to "ojdbc.jar".
   * Database installation with MySQL5.7:   * Database installation with MySQL5.7:
-      * Get MySQL database dump from [[stages-support@methodpark.de?subject=Stages database dump - MySQL|Stages Support]].+      * Get MySQL database dump from [[stages-support@ul.com?subject=Stages database dump - MySQL|Stages Support]].
       * Download MySQL JDBC connector (Connector/J 5.1 Platform Independent) and installer for MySQL 5.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.       * Copy JDBC connector to "<stages installation path>/stages/lib" and rename the file mysql-connector-java-*-bin.jar to mysql.jar.
Line 81: Line 81:
       * Windows: Start the services "Stages Search" and then "Stages"       * Windows: Start the services "Stages Search" and then "Stages"
       * Linux: Execute "stages start"       * Linux: Execute "stages start"
 +
  
 ===== (Optional) Secure MySQL connection with SSL ===== ===== (Optional) Secure MySQL connection with SSL =====
Line 107: Line 108:
  
 </code> </code>
- 
  
 ===== Configure Virus Scanner ===== ===== Configure Virus Scanner =====
Line 127: Line 127:
   * Windows:   * Windows:
       * Open file "<Stages installation path>\stages\config.bat"       * Open file "<Stages installation path>\stages\config.bat"
-      * Modify the red colored setting: //set TOMCAT_OPTS=–JvmMx=<font inherit/inherit;;#c0392b;;inherit><RAM in MB></font>//+      * 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"       * Open a cmd with administrative permissions and navigate to folder "<Stages installation path>\stages\bin"
       * Reinstall the Stages service: **reinstallService.bat**       * Reinstall the Stages service: **reinstallService.bat**
Line 133: Line 133:
   * Linux:   * Linux:
       * Open file "<Stages installation path>/stages/bin/rc.conf"       * Open file "<Stages installation path>/stages/bin/rc.conf"
-      * Modify the red colored value: //CONF_TOMCAT_OPTS="-Xmx<font inherit/inherit;;#c0392b;;inherit><RAM in MB></font>m -XX:+UseG1GC -XX_-OmitStackTraceInFastThrow"//+      * Modify the red colored value: //CONF_TOMCAT_OPTS="-Xmx<RAM in MB>m -XX:+UseG1GC -XX_-OmitStackTraceInFastThrow"//
       * Restart the Stages service:** stages restart**       * Restart the Stages service:** stages restart**
 +
 +=== Search engine memory ===
 +
 +Depending on the size of your database it can be necessary to adjust the memory settings of the search engine. To do that open the file "<Stages installation path>elasticsearch/config/jvm.options".
 +
 +Adjust the lines<code>
 +
 +-Xms1g
 +-Xmx1g
 +
 +</code>
 +
 +After that restart the Stages search service.
 +
  
 ===== Install customer specific metamodel (if available) ===== ===== Install customer specific metamodel (if available) =====
Line 153: Line 167:
       * Restart the Stages service: **stages start**       * Restart the Stages service: **stages start**
  
-===== Install Fonts \\ =====+===== Install 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: If you want to work with international UTF-8 charsets (e.g. Chinese), we suggest to install and configure Stages to use dedicated fonts:
Line 164: Line 178:
       * PDF Print: **Arial Unicode MS**  (subject to add. license conditions)       * PDF Print: **Arial Unicode MS**  (subject to add. license conditions)
  
-__Configuring font for Stages process visualizations (metamodel: Unified Configuration):__ +__Configuring font for Stages process visualizations (metamodel: Unified Configuration) [STAGES 7.4.4.4 and earlier]:__
   * Windows:   * Windows:
       * Unzip: "<Stages installation path>\stages\conf\model\unified_configuration.mm" to "<Stages installation path>\stages\conf\model\unified_configuration"       * Unzip: "<Stages installation path>\stages\conf\model\unified_configuration.mm" to "<Stages installation path>\stages\conf\model\unified_configuration"
Line 171: Line 184:
       * Adjust the following setting: //var FONTNAME = "Arial Unicode MS";//       * Adjust the following setting: //var FONTNAME = "Arial Unicode MS";//
       * Repeat this step for file: " <Stages installation path>\stages\conf\model\unified_configuration\diagram\trunk\configs\scriptconfig-bpmn_classic.js"       * Repeat this step for file: " <Stages installation path>\stages\conf\model\unified_configuration\diagram\trunk\configs\scriptconfig-bpmn_classic.js"
-      * Add the diagram.font.list property to your config.xml file in the following way: \\ <property name=“diagram.font.list” value=“Arial Unicode MS:/destinationOfYourFontFile/arialuni.ttf”/>+      * Add the diagram.font.list property to your config.xml file in the following way: <property name=“diagram.font.list” value=“Arial Unicode MS:/destinationOfYourFontFile/arialuni.ttf”/>
       * Execute: "<Stages installation path>\stages\bin\update.bat"       * Execute: "<Stages installation path>\stages\bin\update.bat"
-      * Add a font-face to your custom.css file like this: 
- 
-<code> 
-@font-face { 
- 
-font-family: 'Arial Unicode MS'; 
-font-style: normal; 
-font-weight: 400; 
-font-display: swap; 
-src: local('Arial Unicode MS'), local('Arial Unicode MS'), url (''/pathToFont/arialuni.ttf') format('truetype'); 
-unicode-range: U+0460-052F, U+1C80-1C88, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F; 
-} 
- 
-</code> 
- 
   * Linux:   * Linux:
       * Unzip: "<Stages installation path>/stages/conf/model/unified_configuration.mm" to "<Stages installation path>/stages/conf/model/unified_configuration"       * Unzip: "<Stages installation path>/stages/conf/model/unified_configuration.mm" to "<Stages installation path>/stages/conf/model/unified_configuration"
       * Open file: "<Stages installation path>/stages/conf/model/unified_configuration/diagram/trunk/configs/scriptconfig.js"       * Open file: "<Stages installation path>/stages/conf/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";//+      * 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/conf/model/unified_configuration/diagram/trunk/configs/scriptconfig-bpmn_classic.js"       * Repeat this step for file: "<Stages installation path>/stages/conf/model/unified_configuration/diagram/trunk/configs/scriptconfig-bpmn_classic.js"
-      * Add the diagram.font.list property to your config.xml file in the following way: \\ <property name=“diagram.font.list” value=“DejaVu Sans Condensed:/destinationOfYourFontFile/arialuni.ttf”/>+      * Add the diagram.font.list property to your config.xml file in the following way: <property name=“diagram.font.list” value=“DejaVu Sans Condensed:/destinationOfYourFontFile/arialuni.ttf”/>
       * Execute: "<Stages installation path>/stages/bin/update"       * Execute: "<Stages installation path>/stages/bin/update"
-      * 
- 
-Add a font-face to your custom.css file like this: 
- 
-<code> 
-@font-face { 
- 
-font-family: 'DejaVu Sans Condensed'; 
-font-style: normal; 
-font-weight: 400; 
-font-display: swap; 
-src: local('DejaVu Sans Condensed'), local('DejaVu Sans Condensed'), url (''/pathToFont/dejavus.ttf') format('truetype'); 
-unicode-range: U+0460-052F, U+1C80-1C88, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F; 
-} 
- 
-</code> 
- 
-Note1: //The unicode-range is completely optional and can be used in combination with a font splitt up into several .woff or .woff2 files.// 
  
-Note2: //Take care, you are using the appropriate format (e.g. .ttf → truetype, .woff2 → woff2 …)//+**Caution**//: //If Stages doesn't recognize your font via the config.xml, please additionally set the JVM parameter to the path of your fonts folder: -Dsun.java2d.fontpath=“c:/yourownfolder”.
  
-<font inherit/inherit;;#e67e22;;inherit>**Caution**</font>//: //If Stages doesn't recognize your font via the config.xml, please additionally set the JVM parameter to the path of your fonts folder: -Dsun.java2d.fontpath=“c:/yourownfolder”.+__Configuring font for Stages process visualizations (metamodel: Unified Configuration) [STAGES 7.4.4.5 and newer]:__ 
 +  * Make sure the scriptconfig.js in your metamodel is up to date and contains var FONTNAME = availableFontFamilies.getConfiguredFont(); 
 +  * Place the custom font in your conf/fonts folder 
 +  * Add the diagram.font property to your config.xml file in the following way: <property name=“diagram.font” value=“DejaVu Sans Condensed:DejaVuSansCondensed.ttf”/> 
 +  * Execute: "<Stages installation path>/stages/bin/update"
  
 __Configuring font for Stages PDF printing:__ __Configuring font for Stages PDF printing:__