ARIS PPM System Architecture

Copyright (C) Software AG All rights reserved. The content of this document is subject to copyright law.
Any changes, modifications, additions, or amendments require prior written consent from Software AG. Reproduction in any form is only permitted on the condition that the copyright notice remains on the reproduced document. Publication or translation in any form requires prior written consent from Software AG. This manual describes the settings and functions as they were at the time of print. Since manual and software are subject to different production cycles, the description of settings and functions may differ from actual settings and functions. Information about discrepancies is provided in the Readme file that accompanies the product. Please read this file and take the information into account when installing, setting up, and using the product. Software AG does not control the external Web sites to which links are provided. Software AG is not responsible for the content of such Web sites or further links provided on them. External links are provided solely for your convenience and do not imply endorsement of the content of linked sites by Software AG. "ARIS", "IDS", "ProcessWorld", "PPM", and the symbol are trademarks or registered trademarks of Software AG in Germany and in many countries all over the world. SAP NetWeaver is a trademark of SAP AG, Walldorf. All other trademarks are property of their respective owners. U.S. pat. D561,778, pat. D561,777, pat. D547,322, pat. D547,323, pat. D547,324
ARIS Process Performance Manager
Contents
1 2 3 General ................................................................................................................ 1 Information on how to use this guide ....................................................................... 2 Overview ............................................................................................................. 3 3.1 3.2 4 4.1 4.2 4.3 System components..................................................................................... 3 Basic information on in-memory technology .................................................... 6 Network protocols ........................................................................................ 7 PPM network protocols ................................................................................. 7 Loading the PPM user interface ...................................................................... 9 HTTP protocol ................................................................................... 9 HTTPS protocol ................................................................................. 9 Data transfer default ....................................................................... Data transfer using HTTP tunneling ................................................... Compressed data transfer ................................................................ Encrypted data transfer ................................................................... Data transfer via HTTPS proxy .......................................................... A client server with only one port ...................................................... Multiple client servers with only one port ........................................... 12 13 15 15 16 17 18
PPM network ........................................................................................................ 7
4.3.1 4.3.2 4.4 4.4.1 4.4.2 4.4.3 4.4.4 4.4.5 4.4.6 4.4.7 4.5 4.5.1 4.5.2 4.5.3 4.6 4.6.1 4.6.2 5 5.1 5.2 6 6.1 6.2
PPM client-server data communication ......................................................... 10
System design of the PPM network .............................................................. 20 2-tier ............................................................................................. 20 3-tier ............................................................................................. 21 4-tier ............................................................................................. 22 Initializing a scaled system ............................................................... 25 Expanding a scaled system ............................................................... 26
Distributed PPM server systems ................................................................... 23
Install ARIS PPM ................................................................................................. 28 Directory structure after installation ............................................................. 28 PPM licensing ............................................................................................ 30 PPM environment variables ......................................................................... 31 PPM configuration files ............................................................................... 32 Structure ....................................................................................... 32 Global configuration files .................................................................. 32 Registry .................................................................................... 33 SSL .......................................................................................... 34 Help ......................................................................................... 35 Client-specific configuration files ....................................................... 35 AdapterConfig ........................................................................... AnalysisServer ........................................................................... Chart ........................................................................................ CNet (Communication Net).......................................................... Corba server ............................................................................. Database .................................................................................. EPC .......................................................................................... 35 35 37 37 39 40 43
Configuring the PPM system ................................................................................. 31
6.2.1 6.2.2 6.2.2.1 6.2.2.2 6.2.2.3 6.2.3 6.2.3.1 6.2.3.2 6.2.3.3 6.2.3.4 6.2.3.5 6.2.3.6 6.2.3.7
6.2.3.8 6.2.3.9 6.2.3.10 6.2.3.11 6.2.3.12 6.2.3.13 6.2.3.14 6.2.3.15 6.2.3.16 6.2.3.17 6.3 6.3.1 6.3.2 6.3.3 6.4 6.5
EPC import ................................................................................ Initdb ....................................................................................... InitSystem ................................................................................ Keyindicator .............................................................................. Mail .......................................................................................... RE (Relation Explorer) ................................................................ RMIServer ................................................................................. Report ...................................................................................... Server ...................................................................................... Templates .................................................................................
47 48 48 49 50 52 54 55 61 63
System adaptations ................................................................................... 64 Adapting the RMI and Corba ports ..................................................... 64 Adapting the Java Plug-in URL .......................................................... 64 PPM user interface without Web access .............................................. 65
64-bit systems .......................................................................................... 65 PPM clients ............................................................................................... 65 Create client ................................................................................... 65 Creating clients interactively........................................................ 65 Deleting clients ............................................................................... 66 6.5.1.1
6.5.1 6.5.2 7 7.1
Starting the PPM system ...................................................................................... 67 Running the PPM server components ............................................................ 67 Manual start ................................................................................... 67 Scaled system ........................................................................... 67 Automatic start ............................................................................... 69 Setting up JSL ........................................................................... 69 Important jsl.ini key names ......................................................... 71 Scaled system ........................................................................... 71 Establishing the PPM user interface and PPM server connections ........... 72 Transferring parameters for the login dialog ....................................... 72 Localizing the PPM server ................................................................. 73 7.1.1.1 7.1.2 7.1.2.1 7.1.2.2 7.1.2.3 7.2 7.2.1 7.2.2 7.3 7.3.1 7.1.1
Running the PPM user interface ................................................................... 72
PPM command line programs ...................................................................... 72
Maintenance and system support .......................................................................... 74 8.1 8.2 Backing up the PPM system ........................................................................ 74 Restoring the PPM system........................................................................... 74
9 10 11 12
Uninstall ............................................................................................................ 76 Tips & tricks ....................................................................................................... 77 Glossary ............................................................................................................ 78 Appendix............................................................................................................ 79
II
General
This manual describes the implementation and operation of ARIS Process Performance Manager, also called ARIS PPM or PPM, in the user's system. It explains the relationships and data flows between the PPM system components and introduces various installation types. In addition, the architecture and operation of the software as well as the installation settings and their effects are documented. It provides the technical administrator of the PPM system with basic knowledge and configuration expertise to help him to implement, adapt, and maintain different system environments. Please note that this manual is not intended to replace user or customizing training. It is a source of reference containing information that supplements the information provided in the manuals and online help.
Information on how to use this guide

This chapter provides information on how to use this manual. In this manual, menu items, file names, etc. are identified by the following notational and formatting conventions. Notation/formatting Menu items, key combinations, the keyboard, etc. are shown in bold type. Example Enter system as the user name and Click on Help to access the Help menu items and open further information sources. Sequences of menus and menu items are separated by forward slashes. Right-click on the chart background and select Display options/Show absolute indicator values. User-defined entries are highlighted Enter the path <Directory>\PPM. in bold and enclosed in angle brackets. One-line example texts (e. g. a long D:\Program Files\ppm\ directory path) that need to be shown on several lines due to a lack of space are separated by the icon at the end of the line. Particular text sections are specially identified: Warning Warnings indicate important instructions, where a loss of data is possible or a safety risk could arise if they are not observed. Note Notes provide you with important additional information. Tip Tips indicate references to explanatory notes, e.g. in manuals or in the online help. See also This refers to further information on the same topic or related topics within the document. xml\Adapter
dialog boxes, file names, entries via manager as the password.
Overview
ARIS Process Performance Manager is a tool designed to analyze actual working processes. The data comprising the steps of these processes is extracted from application systems and consolidated to process instances. Then, KPIs are calculated for these process instances. In this way, ARIS PPM provides a comprehensive overview of the processes in a company and supports you in identifying weak spots. ARIS PPM uses an SQL RDBMS as the repository in which all configurations and data are saved. ARIS PPM has been developed in Java as a client-server application.
3.1
System components
A 3-tier architecture (three application levels) was selected to implement the PPM system. The PPM application server (see graphic) and Web server represent the transmitter between the ARIS PPM user interface (visualization) and the database server (repository).
ARIS PPM user interface With the ARIS PPM user interface, you can analyze and visualize previously calculated process characteristics. PPM server The PPM server comprises two components: a registry server and at least one client server. The client server imports the data to be analyzed from the application systems, calculates KPIs, and generates charts and evaluations on demand by the ARIS PPM user interface. The PPM administrator manages all system data with the help of a command line interface. It is not necessary to access the database server directly.
Analysis server With the introduction of in-memory architecture in ARIS PPM 5.0.0, all process data are stored for analysis in the main memory (analysis server). This type of memory is very efficient and enables fast response times even for complex analysis queries. The in-memory architecture replaces the DB star schema which has been used by PPM versions up to and including the main version 4 (PPM 4). Each PPM server cooperates with a single instance of an analysis server, with the analysis server being implemented as a separate process and thus capable of being started and stopped independently of the PPM server. Database server The database server persistently stores all PPM-relevant data: Process instance data, configuration data, user data (e.g. favorites) of the PPM components. Essentially, it is the system's data basis. From PPM main version 5 (PPM 5), the database no longer contains tables for the InfoCubes of the star schema. Only merged and calculated process instances are saved. When querying analysis results in PPM 5, SQL queries are no longer sent to the database (except for the representation of processes in EPC view), but the data is determined only by the analysis server now. Web server The Web server stores the PPM HTML pages, the executable program modules of the ARIS PPM user interface in the form of Java applets (code base for all ARIS PPM user interfaces in the network), and the PPM online help. The Web server must be available during the entire runtime of the PPM system and the user interface. The data exchange between PPM user interface and server is performed during runtime via the Java RMI protocol. Web application server The Web application server publishes the following Web applications: Management views and _APD. Both Web applications use the jaas authentication method to protect against unauthorized access. Communication takes place only via the http protocol on the port for the Web application server. Selected analyses can thus be processed and easily made available worldwide on the Internet.
3.2
Basic information on in-memory technology

Changing the system architecture in PPM 5 to in-memory technology results in the following changes Data for analysis queries is saved in the main memory. This process is carried out using an analysis server. From PPM 5, all analysis queries via PPM GUI are no longer sent to the database, but to the analysis server. The analysis server uses PPM logic in the main memory. It runs in a separate JVM to simplify memory management for Java and enable a separate reboot of the PPM server. The analysis server is started via the batch file startup_<ppmclient>.bat, which is created during the client installation in ARIS PPM CTK together with the PPM server. During the data import into the PPM system, the special data structures of the analysis server are filled with all data required for the analysis. The analysis server is designed for non-stop operation. If new data is imported into the PPM system, not all data must be extracted again from the persistence layer. Only changed data is inserted into the memory structures of the analysis server and thus updates the entire data. The main memory structures are volatile and must be completely re-built after a system failure. To keep downtime to a minimum after a system error (e.g., PC reboot), the analysis server saves a recovery file called <ppmclient>.recovery under %PPM5_HOME%\recovery, which it uses to reinitialize itself after a reboot. The initial recovery file is automatically created after the first successful PPM import in that directory and is updated with every new import (runppmimport.bat). You can use the batch files runppmanalysisserver.bat and stopppmanalysisserver.bat to start and stop the analysis server independently. You can use special parameters of the command line program runppmimport.bat to eliminate possible data inconsistencies between PPM server and analysis server and to configure recovery file options. For detailed information on this topic, please refer to the technical reference ARIS PPM Customizing, chapter runppmimport.
PPM network
ARIS PPM uses the default protocols of the TCP/IP network to exchange data. This chapter provides a brief overview of the exchange of data within a computer network, the data flows between the ARIS PPM components, and possible ARIS PPM implementation scenarios.
4.1
Network protocols
Information exchange on the Internet is based on the TCP/IP network protocol (Transmission Control Protocol/Internet Protocol) and executed by means of direct socket connections. The TCP/IP protocol is a fault-tolerant protocol that detects and eliminates transmission errors. The computer's IP address and a port number determine a unique socket. The server program generates a socket upon boot-up and waits for requests. A client computer connects to the server by generating a socket and connecting it to the socket of the server. Next, the information exchange takes place within the protocol set by the server socket. The connection is terminated when one of the partners closes the socket. This is usually the client because the server waits for further requests. The port numbers up to 512 are reserved for specific transmission protocols. They are called well-known ports and must only be used for the respective protocols. The following fixed server port numbers (in parentheses) have been assigned on the Internet to particular transmission protocols: HTTP (80), FTP (21), telnet (23), SMTP (25), POP3 (110), and HTTPS (443). In contrast to the default port numbers of a transmission protocol, you can choose the port number for each protocol. The client and server must use the same port number. Note A socket connection must be unique throughout the Internet. A port can only be assigned once on each computer.
4.2
PPM network protocols

Communication among the PPM components is based on TCP/IP. Other protocol families (e.g. IPX, SPX) are not supported. ARIS PPM uses the following TCP/IP protocols:
Connection Client PPM user interface Server Web server
Protocol Name HTTP (HTTPS) Default port 80 (443) 16300, 16301, ... 1521 16390, 16389 16350
PPM user interface PPM server Dashboard Dashboard Web client
PPM server
RMI
Database server JDBC PPM server Web application server Corba HTTP
RMI (Remote Method Invocation) PPM server and user interface use this protocol to exchange data. ARIS PPM uses the protocol variant JRMP (Java RMI Message Protocol) as the transfer standard. The PPM user interface usually requires two RMI communication channels (socket connections): one for the cross-system RMI registry server and the other for the RMI client server, i.e. the PPM server itself. By default, the RMI protocol requires a direct socket connection. Note For further information, please refer to the chapters Data exchange via RMI (Page 10) and RMI protocol (Page 15). Under certain circumstances, you can configure the PPM system so that only a single RMI communication channel is needed (see chapter PPM system with only one port (Page 17)). Corba (Common Object Request Broker Architecture) The ARIS Performance Dashboard Web application uses this widely-used protocol to communicate with the PPM server. JDBC (Java DataBase Connectivity) Java applications use this standardized protocol to access an RDBMS. The JDBC drivers required for this are supplied with the RDBMS. SMB (Small Message Block) Microsoft protocol for sharing files and printers in the network. If the PPM server and Web server are installed on different computers, you can use this protocol to enable data exchange at the file system level.
HTTP (Hyper Text Transfer Protocol) ARIS PPM uses this protocol only to transfer the HTML document pages, text-based configuration files (*.properties), and Java archive files required to run the PPM user interface in the browser. The Web application server also uses this protocol to publish ARIS Performance Dashboard and Management views. Note Instead of the HTTP protocol, you can also use the secure variant, HTTPS.
4.3
Loading the PPM user interface

The PPM user interface runs in the client computer's Web browser. Depending on user interaction, JAR files are transferred from the PPM Web server to the PPM user interface and executed in the Java Runtime Environment of the browser plug-in.
4.3.1
HTTP protocol
After startup, the PPM user interface downloads the file Registry_settings.properties via the URL http://<PPM-web-Server>/<ppm base>/clientjars/Registry_settings.properties and establishes a connection to the PPM server specified in the RMIServerURL key.
4.3.2
HTTPS protocol
If you want to use the secure HTTPS protocol instead of the HTTP protocol described in the previous chapter, you need to use a Web server that supports this protocol. A special version of the Apache Web server is available (BigApache open source project) with HTTPS capability plus other extended features, e.g. direct PHP and mySQL support. The IIS Web server from Microsoft also supports HTTPS. It is located on every Windows installation CD and can be installed later, if required. Information about enabling the HTTPS protocol in IIS can be found on the Internet. Note Using the HTTPS protocol for the PPM web server renders only loading runtime files and configuration files secure. The RMI data communication between PPM server and user interface is not affected by the Web server encryption. The chapter on Encrypted data transfer (Page 15) describes how to encrypt RMI data communication with SSL, as well.
Note Before installing the PPM software, you should decide whether or not you want to use the HTTPS protocol. Changing the protocol after installation is not recommended. If you use the HTTPS protocol, make sure that you use https instead of http to specify all Web server URLs for the PPM system during installation. You need certificates for the Web server used. A certificate is made up of two keys, a public and a private key. The keys are signed by a Certificate Authority (CA). Note Simple programs (e.g. SimpleCA) for creating server certificates are available on the Internet. Note When creating a certificate, make sure that you specify the computer name of the Web server exactly as it will be addressed later, e.g. ppm.mycompany.com. Server certificate The private key for the server certificate remains on the Web server. The public key is automatically installed on the client (Web browser) the first time the https URL is called up after the user agrees to its installation. Root certificate A root certificate is a certificate signed by a trustworthy issuer (e.g. Thawte or Verisign). The server certificate used is signed with the private key of the root certificate. The public key of the root certificate must be installed for validation of the server certificate signature in the browser. Only then will an installed and valid server certificate be accepted.
4.4
PPM client-server data communication

All data exchange between the PPM server and PPM user interface is based on Java RMI objects. The PPM user interface calls methods in its environment that are executed on the PPM server. The functions of the PPM server are realized in multiple RMI objects. Upon launch, each PPM client server registers at the PPM registry server with a unique name. This name consists of ppm_server_ (fixed part) and the name of the PPM client (e.g. ppm_server_default). Similarly, upon login, the PPM user interface uses the client specified in the login dialog to compose the name of the desired RMI connection partner (PPM client
10
server). Subsequently, the user interface receives a unique connection ID from the PPM registry server for direct data exchange between the PPM user interface and PPM server, depending on user interaction. The data exchange via RMI is completely transparent for the Java application. All RMI network connections must be available during the entire PPM software runtime. Note The address information contained in the RMI objects (IP address and port number) cannot be evaluated by the firewalls when transferred across network boundaries. The RMI objects themselves are designed for direct network communication. The following figure and table illustrate the RMI data flow described:
Client 1
Server
Process During startup, the client server registers at the registry server with its name. Query whether the relevant client server is available (specification of the client name in the login dialog)
Client server Registry server
Front-end
Registry server
Front-end
Registry server
The registry server returns the RMI object reference of the client server started. The user interface executes methods of the client server using the RMI object reference provided.
Front-end
Client server
Front-end
Client server
The client server returns results
11
Note When you start a PPM client server, the RMI SocketFactory determines the type of data transfer between the PPM server and client. A line of the form "... The server has been started using SocketFactory <name of the factory>." is displayed in the log after booting the server, which notifies you of the type of RMI data transfer used. RMI SocketFactory ZDefaultSocketFactory ZCompressionSocketFactory Data communication type Native data transfer Compressed data transfer (PPM default) ZSSLSocketFactory Encrypted data transfer via SSL protocol default Standard RMI protocol
RMI communication through firewalls Firewalls are programs that protect certain areas of the internal LAN in corporate networks. Port firewalls allow data transfer only on particular known ports for required network applications. Proxy servers running on the firewall monitor and control communication on application-specific data streams. If there are firewalls between the PPM server and front-end, the dynamic socket connections for the RMI protocol used by the PPM system are normally blocked. In this case, you can use automatic HTTP tunneling (see chapter Data transfer using HTTP tunneling (Page 13)). RMI data transfer modes You can set different modes for RMI communication between PPM client und server, which are described in the following chapters. After you created a client, the Compressed data transfer mode described in chapter Compressed data transfer (Page 15) is set.
4.4.1
Data transfer default

The default RMI data transfer of PPM is direct, without compressing and encryption. This operation mode is based on direct communication between PPM client and server, and neither HTTP tunneling nor proxy server are supported. This type of data transfer is very efficient but requires a fast network connection.
12
Configuration To enable the RMI default data transfer mode, assign the value false to the key UseSSL in the global configuration file Registry_settings.properties and the value com.idsscheer.ppm.rmi.ZDefaultSocketFactory to the key RMISocketFactory in the client configuration file RMIServer_settings.properties.
4.4.2
Data transfer using HTTP tunneling

If a firewall blocks direct data exchange between PPM front-end and server, the Java standard RMI protocol automatically uses the http protocol for the data transfer because http data transfer is usually port-independent and open in firewalls. The JRMP data stream of the RMI protocol is automatically packed (technical term: tunneled) in an http data stream and sent to the configured http proxy server via a URL in the form of http:<RMI registry server>:<RMI port>. The proxy server used is derived from the configuration of the Java Runtime Environment. Notes The firewall between PPM front-end and server must be open for http data exchange on the RMI registry and client server ports (webproxy). Tunneling and routing via the http proxy server cause significant losses in performance when communication takes place between the PPM server and user interface. Automatic use of the http protocol when the RMI protocol is blocked by a firewall is implemented only for the Default PPM operation mode (see chapter RMI server (Page 54)). Example The diagram below illustrates the data flow between the PPM user interface and server when a firewall separates the PPM user interface from the PPM server.
13
1. The direct query at the RMI port of the PPM server is blocked by the firewall. 2. The RMI transport protocol of the PPM user interface packages the query and sends it in an http data stream (http post query of the form http://<PPM server name>:<RMI port>) to the proxy server. 3. The proxy server forwards the query to the PPM server behind the firewall on behalf of the PPM user interface. 4. When the tunneled JRMP data reaches the PPM server computer, it is automatically unpacked and forwarded by the RMI transport protocol. 5. The response from the PPM server is sent in the reverse direction in a tunneled http data stream. Configuration To enable the RMI data transfer mode with automatic fallback to the http protocol, you need to assign the value false to the UseSSL key in the global configuration file Registry_settings.properties and no value to the key RMISocketFactory in the client configuration file RMIServer_settings.properties (RMISocketFactory=), or you comment out the corresponding line by prefixing the # sign.
14
4.4.3
Compressed data transfer

To boost performance, PPM automatically uses compressed data transfer after you created a client. This operation mode is based on direct communication between PPM client and server, and neither HTTP tunneling nor proxy server are supported. Configuration To enable the RMI data transfer mode with compression, assign the value false to the key UseSSL in the global configuration file Registry_settings.properties and the value com.idsscheer.ppm.rmi.compress.ZCompressionSocketFactory to the key RMISocketFactory in the client configuration file RMIServer_settings.properties.
4.4.4
Encrypted data transfer

If you want to use SSL technology to encrypt data exchanged between the PPM client and server, please note the following: The SSL technology used requires SSL encryption for data communication to always be enabled for the entire PPM system. From a technical point, it is impossible to allow some PPM client servers to access the shared RMI registry in encrypted form, and others to access it in unencrypted form. As a result, SSL encryption is configured across the PPM system. When you use the SSL protocol, technical reasons prevent you from also compressing the data exchange. Due to the additional computing effort, enabling encrypted data communication results in a minor loss in performance. Encryption of data communication is recommended only for the PPM server's default operation mode. For performance reasons, we do not recommend using SSL technology in a scaled (distributed) PPM system. Configuration The configuration of SSL encryption is described in detail in the chapters on Registry (Page 33) and SSL (Page 34). If encrypted data transfer is enabled, the key RMISocketFactory in the client configuration file RMIServer_settings.properties is ignored.
15
4.4.5
Data transfer via HTTPS proxy

If firewalls in your corporate network allow data communication only via https proxies, you can configure your PPM system so that the PPM server and client exchange encrypted data via https proxies. You enable this operation mode by assigning the value https-proxy to the UseSSL key in the client configuration file Registry_settings.properties. SSL-encrypted data transfer is used automatically. The configuration of SSL encryption is described in detail in the chapters on Registry (Page 33) and SSL (Page 34). Specify a proxy Java Control Panel The PPM front-end running in the browser uses the proxy server specified in the Java Runtime Configuration (Java Control Panel in the Control Panel). Use the Java Control Panel to specify the proxy server to be used by entering the computer name and port number in the Network settings dialog. Open the dialog by clicking on Network settings... in the Network settings box on the General tab. You can also edit the https proxy server using the Java Runtime Settings dialog. To do so, go to the Java tab and click on Display Runtime Parameter box as follows: -Dhttps.proxyHost=<host name> -Dhttps.proxyPort=<port number> in the Java Applet Runtime Settings box. Specify the https proxy in the Java
16
Manually If you want to access a PPM server using PPM Analysis GUI via https proxies you need to specify the https proxy in the environment variable PPM_PROXY. The syntax is the same as for the Java Runtime parameter described before. Example PPM_PROXY=-Dhttps.proxyHost=mypc.company.com -Dhttps.proxyPort=3128 Notes If you activate data transfer via https proxies, a loss in performance is to be expected due to the additional intermediate stations. If the proxy specified in the configuration is not available, a corresponding error message is output. If no https proxy is specified in the configuration and the environment variable PPM_PROXY is not defined, data transfer is encrypted and takes place directly (as for UseSSL=true). To avoid the performance loss caused by the https proxies you should not specify any https proxy on the PPM server computer so that PPM command line programs started on the server are able to exchange data with the server via local connections.
4.4.6
A client server with only one port

When starting a PPM client server, the RMI objects are registered at the registry server specified in the file %PPM5_HOME%\config\Registry_settings.properties (see chapter PPM client-server data communication (Page 10)). The PPM client server also internally starts a registry for the proprietary RMI objects so that the PPM server itself can be addressed as a registry server. This means that you can remote access a single PPM client server via a single TCP/IP port. This enables you, for example, to operate a PPM system through a firewall with only the client server port open. Configuration To enable access by PPM clients via a single port, you must specify the computer name and RMI port of the relevant PPM client server in the global file Registry_settings.properties in the clientjars directory of the PPM Web directory (proportional value of the key ManagementViews.BaseDirectory up to html/ of the client configuration file Templates_settings.properties) in the key RMIServerURL. It is usually enough to exchange the registry port
17
number specified during the installation with the port number of the client server (RMIObjectsPort key of the client configuration file RMIServer_settings.properties). Note On the local PPM system, this type of access is impossible because the local Registry_settings.properties in the config directory of the PPM installation is evaluated for all PPM clients (command line tools and stand-alone GUI). Access to a PPM server via a single port is not implemented for compressed RMI data transfer (see chapter Compressed data transfer (Page 15)). Warning If you change the port specified in the global configuration file Registry_settings.properties of the PPM Web server to the port number of a client server, only the corresponding PPM client is available via the network. Therefore, the procedure described can be used only for PPM systems with a single client.
4.4.7
Multiple client servers with only one port

If you want to operate multiple client servers with one port number, you can expand the previously described scenario (see chapter PPM system with only one port (Page 17)). Since the combination of computer name or IP address and port number must be unique you can only operate multiple client servers on one computer with only one port if the computer has multiple network addresses, e.g. if multiple network adapters are installed. Each client server and the PPM registry use one network address each. To access the PPM system, the file Registry_settings.properties of the web directory and of the analysis GUI installation does not need to be adapted because the PPM registry is linked with a particular network address and the network address of the relevant PPM server is entered in the corresponding RMI objects. By linking the PPM registry to a particular address and by overwriting the computer name in the RMI objects with the name of the relevant PPM server, the file Registry_settings.properties of the web directory and the analysis GUI does not need to be adapted for accessing the PPM system.
18
For the system described, the computer requires one network address for the PPM registry and each client server. If you want to address the network addresses via host names, each network address must be assigned a unique name. Configuration Edit the file Registry_settings.properties in the config directory of the ARIS PPM installation. Specify the network address and port number of the PPM registry in the key RMIServerURL. Assign the value true to the key BindToSingleAddress. The PPM registry will then exclusively use the specified network address. For each relevant client server, edit the file RMIServer_settings.properties in the client-specific configuration directory. Specify the relevant network address (IP or network name) of the client server in the key RMIObjectsBindAddress. The port number is specified in the key RMIObjectsPort. With this configuration, the client server uses the specified network address exclusively. Note Only the Standard server operation mode supports this procedure. Scaled systems are not supported. Warning The procedure described is not implemented for the default PPM server operation mode (key RMISocketFactory of the configuration file RMIServer_settings.properties, see RMIServer (Page 54)). Example You want to operate two clients via a single port. The PPM server computer has three network adapters that are configured in a way that the computer can be addressed via the network with the names ppmsrv, ppmsrv1 (client ppm1), and ppmsrv2 (client ppm2). The port number for PPM is 5010. Procedure: Edit the file %PPM5_HOME%\config\Registry_settings.properties. Enter the value ppmsrv:5010 in the key RMIServerURL. Assign the value true to the key BindToSingleAddress. Edit the file %PPM5_HOME%\config\ppm1\RMIServer_settings.propertie s. Enter the value ppmsrv1 in the key RMIObjectsBindAddress. The port number 5010 is specified in the key RMIObjectsPort.
19
Edit the file %PPM5_HOME%\config\ppm2\RMIServer_settings.propertie s. Enter the value ppmsrv2 in the key RMIObjectsBindAddress. The port number 5010 is specified in the key RMIObjectsPort.
4.5
System design of the PPM network

Depending on the existing local network structure, there are different PPM implementation scenarios.
4.5.1
2-tier
All PPM server components run on one computer.
Advantages
Easy implementation and maintenance. All PPM-specific components are located on one computer.
Disadvantages
Since the system resources are distributed to all PPM components, you may experience a loss in main memory performance.
Note
We recommend that you use a multi-processor system with a high-performance RAID hard drive system as your hardware platform.
20
4.5.2
3-tier
The PPM server components and Web server are located on the same computer; the existing database server is also used for ARIS PPM. Scenario 1
The PPM server and database server are located on the same computer; the existing Web server is also used for ARIS PPM (the PPM server is, for example, installed on the Web server computer). Scenario 2
21
Advantages
Uses existing system resources Low maintenance cost
Disadvantages
Possible loss in performance because PPM database accesses via the LAN share the available network bandwidth with many other computers.
Note
When using an existing database server, we recommend that you implement a separate database instance for ARIS PPM as well as a dedicated high-speed network connection between the database server and the PPM server for security reasons and to increase performance.
4.5.3
4-tier
Only the PPM server runs on a separate computer; the existing database server and Web server are also used for ARIS PPM.
Advantages
Minimal installation cost Uses existing system resources Low maintenance cost
Disadvantages
Possible loss in performance because PPM database accesses via the LAN share the available network bandwidth with many other computers.
22
Advantages
Minimal installation cost Uses existing system resources Low maintenance cost
Note
The PPM directory on the Web server must be accessible for the PPM server in the file system. If the PPM server and Web server are located on separate computers, you need to set up a corresponding network share. Please establish this connection before the installation so that the files of the PPM setup program can be copied and the correct paths can be entered in the configuration files. When using an existing database server, we recommend that you implement a separate database instance for ARIS PPM as well as a dedicated high-speed network connection between the database server and the PPM server for security reasons and to increase performance.
4.6
Distributed PPM server systems

To improve import and analysis performance, you can operate several PPM servers in parallel. These parallel servers are managed by a central master server. PPM user interfaces communicate exclusively with the master server. The master server passes on queries unchanged to all connected sub-servers. The time-consuming calculation of analysis results takes place simultaneously on the sub-servers. The master server aggregates the results from the sub-servers and sends the overall result to the front-end. Note In a distributed PPM server system, user interface access to the master server is completely transparent. To achieve an optimum parallelization result, all sub-servers should, as far as possible, be evenly utilized. Overall system performance is determined by the slowest sub-server. System configurations are imported using the master server. The master server passes them on to the sub-servers. All PPM servers have the same configuration upon completion of the configuration process. Source system data is divided into different data packages by an appropriate procedure and imported directly by the relevant sub-servers. A direct parallelization effect is the result. One criterion for dividing data packages may be the location, for example: Sub-server 1 receives data from location A, sub-server 2 receives the data
23
from location B etc. Time, however, is a less suitable criterion for dividing the data packages, as practice analyses are frequently performed with a time filter and queries can then be answered by only one sub-server.
Example: Data flow between front-end and scaled server system
Note To ensure optimum performance, all sub-servers should use their own system resources (CPU, RAM, hard disk). In addition, the master server should be connected to the sub-servers via a dedicated high-speed network.
24
Example: Dedicated high-speed network
Advantages Disadvantages Note
Maximum performance by scaling Very complex installation work, high costs To ensure fault-free communication between the servers, the network used by the master server to communicate with the sub-servers should be uncoupled from the rest of the network.
Several sub-servers can be combined in a multi-processor system with different, independent RAID arrays. This reduces installation work and license costs. Note When designing the scaling concept, make sure that the scaling effect is not lessened by the shared use of resources (e.g. several sub-servers using the same data file of a database instance). In a multi-processor system, you can use one database instance for various PPM database users if each database user is working with separate data files on physically different data carriers.
4.6.1
Initializing a scaled system

A scaled system is initialized as follows: 1. First of all, install all sub-servers, then the master server. Specify all sub-servers in the master server's client setup.
25
In the example below, one sub-server each is provided for the locations in Switzerland (ch), the Netherlands (nl) and Germany (de). The sub-servers for Switzerland and the Netherlands are installed on the same computer.
1. First of all, initialize all sub-servers. All sub-servers and the master server use the same configuration file to initialize the PPM languages. The configuration file is specified in the Initdb_settings.properties file of each server (see chapter Initdb (Page 48)). The remaining configuration files of the overall system are specified in the InitSystem_settings.properties file of the master server (see chapter InitSystem (Page 48)). This file is automatically specified by the client setup for all sub-servers and is empty. 2. Next, initialize the master server. The master server imports the system configurations specified in the InitSystem_settings.properties file and copies them to the sub-servers.
4.6.2
Expanding a scaled system

A scaled system can be expanded at any time by adding further sub-servers. The master server can manage a maximum of 64 sub-servers.
26
Proceed as follows to add a sub-server to an existing system: 1. Enter the parameters of the new sub-server in the Server_settings.properties configuration file of the master server (see chapter Server (Page 61)). SUBSERVER.X.CLIENT = subsrv2 SUBSERVER.X.PASSWORD = #*+GoVlqdxyBIugO0FWvj5WnyJ3HyM=+*# SUBSERVER.X.URL = pcmmn.ids-scheer.de:3714 SUBSERVER.X.USER = system Replace X with the highest sub-server number plus 1. 1. Use the runppmconfig PPM system command to export the entire master server configuration, e.g. runppmconfig -user system -client master -system C:\ppm_config 2. Initialize the new sub-server with the previously exported configuration files. This ensures that the new sub-server has the same configuration as the master server. 3. Restart the master server. Note The existing sub-servers do not need to be restarted. As the new sub-server does not yet contain any data, the KPI caches are not re-calculated.
27
Install ARIS PPM

The ARIS PPM software is installed using the platform-specific installation program (e.g. setup_Win64.exe for Windows 64-bit systems), which is described in detail in the ARIS PPM installation manual. For Windows systems, the setup program writes references for calling the uninstall programs in the Windows Registry. The executing Windows user must have the relevant privileges to write to the registry. Note If you do not want to use the Java Runtime Environment supplied we recommend that you install a suitable Java Runtime Environment before you install the ARIS PPM software. PPM server and PPM front-end must use the same main JRE version.
5.1
Directory structure after installation

The figure below illustrates the directory structure of the ARIS PPM server installation in the selected installation directory (here: ppm5).
28
The table lists the directories created during installation including their contents: Directory _uninst bin Contents Uninstall files Executable files of the PPM components Batch files or Unix shell scripts for calling the individual PPM modules License.key license file specified during installation config Global and client-specific configuration files. The entire configuration of a PPM client is stored in a subdirectory that has the same name as the client. ctk custom ARIS PPM CTK installation directory Client-specific customizing and data files. CTK uses this directory structure to manage clients. dtd XML document definition files. These files contain the meta structures used in the PPM XML files. Files whose names start with an underscore are also used by other DTD files. lib log patch Runtime libraries Default log directory of the client servers Directory for runtime files with extended functionality. The runtime files for extended, client-specific PPM server functionality are stored in the patch directory in the client configuration directory, e.g. %PPM5_HOME%\config\umg_en\patch. Performance Dashboard ARIS Performance Dashboard installation directory (optional)
reportautomation Directory for storing automatically created reports to send by e-mail. The reports are saved in client- and user-specific subdirectories. web Mirrors the contents of Web documents. The setup program copies the contents of this directory to the specified Web server directory (optional). xml Default XML customizing files
29
If you selected the Do you want to copy the 'web' folder to a Web server? option during installation, the following structure is created in the specified Web server directory (here: ppm).
The table lists the directories created during installation including their contents: Directory ppm Contents Home directory of the PPM Web documents. The directory is created by the PPM installation program, if desired. You can choose any name. clientjars Code and configuration base for PPM user interfaces. Contains all runtime libraries of the PPM user interfaces and copies of the global PPM configuration files. html Home directory for general and client-specific HTML pages. For each client there is a subdirectory with the corresponding name. help PPM online help
5.2
PPM licensing
The License.key file in the bin directory of the PPM installation is used to unlock the PPM software. The setup program automatically copies this file during installation. You may adapt the PPM license at any time by replacing the file and restarting the PPM server.
30
Configuring the PPM system

The PPM system features several independent user concepts: Operating system The system components determine the identifiers used to run the PPM components, i.e. the PPM server, Web server, and database server. When installing, you need to make sure that all components are assigned the required system privileges (access type in the file system, description of the Windows system components, e.g. registry or network devices). PPM The PPM user concept is restricted to the PPM client-specific database schema. Database One database user is configured for each PPM client.
6.1
PPM environment variables

The PPM installation program writes the following environment variables to the global system environment: PPM5_HOME Directory path of the PPM installation directory. PPM5_CLASSPATH Initial value for the class path that is transferred to the virtual machine. This value is expanded to include the file names of all JAR files in the %PPM5_HOME%\config\<client name>\patch, %PPM5_HOME%\config\patch, and lib directories, and the directory path for the %PPM5_HOME%\config directory. Warning If the config directory path is not specified in the PPM5_CLASSPATH variables, the client-specific configuration files cannot be read. In this case, you will receive the error message "The client <name of client> does not exist" when you start a PPM component. PPM5_JAVAHOME Indicates the JRE installation directory. %PPM5_JAVAHOME%\bin\java.exe is used to access the virtual machine.
31
PPM5_JAVAHOME_AS Indicates the JRE installation directory for the analysis server. %PPM5_JAVAHOME%\bin\java.exe is used to access the virtual machine.
6.2
PPM configuration files

All PPM configuration files are text files that can be edited in any text editor. The configuration file names are composed according to the pattern <PPM component>_settings.properties. The home directory for all configuration files is the config directory of the PPM installation.
6.2.1
Structure
All configuration files are structured analogously. The configuration entries are structured in lines. They have the format KEY = VALUE. The VALUE value is assigned to the KEY configuration characteristic. KEY may be divided into different configuration classes by dots (.), e.g. <PPMcomponent>.<configuration characteristic>. VALUE may be an actual value in the form of a number or file name, a component-specific keyword or a switch with the value true or false. Lines that start with the # sign are comment lines. Blank lines are permitted. There are different types of configuration files: Global configuration files impact the entire PPM system. Client-specific configuration files influence the respective client.
If the global configuration files are modified, it is necessary to restart the RMI registry server, and if necessary, the Corba registry server, and all client servers. Warning Please ensure that you spell keywords in the correct case.
6.2.2
Global configuration files

Data stored in the global configuration files is interactively entered by the user during installation and applies to all clients in the PPM system.
32
6.2.2.1
Registry
Enter the URL specified by the RMIServerURL key in the form of <computer name>:<port number> (e.g.RMIServerURL=mypc.mycompany.com:1099). The two entries RMILeaseValue and RMICheckInterval configure regular checks of the RMI connection and should only be modified in exceptional cases. The entry RMIHandshakeTimeout indicates in milliseconds the duration that an RMI client waits for the response of an RMI server before it throws an exception in case of a failed connection and aborts the connection. This setting applies to all RMI communication between analysis server and PPM server of all clients and all PPM components. Note By removing the entry from the file or setting the value to less than 0 you can restore the standard Java behavior. If you set the value to 0, no timeout at all occurs. We recommend a value of two minutes for limiting the time for failed connections. The UseSSL key determines whether the PPM system uses the unencrypted Java Remote Methode protocol (JRMP) (value false) or the Secure Socket Layer (SSL) protocol (value true) to transfer RMI data. Additional SSL encryption settings are specified in the SSL_settings.properties file. If you assign the value https-proxy to the key UseSSL the system attempts to transfer the data in encrypted form via an https proxy. For detailed information, please refer to the chapter Data exchange via HTTPS proxy (Page 16). In addition to the setting UseSSL=https-proxy, you can use EnableRMITracing=true to output diagnostic error messages on the Java console.
The CorbaServerURL key specifies the URL for the Corba registry server in the form of <computer name>:<port number>.
The CorbaServerActivationPort key specifies the port that can be used to transfer the runtime information and control instructions for Corba objects. PPM does not use this functionality.
33
Both the RMI and Corba registry servers start their services under the specified port and IP addressed assigned by the DNS system to the specified computer name. PPM client servers that have been started create RMI objects, and if necessary, Corba objects, and register these objects in the registry servers with the port numbers that were specified in the client-specific settings files RMIServer_settings.properties and Corba_settings.properties.
Note If you have installed multiple network cards in your PPM server computer, specify the IP address of the desired network card (in whose network the PPM system should be available) instead of the computer name.
The PPM user interface started in the Web browser uses a copy of the Registry_settings.properties file in the clientjars directory of the Web server and establishes a connection to the specified URL.
6.2.2.2
SSL
If you have enabled the encrypted RMI data transfer in the Registry_settings.properties file, configure additional SSL encryption settings in the SSL_settings.properties file. The PATH_TO_KEYSTORE key specifies the keystore to be used. A keystore is a database file in which both public and private key pairs are saved in an already encrypted form. The USE_OWN_KEYSTORE specifies whether you want to use a separate keystore (value true) or the keystore of your PPM installation (value false). If you use the keystore of your PPM installation, proceed as follows: In the PATH_TO_KEYSTORE key, specify the absolute path for the sslkeystore file in the config directory of your PPM installation. In this case, you do not have to specify a password in the KEYSTORE_PASSWORD key. The KEYSTORE_PASSWORD key specifies the password used to encrypt the keystore. Note If you use a separate keystore, you must specify the associated password.
34
Warning Always enter only one public/private key pair in your keystore. This ensures that a suitable certificate is always used to establish the SSL connection.
6.2.2.3
Help
This contains the URL for HTTP access to the html/help directory on the PPM Web server, e.g. http://mypc.mycompany.com/ppm/html/help/. Note The Registry_settings.properties and Help_settings.properties files in the config directory of the PPM installation and in the clientjars directory of the Web server must always be identical, so that the PPM server and user interface use the same configuration within the network.
6.2.3
Client-specific configuration files

The client-specific configuration is stored in configuration files in a subdirectory whose name corresponds with the client name.
6.2.3.1
AdapterConfig
Warning The settings in the AdapterConfig_settings.properties file relate only to the XML import in graph format. For the XML import, the XML_DATEFORMAT and XML_DATEFORMAT_ALTERNATIVE keys specify the time format expected in the log files (specification of date and time). The XML_TIMEOFDAYFORMAT and XML_TIMEOFDAYFORMAT_ALTERNATIVE keys specify the time (clock time) format expected in the log files. The XML_DAYFORMAT and XML_DAYFORMAT_ALTERNATIVE keys specify the format of a calendar day expected in the log files. The format specifications are used with the TIME (DATE) or DAY data type when assigning a source system attribute value to a PPM attribute.
6.2.3.2
AnalysisServer
The data in this file is used for analysis server settings. The following table lists the most important setting options:
35
Key RECOVERY_FILE
Example value C:\PPM5\recovery\ umg_en.recovery
Description Client-specific recovery file of the analysis server (default location: %PPM5_HOME%\recovery)
ANALYSIS_SERVER_ IMPORT_BLOCK_SIZE
1536 (recommended value)
Size of the import packages on the analysis server side. Correlates to the value of KI_COMMIT_BLOCK_SIZE (see chapter Database (Page 40)).
INDEX.PROCESS. <internaldimname>. USE
INDEX.PROCESS. MATERIAL. USE=true
Optional configuration. Use true to create an index on the dimension with its internal name (<internaldimname>). Only these process dimension types are allowed: Text dimension (one-level, two-level, n-level) Time dimension (timedim) Time of day dimension (hourdim)
INDEX.PROCESS. <internaldimname>. REFINEMENT
INDEX.PROCESS. MATERIAL. REFINEMENT= BY_LEVEL2_5
Additional, optional information on the created index of a dimension (except for one-level text dimensions). Refinement that the index is to be maintained with. Default value is the roughest value (BY_LEVEL_1, BY_YEAR, BY_HOUR_OF_DAY). Possible values: Two-level text dimension BY_LEVEL1, BY_LEVEL2 N-level text dimension BY_LEVELX_Y, with X indicating the selected refinement level and Y indicating the maximum number of levels of the dimension (with the example value BY_LEVEL2_5, an index is created on the second level of the five-level text dimension MATERIAL) Time dimension, valid values: BY_DAY, BY_MONTH, BY_QUARTER,
36
Key
Example value
Description BY_YEAR Time of day dimension, allowed values: BY_MINUTE_OF_DAY, BY_HOUR_OF_DAY Note Only one index is allowed for each dimension. If multiple indices are activated or deactivated or refinement data is configured for one and the same dimension, only the last data is used. Wrong dimension types are ignored without error message output. As soon as an index was successfully created, the corresponding information is output.
PRINT_STACKTRACE_ ON_EXCEPTION
false
TRUE activates the stack trace output of exception-based error messages for runtools.
RETRIEVER_MAX_ INSTANCES
50000 (default value)
Maximum number of process instances or function/relation instances that the analysis server can query. If the specified value is exceeded in a process instance query, the query aborts with an error message.
6.2.3.3
Chart
The information in this file determines the appearance of the charts generated by the PPM server. You can, for example, define labeling colors and character sets. The file contains comprehensive comments describing the effects of the entries.
6.2.3.4
CNet (Communication Net)

The information in the file reflects the default values of the individual keys, which influences the appearance of a communication network created in
37
the Organizational analysis module. All parameters are optional. The file contains comprehensive comments describing the effects of the entries. Key DEFAULT_NODE_ MODE Description Node representation mode. Possible values: COMPLETE_MODE (organizational unit in ARIS notation) or SIMPLE_NODE (node as color shaded circle). Default value: COMPLETE_MODE DEFAULT_NODE _SIZE DEFAULT_EDGE_ THICKNESS_MODE Default diameter of circle (only in SIMPLE_NODE mode) Connection weight representation mode depending on: - Percentage share of outgoing connections (OUTGOING_MODE) - Percentage share of incoming connections (INCOMING_MODE) - Absolute KPI value (VALUE_MODE) Representation of uniform connection weights: NONE_MODE DEFAULT_ EDGE_VALUE_MODE Connection value representation mode depending on: - Percentage share of outgoing connections (OUTGOING_MODE) - Percentage share of incoming connections (INCOMING_MODE) - Absolute KPI value (VALUE_MODE) Connection values not represented: NONE_MODE DEFAULT_ EDGE_THICKNESS Connection weight for uniform representation (only in NONE_MODE mode) DEFAULT_ EDGE_COLOR DEFAULT_ NODE_COLOR DEFAULT_ BACKGROUND_COLOR Background color Node color Connection color
38
Key DEFAULT_ SELFEDGE_MODE
Description Visualization of internal communication of a node (KPI value) using the diameter of the circle (only in SIMPLE_NODE mode). Possible values: - true (Show) - false (Do not show)
DEFAULT_EDGE_ PIXEL_RANGE
Value range (floating point number) for connection weight in pixels (min, max) for dependent representation (all modes except NONE_MODE)
DEFAULT_NODE_ PIXEL_RANGE
Value range for diameter of circle in pixels (min, max) for representation depending on the KPI value (DEFAULT_SELFEDGE_MODE=true)
UNDER_WARNING_ EDGE_COLOR
Connection color in RGB format for KPI values that are better than the warning value maintained (= planned value 1 for KPI).
WARNING_EDGE_ COLOR
Connection color in RGB format for KPI values between the warning value (= planned value 1) and the alarm value (= planned value 2).
ALARM_EDGE_ COLOR
Connection color in RGB format for KPI values that are poorer than the alarm value (= planned value 2).
ONLY_FOR_ RELATIONS
Type of analysis of communication network. Possible values: - true (Default value: only relationships between organizational dimensions) - false (between any two dimensions)
6.2.3.5
Corba server
The information in this file configures the data exchange via the Corba protocol. The PPM Web application uses the Corba protocol to publish Management views and Performance Dashboards.
39
The CorbaObjectsPort key determines the port number used by the PPM client server. Corba objects created by the client server are registered with this port number at the Corba registry. You can use the CorbaServerEnabled switch to determine whether the Corba server for the client is to be started (value true) or not (value false). Note To use ARIS Performance Dashboard or Management views for your PPM client, you must configure and start the Corba server.
6.2.3.6
Database
The information in this file controls the interface between the PPM server and database server. The file is divided into a general and an RDBMS-specific part. General part Key DATABASE_TYPE Description Specifies the type of the RDBMS to be used. Permitted values are ORACLE, ORACLE_10, DB2, DB2_9, SQLSERVER, SQLSERVER_2005, SQLSERVER_2008, and SQLSERVER_2008_UNICODE. COMMIT_RATE_MERGER Number of merge keys processed in a transaction COMMIT_FACTOR_READ _WRITE_MERGER Gives the number of merge keys processed within a database request (ResultSet) when multiplied with the value of COMMIT_RATE_MERGER. COMMIT_RATE_EPC Number of process fragments processed by the merger in a transaction COMMIT_FACTOR_READ _WRITE_EPC Gives the number of process fragments processed within a database query (ResultSet) when multiplied with the value of COMMIT_RATE_EPC. COMMIT_RATE_MERGER Number of process fragments imported in a transaction COMMIT_RATE_DELETE _CALCULATED_EPCS Number of EPCs processed per transaction when deleting using runppmdelete.
40
Key COMMIT_RATE_ KEYGENERATOR
Description Number of process instances processed by the KPI calculator in a transaction. Recommended number to avoid frequent, redundant database accesses: 7500
COMMIT_RATE_ DELETE_EPK KI_REFILL_ READ_BLOCK_SIZE
Number of process instances deleted in a transaction during aggregation Number of process instances read during one transaction during reinitialization of the analysis server. Values <1000 are not allowed. Default value: 1000000
KI_COMMIT_ BLOCK_SIZE
Number of process instances processed by the KPI calculator in a transaction. Replaces the entry COMMIT_RATE_KEYINDICATOR. Default value: 1024
KI_EPC_ BUFFER_SIZE
Number of process instances the KPI calculator writes into the main memory. The value is to be smaller or equal to the value for KI_COMMIT_BLOCK_SIZE. Default value: 250
KI_DIM_ CACHE_SIZE
Maximum number of values in the dimensions cache that are used by the KPI calculator. Default value: 10000
KI_NEW_DIM_ BUFFER_SIZE
Buffer size for unknown dimension values. Default value: 2500
41
Key URL
Description URL of the PPM databases in JDBC notation. Depending on the specified RDBMS type (DATABASE_TYPE), you need to specify the following settings: Oracle THIN protocol: URL=jdbc:oracle:thin:@<host>:<port>:< dbname> Oracle OCI8 protocol: URL=jdbc:oracle:oci8:@<SQL net name> DB2 protocol: URL=jdbc:db2:<dbname> MS SQL server protocol (from version 3.0.1): URL=jdbc:microsoft:sqlserver://<host>:< port>;SelectMethod=Cursor;DatabaseNam e=<dbname>
USER
Database user of the PPM databases
PASSWD
Password for the PPM databases. The client setup program encrypts the specified password. Unencrypted entries are permitted.
Note To ensure maximum performance of the KPI calculator, the values of the two parameters KI_EPC_BUFFER_SIZE and KI_DIM_CACHE_SIZE should be in a ratio of approximately 1:10. Since the calculation of process instances requires a lot of memory, the buffer size of the main memory KI_EPC_BUFFER_SIZE should not be too large. If you use many dimensions in your configuration, the value for the KI_DIM_CACHE_SIZE dimensions cache should not be too small.
The names of the tree items displayed in the process tree are indicated for process instances that could not be assigned to any process type (UTF-coded character string):
42
Key ERROR_NODE.STR NOT_TYPIFIED.STR
Meaning Name of the process tree node Name of the tree item with process instances that could be assigned neither to a process type nor to a process type group.
WRONG_TYPIFIED.STR
Name of the tree item with process instances that could not be assigned to a process type group.
RDBMS-specific part RDBMS-specific settings are intended for fine tuning the database. They enable source system-specific optimization of the execution and storage efficiency of the RDBMS for the database instance. The default settings usually cover all application scenarios in an optimal way. Note For detailed information on optimizing the database systems supported by PPM, please refer to the ARIS PPM Database systems user guide. Warning Modifications to the RDBMS-specific configurations may affect the entire database and even destroy it. Please ask an RDBMS administrator for support.
6.2.3.7
EPC
The information in this file configures the representation of both non-aggregated and aggregated EPCs. Default setting for EPC view #Configuration of the default view #Possible values: epk, attributes, functions, gantt Default_Epk_View = epk Color intensity of functions #Configuration of color intensities: FUNCTION_INTENSITY_MAX.0 = 0.2 FUNCTION_INTENSITY_MAX.1 = 0.4 FUNCTION_INTENSITY_MAX.2 = 0.6 FUNCTION_INTENSITY_MAX.3 = 0.8 For the display of aggregated EPCs, these settings configure the color intensity depending on the number of executions of the respective
43
functions. For each of the four levels, the threshold value is specified as a factor. Connection configuration #Configuration of connection categories: EDGE.0 = EDGE1 EDGE.1 = EDGE2 EDGE.2 = EDGE3 EDGE.DEFAULT_WITH = 2 EDGE1.max = 0.3 EDGE1.width = 1 EDGE2.max = 0.7 EDGE2.width = 3 EDGE3.max = 1 EDGE3.width = 5 When displaying aggregated EPCs, these settings configure the weight of flow connections depending on the number of the connection's executions. For each of the three levels, the threshold is specified as a factor and the connection weight in pixels. Layout configuration Warning The following settings originate from the layout algorithm for ARIS Business Architect and should not be changed. Setting LAYOUT_ALGO_NO LAYOUT_EPK_ALGO Value 20 1 Description Layout algorithm number Layout procedure for the non-aggregated EPC view LAYOUT_EPK_ ALGO_COMPRESSED LAYOUT_LONGEST_ PATH_POSITION LAYOUT_BREAK_SPACE LAYOUT_MAKE_SPACE LAYOUT_ROOT_DOWN LAYOUT_ROOT_POSITION LAYOUT_CHANGE_ SON_ARRANGEMENT 1 0 Layout procedure for the aggregated EPC view Alignment of the longest path: centered, right, left true true 1 0 2 Replace space with line break Create space in partial layout Root position relative to the subtree Root node position Change to vertical layout
44
Setting LAYOUT_ ARRANGE_SATTELITES LAYOUT_OBJECT_SCALING LAYOUT_SHOW_TRIMMED LAYOUT_SHOW_ ATTRIB_TITLE LAYOUT_XSPACING LAYOUT_YSPACING LAYOUT_FONTSIZE LAYOUT_HORIZONTAL
Value false false false false 30 50 10 false
Description Arrange satellites Scale objects Display untrimmed EPC Display attribute title Horizontal object spacing Vertical object spacing Font size in EPC objects EPC is not represented in horizontal layout
Placing object attributes #Configuration of default attribute placements: EPK_NODE_ATTRIBUTE_PLACE_CENTER = AT_OBJNAME EPK_NODE_ATTRIBUTE_PLACE_RIGHT_TOP = AT_AV_PROC_TIME EPK_NODE_ATTRIBUTE_PLACE_RIGHT_BOTTOM = EPK_NODE_ATTRIBUTE_PLACE_LEFT_BOTTOM = AT_END_TIME EPK_NODE_ATTRIBUTE_PLACE_LEFT_TOP = AT_START_TIME Includes information about the position of individual object attributes in the EPC view. Specified in the form POSITION = ATTRIBUTE IDENTIFIER. Displaying object attributes in tooltips #Configuration of default tooltip display SHOW_TOOLTIP.0 = AT_PROCTYPEGROUP SHOW_TOOLTIP.1 = AT_PROCTYPE Determines the object attributes for which values are displayed when the mouse pointer is positioned over an object. Placing object attributes (function-specific) FUNCTION.0 = SAP.AUFT #Configuration of attribute placements for function 'Create customer order' SAP.AUFT.EPK_NODE_ATTRIBUTE_PLACE_CENTER = AT_OBJNAME SAP.AUFT.EPK_NODE_ATTRIBUTE_PLACE_RIGHT_TOP = AT_AV_PROC_TIME SAP.AUFT.EPK_NODE_ATTRIBUTE_PLACE_RIGHT_BOTTOM = SAP.AUFT.EPK_NODE_ATTRIBUTE_PLACE_LEFT_BOTTOM = AT_END_TIME SAP.AUFT.EPK_NODE_ATTRIBUTE_PLACE_LEFT_TOP = AT_START_TIME
45
#Configuration of default tooltip display SAP.AUFT.SHOW_TOOLTIP.0 = AT_PROCTYPEGROUP SAP.AUFT.SHOW_TOOLTIP.1 = AT_PROCTYPE SAP.AUFT.SHOW_TOOLTIP.2 = AT_KI_FEDFREQ Prefixing the object name enables you to display object-specific attribute values. This kind of file section is initiated by the line FUNCTION.X = <AT_OBJNAME_INTERN>. Type of functions aggregation #Should orgunit attributes at functions be used for compression? EPK_USE_ORGUNIT_FOR_COMPRESS = false If the value of this setting is true, organizational units are taken into account when aggregating process instances. Identical functions with different processors are not aggregated but linked by OR rules. Aggregating hierarchical process instances #Default behaviour when compressing hierarchical EPCs DELETE_REFERENCED_EPCS_WHEN_COMPRESSED = false If the value of this setting is true, the assigned process instances of all assignment levels are deleted when aggregating process instances. Deleting hierarchical process instances #Default behaviour when deleting hierarchical EPCs DELETE_REFERENCED_EPCS_WHEN_DELETETED = false If the value of this setting is true, the assigned process instances of all assignment levels are also deleted when deleting process instances. Note To delete process instances including all assignment levels in the Administration user interface component, you need to set the DELETE_REFERENCED_EPCS_WHEN_DELETETED = true key. Warning When aggregating or deleting process instances, assigned process instances are deleted regardless of process access privileges. PPM users with the Process instance aggregation function privilege can also delete process instances for which they usually do not have access privileges. Settings for process instance tables #Limit for instances in instancelist (0 = No question at all) CRITICAL_INSTANCE_COUNT_TO_VIEW = 2500 Maximum number of process instances displayed in a process instance table. Default value: 2500.
46
6.2.3.8
EPC import
The information controls the premerger of the data import. Both initially save imported fragments in a runtime-based cache and fragments with an identical process key are summarized. The fragments are only written to the database if the cache exceeds its maximum size or the import is finished. The XML premerge processes instantiated fragments that were imported by the XML import. The EPC premerge processes fragment instances already saved in the database before the actual PPM data import. Note You can optimize the performance gain associated with the premerge by importing the system event data in such a way that system events with identical process key directly follow each other. Note Use the XML premerge for XML-based system event data. Avoid using both premerges at the same time.
Key XML_IMPORT_PREMERGER _CACHE_SIZE XML_IMPORT_COMMIT_RATE
Description Size of XML premerge cache. Default value: 5000 Number of fragment instances written to the database in one transaction. The value specified should exceed the cache size. Default value: 50000
EPC_IMPORT_PREMERGER _CACHE_SIZE EPC_IMPORT_COMMIT_RATE
Size of XML premerge cache. Default value: 0 Number of fragment instances extracted from the database and processed in one transaction. The value specified should exceed the cache size. Default value: 5000
47
Key READ_RATE_EPC
Description The value specified corresponds to the number of process instances that are merged, typified and calculated in one transaction. Default value: 100000
Note If you specify the value 0 for the cache size, the corresponding cache is disabled.
Warning We recommend that you limit the amount of data during the PPM import because any memory problems of the JRE may result in data inconsistencies.
6.2.3.9
Initdb
Controls the first phase of database initialization. The language keys specified in the referenced XML file determine the default language and the possible alternative languages of ARIS PPM.
6.2.3.10
InitSystem
This controls the second phase of database initialization in which the customizing files are imported. The file is divided into sections. The specifications of a section are used as arguments for internally performed calls of the runppmconfig configuration tool. XXX corresponds to consecutive numbering. INIT_MODULE_XXX = INIT_MODULE_XXX_NAME = <name> Name of the configuration component. Corresponds to the -command argument of the runppmconfig tool. INIT_MODULE_XXX_FILE = <file name> XML file to be used.
48
6.2.3.11
Keyindicator
Controls the KPI calculator. The table below lists the descriptions of a selection of the most important keys of the file. Key MAX_STEP_COUNT Meaning Maximum number of iteration steps in the chart display MAX_TIME_ STEP_COUNT MAX_DATASET_ EXTENDER_SIZE Maximum number of iteration steps in the Time dimension If no value can be determined for KPIs of the NUM_KEYINDICATOR and FREQ_KEYINDICATOR retriever type, the result set of the KPI query is stated as 0. Result sets up to the size specified here are taken into account. USE_KI_CACHE true activates the buffer of the precalculated favorites. AUTO_FILL_CACHE true triggers automatic filling of the cache after deletion (only for USE_KI_CACHE=true). CALC_RELATIVE_ KI_FOR_CACHE FILL_CACHE_ DELAY_TIME false skips the precalculation of favorites with relative time filters. Delay in milliseconds before precalculation of favorites starts after finishing a PPM data import KI_LRU_ CACHE_SIZE Number of queries saved in the main memory based LRU (least recently used) KPI cache. Recommended value: 50. The value 0 disables this option. EPK_LRU_ CACHE_SIZE Number of EPC queries saved in the main memory based LRU EPC cache. Recommended value: 50. The value 0 disables this option.
49
Key DEFAULT_ LIMITPERC
Meaning Predefined threshold value (in percent) for displaying analysis results in the Process Mining Wizard, above which unfavorable deviations from the KPI value or conspicuous variation limits of dimension values are to be displayed. Default value: 10.0%.
DEFAULT_ RELEVANCEPERC
Specified threshold value (in percent) in terms of the relevance of dimension values for the display of analysis results in the Process Mining Wizard, above which dimension values are to be displayed. Default value: 10.0%.
DEFAULT_ NUMBEROFLINES
Maximum number of result lines per process type in the Process Mining Wizard. Default value: 15.
6.2.3.12
Mail
The computer specified in the EMAIL_SERVER key (TCP/IP network name or IP address) receives the e-mails sent by the PPM server via the SMTP protocol. The FORMAT and STYLE keys specify the formats to be used in the Activities table and Messages table. These formats must be defined in the Report_settings.properties file. REPORT_DETAIL_ACTIVITY_STYLE = null REPORT_DETAIL_ACTIVITY_FORMAT = cpi_detail_html REPORT_DETAIL_COMMENT_STYLE = null REPORT_DETAIL_COMMENT_FORMAT = cpi_detail_html REPORT_EMAIL_ACTIVITY_STYLE = null REPORT_EMAIL_ACTIVITY_FORMAT = cpi_detail_plaintext REPORT_EMAIL_COMMENT_STYLE = null REPORT_EMAIL_COMMENT_FORMAT = cpi_detail_plaintext The keys REPORT_EMAIL_ACTIVITY_TYPE and REPORT_EMAIL_COMMENT_TYPE indicate the format of the e-mail created. Possible values are text/plain for e-mails in text format and text/html for e-mails in html format. REPORT_EMAIL_ACTIVITY_TYPE = text/html REPORT_EMAIL_COMMENT_TYPE = text/html
50
Use the key EMAIL_ATTACH_RESULT to specify whether and how an analysis linked to a message will be attached. Possible values: Key value false inline Description The linked analysis will not be attached to the message. The linked analysis will be embedded in the message. The message type is automatically set to text/html. pdf The linked analysis will be attached to the message as a pdf file. Note The linked analysis attached to a message is created using the styles specified in the keys EMAIL_INLINE_STYLE or EMAIL_PDF_STYLE. Use the SEND_ANALYTICS_EMAILS key to indicate whether an e-mail will be sent by default (value = true) or not (value = false) in addition to creating a CPI message if unfavorable deviations exist. SEND_ANALYTICS_EMAILS = false For each Easy mining message type (Early alert, planned value, alarm value, suspected deviation, and outlier analyses), you can use key values to specify whether you are notified by e-mail (key value EMAIL), by a message in the Improvements module (key value CPI), or both (key value CPI,EMAIL). TARGETVALUE_BEHAVIOUR=CPI PROCESSMINING_BEHAVIOUR=CPI ALARMVALUE_BEHAVIOUR=CPI EARLYALERT_BEHAVIOUR=CPI OUTLIER_BEHAVIOUR=CPI Note If you do not specify any key value, a message is created in the Improvements module and, depending on the SEND_ANALYTICS_EMAILS key value, an e-mail may also be sent (value = true) or not (value = false). If you specify a key value, the information in the SEND_ANALYTICS_EMAILS key is ignored. Warning The values for EMAIL and CPI are case-sensitive. Incorrect data results in the action not being executed.
51
6.2.3.13
RE (Relation Explorer)
The information in the file reflects the default values of the individual keys that influence the appearance of a Relation Explorer chart. All parameters are optional. The file contains comprehensive comments describing the effects of the entries. Key DEFAULT_NODE_MODE Description Node representation mode. Possible values: COMPLETE_MODE (organizational unit in ARIS notation) or SIMPLE_NODE (node as color shaded circle). Default value: COMPLETE_MODE DEFAULT_NODE_SIZE Default diameter of circle (only in SIMPLE_NODE mode) for KPI-independent representation (DEFAULT_SELFEDGE_MODE=false) DEFAULT_EDGE_THICKNESS _MODE Connection weight representation mode depending on: - Percentage share of outgoing connections (OUTGOING_MODE) - Percentage share of incoming connections (INCOMING _MODE) - Absolute KPI value (VALUE_MODE) Representation of uniform connection weights: NONE_MODE DEFAULT_EDGE_VALUE_MODE Connection value representation mode depending on: - Percentage share of outgoing connections (OUTGOING_MODE) - Percentage share of incoming connections (INCOMING _MODE) - Absolute KPI value (VALUE_MODE) Connection values not represented: NONE_MODE DEFAULT_EDGE_THICKNESS Connection weight for uniform representation (only in NONE_MODE mode) DEFAULT_EDGE_COLOR Connection color in RGB format
52
Key DEFAULT_NODE_COLOR
Description Node color in RGB format
DEFAULT_BACKGROUND_COLOR Background color in RGB format DEFAULT_SELFEDGE_MODE Visualization of a node's internal communication (depending on the respective KPI value) using the diameter of a circle (only in SIMPLE_NODE mode). Possible values: - true (Show) - false (Do not show) DEFAULT_EDGE_PIXEL_RANGE Value range (floating point number) for connection weight in pixels (min, max) for dependent representation (all modes except NONE_MODE), e.g. DEFAULT_EDGE_PIXEL_RANGE=1,3.5 DEFAULT_NODE_PIXEL_RANGE Value range for diameter of circle in pixels (min, max) for representation depending on KPI value (DEFAULT_SELFEDGE_MODE=true) UNDER_WARNING_EDGE_COLOR Connection color in RGB format for KPI values that are better than the warning value maintained (= planned value 1 for KPI). WARNING_EDGE_COLOR Connection color in RGB format for KPI values between the warning value (= planned value 1) and the alarm value (= planned value 2). ALARM_EDGE_COLOR Connection color in RGB format for KPI values that are poorer than the alarm value (= planned value 2).
Colors in RGB format The color values are specified as brightness steps of the three basic colors red, green and blue (color triple). They are specified by three integers between 0 and 255 (256 steps). The first value gives the graduation of the red component, the second the graduation of the green component, and the third the graduation of the blue component. 0 is the lowest brightness
53
step and 255 is the highest for a basic color value. Gray tones result from equal graduation, e.g. 240,240,240. Examples: Color Black Dark gray Deep red Deep green Deep blue Brown Gold Light gray White RGB format 0,0,0 64,64,64 255,0,0 0,255,0 0,0,255 165,44,42 255,215,0 240,240,240 255,255,255
6.2.3.14
RMIServer
The information in this file configures the data exchange via the RMI protocol. The RMIObjectsPort key determines the port number used by the PPM client server. RMI objects created by the client server are registered with this port number at the RMI registry. The key RMIObjectsPortAnalysisServer specifies the port number that the analysis server uses for communication. The RMISocketFactory key determines the RMI data exchange type. Value com.idsscheer.ppm.rmi.compress. ZCompressionSocketFactory com.idsscheer.ppm.rmi. ZDefaultSocketFactory No value Note Using the compressed RMI data exchange (PPM default setting) will increase the performance of the PPM client-server communication. Standard RMI data exchange Description Compressed RMI data exchange (PPM default) RMI data exchange in plain text
54
Note If you have enabled SSL encryption (UseSSL=true or UseSSL=https-proxy key in the Registry_settings.properties file), the RMISocketFactory key is ignored and the ZSSLSocketFactory value is used as RMI SocketFactory.
6.2.3.15
Report
The multi-level keys distinguish between the different output formats of the PPM report component. Specific definition files are referenced for each output format based on the report directory in the client configuration directory. Comments are added to the keys in the file. Localization of e-mail texts The reports.resource_directory key specifies a directory (default: %PPM5_HOME%\config\<client name>\report\resources) containing language-specific resource files for e-mail texts. The name pattern of these files is as follows: report_resource_<language code>.xml, e. g. report_resource_en.xml. In various context-specific XML structure elements, the texts are specified in the PCDATA box of the corresponding resourceelement XML element. The context of the corresponding text is specified in the name attribute of the resourceelement XML element. Note You can efficiently create e-mail texts for languages that are not supported by copying the existing file report_resource_en.xml and rename it using the correct language code (e. g. report_resource_es.xml for Spanish). All texts in the PCDATA box of this newly created resource file can then be translated to the relevant language in a text editor. Localization of CPI texts You can edit interface texts and e-mail texts containing the output of particular values transferred by PPM (e. g. planned values and KPI values). To do so, specify particular XML child elements in the cpiresource XML element of your report_resource.xml file. In the name XML attribute of these child elements, the internal resource ID is specified which is then overwritten by the text specified in the PCDATA box: <resourceelement name="<Resource ID>"><Text></resourceelement>
55
Example (extract from report_resource.xml) <resource> ... <cpiresource> ... <resourceelement name="ZEarlyAlertChecker.subject.STR"> Critical process instances concerning "{0}" ("{1}")</resourceelement> ...
Define export formats The export formats you can select in ARIS PPM are defined in the key exportformats. By default, the formats XML, CSV, and CSVF are available for export definitions and can be selected in the Export properties dialog. Each format has a set of settings that need to be copied for a new format and adapted accordingly. Note The key values must be specified in capital letters.
Early alert check
Topic: Subject
Resource ID Variable {0} Variable {1} Text
ZEarlyAlertChecker.subject.STR Early alert dimension Process type Critical process instances concerning "{0}" ("{1}")
Resource ID
ZEarlyAlertChecker.message.exceeding_non.non_tv.war n_not_set.STR
Variable {0} Variable {1} Text
Process type group Early alert dimension Critical process instances were found for the early alert dimension(s) "{1}" under the process type group "{0}".
56
Topic: Message texts
Resource ID Text
ZEarlyAlertChecker.message.clickHere.STR Click here:
Resource ID Text
ZEarlyAlertChecker.message.Information.STR Note: Problems occurred when connecting to the system. Possibly, not all process instances were included in the check.
Resource ID Text
ZEarlyAlertChecker.message.MessageDetails.STR For details, please refer to the following message or contact your system administrator.
Planned value check
Topic: Subject
ZPlannedValueAnalyticManager.subject.under_tv.STR KPI Process type Planned value below limit for KPI "{0}" ("{1}")
ZPlannedValueAnalyticManager.subject.over_tv.STR KPI Process type Planned value exceeded for KPI "{0}" ("{1}")
Topic: Message texts The resource IDs/texts described below use the following variables: Variable {0} Variable {1} Actual value Alarm value
57
Variable {0} Variable {2}
Actual value Warning value
Resource ID
ZPlannedValueAnalyticManager.message.exceeding_war n1.over_tv.STR
Text
Planned value 1 ({2}) exceeded. The actual value is {0}. Planned value 2 is {1}.
Resource ID
ZPlannedValueAnalyticManager.message.exceeding_war n1.under_tv.STR
Text
Planned value 1 ({2}) is below limit. The actual value is {0}. Planned value 2 is {1}.
Resource ID
ZPlannedValueAnalyticManager.message.exceeding_war n2.over_tv.warn_set.STR
Text
Planned value 2 ({1}) exceeded. The actual value is {0}. Planned value 1 is {2}.
Resource ID
ZPlannedValueAnalyticManager.message.exceeding_war n2.under_tv.warn_set.STR
Text
Planned value 2 ({1}) is below limit. The actual value is {0}. Planned value 1 is {2}.
Resource ID
ZPlannedValueAnalyticManager.message.exceeding_war n2.over_tv.warn_not_set.STR
Text
Planned value 2 ({1}) exceeded. The actual value is {0}. Planned value 1 has not been defined.
Resource ID
ZPlannedValueAnalyticManager.message.exceeding_war n2.under_tv.warn_not_set.STR
Text
Planned value 2 ({1}) is below limit. The actual value is {0}. Planned value 1 has not been defined.
58
Topic: Text for the filter of the planned value definition
Resource ID Text
ZPlannedValueAnalyticManager.filter.STR The planned value definition refers to the following filters:
Alarm value check
Topic: Subject
ZAlarmValueAnalyticManager.subject.under_tv.STR Early alert dimension Process type Alarm value below limit for KPI "{0}" ("{1}")
ZAlarmValueAnalyticManager.subject.over_tv.STR Early alert dimension Process type Alarm value exceeded for KPI "{0}" ("{1}")
Resource ID Variable {0} Text
ZAlarmValueAnalyticManager.subject.under_tv.STR Alarm value Alarm value below limit for KPI "{0}" ("{1}")
Resource ID Variable {0} Text
ZAlarmValueAnalyticManager.subject.over_tv.STR Alarm value Alarm value exceeded for KPI "{0}" ("{1}")
Process mining
59
Topic: Subject
Resource ID Text
ZProcessMiningAnalyticManager.subject.STR Suspected deviations identified by Process mining
Resource ID
ZProcessMiningAnalyticManager.message.exceeding_no n.non_tv.warn_not_set.STR
Text
Suspected deviations identified in Process mining.
Outlier analysis
Topic: Subject
ZOutlierAnalyticManager.subject.STR KPI Process type Outliers identified for KPI "{0}" ("{1}"
Resource ID
ZOutlierAnalyticManager.message.exceeding_non.over_ tv.warn_not_set.STR
Variable {0} Text
Limit The outlier analysis identified outliers for the limit greater than "{0}".
Resource ID
ZOutlierAnalyticManager.message.exceeding_non.under _tv.warn_not_set.STR
Variable {0}
Limit
60
Resource ID
ZOutlierAnalyticManager.message.exceeding_non.under _tv.warn_not_set.STR
Text
The outlier analysis identified outliers for the limit smaller than "{0}".
6.2.3.16
Server
Key PRINT_STACKTRACE_ ON_EXCEPTION ANALYSIS_SERVER_ CONNECT_RETRY_ INTERVAL Figure Value Switch Description TRUE activates the stack trace output of exception-based error messages for runtools. Number of milliseconds that the PPM server is to wait for the analysis server during RMI connection before the PPM server retries connecting if the first connection failed. ANALYSIS_SERVER_ MAX_CONNECT_ RETRIES MINIMUM_ PASSWORD_LENGTH Figure Figure Maximum number of failed connections before the system stops trying to connect. Specifies the minimum length of the PPM user password. 0 and 1 mean that at least one character has to be entered. Default value: 0 ENCODING Text Specifies the character set encoding of exported XML files. Possible values: ISO-8859-1, UTF-8 USE_LDAP Switch true activates the PPM LDAP interface. Default value: false LDAP_CONF_FILE File Specifies the configuration file of the PPM LDAP interface
61
Key XML_OUTPUT_ NORMALIZED
Value Switch
Description true means that when writing an XML file, several successive spaces are combined to form a single space. Default value: false
USE_SHARED_ CONNECTIONS
Switch
true means that shared sessions are used if a user logs in several times with the same language. Only valid when logging in via a Management view URL and for the Oracle database system.
SHARED_CONNECTION _POOL_SIZE PREV_PERIOD. TOLERANCE _IN_PERCENT
Figure
Maximum number of shared sessions
Figure
Percentage tolerance within which comparison values are considered equal to the KPI value. Used in EPC view to represent trends.
SUBSERVER_MAX_ CONNECT_RETRIES SUBSERVER_RETRY_ WAIT_TIME
Figure
Maximum number of attempts to connect to sub-servers.
Figure
Waiting time in milliseconds after which the next attempt to connect to the sub-server is started
SERVER_MODE
Text
Determines a server's operation mode. Possible values: STANDALONE, SUBSERVER, MASTER
TEMPORARY_ PASSWORD_TOKEN_ TIMEOUT
Figure
The length of time for which the password token is valid if called by PPM Dashboards or Management views
Note In a productive system, you should avoid specifying a trace file of the master server, as this will have a negative impact on performance. Only specify a trace file to estimate the quality of your scaling concept (even utilization of all sub-servers).
62
During the master server client setup, all sub-servers to be used by the master are specified. This information is stored in the following entries (X is a placeholder for the number of a sub-server, value range 1-64): Key SUBSERVER.X.URL Value Description URL Registry URL to address the sub-server SUBSERVER.X.CLIENT SUBSERVER.X.USER Text Text Name of the client Name of the PPM user whose ID is used by the master server to connect to the sub-server SUBSERVER.X.PASSWORD Text PIKI_SUBSERVER Encrypted password of the PPM user
Figure Determines the sub-server (value corresponds to the current number of the sub-server enumeration) that contains the KPI series for data input of process instance-independent KPIs in the PPM front-end.
Note Use the system user for communication between master server and sub-servers. This ensures that the master server can access the sub-servers with full system privileges. Warning Please make sure that the data of process instance-independent KPI series are provided by a single sub-server. Data determination across multiple sub-servers does not ensure correct data determination.
6.2.3.17
Templates
The following settings are specified for Management views, reports, Performance Cockpits, and Performance Dashboards: Partial key BaseDirectory Meaning Directory containing the respective definition files (access by the file system). The system user executing the PPM software requires Full access mode for this directory.
63
Partial key BaseURL
Meaning Specifies the URL access by HTTP for Management views and by FILE for reports to the directory indicated under BaseDirectory.
Filter
File extension of the Management views or report definition files.
The ClientJars.BaseURL key specifies the URL for http access to the runtime files for the PPM Web user interface.
6.3
System adaptations
You can modify the system configuration that you created during installation at a later time.
6.3.1
Adapting the RMI and Corba ports

To specify a new port number for the various PPM servers, you need to change the port number in the relevant configuration file and restart the corresponding PPM server. Note Restarting the PPM registry server forces an automatic restart of the client servers.
6.3.2
Adapting the Java Plug-in URL

The PPM user interface runs Java applets in the browser's Java JRE plug-in. If no Java JRE is installed on the front-end system, the browser will redirect to a suitable download page on the Internet by calling an URL. This URL can be entered in the HTML files for Netscape browsers and other browser types. Load the PaintApplet.js file in the html subdirectory of the PPM Web server directory into an editor and assign the desired URL to the JRENotFoundPage JavaScript variables. Example var JRENotFoundPage = '<URL>';
64
6.3.3
PPM user interface without Web access

To allow the PPM user interface to access a remote PPM system outside a browser plug-in, install the PPM Analysis GUI component.
6.4
64-bit systems
Note If the system message The system cannot execute the specified program is displayed when you execute the 64-bit programs, you must install the Microsoft Visual C++ 2005 Redistributable Package (x64) package. You can download the package from the following Internet page: http://www.microsoft.com/downloads/details.aspx?familyid=905481304468-4BBC-9673-D6ACABD5D13B&displaylang=en 1
6.5
PPM clients
The PPM client concept facilitates independent management of different data sets by a PPM server. An independent database schema is assigned to each PPM client. When logging in to the PPM system, the user specifies the desired client. The database schemas may be distributed to several database servers.
6.5.1
Create client
You can create PPM clients interactively using the client setup program or manually by editing configuration files. The configuration of the PPM client is the sum of the basic configuration (e.g. Web server) created during the PPM installation and the extended specifications for the new client (e.g. PPM databases).
6.5.1.1
Creating clients interactively

You will find detailed information on the runppmclientadministration client setup program in the PPM Installation Guide. Note The suggested value for the temporary directory for report generation is extracted from the TMP system environment variable.
1
Responsibility for linked content lies exclusively with those maintaining the individual sites.
65
6.5.2
Deleting clients
To delete a PPM client, run the relevant uninstall program. You can call up the uninstall program from the Windows Control Panel or you can start it directly from the %PPM5_HOME%\config\<client name>\_uninst directory (uninstall.exe file).
66
Starting the PPM system

PPM servers are Java applications and run in the virtual system environment of the JRE. The individual PPM servers are started in a separate Java VM (separate java.exe system process) by calling the corresponding Java class.
7.1
Running the PPM server components

You can launch the PPM server components automatically or manually. The automatic start is based on system services in the MS Windows operating system. All correspondingly configured services will be launched on system start.
7.1.1
Manual start
When launching the PPM server components manually, the following start sequence results from the servers' interdependence: 1. Database server 2. Web server 3. RMI registry server and, if necessary, the Corba registry server 4. PPM analysis server 5. PPM client server The following example shows how to start the system manually using a command prompt: cd /d start start start %PPM5_HOME%\bin runppmregistry & start runppmcorbaregistry runppmanalysisserver -client <client> runppmserver -client <client>
We recommend installing the PPM server components as Windows services. If required, you can run or stop PPM client servers (start type manually) that are rarely used by using the net start "ARIS PPM server (<client name>)" or net stop "ARIS PPM server (PPM client)" Windows system command. Using this start type, the system user can exit the Windows session because there are no active Java virtual machines run with the command prompt to prevent exit.
7.1.1.1
Scaled system
In a scaled PPM system, all PPM sub-servers are started first. If the sub-servers are located on different computers, the corresponding PPM registry server must be started on each computer. After successfully
67
starting all sub-servers, the master server is started. The master server first of all connects to all specified sub-servers and compares its own configuration with the configuration of the sub-servers. Connections to sub-servers with a different configuration from the master server are terminated. Note The master server is always started, regardless of how many sub-servers it was able to establish a connection to. The master server saves the system status, so that it can inform the user interface which subservers could not be integrated in case of queries. Synchronization of configuration The synchronization of master server and sub-server configurations includes comparing the runtime environments and PPM system configurations. The following elements of the runtime environments must match: Operating system JRE version PPM build number Output language (either default system language or the language specified by the -language argument) Database type (Oracle, MS SQL server, DB2) Database version number Encoding (ISO 8859-1 or UTF-8)
The following elements of the system configurations must match (the list reflects the order in which they are checked): 1. Languages 2. Data types (type, scaling and base scaling) 3. Attribute types and attribute type groups 4. Attribute names in all languages 5. KPI groups 6. KPIs and dimensions 7. Process tree 8. Factory calendar and transformation factors 9. Key rules 10. Merge configuration 11. Attribute copy rules
68
12. Organizational units 13. Meta schema and process type definition
7.1.2
Automatic start
The JSL technology (Java Service Launcher) enables the PPM system to be started fully automatically without using the Windows services to log in to Windows. The services started use the Windows system account SYSTEM. This account requires Full access mode for all PPM directories.
7.1.2.1
Setting up JSL
You can use the jsl.exe file to add Java applications to the Windows services or to remove them from the Windows services. The jsl.ini file configures the environment in which the PPM registry server or PPM client server runs. The installed jsl.ini files are preconfigured for direct use. Setting up and running a JSL service 1. Launch the command prompt. 2. Go to the directory containing the jsl.ini file of the desired PPM server, e.g. %PPM5_HOME%\config for the PPM registry server or %PPM5_HOME%\config\<client> for the relevant PPM client server. 3. Execute the jsl -install command line. To set up the PPM Corba registry as a service, execute the jsl -install jsl_corba.ini command line in the %PPM5_HOME%\config directory.
JSL indicates the name of the newly set up Windows service. The service is configured to the Automatic start type but not yet enabled. To run the service immediately, use either the Windows Control Panel or the net start "<service name>" DOS command. When setting up the PPM registry server as a Windows system service, the following screen output is displayed: C:\>cd /D %PPM5_HOME%\config D:\PPM\config>jsl -install ARIS PPM-RMI registry installed as a Windows service. D:\PPM\config>net start "ARIS PPM-RMI registry" ARIS PPM RMI registry was successfully launched. D:\PPM\config>
69
The structure of Jsl.ini files is similar to the INI system files. They contain descriptive comments for each entry, which supports adaptation to other environments. [service] appname = ARIS PPM-RMI registry servicename = ARIS PPM-RMI registry displayname = ARIS PPM-RMI registry ;port used to communicate stop command to JVM ;Must be unique for each JSL instance installed stopport = 8465 ;service dependencies can be added ;as a comma separated string "dep1,dep2" ;dependencies=TinyHttp ;service start type ;auto demand disabled ;default is auto starttype=auto ;load ordering group loadordergroup=someorder ;account under which service runs ;default is system ;account=.\administrator ;password for above account ;system need not provide a password ;password=somewpd [java] ;Path to the java runtime used ;If this option is not used the default from the registry will be used jrepath=C:\Program Files\JavaSoft\JRE\1.5.0_13 ;working directory wrkdir=D:/ppm/bin ;the number of parameters passed to the java application ;parameters must be numbered param00, param01 ... params = 3 param00 = -cp param01 = D:\ppm41\5701\config;{D:\ppm41\5701\patch\*.jar,D:\ppm41\5701 \lib\*.jar} param02 = com.idsscheer.ppm.rmi.ZRMIRegistryServer
To set up the Windows services, you need administrative privileges.
70
7.1.2.2
Important jsl.ini key names

Section [service] Directory appname servicename displayname dependencies starttype Contents Name of the executable program used to run the service Internal name of the service List entry displayed in the Windows Service Manager Name of the system service that must be running Start type of the system service to be set up. The possible values auto (automatic), demand (manually), and disable (disabled) correspond to the Service Manager's setting options.
Section [java] Directory jrepath wrkdir <List> Warning All path specifications must be complete including a drive letter and should not contain any environment variables. Note If you have made any changes in the lib directory of the PPM installation, which result in a modified class path, you must also make these changes manually in the jsl.ini files. Modifications to the jsl.ini file apply when executing the jsl command; if required, you need to use jsl -remove to disable the relevant PPM server first. Contents Value of the PPM5_JAVAHOME environment variable <PPM installation directory>\bin List of the arguments transferred to the VM
7.1.2.3
Scaled system
Due to the required start sequence (start master server first, then start sub-servers), the automatic PPM system start of a scaled system using JSL technology does not always cause the system to run. In practice, the master server and the sub-servers will be distributed across different systems and the option of using the dependency of the system services to control the starting sequence cannot be used.
71
7.2
Running the PPM user interface

The PPM user interface runs in the form of Java applets in the Web browser of the client computer. If the required JRE is not yet installed, the browser will automatically redirect to the JRE download page. Installing the JRE from the PPM installation CD enables you to run the PPM user interface directly.
7.2.1
Establishing the PPM user interface and PPM server connections

To load the index.html HTML page, enter its URL in the PPM Web server. The PPM user interface is displayed in the browser window. Note To allow the Java applet of the PPM user interface to be executed in the browser's JRE plug-in, JavaScript support of the browser must be enabled. When using the Internet Explorer, make sure that its internal virtual machine is disabled (menu Extras/Internet Options/Advanced).
7.2.2
Transferring parameters for the login dialog

By adding a list of arguments to the URL of the PPM server, you can transfer settings for the login dialog. The list of arguments starts with a question mark (?) and the arguments are separated by &: ?client=<client>&user=<user name>&password=<password>&language=<language code> Example: http://mypc.mycompany.com/ppm/html/index.html?client=umg_en&us er=system&language=en
7.3
PPM command line programs

The command line programs (*.bat) for managing and configuring the PPM system located in the bin directory of the PPM installation have a four-level structure: 1. Determining and checking PPM environment variables 2. Composing an argument character string of all transferred command line arguments 3. Creating a local class path
72
4. Running the Java Virtual Machine with specification of the class path and the argument character string, and calling a command line tool-specific class in the VM Warning The class path must contain all references to the JAR files in the lib directory of the PPM installation, to the JDBC and JCo drivers, and the config directory of the PPM installation. Please note that when adapting the command line tools, the runinitdb and runppmconverter tools contain additional process-controlling batch code and call up multiple Java classes. Note You need to execute the PPM command line programs in the bin directory of the PPM installation to open the License.key licensing file.
7.3.1
Localizing the PPM server

Adaptation to the American language area In order to display the date in American format Month/Day/Year, go to the lib directory of the PPM installation and to the clientjars directory of the PPM Web server, and replace the ppmdate.jar file with the file of the same name from the \ARIS PPM\nls\us directory on the PPM installation CD. You can restore the standard English date format by copying the ppmdate.jar file in the \ARIS PPM\nls\en directory on the PPM installation CD.
73
8 8.1
Maintenance and system support Backing up the PPM system

Database backup All PPM client-specific database contents are saved in the schema of a database user; it is sufficient to back up the schema of the relevant user as a back up. Please ensure that the backups you create are consistent. To do this, exit the relevant PPM client server before starting the backup process or use backup procedures of the database system that are not affected by transactions.
Backing up the PPM configuration Archive the config, custom, and patch subdirectories of your PPM installation, the PPM Web server directory, and all user-specific report definition files. Continue to archive the PPM directory of the Web server and all user-specific report definitions. To determine the storage location of the Web server directory that you specified at installation, refer to the ManagementViews.BaseDirectory key in the client-specific Templates_settings.properties configuration file. Discard the last part html/umg_en/managementviews/ of the directory information.
Backing up the Web application configuration To back up the configuration files of your Web applications (ARIS Performance Dashboard and Management views), back up the %PPM_PC2_HOME%\webapp\WEB-INF\config and %PPM_PC2_HOME%\webapp\assets\config directories.
8.2
Restoring the PPM system

After reinstalling the PPM software, restore the configuration you saved before: Restore the config directory. Restore the PPM Web server directory. Restore all client-specific customizing files. Restore the Web application directories.
74
Warning To ensure that the restored PPM installation can run, you must specify the same installation directory during the new installation, so that the directory paths contained in the restored configuration files are valid. The same applies to the PPM Web server directory. Note To efficiently manage the customizing files of the different PPM clients, we recommend that you store these files in a separate custom\<client name> directory structure in the PPM installation directory. CTK uses this directory structure, as well.
75
Uninstall
You can uninstall ARIS PPM by executing the uninstall.exe program in the %PPM5_HOME%\_uninst directory. Proceed as follows to uninstall ARIS PPM completely from your system: 1. Delete all files that were created manually, e.g. client configuration files. The uninstall program removes only files that were installed by the setup program. 2. Delete the database schemas that were generated for ARIS PPM. 3. Delete the analysis server recovery file.
76
10
Tips & tricks

Keyword File shortcuts File names Tip The Java VM does not recognize file shortcuts. Relative path specifications (to %PPM5_HOME%\bin) in the customizing files facilitate management and maintenance of the PPM clients. Avoiding spaces in file names saves a lot of typing. etc/hosts The name resolution of the specified PPM registry server name must be unique. Avoid inconsistent name resolutions using etc/hosts and DNS systems. Password To change the password for any PPM user, enter the password of the system PPM user as the password. PPM server PPM servers that are set up as Windows system services will start without terminal output. Deregistering the Windows session is possible. Remote access When installing via remote access software, it may happen that dialog boxes are not reproduced in their entirety. Pressing the Ctrl+Alt+Del key combination and clicking on Cancel forces a reconstruction of the remote screen. Slash, backslash The PPM configuration files use the / sign in path specifications. The usual Escape sign. Environment variables The JRE always evaluates environment variables of the system environment, not those that were locally configured in the command prompt. runppmclientadministration evaluates the PPM_HOME variable of the system environment. Modifying the locally changed PPM_HOME variable will have no effect. Web server Retain the configuration of the PPM Web server. Subsequent adaptation of the PPM client configuration is very demanding and prone to errors. \ DOS sign is treated like the
77
11
Glossary
The glossary explains the terms in a PPM-specific context. Term Database schema Definition Sum of all database objects assigned to a database user and their contents EPC Event-driven process chain. Chronological sequence of work steps. KPI Measurable (calculable) characteristics of a process or function Merging To combine multiple process fragments into a comprehensive EPC (process instance) Process fragment Smallest possible unit of an EPC which merely consists of a start event, function and end event Process instance EPC based on actually run business transactions with KPIs Source system Typifying IT system providing data for ARIS PPM Assignment of individual process instances to process type groups and process types Port number A port number is added to the IP address to enable a computer to exchange data simultaneously with other computers. RMI RMI allows Java programs to run program code (Java methods) on a remote computer. Functionally related protocols are RPC and RFC (RMI is an object-oriented variant of these protocols).
78
12
Appendix
CGI script java-rmi.cgi #!/bin/sh # # Copyright 2004 Sun Microsystems, Inc. All rights reserved. # SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. # # # @(#)java-rmi.cgi.sh # 1.9 03/12/19
# # This script executes the Java interpreter, defines properties # that correspond to the CGI 1.0 environment variables, and executes # the class "sun.rmi.transport.proxy.CGIHandler". It should be # installed in the directory to which the HTTP server maps the # URL path "/cgi-bin". # # (Configuration is necessary as noted below.) # # This class will support a QUERY_STRING of the form "forward=<port>" # with a REQUEST_METHOD "POST". The body of the request will be # forwarded (as another POST request) to the server listening on the # specified port (must be >= 1024). The response from this forwarded # request will be the response to the original request. # # CONFIGURATION: # # Fill in correct absolute path to Java interpreter below. For example, # the "PATH=" line might be changed to the follow if the JDK is installed # at the path "/home/peter/java": # # PATH=/home/peter/java/bin:$PATH # PATH=/usr/local/java/bin:$PATH exec java \ -DAUTH_TYPE="$AUTH_TYPE" \ -DCONTENT_LENGTH="$CONTENT_LENGTH" \ -DCONTENT_TYPE="$CONTENT_TYPE" \ -DGATEWAY_INTERFACE="$GATEWAY_INTERFACE" \ -DHTTP_ACCEPT="$HTTP_ACCEPT" \ -DPATH_INFO="$PATH_INFO" \ -DPATH_TRANSLATED="$PATH_TRANSLATED" \ -DQUERY_STRING="$QUERY_STRING" \ -DREMOTE_ADDR="$REMOTE_ADDR" \ -DREMOTE_HOST="$REMOTE_HOST" \ -DREMOTE_IDENT="$REMOTE_IDENT" \ -DREMOTE_USER="$REMOTE_USER" \
79
-DREQUEST_METHOD="$REQUEST_METHOD" \ -DSCRIPT_NAME="$SCRIPT_NAME" \ -DSERVER_NAME="$SERVER_NAME" \ -DSERVER_PORT="$SERVER_PORT" \ -DSERVER_PROTOCOL="$SERVER_PROTOCOL" \ -DSERVER_SOFTWARE="$SERVER_SOFTWARE" \ sun.rmi.transport.proxy.CGIHandler
80

ARIS PPM System Architecture

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

ARIS PPM System Architecture

Uploaded by

Copyright:

Available Formats

Copyright (C) Software AG All rights reserved. The content of this document is subject to copyright law.

ARIS Process Performance Manager

PPM network ........................................................................................................ 7

PPM client-server data communication ......................................................... 10

Distributed PPM server systems ................................................................... 23

Configuring the PPM system ................................................................................. 31

ARIS Process Performance Manager

6.5.1 6.5.2 7 7.1

Running the PPM user interface ................................................................... 72

PPM command line programs ...................................................................... 72

ARIS Process Performance Manager

ARIS Process Performance Manager

Information on how to use this guide

dialog boxes, file names, entries via manager as the password.

ARIS Process Performance Manager

ARIS Process Performance Manager

ARIS Process Performance Manager

ARIS Process Performance Manager

Basic information on in-memory technology

ARIS Process Performance Manager

PPM network protocols

ARIS Process Performance Manager

Connection Client PPM user interface Server Web server

PPM user interface PPM server Dashboard Dashboard Web client

ARIS Process Performance Manager

Loading the PPM user interface

ARIS Process Performance Manager

PPM client-server data communication

ARIS Process Performance Manager

Client server Registry server

The client server returns results

ARIS Process Performance Manager

Data transfer default

ARIS Process Performance Manager

Data transfer using HTTP tunneling

ARIS Process Performance Manager

ARIS Process Performance Manager

Compressed data transfer

Encrypted data transfer

ARIS Process Performance Manager

Data transfer via HTTPS proxy

ARIS Process Performance Manager

A client server with only one port

ARIS Process Performance Manager

Multiple client servers with only one port

ARIS Process Performance Manager

ARIS Process Performance Manager

System design of the PPM network

ARIS Process Performance Manager

ARIS Process Performance Manager

Uses existing system resources Low maintenance cost

ARIS Process Performance Manager

Distributed PPM server systems

ARIS Process Performance Manager

Example: Data flow between front-end and scaled server system

ARIS Process Performance Manager

Example: Dedicated high-speed network

Advantages Disadvantages Note

Initializing a scaled system

ARIS Process Performance Manager

Expanding a scaled system

ARIS Process Performance Manager

ARIS Process Performance Manager