You are on page 1of 118

ARIS 6 Collaborative Suite

Version 6.2
Administration Guide
Last Revision November 2003
All rights reserved. This document may not be reproduced in whole or in part without
prior consent from IDS Scheer AG. Subject to changes.
The use of registered names and trademarks in this publication does not imply that
such names are free for general use.
Copyright (C) 1997 -2003 by IDS Scheer AG, Saarbrcken
Contents

Contents

1 Manual Conventions ................................................................................ 1


1.1 Entry Methods and Formatting .............................................................. 1
1.2 Icons Used ......................................................................................... 1

2 How to Set Up an ARIS Web Designer Client for Use in a Browser .......... 2
2.1 Procedure........................................................................................... 2
2.2 Installed ARIS Web Designer Files.......................................................... 3
2.3 Automatic Installation with aris_database.html and JRE ............................ 5
2.4 SSL - Encryption of Data Transmission Using Secure Socket Layer ............. 6
2.4.1 Settings for ARIS Business Server When Using SSL ........................... 6
2.4.2 Particularities Concerning SSL Encryption and JRE 1.4.x..................... 7
2.5 Language Update and Character Sets ..................................................... 9
2.6 Execution as Applet or Application ......................................................... 9
2.7 Provide Additional Memory...................................................................10
2.8 Installation by Software Distribution......................................................11
2.8.1 Possible Settings for user.cfg ........................................................11
2.8.2 Pre-Configured user.cfg................................................................11
2.8.3 How to Configure user.cfg ............................................................12
2.9 ARIS Web Report Server .....................................................................13
2.9.1 Hardware Requirements for ARIS Web Report Server .......................13
2.9.2 Report Formats and Report Files....................................................13
2.9.3 Creating Web Reports - Special Features ........................................14
2.9.3.1 Dialog Variables ...................................................................14
2.9.3.2 Windows API Functions .........................................................15
2.9.3.3 Nested Dialogs.....................................................................15

3 ARIS Process Cost Analyzer .................................................................. 16


3.1 Client Installation ...............................................................................16
3.2 Default Server ...................................................................................17
3.3 ARIS 6.2 Server User-Defined (Advanced Installation) .............................18
3.4 License Keys......................................................................................18
3.5 Management of PCA Databases ............................................................18
3.6 PCA Reports ......................................................................................19

4 ARIS Agent ........................................................................................... 20


4.1 What Is the Purpose of ARIS Agents? ....................................................20
4.2 What Tasks Does an ARIS Agent Handle?...............................................20
4.3 How to Close ARIS Agents ...................................................................20
4.4 Activation of the ARIS Notify Service .....................................................21

ARIS Administration I
Contents

5 Configuration Options............................................................................23
5.1 How to Configure arisserver.cfg............................................................ 23
5.1.1 HTML Generator - Current Database Lists ....................................... 24
5.1.2 Restriction of the Number of index_backup Files .............................. 25
5.2 When Must You Configure arislauncher.cfg? ........................................... 26
5.3 Central User Login Using LDAP ............................................................. 27
5.3.1 Requirements for LDAP Authentication ........................................... 27
5.3.2 Advantages of LDAP Authentication ............................................... 27
5.3.3 Security..................................................................................... 28
5.3.3.1 Access to Databases ............................................................. 28
5.3.3.2 SSL Protocol........................................................................ 28
5.3.3.3 Backup Server ..................................................................... 28
5.3.4 How to Set Up ARIS for LDAP Server Operation ............................... 29
5.3.5 Authentication Process ................................................................. 31

6 Database Systems .................................................................................32


6.1 Oracle Database Server ...................................................................... 32
6.1.1 Required Tablespaces and Tables .................................................. 33
6.1.2 Recommended Tablespace Configuration ........................................ 34
6.1.3 Oracle System Parameters ........................................................... 34
6.1.4 Oracle Database Settings ............................................................. 35
6.1.5 Oracle Instance Parameters .......................................................... 35
6.1.6 Oracle Optimizer ......................................................................... 36
6.1.7 Refresh Oracle Statistics .............................................................. 36
6.1.8 Oracle Schemes for ARIS ............................................................. 37
6.1.9 How to Create an ARIS 6 Database User in Oracle ........................... 38
6.1.10 Oracle - Recommended Reading.................................................... 38
6.2 Microsoft SQL Server .......................................................................... 39
6.2.1 Required Programs, Drivers and Scripts.......................................... 39
6.2.2 Notes on Installing the SQL Server ................................................ 39
6.2.3 Setting up the SQL Server ............................................................ 40
6.2.4 Using ARIS *.SQL Scripts ............................................................. 41
6.2.4.1 Adapting the init.sql Script .................................................... 41
6.2.4.2 ARIS Scheme Strategy.......................................................... 42
6.2.4.2.1 Automatic Configuration (Recommended) ............................ 42
6.2.4.2.2 Manual Configuration ........................................................ 43
6.2.5 ARIS Installation with SQL Server.................................................. 46
6.2.6 JDBC driver ................................................................................ 46

II Administration ARIS
Contents

6.3 IBM DB2 ...........................................................................................47


6.3.1 Required Programs, Drivers and Scripts ..........................................47
6.3.2 Particularities of IBM DB2 Administration ........................................47
6.3.3 Setting up the DB2 Server ............................................................48
6.3.3.1 Creating a DB2 Database.......................................................48
6.3.3.2 Adapting Parameters of the DB2 Database ...............................48
6.3.3.3 Creating Operating System User ARIS62 .................................49
6.3.3.4 Adapting and Executing Installation Scripts ..............................50
6.3.4 Adapting Connection Data to ARIS Business Server ..........................50
6.3.5 ARIS Database Management .........................................................51
6.3.5.1 Auto-Management ................................................................51
6.3.5.2 Manual Management.............................................................51
6.3.5.2.1 Notes on Manual Management ............................................52
6.3.5.2.2 Procedure for Manual Management......................................52
6.3.5.2.3 ARIS Scheme Versions ......................................................54

7 Additional Information.......................................................................... 55
7.1 Maintenance Work with an ARIS Client ..................................................55
7.2 Automated Installation ........................................................................55
7.3 ARIS API: Continued Use of Programs from Earlier ARIS Versions..............56
7.4 ARIS Site Administrator.......................................................................57
7.5 ARIS Converter ..................................................................................57
7.6 Backing Up User and Configuration Databases ........................................58
7.7 Backing Up Current Configuration Files ..................................................59
7.8 Reset Database Administrator Password ................................................59
7.9 Server Log Directory ...........................................................................59
7.10 ARIS Metaframe .................................................................................59

8 Transferring Data from Earlier Versions of ARIS ................................... 60


8.1 User Databases ..................................................................................61
8.1.1 How to Transfer User Databases ....................................................61
8.2 Configuration Databases......................................................................64
8.2.1 How to Transfer Item Groups from Configuration Databases ..............64
8.2.2 How to Transfer Individual Items of Configuration Databases.............65
8.2.3 How to Transfer Exported Filters, Templates and Chart Definitions .....66
8.3 How to Transfer User-Generated or Modified Scripts from Earlier ARIS
Versions............................................................................................66
8.4 How to Transfer User-Generated Semantic Checks fromEarlier ARIS
Versions............................................................................................67
8.5 ASCII and Excel Exports ......................................................................68

ARIS Administration III


Contents

9 ARIS Admintool .....................................................................................69


9.1 How to Launch ARIS Admintool ............................................................ 69
9.2 Valuable Information .......................................................................... 69
9.3 ARIS Admintool Commands ................................................................. 70
9.3.1 Backup ...................................................................................... 71
9.3.1.1 Example ............................................................................. 71
9.3.1.2 Data Backup Using a Batch Program (Batch File) ...................... 72
9.3.2 Backupconfig .............................................................................. 72
9.3.3 Copy ......................................................................................... 73
9.3.4 Dbmspassword ........................................................................... 74
9.3.5 Delete ....................................................................................... 74
9.3.6 Exit ........................................................................................... 74
9.3.7 Help .......................................................................................... 75
9.3.8 Interactive ................................................................................. 75
9.3.9 Kill ............................................................................................ 75
9.3.10 List ........................................................................................... 76
9.3.11 Maintain .................................................................................... 76
9.3.12 Password ................................................................................... 77
9.3.13 Rename ..................................................................................... 77
9.3.14 Reorg ........................................................................................ 77
9.3.15 Restore...................................................................................... 78
9.3.16 Restoreconfig ............................................................................. 79
9.3.17 Scheme Context ......................................................................... 79
9.3.18 Server ....................................................................................... 80
9.3.19 Sessions .................................................................................... 80
9.3.20 Statistic ..................................................................................... 81
9.3.21 Status ....................................................................................... 81
9.3.22 Version ...................................................................................... 82

10 Hardware and Software Requirements ..................................................83


10.1 Database Server ................................................................................ 83
10.1.1 Oracle Database ......................................................................... 84
10.1.2 Microsoft SQL Server ................................................................... 84
10.1.3 IBM DB2 .................................................................................... 84
10.1.3.1 Hardware Requirements........................................................ 84
10.1.3.2 Software Requirements......................................................... 85
10.2 ARIS Default Server (ARIS Business Server) .......................................... 86
10.2.1 Hardware Requirements............................................................... 86
10.2.2 Software Requirements................................................................ 87

IV Administration ARIS
Contents

10.3 Client Installations..............................................................................88


10.3.1 Hardware Requirements ...............................................................88
10.3.2 Software Requirements ................................................................88
10.4 Client Installations (Single-User Installation) ..........................................89
10.4.1 Hardware Requirements ...............................................................89
10.4.2 Software Requirements ................................................................89
10.5 Special Requirements..........................................................................90
10.6 ARIS Web Designer ............................................................................93
10.6.1 Hardware Requirements ...............................................................93
10.6.2 Software Requirements ................................................................94
10.7 ARIS Web Designer Components ..........................................................95
10.7.1 Hardware Requirements ...............................................................96
10.7.2 Software Requirements ................................................................96
10.8 ARIS Web Report Server .....................................................................96
10.9 ARIS Converter ..................................................................................97

11 Glossary ................................................................................................ 98

12 Appendix............................................................................................. 101
12.1 IDS Scheer Customer Inter@ction Center ............................................ 101
12.2 System Languages and Locale IDs ...................................................... 102
12.3 Port Numbers .................................................................................. 106
12.4 Copyright ........................................................................................ 106

13 Index .................................................................................................. 108

ARIS Administration V
Manual Conventions

1 Manual Conventions

1.1 Entry Methods and Formatting


In the Administration Guide, menu items, file names, etc. are
formatted and identified as follows.

Entry Method/Formatting Example

Menu items, shortcut keys, dialog Click on OK.


boxes, file names, keyboard entries etc.
are shown in bold. Enter the path in the sample.txt file.

Sequences of menus and menu items Click on Help/Help Topics.


are appended after each other,
separated by forward slashes.

Entries with user-defined content are Enter the path <directory>\server.


highlighted in bold and enclosed in
angle brackets.

1.2 Icons Used


Special sections of text are identified by the following icons.

Icon Meaning

An exclamation mark indicates important information which, if


disregarded, may cause loss of data or result in a security risk.

A light bulb points out useful tips.

A pushpin points out references to explanations in user guides or in the


online help.

ARIS Administration 1
How to Set Up an ARIS Web Designer Client for Use in a Browser

2 How to Set Up an ARIS Web Designer Client for Use in a


Browser
This section contains information on the setup, setting options and
execution modes (see chapter 2.4) that are important for using ARIS
Web Designer in a browser environment.

2.1 Procedure
1. Ensure that the system requirements are satisfied (see chapter 10.6).

2. Install the ARIS Web Designer components (see the Installation


Guide).

3. Install a JRE released for ARIS, e.g. JRE 1.4.2 (see chapter 2.3).
Install JRE in a path whose directory name must not include any
spaces or special characters. Otherwise, JRE cannot be
executed.

4. With your browser, navigate to the installation directory for the ARIS
Web Designer components. There, you will find the example file
index_lan.html. If the ARIS Web Designer components have been set
up, you will find a link to the HTML test page at the end of the Multiple
Language page. Any user can click on this link to verify that the
computer configuration for ARIS Web Designer is correct.

If you navigate back to the ARIS Web Designer components


installation directory with your browser, you will be offered the
database list of the linked ARIS Site.
5. Pass the link for this path to those users who want to work with ARIS
Web Designer, e.g. the link to the index_lan.html file.

6. When users click on one of the database links for the first time, they
will be prompted to enter the license key, if you in your capacity as
administrator have not reconfigured the entry by changing the
user.cfg file (see chapter 2.8.3).

2 Administration ARIS
How to Set Up an ARIS Web Designer Client for Use in a Browser

2.2 Installed ARIS Web Designer Files


By default, the files you need to download the ARIS Web Designer JAR
files to your computer are installed in your Web server's
aris6.2/html/lib directory. You need the JAR files in order to be able
to run ARIS Web Designer.

The arisloader.cfg file is also stored in this Web directory. This file
controls the download of ARIS Web Designer if you click on a database
shortcut on the main page.

Here are some examples of entries in the arisloader.cfg file:

# Specify Client Installation Path Here


# Samples:
# libdir= 'Install Client to <Default directory>/ARIS6.2
# libdir=c:\ARIS6.2 'Install Client to C:\/ARIS6.2
libdir=

# DO NOT EDIT THIS SECTION!


# Main Start Class
mainclass=com.idsscheer.aris.client.container.common.AARISClientContainer

#Certificates Container
certificates=certificates.jar

# DLL Container for MS Windows Interaction


dll_container=cl_wcp.jar
ssl_container=ORBacusSSL.jar

# External Libraries

jarfile=bsscjhrs.jar:6.2.1.1
jarfile=CnvConnect.jar:6.2.1.1:ignore
jarfile=iaik_jce.jar:6.2.1.1
jarfile=jh.jar:6.2.1.1
jarfile=junit.jar:6.2.1.1:ignore
jarfile=kxml2.jar:6.2.1.1
jarfile=ORBacusClient.jar:6.2.1.1
jarfile=ORBacusSSL.jar:6.2.1.1
jarfile=y.jar:6.2.1.1

ARIS Administration 3
How to Set Up an ARIS Web Designer Client for Use in a Browser

# ARIS Client jars


jarfile=certificates.jar:6.2.1.30607
jarfile=aris_loader.jar:6.2.1.30607
jarfile=hkprot.jar:6.2.1.30607:ignore

Use the libdir= entry and the arisjarpath62= and arishome62=


environment variables to specify the directory on your computer to
which the ARIS Web Designer files are to be copied after launching.
For the arishome62= variable, ARIS Toolset Setup enters the path of
the ARIS Toolset installation directory. arisjarpath62= and
arishome62= are environment variables of the client computer, they
are not entries in the arisloader.cfg file.

Please do not use any country-specific special characters in the path


information for arisjarpath62=, arishome62= and libdir=.

The entry and the environment variables are requested in the following
sequence:

1. The system first searches for the arisjarpath62 environment variable.


If it is found, the JAR files are copied to the directory specified there. If
this environment variable is not found,

2. the libdir entry in the arisloader.cfg file is checked. If a directory is


assigned to this entry, the JAR files are copied to that directory. If a
directory is not assigned to this entry,

3. the system searches for the arishome62 environment variable. If it is


found, the JAR files are copied to the directory specified there. If this
environment variable is not found,

4. the JAR files are copied to the <installation


directory>\Aris6.2\webdesigner directory.

The arisjarpath62= and arishome62= environment variables (see


steps 1 and 3) enable you to copy the JAR files to any directory on any
client computer.

4 Administration ARIS
How to Set Up an ARIS Web Designer Client for Use in a Browser

2.3 Automatic Installation with aris_database.html and


JRE
The aris_database.html file opens databases and models in ARIS
Web Designer/ARIS UML Designer. To be able to use ARIS Web
Designer/ARIS UML Designer, you must have installed JRE 1.3.1_03
(international), 1.3.1_06 (international) or 1.4.2 (international) (see
chapter Java Runtime Environment 1.3.1_03/1.4.2 in the
Installation Guide). The aris_database.htm file checks that JRE
1.3.1_03 or higher is installed.

Install JRE in a path whose directory name must not include any
spaces. Otherwise, JRE cannot be executed.

If neither of the required JRE is installed, installation of JRE will branch


to the Internet address of SUN:

if (NN) { document.writeln('<EMBED \
WIDTH = "100%" HEIGHT = "100%" \
pluginspage="http://java.sun.com/products/plugin/1.3/plugin-
install.html" \
scriptable=false \'); }
else { document.writeln('<OBJECT classid="clsid:8AD9C840-044E-
11D1-B3E9-00805F499D93" \
WIDTH = "100%" HEIGHT = "100%" \
codebase="http://java.sun.com/products/plugin/1.3/jinstall-13-
win32.cab#Version=1,3,1,0">');
}

However, you can also delete the Internet address or replace it with
the address of the ARIS Web Designer components.

The JRE plug-ins for Netscape and for Microsoft Internet Explorer are
located in the tools\java runtime environment directory.

(j2re1_3_1_06-win-i.exe)

You will find information on the JRE plug-in at:


http://www.java.sun.com/.

ARIS Administration 5
How to Set Up an ARIS Web Designer Client for Use in a Browser

2.4 SSL - Encryption of Data Transmission Using Secure


Socket Layer
Using SSL (1024-bit RSA) you can exchange data between ARIS Web
Designer and the ARIS Business Server in encrypted form.

SSL capability is already integrated in ARIS.

Encrypted data exchange is only possible if ARIS Business Server and


ARIS Site Manager are installed on the same computer.

2.4.1 Settings for ARIS Business Server When Using SSL


If you want data exchange to be encrypted, proceed as follows :

1. Ensure that the system date matches the current date. This ensures
that the validity of the SSL certificates supplied by IDS Scheer is
checked correctly. These certificates can only be used to exchange
data between ARIS Web Designer and ARIS Business Server.

2. Open the arislauncher.cfg file in a text editor. By default, this file is


located in the %ARIS_HOME62%\server\config directory following
installation of ARIS Business Server.

3. Insert the text in reverse video below in the line displayed:

<Profile name="Public" prot="16040" ssl="443" threadpoolsize="100" options=""/>

If the port specified here is in use, you can use another free
port.

4. Save the arislauncher.cfg file and close it.

5. Open the arisserver.cfg file in a text editor. By default, this file is


located in the %ARIS_HOME62%\server\config directory following
installation of ARIS Business Server.

6 Administration ARIS
How to Set Up an ARIS Web Designer Client for Use in a Browser

6. In the HTMLGenerator section, remove the comment lines shown in


reverse video below:

<!-- Remove this comment to turn on ssl encryption


<genfile target_dir="ssl" target_name="index.html" database_template="aris_database_ssl.html"/>

-->

If ARIS Business Server was active during the change, it must


be restarted.

7. From now on, use the index_ssl.html file as the start file for the
databases. This file is located in the /html directory (if only one
language is installed) or the /html<languageid> directory (if
multiple languages are installed).

2.4.2 Particularities Concerning SSL Encryption and JRE


1.4.x
If you start ARIS Web Designer via a Web server using JRE 1.4.x and
you want to use SSL, the following installations are required:

1. "Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction


Policy Files".

2. Security Provider.

Installing Policy Files

The Policy files are zipped in the Tools directory of the your ARIS CD
(jce_policy-1_4_2.zip).

Unzip them on the ARIS Web Designer computer to the security


directory, e. g. %ARIS_HOME62%\JavaClient\jre\lib\security.

You may also download these files from the SUN Web site. In this case
the JCE subdirectory will be created during extraction. Copy the files
from there to the security directory, e. g.
%ARIS_HOME62%\JavaClient\jre\lib\security.

ARIS Administration 7
How to Set Up an ARIS Web Designer Client for Use in a Browser

You will find the files at:


http://java.sun.com/j2se/1.4.2/download.html, Other Downloads
section. Click on the Download link following Java Cryptography
Extension (JCE) Unlimited Strength Jurisdiction Policy Files
1.4.2. On the following page, download the jce_policy-1_4_2.zip
file.

Installing Security Provider

After having unzipped the files to the ...\jre\lib\security directory,


proceed as follows:

1. Copy the iaik_jce.jar file from the Tools\java runtime


environment directory of the ARIS CD to %ARIS_HOME 62%\
JavaClient\jre\lib\ext. Please create the target directory if it does
not exist yet.

2. Switch to the %ARIS_HOME62%\JavaClient\jre\lib\security


directory.

3. Open the java.security file in a text editor.

4. Search for the # List of providers and their preference orders


(see above): commentary.

5. Copy the last line of the following entries, e. g.


security.provider.2=com.sun.rsajca.Provider, and paste them into
the next line.

6. Increase the number after provider. by one. In the preceding


example, 3 would be the number to enter: security.provider.3=
com.sun.rsajca.Provider.

7. Replace the entry following the equals sign with


iaik.security.provider.IAIK. Please observe the upper and lower
case conventions. The preceding example would look like this:
security.provider.3=iaik.security.provider.IAIK.

8. Save and close the java.security file.

9. If ARIS Web Designer is open in a browser, close the program and


restart it.

8 Administration ARIS
How to Set Up an ARIS Web Designer Client for Use in a Browser

2.5 Language Update and Character Sets


A language update for the ARIS Web Designer components and ARIS
Server copies the language resource files to the \aris6.2\lib directory
and enters them in the arisloader.cfg file. This means that the
language update is performed automatically when an ARIS Web
Designer Client opens a database.

To display different character sets (Japanese, Arabic, Cyrillic, etc.) in


ARIS Web Designer/ARIS UML Designer the corresponding file in the
<JRE installation directory>\1.3\lib directory must be called
font.properties. If, for example, you wish to display Japanese
characters, you must rename the font.properties.ja file to
font.properties.

2.6 Execution as Applet or Application


We recommend running ARIS Web Designer/ARIS UML Designer as an
application, in order to prevent errors that could possibly be caused by
your browser. You can install ARIS Web Designer/ARIS UML Designer
as a client or as described below start it as an application via a
browser.

During installation of the Web Designer components, the \lan and


\app directories are also set up (see chapter Client
Installations/Special Requirements in the Administration Guide). If
you use the \lan directory, ARIS Web Designer/ARIS UML Designer will
run as an applet; if you use \app, it will run as an application.

To make the change manually rather than by choosing directories:

1. Open the aris_database_*.html files. The files are located in the


templates\htmlgen\en directory of your ARIS Business Server
installation directory.

2. Find the following line:

var appletmode = (args['appletmode'] ? args['appletmode'] :


"true");

3. Replace the true parameter with false.

4. Save your changes.

ARIS Administration 9
How to Set Up an ARIS Web Designer Client for Use in a Browser

You can undo these settings at any time by replacing false with true in
the relevant line of the file indicated above.

2.7 Provide Additional Memory


If you use ARIS Web Designer as applet, you can provide additional
memory for ARIS Web Designer. This is recommended if you use e. g.
memory-intensive, user-defined symbols in your databases.

1. Click on Start/Settings/Control Panel in Windows.

2. Double-click on Java Plug-in <version number>.

3. The Java Plug-in Control Panel dialog box will open. The name of
the dialog box can vary depending on the version.

4. In the Java Runtime Parameters box on the Basic tab, enter the
characters Xmx, then the size of the main memory you want to make
available in ARIS Web Designer and then an m.
Example: To make available 256 megabyte, enter -Xmx256m. A
value of 256 megabyte is recommended if your computer has a main
memory of 512 megabyte.

5. Depending on the version, click on Apply or Reset or and close the


dialog box.

10 Administration ARIS
How to Set Up an ARIS Web Designer Client for Use in a Browser

2.8 Installation by Software Distribution


The following change to the standard installation blocks further updates
or other changes by the ARIS installation program. You must then
make such changes yourself.
Generally, the following is true: The cid.bin file must not be
distributed, otherwise all clients will be identified as one and the same
client. Since the file is recreated when starting the client, it is not
necessary to distribute it.

After starting ARIS Toolset or ARIS Web Designer you will find the
cid.bin file in the .ARIS62 subdirectory of the user profile
(%userprofile).

You can copy the ARIS Web Designer JAR files from the aris6.2/lib
directory to a directory on the client computer by software distribution
You can then assign the arishome62 environment variable to this
path.

2.8.1 Possible Settings for user.cfg


You can make the following settings, for example, in the user.cfg file:

You can enter an IDS company license key so that users no longer
have to enter a license key when launching ARIS Web Designer for the
first time.

You can enter configuration settings, e.g. default filter or grid width.

You can set up a sample ARIS Web Designer and copy the user.cfg
file generated there to the aris6.2/config directory.
Note: You must delete the session ID in that case.

2.8.2 Pre-Configured user.cfg


When ARIS Web Designer has been installed for the first time (see
chapter 2), the internal file user.cfg is used when it is run for the first
time. This file also ensures that you have to enter the license key for
ARIS Web Designer when the program is launched.

ARIS Administration 11
How to Set Up an ARIS Web Designer Client for Use in a Browser

2.8.3 How to Configure user.cfg


If ARIS Web Designer finds the user.cfg file in the config directory of
your ARIS Web Designer components installation, it will use that
instead of the preconfigured user.cfg (see chapter 2.8.1).

1. Switch to the config directory of your ARIS Web Designer components


installation.

2. Open the user.cfg file in a text editor, make your entries (see chapter
2.8.1) and save the file.

The first time a user launches ARIS Web Designer, your settings will be
used. If a user has already used ARIS Web Designer before the
user.cfg file is changed, the user.cfg file on the user's computer must
be deleted.

12 Administration ARIS
How to Set Up an ARIS Web Designer Client for Use in a Browser

2.9 ARIS Web Report Server


The ARIS Web Report Server enables you to create ARIS Web Designer
reports as you work.

It is installed automatically when ARIS Site Manager is installed.

2.9.1 Hardware Requirements for ARIS Web Report


Server
You will need 10 MB RAM plus 25 MB RAM for each simultaneously
generated report. For example, to generate four reports at the same
time, you will require 10 MB plus four times 25 MB RAM, i.e. a total of
110 MB RAM.

2.9.2 Report Formats and Report Files


To be able to output reports in Word for Windows and Excel formats,
both programs must be installed on the computer on which ARIS Site
Manager is installed.

You can manage the report scripts using ARIS Site Administrator (see
Online Help).

Reports are opened in the program that is linked to the result format.
For instance, if you have selected RTF as the output format, the report
will be output on the computer on which you have installed ARIS Web
Designer with the connected RTF editor, e.g. Word for Windows.

Reports will be saved in your Temp directory. To save them in a


different directory, use the Save As functionality of the output
program.

ARIS Administration 13
How to Set Up an ARIS Web Designer Client for Use in a Browser

2.9.3 Creating Web Reports - Special Features

2.9.3.1 Dialog Variables


If you want to use dialog variables in a Web report, unlike a local
report, you must declare the scope of the dialog variables.

Example of a local report:

bIsOk = False
If bIsOk Then
Begin Dialog UserDialog 440,112,"ARIS Report" ' %GRID:10,7,1,1
OptionGroup.options
OptionButton 20,14,380,14,"Option1"
OptionButton 20,35,380,14,"Option2"
OKButton 210,77,100,21
CancelButton 320,77,100,21
End Dialog
Dim Dlg As UserDialog
End If
If Dlg.options = 0 Then ...

If this report is used as a Web report, an error will occur because the
Dlg.options variable is not globally valid.

The following change makes the Dlg.options variable globally valid so


that the report can be used as a Web report:

Dim nDlg_Options As Long


bIsOk = False
If bIsOk Then
Begin Dialog UserDialog 440,112,"ARIS Report" ' %GRID:10,7,1,1
OptionGroup.options
OptionButton 20,14,380,14,"Option1"
OptionButton 20,35,380,14,"Option2"
OKButton 210,77,100,21
CancelButton 320,77,100,21
End Dialog
Dim Dlg As UserDialog
nDlg_Options = Dlg.options
End If
If nDlg.options = 0 Then ...

14 Administration ARIS
How to Set Up an ARIS Web Designer Client for Use in a Browser

2.9.3.2 Windows API Functions


The Web report runs the report scripts on the server. As a result, for
example, dialogs called in a script using Windows API functions will
appear on the server and not on the client as required. The same
applies while running Shell and ShellExecute: The corresponding
programs and files will be run or opened via the default methods on
the server.

For this reason, ARIS Script contains special methods so that the
dialog boxes, programs and files appear, run or open on the client. The
parameters for these methods can be found in the associated help
files.

The default methods are described in the following.

You must replace the default methods as shown in the following table:

Default ARIS Script

GetOpenFileName BrowseForFiles
(Win API) Option parameters include = 0. Multiple
selection of files is possible if you increase
this parameter by + 8.
GetSaveFileName BrowseForFiles
(Win-API) Option parameter includes = 3
GetFilePath BrowseForFiles
(Sax Basic)
SHBrowseForFolder BrowseForFolders
(Win-API)
ShellExecute Shell
(Win-API)

2.9.3.3 Nested Dialogs


Nested dialogs are generally not permitted in Web reports. Such
nested dialogs occur for example if a message box (MsgBox) is used
to output an error message in the DialogFunc. To have this message
box output by the Web report, you must include it in such a way that it
only appears after the dialog box generated with DialogFunc has
closed.

ARIS Administration 15
ARIS Process Cost Analyzer

3 ARIS Process Cost Analyzer


ARIS Process Cost Analyzer is a component of the ARIS 6 - Colla-
borative Suite which can be installed as a stand-alone component or in
combination with the ARIS Toolset or ARIS Web Designer components.

The system requirements specified in chapter 10 apply.

The installation scenarios described in chapter Installation Scenarios


in the Installation Guide are available for use with ARIS Process Cost
Analyzer.

3.1 Client Installation


If one or more users are working on the same computer, the
installation option CLIENT WITH LOCAL STANDARD DATABASE
SYSTEM is recommended.

1. Insert the ARIS CD into your CD drive. If the start page is not
displayed automatically, click on the name of your CD drive in
Windows Explorer and double click on the ARIS_62.exe program.

2. Click on Installations.

3. Click on Client Installations.

4. Click on ARIS Client.

5. The installation program's Welcome page is displayed. Click on Next.

6. Once you have read and accepted the license agreements, click on
Yes.

7. To use the suggested installation directory, click on Next and continue


with the next step.

The name of the installation directory must not contain any


country-specific special characters.
To install the program in a directory other than the one proposed, click
on Browse. Enter the desired path in the Path box or navigate to the
desired folder in the Directories box. Click on OK. Click on Next.

8. Select a program folder in which to place the program shortcuts. Click


on Next.

16 Administration ARIS
ARIS Process Cost Analyzer

9. On the Select Components page, select the ARIS Process Cost


Analyzer component.
If you want to edit and transfer models from ARIS, you should also
select the ARIS Toolset component.
If you want to edit ARIS models in your Web browser, you should also
select the ARIS Web Designer component.

10. Click on Next.

11. The CLIENT WITH LOCAL STANDARD DATABASE SYSTEM option


is selected on the Select Type of Installation page. Click on Next.

12. Check the check box of the interface and method languages in which
ARIS is to be installed. Click on Next.

13. Check your settings in the summary. If your settings are correct, click
on Next. The program will be installed.

14. If you do not wish to create a desktop shortcut, clear the check box.
Click on Finish. The installation is completed and the installation
program will close.

3.2 Default Server


If several users, but not more than 50, will be working simultaneously
with ARIS, it is recommended that you install a client without a local
standard database system and a default server.

1. Proceed as described in chapter 3.1. However, in step 12 you should


select the option CLIENT WITHOUT LOCAL STANDARD DATABASE
SYSTEM.

2. Then install a default server (see chapter ARIS 6.2 Default Server
(Recommended for up to 50 Users) as described in the Installation
Guide).

ARIS Administration 17
ARIS Process Cost Analyzer

3.3 ARIS 6.2 Server User-Defined (Advanced Installation)


If more than 50 users are working with ARIS simultaneously and you
want to optimize performance when transferring data from ARIS
models due to large data quantities and complex data structures, or if
you want to install individual server components on different
computers for one of the other reasons described in chapter
Installation Scenarios, it is recommended that you install a client
and a user-defined server.

1. Proceed as described in chapter 3.1. However, in step 12 you should


select the option CLIENT WITHOUT LOCAL STANDARD DATABASE
SYSTEM.

2. Then install a user-defined server (see chapter ARIS 6.2 Server


User-Defined (Advanced Installation) as described in the
Installation Guide).

3.4 License Keys


The first time you launch ARIS Process Cost Analyzer, you are
prompted to enter a license key.

Enter the license key you received when you purchased your ARIS
license. Note that a special license key may be necessary for a
combination of several ARIS components. License keys may also have
a time limit.

If you have any questions about your license key, please contact the
IDS Scheer Customer Inter@ction Center (see chapter 12.1).

3.5 Management of PCA Databases


ARIS PCA Site Administrator is available for backing up, renaming and
deleting PCA databases.

You will find it in your ARIS program group in the Administration


subfolder, e.g. under Start/Programs/ARIS 6.2/Administration.

18 Administration ARIS
ARIS Process Cost Analyzer

3.6 PCA Reports


You can also use ARIS PCA Site Administrator to manage PCA reports
(see chapter 7.6). This applies to reports in your local standard
database system (client installation) and reports on other ARIS servers
(default server or user-defined server).

In order to be able to use report scripts you have created yourself, you
will require an external server and ARIS Site Administrator. If you
select ARIS Toolset during the client installation, ARIS Site
Administrator is also installed automatically. Alternatively, you can
install the external server (default server or user-defined server) later.

ARIS Administration 19
ARIS Agent

4 ARIS Agent
The following describes how the agent-based system in ARIS can
support you in diagnosing and restoring ARIS services.

4.1 What Is the Purpose of ARIS Agents?


The ARIS Agent system autonomously monitors ARIS Business Server
processes together with their dependent services, particularly for
starting and stopping them.

Within the system, an ARIS Agent monitors and administers all ARIS
Business Server processes (and the associated ARIS Service) that are
installed on one computer.

4.2 What Tasks Does an ARIS Agent Handle?


An ARIS Agent is particularly responsible for the following tasks:

Determining and providing ARIS Service information

Monitoring ARIS Services through regular queries to ARIS Services


(Ping)

Shutting down or rebooting ARIS Services (automatically or after


prompting)

4.3 How to Close ARIS Agents


If you shut the ARIS Business Server down correctly, this will also shut
down the ARIS Agent and all ARIS Services. To do this, either open the
DOS window for the ARIS Business Server and press Ctrl + C or exit
the service.

20 Administration ARIS
ARIS Agent

4.4 Activation of the ARIS Notify Service


ARIS Site administrators can have messages sent by the ARIS Notify
Service when problems arise. It is also possible to notify several
administrators at the same time.

In the arisserver.cfg file you can have an email sent to anyemail


address if the behavior of the ARIS Site triggers warnings or error
messages. The email will have as an attachment the zipped files of the
log and config directories. You can change the notification mode by
setting the state value.

The mail.user.name account (see following settings) must be on your


e-mail server.

The settings are included in the Adminservice tag:

<mailserver
state="on"
mail.locale.lang="en"
mail.locale.country="en"
mail.warnings.enable="true"
mail.server.host="172.20.130.233"
mail.server.protocol="smtp"
mail.user.name="adminservice"
mail.user.address="adminservice@ids-scheer.de">
<recipient
mail.recipient.to="adminservice@ids-scheer.de"
mail.recipient.cc="adminservice@ids-scheer.de">
</recipient>
</mailserver>

ARIS Administration 21
ARIS Agent

Possible values:

Entry Value Meaning

state on The mail function is switched on.


off The mail function is switched off.
mail.locale.lang de Contains the respective language
code.
mail.locale.country de
In this example, the language code
for English.
mail.warnings.enable true Emails will be sent for warnings and
errors.

false Emails will be sent only for errors.

mail.server.host 172.20.130.233 IP address or name of the mail


server.
In this example an IP address has
been entered.
mail.server.protocol smtp Protocol with which the emails are
sent.
In this example: simple mail transfer
protocol.
mail.user.name adminservice Name of the email sender.
In this example adminservice
mail.user.address adminservice@ids- Address of the email sender.
scheer.de In this example adminservice@ids-
scheer.de
mail.recipient.to adminservice@ids- Address of the email recipient.
scheer.de In this example adminservice@ids-
scheer.de
mail.recipient.cc adminservice@ids- Address of the email recipient who is
scheer.de to receive a copy of the email.
In this example adminservice@ids-
scheer.de

22 Administration ARIS
Configuration Options

5 Configuration Options
Here you will find a description of the ways you can customize ARIS to
suit your needs by modifying various files.

5.1 How to Configure arisserver.cfg


You can use arisserver.cfg (server\config directory) to:

Control the behavior of the HTML Generator (see chapter 5.1.1).

Configure the connections between the clients, ARIS Business Server


and ARIS Site Manager (see the following descriptions).

Define that an e-mail is sent automatically to any address if the


behavior of ARIS Business Server triggers warnings or error messages
(see chapter 4.4).

Client/ARIS Business Server Connection

Each client sends a ping to ARIS Business Server every 25 seconds,


and ARIS Business Server polls its clients every 90 seconds (value in
milliseconds) according to the following setting. This entry determines
the period within which a user can contact the ARIS Business Server
via the client without having to log in again via the log-in dialog box.

<AppServerTimer
timeout_interval="90000" />

ARIS Business Server/ARIS Site Manager Connection

The following entries specify the intervals at which ARIS Site Manager
checks whether the license service is active:

<licenseservice_client
timeout_interval="300000"
heartbeat_interval="50000" />

The heartbeat_interval="50000" entry specifies that the ARIS


Business Server will send a ping to the ARIS Site Manager every 50
seconds (= 50 000 milliseconds) and so indicate that its licenses are
still being used.

The timeout_interval="300000" entry specifies that the ARIS Site


Manager checks every 5 minutes (= 300 000 milliseconds) whether the
ARIS Business Server is still logged in with the corresponding licenses.

ARIS Administration 23
Configuration Options

If this is not the case all licenses used via this ARIS Business Server
will be released.

Similarly, the following entries handle the locks in the database:

<lockservice_client
timeout_interval="300000"
heartbeat_interval="50000" />

The heartbeat_interval="50000" entry specifies that the ARIS


Business Server will send a ping to the ARIS Site Manager every 50
seconds (= 50 000 milliseconds) and so indicate that its locks are still
valid.

The timeout_interval="300000" entry specifies that the ARIS Site


Manager checks every 5 minutes (= 300 000 milliseconds) whether the
ARIS Business Server is still logged in with the corresponding licenses.
If this is not the case all locks generated via this ARIS Business Server
will be lifted.

5.1.1 HTML Generator - Current Database Lists


The HTML Generator creates all the index files and the
aris_database.html file for the ARIS Web Designer components. It
updates the access files whenever databases are created, renamed or
deleted. You can control this activity in the arisserver.cfg file
(server\config directory).

During a default server installation, the HTML Generator is switched on


and generates the index.html files in the C:\<default
directory>\aris6.2\server\html directory. If you accept all default
values during installation, this directory will always contain a current,
executable directory of ARIS Web Designer components that you can
copy directly to your Web server.

In a user-defined installation a dialog box will prompt you for the


location of the HTML Generator.

The HTMLGENERATOR section of the arisserver.cfg file contains the


path in which the created files are saved. A language ID is entered in
this section for each of the interface languages installed on the ARIS
Business Server. The HTML Generator creates an index.html file for
each of these IDs in the ARIS Web Designer components structure:

24 Administration ARIS
Configuration Options

<htmlgen>
<languagelist>
<language tag="de"/>
<language tag="en"/>
<language tag="ja"/>
</languagelist>

<!-- Please edit only these paths for HTMLgenerator


configuration -->
<outputpath path="C:/Program Files/wwwroot/aris6.2"/>
</htmlgen>

You can perform HTML generation manually at any time by running the
htmlgen.bat file in the ARIS Business Server directory.

5.1.2 Restriction of the Number of index_backup Files


If the HTML Generator creates a new index.html file the existing
index.html file is saved as an index_backup(>DateTime>).zip file
in the specified backup path. The backup path is entered in the
<htmlgen> section, e.g. <backuppath
path="e:/inet/wwwroot/aris6.2/backup"/>.

By your entry in the <htmlgen> section, you can determine the


intervals at which the backup files, except for the most current ones,
will be deleted. The interval is expressed in days. The following
example defines that all but the most current index_backup files will
be deleted after seven days:

<backupperiod period="7"/>

ARIS Administration 25
Configuration Options

5.2 When Must You Configure arislauncher.cfg?


You will only have to configure the arislauncher.cfg file

if you wish to use SSL software (see chapter 2.4),

if memory-intensive applications, such as an XML import or a fast


merge, require more memory,

if you have to change the ports as a result of a port conflict with


external software.

If you have installed ARIS locally, you will find the file in the <ARIS
installation directory>\LocalServer\config directory.

If ARIS is installed on a server, you will find it in the <ARIS


installation directory>\server\config directory.

Provide Additional Memory

To provide additional memory, you must ensure that the hardware


requirements are fulfilled.

You can then increase the memory usage by entering:

<Property name="JVM Option 5" value="Xmx256m"/>

You only have to change the value shown in bold. The entry in the
example above specifies that the ARIS Business Server may use a
maximum memory of 256 megabyte.

Ports Changed

To customize the ports specified by default, you must make your


changes for the server in the following files:

arislauncher.cfg

agentlauncher.cfg

adminservicelauncher.cfg

arisserver.cfg

TCP/IP services file.

In addition, you must also modify the client ports in the following files:

TCP/IP services file.

26 Administration ARIS
Configuration Options

siteadmin.cfg

converterclient.cfg

aris_database*.html in the <ARIS installation


directory>\server\templates\htmlgen\<language code>
directory

You have to make this change again after every update.

5.3 Central User Login Using LDAP


To institute a centralized system of user authentication for an ARIS
Site, you can set up an LDAP server (for definition of LDAP server see
chapter 11).

5.3.1 Requirements for LDAP Authentication


To authenticate users via LDAP, you will have to install an LDAP
server. The LDAP server software can be downloaded free of charge
from the Internet or purchased.

5.3.2 Advantages of LDAP Authentication


Authenticating users via the LDAP server instead of the ARIS database
simplifies administration and avoids redundancy of password
information.

With this "single point of login"", users' passwords only need to be


maintained in one system. Moreover, if you delete an LDAP user or
change his password, that user can no longer access any of the ARIS
databases that use the LDAP login process.

Please ensure that users choose a password containing at least one


letter. It is not possible to leave the password field blank, i.e. not to
use a password.

ARIS Administration 27
Configuration Options

5.3.3 Security

5.3.3.1 Access to Databases


We recommend creating at least one system user per database who is
authenticated via the database rather than the LDAP server. This
avoids the situation in which there is no access to databases at all if
the LDAP servers go down.

To ensure that the system user is authenticated by the database, all


you have to do is ensure that the check box of the LDAP login
attribute is cleared for this user (see chapter 5.3.4).

5.3.3.2 SSL Protocol


You can send login data in encrypted form via SSL (for definition of
SSL see chapter 11). This assumes that your LDAP server supports
the SSL protocol.

To enable SSL, you must add ssl: to the server URL you entered in the
LDAP login server URL attribute for the database. Example:
ssl:ldap://aris:389 (see chapter 5.3.3.3).

If the login process uses SSL, the LDAP server will send its SSL
certificate to the ARIS Business Server. Before the ARIS Business
Server can accept the certificate, this must be entered in the
corresponding file (keystore) of the ARIS Business Server.

Enter the ARIS Business Server keystore path in the arisserver.cfg


file. Example: securitykeystore=<ARIS installation
directory>/server/ security/ariskeystore/ (see chapter
5.3.3.3). Within an ARIS Site all the ARIS Business Servers must have
an identical keystore.

5.3.3.3 Backup Server


You can enter up to three LDAP servers as database attribute.
Operating three identically configured LDAP servers ensures a high
level of reliability. During login, the first LDAP server is accessed, if this
is not available the second etc.

28 Administration ARIS
Configuration Options

5.3.4 How to Set Up ARIS for LDAP Server Operation


When you have installed the LDAP servers, you have to make the
following settings in ARIS. These settings must be made for each
database for which the users are to log in using the LDAP server:

1. Log into the database in ARIS Toolset.

2. Right-click on the name of the database, and then click on Attributes.


The attribute editing will open.

3. Enter the respective LDAP server URL as the attribute value for each
LDAP login server URL attribute. This has the following structure:
ldap://<server name>:<port number>.

The server name is the name of the LDAP server, the port number is
the number of the port on which the LDAP server receives unencrypted
queries. Example: ldap://aris:389.
To use SSL for encrypted transmission of login data, enter ssl: before
the LDAP server URL. Example: ssl:ldap://aris:389 (see chapter
5.3.3.2). For improved reliability, you can enter up to three LDAP
servers (see chapter 5.3.3.3).

4. Click on File/Save.

5. Close the attribute editing.

6. Click on the User database item.


If the database item is not visible, you must select the check box next
to the User management list entry in the Display field on the
Explorer (View/Options) options page.

7. Select the names of the users who are to log in using the LDAP server.

8. Right-click in the selection and then on Attributes. The attribute


editing will open.

9. In the Distinguished Name field, for each user enter the name of the
node corresponding to the user and containing the password
information. Whether you use e.g. the unique ID (uid) or the common
name (cn) depends on your LDAP server settings.
The structure of the entry is uid=<username> or
cn=<username>,dc=<directory contact>.
Example: For user Peter Fletcher the entry could be uid=pf,dc=aris.

ARIS Administration 29
Configuration Options

10. Select the LDAP login attribute check box for each user. If this check
box is not selected, login using the LDAP server will not work.

11. Click on File/Save.

12. Close the attribute editing.

From now on, the users you selected at step 7 will be authenticated using
the LDAP server.

30 Administration ARIS
Configuration Options

5.3.5 Authentication Process


The login process is executed differently depending on whether the
user is to log in using the LDAP server, because the LDAP login
attribute has been selected, or via the database because this check
box has been cleared:

ARIS Administration 31
Database Systems

6 Database Systems
For working with ARIS, you can use other database systems than the
standard database system. In the following you will obtain information
on setting up and managing these database systems. As far as the
platform approvals for individual database versions are concerned, the
manufacturer's specifications do apply.

6.1 Oracle Database Server


To set up your Oracle database system we recommend that you
take advantage of IDS Scheer Installation Support (see Chapter
12.1).

Read this section if you intend to use ARIS with Oracle.

If you are installing Oracle yourself, always follow the installation


instructions given in the Oracle installation guide.

Scale your system in such a way that operation of Oracle does not take
up more than 40% of your RAM. Otherwise, runtime problems may
arise when the ARIS Business Server and other applications are
running on the same computer at the same time.

Once you have installed the Oracle DBMS server you must create an
ARIS instance/database. The following sections detail the table space
and table configurations required for ARIS as well as recommended
Oracle system parameters.

The ARIS instance/database is created by the Oracle Database


Configuration Wizard.

Once you have created the instance/database, you must create an


ARIS 6 database user. To do this, run the SQL scripts that are located
in the setups\oracle directory on the ARIS CD (see chapter 6.1.9).

32 Administration ARIS
Database Systems

6.1.1 Required Tablespaces and Tables


This section describes the table spaces and tables required for using
ARIS with Oracle.

The tablespaces described in the following table must already be in


place before you install ARIS for use with Oracle.

Table Default Default Default PCT Default Size of Data File Next
Space INITIAL NEXT INCREASE MAXEXTENT Extension

ARISDATA 128KB 1 MB 0 UNLIMITED 2 GB 10 MB

ARISINDEX 128KB 1 MB 0 UNLIMITED 1.5 GB 10 MB

Total 3.5 GB

Taking all of the sizes of these tablespaces together, it is clear that for
all ARIS databases, approximately 3.5 GB of hard disk space is
required initially on the Oracle server.
Tablespace Parameters
Since most tables derive their parameters from the tablespaces, it is
important to ensure that the standard storage parameters of the table
spaces (INITIAL, NEXT) are set up in line with the quantity of data to
be stored in the database.

On the basis of the size of the initial extent as proposed above, an


ARIS database created subsequently will initially take up around 25
MB.

ARIS Administration 33
Database Systems

6.1.2 Recommended Tablespace Configuration


This section provides an overview of the recommended tablespace
configuration for using ARIS with Oracle. This configuration is the
storage property on which every newly created table (and every index)
is based.

Name Contents

ArisData Tables

ArisIndex Table indexes

System Tablespace Data dictionary, System


packages

Rollback Tablespace Rollback Segments

Temp Temp segments

6.1.3 Oracle System Parameters


We recommend the following values for configuration of Oracle system
parameters. These parameters ensure that ARIS databases are not
excessively fragmented and do not take up too much space:

Oracle System Value


Parameters

Temp Tablespace Datafilesize=5 MB

Autoextend on

Maxsize=100 MB

NextExtent=5 MB

Rollback Tablespace Datafilesize=100 MB

Autoextend on

Nextextent=10 MB
Rollback Segments 28 segments with an initial size of
around 4 MB

34 Administration ARIS
Database Systems

6.1.4 Oracle Database Settings


When setting up the Oracle database for ARIS you must set UTF 8 as
the database character set. UTF 8 is absolutely necessary to the
operation of ARIS.

We recommend an 8 KB block size - which should be a multiple of the


operating system block size.

You cannot change either of these settings subsequently, in other


words if these settings are incorrect you will have to completely
reinstall the database.

We recommend 20 MB as the size for each of the redolog files.

6.1.5 Oracle Instance Parameters

Parameter Description

compatible=8.1.0 The Oracle instance has to be compatible


for the version 8.1.0. However for the
instance itself you must have at
least the version 8.1.7. This entry is
necessary, among other things, for using
CLOB data types in connection with the
UTF 8 character set.

checkpoint_interval= 40000 The number entered here multiplied by


the operating system block size should
result approximately in the size of the
redolog files.
Example If one assumes an operating
system block size of 512 bytes and 20
MB for the redolog files, the value will be
approximately 40000.

checkpoint_timeout=0 This parameter indicates the period in


seconds in which Oracle performs an
automatic check point. The value is set
to 1800 by default. To turn off the time-
controlled check point, enter 0 here.

ARIS Administration 35
Database Systems

Parameter Description

session_cached_cursors=100 Optimizes access

query_rewrite_enabled=true Necessary for use of function-based


query_rewrite_integrity=trusted indices.

6.1.6 Oracle Optimizer


We recommend that you use the cost-based optimizer instead of the
rule-based optimizer. This is, for instance, the only way to select
function-based Oracle indices for ARIS 6.

The cost-based optimizer is used automatically as soon as statistics


exist for the corresponding scheme.

ARIS 6 generates these statistics automatically when converting an


ARIS database from ARIS 5.01, and when restoring an ARIS 6
database (in ESTIMATE mode). When a new ARIS database is created
there are no statistics yet. We recommend that you generate these
statistics at regular intervals, for instance using SQL*PLUS by calling
up

execute dbms_utility.analyze_schema('<oracle_user>',
'COMPUTE');

<oracle_user> indicating the Oracle user in whose scheme the ARIS 6


database is located.

6.1.7 Refresh Oracle Statistics


Oracle statistics are recalculated when ARIS databases are restored or
converted. If you are editing large quantities of data with ARIS Web
Designer/ARIS UML Designer, it can happen that the performance is
noticeably reduced In this case, the Oracle statistics need to be
maintained. You have two options for recalculating the statistics:

Call the Maintain function in the ARIS Admin tool for the corresponding
databases (see chapter 9.3.11).

36 Administration ARIS
Database Systems

In Oracle, implement a job that periodically calls the


DBMS_STATS.GATHER_SCHEMA_STATS method for the Oracle
schemas in which the data for the ARIS database is located. If you
use the GATHER STALE option, the statistics are only refreshed if more
than 10% of the data has changed. For more information on the
DBMS_JOB and DBMS_STATS package, please refer to your Oracle
documentation.

6.1.8 Oracle Schemes for ARIS


Each ARIS databases is located in exactly one Oracle scheme. These
schemes all begin with the prefix A62_ followed by a sequential
number, e.g. A62_1516.

The names of all of these schemes are managed in a catalog table.


This table is located in the ARISADMIN62 scheme and is called
DBLIST. There you will find the assignment of names of ARIS
databases to Oracle schemes in which the ARIS databases are located.
If, for example, you delete a row from this table, the ARIS database
concerned is no longer visible for the application even though the
associated Oracle scheme still exists.

When deleting an ARIS database in the application it may happen that


the associated Oracle scheme cannot be deleted since there may still
be connections to this scheme (outside the application for instance via
SQL*PLUS). In a case like that only the corresponding entry from the
DBLIST table will be removed rendering the database no longer visible
for the application. For this reason, it is advisable to periodically check
which Oracle schemes - names beginning with "A62_" - are not
referenced in the DBLIST table and are therefore no longer required.
In such cases you can manually delete the schemes that are no longer
required.

ARIS Administration 37
Database Systems

6.1.9 How to Create an ARIS 6 Database User in Oracle


To create a database user, proceed as follows:

1. Open the DOS Box (or a shell under UNIX) and switch to the
setups\oracle directory on the ARIS CD.

2. Ensure that the ORACLE_HOME and ORACLE_SID environment


variables have been set.

3. Run the aris62.bat batch file (under UNIX the aris62.sh file) by
entering the file name, the user name and password of the Oracle
system user, and the path to the ARIS installation scripts. In step 1,
you switched to the directory containing the ARIS installation scripts.
Therefore this is shown as the current directory in the following
command sequence.

Example: aris62.bat system manager .

6.1.10 Oracle - Recommended Reading


Extensive information is available in publications from Oracle Press.
You can also find out information from the following books:

Ed Whalen: SAMS Teach Yourself Oracle 8 in 21 Days, ISBN:


0672311593

Marina Krakovsky: Understanding the Oracle Server, ISBN:


0131902652

Gnther Strner: Oracle 8i. Der objekt-relationale Datenbank Server


[The object-relational database server], ISBN 3930124017.

38 Administration ARIS
Database Systems

6.2 Microsoft SQL Server


To set up your Microsoft SQL Server we recommend that you
take advantage of IDS Scheer Installation Support (see Chapter
12.1).

Please read this section if you intend to use ARIS with Microsoft SQL
Server.

If you are installing Microsoft SQL Server yourself, always follow the
installation instructions in the Microsoft SQL Server installation guide.

6.2.1 Required Programs, Drivers and Scripts


To use ARIS together with a SQL server, you need the following
components:

Microsoft SQL Server 2000 Standard for installing the SQL server on
a Microsoft server
If you want to use this server, you must buy it from Microsoft.

Microsoft Service Pack 3a for Microsoft SQL Server 2000

Microsoft JDBC driver


You can download the Microsoft JDBC driver from the Microsoft home-
page.

ARIS@SQL server scripts


These scripts are located in the Setups\MSSQL directory on the ARIS
CD.

6.2.2 Notes on Installing the SQL Server


Please use the Mixed Mode (Windows Authentication and SQL
Server Authentication) installation option, as ARIS uses a separate
SQL server user and its associated database scheme for each ARIS
database. This means that a system user cannot be generated for an
ARIS database.

Select the desired licensing mode.

After installing Microsoft SQL Server, install Service Pack 3a for the
SQL server. Otherwise the SQL server cannot function properly.

ARIS Administration 39
Database Systems

6.2.3 Setting up the SQL Server

The following description refers to Windows 2000. The names and


locations of options may be different in other operating systems.
1. Open Computer Management.

2. In the tree view, browse to the newly installed SQL server via
Services and Applications and Microsoft SQL Servers.

3. Right-click on the name of the newly installed system and then on


Properties.

4. On the Server Settings tab, enable the Allow modifications to be


made directly to the system catalogs check box.
This allows the ARIS main user to create a new SQL server user
directly. ARIS requires the main user in order to be able to create its
own databases.

5. Check the Allow triggers to be fired which fire other triggers


(nested triggers) check box.
This setting is necessary to improve ARIS referential integrity. SQL
servers prevent double referencing of base keys in a derived table,
which is intended to prevent possible loops. To obtain the required
functionality, ARIS uses nested triggers.

6. If the SQL server is the main application on the computer, you can
make additional resources available to it. On the Processor tab,
enable the Boost SQL Server priority on Windows check box.

7. If you are using a computer with more than one processor, enable Use
Windows NT Fibers. We recommend this approach so that more NT
fibers are used as threads. This also improves performance when
switching between and generating threads.

8. Close the dialog box by clicking on OK.

9. Click on Services in the tree view.

10. In the detail view, right-click on SQLSERVERAGENT and then on


Properties.

40 Administration ARIS
Database Systems

11. On the General tab, set Automatic as the start type for SQL server
and server agent.

The agent must be started every time the SQL server is


restarted.

12. Click on Connections and set the query time-out to 0.

13. Click on OK and close Computer Management.

6.2.4 Using ARIS *.SQL Scripts

6.2.4.1 Adapting the init.sql Script


The following section of the init.sql script generates the ARIS
instances on the SQL server.

CREATE DATABASE ARIS


ON
(NAME = aris_dat,
FILENAME = G:\sqlsrvdata\aris.mdf,
SIZE = 100,
FILEGROWTH = 50)
LOG ON
( NAME = aris.log,
FILENAME = F:\sqlsrvdata\aris.ldf,
SIZE = 20,
FILEGROWTH = 20MB)
GO

Please enter two existing paths for the two paths of the files aris_dat
and aris_log (see Assignments).

ARIS Administration 41
Database Systems

6.2.4.2 ARIS Scheme Strategy


You can create ARIS databases automatically or manually.

6.2.4.2.1 Automatic Configuration (Recommended)


This strategy automatically generates new databases in the
ARIS62.db_stock table.

A prerequisite for this is that the ARIS main user has the
privileges needed to change the SQL server tables. This
privilege is assigned to the ARIS62 user by the
enhancedProcedures.sql script.

If you opt for this configuration, your intervention is not required to


create or delete ARIS schemes.

Proceed as follows:

1. You must copy the scripts to your hard drive! You need write
privileges in the target directory to store the logfiles from the
installation.

2. Open the DOS box for the directory to which you have copied the
aris62AutoAdmin.bat file and the SQL scripts.

3. Execute the aris62AutoAdmin.bat script and enter the name of the


database user, e.g. sa, the password, e.g. manager and the directory
where the SQL*Plus scripts are located.
Example: aris62AutoAdmin.bat sa manager .
The period at the end of the example line stands for the current
directory.

42 Administration ARIS
Database Systems

This executes the following scripts in the order listed:

Script Description
init.sql Generates the ARIS instance.
installaris62.sql Generates the ARIS62 ARIS main user and assigns
its access privileges to it.
aris_23.sql Generates the procedures required for the ARIS
databases in the ARIS23 scheme.
aris_22.sql Generates the procedures required for ARIS
databases in the ARIS22 scheme.
aris_21.sql Generates the procedures required for ARIS
databases in the ARIS21 scheme.
bo_2.sql Generates the procedures required for ARIS
databases in the BO (Business Optimizer) scheme.
enhancedProcedures.sql Assigns the privilege of creating users to the
ARIS62 ARIS main user.
initialDatabases.sql Generates the first database in the DB_STOCK
table.
recycler.sql Job of the SQL server agent. This job removes
deleted databases at midnight each night. This
makes users of deleted databases available again.

6.2.4.2.2 Manual Configuration


If you do not want to give the main ARIS user the privilege of
modifying system tables on the SQL server, manual configuration is
possible.

Proceed as follows:

1. Open the DOS box for the directory to which you have copied the
aris62SelfAdmin.bat file and the SQL scripts.

2. Execute the aris62SelfAdmin.bat script and enter the name of the


database user, e.g. sa, the password, e.g. manager and the directory
where the SQL*Plus scripts are located.
Example: aris62SelfAdmin.bat sa manager .
The period at the end of the example line stands for the current
directory.

ARIS Administration 43
Database Systems

This executes the following scripts in the order listed:

Script Description
init.sql Generates the ARIS instance.
installaris62.sql Generates the ARIS62 ARIS main user and assigns
its access privileges to it.
aris_23.sql Generates the procedures required for the ARIS
databases in the ARIS23 scheme.
aris_22.sql Generates the procedures required for ARIS
databases in the ARIS22 scheme.
aris_21.sql Generates the procedures required for ARIS
databases in the ARIS21 scheme.
bo_2.sql Generates the procedures required for ARIS
databases in the BO (Business Optimizer) scheme.
initialDatabases.sql Generates the first database in the DB_STOCK
table.
recycler.sql Job of the SQL server agent. This job removes
deleted databases at midnight each night. This
makes users of deleted databases available again.

If the ARIS62.dbstock table is blank, you must complete it


manually. Otherwise it will not be possible to create an ARIS
database.
During installation, the table is populated with some empty
database schemes. If these are used up by the creation of ARIS
databases, the ARIS Client will inform you that the dbstock
table must be filled out.

You can make the ARIS62.dbstock table entries by recycling deleted


databases (ARIS62.db_trash table) or by refilling them. You can also
switch from manual to automatic configuration (see chapter
6.2.4.2.1):

44 Administration ARIS
Database Systems

Recycling

As you can see from the table shown here, recycling is


performed for each job at midnight (recycling.sql file).

You can also initiate recycling manually:

1. Open the DOS box for the directory to which you have copied the SQL
scripts.

2. Execute the maintenance.bat script and enter the name of the


database user, e.g. sa, the password, e.g. manager and the directory
where the SQL*Plus scripts are located.
Example: maintenance.bat sa manager .
The period at the end of the example line stands for the current
directory.

Refilling

1. Open the DOS box for the directory to which you have copied the SQL
scripts.

2. Execute the refillDatabases.bat script and enter the name of the


database user, e.g. sa, the password, e.g. manager and the directory
where the SQL*Plus scripts are located.
Example: refillDatabases.bat sa manager .
The period at the end of the example line stands for the current
directory.

Switching from manual to automatic configuration

1. Open the DOS box for the directory to which you have copied the SQL
scripts.

2. Execute the aris62SwitchToAutoAdmin.bat script and enter the


name of the database user, e.g. sa, the password, e.g. manager and
the directory where the SQL*Plus scripts are located.
Example: aris62SwitchToAutoAdmin.bat sa manager .
The period at the end of the example line stands for the current
directory.

ARIS Administration 45
Database Systems

6.2.5 ARIS Installation with SQL Server


To be able to access the installed Microsoft SQL Server using ARIS,
please install the ARIS Server as described in the chapter ARIS Site
Manager/Step-by-Step Instructions in the Installation Guide. The
model for this installation is in the chapter ARIS Site
Manager/Model: ARIS Site Manager Installation in the
Installation Guide.

6.2.6 JDBC driver


Microsoft does not allow Microsoft JDBC drivers to be installed at the
same time by our installation program. For this reason, the ARIS
installation program only installs placeholder files.

Before you launch the ARIS Server, please download the following
Microsoft JDBC drivers from the Microsoft homepage and replace the
placeholder files with them:

msbase.jar

mssqlserver.jar

msutil.jar

46 Administration ARIS
Database Systems

6.3 IBM DB2


To set up IBM DB2 we recommend that you take advantage of
IDS Scheer Installation Support (see chapter 12.1).

Read this section if you intend to use ARIS with IBM DB2.

If you are installing IBM DB2 yourself, always follow the installation
instructions given in the IBM DB2 installation guide.

6.3.1 Required Programs, Drivers and Scripts


To use ARIS together with IBM DB2, you need the following
components:

IBM DB2 UDB 8.1 for installing IBM DB2 on a computer


If you want to use this database system, you must buy it from IBM.

IBM FixPack 3 for IBM DB2 UDB 8.1

Java-StoredProcedures
These are located in the JAR file aris62db2.jar in the Setups\DB2
directory on the ARIS CD.

ARIS@DB2 scripts
These scripts are located in the Setups\ DB2 directory on the ARIS
CD.

6.3.2 Particularities of IBM DB2 Administration


Unlike ORACLE, it is not possible with DB2 to automatically generate
the statistics for the DB2 Query Optimizer when restoring ARIS adb
files. It is also impossible to run the statistics generation using the
Maintain ARIS function of ARIS Site Administrator or ARIS Admintool.

Therefore we recommend that you, as the DB2 database


administrator, use the (A62_) scheme assigned to the ARIS database
to calculate the statistics of the tables. This is necessary after having
restored an ARIS database or after considerable growth of an existing
database and can be done using the RUNSTATS DB2 function.

ARIS Administration 47
Database Systems

6.3.3 Setting up the DB2 Server

6.3.3.1 Creating a DB2 Database


1. Using the Control Center, create a new database.

2. We recommend that you name the database ARIS.

3. If you use a name other than ARIS for the database, please replace
the character string ARIS in the various scripts and configuration files
with the name you have used.

4. Select SMS Table Areas when configuring the default table areas.

5. Specify the region using UTF-8, sort order System.

6.3.3.2 Adapting Parameters of the DB2 Database


The optimal size of the following values depends on which ARIS
functions you want to carry out. If you intend to transfer ARIS
databases from previous versions (versions prior to ARIS 6.0), to carry
out extensive XML imports or to restore adb files in the overwrite
mode, you should choose higher values accordingly, for example.

1. Create a buffer pool with the name ARISBP, page size 8K and number
of pages 20000.

2. Create the ARISDATA table area for recording the ARIS data on the
following basis:

Type Regular

Buffer pool ARISBP

Page size 8K

Management type DMS

Largest expected table size 50 MB

3. Create the ARISINDEX table area for recording the indexes on the
same basis as the ARISDATA table area.

48 Administration ARIS
Database Systems

4. Create the ARISLOB table area for recording the LOB objects on the
following basis:

Type Large

Buffer pool IBMDEFAULTBP

Page size 4K

Management type DMS

Largest expected table size 25 MB

5. Create the ARISTEMP table area for recording the temporary data on
the following basis:

Type System temporary

Buffer pool ARISBP

Page size 8K

Management type SMS

6. Optimize the parameters of the transaction log files:

LOGFILSIZ 5000

LOGPRIMARY 5

LOGSECOND 5

7. Optimize the following database parameters:

MAXLOCKS=35

MAXAPPLS=1000

LOCKLIST=10000

8. Optimize the following instance parameters:

MAXAGENTS=1000

6.3.3.3 Creating Operating System User ARIS62


1. Create the new operating system user ARIS62.

2. Give it the password arisadmin (in lower case).

When the installation scripts are executed (see chapter 6.3.3.4), a


DB2 user with the same name is created.

ARIS Administration 49
Database Systems

6.3.3.4 Adapting and Executing Installation Scripts


1. Copy the aris62db2.jar file and both scripts installaris62.db2 and
installaris62db2.bat from the Setups\DB2 directory on the ARIS
CD to your DB2 database computer.

2. Open the installaris62.db2 script in an editor and find the line

CALL sqlj.install_jar('file:E:/Program
Files/.../aris62db2.jar','aris62_jar');

3. Replace the path with the path to the aris62db2.jar file on your DB2
database computer.

4. If you have called the DB2 database something other than ARIS (see
chapter 6.3.3.1), please modify the connection call for the script
accordingly. Under Windows, this is:

CONNECT TO ARIS USER db2admin USING manager;

5. In the line indicated above, also specify the password for the
db2admin DB2 user.

6. If you do not want the DB2 user ARIS62 created with this script to
have the DBADM privilege, comment out the following line:

GRANT DBADM ON DATABASE TO USER ARIS62;

If user ARIS62 has the DBADM privilege, ARIS assumes


complete administration of the ARIS database. If not, you must
manage the ARIS databases manually (see chapter 6.3.5).

7. Save your changes.

8. Execute the installaris62db2.bat file. The database objects required


by ARIS are created.

6.3.4 Adapting Connection Data to ARIS Business Server


If you

are using a database name other than ARIS (see chapter 6.3.3.1)
and/or

have modified the default port number 50000 and/or

have not given the user ARI62 a DBADM privilege,

please adapt the connection data as follows:

50 Administration ARIS
Database Systems

1. Open the Lockservice.cfg file that is located in the Server\config


directory of your ARIS Business Server installation.

2. Find the line url=jdbc:db2://myhost:50000/ARIS.

3. If you have used a name other than ARIS for your database, replace
ARIS with that name.

4. If you are using a port number other than 50000, replace this with the
port number you used for DB2.

5. If you have not given the user ARI62 a DBADM privilege, enter the
line schema_management="manual". This indicates that you will
manage the databases manually (see chapter 6.3.5.2).

6. Save your changes.

6.3.5 ARIS Database Management


Every ARIS database is saved in its own DB2 scheme with its own set
of DB2 tables. DB2 schemes for ARIS can be created and deleted
automatically by ARIS (auto-management) or manually by a DB2
database administrator.

6.3.5.1 Auto-Management
If you have given ARIS the DBADM privilege via the user ARIS62 (see
chapter 6.3.3.4), ARIS assumes complete administration of the ARIS
databases. Every time a new ARIS database is required, ARIS creates
database objects (scheme, tables etc.) in which the contents of the
ARIS database are saved. ARIS also deletes database objects if an
ARIS database is to be deleted.

6.3.5.2 Manual Management


If you have not given ARIS the DBADM privilege (see chapter
6.3.3.4), ARIS cannot create or delete any DB2 database objects. In
this case, you must provide ARIS with a sufficient supply of empty
ARIS databases, i.e. DB2 schemes with DB2 database objects, and
indicate to the ARIS Business Server that these will be managed
manually (see chapter 6.3.4).

ARIS Administration 51
Database Systems

6.3.5.2.1 Notes on Manual Management


In manual management, the DB2 database administrator must ensure
there is always a sufficient supply of ARIS databases. Without this
supply, the ARIS user cannot create an ARIS database, even with the
ARIS DBADMIN privilege.

If an ARIS user deletes an ARIS database, it is no longer visible to that


user. However, it has not been definitively deleted: in theory, a
deleted ARIS database can be reactivated by "diverting" the entry from
the db_trash table to the dblist table.

As ARIS only connects to the ARIS62 user and this does not require
the DBADM privilege for the manual procedure, ARIS can get by with a
minimum of privileges.

The administration effort can be reduced by implementing a job in the


database that in turn automates the manual procedure.

6.3.5.2.2 Procedure for Manual Management


Fill supply of DB2 schemes

1. Connect to the DB2 database as a user with the DBADM privilege, e.g.
as user db2admin.

2. Execute the following procedure by entering the character string


"aris" for an ARIS database or "bo" for an ARIS Process Cost
Analyzer database as the first argument. In the following example,
"aris" is used:

CALL ARIS62.CREATE_A62_SCHEMA("aris", 23, 1,?,?)

This call causes exactly one scheme to be created for an ARIS


database with the ARIS scheme version 23. This scheme version refers
to ARIS version 6.2.x (see chapter 6.3.5.2.3).

The third parameter, the number 1 in the example, specifies the


number of ARIS databases that are to be created simultaneously. The
CALL ARIS62.CREATE_A62_SCHEMA("aris", 23, 7,?,?) call would
create seven DB2 schemes for ARIS version 6.2.x.

52 Administration ARIS
Database Systems

List used and unused DB2 schemes

1. To list all used and unused DB2 schemes, run the following SQL
statement:

SELECT * FROM ARIS62.db_stock

If you now create a new ARIS database in ARIS, ARIS uses the
db_stock table to check whether a suitable scheme is available. If so,
the entry is removed from the db_stock table and a new entry is
inserted in the dblist table.

2. To list all currently used DB2 schemes, run the following SQL
statement:

SELECT * FROM ARIS62.dblist

If you now delete an ARIS database in ARIS, the entry is removed


from the dblist table and inserted in the db_trash table. All schemes
that are no longer required and can be deleted by you are entered into
the db_trash table.

3. To list all DB2 schemes that are no longer needed, run the following
SQL statement:

SELECT * FROM ARIS62.db_trash

Delete DB2 schemes that are not needed

To delete all DB2 schemes listed in the db_trash table, execute the
following procedure:

CALL ARIS62. EMPTY_A62_TRASH(?,?)

ARIS Administration 53
Database Systems

6.3.5.2.3 ARIS Scheme Versions


To import ARIS databases into DB2 databases, you need an
appropriate scheme. The ARIS scheme versions are listed in the
following table:

ARIS version Database Scheme type Scheme version


type
ARIS 6.0.x ARIS "aris" 21
ARIS 6.1.x ARIS "aris" 22
ARIS 6.2.x ARIS "aris" 23
ARIS 6.2.x PCA "bo" 2

For example, if you want to restore a version 6.1.1 ADB file (backed up
ARIS database) to the DB2 database, transfer the ARIS scheme
version 22 to the procedure in the second argument:

CALL ARIS62.CREATE_A62_SCHEMA("aris", 22, 1,?,?)

54 Administration ARIS
Additional Information

7 Additional Information
This section provides information for example on backing up databases
or program timing.

7.1 Maintenance Work with an ARIS Client

Special Licensing Feature


To use an ARIS Client for maintenance tasks, you need a separate
license key. To purchase a key, please contact IDS Scheer Sales.

A maintenance license key may only be used for an ARIS Client with
which you perform maintenance tasks, automatic exports with ARIS
Web Publisher, or generate reports.

You are not permitted to perform modeling with this ARIS Client.

7.2 Automated Installation


With the following procedure, you can transfer a completed installation
to additional computers quickly and easily without any changes or
further user entries. This means that you will not have to repeatedly
make the same settings each time:

1. Run the installation program using the setup.exe -r command.

2. Make your settings and then close the installation. Using the -r
parameter creates the setup.iss file in your Windows directory.

3. Create a new directory on your hard disk and copy the files of the
installation program and all its subdirectories to this new directory.

4. Then copy the setup.iss file to the new directory as well, so that it is
in the same location as the setup.exe file.

5. Copy the newly created directory to all the computers on which you
want to carry out an identical installation.

6. Run the setup using the setup -s command.

For more information, please contact the IDS Scheer Customer


Inter@ction Center (see Chapter 12.1).

ARIS Administration 55
Additional Information

7.3 ARIS API: Continued Use of Programs from Earlier


ARIS Versions
If you have acquired ARIS API subsequently, your license key will have
to be adapted. You can only use ARIS API if your license key includes
the code ap. The service hotline (see chapter 12.1) will gladly provide
you with your license key or send it to you by e-mail. To adapt your
license key please give us your IDS order number (delivery note) and
your current license key. You will find your current license key in the
About (Help/About) dialog box.

Once you have entered the new license key you will be able to install
ARIS API.

ARIS API Programs of ARIS Version 5.x


You can continue to use programs that you created using ARIS API 5.x
by recompiling with the new header files (*.h) and libraries (*.lib).

To ensure undisrupted operation the applications (*.exe) created using


ARIS API should be located in the installation directory of ARIS 6.

To place ARIS API applications in different directories, the path to the


ARIS 6 installation directory must be added to the path variable.

The GUID_REP_COMPLIANCE_ATS mode (in ArisDatabaseMode)


will no longer be supported. From ARIS API 6 upward there is just one
format for representing GUID values. Representation of GUID is
identical with the representations you will find on the Maintained
Attributes properties page of ARIS Toolset.

The format for the filter keys that are used in the ArisConfigInit()
API function has been changed. The existing keys (e.g. FULLMETHOD
or EASYFILTER) are no longer recognized. Instead you will have to use
the new keys. The new keys are made up of the GUID of the desired
filter.

Example for initialization of the entire method:

ArisConfigInit( hDatabase,
"DD838074-AC29-11D4-85B8-00005A4053FF", &Error );

You can look up which GUID belongs to which configuration filter in the
ARIS Toolset Configuration Wizard.

56 Administration ARIS
Additional Information

7.4 ARIS Site Administrator


ARIS Site Administrator is installed automatically with the installation
of ARIS Toolset. If you use a single-user installation, ARIS Site
Administrator is started with the interface language you selected in the
ARIS Client. For example, if you specified interface language English
(USA) using ARIS Toolset, ARIS Site Administrator will also be
launched with English as the interface language.

7.5 ARIS Converter


ARIS Converter is automatically installed when ARIS Toolset is
installed. If you use a single-user installation, ARIS Converter is
started with the interface language you have selected in the ARIS
client. For example, if you have specified the interface language
English (USA) using ARIS Toolset, ARIS Converter will also be
launched with English as the interface language.

We recommend that for purposes of data conversion the ARIS Toolset


be installed on a separate computer together with ARIS Converter. This
will ensure rapid completion of the database conversion.

ARIS Converter is the program you use to convert data from ARIS 4.x,
ARIS 5.x and ARIS 6.x formats for work with ARIS 6 Collaborative
Suite, Version 6.2 irrespective of the server platform or the database
management system you are using. The 6.2 conversion enables you to
transfer your databases from one database system to another. For
example, if you have created a user database under Oracle for ARIS
6.2, you can use ARIS Converter to specify that this database is to be
transferred to your local ARIS Toolset with the standard database
system.

You can transfer ARIS Version 4.0 databases with ARIS Converter, but
you will need to use ACD files. ACD files (ACD = ARIS Compressed
Database) represent the file format in which ARIS databases of version
5.x are saved.

Databases of the ARIS Versions 4.11 and 5.0 can be converted using a
database directory or an ACD file (see table on page Fehler!
Textmarke nicht definiert.). If you transfer the databases using a
database directory, you can also convert the configuration data. If you

ARIS Administration 57
Additional Information

use ACD files it is not possible to transfer configuration data. On the


other hand, databases in ARIS versions 5.01 to 5.02 and 6.0x to 6.2
can also be converted directly from the corresponding server.

The only exception to this is ARIS 6.0.0. Before you can create a
connection between ARIS Converter and the ARIS 6.0 server, you must
replace a number of files in the lib directory of your ARIS 6.0.0
installation. These files are located in the Tools\ARIS 60 Converter
Patch directory on the ARIS CD.

The system requirements are listed in chapter 10.9.

If you have memory problems when converting large databases (see


serverout.log file in the <ARIS installation
directory>\LocalServer\log\directory), you can specify in the
arislauncher.cfg (<ARIS installation
directory>\LocalServer\config\directory) file that more memory is
to be allocated for database conversion. Increase the megabyte value
accordingly (shown in bold in the following example):

<Property name="Java Option 5" value="-Xmx128m"/>

A description of the conversion procedure is included in chapter 8.

7.6 Backing Up User and Configuration Databases


To backup all the contents of an ARIS database server, proceed as
follows:

1. Use ARIS Admintool to backup all user databases. Use the arisadm62
backup all <directory> command (see chapter 9.3.1). If you are
running ARIS Admintool in interactive mode (see chapter 9.1) enter
backup all <directory>.

2. If you are working with ARIS Process Cost Analyzer: Backup all PCA
databases using ARIS PCA Site Administrator (see chapter 3.5).
It is not possible to back up the PCA databases using the arisadm62
tool or a command line interface. If you want to run an automatic
scheduled backup of your PCA databases and you are using Oracle as
your database management system, you must do this with an Oracle
DUMP. On the other hand, if you are using the ARIS standard database
system, to preserve consistency the ARIS Server must be shut down
and the backup carried out on a file basis.

58 Administration ARIS
Additional Information

3. Back up the configuration data by copying the sysconfig directory for


the computer on which you have installed ARIS Site Manager to your
backup directory (see chapter ARIS Site Manager in the installation
guide).

It is also possible to backup user databases online. The ARIS System


Control and Administration training course provides includes
instruction on backup procedures and concepts. For information call
+49 - (0)681-210-1900.

7.7 Backing Up Current Configuration Files


Every time ARIS Business Server is launched, the configuration files
are backed up in the backup_sysconfig.zip file. This file is placed in
the sysconfig directory. You can open this file as required using an
extraction program and restore the files from the sysconfig directory.

7.8 Reset Database Administrator Password


Oracle Installation You can reset the password using an Oracle tool.

Standard Database System To reset the Database Administrator


password for the ARIS standard database system contact the IDS
Scheer Customer Inter@ction Center (see Chapter 12.1).

7.9 Server Log Directory


The activities of the ARIS Business Server are recorded in the log
directory of the server installation directory. If ARIS Business Server
does not work properly, please send a description of the problem and
all contents of the log and config directory to the IDS Scheer
Customer Inter@ction Center (see Chapter 12.1).

7.10 ARIS Metaframe


For more information on contact the IDS Scheer Customer
Inter@ction Center (see Chapter 12.1).

ARIS Administration 59
Transferring Data from Earlier Versions of ARIS

8 Transferring Data from Earlier Versions of ARIS


This chapter provides information on data transfer from databases of
version 4.0 and higher.

ARIS Version Source Data

4.0 Database in ACD format User database

4.11 ARIS database directory User databases with or without


configuration database

Database in ACD format User database

5.0 ARIS database directory User databases with or without


configuration database

Database in ACD format User database

5.01 or 5.02 ARIS Network server User databases with or without


configuration database
Local ARIS database system
(Local)

ARIS database directory

Database in ACD format User database

6.0x Database directory on a network User database with or without


server configuration database

Local ARIS database system


(Local)

6.1/6.2 Database directory on a network User database to be transferred


server from one database platform, e.g.
Oracle, to another platform, e.g.
Local ARIS database system
standard database system, with or
(Local)
without configuration database.

Figure 1: Overview of Database Conversion

What Data Will Be Transferred?

You can use data from version ARIS 4.0 and higher in ARIS 6
Collaborative Suite. Using ARIS Converter you can transfer user
databases. You can transfer configuration databases from version 4.11
and higher if the data are not present in ACD files, but in an ARIS
database directory. An ARIS database directory is a directory of an
ARIS installation of the versions 4.11 or 5.x, containing respectively an

60 Administration ARIS
Transferring Data from Earlier Versions of ARIS

active ARIS database. The directory and the database have the same
name. It contains the files objects.dat and objects.idx.

To transfer individual items of the configuration database, proceed as


described in chapter 8.2.2.

8.1 User Databases


User databases contain for example the structure and procedural
organization of your company. All the contents of user databases may
be transferred using ARIS Converter. For information on ARIS
Converter see chapter 7.4.

8.1.1 How to Transfer User Databases


1. Create a backup copy of your databases. The data to be transferred
may be available in the following forms:

Within an ARIS installation (locally or on the network)

In a data folder

As an ACD file (backup file for ARIS versions prior to ARIS 6)

2. Click on Start/Programs/ARIS 6.2/ARIS Converter. The


Converter Wizard will be run.

3. Select the ARIS Server on which the converted database is to be


saved. To add a server to the list, click on Add. Enter the name of the
server and click on OK.

4. Click on Next.

5. Select the option button of the ARIS version to be used as source for
conversion.

6. Click on Next.

7. Select the source where the ARIS user database is located which you
want to transfer to your new ARIS installation. Depending on the
choice you made above you will now have one or more of the following
options:

ARIS Administration 61
Transferring Data from Earlier Versions of ARIS

ARIS Network Server

Select an ARIS server in the Network server field. To add a server to


the list, click on Add. Enter the name of the server and click on OK.

Local system

Local database directory: Activate the Local option button.

To convert version 6.0 or 6.01 databases locally, (LOCAL


server), you will have to launch ARIS 6.0 or 6.01 before starting
ARIS Converter and ensure that the LOCAL server has been
started. To start, click on LOCAL in the tree view in ARIS
Explorer.

ARIS database directory:

Activate the Database directory option button.

Enter the path name of the database directory. To search for the
directory, click on the Browse (...) button. The path name must not
contain any special characters.

Database in ACD format:

Please note that when converting databases available in ACD format,


it is impossible to convert configuration databases. This also means
that user-defined symbols will be replaced by ARIS default symbols.
Therefore, we recommend that you use the Database directory
option.

Activate the ACD File option button.

Enter the path and file name. To search for the file, click on the
Browse (...) button. The path name must not contain any special
characters.

If you are converting a database in ACD format, continue from step


15.

8. Click on Next.

9. Select the ARIS user database you wish to transfer.

10. Click on Next.

62 Administration ARIS
Transferring Data from Earlier Versions of ARIS

11. To also transfer the configuration database items, keep the settings,
i.e. all check boxes will be enabled. This will have the following effects:

Items and method extensions in the configuration database on the


source server will be transferred, if they do not exist on the target
server.

Items as well as user-defined symbols of the configuration database


that already exist on the target server will be overwritten by items and
user-defined symbols having an identical GUID.

Names of user-defined symbols, free attributes and units of free


attributes that already exist in a certain language in the configuration
database on the target server will be overwritten.

Assignments of attributes to attribute type groups that already exist in


the configuration database on the target server will be overwritten.

Items and method extensions in the configuration database on the


target server remain unchanged if they do not exist on the source
server.
User-defined symbols will always be transferred. You cannot clear this
check box.

12. Click on Next.

13. Enter the password for the database administrator and the configuration
database of the source server.

14. Click on Next.

15. Enter the password for the database administrator and the configuration
database of the target server.

16. Click on Next.

17. You will see all of the settings that you made in the wizard. Click on
Finish to begin transferring the data. The converted database will now
be saved. If the name already exists, a number will be appended to it.
During data transfer you will receive information in a dialog box. To
cancel the data transfer click on Cancel.

18. During the transfer of databases in ACD format, versions 4x and 5.0

the format of certain attributes will be converted from Text to Date.


Select the date format you would like to use for those attributes. The
attribute values (date information) can only be updated to the new

ARIS Administration 63
Transferring Data from Earlier Versions of ARIS

format correctly if they are composed exclusively of numeric


characters. Other entries will be deleted.

certain language-dependent attributes will be changed to language-


independent attributes. Select the database language whose attribute
values you would like to use for those attributes.

19. Once the data transfer has been completed successfully, click on OK.
ARIS Converter will close.

8.2 Configuration Databases


Configuration databases contain method and evaluation filters,
templates, font formats and chart definitions. The contents of the
configuration database are available to all user databases on a given
server. You can transfer individual elements of your configuration
databases.

8.2.1 How to Transfer Item Groups from Configuration


Databases
You can use ARIS Converter to transfer any or all item groups such as
filters or model templates, from the ARIS 4.11 configuration database
to ARIS 6.2.

The procedure description and the Select Configuration Database


Wizard page of the online help for ARIS Converter include instructions
for selecting individual item groups.

When you transfer item groups with ARIS Converter, the reference to
the respective database will not be affected. In other words, the
assignment of user-defined symbols to objects in the databases will
still be available.

64 Administration ARIS
Transferring Data from Earlier Versions of ARIS

8.2.2 How to Transfer Individual Items of Configuration


Databases
To transfer individual items of the configuration database from an
installation in ARIS 5.01 and higher, you must first export all filters,
templates and chart definitions with which you want to work in ARIS 6
- Collaborative Suite, version 6.2. Then you can import them into ARIS
6. Proceed as follows:

1. Run the ARIS version from which you want to export data.

2. Open ARIS Explorer.

3. One after the other, export all the filters, templates and chart
definitions with which you wish to work in ARIS 6. To do this, click on
the plus sign (+) in the tree view next to the server from whose
configuration database you wish to export the filter, template or chart
definition.

4. Activate the Filter, Template or Chart Definition tab in the detail


view.

5. Right click on a filter, template or chart definition and select Export.

If you are exporting filters you must select Export (XML). You can
only import into ARIS 6 filters that you have exported using this export
format.

6. If you have identified yourself as the configuration administrator, a


dialog box will open in which you can indicate the name and location
you want for the export file.

7. Click on Save to launch the export.

The exported items of the configuration database may now be easily


imported into ARIS 6. Proceed as follows:

1. Run ARIS 6.

2. Open ARIS Explorer.

3. Click on the plus sign (+) in the tree view next to the server into
whose configuration database you wish to import the filter, template or
chart definition.

4. In the tree view right click on the configuration database and select
Import/Filter, Import/Template or Import/Chart Definition.

ARIS Administration 65
Transferring Data from Earlier Versions of ARIS

5. If you have identified yourself as the Configuration Administrator, a


dialog box will open in which you can specify the import file.

6. Select the import file and click on Open. The file will be imported.

8.2.3 How to Transfer Exported Filters, Templates and


Chart Definitions
All filters, templates and chart definitions that you have exported from
ARIS 5.01 or higher in XML format (ACC, AMC and ATC files) can be
transferred without difficulty.

Filters that you exported with Export (Classic) cannot be imported.

Proceed as follows:

1. Run ARIS 6.

2. Open ARIS Explorer.

3. Click on the plus sign (+) in the tree view next to the server into
whose configuration database you wish to import the filter, template or
chart definition.

4. In the tree view right click on the configuration database and select
Import/Filter, Import/Template or Import/Chart Definition.

5. If you have identified yourself as the Configuration Administrator, a


dialog box will open in which you can specify the import file.

6. Select the import file and click on Open. The file will be imported.

8.3 How to Transfer User-Generated or Modified Scripts


from Earlier ARIS Versions
User-generated or modified scripts that you have generated in earlier
ARIS versions and want to use for work with the current ARIS version
can be transferred using ARIS Script Converter.

Proceed as follows:

1. Copy the scripts into the script directories of ARIS 6 <installation


directory>\script\ ....

2. Run ARIS Script Converter (Start/Programs/ARIS


6.2/Administration/ARIS Script Converter).

66 Administration ARIS
Transferring Data from Earlier Versions of ARIS

3. Click on Select Scripts. You will see a dialog box in which you can
select all the scripts you wish to update.

4. Click on OK when you have selected all of the scripts. You will see a
list of all of the scripts with path details.

5. To add more scripts from different directories to the list, repeat steps 3
and 4 until you have added all the scripts to the list.

6. Click on Convert. ARIS Script Converter will now update all the listed
scripts. This procedure may take a moment. A status bar will be
displayed in the lower portion of the dialog box.

7. When the update is complete, you will receive a message to that


effect.

If not all of the scripts have been updated, you will be advised of
the scripts in question and the reason why ARIS Script Converter
did not update them. Read-only scripts cannot be updated, for
instance. Scripts that were not updated will remain on the list.

8. When you have updated all of the scripts, click on Exit.

8.4 How to Transfer User-Generated Semantic Checks


fromEarlier ARIS Versions
You can still use Semantic Checks from earlier ARIS versions in the
current ARIS version.

To make semantic checks available in the ARIS Semantic Check


component in the current ARIS version:

1. Copy the configuration files and the semantic check scripts to the
corresponding semantic check directory of the newly installed ARIS
version.

2. Update these scripts using ARIS Script Converter (see chapter 8.3).

ARIS Administration 67
Transferring Data from Earlier Versions of ARIS

8.5 ASCII and Excel Exports

Text export
ARIS 4.x text exports cannot be imported into ARIS 6.

Excel Exports (ABC)


ARIS 4.x Excel exports (Excel 95 and higher) can be imported into
ARIS 6.

68 Administration ARIS
ARIS Admintool

9 ARIS Admintool
You can use ARIS Admintool to manage the ARIS databases on a
server. The program is a console application (MS DOS program) and is
executed in the MS DOS input window. The individual commands of
the program are supplied as command line parameters. The program
gives you information about the success and effect of each executed
command.

ARIS databases should never be edited using Windows Explorer. In


particular, renaming database folders or copying files can cause the
program not to function properly.

9.1 How to Launch ARIS Admintool


Under these conditions you can run ARIS Admintool from any client
computer and have access to the ARIS databases on the server:

Click on Start/Programs/ARIS 6.2/Administration/ARIS


Admintool. The MS DOS input window will open and ARIS Admintool
will be launched in interactive mode.

9.2 Valuable Information


A command line in ARIS Admintool has the following syntax:

Arisadm62 [<option>] <command> [<command argument 1>]


.......

The following options can be used in ARIS Admintool:

Option Description

-s <server name> Specifies the server on which the command is to be performed. In


interactive mode, the server can be changed with the server
command.

-p <password> Specifies the Database Administrators password for the specified


server. If the password is not correct, the program will prompt you
to enter the correct password before the selected command can be
performed. The default password is DBADMIN (uppercase).

ARIS Administration 69
ARIS Admintool

Option Description

-pc <password> Specifies the Configuration Administrators password for the


specified server. If the password is not correct, the program will
prompt you to enter the correct password before the selected
command can be performed. The default password is CFGADMIN
(uppercase).

-l <file name> Activates logging of all program operations. The log file will indicate
when which operation was performed and with what result.

When working with ARIS Admintool, take note of the following:

If you do not enter a server name (-s), the function will be executed
on the LOCAL server.

If you are working with ARIS Admintool directly on the server


computer, please use the -s localhost parameter.

If you have not entered a password, you will be prompted to supply


the Database Administrator password before each command is
executed.

System messages in ARIS Admintool are always output in the ARIS


installation language on the server side.

9.3 ARIS Admintool Commands


All of the program commands in the following are listed in the syntax of
interactive mode (Start/Programs/ARIS
6.2/Administration/ARIS Admintool). When you are not in
interactive mode, the command must be preceded by arisadm62 and
a space.

If parameters include spaces you must enclose the parameter in


quotation marks.

Example: You wish to recreate the Sales Data database under the
name Sales Data 2002. In interactive mode, enter the following:

copy Sales Data "Sales Data 2002"

70 Administration ARIS
ARIS Admintool

9.3.1 Backup
Backs up a database as a compressed file with the .ADB (ARIS
database) file extension to a folder of your choice.

ARIS databases contain, for example, your company's organizational


structure and business processes. The contents of these databases are
subject to constant development. Every time a user opens a database
and, for example, adds to a model, important information is added. To
avoid the risk of losing this data, you should backup your user
databases every day.

To backup a database as an ADB file, enter the following command call


and then press Enter:

backup <database name> <backup directory>

The name of the backup file consists of the name of the database
followed by the .ADB file extension.

If a file of the same name already exists in the backup directory, it will
be overwritten.

To backup all databases on a server as ADB files, enter the following


command call and press Enter:

backup all <directory>

When you are not in interactive mode, the command must be preceded
by arisadm62 and a space.

With the Restore command, databases that have been backed up as


ADB files on a server can be imported and registered.

9.3.1.1 Example
The Project database to be backed up is located on the LOCAL
server. The Database Administrator's password is DBADMIN. The
backup file is to be saved to the Backup folder on a diskette.

Proceed as follows:

1. Run ARIS Admintool (Start/Programs/ARIS


6.2/Administration/ARIS Admintool). ARIS Admintool is launched
directly in interactive mode and you can enter the desired command.

ARIS Administration 71
ARIS Admintool

2. Enter the following command line and press Enter:

backup project e:\backup

3. If you have identified yourself as the Database Administrator, the


command will now be executed.

9.3.1.2 Data Backup Using a Batch Program (Batch File)


If you want to carry out an automatic data save at a particular time
every day, ARIS provides support with the backup.cmd batch
program on the ARIS CD. You can run this program regularly using
scheduling software, for example the JIT Scheduler 4.11 (freeware)
scheduling program provided on the ARIS CD.

To perform time-controlled data backups, copy the file backup.cmd


from the tools\scheduler directory on the CD to the installation
directory in which ARIS Admintool (arisadm62.exe) is located. Then
use the time control software to specify the times at which the data
backup is to be performed. All logged databases will be backed up at
the time indicated to the directory you specified previously in the
backup.cmd file.

9.3.2 Backupconfig
Savesthe ARIS configuration data (filters, templates and charts) to the
specified directory in the appropriate file format (see chapter 8.2.3).

To save the ARIS configuration data, enter the following command call
and then press Enter:

backupconfig <backup directory> <file name>

To restore configuration files, use the Restoreconfig command (see


chapter 9.3.16).

72 Administration ARIS
ARIS Admintool

9.3.3 Copy
Copies databases to a server and registers them there.

To copy a database, enter the following command call and then press
Enter:

copy <source database name> <target database name>

When you are not in interactive mode, the command must be preceded
by arisadm62 and a space.

Optionally, you can separately specify a server to which you want to


copy the database by using a colon.

In batch mode, you can also specify the Database Administrator


password:

copy <source database name> <target database name>


[:<server>] [<password>]

Database names must be unique. If a database already exists with the


name specified in the second parameter, the database cannot be
copied.

Example
The SalesDB database is to be duplicated on the LOCAL server. The
Database Administrator's password is DBADMIN. The copy of the
database is to have the name New SalesDB.

Proceed as follows:

1. Run ARIS Admintool (Start/Programs/ARIS


6.2/Administration/ARIS Admintool). ARIS Admintool is launched
directly in interactive mode and you can enter the desired command.

2. Enter the following command line and press Enter:

copy SalesDB "New SalesDB"

3. If you have identified yourself as the Database Administrator, the


command will now be executed.

ARIS Administration 73
ARIS Admintool

9.3.4 Dbmspassword
Changes the password for the DBMS user. This change is helpful if the
DBMS (database management system) used is also used by
applications other than ARIS. This may be the case with the Oracle
DBMS. The Oracle DBMS user is called ARIS62. The default password
is arisadmin (lowercase).

To change the passwrod for the DBMS user:

dbmspassword

You are then asked for the current and the new passwords. You are
also asked for the database administrator password (uppercase
DBADMIN by default) if you have not had to enter it until now.

When you are not in interactive mode, the command must be preceded
by arisadm62 and a space. You can then add both the new and the
old password , e.g. arisadm62 dbmspassword <password>
<oldpassword>.

9.3.5 Delete
Removes a database from the database server and deregisters it.

A database can only be deleted when no users are logged in.

To delete a database from the selected database server, enter the


following command call and press Enter:

delete <database name>

When you are not in interactive mode, the command must be preceded
by arisadm62 and a space.

9.3.6 Exit
Exits the interactive mode and ARIS Admintool. The Exit command
can only be executed in interactive mode.

To exit interactive mode and the program, enter the following


command call and then press Enter:

exit

74 Administration ARIS
ARIS Admintool

9.3.7 Help
Displays a help text for every available command. This describes the
actions that will be performed as a consequence of the command, as
well as the parameters that must be entered with the command.

To call help for a specific command, enter the following command call
and then press Enter:

help <command>

To see an overview of help, enter the following command call and


press Enter:

help more

When you are not in interactive mode, the command must be preceded
by arisadm62 and a space.

9.3.8 Interactive
Switches ARIS Admintool to a mode in which you can enter several
commands in a prompt sequence without having to exit the program.
To do this, you only have to log on to each server once.

To enter a sequence of commands within the program, enter the


following command call and then press Enter:

interactive

9.3.9 Kill
Terminates all connections of a user to databases on the selected
database server. This connection is identified by the connection ID that
you can display using the Sessions command.

All users whose connection to databases on the specified server was


terminated with the Kill function cannot properly exit ARIS. Changes
that have not been saved are lost and must be made again after ARIS
is relaunched.

To terminate a user's connection to databases on the specified server,


enter the following command call and press Enter:

kill <session ID>

ARIS Administration 75
ARIS Admintool

To cut all users' connections to databases on the specified server,


enter the following command call and press Enter:

kill <all>

When you are not in interactive mode, the command must be preceded
by arisadm62 and a space.

9.3.10 List
Displays all databases that are registered on a database server and
can be opened by ARIS.

To display all the databases that can be opened by ARIS, type in the
following function call and then press Enter:

list

When you are not in interactive mode, the command must be preceded
by arisadm62 and a space.

9.3.11 Maintain
Runs maintenance of the specified database. Maintenance is database
system-specific, which means that a set number of maintenance tasks
is performed depending on the database. Refer to your database
management system documentation for information regarding specific
maintenance tasks.

To perform maintenance on a database, enter the following command


call and then press Enter:

maintain <database name>

When you are not in interactive mode, the command must be preceded
by arisadm62 and a space.

76 Administration ARIS
ARIS Admintool

9.3.12 Password
Changes the database administrator password for the specified server.
First, the current password must be entered.

To change the password for the Database Administrator, enter the


following command call and then press Enter:

password <new password>

When you are not in interactive mode, the command must be preceded
by arisadm62 and a space.

9.3.13 Rename
Renames a database.

To rename a database, enter the following command call and then


press Enter:

rename <old database name> <new database name>

When you are not in interactive mode, the command must be preceded
by arisadm62 and a space.

9.3.14 Reorg
Reorganizes a database.

ARIS searches the database for object and connection definitions of


which there are no longer any occurrences in models. These are then
deleted.

If you are using an object library, you should not activate this option
since it may be desired and intended for certain definitions to be
created that have no occurrences.

A reorganization can only be performed if no users are logged into the


database.

Objects that are referenced by tables of the ARIS ABC component are
ignored for purposes of the reorganization. To reorganize a database,
enter the following command call and then press Enter:

ARIS Administration 77
ARIS Admintool

reorg <database name> delete

To reorganize all databases, enter the following command call and


then press Enter:

reorg all <delete>

When you are not in interactive mode, the command must be preceded
by arisadm62 and a space.

9.3.15 Restore
Imports databases that have been saved as ADB files onto the current
database server and registers them there.

A database that has the same name as the one to be imported may
not exist in the database directory. You are therefore given the
opportunity to rename the database when importing.

To import an ADB file to a server and register it there, enter the


following command call and then press Enter:

restore <backup file>

The <backup file> command parameter consists of the absolute path


to the folder in which the backup file is located, and the name of the
backup file.

To import an ADB file and rename it at the same time, enter the
following command and then press Enter:

restore <backup file> <new name>

When you are not in interactive mode, the command must be preceded
by arisadm62 and a space.

Example
The Project database is to be restored and registered on the LOCAL
server. The Database Administrator's password is DBADMIN. The
project.adb file is located in the restore directory on a diskette.

Proceed as follows:

1. Run ARIS Admintool (Start/Programs/ARIS


6.2/Administration/ARIS Admintool). ARIS Admintool is launched
directly in interactive mode and you can enter the desired command.

78 Administration ARIS
ARIS Admintool

2. Enter the following command line and press Enter:

restore a:\restore\project

3. If you have identified yourself as the Database Administrator, the


command will be executed.

9.3.16 Restoreconfig
Restores the ARIS configuration data (filters, templates and charts)
from an ACB file.

To restore the ARIS configuration data, enter the following command


call and then press Enter:

restoreconfig <path\file name>

To backup ACB files, use the Backupconfig command (see chapter


9.3.2).

When you are not in interactive mode, the command must be preceded
by arisadm62 and a space.

9.3.17 Scheme Context


Changes the view area for databases. The default scheme context is
aris.

To access ARIS Process Cost Analyzer databases (see chapter 3), enter
the following command call and then press the Enter key:

schemecontext pca

If you now use the commands List (see chapter 9.3.10) or Backup
(see chapter 9.3.1), they refer exclusively to PCA databases.

When not in interactive mode, you can enter arisadm62 -sc


<scheme> as a command line command, e.g. arisadm62 -sc pca.

ARIS Administration 79
ARIS Admintool

9.3.18 Server
Can only be executed in interactive mode. This terminates the current
connection to the server and permits the establishment of a new
connection with another server. All commands that are entered
thereafter relate to the new server.

To terminate the current server connection and create a new one,


enter the following command call and then press Enter:

server <server> [<password>]

You can also enter the Database Administrator password here,


otherwise, it will be requested later.

When you are not in interactive mode, the command must be preceded
by arisadm62 and a space.

9.3.19 Sessions
Displays all users who are logged in to a database on the specified
server.

The following information will be displayed:

The TCP/IP host name of the computer via which the particular user
has logged in to the database

User name

Connection ID

Name of the application that established the connection

The value displayed for the user name will be the one specified in the
Username environmental variable of the computer from which the
user logged in to the database. Under Windows NT this value is set
automatically during login.

The information displayed can be sorted by user name or database


name.

You have the following options for displaying information about all
current users of databases on the listed server.

Users sorted by user name:

session byuser

80 Administration ARIS
ARIS Admintool

Users sorted by database name:

session bydatabase

When you are not in interactive mode, the command must be preceded
by arisadm62 and a space.

9.3.20 Statistic
Displays the following information for the evaluated database:

All models

All users

All font formats

To display this information, enter the following command and then


press Enter:

statistic <database name>

To obtain more detailed information, enter the following command and


then press Enter:

statistic <database name> detail

When you are not in interactive mode, the command must be preceded
by arisadm62 and a space.

9.3.21 Status
Displays the status of a client-server connection.

To display the status of a client-server connection, enter the following


command and press Enter:

status <server>

When you are not in interactive mode, the command must be preceded
by arisadm62 and a space.

ARIS Administration 81
ARIS Admintool

9.3.22 Version
Issues the version numbers for all Dynamic Link Libraries (DLLs) used
by ARIS. These are the DLLs of the system in which ARIS Admintool
was launched.

To display version numbers, enter the following command and then


press Enter:

version

When you are not in interactive mode, the command must be preceded
by arisadm62 and a space.

82 Administration ARIS
Hardware and Software Requirements

10 Hardware and Software Requirements


This section describes the processor, memory, system configuration
and software requirements the various server and client computers
must meet for ARIS. The requirements given here have been tested
and approved. To use other applications at the same time, you may
need a faster processor, additional memory or a different, upgraded
system.

Higher versions are neither tested nor approved.

ARIS 6 Collaborative Suite requires an operative TCP/IP structure.

Knowing how the system is going to be used is essential to determining


an optimal technical configuration.

For specific cases, please contact the IDS Scheer Customer Inter@ction
Center (see chapter 12.1).

Despite the release of the software on the operating system versions


listed and other software and hardware requirements, we cannot
guarantee that problems will not arise due to unpredictable
compatibility issues on certain hardware/software constellations.

This applies, for example, to the use of certain printers/drivers or


graphic cards/drivers under certain operating system versions. In
individual cases, this may result in problems in displaying graphics in
ARIS, in producing reports, in other Office applications or in Web
Publisher exports. When a dongle is used as copy protection in
software programs, the performance of the parallel interface may lead
to delays or even faults arising.

10.1 Database Server


This section describes the hardware and software requirements that
must be in place in order to set up the ARIS Database Server with a
database other than the standard database system.

Please take note of the releases of the respective database


manufacturer generally, as it may be that only a specific patch level of
a database is released for the server you are using.

ARIS Administration 83
Hardware and Software Requirements

10.1.1 Oracle Database


If you are installing Oracle yourself, always follow the installation
instructions in the Oracle 8.1.7 Enterprise Edition or 9i Standard or
Enterprise Edition installation guides.

10.1.2 Microsoft SQL Server


If you are installing Microsoft SQL Server yourself, always follow the
installation instructions in the Microsoft SQL Server installation guide.

10.1.3 IBM DB2


If you are installing IBM DB2 yourself, always follow the installation
instructions given in the IBM DB2 installation guide.

10.1.3.1 Hardware Requirements


Minimum System Requirements

Processor: Pentium II 233 MHz, 256 MB RAM (for Windows 2000 +


32 MB RAM)

1GB free hard disk space + an additional 30 MB on the system drive

Recommended System Requirements

The processor requirements depend on the number of users and the


size of the database. If in doubt please contact the IDS Scheer
Customer Inter@ction Center (see chapter 12.1).

1GB free hard disk space + an additional 30 MB on the system drive

Graphics Card

At least SVGA

Network

100 Mbit network between database server and ARIS Business Server

84 Administration ARIS
Hardware and Software Requirements

10.1.3.2 Software Requirements


Operating System

Windows NT 4.0 Server + Service Pack 6a

Windows 2000 Server + Service Pack 2, Service Pack 3 or Service Pack


4

Windows 2003 Server Standard Edition. However, this release is


not valid for 64-bit Itanium processors. If you want to output
reports with Microsoft Word or Microsoft Excel, Office XP must be
installed because previous versions are incompatible with Windows
2003 server.

HP UX 11.11

Sun Solaris 8 (5.8) upon request (Customer Inter@ction Center, see


Chapter 12.1)

Network Communication

TCP/IP

ARIS Administration 85
Hardware and Software Requirements

10.2 ARIS Default Server (ARIS Business Server)


This section describes the hardware and software requirements for
ARIS Business Server.

The default server includes:

ARIS Business Server

ARIS Site Manager

Standard database system

ARIS Converter

ARIS Web Report Server

10.2.1 Hardware Requirements


Minimum System Requirements

Processor: Intel Pentium III 450 MHz, 256 MB RAM (for Windows 2000
+ 32 MB RAM)

Recommended System Requirements

The processor requirements depend on the number of users and the


size of the database (512 MB RAM for 50 users).
If you are using ARIS Web Report Server, you will need an additional
20 MB RAM for each simultaneously created report.
If you are using ARIS Converter, you will need an additional 256 MB
RAM and 512 MB hard disk space for converting an SAP reference
model database, for example.
If in doubt please contact the IDS Scheer Customer Inter@ction Center
(see chapter 12.1).

Graphics Card

Minimum: SVGA

Recommended: Screen resolution: 1024 x 768, at least 256 colors

Network

High-speed network (100Mbit) between database server and ARIS


Business Server.

86 Administration ARIS
Hardware and Software Requirements

10.2.2 Software Requirements


Operating System

Windows NT 4.0 Server + Service Pack 6a

Windows 2000 Server + Service Pack 2, Service Pack 3 or Service Pack


4

Windows 2003 Server Standard Edition. However, this release is


not valid for 64-bit Itanium processors. If you want to output
reports with Microsoft Word or Microsoft Excel, Office XP must be
installed because previous versions are incompatible with Windows
2003 server.

HP UX 11.11
To carry out mySAP Synchronization with SAP Solution Manager, JRE
1.4.1 32 bit version and SAP Java Connector (JCo) version 2.11 must
be installed.

Sun Solaris 8 (5.8) upon request (Customer Inter@ction Center, see


chapter 12.1)
To carry out mySAP Synchronization with SAP Solution Manager, JRE
1.4.1 32 bit version and SAP Java Connector (JCo) version 2.11 must
be installed.

If you are using ARIS Web Report Server, you will have to have
installed Microsoft Office so that the DOC and XLS output formats can
be generated.
If you intend to convert databases, all applications whose COM objects
you are using in ARIS databases must also be installed. When
converting databases that contain links to Microsoft Word and
Microsoft Excel documents, Microsoft Word and Microsoft Excel Version
97 or higher must be installed.

Network Communication

TCP/IP

ARIS Administration 87
Hardware and Software Requirements

10.3 Client Installations


This section describes the hardware and software requirements for
client installations. This information also applies to ARIS Toolset/ARIS
Easy Design, ARIS Web Designer, UML Designer and ARIS Process Cost
Analyzer.

10.3.1 Hardware Requirements


Minimum System Requirements

Processor: Intel Pentium II 233 MHz, 64 MB RAM (for Windows 2000


and Windows XP Professional + 32 MB RAM)

375 MB free hard disk space

Recommended System Requirements

Processor: Intel Pentium III 450 MHz, 128 MB RAM (for Windows 2000
and Windows XP Professional + 32 MB RAM)

Graphics Card

Minimum: SVGA, screen resolution: 800 x 600; 256 colors

Recommended: Screen resolution: 1024 x 768, at least 256 colors

10.3.2 Software Requirements


Operating System

Windows XP Professional, Windows XP Professional + SP1 or Windows


XP Professional + SP 1a

If you run Norton AntiVirus under Windows XP, you will not be
able to display or insert embedded WinWord documents in
opened models.

Windows NT 4.0 + Service Pack 6a

Windows 2000 + Service Pack 2, Service Pack 3 or Service Pack 4

Network Communication

TCP/IP

88 Administration ARIS
Hardware and Software Requirements

10.4 Client Installations (Single-User Installation)


This section describes the hardware and software requirements for
single-user installation.

This information also applies to ARIS Toolset/ARIS Easy Design, ARIS


Web Designer, UML Designer and ARIS Process Cost Analyzer.

10.4.1 Hardware Requirements


Minimum System Requirements

Processor: Intel Pentium II 233 MHz, 128 MB RAM (for Windows 2000
and Windows XP Professional + 32 MB RAM)

375 MB free hard disk space + sufficient space for all user databases
(e.g. an SAP reference model database requires 450 MB)

Recommended System Requirements

Processor: Intel Pentium III 450 MHz, 256 MB RAM (for Windows 2000
and Windows XP Professional + 32 MB RAM)

Graphics Card

Minimum: SVGA, screen resolution: 800 x 600; 256 colors

Recommended: Screen resolution: 1024 x 768, at least 256 colors

10.4.2 Software Requirements


Operating System

Windows XP Professional, Windows XP Professional + SP1 or Windows


XP Professional + SP 1a

If you run Norton AntiVirus under Windows XP, you will not be
able to display or insert embedded WinWord documents in
opened models.

Windows NT 4.0 + Service Pack 6a

Windows 2000 + Service Pack 2, Service Pack 3 or Service Pack 4

Network Communication

TCP/IP

ARIS Administration 89
Hardware and Software Requirements

10.5 Special Requirements


ARIS Simulation

Besides ARIS Toolset system requirements, for ARIS Simulation you


will also need:

Main memory:
128 MB RAM (in addition to the 128 MB RAM recommended for ARIS
Toolset) When using ARIS under Windows 2000 or Windows XP
Professional, the minimum system requirement is 160 MB RAM)

ARIS Web Publisher

System Requirements for Computers Used to Create Web


Publisher Exports

Besides the ARIS Toolset system requirements, for ARIS Web Publisher
you will also need:

Main memory:
128 MB RAM (in addition to the 128 MB RAM recommended for ARIS
Toolset) When using ARIS under Windows 2000 or Windows XP
Professional, the minimum system requirement is 160 MB RAM)

Hard disk space:


120 MB free hard disk space (for exports to the local hard disk). In
general, the hard disk space required depends on the volume of the
export data in each case.

File system:
Recommended: NTFS. NTFS is necessary for larger exports (large
number of files).

Screen resolution:
640 x 480 (SVGA), 256 colors. Recommended: 1024 x 768, at least
256 colors

Platform:
Web Publisher exports are platform-independent. Certain system add-
ons require Microsoft Windows, e.g. ARIS mySAP Connectivity for ARIS
Web Publisher and Connectivity for Lotus Notes.

90 Administration ARIS
Hardware and Software Requirements

Intranet publishing:
If you are sharing your Web Publisher exports on the intranet, we
recommend publishing the files on a WWW server, not on a file server.

System Requirements for Computers Used to Display Web


Publisher Exports

System font:
Small fonts

Processor:
Intel Pentium 166 MHz, 128 MB RAM

Screen resolution:
Recommended: 1024 x 768, minimum 256 colors

Browser:
Microsoft Internet Explorer, version 4.01 or higher + Service Pack 1,
5.01 + Service Pack 2, 5.5 + Service Pack 2 or 6.0 + Service Pack 1.
Exception: Version 5.0, which may cause graphics to be displayed
incorrectly.
Netscape Navigator, version 4.01 or higher, version 4.73 + Crypto API
2.0.

Versions released after this manual has been sent to press may not
have been approved by IDS Scheer, but they can probably be used.

Java Virtual Machine (JVM):


Version 1.1.4 for Internet Explorer or Netscape Navigator (generally
included in the browser) for Java GIF and Java JPG export types with
user-defined tree view.
If the installed Web browser does not include JVM 1.1.4 or higher, e.g.
Internet Explorer Version 6.0 under Windows XP, it must be installed
later.

Java Runtime Environment (JRE):


1.3.1_03 (international) , 1.3.1_06 (international) and 1.4.2
(international) for Internet Explorer or Netscape Navigator for the
Java WMF with Complete Tree View export type.
You do not need JRE for the following export types:

Java GIF/JPG exports with user-defined tree view

HTML export with user-defined tree view

ARIS Administration 91
Hardware and Software Requirements

WWW Server (for Role-Based Access to Web Exports)

Microsoft Internet Information Server 4.0 or 5.0 with active


component, either ASP or PERL

Apache Web Server 1.3.6 and Apache HTTP Server 2.0 under Windows
with active component, either ASP or PERL. TCP/IP network
communication

WWW Server (without Role-Based Access to Web Exports)

You can use any Web server, since no active components are required.
The Web servers listed under WWW Server (for Role-Based Access to
Web Exports) have been tested.

For information on specific features and the compatibility of different


software combinations go to:
www.ids-scheer.com/support.

ARIS mySAP Connectivity for ARIS Web Publisher

SAP GUI3.0f to SAPGUI 6.20

If you work with SAPGUI 4.6, the librfc.dll file must be deleted from
the C:\Program Files\ARIS6.2\Web Publisher directory and the
ARIS installation directory.

ARIS Lotus Notes Connectivity for ARIS Web Publisher, ARIS


Lotus Notes Connectivity

Lotus Notes version 4.5 and higher

ARIS Merge, ARIS Report, ARIS Analysis, ARIS Semantic Check,


ARIS Web Publisher, XML Export and Import

If, besides these components, you want to use

OLE Automation and/or

time-controlled software (ARIS CD\Tools),

Windows Scripting Host (ARIS CD\Tools|win_up\WSH) must be


installed on your computer.

92 Administration ARIS
Hardware and Software Requirements

If you are using Windows 2000, XP or 2003 with Internet Explorer


version 6.0 or later, you do not need to install Windows Scripting Host
separately. It is already included in these operating systems.

ARIS Process Generator

Office 97 [MS Excel 97 (Service Pack 2), MS Excel 2000 with 7 MB free
disk space in the <temp> directory], Office 2000, Office XP or Office
2003.

ARIS Report

Office 97, Office 2000, Office XP or Office 2003. If you output reports
in the Office 2003 Word DOC format, presentation errors may occur.

PCA Reports

Office 97, Office 2000 or Office XP.

10.6 ARIS Web Designer


This section describes the hardware and software requirements for
ARIS Web Designer.

10.6.1 Hardware Requirements


Minimum System Requirements

Processor: Intel Pentium 166 MHz, 64 MB RAM (for Windows 2000 or


Windows XP Professional + 32 MB RAM)

20 MB free hard disk space

Recommended System Requirements

Processor: Intel Pentium II 450 MHz, 128 MB RAM (for Windows 2000
or Windows XP Professional + 32 MB RAM), 128 MB Swap File

Graphics Card

Minimum: SVGA, screen resolution: 800 x 600; 256 colors

Recommended: Screen resolution: 1024 x 768, at least 256 colors

ARIS Administration 93
Hardware and Software Requirements

Bandwidth

Minimum: 56 k modem

Recommended: 128k transmission

Optimal: Standard network connection with 10 MBit or higher

10.6.2 Software Requirements


Operating System

Windows XP Professional, Windows XP Professional + SP1 or Windows


XP Professional + SP 1a

If you run Norton AntiVirus under Windows XP, you will not be
able to display or insert embedded WinWord documents in
opened models.

Windows NT 4.0 + Service Pack 6a

Windows 2000 + Service Pack 2, Service Pack 3 or Service Pack 4

Browser

Microsoft Internet Explorer Version 5.01, 5.5 or 6.0.

Netscape Navigator version 4.73 + Crypto API 2.0 and version 6.22.

Versions released after this manual has been sent to press may not
have been approved by IDS Scheer, but they can probably be used.

Java Runtime Environment (JRE) 1.3.1_03 (international) , 1.3.1_06


(international) and 1.4.2 (international) are approved for Internet Ex-
plorer or Netscape Navigator.

To display different character sets (Japanese, Arabic, Cyrillic, etc.) the


corresponding file in the <JRE installation directory>\1.3\lib must be
called font.properties. If, for example, you wish to display Japanese
characters, you must rename the font.properties.ja file to
font.properties.

94 Administration ARIS
Hardware and Software Requirements

Browser Security Settings

Microsoft Internet Explorer

If you are working with Microsoft Internet Explorer and Java Runtime
Environment (JRE) is not installed and is to be downloaded, you must
make the following settings in the Tools/Internet
Options/Security/Custom Level menu in Microsoft Internet
Explorer:

Adjust your browser settings to ensure that

ActiveX control elements and plug-ins can be executed

signed ActiveX control elements are downloaded

permission to run Javascript exists.

Netscape Navigator

Netscape Navigator does not support ActiveX control elements or


scripting.

If you are working with Netscape Navigator, you must adjust your
browser settings to enable Javascript to be run
(Edit/Settings/Extended button).

Network Communication

TCP/IP

10.7 ARIS Web Designer Components


This section describes the hardware and software requirements for
ARIS Web Designer components.

The following Web server has been tested and approved for
operation with ARIS Web Designer

Microsoft Internet Information Server 4.0 or 5.0

Apache Web Server 1.3.6 and Apache HTTP Server 2.0 under Windows

Network Communication

TCP/IP

Follow all information contained in the corresponding installation guide.

ARIS Administration 95
Hardware and Software Requirements

10.7.1 Hardware Requirements


Minimum System Requirements:

Processor: Intel Pentium II, 64 MB RAM (for Windows 2000 + 32 MB


RAM)

30 MB free hard disk space

Graphics Card

Minimum: SVGA, screen resolution: 800 x 600; 256 colors

Recommended: Screen resolution: 1024 x 768, at least 256 colors

10.7.2 Software Requirements


Operating System

Windows NT 4.0 Server + Service Pack 6a

Windows 2000 Server + Service Pack 2, Service Pack 3 or Service Pack


4

Windows 2003 Server Standard Edition. However, this release is


not valid for 64-bit Itanium processors. If you want to output
reports with Microsoft Word or Microsoft Excel, Office XP must be
installed because previous versions are incompatible with Windows
2003 server.

Browser

Microsoft Internet Explorer Version 5.01, 5.5 or 6.0. Higher versions


are neither tested nor approved.

Network Communication

TCP/IP

10.8 ARIS Web Report Server


To generate the DOC and XLS output formats you must have installed
Microsoft Office on the computer on which ARIS Site Manager is
installed.

The system requirements depend on your use scenario. They are


described with reference to ARIS Business Server in chapter 10.2.1.

96 Administration ARIS
Hardware and Software Requirements

10.9 ARIS Converter


All applications from which you are using COM objects in ARIS
databases must be installed in all cases on the computer you are using
to convert databases. When converting databases that contain links to
Microsoft Word and Microsoft Excel documents, Microsoft Word and
Microsoft Excel Version 97 or higher must be installed.

The system requirements depend on your use scenario. They are


described with reference to ARIS Business Server in chapter 10.2.1.
If in doubt please contact the IDS Scheer Customer Inter@ction Center
(see chapter 12.1).

If you run Norton AntiVirus under Windows XP, WinWord documents


will not be transferred to the converted database.

ARIS Administration 97
Glossary

11 Glossary

Term Meaning

ARIS Agent Program that autonomously monitors and manages ARIS Business
Server processes.

ARIS Site One or more ARIS Business Servers, a database server and an
ARIS Site Manager.

Application Server Computer on which applications are run. It is a component of a 3-


tier architecture.

ARIS Business ARIS Application Server


Server

ARIS Converter ARIS 6 conversion component. It converts ARIS data from earlier
versions of ARIS into the current ARIS format.

Database Server Computer on which the ARIS Repository is installed. ARIS Clients
access the database server on which the ARIS Repository
containing the ARIS databases resides via the ARIS Business
Server.

ARIS Easy Design ARIS Client that provides the functionality of ARIS Toolset tailored
to the operational departments.

ARIS HTML Program module that automatically generates the HTML files
Generator needed by ARIS Web Designer when ARIS Web Designer is used
via a browser.

ARIS Site Central management component with which administrative


Administrator accesses can be provided to all ARIS sites simultaneously.

ARIS Site Central component of ARIS Site that, for instance, coordinates
Manager access to programs and data by means of a license and lock
service.

ARIS PCA Site Administration component that can be used to administer ARIS
Administrator Process Cost Analyzer databases and reports.

ARIS Toolset ARIS Client used to model, analyze and simulate business
processes etc.

98 Administration ARIS
Glossary

Term Meaning

ARIS Web Modeling tool in ARIS 6 Collaborative Suite that runs within a
Designer browser or as an application (see chapter 2.4) and that can be
used in a LAN and a WAN. ARIS Web Designer thus enables as it
were Internet modeling of business processes.

ARIS Web Report "Point of contact" between ARIS Web Designer and ARIS Toolset.
Server Using this server, ARIS Web Designer activates report generation
in ARIS Toolset.

ARIS Web WWW components accessed by ARIS Web Designer when ARIS
Designer Web Designer is started via a browser.
components

CPU Central processing unit. Processor of a computer.

Firewall Technology (hardware and/or software) that controls the data flow
between internal and external (unprotected) networks and
provides protective mechanisms to combat unauthorized access.

JRE Java Runtime Environment. System that is used to run Java


programs. The main components are the Java Virtual Machine, the
Java Interpreter, and the host operating system.

LAN Local Area Network. Network within a company. This network has
broad bandwidth.

Load Distribution Distribution of the network load per application server. The more
transport transactions are required, the higher the utilization of a
network.

LDAP Lightweight Directory Access Protocol. Protocol that provides


access to centrally managed libraries of information and
directories. It saves having to search the whole network for data.
The access data for user login to ARIS is stored centrally on the
LDAP server so it does not have to be managed separately for
each database.

Oracle Relational database system that can be used for ARIS


installations.

ARIS Administration 99
Glossary

Term Meaning

RAID Redundant Array of Independent Disks. Method of linking several


hard drives and accessing these as if accessing a single hard drive.
This means that data storage and data access is "spread" across
these hard drives, which improves access time and avoids
complete loss of data should a drive fail.

SSL Secure Socket Layer. Security software for encrypting data that is
exchanged between programs.

WAN Wide Area Network. Network that transports data both within the
company network and via the Internet. This network has low
bandwidth.

Web server A server containing the HTML pages, images, documents and
other files and folders that users or programs within a network can
access.

100 Administration ARIS


Appendix

12 Appendix

12.1 IDS Scheer Customer Inter@ction Center

Do you have questions relating to the installation,


maintenance or optimization of ARIS?

Take Advantage of our Service Offerings!


Telephone support

On-site support and remote maintenance

Training and training workshops

Online support

Customer Inter@ction Center

Service Hotline
++49 (0) 6 81-2 10 12 12 (Europa)
++33 (0) 825 324 325 (Frankreich)
++44 (0) 121 767 1928 (Grobritannien)
++1 888 212 54 39 (Amerika)
++81 (0) 3 35 16 74 31 (Asien)

Web Services
www.ids-scheer.com/support

E-Mail
ids-service@ids-scheer.de

ARIS Administration 101


Appendix

12.2 System Languages and Locale IDs

System Language Locale ID

Afrikaans - South Africa 1078

Albanian - Albania 1052

Arabic - Algeria 5121

Arabic - Bahrain 15361

Arabic - Egypt 3073

Arabic - Iraq 2049

Arabic - Jordan 11265

Arabic - Kuwait 13313

Arabic - Lebanon 12289

Arabic - Libya 4097

Arabic - Morocco 6145

Arabic - Oman 8193

Arabic - Qatar 16385

Arabic - Saudi Arabia 1025

Arabic - Syria 10241

Arabic - Tunisia 7169

Arabic - U.A.E. 14337

Arabic - Yemen 9217

Basque - Spain 1069

Belarussian - Belarus 1059

Bulgarian - Bulgaria 1026

Catalan - Spain 1027

Chinese - Hong Kong 3076

Chinese - PRC 2052

Chinese - Singapore 4100

Chinese - Taiwan 1028

102 Administration ARIS


Appendix

System Language Locale ID

Croatian - Croatia 1050

Czech - Czech Republic 1029

Danish - Denmark 1030

Dutch - Belgium 2067

Dutch - Netherlands 1043

English - Australia 3081

English - Belize 10249

English - Canada 4105

English - Caribbean 9225

English - Ireland 6153

English - Jamaica 8201

English - New Zealand 5129

English - South Africa 7177

English - Trinidad 11273

English - United Kingdom 2057

English - United States 1033

Estonian - Estonia 1061

Faeroese - Faeroe Islands 1080

Farsi - Iran 1065

Finnish - Finland 1035

French - Belgium 2060

French - Canada 3084

French - France 1036

French - Luxembourg 5132

French - Switzerland 4108

German - Austria 3079

German - Germany 1031

German - Liechtenstein 5127

ARIS Administration 103


Appendix

System Language Locale ID

German - Luxembourg 4103

German - Switzerland 2055

Greek - Greece 1032

Hebrew - Israel 1037

Hungarian - Hungary 1038

Icelandic - Iceland 1039

Indonesian - Indonesia 1057

Italian - Italy 1040

Italian - Switzerland 2064

Japanese - Japan 1041

Korean - Korea 1042

Latvian - Latvia 1062

Lithuanian - Lithuania 1063

Norwegian - Norway (Bokmal) 1044

Norwegian - Norway (Nynorsk) 2068

Polish - Poland 1045

Portuguese - Brazil 1046

Portuguese - Portugal 2070

Romanian - Romania 1048

Russian - Russia 1049

Serbian - Serbia (Cyrillic) 3098

Serbian - Serbia (Latin) 2074

Slovak - Slovakia 1051

Slovene - Slovenia 1060

Spanish - Argentina 11274

Spanish - Bolivia 16394

Spanish - Chile 13322

Spanish - Colombia 9226

104 Administration ARIS


Appendix

System Language Locale ID

Spanish - Costa Rica 5130

Spanish - Dominican Republic 7178

Spanish - Ecuador 12298

Spanish - El Salvador 17418

Spanish - Guatemala 4106

Spanish - Honduras 18442

Spanish - Mexico 2058

Spanish - Nicaragua 19466

Spanish - Panama 6154

Spanish - Paraguay 15370

Spanish - Peru 10250

Spanish - Puerto Rico 20490

Spanish - Spain (Modern Sort) 3082

Spanish - Spain (Traditional Sort) 1034

Spanish - Uruguay 14346

Spanish - Venezuela 8202

Swedish - Finland 2077

Swedish - Sweden 1053

Thai - Thailand 1054

Turkish - Turkey 1055

Ukrainian - Ukraine 1058

Vietnamese - Vietnam 1066

ARIS Administration 105


Appendix

12.3 Port Numbers

Port Name For

16040 aris62_name_public Public Name Service

16041 aris62_name_private Private Name Service

16042 aris62_name_admin Admin Service

16043 aris62_name_agent Agent Service

16044 aris_Sybase Standard database system

16045 aris62_local_public Public Name Service local

16046 aris_local_Sybase Standard database system local

16047 aris62_local_private Private Name Service local

16048 aris62_local_admin Admin Service local

12.4 Copyright
Registered trademarks of the Microsoft Corporation include:

Microsoft SQL Server.

MS Excel

MS Internet Explorer

Visual Basic

Windows 2000

Windows 95/98

Windows NT

Windows XP

Word for Windows

Apache Web Server and Apache HTTP Server are registered


trademarks of Apache Software Foundation. ARIS includes software
developed by Apache Software Foundation (http://www.apache.org/).

HP-UX is a registered trademark of Hewlett-Packard Company.

106 Administration ARIS


Appendix

IBM DB2 is a registered trademark of IBM.

Lotus Notes is a registered trademark of Lotus Development


Corporation.

Netscape Communicator is a registered trademark of Netscape.

Novell is a registered trademark of Novell Inc.

Oracle DBMS is a registered trademark of Oracle.

Rational Rose is a registered trademark of Rational.

SAP, R/3, HR and AcceleratedSAP are registered trademarks of SAP


AG.

Solaris is a registered trademark of Sun Microsystems, Inc.

Other product names mentioned are trademarks or registered


trademarks of their respective manufacturers.

ARIS Administration 107


Index

13 Index
Admintool Run as application 9
General 69 Run in browser 9
ARIS ARIS Web Designer
LDAP settings 29 Applet 10
ARIS 6-datenbank 32 Character sets 9
ARIS Admintool File storage 3
Backup 71 Installed files 3
Backupconfig 72 JAR-files 3
Command line 69 Procedure 2
Commands 70 Provide additional memory 10
Copy 73 Run as application 9
Dbmspassword 74 Run in browser 9
Delete 74 Setup 2
Exit 74 ARIS Web Designer components 24
General information 69 ARIS Web Report Server 13
Help 75 Hardware requirements 13
Interactive 75 Report files 13
Interactive mode 69 arishome60 4
Kill 75 arisserver.cfg
List 76 Entry "mail.locale.country" 22
Maintain 76 Entry "mail.locale.lang" 22
Password 77 Entry "mail.recipient.cc" 22
Rename 77 Entry "mail.recipient.to" 22
Reorg 77 Entry "mail.server.host" 22
Restore 78 Entry "mail.server.protocol" 22
Restoreconfig 79 Entry "mail.user.address" 22
Server 80 Entry "mail.user.name" 22
Sessions 80 Entry "mail.warnings.enable" 22
Statistics 81 Entry "state" 22
Status 81 Backup 25
Version 82 Automate 72
ARIS Agent 20 Database 58
Shut down 20 Example 71
ARIS API PCA Databases 18
Continued use of programs 56 Scheduled 58
ARIS Business Server Using batch program 72
Processes 20 Using Windows NT 72
Provide memory 26 Company license key 11
ARIS Converter 57 Configuration database
ARIS instance 32 Transfer item groups 64
ARIS Notify Service 21 Transfer items 65
ARIS PCA Site Administrator 18 Configuration file 59
ARIS Process Cost Analyzer 16 Connection
ARIS UML Designer

108 Administration ARIS


Index

ARIS Business Server - ARIS Site backup_sysconfig.zip 59


Manager 23 cid.bin 11
Client - ARIS Business Server 23 Font.properties 9
Copyright 106 htmlgen.bat 25
Customer Inter@ction Center 101 index.html 24, 25
Data backup index_backup.zip 25
Automate 72 setup.iss 55
Example 71 tcpip/service 27
Using batch program 72 user.cfg 2, 11, 12
Using Windows NT 72 HTML Generator 24
Data transfer 60 IBM DB2 47
Database Identical installations 55
Backup 58 Installation
Manage 69 ARIS Converter 57
DB2 47 ARIS Web Report Server 13
ARIS scheme versions 54 Call with "setup.exe -r" 55
aris62db2.jar file 47 Call with"setup.exe -s" 55
Database parameters 49 Installations
Delete DB2 schemes 53 Identical 55
Fill DB2 scheme supply 52 Instance parameters
Installation script installaris62.db2 50 DB2 49
Installation script installaris62db2.bat Oracle 35
50 Interactive mode 69, 75
Instance parameters 49 Jar files
List DB2 schemes 53 Storage location 4
Manage ARIS databases automatically JAR files
51 Web Designer 3
Manage ARIS databases manually 51 JDBC driver 46
Operating system user 49 JRE 2
Programs,drivers,scripts 47 JRE 1.3.1_03 5
DB2 script JRE 1.3.1_06 5
installaris62.db2 50 JRE 1.4.2 5
installaris62db2.bat 50 LDAP
DBMS user Authentication 27
Password 74 LDAP login attribute 28
Email Login process 31
Send for errors 21 LDAP server
Send for warnings and errors 21 Backup server 28
Excel export 68 Login process 31
Export Reliability 28
Excel 68 Set up 27
Text 68 Settings for ARIS 29
File SSL protocol 28
aris_database.html 5, 27 libdir 4
arisloader.cfg 3 Locale ID 102
arisserver.cfg 21, 23, 24, 27 Login process 31

ARIS Administration 109


Index

Maintenance tasks Transfer user-generated 67


License key 55 Update 66
Licensing stipulations 55 Script Converter 66
Manage Secure Socket Layer 6
Database 69 Security provider 8
Metaframe 59 Semantic Check
Microsoft SQL Server 39 Transfer scripts 67
MS-DOS program Send
Admintool 69 Email for errors 21
Oracle Email for warnings and errors 21
DBMS_STATS.GATHER_SCHEMA_STAT Send automatic email 21
S method 37 Server
Implement job 37 DB2 47
Option GATHER STALE 37 Manage database 69
Oracle DUMP 58 SQL 39
Refresh Statistics 36 Single point of login 27
Oracle database server 32 Software distribution 11
ARIS schemes 37 SQL
Create database user 38 ARIS62.db_trash table 44
Instance parameters 35 ARIS62.dbstock table 44
Optimizer 36 Microsoft JDBC driver 46
Recommended reading 38 Recycling 45
System parameters 34 recycling.sql file 45
Tablespace configuration 34 Refilling 45
Tablespace parameter 33 Switch from manual to automatic 45
UTF 8 character set 35 SQL script
Oracle Database Server aris_21.sql 43, 44
Tablespaces and tables 33 aris_22.sql 43, 44, 54
Password aris_23.sql 54
DBMS user 74 aris62SwitchToAutoAdmin.bat 45
LDAP 27 bo_2.sql 43, 44
PCA database enhancedProcedures.sql 43
Backup 58 init.sql 43, 44, 54
PCA Databases initialDatabases.sql 43, 44
Backup 18 installaris62.sql 43, 44, 54
Performance maintenance.bat 45
Refresh Oracle statistics 36 recycler.sql 43, 44
Ping 20 refillDatabase.bat 45
Policy files 7 SQL server 39
Port INIT.SQL 41
Change 26 Installation instructions 39
Number 106 Manage ARIS databases automatically
Provide memory 26 42
Report files 13 Manage ARIS databases manually 43
Requirements 83 Programs,drivers,scripts 39
Script SQL server agent 41

110 Administration ARIS


Index

SQL Server Text export 68


Setup 40 Trademark 106
SQL-script Update
aris_23.sql 43, 44 Script 66
SSL Web Designer
ARIS Web Designer and ARIS Business Applet 10
Server 6 Character sets 9
Java Cryptography Extension (JCE) 7 File storage 3
JRE 1.4.x 7 Installed files 3
LDAP server 28 JAR files 3
Procedure 6 Procedure 2
Standard database system Provide additional memory 10
Reset password 59 Setup 2
System language 102

ARIS Administration 111