This document covers the following topics:
The installation medium of the EntireX Process Extractor contains the following:
| File/Folder | Description |
|---|---|
| 3rdparty | Source of open source components used for this product. |
| Doc | Documentation as PDF documents. |
| UNIX | For UNIX platforms. |
| UNIX\EntireXProcessExtractor.tar | The runtime part, which is unpacked to a folder for the runtime installation. |
| Windows\ | For Windows platforms. |
| Windows\install\ | Folder with two installable units:
|
| Windows\lib\ | Folder with Ant JARs and related JARs. |
| Windows\scripts\ | Folder with Ant script for installation, used by install.bat. |
| Windows\install.bat | Installation script for Windows. |
| Windows\install.txt | Description of the installation process for Windows. |
| zOS | For z/OS (USS) platforms. |
| zOS\EntireXProcessExtractor.tar | The runtime part, which is unpacked to a folder for the runtime installation. |
| 3rdpartylicenses.pdf | Document containing the license texts for all third party components. |
| install.txt | How to install the product on the different platforms. |
| license.txt | The Software AG license text. |
| readme.txt | Brief description of the product. |
The runtime part of the EntireX Process Extractor is provided as file EntirexProcessExtractor.zip in folder Windows\install, which contains the following files:
| File | Description |
|---|---|
| entirex.processextractor.jar | The main JAR file for the EntireX Process Extractor. |
| com.softwareag.entirex.processextractor.analyzer.jar | The analysis engine for the EntireX Process Extractor. |
| entirex.jar | Supporting JAR file (EntireX Java Runtime). |
| commons-lang-2.6.jar | Supporting JAR file. |
| log4j-1.2.16.jar | Supporting JAR file. |
| xstream-1.2.2.jar | Supporting JAR file. |
| Readme.txt | Brief description and change log. |
| entirex.processextractor.bat | Start script for convenience (Windows). |
| entirex.processextractor.sh | Start script for convenience (UNIX and z/OS USS). |
| entirex.processextractor_shutdown.bat | Shutdown script for convenience (Windows). |
| entirex.processextractor_shutdown.sh | Shutdown script for convenience (UNIX and z/OS USS). |
| entirex.processextractor.properties | Java properties with default configuration (ASCII encoding). |
| docs/ | Folder with documentation in PDF files. |
| Examples/ | Folder with examples (example.idl and a compatible example.exar).
|
On UNIX or z/OS the file is EntirexProcessExtractor.tar with the same contents.
The design-time and runtime components of EntireX Process Extractor are available on the following platforms:
| Platform | Version | Runtime | Design Time |
|---|---|---|---|
| z/OS | z/OS 1.12 | x | |
| z/OS 1.13 | x | ||
| UNIX | Solaris 10 (UltraSPARC) | x | |
| Red Hat Enterprise Linux 5 x86 (32-bit) | x | ||
| Red Hat Enterprise Linux 5 x86 (64-bit) | x | ||
| Red Hat Enterprise Linux 6 x86 (64-bit) | x | ||
| SUSE Linux Enterprise Server 11 (32-bit) | x | ||
| SUSE Linux Enterprise Server 11 (64-bit) | x | ||
| Windows | Windows 7 x86 (32-bit) Professional Editions | x | x |
| Windows 7 x86 (64-bit) Professional Editions | x | x | |
| Windows 2008 Standard and Enterprise Edition x86 (32-bit) | x | x | |
| Windows 2008 Standard and Enterprise Edition x86 (64-bit) | x | x |
The following must be installed to use EntireX Process Extractor:
Software AG Designer and EntireX Workbench 8.2 SP2 or above.
Any supported version of EntireX. EntireX does not need to be installed on the same machine as EntireX Process Extractor.
Java 6 recommended (minimum Java 5).
ARIS PPM version 5.0.1 SR3 or above. This is required for evaluating the process data extracted with EntireX Process Extractor.
The EntireX Process Extractor is delivered with the folder structure described above. It can be installed under the following platforms:
See User's Guide for more information on how to create a working environment, extract business process data, and analyze this data, using ARIS PPM.
To install EntireX Process Extractor under z/OS USS (runtime only)
Unpack the file EntirexProcessExtractor.tar to a folder of your choice, using the following command:
pax -rvf EntireXProcessExtractor.tar -x tar -o uname=<your user>,gname=<your group>
To install EntireX Process Extractor under UNIX (runtime only)
Unpack the file EntirexProcessExtractor.tar to a folder of your choice.
To install EntireX Process Extractor under Windows
Ensure that the Software AG Designer is closed.
Double-click on the install.bat file.
Install the design-time component of EntireX Process Extractor. Enter the path where the Software AG Designer is installed and press . Example:
<webMethods suite folder>\eclipse\v36
To skip this step, leave blank and press . The design-time component will not be installed.
Install the runtime component of EntireX Process Extractor. Enter the absolute path where you would like to install the runtime component and press . Example:
<webMethods suite folder>
In this folder, a folder EntireXProcessExtractor is created for all files of the runtime component.
Note:
Do not use a relative path. This would be relative to the scripts folder of the installation medium.
To skip this step, leave blank and press . The runtime component will not be installed.
The desired components of EntireX Process Extractor are now installed.
The script files that start the EntireX Process Extractor allow command-line options as described in the table below. Alternatively, you can use system properties or a property file. The command-line option has the highest priority; the system property has second priority, and the entries of a property file have third priority.
This section covers the following topics:
The default name of the properties file is
entirex.processextractor.properties. It can be
changed by assigning an arbitrary file name with a path to a Java system
property with the name
entirex.processextractor.properties. The file is
searched for in the directory of the start script.
A sample properties file is contained in the installation folder.
Under UNIX or Windows you can use command-line arguments or Java system properties to specify the property file.
To specify the property file using command-line arguments
Enter command:
java -classpath <entirex.processextractor.jar with
path> com.softwareag.entirex.processextractor.proxy.PPM –propertyfile
entirex.processextractor.properties |
To specify the property file using Java system properties
Enter command:
java
-Dentirex.processextractor.propertyfile= entirex.processextractor.properties
-classpath <entirex.processextractor.jar with path>
com.softwareag.entirex.processextractor.proxy.PPM |
| Property | Command-line Option | Default Value | Explanation |
|---|---|---|---|
| -help | (not applicable) | Display all options with a short description. | |
| entirex.processextractor.broker | -broker | localhost:1971 | The ID of the EntireX broker to connect to. Only TCP/IP broker IDs are supported. |
| entirex.processextractor.filesize | -filesize | 10m (ten megabytes) |
The number of bytes written to a PPM file before a new file is created. Valid values: <number><character>, where the number is a positive number and the character means: b bytes, k kilobytes, m megabytes, g gigabytes. The minimum size is 1k. |
| entirex.processextractor.logfile | -logfile | processextractor.log | Path and name of the logging file. Environment variables in the
name are resolved only if used as command-line option. To write the log to
stdout, set the file name to an empty string.
|
| entirex.processextractor.loglevel | -loglevel | ERROR | Logging level. Allowed values are "OFF", "FATAL", "ERROR", "WARNING", "INFO", "DEBUG", "TRACE". OFF turns logging off, and TRACE produces the most verbose logging. |
| entirex.processextractor.port | -port | 0 (invalid) | The port number on the local machine where the Extractor listens for calls. Default is 0, which is an invalid port. Required parameter. |
| entirex.processextractor.propertyfile | -propertyfile | entirex.processextractor.properties | The name of the property file. |
| entirex.processextractor.servers | -servers | false | Process all RPC calls from RPC servers and ignore calls from RPC clients. Default is to ignore calls from RPC servers and process RPC client calls. |
| entirex.processextractor.source | -source | current working directory | The name of the folder that contains the RPC Business Activities used to extract the events. All files with extension .exar are used. Other files are ignored. An empty folder is not allowed. |
| entirex.processextractor.target | -target | current working directory | Target directory to which the PPM files are written. |
