ARIS Server Installation and Administration Guide - 0 PDF
ARIS Server Installation and Administration Guide - 0 PDF
ARIS Server Installation and Administration Guide - 0 PDF
Guide
ARIS
Version 9.6
April 2014
This document applies to ARIS Version 9.6 and to all subsequent releases. Specifications
contained herein are subject to change and these changes will be reported in subsequent release
notes or new editions.
Copyright © 2010 - 2014 Software AG, Darmstadt, Germany and/or Software AG USA Inc.,
Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
The name Software AG and all Software AG product names are either trademarks or registered
trademarks of Software AG and/or Software AG USA Inc. and/or its subsidiaries and/or its
affiliates and/or their licensors. Other company and product names mentioned herein may be
trademarks of their respective owners. Detailed information on trademarks and patents owned by
Software AG and/or its subsidiaries is located at http://documentation.softwareag.com/legal/.
Use of this software is subject to adherence to Software AG's licensing conditions and terms.
These terms are part of the product documentation, located at
http://documentation.softwareag.com/legal/ and/or in the root installation directory of the
licensed product(s).
This software may include portions of third-party products. For third-party copyright notices and
license terms, please refer to "License Texts, Copyright Notices and Disclaimers of Third Party
Products". This document is part of the product documentation, located at
http://documentation.softwareag.com/legal/ and/or in the root installation directory of the
licensed product(s).
Server Installation and Administration Guide
Contents
1 General Notices .................................................................................................... 1
2 Installation ........................................................................................................... 2
2.1 Available Setups .......................................................................................... 3
2.1.1 ARIS Connect Server Installation (Windows Operating System)............. 5
2.1.2 ARIS Design Server Standalone Installation (Windows Operating
System) ........................................................................................... 9
2.1.3 ARIS Risk & Compliance Manager Server Installation (Windows
Operating System) .......................................................................... 12
2.1.4 ARIS Publisher Server Installation (Windows Operating System) ......... 14
2.1.5 ARIS Remote Installations (Windows Operating System) ...................... 16
2.1.6 Installing ARIS on a Linux Operating System ...................................... 17
2.2 Using Oracle or Microsoft SQL Server instead of the Standard Database
System .................................................................................................... 19
2.2.1 Customize the Oracle Database ........................................................ 19
2.2.2 Customize the Microsoft SQL Server System ....................................... 21
2.3 Using Oracle or Microsoft SQL Server for ARIS Publisher Server ...................... 26
2.3.1 Use Oracle Database (Tomcat).......................................................... 26
2.3.2 Use Microsoft SQL Database ............................................................. 29
2.3.3 Change Database Connection Parameters .......................................... 31
2.4 Update Installation .................................................................................... 32
2.5 Back up and Restore Data .......................................................................... 35
5 Customizing ....................................................................................................... 51
5.1 Administration Tools .................................................................................. 51
5.1.1 Administration ................................................................................ 51
5.1.2 Command Line Tools for the Administration ........................................ 52
5.1.3 ARIS Cloud Controller (ACC) ............................................................. 61
5.1.4 ARIS Server Administrator .............................................................. 101
I
Server Installation and Administration Guide
6 Data migration from ARIS version 9.x to ARIS version 9.6 ...................................... 147
7 Data Migration from ARIS version 7.2 to ARIS version 9.x ....................................... 148
7.1 Migration of ARIS with a Local User Administration ....................................... 148
7.2 Migration of ARIS with LDAP Integration ...................................................... 149
7.3 Migration of ARIS with Process Governance without Central User
Management ............................................................................................ 149
7.4 Migration of ARIS with Process Governance with Central User Management ... 150
7.5 Migration of ARIS document storage Data .................................................... 150
7.6 Migration of Databases, Configuration Elements and Scripts........................... 151
II
Server Installation and Administration Guide
1 General Notices
This manual describes the settings and features as they were at the time of print.
In this document, file names and user-defined content are formatted and identified as follows:
File names, keyboard entries etc. are shown in bold.
Entries with user-defined content are highlighted in <bold and enclosed in angle
brackets>.
Optional ACC command parameters are highlighted in (round brackets followed by)?
1
Server Installation and Administration Guide
2 Installation
This chapter describes all one-node server installation procedures using the setup programs.
For all other installation scenarios e.g. multi-node systems for a larger distributed scenario and
higher availability please contact your local Software AG sales organization (page 161).
To avoid redundancies this document does not re-iterate information available in other
documents. For more details please review the following documents (see installation media or
download them http://aris.softwareag.com/ARISDownloadCenter/ADCDocumentationServer):
For information about hardware and software requirements, please refer to the ARIS
Platform Matrix document
The client installation is described in the ARIS Client Installation Guide.
For an overview on features and functionalities, please refer to the Product Functionality
Matrix document
For an overview on supported interfaces, methods, languages, and compatibilities, please
refer to the Technical Product Matrix document
2
Server Installation and Administration Guide
This setup will install ARIS Agent, ARIS Connect Server containing ARIS Design Server,
standard database system, ARIS Connect Viewer, ARIS Connect Designer and ARIS
download clients and provide the default tenant. The functionalities ARIS Connect
workflows‚ Share model, Change request and Approve model are available using an ARIS
Connect Server license. For full ARIS Process Governance functionality you need to purchase and
import an ARIS Process Governance Server license.
The installation procedures are available for a Windows operating system (page 5) or a Linux
operating system (page 17). If you use your Oracle database system or your Microsoft SQL
database system please make sure to customize your operating database system (page 19)
before starting the ARIS setup.
Please install an ARIS Client if you would like to manage server data using ARIS Server
Administrator (page 101).
This setup will install ARIS Agent, ARIS Design Server, standard database system and
ARIS download clients and provide the default tenant.
The installation procedure is available for a Windows operating system (page 9) or a Linux
operating system (page 17). If you would like to use your Oracle database system or your
Microsoft SQL database system you need to configure your operating database system (page 19)
before starting the ARIS setup.
Please install an ARIS Client if you would like to manage server data using ARIS Server
Administrator (page 101).
This setup will install ARIS Agent, ARIS Risk & Compliance Manager Server and ARIS
document storage.
The installation procedure is available for a Windows operating system (page 14). If you would
like to use your Oracle database system or your Microsoft SQL database system you need to
configure your operating database system (page 19) before starting the ARIS setup.
If you are using ARIS Risk & Compliance Manager already you can connect the existing ARIS
document storage and the ARIS Risk & Compliance Manager User Management to the active ARIS
Connect Server or ARIS Design Server.
This setup will install ARIS Agent and ARIS Publisher Server.
The installation procedure is available for a Windows operating system (page 14) or a Linux
operating system (page 17).
3
Server Installation and Administration Guide
The standard installation uses a Derby database system and Apache Tomcat Web Application
Server. With this test system, only one user can access a Publisher export. Swim lane models
cannot be exported using a Derby database. If you are installing ARIS Publisher Server on a Linux
operating system you cannot use a Derby database.
For a productive system, a larger number of users and on a Linux system, you need an Oracle
database system or a Microsoft SQL database system that must be configured for ARIS
Publisher Server (page 26) before starting the ARIS setup. These systems are not included in the
package. Depending on the ARIS Publisher Server license purchased (page 116), these systems
enable all users to simultaneously work on exports.
For demonstration reasons (laptop) we also recommend the ARIS client installation including the
server LOCAL (see Client Installation Guide).
Before installing ARIS Connect Server, ARIS Design Server or ARIS Publisher Server on a Linux
operating system you must provide ARIS Agent to your Linux Debian or Red Hat system. To allow
customizing activities additionally provide ARIS Cloud Controller (ACC). Use the *.deb files for
Debian systems and *.rpm files for Red Hat systems. After you have copied and installed the files
start the remote installation from a Windows system.
4
Server Installation and Administration Guide
Prerequisites
If you would like to import the license file right now please make sure to have the file saved on
this computer. Otherwise the license must be imported using the Administration.
Procedure
1. Start the ARIS Connect Server installation.
2. Install ARIS Connect Server on the active computer.
3. Specify the port numbers to be used.
4. Select the suitable system settings option. You need to take the RAM required and the number
of users who will be accessing the ARIS Server into account to ensure optimum load
distribution and better protection against failure. For a productive system it is recommended
to select the Medium number of users or High number of users option.
For demonstration reasons (laptop) we recommend the option Small number of users.
(page 78)
5
Server Installation and Administration Guide
5. Select the database system. If you do not check Standard please make sure the database
system has been customized (page 19) before running this setup.
6. After the database system has been customized, select the database management system
and the JDBC driver.
7. Enter the connection parameters. Please use the database name, the application user and the
schema names selected during customizing.
ORACLE (page 21)
6
Server Installation and Administration Guide
7
Server Installation and Administration Guide
8
Server Installation and Administration Guide
Prerequisites
If you would like to import the license file right now please make sure to have the file saved on
this computer. Otherwise the license must be imported using the Administration.
Procedure
1. Start the ARIS Design Server installation.
2. Install ARIS Design Server on the active computer.
3. Specify the port numbers to be used.
4. Select the suitable system settings option. You need to take the RAM required and the number
of users who will be accessing the ARIS Server into account to ensure optimum load
distribution and better protection against failure. For a productive system it is recommended
to select the Medium number of users or High number of users option.
For demonstration reasons (laptop) we recommend the option Small number of users.
(page 78)
5. Select the database system. If you do not check Standard please make sure the database
system has been customized (page 19) before running this setup.
6. After the database system has been customized, select the database management system
and the JDBC driver.
9
Server Installation and Administration Guide
7. Enter the connection parameters. Please use the database name, the application user and the
schema names selected during customizing.
ORACLE (page 21)
10
Server Installation and Administration Guide
You can configure SMTP mail processing (page 76) any time. Some parameters can also be
edited in the Administration (page 51) of this server. Please refer to the Administration online
help.
9. Only if your mail server requires SMTP authentication check the option SMTP authentication
and enter user name and password.
If you enter these parameters but your mail server does not require SMTP authentication, the
connection will be rejected.
10. If you are about to use a proxy server please enter all proxy processing parameters. They can
also be entered using the Administration (page 51) of this server. Please refer to the
Administration online help.
11. Start the installation process.
12. Once after the installation process is completed configure the system (page 51).
13. Click Start > All Programs > ARIS > Administration > Start ARIS Design Server. This
process will take a while.
14. Click Start > All Programs > ARIS > Administration > Start ARIS Cloud Controller and
enter list to check the status of the processes.
15. After <abs> is running open your browser and enter localhost/umc or <IP address or
fully-qualified host name>/umc. The login dialog opens.
16. Enter the user name superuser and the password superuser. The administration opens.
17. Click Logout.
18. Send the URL <IP address or fully-qualified host name>/umc to the ARIS administrator.
The ARIS Design Server is installed, customized and running.
You can stop ARIS Design Server using the Stop ARIS Design Server link in the Windows start
menu or enter stopall in the ARIS Cloud Controller.
The administrator must import licenses, create users and user groups and assign privileges and
licenses (page 38) for the default tenant. If you have created additional tenants (page 37) users
and licenses must be manages for each tenant.
Update installations are available (page 32). Components will be stopped. After the system has
been updated all components will be started automatically.
11
Server Installation and Administration Guide
Prerequisites
If you would like to import the license file right now please make sure to have the file saved on
this computer.
Procedure
1. Perform the ARIS Risk & Compliance Manager Server installation.
2. Install the server on the active computer.
3. Select the modeling approach you wish to install for ARIS Risk & Compliance Manager.
Attention: You cannot change the modeling approach after installation is complete.
4. If you change the default port numbers please enter free numbers to prevent port conflicts
(page 157).
5. Specify the mail server parameters for outgoing mails. Enter the name of the mail server and
the default e-mail address, if this information is already available.
6. If you enable the event processing and enter all server parameters ARIS Risk & Compliance
Manager will receive e.g. WebMethods events and handle them.
7. Select the database system. If you do not check Standard please make sure to have the
database system customized (page 19) before running this setup.
8. Select the suitable installation option. You need to take the memory requirement into account
to ensure optimum load distribution and better protection against failure.
12
Server Installation and Administration Guide
13
Server Installation and Administration Guide
Prerequisites
Make sure to have the ARIS Publisher Server license file saved on this computer.
Procedure
1. Perform the ARIS Publisher Server installation.
2. Install ARIS Publisher Server on the active computer.
3. Select the ARIS Publisher Server to be installed.
14
Server Installation and Administration Guide
4. If you retain the settings of the installation program, the context path and the free port
(19990) to the web server are entered automatically.
5. Select the suitable installation option. You need to take the memory requirement into account
to ensure optimum load distribution and better protection against failure.
The option Small is recommended for a single installation for demonstration purposes e. g. on
a laptop (32-bit VM; 1 GB for the application, 256MB for Derby).
The option Medium reserves 3 GB for the application and 512MB for Derby. The use of Oracle
or Microsoft SQL Server is recommended.
The option Large reserves 8 GB for the application and 1 GB for Derby. The use of Oracle or
Microsoft SQL Server is obligatory.
6. If you use Process Governance please specify the integration parameters.
The Process Governance module and the Start governance process pop-up menu are
only available in the Publisher exports if a Process Governance license is available for the
connected ARIS Connect Server or ARIS Design Server and all Process Governance integration
parameters have been entered during the ARIS Publisher Server setup process.
7. Select the database system. If you do not check Standard please make sure to have the
database system customized (page 19) before running this setup.
8. Start the installation process.
9. Once after the installation process is completed configure the system (page 51).
10. Click Start > All Programs > ARIS > Start ARIS Publisher Server.
11. After ARIS Publisher Server is running open your browser and enter http://<IP address or
fully-qualified host name>:<port number>/businesspublisher, e.g.
http://arispublishersrv:19990/businesspublisher.
12. Start the Administration (page 39) of the ARIS Connect Server or ARIS Design Server and
import the ARIS Publisher Server license file.
After the installation, reports are run by ARIS Publisher Server. You can additionally install a
Report Server to optimize system performance when running reports. To install an ARIS Publisher
Report Server start this setup again and select the ARIS Publisher Report Server to be installed.
After you have installed ARIS Publisher Report Server, exports are managed by ARIS Publisher
Server and reports are run by ARIS Publisher Report Server.
If you already use ARIS Connect or ARIS Design Server and have installed ARIS Publisher Server
later you can force ARIS Publisher Server to use the Administration of your productive ARIS
Connect Server or ARIS Design Server (page 111) installation. Only in this case ARIS document
storage will be available if customized (page 113).
You may change the standard database connection parameters (page 31).
Update installations are available (page 32). Components will be stopped. After the system has
been updated all components will be started automatically.
15
Server Installation and Administration Guide
Procedure
1. Start the ARIS Agent setup on the server that will be used for remote installation. Tis will
provide ARIS Cloud Controller (ACC) (page 61) on this machine.
2. Start the server installation from any Windows system.
3. Select the remote installation option and enter the name of the remote server.
4. If you have changed the remote access password (page 67) you must enter the new password
using the option Enter changed remote access password.
5. Once after the installation process is completed configure the system (page 51).
6. Start the server (Start > All Programs > ARIS > Administration). This process will take
a while.
7. Click Start > All Programs > ARIS > Administration > Start ARIS Cloud Controller and
enter list to check the status of the processes.
8. After the server is running open your browser and enter <IP address or fully-qualified
host name>/umc. The login dialog opens.
9. Enter the user name superuser and the password superuser. The administration opens.
10. Click Logout.
11. Send the URL <IP address or fully-qualified host name>/umc to the ARIS administrator.
The Server is installed, customized and running.
You can stop enter stopall in the ARIS Cloud Controller.
The administrator must import licenses, create users and user groups and assign privileges and
licenses (page 38) for the default tenant. If you have created additional tenants (page 37) users
and licenses must be manages for each tenant.
Update installations are available (page 32). Components will be stopped. After the system has
been updated all components will be started automatically.
16
Server Installation and Administration Guide
kernel.shmmax:
if "kernel.shmmax < 629145600" then "kernel.shmmax = 629145600"
max_file_max:
if "max_file_max < 200000” then "fs.file-max = 200000"
/etc/security/limits.d/40-aris.conf
Procedure
1. Copy the file aris-cloud-agent_1.0.0-SNAPSHOT_amd64.deb or
aris-cloud-agent-1.0.0-1.x86_64.rpm from the installation media to the hard drive of
your Linux system.
This file provides ARIS Agent. ARIS Agent is needed to perform a remote ARIS Connect Server
or ARIS Design Server installation.
2. To allow enhanced customizing of ARIS copy the file
aris-acc_1.0.0-SNAPSHOT_amd64.deb or aris-cloud-agent-1.0.0-1.x86_64.rpm
from the installation media to the hard drive of your Linux system.
This file provides ARIS Cloud Controller (ACC) (page 61).
3. Depending on the files you have copied and the type of the Linux system enter the relevant
command to install the files:
dpkg –i aris-cloud-agent_1.0.0-SNAPSHOT_amd64.deb
This command installs ARIS Agent to your Debian system.
dpkg –i aris-acc_1.0.0-SNAPSHOT_amd64.deb
17
Server Installation and Administration Guide
This command installs ARIS Cloud Controller (/bin/acc.sh) to your Debian system.
rpm –i aris-cloud-agent-1.0.0-1.x86_64.rpm
This command installs ARIS Agent to your Red Hat system.
rpm –i aris-acc-1.0.0-1.x86_64.rpm
This command installs ARIS Cloud Controller (/bin/acc.sh) to your Red Hat system.
4. If you are not about to use the standard database system, please make sure to customize your
Oracle or Microsoft SQL database system (page 19) before starting the ARIS Server
installation. For an ARIS Publisher Server installation the customizing is mandatory as the
standard database system Derby cannot be used.
5. Start the installation of ARIS Connect Server (page 5), ARIS Design Server (page 9) or ARIS
Publisher Server (page 14) from a Windows system.
6. Select the remote installation option and enter the name of your Linux system.
7. If you have changed the remote access password (page 67) you must enter the new password
using the option Enter changed remote access password.
8. Once after the installation process is completed configure the system (page 51).
9. Start ARIS Cloud Controller (acc.sh) and enter startall. This process will take a while.
10. Enter list to check the status of all components.
11. After all processes are running open your browser and enter localhost/umc or <IP address
or fully-qualified host name>/umc. The login dialog opens.
12. Enter the user name system and the password manager. The administration opens.
13. Click Logout.
14. Send the URL <IP address or fully-qualified host name>/umc to the ARIS administrator.
The ARIS Server is installed, customized and running.
You can stop enter stopall in the ARIS Cloud Controller.
The ARIS administrator should immediately change the password superuser to prevent
unauthorized access. The name superuser cannot be changed. Also the password manager of
the system user system should be changed.
The administrator must import licenses, create users and user groups and assign privileges and
licenses (page 38) for the default tenant. If you have created additional tenants (page 37) users
and licenses must be manages for each tenant.
To uninstall ARIS from a Debian system enter dpkg –-purge aris-acc or dpkg –-purge
aris-cloud-agent. To uninstall ARIS from a Ret Hat system enter rpm –e aris-acc or rpm –e
aris-cloud-agent.
Update installations are available (page 32). Components will be stopped. After the system has
been updated all components will be started automatically.
18
Server Installation and Administration Guide
Before performing an ARIS Publisher Server setup please customize the Oracle (page 26) or the
Microsoft SQL Server (page 29) database management system for ARIS Publisher Server.
19
Server Installation and Administration Guide
Warning
If you are about to update your ARIS 9.x version using an Oracle database you must upgrade
your database schema first before starting the server. Otherwise your runtime environment and
data might be harmed and the application may not work anymore.
To do so please use the files on you installation medium under
Add-ons\DatabaseScripts\Oracle\Design&ConnectServer. Base requirement for this
configuration is a correct configured envset.bat.
Execute the cip_update_schema_for_tenant.bat file for MS Windows operating system or
cip_update_schema_for_tenant.sh file for a Unix operating system.
This has to be executed for each tenant separately. Call the file directly on a computer where an
Oracle client is installed in the following syntax:
cip_update_schema_for_tenant.bat <tenant_name>, e.g.
cip_update_schema_for_tenant.bat default
or
cip_update_schema_for_tenant.bat myprojecttenant.
20
Server Installation and Administration Guide
21
Server Installation and Administration Guide
Software AG software maintenance agreement and that these changes can only be performed if
you requested and agreed on them. For information about hardware and software requirements,
please refer to the ARIS Platform Matrix document (see installation media or download it
http://aris.softwareag.com/ARISDownloadCenter/ADCDocumentationServer).
Please consider the legal notices http://documentation.softwareag.com/legal/.
To customize the system you need the following components:
An operating Microsoft SQL Server database.
The Microsoft JDBC Driver sqljdbc4.jar. You can download this driver from the Microsoft Web
Site to a directory of your choice.
SQL scripts and all additional files. These scripts and files are located on the installation
medium (Add-ons\DatabaseScripts\MSSQL) or they can be downloaded from the ARIS
Download Center
(aris.softwareag.com/ARISDownloadCenter/ARISDownloadCenter?language=en).
22
Server Installation and Administration Guide
23
Server Installation and Administration Guide
24
Server Installation and Administration Guide
Syntax
USE [<database name>]
GO
CREATE SCHEMA [<database name>_<schema name>]
GO
CREATE USER [<user name>_<database name>_<schema name>] WITHOUT LOGIN
ALTER USER <user name>_<database name>_<schema name> WITH DEFAULT_SCHEMA =
<database name>_<schema name>
GRANT CONTROL ON SCHEMA :: [<database name>_<schema name>] TO [<user
name>_<database name>_<schema name>]GRANT IMPERSONATE ON USER::<user
name>_<database name>__<schema name> TO ARIS9
GRANT CREATE TABLE TO [<user name>_<database name>_<schema name>]
GRANT CREATE VIEW TO [<user name>_<database name>_<schema name>]
GRANT CREATE FUNCTION TO [<user name>_<database name>_<schema name>]
GO
Example
In this example the database CIP is used. The schema name is CIP_MASTER and the user
name is ARIS9.
USE [CIP]
GO
CREATE SCHEMA [CIP_MASTER]
GO
CREATE USER [ARIS9_CIP_MASTER] WITHOUT LOGIN
ALTER USER ARIS9_CIP_MASTER WITH DEFAULT_SCHEMA = CIP_MASTER
GRANT CONTROL ON SCHEMA :: [CIP_MASTER] TO [ARIS9_CIP_MASTER]
GRANT IMPERSONATE ON USER::ARIS9_CIP_MASTER TO ARIS9
GRANT CREATE TABLE TO [ARIS9_CIP_MASTER]
GRANT CREATE VIEW TO [ARIS9_CIP_MASTER]
GRANT CREATE FUNCTION TO [ARIS9_CIP_MASTER]
GO
Start the ARIS Server setup (page 2) process, select the database management system
Microsoft SQL and the JDBC driver.
After you have set up the schema you need to assign the tenants (page 74) to additionally created
schemes.
25
Server Installation and Administration Guide
2.3 Using Oracle or Microsoft SQL Server for ARIS Publisher Server
Before performing an ARIS Publisher Server setup please customize the Oracle (page 26) or the
Microsoft SQL Server (page 29) database management system for ARIS Publisher Server.
If you install a database yourself, always follow the instructions provided by the respective
manufacturer, or contact your local Software AG sales organization (page 161). Please consider
the legal notices http://documentation.softwareag.com/legal/.
You may change the database connection parameters (page 31).
Prerequisite
You have created an Oracle database and configured it as follows. If you install a database
yourself, always follow the instructions provided in the Oracle Installation Guide. We
recommend that you use two separate Oracle databases for ARIS Design Server and ARIS
Publisher. This keeps the two systems from competing for resources, and you achieve better
performance and higher availability.
Use of the database character set AL32UTF8 is mandatory.
We recommend a block size of 8K.
query_rewrite_enabled=true
query_rewrite_integrity=trusted
You have created two table spaces: ARISBPDATA (for table data) and ARISBPINDEX (for
index data). To use other names or existing table spaces, you must customize the
configuration file webappserver.cfg (see below). We recommend that you set the table
spaces for automatic, unlimited growth. Otherwise, you run the risk of completely exhausting
the memory in the table spaces, which may cause important functions of ARIS Design Server
and ARIS Publisher to fail. If the option for automatic growth is not set, regular monitoring
(e.g. weekly) of the Oracle instance is required to ensure that the table spaces are manually
increased on time.
You have created an Oracle user that ARIS Publisher can use to connect to the database. The
name of the Oracle user is assumed to be ARISBP. You can select any password. Enter it -
coded or unencoded - in the configuration file <Installation
path>\server\bin\work\work_businesspublisher_<s, m or
l>\base\webapps\businesspublisher\WEB-INF\Resources.xml (see below). If you prefer
another name, change the name there as well:
CREATE USER ARISBP IDENTIFIED BY ARISBP;
26
Server Installation and Administration Guide
Procedure
1. Open the file Resources.xml in the ARIS Publisher Server installation directory.
2. Ensure that the following entries are specified:
<Context path="/businesspublisher" docBase="installation path>/businesspublisher/"
debug="0" reloadable="false" crossContxt="true">
<Resource name="jdbc/businesspublisherdb" auth="Container"
type="javax.sql.DataSource"
maxActive="30" maxIdle="30" maxWait="1000" initialSize="10"
<!-- Configure the DBCP (database connection pool) with these values. For an explanation
of these values, go to:
http://jakarta.apache.org/commons/dbcp/configuration.html
(http://jakarta.apache.org/commons/dbcp/configuration.html)-->
27
Server Installation and Administration Guide
28
Server Installation and Administration Guide
Prerequisite
The file create_db.sql (installation media) is copied to a directory of your choice. This script
can be modified according to your security guide lines.
You have installed Microsoft SQL Server under Microsoft Windows. Microsoft SQL Server is
not included in the package.
You have downloaded the SQL Server JDBC driver (jTDS.jar or sqljdbc4.jar) from the
Microsoft Download Center to a directory of your choice.
To encrypt passwords use the ARIS Server Administrator (page 101) command encrypt.
Procedure
1. Open the Server properties dialog.
2. On the Security tab, select the SQL Server and Windows authentication mode option.
3. Create a database using the script create_db.sql.
a. Open the script for editing.
b. Adjust the path to the database file. Ensure that the path has been created before you run
the script.
If you specify or encode the database name, user name, and password you must also
customize the configuration files <Installation
path>\server\bin\work\work_businesspublisher_<s, m or
l>\base\webapps\businesspublisher\WEB-INF\Resources.xml and webappserver.cfg.
c. Ensure that Latin1_General_CI_AI sorting is selected for the COLLATE statement.
The script creates the specified data groups. If you have changed the names in the script,
you must also change them in the configuration file Resources.xml.
ARISBPDATA: contains all database objects
ARISBPINDEX: contains all index data
d. Copy the required JDBC driver (see prerequisite) to the Tomcat installation directory under
common/lib.
4. Customize the configuration file Resources.xml as follows:
If you use jTDS.jar:
<Resource name="jdbc/businesspublisherdb"
auth="Container"
type="javax.sql.DataSource"
maxActive="100" maxIdle="20" maxWait="1000"
username="<enter username>"
password="<enter password>
29
Server Installation and Administration Guide
driverClassName="net.sourceforge.jtds.jdbc.Driver"
url="jdbc:jtds:sqlserver://<hostname>:<portnumber>/<database
name>;instance=<instancename>"
validationquery="Select 1 "/>
</Context>
If you use sqljdbc4.jar:
<Resource name="jdbc/businesspublisherdb"
auth="Container"
type="javax.sql.DataSource"
maxActive="100" maxIdle="20" maxWait="1000"
username="<enter username>"
password="<enter password>"
driverClassName="com.microsoft.sqlserver.jdbc.SQLServerDriver"
url="jdbc:sqlserver://<hostname>:<portnumber>/<database
name>;instance=<instancename>"/>
factory="com.idsscheer.aris.tools.databaseConnectionPool.ADatabaseSourceF
actory"
validationquery="Select 1 "/>
5. Customize the configuration file ..<ARIS Publisher Server installation
path>..\webappserver.cfg.
Ensure that the entries in the following line are correct:
<bp-mssql schema="ARISBPDATA" filegroup-data="ARISBPDATA"
filegroup-index="ARISBPINDEX" />
If you have changed the names in the script, you must adjust them here.
6. Ensure that the database connection is set for MSSQL.
<dao-class
name="com.idsscheer.aris.businesspublisher.application.dao.database.AMSSQLDAO
" />
You may change the database connection parameters (page 31).
30
Server Installation and Administration Guide
Example
The following values will be changed within the businesspublisher_m component:
<DBMS-Hostname>=ora-server.domain.tld
<TCPIP-PORT>=1521
<SERVICE-NAME>=ARIS
<DBMS-USERNAME> (and Schema)=ARISBP95
<DBMS-PASSWORD>=ARISBP
Tablespace-Name for Data=ARISBP9DATA
Tablespace-Name for Index=ARISBP9INDEX
To change the settings in the server configuration please follow this procedure:
1. Start ARIS Cloud Controller (ACC) (page 61) on your ARIS Publisher Server.
2. To stop all components, enter:
stop all
3. Reconfigure the businesspublisher component, enter:
e. g.:
Please make sure to place a plus-character (+) in front of each property to be changed.
4. Start all components, enter:
start all
The properties have been changed.
31
Server Installation and Administration Guide
ARIS Connect Server, ARIS Design Server and ARIS Risk & Compliance Manager Server
Before updating please read the known restrictions page (page 159).
The update installation setup is available for one-node server installations only. All components
and the default tenant's system database will be updated and migrated. All other tenants must be
updated manually (page 73).
Warning
Scheduled reports as well as ACC enhancements concerning SSL, SAP® JCo and ODBC drivers
will be lost and must be reconfigured manually.
If you have changed the remote access password (page 67) please change the password to
g3h31m before starting the update. You need the superuser's password for each tenant.
After you have updated (page 32) ARIS Connect a re-indexing will take place after the first log in
for each database. Using large databases this may take some time. It is recommended to
re-index all databases for each tenant (page 73) before users have access to ARIS Connect.
To update customized installations e.g. multi-node systems please contact your local Software
AG sales organization (page 161).
When upgrading from ARIS version 9.5, you must migrate your Process Governance data
(page 59).
32
Server Installation and Administration Guide
33
Server Installation and Administration Guide
This has to be executed for each tenant separately. Call the file directly on a computer where
an Oracle client is installed in the following syntax:
cip_update_schema_for_tenant.bat <tenant_name>, e.g.
cip_update_schema_for_tenant.bat default
or
cip_update_schema_for_tenant.bat myprojecttenant.
4. Start the ARIS Server setup and select the desired database system.
5. Restore data (page 35).
6. Update all other tenants (page 73).
7. Reconfigure ACC enhancements.
8. Re-index databases (page 73).
If the database system had been changed from Derby to Oracle you cannot update the installed
version 9.0.
After you have updated the ARIS Publisher Server you must import the ARIS Publisher Server
license again.
Red Hat
rpm –Uvh aris-*.rpm
Debian
dpkg –i aris-*.deb
34
Server Installation and Administration Guide
Database
Filter
On the Administration tab with the function Export in the pop-up menu for a filter
(individual backup).
In ARIS Server Administrator, using the backupsystemdb command.
Scripts
On the Administration tab with the function Export in the pop-up menu for a script (individual
backup).
In ARIS Server Administrator, using the backupsystemdb command.
35
Server Installation and Administration Guide
36
Server Installation and Administration Guide
3 Tenant Management
After the installation of ARIS Connect or ARIS Design Server the default tenant is available. If
you need additional tenants to provide different sets of databases, users, configurations or ARIS
methods you can easily create tenants.
If you do not use the standard database system, please make sure to create additional schemes
in your Oracle (page 21) or Microsoft SQL database management system (page 24) and you have
assigned the tenants (page 74) to these schemes.
Administrators can manage tenants in different ways:
Create tenants using ACC (page 68)
Backup tenants using ACC (page 69)
Restore tenants using ACC (page 70)
Copy tenants using ACC (page 71)
Delete tenants using ACC (page 72)
Update a tenant using ACC (page 73)
Advanced tenant management using ACC (page 100)
Tenant management using command line tools (page 53)
Please make sure to manage (page 38) users and licenses for all tenants.
37
Server Installation and Administration Guide
The Administration is a tool managing users, user groups, privileges, licenses, documents, and
configurations for each tenant (page 37) affecting all ARIS products. This ensures the single
sign-on for various ARIS products. Users can also be created using an LDAP system.
Administration is available for users holding the User management and License management
function privilege. Initially only the superuser and system system users are available. These
users are able to manage users for all tenants of your system (page 38). Users can also be
manages using the Administration's command line tools (page 52).
If you are about to manage users within the Administration please make sure to have the ARIS
Risk & Compliance Manager Server reconfigured (page 77) and that you have forced ARIS
Publisher Server to use the specific Administration (page 111).
Administrators must perform these actions in order to allow access to ARIS:
1. Change the passwords of the superuser user and the system user. (page 40)
2. Import the license if it has not been imported during the setup process. (page 40)
3. Create users (page 41) or import (page 42) them from the LDAP system.
4. Create user groups (page 42) or import (page 42) them from the LDAP system.
5. Assign users to user groups. (page 43)
6. Assign privileges. (page 43)
Further information is available in the <:admin>'s online help (<User name> > Help).
All users and user groups managed in the Administration are available in every existing or future
database of this tenant. In each database product specific privileges must be assigned in ARIS
(page 44). To do so, please also refer to the ARIS online help chapter Manage users.
38
Server Installation and Administration Guide
While creating a database all users and user groups are imported from the Administration. To
control data access and role specific actions administrators need to assign privileges and filters
for each database. The server LOCAL can only be used by the system user.
Please make sure to have managed users and licenses before you manage users in ARIS.
These actions can be performed by all users holding the function privileges Database
administrator and User management.
1. Create databases (page 44).
2. Assign database specific privileges and filters. (page 44)
3. Provide the URL <IP. address or fully-qualified host name>/#<Tenant>/home, e.g.
http://aris.connect.sag/#default/home to all users using ARIS Connect.
All authorized users have access to licensed ARIS products.
Privileges and filters must be assigned for each additional database.
Procedure
1. Click the link localhost/umc or <IP address or fully-qualified host name>/umc. The
login dialog of the Administration opens.
2. Enter the user name superuser and the password superuser.
3. Select the tenant.
4. Click Log in.
The Administration opens.
39
Server Installation and Administration Guide
2. Click User management, and select Users. The list of users is displayed.
3. Enter superuser into the search box. The search result is shown.
4. Click superuser. The user data (details) is displayed.
5. Click Edit.
6. Enable the Change password check box. The Password and Confirm password boxes are
displayed.
7. Enter a new password, and reenter it. If you want to use the webMethods integration,
passwords may not contain a colon.
8. Click Save.
9. Change the system user's password too
The passwords is changed. The users receive e-mail notifications.
2. Click Licenses.
3. Click Import license file. The Upload license file dialog opens.
4. Select the relevant license file.
5. Click Upload. The license file is transferred. If an ARIS Design Server license is imported
instead of an ARIS Connect license, ARIS Connect functionality will not available.
If you need additional license keys later, simply import the new license file as described above. To
display imported license files, click the relevant license, and select Open license file.
40
Server Installation and Administration Guide
2. Click User management, and select Users. The list of users opens.
41
Server Installation and Administration Guide
2. Click User management, and select Users groups. The list opens.
2. Click User management, and select Users or User groups. The list of users or user
groups is displayed.
4. Click Start LDAP import. The button is active only if an LDAP system is configured on the
server.
5. Select the filter.
6. Click OK.
The users or user groups are transferred from the LDAP system according to the selected filter.
42
Server Installation and Administration Guide
7. Click Save.
The users are assigned to the user group.
2. Click User management, and select Users or User groups. The list opens.
3. Select an item. The detail view is displayed.
4. Click Privileges > Function privileges.
Function privileges define the role of a user or a user group as they control the actions a user
can perform. The current assignment is displayed.
5. Enable the check boxes of the function privileges to be assigned.
6. Click License privileges. License privileges define the set of ARIS products and views a user
can log into. The current assignment is displayed.
7. Enable the check boxes of the license privileges to be assigned.
The user/user group holds the selected set of privileges. If users have assigned a privilege
directly and via associated user groups, this is detected automatically so that the user only uses
one license.
Database specific function privileges (page 49) must be assigned for each database (page 44).
43
Server Installation and Administration Guide
3. Click Navigation in the bar panel if the Navigation bar is not activated yet.
4. In the Explorer tree, click your connection to the ARIS Server and select New >
Database.
5. Enter a name. Do not use any special characters.
6. Enable the Versionable check box if you want the content of the new database to be
versioned.
7. Click OK. The database is created and displayed in the Navigation bar, either as a
non-versionable or versionable database.
All users and user groups are automatically transferred from the Administration.
3. Click Navigation in the bar panel if the Navigation bar is not activated yet.
5. In the table, right-click the user or user group, and select Properties.
44
Server Installation and Administration Guide
6. Click Access privileges on the Selection tab. Access privileges regulate individual access to
each database.
7. Select the users/user groups for which you want to assign privileges. You can assign Read (r),
Write (w), and Delete (d) access privileges. The Version (v) access privilege is available for
versionable databases only.
8. Select the required access privileges in the Privileges field.
9. If you click the Pass on privileges button, the privileges selected in the Privileges box are
applied to all subgroups. This also applies to all new subgroups created below this group in the
future.
10. Click Function privileges on the Selection tab. For users to be able to perform certain
actions, they need the corresponding function privileges in each database. You can assign
function privileges via user groups, as well.
11. In the Assign column, click the relevant function privileges.
Users holding the Administration's Database administrator function privilege will become
system users in every database. They hold all function privileges of a database and can access
all database groups.
12. You cannot change function privileges for system users. Only system users can check the
System user check box. This user has all function and access privileges.
13. Click Method filter on the Selection tab. Filters enable users to log in with a particular filter to
only provide them with the needed ARIS method content.
14. In the Assign column, click the relevant filters.
15. Click OK.
The selected privileges and filters are assigned. Users can now log in.
Privileges and filters must be assigned for each additional database.
45
Server Installation and Administration Guide
46
Server Installation and Administration Guide
47
Server Installation and Administration Guide
48
Server Installation and Administration Guide
RCM administrator
Run the semantic check reports, export and import scripts relevant for ARIS Risk &
Compliance Manager in ARIS, and manage ARIS Risk & Compliance Manager.
Server administrator
Manage the Design server component ofARIS Connect Server or ARIS Design Server.
Script administrator
Manage the tenant's report scripts and macros.
Technical configuration
Configure the system, e.g., LDAP, SMTP, and import and export configuration files in
Administration, as well as manage documents.
49
Server Installation and Administration Guide
Database management
Users with this function privilege can:
edit database attributes
create, modify and delete languages
Database export
Users with this function privilege can:
transfer database content to other databases (merge)
export and import database content.
Method changes
Users with this function privilege can change the color or line weight of objects in models by
changing the Fill color, Line color, Line style, and Weight boxes on the Format >
Representation > Object appearance page.
As a result, only the appearance of this object occurrence differs from the default appearance
defined in the ARIS Method.
To change the ARIS Method you need the configuration and method management
privilege.
Prefix management
Users with this function privilege can manage database prefixes and change this attribute for
all database items for which they have the Write access privilege.
Prefixes of a database are managed on the Administration tab on the Identifier properties
page. By assigning a particular prefix to a user, you can identify the users who have created
database items.
Font format management
Users with this function privilege can create, change, or delete font formats in the database on
the Administration tab.
Lock permanently
Users with this function privilege can lock group content, objects, and models during Release
Cycle Management. Permanently locked database items are displayed, but they can only be
edited by the user who locked them. This user and system users can remove the lock.
Attribute formatting
Users with this function privilege can format attributes.
Report automation
Users with this function privilege can run reports as scheduled reports. The group Scheduled
reports is displayed in the Explorer tree.
50
Server Installation and Administration Guide
5 Customizing
This chapter provides information on configuring your system. For information about hardware
and software requirements, please refer to the ARIS Platform Matrix document (see
installation media or download it
http://aris.softwareag.com/ARISDownloadCenter/ADCDocumentationServer).
After the installation you may need to customize the system.
If you use standard license without extension packs the system will work without customization.
For some extension packs, e.g. for Process-Driven Management for SAP® Solutions (page 124)
you must customize ARIS depending on the functionality to be provided. You can also change
settings entered during the setup process using the administration tools (page 51).
After you have customized the system administrators need to create users and user groups in the
Administration and assign privileges and licenses (page 51).
5.1.1 Administration
The Administration is a tool to manage users, user groups, privileges, licenses, documents, and
configurations for each tenant (page 37) of all ARIS products. This ensures the single sign-on for
various ARIS products. Users can also be created using an LDAP system. Administration is
available for users holding the User management and License management function
privilege. After the installation only the administrators superuser or system can login.
ARIS also provides a set of command-line tools (page 52) that can be used to perform
administrative operations.
51
Server Installation and Administration Guide
52
Server Installation and Administration Guide
Procedure
1. Open a command prompt (Start > Run > cmd).
2. Type y-password.bat <option> <password>
3. Cut the encrypted password and paste it to your configuration file.
There will be the following output:
[CLI] Setting verbosity level... [VALUE: 0=OFF]
[CLI] Plain: <password>
[CLI] Encrypted: f4a28327ad2f0c87336dd74fe0a70c39
General usage
Options Description
-?, -h, --help Show help
Default: false
Commands Description
encrypt encrypts the password
Example
Input
y-password.batl encrypt aris
Output
[CLI] Setting verbosity level... [VALUE: 0=OFF]
[CLI] Plain: aris
[CLI] Encrypted: f4a28327ad2f0c87336dd74fe0a70c39
53
Server Installation and Administration Guide
Prerequisites
ARIS Connect Server Installation
Users need the function privileges license management, user management, user
management configuration.
ARIS Design Server Standalone Installation
Users need to login as superuser or they need either an ARIS Architect license or an ARIS
UML Designer license. For local systems they need to login as system user system.
Procedure
1. Open a command prompt (Start > Run > cmd).
2. Type y-tenantmgmt.bat without parameters to display the help.
General usage
Options Description
-?, -h, --help Show help, default: false
54
Server Installation and Administration Guide
55
Server Installation and Administration Guide
After creating a tenant, you have to import the relevant license and create the users. You can do
so from command line or via graphical user interface Administration.
It is recommended to change the password of the default user system immediately after the
installation.
Example
The following line creates a tenant with name Test. Please pay attention to the order.
y-tenantmgmt.bat -s http://my_aris_host.com -t test createTenant -u system -p manager
The following line creates a new tenant with name test01 and initial system user password abc.
Please pay attention to the order.
y-tenantmgmt.bat -s http://my_aris_host.com -t test01 createTenant -u system -p
manager -systemp abc
The following line prints information of the default tenant.
y-tenantmgmt.bat -s http://my_aris_host.com -t default getTenant -u system -p manager
56
Server Installation and Administration Guide
57
Server Installation and Administration Guide
Procedure
1. Open a command prompt (Start > Run > cmd).
2. Type y-ldapsync.bat -s <http://host_url> -t <tenant name> <command> -u <user
name> -p <password>
Users are synchronized or imported from an LDAP system.
General usage
Options Description
-?, -h, --help Show help
-s, --server URL of the server, URL of the server, e.g. http://my_host_url
Commands Description
importUsers Imports users from an LDAP system, the spelling is case sensitive.
importGroups Imports a hierarchy from an LDAP system, the spelling is case sensitive.
syncUsers Synchronizes existing users with an LDAP system, the spelling is case
sensitive.
syncGroups Synchronizes existing groups with an LDAP system, the spelling is case
sensitive.
Example 1
y-ldapsync.bat -s http://my_aris_host.com -t default importUsers -u system -p manager -f
(cn=userID)
[CLI] Setting verbosity level... [VALUE: 0=OFF]
[CLI] Importing users... [TENANT: 30ff3081-aa9e-33e7-a7d7-5f9d00ae89ee, FILTER:
(cn=userID)]
58
Server Installation and Administration Guide
Example 2
Import all users from an LDAP system.
y-ldapsync.bat -s http://my_aris_host.com -t default importUsers -u system -p manager -f
(cn=*)
Procedure
1. Open a command prompt (Start > Run > cmd).
2. Type y-datadump.bat -s <http://host_url> -t <tenant name > <command> -u
<user name> -p >password> -f <dump file>
In this case, there is a dump file written that contains the database content. There will the
following output:
[CLI] Setting verbosity level... [VALUE: 0=OFF]
[CLI] Exporting data... [TENANT: 30ff3081-aa9e-33e7-a7d7-5f9d00ae89ee, FILE: C:\out.zip]
[CLI] Data successfully exported. [TENANT: 30ff3081-aa9e-33e7-a7d7-5f9d00ae89ee]
General usage
Options Description
-?, -h, --help Show help
-s, --server URL of the server, URL of the server, e.g. http://my_host_url
59
Server Installation and Administration Guide
Commands Description
export Exports all data of the specified tenant to a data dump file. Currently, a dump
contains the following information:
tenant
users
groups
user-group assignments
profile pictures (optional)
permissions, dependent on the privileges of the user who enters the
command
licenses, dependent on the privileges of the user who enters the command
configuration, dependent on the privileges of the user who enters the
command
The data is stored in JSON format and packed into an encrypted ZIP file. The
ZIP file can be restored using the same command line tool.
migrate Migrates data from central user management version 1.x to version 2.x. A
dump file is used to perform this migration.
Example
In this example, data are exported into a dump file.
y-datadump.bat -s <http://host_url> -t default export -u system -p manager -f out.zip
60
Server Installation and Administration Guide
61
Server Installation and Administration Guide
UNKNOWN
The component state is not yet known. This state is shown directly after the agent was
started.
STOPPED
The component is currently not running.
STARTING
The component is starting, but this process is not complete yet.
STARTED
The component is running.
STOPPING
The component is stopping, but this process is not complete yet.
DOWN
This component has and crashed. The agent will attempt to automatically restart the
component momentarily.
FAILED
Component has crashed. The agent has given up trying to restart the component.
If a component does not start properly please read the Basic Troubleshooting chapter
(page 156).
62
Server Installation and Administration Guide
This table lists all components run by ARIS Design Server (Design), ARIS Connect Server
(Connect), ARIS Risk & Compliance Manager ( ARCM), ARIS Publisher Server (Publisher) and the
locally installed server installed by the ARIS Client Setup (LOCAL) for a medium number of users
installation. That's why all instanceIds end with _m. Installations for a small or a large number of
users are typified with _s or _l.
Components run by the server LOCAL are not accessible by ACC. This server is only available in
combination with ARIS Client installations.
postgresECP_m Collaboration x
database
umcadmin_m Administration x x x x
simulation_m Simulation x x x
63
Server Installation and Administration Guide
If you run ARIS on a laptop (8 GB) for demonstration reasons you might stop components you do
not need (page 78) to ensure more memory for the system.
Procedure
1. Start ARIS Cloud Controller (ACC) (page 61).
2. Enter reconfigure <instanceId> +JAVA-Xmx="<amountOfMemory>".
The affected components will be started after the settings have been updated.
Examples
reconfigure abs_s +JAVA-Xmx="1024m"
The memory settings for the modeling component of an s installation will be increased to max.
1024 MB (32 bit).
reconfigure abs_m +JAVA-Xmx="1G"
The memory settings for the modeling component of an m installation will be increased to
1GB.
reconfigure apg_m +JAVA-Xmx="2G"
The memory settings for the governance component of an m installation will be increased to
2GB.
64
Server Installation and Administration Guide
To use SSL you need to get a valid certificate signed by a certificate authority (CA) for the server
on which the load balancer is running. Please make sure that the certificate is compatible with the
Java version of all ARIS clients.
You can buy a certificate from an official CA. Most clients in particular browsers will trust
certificates signed by such a CA.
If your company uses own CA get a certificate from this CA and add this CA to the trust store
of all clients.
Your certificate should consist of two parts the private key used to encrypt information sent back
to the client (file extension .key) and the server certificate (file extension .crt).
1. Put these two files into a ZIP file.
2. Copy this ZIP file to a location that can be accessed by ARIS Cloud Controller (ACC).
3. Start the ACC (page 61).
4. Stop (page 64) the component load balancer.
5. Enter the ACC command enhance <instanceID of the load balancer component> with
sslCertificate local file "<path to the ZIP file>".
If the instanceID of the load balancer is loadbalancer_m and your certificate ZIP file is
located at c:\temp\lbcert.zip enter the ACC command enhance loadbalancer_m with
sslCertificate local file "c:\\temp\\lbcert.zip".
Notice the double backslashes. Alternatively, use single forward slashes, e. g.
"c:/temp/lbcert.zip".
65
Server Installation and Administration Guide
Procedure
1. Start ARIS Cloud Controller (ACC) (page 61).
2. Relative to your Linux system you need to redirect different ports one after another.
Enter the commands using the following syntax:
iptables -t nat -A PREROUTING -i eth0 -p tcp --dport <port number to redirect> -j
REDIRECT --to-ports <port number>
This example redirects port 80 to port 1080.
iptables -t nat -A PREROUTING -i eth0 -p tcp --dport 80 -j REDIRECT --to-ports
<1080>
3. Redirect other ports.
4. Enter startall.
ARIS components run using the redirected ports.
If components do not start up properly, please resolve possible port conflicts (page 157).
66
Server Installation and Administration Guide
Procedure
1. Start ARIS Cloud Controller (ACC) (page 61).
2. Change the password:
set password = "<enter the new password>"
3. Restart ACC. The Password has been changed.
4. If you use the start icon for ARIS Cloud Controller (Start > All Programs > ARIS >
Administration > ARIS Cloud Controller) please also change the password command line
parameter within the ACC shortcut:
If you run an ARIS Server setup after you have changed the default password please use the
option Enter changed remote access password and enter the new password.
If you run an update setup (page 32) please change the password to G3h31m before starting the
update.
67
Server Installation and Administration Guide
Prerequisites
If you do not use the standard database system, please make sure to create additional schemes
in your Oracle (page 21) or Microsoft SQL database management system (page 24) and you have
assigned the tenants (page 74) to these schemes.
Procedure
1. Start ARIS Cloud Controller (ACC) (page 61).
2. Enter:
create tenant <tenant name>
e. g.:
create tenant test01
The tenant test01 will be created.
3. The administrator must import licenses, create users and user groups and assign privileges
and licenses (page 51) for the test01 tenant.
4. Start a ARIS client and log in using this tenant. The syten database will be created for that
tenant.
The tenant is created and can be backed up (page 69).
68
Server Installation and Administration Guide
Scheduled reports as well as ACC enhancements concerning SSL, SAP® JCo and ODBC drivers
will not be backed up.
Prerequisites
ARIS Connect Server Installation
Users need the function privileges license management, user management, user
management configuration and database administration.
ARIS Design Server Standalone Installation
Users need to login as superuser or they need either an ARIS Architect license or an ARIS
UML Designer license and the database administration function privilege. For local
systems they need to login as system user system.
Make sure to have been logged into an ARIS client using this tenant.
Procedure
1. Start ARIS Cloud Controller (ACC) (page 61).
2. Enter
backup tenant <Tenant Id> to <pathToBackUpFile> username=<Superuser of the
Administrator> password=<Superuser password>.
The backup is started. The complete backup is written to one single zip file.
You can restore (page 70) this tenant using this file. Using the restore tenant command will
copy the content to an existing tenant.
You can manage tenants also using the Administration's command line tools (page 53).
69
Server Installation and Administration Guide
Scheduled reports as well as ACC enhancements concerning SSL, SAP® JCo and ODBC drivers
will not be restored.
Please note that all current data of a running tenant are deleted and replaced by the data of the
backup file and that no user can work on this tenant during the restore process.
Prerequisites
You need access to the relevant back-up zip file
ARIS Connect Server Installation
Users need the function privileges license management, user management, user
management configuration and database administration.
ARIS Design Server Standalone Installation
Users need to login as superuser or they need either an ARIS Architect license or an ARIS
UML Designer license and the database administration function privilege. For local
systems they need to login as system user system.
Procedure
1. Start ARIS Cloud Controller (ACC) (page 61).
2. Enter
restore tenant <Tenant Id> from <pathToBackUpFile> username=<Superuser of the
Administrator> password=<Superuser password>.
The tenant will be restored.
Current data will be deleted and replaced. No user can work with this tenant during the restore
process.
You can manage tenants also using the Administration's command line tools (page 53).
70
Server Installation and Administration Guide
Scheduled reports as well as ACC enhancements concerning SSL, SAP® JCo and ODBC drivers
will not be copied.
Prerequisites
You need access to the relevant back-up zip file
ARIS Connect Server Installation
Users need the function privileges license management, user management, user
management configuration and database administration.
ARIS Design Server Standalone Installation
Users need to login as superuser or they need either an ARIS Architect license or an ARIS
UML Designer license and the database administration function privilege. For local
systems they need to login as system user system.
Procedure
1. Create a tenant (page 68) on the ARIS server where the tenant will be copied to and import
the licenses (page 51).
2. Start ARIS Cloud Controller (ACC) (page 61).
3. Enter:
restore tenant <Tenant Id> from <pathToBackUpFile> username=<Superuser of the
Administrator> password=<Superuser password>.
All data of the backup file will be copied to the new tenant. Current data will be deleted except the
name of the new tenant.
No user can work with this tenant during the restore process.
You can manage tenants also using the Administration's command line tools (page 53).
71
Server Installation and Administration Guide
Prerequisites
ARIS Connect Server Installation
Users need the function privileges license management, user management, user
management configuration and database administration.
ARIS Design Server Standalone Installation
Users need to login as superuser or they need either an ARIS Architect license or an ARIS
UML Designer license and the database administration function privilege. For local
systems they need to login as system user system.
Procedure
1. Back up (page 69) the tenant in order to restore (page 70) data.
2. Start ARIS Cloud Controller (ACC) (page 61).
3. Enter:
delete tenant <Tenant Id> username=<Superuser of the Administrator>
password=<Superuser password>.
Deletes the specified tenant and all its associated data from the system. User name and password
of an administrative user have to be specified using the parameters master.tenant.user.name
and master.tenant.user.pwd, respectively.
If the optional force keyword is used, the security question Are you sure? is overridden, i.e., the
tenant and its data is deleted without further notice.
You can manage tenants also using the Administration's command line tools (page 53).
72
Server Installation and Administration Guide
Prerequisites
ARIS Connect Server Installation
Users need the function privileges license management, user management, user
management configuration and database administration.
ARIS Design Server Standalone Installation
Users need to login as superuser or they need either an ARIS Architect license or an ARIS
UML Designer license and the database administration function privilege. For local
systems they need to login as system user system.
Procedure
1. Start ARIS Cloud Controller (ACC) (page 61).
2. Enter
invoke updatesystemdb on abs_<s, m or l> tenant.name=<tenant name>
tenant.user.name=superuser tenant.user.pwd="<superuser's password>"
The system database of this tenant will be updated and migrated.
Prerequisites
ARIS Connect Server Installation
Users need the function privileges license management, user management, user
management configuration and database administration.
ARIS Design Server Standalone Installation
Users need to login as superuser or they need either an ARIS Architect license or an ARIS
UML Designer license and the database administration function privilege. For local
systems they need to login as system user system.
Procedure
1. Start ARIS Cloud Controller (ACC) (page 61).
2. Enter
invoke maintainAll on abs_<s, m or l> tenant.name=<tenant name>
tenant.user.name=superuser tenant.user.pwd="<superuser's password>"
73
Server Installation and Administration Guide
After you have created an empty Oracle (page 24) or Microsoft SQL (page 21) schema for an
additional tenant the tenant must be assigned to the database schema.
1. Start ARIS Cloud Controller (ACC) (page 61).
2. Discover the database db service ID (<dbserviceID>):
list external services
3. Assign a tenant to the additional schema:
assign tenant <tenant name> to service <dbserviceID> com.aris.cip.db.schema
=<schema name>
Please make sure to enter the tenant name in lower-case characters only.
4. Create the new tenant:
create tenant <tenant name>
The new tenant is available on ARIS Design Server. If you are about to use this tenant on a ARIS
Connect Server, you must create the technical user and assign the tenant to the administration
service.
Create the technical user and assign the tenant to the service
To make this tenant available on a ARIS Connect Server you must create the technical user and
assign the tenant to the Administration service.
1. you must create the technical ARIS user:
enhance umcadmin_<s, m or l> with createUser trigger only options
tenant.name=<tenant name> tenant.user.name=superuser
tenant.user.pwd=<superuser's password>
affected.user=aris_tech_user_ecp_<tenant name> affected pwd=<tenant name>
as.technical.user=true
2. Assign the tenant to the Administration service:
assign tenant <tenant name> to service umc<dbserviceID>
ecpTechnicalUserName=aris_tech_user_ecp_<tenant name>
ecpTechnicalUserPassword=<tenant name>
The new tenant is available on ARIS Connect Servers.
Additional Settings
To enable validationQuery for external DB connections (Oracle & Microsoft SQL) please use the
correct validation query for the DBMS.
For Oracle use:
"select 1 from dual"
For Microsoft SQL use:
74
Server Installation and Administration Guide
"select 1"
During registration of external service add parameters e. g. for Oracle:
validationQuery="select 1 from dual" testOnBorrow=true,
register external service db
url="jdbc:oracle:thin:@<target_host>:<target_port>:<target_service_name>"
driverClassName="oracle.jdbc.OracleDriver" username="<cip_app_user>"
password="<cip_app_pwd>" maxIdle=15 maxActive=100 maxWait=10000
removeAbandoned=false removeAbandonedTimeout=600 logAbandoned=true
defaultAutoCommit=false rollbackOnReturn=true host=<target_host>
port=<target_port> jmxEnabled=true validationQuery="select 1 from dual"
testOnBorrow=true
After the external service was already registered, e .g. for Oracle, update the external service
<dbserviceID>
url="jdbc:oracle:thin:@<target_host>:<target_port>:<target_service_name>"
driverClassName="oracle.jdbc.OracleDriver" username="<cip_app_user>"
password="<cip_app_pwd>" maxIdle=15 maxActive=100 maxWait=10000
removeAbandoned=false removeAbandonedTimeout=600 logAbandoned=true
defaultAutoCommit=false rollbackOnReturn=true host=<target_host>
jmxEnabled=true validationQuery="select 1 from dual" testOnBorrow=true
75
Server Installation and Administration Guide
76
Server Installation and Administration Guide
77
Server Installation and Administration Guide
To set the auto-start flag true e.g. for the component zoo_l you need to enter:
set zoo_s property autostart=true
Use the show instance command do see the current setting:
ACC+ n1>show instance zoo_l
ID: zoo_s state:STARTED
type:com.aris.runnables.zookeeper-run-prod-1.0.0-RC17-Trunk-SNAPSHOT)
Configuration parameters:
clientPort=2181
myid=1
server=sbrvblulinsrv01:2888:3888, sbrvblulinsrv02:2888:3888
78
Server Installation and Administration Guide
This example of ACC commands turns auto-start in ACC off (is a default setting by setup). Then
auto-start is turned on only for essential components and turned off for unneeded components:
set autostart.mode=autostart.flag
set zoo_l property autostart="true"
set postgres_l property autostart="true"
set postgresECP_l property autostart="true"
set couchdb_l property autostart="true"
set cloudsearch_l property autostart="true"
set elastic_l property autostart="true"
set adsadmin_l property autostart="true"
set umcadmin_l property autostart="true"
set loadbalancer_l property autostart="true"
set abs_l property autostart="true"
set apg_l property autostart="false"
set copernicus_l property autostart="true"
set octopus_l property autostart="false"
set ecp_l property autostart="true"
set simulation_l property autostart="false"
Important to know is that the above behavior only works when the ARIS agent is starting
(Windows Service). So you need to enter stopall and restart ARIS agent (Windows Service) to
see the effect.
Please note that startall overrules all of the above changes, hence, starts all components. This is
an advantage to quickly get the full scope again.
You can also run ARIS Connect Server start up as ARIS Design Server:
Auto-start is turned on only for 13 components of ARIS Design Server:
set autostart.mode=autostart.flag
set zoo_l property autostart="true"
set postgres_l property autostart="true"
set postgresECP_l property autostart="false"
set couchdb_l property autostart="true"
set cloudsearch_l property autostart="true"
set elastic_l property autostart="true"
set adsadmin_l property autostart="true"
set umcadmin_l property autostart="true"
set loadbalancer_l property autostart="true"
set abs_l property autostart="true"
set apg_l property autostart="true"
set copernicus_l property autostart="true"
set octopus_l property autostart="true"
set ecp_l property autostart="false"
set simulation_l property autostart="true"
79
Server Installation and Administration Guide
80
Server Installation and Administration Guide
set remote.repository.url="http://something.com/repo"
You should enter:
When starting ACC in one of the three usage modes without any additional command line
parameter, it will by default not have any connection to any cloud node. There are three options
to specify nodes you want to control with ACC:
You can use the add node command to put the individual cloud nodes under ACC's control.
Alternatively, you can list all your cloud nodes in a node file and pass this file to the ACC with
the \-n (or --nodefile) command line option.
If you only want to connect to a single node and issue commands there, you can also use the
ACC's -h (or --host) command line option to directly specify the host or IP name of the node
you want to control with ACC.
81
Server Installation and Administration Guide
If <Command> is specified, ACC is started in command mode (i.e., only the command passed on
the command line is executed ACC will exit afterwards).
Syntax
acc <parameters> [<Command>]
-f, --file Relative or Use this parameter to start ACC in batch mode, executing
absolute path to the commands in the given command file.
a command file. Put the path in double quotes if the path contains any
whitespaces.
-s, --silent - (toggle) When using ACC in batch mode, this switch enables silent
Default = off mode, i.e., the output of the commands is suppressed.
-h, --host String (IP or The host name or IP address of the single cloud node on
Hostname) which you want to issue commands. ACC is invoked with an
implicit add node command using the given host name
followed by a set current node command. The logical node
name used is the first part of the host name if a host name
was used as parameter, or the first part of the host name
determined by a reverse name lookup if an IP address was
used as parameter.
-p, --port Positive integer The port of Acc's REST API on the single cloud node on which
1 - 65535 (Port) you want to issue commands, see -h switch.
Default=9000
82
Server Installation and Administration Guide
-pwd, The password to Used to specify the password to use when connecting
--password use when directly to an agent with enabled authentication using the -h
connecting command-line option *. * If a user name is specified (with
directly to an -u) but this option is not given, ACC will prompt you for the
agent with the -h password.
option.
-n, --nodefile Relative or File containing the list of nodes that are part of this cloud.
absolute path to Allows factoring out of node-specific infos (i.e., host
a node file. names/IPs and ports) of the template, thereby making
templates reusable in different environments without any
editing.
Put the path in double quotes if it contains any whitespace.
Two formats are supported: The old format, where every
node is given on a separate line using the syntax
<nodeName>=<ipOrHostName> ['@' <agentPort>]
or the new format, where the file only contains add node
commands.
-ig, - (toggle) If set, processing of a command file will continue even if one
--ignore-error Default=off of the contained commands fails.
s
83
Server Installation and Administration Guide
ACC Commands
In addition a number of special commands exist when using the ACC in interactive mode.
Commands can optionally be prefixed with a node specification (on [node] <nodeName>)
referred to as <nodeSpec> in the syntax description of the commands (page 95) to send them to
a node other than the current node.set current node
Add node Registers a new cloud node with the given IP or hostname
Add node <nodeName> node with ACC under the given logical node name. Allows to
<ipOrHostName> (@ optionally specify the port of the REST API of this node's
<agentPort>)? (<username>
<password>?)? agent if it isn't using the default.
remove node Deregisters the cloud node with the given logical node name.
remove node <nodeName>
add zk instance Adds a new zookeeper (ZK) instance to the cloud's zookeeper
<nodeSpec>? add (zk| ensemble on the specified node or to the current node, if no
zookeeper) (master| node name is specified. Allows to optionally specify the
observer)? instance? (using
instanceId? <instanceId>)? instanceId to be used for the new zookeeper instance. If none
is specified, ACC will automatically choose an instanceId.
Note that the change is not submitted directly, but only with
the separate commit zk changes command.
84
Server Installation and Administration Guide
configure Configures a new runnable with the given group ID, artifact
<nodeSpec>? configure ID, and version using the given instance ID. Configuration
<groupId>.<artifactId> parameters can be specified as key-value pairs (or list of
<version> <instInstancId>
(<key> <value> (, <value>)*)* comma-separated values). Values can be either Integers,
(enhance with <enhancement> identifiers (i.e., strings starting with a letter or the
(, <enhancement>)*)?
underscore character ('_'), and containing only letters, digits,
dashes ('-') or the underscore character ('_')), or Strings
(i.e., arbitrary sequences of characters, delimited by
double-quotes ('')). Further, enhancements can be specified.
85
Server Installation and Administration Guide
show instance Shows details of the configuration of the runnable with the
<nodeSpec>? show (runnable | given instance ID on the specified node (or the current node,
instance) <instanceId> (cfg | if no node name is specified).
config | configuration)
86
Server Installation and Administration Guide
startall Starts all runnables on the specified node (or the current
<nodeSpec>? startall node, if no node name is specified) that are not currently in
STARTED or STARTING state.
stopall Stops all runnables on the specified node (or the current
<nodeSpec>? stopall node, if no node name is specified) that are currently in
STARTED state.
killall Kills all runnables on the specified node (or the current node,
<nodeSpec>? killall if no node name is specified) that are currently not in
STOPPED or DOWN state.
87
Server Installation and Administration Guide
restart agent Restarts the agent on the specified node (or the current node,
<nodeSpec>? restart agent if no node name is specified).
show agent Shows the configuration parameters of the cloud agent on the
<nodeSpec>? show agent (cfg | specified node (or the current node, if no node name is
config | configuration) specified).
set agent Sets the specified configuration parameter of the cloud agent
<nodeSpec>? set <key> <value> on the specified node (or the current node, if no node name is
(, <value>)* specified) to the given value (or list of comma-separated
values). Values can be either Integers, identifiers (i.e.,
strings starting with a letter or the underscore character ('_'),
and containing only letters, digits, dashes ('-') or the
underscore character ('_')), or Strings (i.e., arbitrary
sequences of characters, delimited by double-quotes ('')).
get agent param Gets the specified configuration parameter of the cloud agent
<nodeSpec>? get <key> on the specified node (or the current node, if no node name is
specified).
set current node Sets the node with the given node name as the cloud
set current node <nodeName> controller's current node, i.e., the which is used for all
commands without an explicitly specified node.
on [node] <nodeName> Commands can optionally be prefixed with a node
specification referred to as <nodeSpec> in the syntax
description of the commands to send them to a node other
than the current node.set current node
88
Server Installation and Administration Guide
register app type Allows to register a runnable (i.e., a specific group and
register (app | application ) artifact ID) in a specific version under a logical name, the
type <appTypeId> application type ID. The application type ID can later be
<groupId>.<artifactId>
<version> <portSpec>* referenced in configure commands to more conveniently
(defaults (<key> <value> ( , configure a new instance of this runnable.The command also
<value>)*)+ )?
allows to specify default configuration parameters which are
added to the configure command of any runnable of that
application type that is later configured.Further, it is possible
to add port specifications, telling the agent which parameters
of the runnable represent network ports.
deregister app type Removes the registered application type with the given
deregister (app | application application type ID.
) type <appTypeId>?
list app instances Lists all instances of the specified application type across all
list (app | application) type nodes.
<appTypeId> instances?
list app types Lists all registered application types.
list (app | application)
types
show controller Shows the current value of all ACC configuration parameters.
show (acc | controller) (cfg
| config)
set controller Sets the ACC configuration parameter <key> to the given
set (acc | controller) (cfg | <value>.
config) <key> <value> ( ,
<value>)*
get controller cfg parameters Gets the value of the ACC configuration parameter <key>.
get (acc | controller) (cfg |
config) <key>
89
Server Installation and Administration Guide
backup tenant Performs a backup of all data of the specified tenant to the
backup tenant <tenantId> (to specified location. A user name and password of a user in the
<path>)? (<key> <value> (, respective with sufficient administrative privileges in all
<value>)*)*
applications needs to be specified using the parameters
username and password, respectively. If the target path
specified is an existing directory, the name of the backup file
will be generated automatically and put into this directory. If
the target path is an existing file, the user will be required to
confirm overwriting of this file. If the directory of the target
file does not exist, it will be created.
restore tenant Performs a restore of all data of the specified tenant from a
restore tenant <tenantId> file in the specified location. A user name and password of a
from <path> (<key> <value> (, user in the respective with sufficient administrative privileges
<value>)*)*
in all applications needs to be specified using the parameters
user name and password, respectively.
delete tenant Deletes the specified tenant and all its associated data from
delete tenant <tenantId> the system. User name and password of an administrative
user have to be specified using the parameters
master.tenant.user.name and
master.tenant.user.pwd, respectively.
Warning: If the optional force keyword is used, the security
question Are you sure? is overridden, i.e., the tenant and its
data is deleted without further notice. force?
90
Server Installation and Administration Guide
unassign tenant from service Removes the existing service-to-tenant assignment between
unassign tenant? <tenantId> the service with the specified <serviceId> and the tenant
from service? <serviceId> with the given <tenantId>.
set tenant data Allows to set (or unset) tenant data for the specified tenant,
set tenant <tenantId> data optionally for the specified application or service type.Tenant
(for (app | application | data is a set of key-value pairs that is stored individually for
services) (<serviceType> |
<appType>))? (+? <key> each tenant for a specific application or service type using the
<value> (, <value>)* | - optional for application or for service clause, respectively, or
<key>)*
independently from a specific application or service type by
omitting this clause. Several key-value pairs can be
specified in one command. Any already existing value for a
specified key is overwritten with the new value. By prefixing a
key with -, any value already set for that key can be unset.
Any key-value-pair that is not explicitly set or unset will
remain unchanged.
get tenant data Allows to get the value for the tenant data item with the
get tenant <tenantId> data specified key for the specified tenant, optionally for a specific
(for (app | application | application or service.Tenant data is a set of key-value pairs
services) (<serviceType> |
<appType>))? <key> that is stored for individually for each tenant a specific
application or service type using the optional for application
or for service clause, respectively, or independently from a
specific application or service type by omitting this clause.
show tenant data Displays all tenant data values for the specified tenant,
show tenant <tenantId> data optionally for a specific application or service.Tenant data is a
(for (app | application | set of key-value pairs that is stored individually for each
services) (<serviceType> |
<appType>))? tenant for a specific application or service type using the
optional for application or for service clause, respectively, or
independently from a specific application or service type by
omitting this clause.
91
Server Installation and Administration Guide
get system config Allows to get the system configuration value with the
get system (config | cfg | specified key.
configuration) <key>
show system config Displays all system configuration data values that are
show system (config | cfg | currently configured.
configuration)
register external service Registers an external service of a given service type (e.g.
register external? service external DBMS, SMTP server, HTTP proxy) with its
<serviceType> (<key> <value> configuration parameters within the system.
(, <value>)*)*
list external service Lists all external (or non-managed) services currently
list external? services registered with the system.
get runnable property Gets the specified property value of the specified runnable on
<nodeSpec>? get (runnable | the specified node (or the current node, if no node name is
instance)? <instanceId> specified).
property <key>
92
Server Installation and Administration Guide
register global enhancement Registers a new global enhancement with <ID>, i.e., an
register global? enhancement enhancement that will be added to all runnables configured
<ID> <enhancement> afterwards.
93
Server Installation and Administration Guide
zk ls Lists the children of the zookeeper node with the given path.
(zk | zookeeper) ls
<absoluteZookeeperPath>
zk get Retrieves the payload of the zookeeper node with the given
(zk | zookeeper) get path. The payload is displayed as a string, which makes this
<absoluteZookeeperPath> method unsuitable for binary payloads.
zk delete Deletes the zookeeper node with the given path. Deletion of
(zk | zookeeper) force? a node is only successful, if the node does not have any child
delete nodes.By using the force keyword, you can delete entire
<absoluteZookeeperPath>
subtrees.
zk update Changes the payload of the zookeeper node with the given
(zk | zookeeper) (set | path to the specified string. It is not possible to set binary
update) payloads with this command.
<absoluteZookeeperPath>
(payload <STRING> )?
zk dump Prints the entire zookeeper content to screen.
(zk | zookeeper) dump
94
Server Installation and Administration Guide
Absolute path
('/' | '\' | [A-Z] ':') <relativePath>
An absolute path starting with either a forward or backward slash (on Linux) or a file letter (on
Windows), where the individual path steps are separated by either forward or backward slashes.
Artifact enhancement
<groupId>.<artifactId> <version> (classifier <ID>)? type <ID>
Enhances a runnable with an artifact from the repository, by specifying the Maven-esque
groupdId, artifactId, version, type, and optionally the classifier, of the artifact.
Artifact file
file <key> <groupId> . <artifactId> <version> (classifier <classifier>)? type <type>
Uses an artifact from the repository as input for an invoke command, by specifying the
Maven-esque groupdId, artifactId, version, type, and optionally the classifier, of the artifact.
Enhancement point
<ID>
The name of the runnable's enhancement point to which to send the file and the optional
parameters to be used for enhancement.
ID
('a'..'z'|'A'..'Z'|'_') ('a'..'z'|'A'..'Z'|'0'..'9'|'_'|'-')*
An ID (identifier) is any string beginning with a letter or the underscore character (_), and
containing only letters, digits, the underscore character (_), or a dash character (-).
Integer
'-'? '0'..'9'+
A positive or negative Integer number.
Relative path
(<ID> | <STRING>) ( ('/' | '\') (<ID> | <STRING>))*
A relative path, where the individual path steps are separated by either forward or backward
slashes.
95
Server Installation and Administration Guide
Repository file
file <key> <relativePath>
Uses a file from the repository as input for an invoke command, by specifying the file's path
relative to the repository's root.
String
'' ( <any character but '\\' or '' )* ''
An almost arbitrary sequence of characters, delimited by double quotes. To represent certain
special characters, you can use the common escape sequence via the backslash character (\),
e.g., for newline, \\ for a backslash, \t for a tabulator, \ to obtain a double-quote as part of the
string's content, etc.
Please find the description of used syntax entries in alphabetical order:
<absolute ZookeeperPath>
Absolute zookeeper path
('/' | '\' ) <relativePath>
A path in zookeeper.
<agentPort>
Agent's Port number.
<appType>
Application type
umc | abs | ads | apg | ecp | cop | ...
A technical application type as defined by the zookeeper component.
<appTypeId>
Application type ID
<ID>
An application type ID is used to uniquely identify a registered application type on the cloud
controller. An application type ID can be any string without whitespace, starting with a letter or
underscore character (_), and containing only letters, digits, or underscore characters.
<artifactId>
Artifact ID
<ID>
The common Maven-esque artifact ID of the runnable.
96
Server Installation and Administration Guide
<enhancement>
Enhancement
<enhancementPoint> (<artifactEnhancement> | <fileEnhancement> |
<localFileEnhancement>) (options ( <key> <value> (, <value>)*)+ )?
Enhance a runnable with a file. There are two ways to specify the source file, as Maven repository
artifact or as repository file. Optionally, parameters can be specified that are passed to the
runnable's corresponding enhancement point.
<groupId>
Group ID
<ID> (. (<ID>|<INT>))+)
The common Maven-esque group ID of the runnable, i.e., a sequence of identifiers separated by
dots (.).
<instanceId>
Instance ID
<ID>
An instance ID is used to uniquely identify a runnable within one node. An instance ID can be any
string without whitespace, starting with a letter or underscore character (_), and containing only
letters, digits, or underscore characters.
<invocationFile>
Invocation file
<artifactFile> | <repositoryFile> | <accLocalFile>
Specifies a file to be used as input for the operation. The file can be specified using Maven artifact
coordinates (GAV), as a relative path to a file in one of the repositories known to the respective
agent, or as a file local to the machine on which the ACC is running.
<ipOrHostName>
IP address or fully qualified name of the server to be connected.
<key>
Key
<ID> (. (<ID> | <INT>))+
A key can be any identifier i.e. any string without whitespace, starting with a letter or underscore
character (_), and containing only letters, digits, or underscore characters or a dotted identifier,
i.e., a sequence of several identifiers integers as parts, separated by a . character, e.g.: ShortId,
ASimpleButLongerIdentifier12345, A.dotted.identifier.1
97
Server Installation and Administration Guide
<nodeName>
Node name
A node name is a unique logical name given to a node registered by ACC. It can be any string
without whitespace, starting with a letter or underscore character (_), and containing only letters,
digits, or underscore characters.
<nodeSpec>
Node specification
on <nodeName>
All zookeeper ensemble management, lifecycle and agent configuration commands can optionally
be prefixed with a node specification to send them to a node other than the current node or to
determine the node if no current node has been set.
<operation>
Operation
<ID>
The name of the operation to invoke.
<password>
Required user password. This might be the password of a remote access user (page 67), a
database user, the superuser or a system user.
<portSpec>
Port specification
port <key> (<INT> | <INT>:<INT>) (',' (<INT> | <INT>:<INT>))* (default <INT>)?
A port specification declares that a the configure parameter <key> represents a port (or is a port
parameter for short). Individual or ranges of ports that are reserved for this port parameter can
be specified. Further, a default can be declared, which indicates the port that is used by the
runnable if no explicit value is specified for this port parameter during configure.
<serviceId>
Service ID
<ID>
A service ID is used to uniquely identify a service. It is assigned automatically by the system when
the service is registered. It can be used to refer to a specific service for updating or deregistering
it.
98
Server Installation and Administration Guide
<serviceType>
Service type
db | smtp | proxy | postgresql-ecp | elasticsearch | rs | ...
A technical service type as defined by the zookeeper component. A service type specifies the
type of an external or internal service to be registered.
<state>
State
STOPPED | STARTED | STARTING | STOPPING | UNKNOWN | DOWN |
The possible runnable lifecycle states.
<tenantId>
Tenant ID
<ID>
A tenant ID is used to uniquely identify a tenant. A tenant ID can be any string without
whitespace, starting with a letter or underscore character (_), and containing only letters, digits,
or underscore characters.
<username>
Required user name. This might be a remote access user (page 67), a database user, the
superuser or a system user.
<value>
Value
<ID> | <INT> | <STRING>
A value can either be any identifier i.e., a string without whitespace, starting with a letter or
underscore character (_), and containing only letters, digits, or underscore characters, and
Integer number, or a string, i.e., an arbitrary, double-quote-delimited sequence of characters,
e.g.: ThisIsAnIdentifier435, _ThisIsAlsoAnIdentifier, 12345, This is also a valid value!.
<version>
Version
('a'..'z'|'A'..'Z'|'0'..'9'|'_'|'-'|'.')+
The common Maven-esque version of the runnable.
99
Server Installation and Administration Guide
Prerequisites
If you do not use the standard database system, please make sure to create additional schemes
in your Oracle (page 21) or Microsoft SQL database management system (page 24) and you have
assigned the tenants (page 74) to these schemes.
Procedure
1. Start ARIS Cloud Controller (ACC) (page 61).
2. Create tenant runnable types:
This is a list of groupId.artifactId for all runnable types that should have the create tenant
enhancement triggered by the create tenant command. In this case we need four tenant
runnable types calling the Administration forcing the tenant enhancement points
createTenant, importLicense, assignLicense and createTenant. Additionally we need
teo tenant runnable types calling the modeling component forcing the tenant enhancement
points migrateDB and renameDB.
enter, e.g.:
set acc config
create.tenant.runnable.types="com.aris.umcadmin.y-umcadmin-run-prod","com.ari
s.umcadmin.y-umcadmin-run-prod","com.aris.umcadmin.y-umcadmin-run-prod","com.
aris.umcadmin.y-umcadmin-run-prod","com.aris.modeling.components.y-server-run
-prod","com.aris.modeling.components.y-server-run-prod"
3. Create tenant enhancement points:
This is a list of enhancement points that are used to trigger create tenant. Please make sure
that in step 2 for each tenant enhancement point the corresponding runnable type has been
created in the right order.
enter, e.g.:
set acc config
create.tenant.enhancement.points=createTenant,importLicense,assignLicense,cre
ateTenant,migrateDB,renameDB
100
Server Installation and Administration Guide
101
Server Installation and Administration Guide
5.2 Logging
If problems occur during operation, please stop all components (page 64), ARIS servers and your
local ARIS client and execute the <path to server installation
directory>\support\collectLogFiles.bat file. All ARIS log files will be collected and saved as a
ZIP file.
All activities of components are recorded in the log directories of the server installation directory.
If problems occur during operation, you can use the log files to find and resolve errors. If you
cannot solve the problems and have a maintenance agreement, please send an error description
and the entire contents of the log and config directories as ZIP files to your local Software AG
sales organization.
The log files are located in the directory <path to installation directory>\.
.server\bin\work\<instanceid>\base\logs\
e.g. C:\SoftwareAG\ARIS9.0\server\bin\work\work_abs_m\base\logs
.\server\acc\log\
.\server\logs\
.\server\bin\log\
The activities of ARIS clients are recorded under <system drive>:\Documents and
Settings\<user>\ARIS9.6\log.
Setup activities are logged using the file %temp%\ARIS_install_log.
102
Server Installation and Administration Guide
Prerequisite
Server
Users who want to work with SSO have a valid user account in the Microsoft Active Directory
Domain Services.
The users exist in the Administration.
Microsoft Active Directory Domain Services supports a Kerberos-based authentication
(default) and the service principal name of ARIS Connect server is entered in the following
format: HTTP/<hostname>, e.g. HTTP/mypc01.my.domain.com.
Client
The client computers and servers are connected to the same MS Active Directory Domain
Services.
The browser used supports a Kerberos-based authentication.
The browser has been configured accordingly.
103
Server Installation and Administration Guide
A technical user is used to validate Kerberos tickets against the Microsoft Active Directory. This
user must be created in the Microsoft Active Directory and a keytab file must be created for this
user.
A keytab file contains a list of keys and pricipals. It is used to log on the technical user to the
Microsoft Active Directory without being prompted for a password. The most common use of
keytab files is to allow scripts to authenticate against the Microsoft Active Directory without
human interaction or storing a password in a plain text file. Anyone with read permission on a
keytab can use all of the keys containsed so you must restrict and monitor permissions on any
keytab file you create. The keytab must be recreated when the password of the technical user
changes.
A keytab file can be created by passing the following parameters to the JRE command line tool
ktab.exe:
ktab -a <TECHUSER_USER_PRINCIPAL_NAME> -n 0 -append -k umc.keytab - e.g. ktab
–a aristechuser@MYDOMAIN.COM –n0 –append –k umc.keytab.
Procedure
1. Open the Administration.
2. Select Configuration.
3. Switch to User management settings.
4. Select Kerberos/SPNEGO.
5. To activate SSO, find the string
com.aris.umc.kerberos.active
Set this configuration key to true.
6. Select
com.aris.umc.kerberos.config
and upload the Kerberos configuration by clicking into the field.
In case the Kerberos configuration file is not available, create a new one. Name it e.g.
krb5.conf, add the following lines and adapt the configuration to your requirements.
[libdefaults]
default_tgs_enctypes = des-cbc-md5 des-cbc-crc des3-cbc-sha1 aes128-cts
aes128-cts-hmac-sha1-96 aes256-cts aes256-cts-hmac-sha1-96 rc4-hmac
arcfour-hmac arcfour-hmac-md5
default_tkt_enctypes = des-cbc-md5 des-cbc-crc des3-cbc-sha1 aes128-cts
aes128-cts-hmac-sha1-96 aes256-cts aes256-cts-hmac-sha1-96 rc4-hmac
arcfour-hmac arcfour-hmac-md5
permitted_enctypes = des-cbc-md5 des-cbc-crc des3-cbc-sha1 aes128-cts
aes128-cts-hmac-sha1-96 aes256-cts aes256-cts-hmac-sha1-96 rc4-hmac
arcfour-hmac arcfour-hmac-md5
7. Upload this file.
104
Server Installation and Administration Guide
8. In the Administration, upload the generated Kerberos key tab file by clicking into the field
com.aris.umc.kerberos.keyTab
9. In the Administration, find the following string and and configure the username of the
technical user.
com.aris.umc.kerberos.servicePrincipalName
If the service principal name in the keytab is e.g. mypc01@MY.DOMAIN.COM then the
values of the properties com.aris.umc.kerberos.servicePrincipalName must contain the
service principal name specified in the keytab.
10. In the Administration, find the following string and and configure the realm for the Kerberos
service. Enter the fully qualified name of the domain in uppercase.
com.aris.umc.kerberos.realm
The values of the properties com.aris.umc.kerberos.realm must contain the fully qualified
domain name - e.g. MYDOMAIN.COM.
11. In the Administration, find the following string and configure the fully qualified name of the
KDC to be used:
com.aris.umc.kerberos.kdc
12. Optional: In the Administration, find the following string and define the list of IP addresses
for which you want to enable SSO (whitelist):
com.aris.umc.kerberos.whitelist
Each entry in the list must begin in an individual line:
Example
192.168.100.1
192.168.100.*
10.0.0.*
#Allow all IPs
*.*.*.*
13. Optional: In the Administration, find the following string and configure the debug mode for
Kerberos operations:
com.aris.umc.kerberos.debug=true
Example
The following can be configures in the Administration.
com.aris.umc.kerberos.active=true
com.aris.umc.kerberos.config=/etc/krb5.conf
com.aris.umc.kerberos.keyTab=C:/safePlace/krb-umc.keytab
com.aris.umc.kerberos.whitelist=./config/Kerberos/krb-ip-whitelist.conf
com.aris.umc.kerberos.servicePrincipalName=mypc01
com.aris.umc.kerberos.realm=MY.DOMAIN.COM
com.aris.umc.kerberos.kdc=mykdc01.my.domain.com
com.aris.umc.kerberos.whitelist=./config/Kerberos/krb-ip-whitelist.conf
com.aris.umc.kerberos.debug=false
105
Server Installation and Administration Guide
Client configuration
Configure the browser settings to allow SSO. SSO has been tested using the following browsers:
Microsoft Internet Explorer (version 6 or higher)
Firefox
Google Chrome
Apple Safari (für Mac OS)
Procedure
1. Launch Microsoft Internet Explorer.
2. Select Tools > Internet Options.
3. Activate the Security tab and click Local Intranet.
4. Click the Sites button and then the Advanced button.
5. Add the URL for the ARIS Connect server that has been configured for SSO. Add both the DNS
host name and the IP address for ARIS Connect Server.
6. Disable Require server verification (https:) for all sites in this zone.
7. Click Close and then OK.
8. Click the Custom level button and make sure that no user-defined settings impede your new
settings.
9. Scroll to the User Authentication section. Check whether Automatic logon only in
Intranet zone is activated.
10. Click OK to close the dialogs.
11. Close and restart Microsoft Internet Explorer.
Mozilla Firefox
In Mozilla Firefox, you can define trusted pages via the computer name, IP address, or
combinations of both. You can also use wildcards.
Procedure
1. Launch Mozilla Firefox.
2. Enter about:config in the address bar and press the Enter key. If a message is displayed,
confirm it.
3. Enter network.negotiate in the Filter bar and press the Enter key.
4. Double-click network.negotiate-auth.trusted-uris.
5. Enter the computer name or IP address of the ARIS Connect server that has been configured
for SSO and click OK.
106
Server Installation and Administration Guide
Google Chrome
Kerberos can be enabled by passing a comma-separated list of permitted URLs via the
authentication server whitelist command line switch. For example pass in the following options
that any URL ending in mydomain.suffix.com is permitted.
--auth-server-whitelist="*.mydomain.suffix.com,*.suffix.com"
Without the * prefix, the URL has to match exactly. MS Windows only: If the command line switch
is not present, then the permitted list automatically contains all URLs of MS Internet Explorer local
intranet zone.
a. %JAVA_HOME%/lib/security/krb5.conf
b. %WINDOWS_ROOT%/krb5.ini
2. By the system properties java.security.krb5.realm and java.security.krb5.kdc.
In JRE 7, when neither of the above two ways is used, Java tries to fetch the realm and KDC
settings using the Domaine Name Service. An SRV (Service) Resource Records is used to
indicate the host name and port number to contact for the KDC service, optionally with
weighting and priorization.
107
Server Installation and Administration Guide
By default, newer versions of Windows do not allow Java to access the session key of a
Ticket-Granting Tickets (TGT). The key is required to acquire additional service tickets. To
allow this access, one needs to set the following registry key on the client, see Java Bug
6576422:
Windows XP and 2000:
HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Lsa\Kerberos
Value Name: allowtgtsessionkey
Value Type: REG_DWORD
Value: 0x01
Windows 2003, Vista, 7:
HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Lsa\Kerberos\Parameter
s
Value Name: allowtgtsessionkey
Value Type: REG_DWORD
Value: 0x01
The client application tries to acquire the TGT from the following locations (ordered):
108
Server Installation and Administration Guide
Prerequisite
Ensure that you have installed ARIS Design Server/ARIS Connect server and ARIS Publisher
Server.
You need an ARIS Publisher Server license including the IT Inventory extension pack and the
number of users.
109
Server Installation and Administration Guide
After the standard installation ARIS Publisher Server runs the reports executed from Publisher
exports. You can additionally install an ARIS Publisher Report Server to optimize the system
performance.
If you retain the settings of the installation program when you use the standard installation of
ARIS Publisher Server, the context path and the free port to the Web server are entered
automatically.
Additional modification is required for Process-driven Management for SAP® Solutions
(page 146).
110
Server Installation and Administration Guide
Procedure
In the file..<ARIS installation path>\server\bin\work\work_businesspublisher_<s, m or
l>\base\webapps\businesspublisher\config\webappserver.cfg, change the value of the
LoginModuleSection to UMCLogin:
<LoginModuleSection value="UMCLogin"/>
Publisher users are authenticated via Administration and ARIS document storage will be available
if it has been connected to the ARIS Publisher Server (page 113).
Prerequisite
You have access privileges for the ARIS Publisher Server installation directory.
Ensure that the users have been created in the SAP® system and have RFC privileges (page
125).
The special SAP® ports sapgw00 3300/tcp and sapdp00 3200/tcp must be enabled in
the Windows Services file of the client computer (C:\Windows/ system32/ drivers/
etc/services). In general, these ports are entered automatically during SAP GUI installation.
If you use server groups for access (SAP® routers), you need to enter the SAP® ports
manually in consecutive sequence. By default, the syntax for a port number is as follows 3300
plus the <SAP® system number> will be used. If, for example, the system number is 03,
the port number 3303 must be entered. Entries that have not been entered in consecutive
sequence are ignored.
If the dialog is not displayed correctly when starting SAP® transactions from a Publisher export,
open the Java Control Panel and disable the Enable the next-generation Java Plug-in check
box under Java Plug-in on the Advanced tab.
Procedure
1. Open the file in the ARIS Publisher Server installation directory <ARIS installation
path>\ARIS9.6\server\bin\work\work_businesspublisher_<s, m or
l>\base\webapps\businesspublisher\config\webappserver.cfg with a text editor.
111
Server Installation and Administration Guide
Procedure
In the file..<ARIS installation path>\server\bin\work\work_businesspublisher_<s, m or
l>\base\webapps\businesspublisher\config\webappserver.cfg, add.
<rocketSearch>
<engine value="on"/>
</rocketSearch>
You can reactivate the previous standard search by setting the engine value to off.
Procedure
1. Open <ARIS installation path>\server\bin\work\work_businesspublisher_<s, m or
l>\base\webapps\businesspublisher\config\webappserver.cfg and change:
<switch value="off"/>
to
<switch value="on"/>
2. Restart ARIS Publisher Server.
112
Server Installation and Administration Guide
Procedure
1. Open <ARIS installation path>\server\bin\work\work_businesspublisher_<s, m or
l>\base\webapps\businesspublisher\config\webappserver.cfg and configure the mail
server settings under <bpadmin>.
2. Restart ARIS Publisher Server.
Prerequisite
You have set up ARIS document storage within the Administration of the connected ARIS
Connect Server or ARIS Design Server.
ARIS Publisher users are managed within the Administration (page 111).
Procedure
1. Copy the file <ARIS installation path>/server/bin/work/work_abs_<s, m or
l>/base/webapps/abs/config/SpringCRModule.xml from the connected ARIS Connect
Server or ARIS Design Server to <ARIS installation
path>/server/bin/work/work_businesspublisher_<s, m or
l>/base/webapps/businesspublisher/WEB-INF/Spring/core.
2. Configure the adsProviderConfig property in the SpringCRModule.xml file.
3. Specifiy the URL of a valid ARIS document storage server instance. This must be the same
instance that the ARIS Connect Server orARIS Design Server refers to. This property must not
be empty.
4. Restart ARIS Publisher Server.
113
Server Installation and Administration Guide
Procedure
1. Open the file <ARIS installation path>/server/bin/work/work_businesspublisher_<s, m or
l>/base/webapps/businesspublisher/layouts/default/ config/layout.cfg.xml and change the
address in the <responsible email="name@company.com"/> entry.
2. Restart ARIS Publisher Server.
Prerequisite
Make sure that the Person responsible model attribute is specified for each process with the
correct e-mail address.
Procedure
1. Add 1584 to <attr feedbackAttributeNr> in the file <ARIS installation
path>/server/bin/work/work_businesspublisher_<s, m or
l>/base/webapps/businesspublisher/layouts/default/config/layout.cfg.xml.
2. Restart ARIS Publisher Server.
If you use a user-defined attribute type to specify the e-mail address of a process manager, we
recommend that you define it independent of the language. This ensures that an e-mail address
is automatically entered in all languages. Please enter the GUID instead of the attribute type
number for user-defined attribute types. You can find the GUID on the properties page of the
attribute type Administration tab (Conventions > Method > Attribute types).
114
Server Installation and Administration Guide
Procedure
1. Open <ARIS installation path>\server\bin\work\work_businesspublisher_<s, m or
l>\base\webapps\businesspublisher\config\webappserver.cfg and specify the required
<ldap> settings.
2. Restart ARIS Publisher Server.
Warning
If your LDAP server is set up so that it allows anonymous authentication (unauthenticated bind
mechanism), users may be able to log in without a password.
You can use the administration interface for exports to encrypt (page 115) the password of the
LDAP user specified here. Copy the encrypted password to this file and restart the server.
115
Server Installation and Administration Guide
116
Server Installation and Administration Guide
File Description
aspect_matrix.xml Defines the object types included in the aspects. Please refer
to the Method help (Help/Method help) for the API names of
object types.
If you change the configuration file, please note the XML structure. Please use the default layout
of the matrix as a guide.
We recommend that you ask ARIS Customized Solutions to change your configuration.
Procedure
1. Open the relevant configuration file under.<ARIS installation
path>/server/bin/work/work_businesspublisher_<s, m or
l>/base/webapps/businesspublisher/views/matrix and change it according to your
requirements.
2. Exit and then restart ARIS Publisher Server.
117
Server Installation and Administration Guide
Procedure
Ensure that the values of the keys are specified as follows:
<aoeDefinition exportName="*"
isVisible="true"
Changes to this file take effect immediately without restarting ARIS Publisher Server.
You can also offer the navigation carousel without a structuring model. ARIS Customized
Solutions will be pleased to help you with the implementation.
Procedure
Open the file <ARIS installation path>/server/bin/work/work_businesspublisher_<s, m or
l>/base/webapps/businesspublisher/layouts/default/config/layout.cfg.xml, and enter the URL
for your RSS feed in the <news basename="news"> area.
<news basename="news">
<!-- TODO synchronize access to feed-xml -->
<url proto="http"
location="<Your URL, e. g.
"http://www.ariscommunity.com/group/aris-bpm-blog/feed/teaser">"
proxyAdress="<Your proxy address, e.g. "hades.company.com">"
proxyPort="<Your proxy port>"
refresh="600"/>
</news>
The News area can be customized to meet your requirements. ARIS Customized Solutions will be
pleased to help you with the implementation. For example, you can keep a list of links to the
models or objects that have been changed or created since a specific date.
118
Server Installation and Administration Guide
Procedure
1. Open the file <ARIS installation path>/server/bin/work/work_businesspublisher_<s, m or
l>/base/webapps/businesspublisher/views/visualisation/default_visualisation.xml and
change the file according to your requirements.
2. Exit and then restart ARIS Publisher Server.
5.5.3 Logging
Activities such as imports from ARIS IT Inventory, as well as errors are logged in different files
depending on the component, e.g. inventoryImport-<Version.Build>_0.log. If problems
occur during operation, you can use the log files to find and resolve errors. If you cannot solve the
problems and have a maintenance agreement, please send an error description and the entire
contents of the log and config directories as ZIP files to your local Software AG sales
organization. The log file names and the logging configuration are defined in the file. <ARIS
installation path>/ARIS9.6/server/bin/work/work_businesspublisher_<s, m or l>/base/logs and
/conf.
119
Server Installation and Administration Guide
Precondition
You have access to a zipped file containing the relevant governance process.
Procedure
Copy the zipped file containing the relevant governance process to the autodeployment folder
on an ARIS Design Server or ARIS Connect server instance.
<ARIS Design Server installation
directory>\server\bin\work\work_apg<number>\base\model
All the tenants of this ARIS Design Server or ARIS Connect server can now use the deployed
governance process.
If you are using several ARIS Design Server or ARIS Connect server instances that should provide
the same governances process, you have to copy this zipped file to the autodeployment folders of
all instances.
System requirements
For information about hardware and software requirements, please refer to the ARIS Platform
Matrix document (see installation media or download it
http://aris.softwareag.com/ARISDownloadCenter/ADCDocumentationServer).
120
Server Installation and Administration Guide
Procedure
1. Start (page 61) ARIS Cloud Controller.
2. Stop the relevant runnable, type e.g. stop apg_m.
3. Open the ARIS Process Board configuration file (e.g. <ARIS9.x installation
directory>\server\bin\work\work_apg_m\base\webapps\processboard\WEB-I
NF\tl-configuration.xml).
All supported locales are listed by default in the configuration file.
4. Remove the locales you do not want to use.
If the configuration file contains the operating system's locale, it will be selected by
default.
If the configuration file does not contain the operating system's locale, the first locale
specified in the list will be selected.
121
Server Installation and Administration Guide
Example
<!-- language configuration, first element is selected on UI -->
<locales>
Procedure
1. Start (page 61) ARIS Cloud Controller.
2. Stop the relevant runnable, type e.g. stop apg_m.
3. Open the <ARIS installation
directory>\server\bin\work\work_apg_<character>\base\webapps\processboa
rd\WEB-INF\tl-configuration.xml file with a text editor, e.g. C:\Program
files\ARIS9.x\server\bin\work\work_apg_m\base\webapps\processboard\WEB
-INF\tl-configuration.xml.
4. Set the element styledeclarations active to true: <styledeclarations active="true">
5. Customize the colors, logos and styles. You can define different customizations for each
tenant. If you do not define a tenant, you customization is used for all tenants. If no
customization is defined, the default colors and styles are used.
Many components can be grouped to special color groups. Constants are introduced to the
XML file to define the color of a complete group of components.
6. Start the relevant runnable, type e.g. start apg_m.
You have defined colors, logos and other styles for ARIS Process Board.
122
Server Installation and Administration Guide
123
Server Installation and Administration Guide
Depending on the features you provide, you must customize the system.
Use SAP® synchronization (page 131)
Use customizing transactions/views (page 134)
Use ARIS Online Guide (page 136)
Use BI Modeler (page 145)
Use Publisher exports (page 146)
Ensure that the users have been created in the SAP® system and have RFC privileges (page
125).
The special SAP® ports sapgw00 3300/tcp and sapdp00 3200/tcp must be enabled in
the Windows Services file of the client computer (C:\Windows/ system32/ drivers/
etc/services). In general, these ports are entered automatically during SAP GUI installation.
If you use server groups for access (SAP® routers), you need to enter the SAP® ports
manually in consecutive sequence. By default, the syntax for a port number is as follows 3300
plus the <SAP® system number> will be used. If, for example, the system number is 03,
the port number 3303 must be entered. Entries that have not been entered in consecutive
sequence are ignored.
124
Server Installation and Administration Guide
For Solution Manager synchronization, you also need SAP Java Connector 3.07, or a higher 3.0x
version. It must be installed on your ARIS Design Server or local server.
To perform Solution Manager synchronization, you need SAP Solution Manager, version 4.0, 7.0
or 7.1, with the languages German (de), English (en), French (fr), Spanish (sp), and/or
Japanese (ja). Shortcuts are supported by SAP® synchronization. SAP® Solution Manager
provides these only in version 4.0 SP 15 or higher.
BI Modeler
System requirements
Please ensure that all computers meet the following requirements:
Access to SAP BW 7.0 in German (de), English (en), or French (fr)
The file saplogon.ini is available or SAP GUI for Windows is installed locally (version 7.1 to
7.3)
The transport request was transferred.
Privileges
The SAP_BW_RFC object is required in the SAP® system. (page 128)
To download query files in PDF format and make them available in ARIS, please share a directory
that ARIS Design Server can also access.
125
Server Installation and Administration Guide
If you access via server groups (SAP® router) you need to manually enter the SAP® ports in
consecutive order. The syntax for a port number is 3300 plus the used <SAP® system
number>. If, for example, the system number is 03 you need to enter 3303. Entries that are
not entered in consecutive order are ignored.
You can create the role to be defined using the PFCG transaction. Assign the authorization
objects S_RFC and S_RFCACL to the role.
126
Server Installation and Administration Guide
In the RFC_TYPE section you must select the Function group type.
127
Server Installation and Administration Guide
Procedure
1. Download SAP JCo 3.0.x 32 bit version appropriate for your operating system and for the
runtime environment (JRE) used from the SAP Service Marketplace
(http://service.sap.com/connectors). If you are using a different operating system please
refer to the appropriate download package from SAP AG.
2. Save the zip file, e. g. d:/sapjco30P_9-10005326.zip.
3. Start ARIS Cloud Controller (ACC) (page 61).
4. Stop ARIS Design Server or ARIS Connect Server or enter stop <InstanceId for the
modeling component> to stop the modeling component abs_s, abs_m or abs_l.
<InstanceId for the modeling component> depends on the system settings of the
installation. To find out the correct entry please enter list and look for one of the entries
abs_s, abs_m or abs_l.
5. Provide sapjco3.jar for download clients and ARIS Design Server/ARIS Connect Server using
this command:
128
Server Installation and Administration Guide
enhance <InstanceId for the modeling component> with webappsClasspath local file
<path to the saved zip file>,
e. g.
enhance abs_s with webappsClasspath local file d:/sapjco30P_9-10005326.zip
6. Start <_abs_> or ARIS Connect Server or enter start <InstanceId for the modeling
component> e. g. abs_s, abs_m or abs_l.
sapjco3.jar will be available for download clients, ARIS Design Server and ARIS Connect Server.
All users of download clients must to copy SAP® JCo 3.dll (page 129). Please provide SAP®
JCo for installed clients (page 130) or the server LOCAL (page 131) too.
If you have correctly provided SAP Java Connector SAP JCo 3.0.x but have installed older
runtime libraries of Visual Studio 2005 C/C++, you may have to update
(http://www.microsoft.com/downloads/details.aspx?displaylang=en&FamilyID=766a6af7-ec73
-40ff-b072-9112bab119c2) the Microsoft Active Template Library (ATL). Please consider the SAP
notes 1077727 and 1375494 on the SAP Service Marketplace
(http://service.sap.com/connectors).
Procedure
1. Make sure that a 32-bit JRE version is installed and in use.
2. Download SAP JCo 3.0.x 32 bit version appropriate for your operating system and for the
runtime environment (JRE) used from the SAP Service Marketplace
(http://service.sap.com/connectors). If you are using a different operating system please
refer to the appropriate download package from SAP AG.
3. Copy the file sapjco3.dll next to the Windows operating system libraries.
For information on the Windows operating system, refer to the table below. If you are using a
different operating system, such as Solaris, please refer to the appropriate download package
from SAP AG.
4. Restart the ARIS client.
If you have correctly provided SAP Java Connector SAP JCo 3.0.x but have installed older
runtime libraries of Visual Studio 2005 C/C++, you may have to update
(http://www.microsoft.com/downloads/details.aspx?displaylang=en&FamilyID=766a6af7-ec73
-40ff-b072-9112bab119c2) the Microsoft Active Template Library (ATL). Please consider the SAP
129
Server Installation and Administration Guide
Procedure
1. Download SAP JCo 3.0.x 32 bit version appropriate for your operating system and for the
runtime environment (JRE) used from the SAP Service Marketplace
(http://service.sap.com/connectors). If you are using a different operating system please
refer to the appropriate download package from SAP AG.
2. Copy the file sapjco3.dll next to the Windows system libraries. The ARIS client automatically
installs the 32-bit JRE version.
For information on JRE version and Windows system, refer to the table below. If you are using
a different operating system, such as Solaris, please refer to the appropriate download
package from SAP AG.
3. Copy the sapjco3.jar file to the <ARIS installation directory>\client\lib directory.
4. Restart the ARIS client.
sap Jco 3.0.x is available for this installed client. If you intend to use it together with the locally
installed server LOCAL the latter must be provided with the 64-bit version of the SAP®
JCosapjco3 file (page 131) as well.
If you have correctly provided SAP Java Connector SAP JCo 3.0.x but have installed older
runtime libraries of Visual Studio 2005 C/C++, you may have to update
(http://www.microsoft.com/downloads/details.aspx?displaylang=en&FamilyID=766a6af7-ec73
-40ff-b072-9112bab119c2) the Microsoft Active Template Library (ATL). Please consider the SAP
notes 1077727 and 1375494 on the SAP Service Marketplace
(http://service.sap.com/connectors).
130
Server Installation and Administration Guide
Procedure
1. Stop the ARIS client.
2. Download SAP JCo 3.0.x 64 bit version appropriate for your operating system and for the
runtime environment (JRE) used from the SAP Service Marketplace
(http://service.sap.com/connectors). If you are using a different operating system please
refer to the appropriate download package from SAP AG.
3. Save the zip file.
4. Extract the sapjco3.jar file to the <ARIS client installation
directory>\LOCALSERVER\bin\work\work_abs_local\base\webapps\abs\WEB-I
NF\lib directory.
5. Copy the 64 bit version oft the sapjco3.dll into the deirectory <Windows installation
directory>-Installationsverzeichn>\system32.
6. Start the ARIS client.
If you have correctly provided SAP Java Connector SAP JCo 3.0.x but have installed older
runtime libraries of Visual Studio 2005 C/C++, you may have to update
(http://www.microsoft.com/downloads/details.aspx?displaylang=en&FamilyID=766a6af7-ec73
-40ff-b072-9112bab119c2) the Microsoft Active Template Library (ATL). Please consider the SAP
notes 1077727 and 1375494 on the SAP Service Marketplace
(http://service.sap.com/connectors).
131
Server Installation and Administration Guide
Ensure that the current transport request (page 132) has been imported in the SAP® Solution
Manager system that you want to use for synchronization.
Ensure that the Web services (page 133) for the repository/scenario transfer are enabled in
your SAP® system and properly configured.
Procedure
1. Copy the file K<number>.<SAP® system SID> from the installation media to the directory
\sapmnt\trans\cofiles.
2. Copy the file R<number>.<SAP® system SID> from the installation media to the directory
\sapmnt\trans\data. The sapmnt directory usually corresponds to the directory
\usr\sap. If you cannot find the cofiles and data directories under the specified paths, you
can determine the correct path using the DIR_TRANS variable. To do this, log on to the
relevant SAP® Solution Manager system and execute transaction AL11.
To transfer the transport request to the SAP® system using the command line program
TP.EXE, enter the following commands in the specified sequence:
a. TP addtobuffer <SAP® system SID>K<number> [target system SID]
b. TP import <SAP® system SID>K<number> [client on target system]
You can also execute the transport request using the transaction STMS.
Procedure
1. Log on to the relevant SAP® Solution Manager system as system administrator.
2. Execute transaction STMS. This takes you to the Transport Management System.
3. Click Import overview (F5).
4. Double-click the relevant SAP® Solution Manager system. This takes you to the import queue.
5. In the menu, select Extras > Other requests > Add. The Add transport request to
import queue dialog opens.
6. Enter <SAP® system SID>K<number> and confirm. You return to the import overview.
7. Select the transport request.
8. In the menu, select Request > Import. The Import request dialog opens.
132
Server Installation and Administration Guide
9. Activate the Options tab and check Ignore invalid component version.
10. Enter the relevant target client and confirm via F8 or Start import.
Syntax
<protocol type>://<host name>:<port number>/<URI>?sap-client=<CLIENT>
The host name could be solutionmanager, for example. The port number is 8000 and the path
(URI) is /sap/bc/solman/bpr. The client is the SAP® system client.
For SAP® Solution Manager 3.2, you need Support Package 06. Additional information is
available in the SAP® Service Marketplace.
Procedure
1. Start SAP® Solution Manager and call transaction SICF.
2. Right-click default_host > sap > bc > solman, for example, and select Enable service.
When the service is enabled, additional subgroups are visible.
Enabling reveals the URI of the Web service. In this case, it is /sap/bc/solman/bpr. The
protocol type is http. If you right-click bpr and select Display service, the URI is displayed
in the ICF path box and the protocol type on the Service data/Security requirements tab.
The Default option corresponds to the protocol type http, while the SSL option corresponds
to the protocol type https. To use SSL, you need a valid certificate.
133
Server Installation and Administration Guide
You can also adjust the URL with the 'External aliases' function
Procedure
1. Start SAP® Solution Manager, and call the SICF transaction.
2. Click the External aliases button.
3. Select a host and create a new external alias (F5). You can adjust the path in the External
alias box.
4. Activate the Service data tab. You can adjust the protocol type in the Security
requirements box.
The Default option corresponds to the protocol type http, while the SSL option corresponds
to the protocol type https. To use SSL, you need a valid certificate.
5. Activate the Target item tab. Select the bpr node for the Business Process Repository. The
previous steps revealed the protocol type and the path of the Web service URL.
6. Call the SMICM transaction to determine the port and host name. To list the available ports,
click Go to > Services in the main menu.
All ports for the different protocol types are displayed. If a protocol is missing or inactive
(Active column), inform your system administrator.
Use this information to form the URL.
Procedure
1. Copy the file K<number>.<SAP system SID> from the installation media to the directory
\sapmnt\trans\cofiles.
2. Copy the file R<number>.<SAP system SID> from the installation media to the directory
\sapmnt\trans\data.
The directory sapmnt normally corresponds to the directory \usr\sap. If you cannot find the
cofiles and data directories under the specified paths, you can determine the correct path
using the DIR_TRANS variable. To do this, log on to the relevant SAP system, and run
transaction AL11.
To transfer the transport request to the SAP system using the command line program TP.EXE,
enter the following commands in the specified sequence:
a. TP addtobuffer <SAP system SID>K<number> [target system SID]
b. TP import <SAP system SID>K<number> [client on target system]
134
Server Installation and Administration Guide
You can also execute the transport request using the transaction STMS:
Procedure
1. Log on to the relevant SAP system as a system administrator.
2. Execute transaction STMS. This takes you to the Transport Management System.
3. Click Import overview.
4. Double-click the relevant SAP system. This takes you to the import queue.
5. In the menu, select Add-ons > Other requests > Append. The Append transport
request to import queue dialog opens.
6. Enter <SAP system SID>K<number> and confirm. You return to the import overview.
7. Select the transport request.
8. In the menu, select Request > Import. The Import request dialog opens.
9. Activate the Options tab and check Ignore invalid component version.
10. Enter the relevant target client and confirm via F8 or Start import.
135
Server Installation and Administration Guide
Once you have executed the client setup and made the created HTML documents available in the
SAP® system, your SAP® system administrator must implement the transactions
/IDS/AOG_ADMIN, /IDS/AOG_USER, and ZEXTHLP in the SAP® system and adapt the Web
server.
To do so, please adjust the following:
1. Import required function modules (page 136).
2. Modify program LSHL2U01 (page 138).
3. Specify settings (page 139).
Procedure
1. Copy the file K<number>.<SAP® system SID> from the installation media to the directory
\sapmnt\trans\cofiles.
2. Copy the file R<number>.<SAP® system SID> from the installation media to the directory
\sapmnt\trans\data. The directory sapmnt normally corresponds to the directory
\usr\sap. If you cannot find the cofiles and data directories under the specified paths, you
can determine the correct path using the DIR_TRANS variable. To do this, log on to the
relevant SAP® system, and run transaction AL11.
To transfer the transport request to the SAP® system using the command line program
TP.EXE, enter the following commands in the specified sequence:
a. TP addtobuffer <SAP® system SID>K<number> [target system SID]
b. TP import <SAP® system SID>K<number> [client on target system]
You can also execute the transport request using the transaction STMS.
Procedure
1. Log on to the relevant SAP® system as a system administrator.
2. Execute transaction STMS. This takes you to the Transport Management System.
136
Server Installation and Administration Guide
10. Enter the relevant target client and confirm via F8 or Start import.
Then assign each of the transactions /IDS/AOG_ADMIN, /IDS/AOG_USER, and
ZEXTHLP a new or existing authorization object.
If you create any new authorization objects, you must include them in suitable authorization
profiles.
137
Server Installation and Administration Guide
Procedure
1. If required, log on to the relevant SAP® system.
2. Execute transaction SE37.
DATA: l_error_msg LIKE iwerrormsg. " DHB
DATA: l_action LIKE sy-xcode. " *17i
DATA: exit_flg.
DATA: save_help_info_call LIKE help_infos-call.
DATA: ihelpinfo TYPE help_info.
DATA: lv_help_mode TYPE char1.
DATA: lv_window_name TYPE sydatar.
DATA: a_msgv1 LIKE help_infos-msgv1,
a_msgv2 LIKE help_infos-msgv2,
a_msgv3 LIKE help_infos-msgv3,
a_msgv4 LIKE help_infos-msgv4.
* help center
DATA: l_flag_hc_called TYPE as4flag. "note 1135202
138
Server Installation and Administration Guide
SAP system administrators use the /IDS/AOG_ADMIN transaction to specify default settings
that all users of the client can adopt. Users can specify their own settings with the
/IDS/AOG_USER transaction.
If you plan to make only the help from ARIS Online Guide available to the above user, enable
the Use ARIS Online Guide check box in the ARIS Online Guide - Administration
settings dialog.
To provide user access to the ARIS Online Guide help in addition to the F1 help that is available
in the SAP system by default, enable the Show additionally default help check box.
Enable the Publisher URL overwritable check box to authorize users to change the URL to
the Publisher export.
Enter required information to access the Publisher export providing ARIS Online Guide.
Publisher URL
URL to access the published database:
http://<servername>:<port number>/businesspublisher/link.do
e.g. http://aris1:19990/businesspublisher/link.do
User name
User that is used for login to the Publisher export.
Password
Password of the login user.
Language-Key
Value of the LocaleID (page 141) key representing the interface language used in the
Publisher export.
e.g. 1031 = German, 1033 = English
Profile-Hash
Value of ph key representing the profile used in the Publisher export, e.g. 0mhsu6i.
To determine the values of Profile-Hash and Language-Key open a model in the
Publisher export, right click and select Copy link.
http://publisherserver1:19990/businesspublisher/link.do?login=rkl&password=&localei
d=1031&ph=0mhsu6i&modelguid=55165b80-30c6-11de-3712-00167669f3de
139
Server Installation and Administration Guide
Each of the client's users can use the /IDS/AOG_USER transaction to customize the settings
specified by the SAP system administrator with the /IDS/AOG_ADMIN transaction.
If you only use the help from ARIS Online Guide, enable the Use ARIS Online Guide check
box.
To provide the ARIS Online Guide help in addition to the F1 help that is available in the SAP
system by default, enable the Show additionally default help check box.
Enter required information to access the Publisher export providing ARIS Online Guide in the
ARIS Online Guide - User-specific settings dialog:
Publisher URL
URL to access the published database:
http://<servername>:<port number>/businesspublisher/link.do
e.g. http://aris1:19990/businesspublisher/link.do
Users can change the URL only if the administrator has enabled the Publisher URL
overwritable check box in the ARIS Online Guide - Administration settings dialog.
User name
User that is used for login to the Publisher export.
Password
Password of the login user.
Language-Key
Value of the LocaleID key representing the interface language used in the Publisher
export.
e.g. 1031 = German, 1033 = English
Profile-Hash
Value of ph key representing the profile used in the Publisher export, e.g. 0mhsu6i.
To determine the values of Profile-Hash and Language-Key open a model in the
Publisher export, right click and select Copy link.
http://publisherserver1:19990/businesspublisher/link.do?login=rkl&password=&localei
d=1031&ph=0mhsu6i&modelguid=55165b80-30c6-11de-3712-00167669f3de
If you have changed the default settings that the system administrator specified and want to
reactivate them, click on Restore default.
140
Server Installation and Administration Guide
Each of the client's users can use the ZEXTHLP transaction to activate the ARIS Online Guide the
next time F1 help is called.
If a user has executed this transaction and presses the F1 key, the ARIS Online Guide help is
displayed with the settings specified via the /IDS/AOG_ADMIN and /IDS/AOG_USER
transactions. If the user presses the F1 key again, the standard F1 help of the SAP system is
displayed again.
141
Server Installation and Administration Guide
142
Server Installation and Administration Guide
143
Server Installation and Administration Guide
144
Server Installation and Administration Guide
5.7.7.4 BI Modeler
To enable data exchange between ARIS and SAP NetWeaver® Business Warehouse, you must
import the current transport requests into the SAP system.
The files of the workbench transport request and the files of the customizing transport request are
located on the installation media.
If you re-import the transport request in order to update it, you should first delete the contents
of the following tables:
YARIS_OBJ_ZUO
YARIS_OBJCHILDBZ
YARIS_OBJOBJ_NM
YARIS_OBJ_ATTR
Procedure
1. Import the workbench transport requests in the SAP system before importing the customizing
transport requests. To do this, perform the following steps:
2. Copy the file K<number>.<SAP system SID> to the directory \sapmnt\trans\cofiles.
3. Copy the file R<number>.<SAP system SID> to the directory \sapmnt\trans\data. The
directory sapmnt normally corresponds to the directory \usr\sap. If you cannot find the
cofiles and data directories under the specified paths, you can determine the correct path
using the DIR_TRANS variable. To do this, log on to the relevant SAP system, and run
transaction AL11.
To transfer the transport request to the SAP system using the command line program TP.EXE,
enter the following commands in the specified sequence:
a. TP addtobuffer <SAP system SID>K<number> [target system SID]
b. TP import <SAP system SID>K<number> [client on target system]
The transport request has been transferred.
You can also execute the transport request using the transaction STMS.
1. Log on to the relevant SAP system as a system administrator.
2. Execute transaction STMS. This takes you to the Transport Management System.
3. Click Import overview.
4. Double-click the relevant SAP system. This takes you to the import queue.
5. In the menu, select Add-ons > Other requests > Append. The Append transport
request to import queue dialog opens.
6. Enter <SAP system SID>K<number> and confirm. You return to the import overview.
7. Select the transport request.
8. In the menu, select Request > Import. The Import request dialog opens.
145
Server Installation and Administration Guide
9. Activate the Options tab and check Ignore invalid component version.
10. Enter the relevant target client and confirm via F8 or Start import.
The transport request has been transferred.
146
Server Installation and Administration Guide
Procedure
1. Create a migration directory on the local hard drive of your server with the ARIS installation,
e.g. migration_data. Backup and restore actions should be executed directly on the server.
2. Replace tools directory in the directory <ARIS
installationdirectory>\server\bin\work\work_apg<number>, e.g. C:\Program
Files\Aris9.5\server\bin\work\work_apg1 by tools directory from your installation
medium.
3. Backup your data for all tenants. Type <ARIS
installationdirectory>\server\bin\work\work_apg<number>\tools\bin\y-backu
p-all.bat or <ARIS
installationdirectory>\server\bin\work\work_apg<number>\tools\bin\y-backu
p-all.sh depending on your operating system, e.g. C:\Program
Files\Aris9.5\server\bin\work\work_apg1\tools\bin\y-backup-all.bat.
After a backup is finished, the you will find a separate ZIP archive for each tenant in the
migration directory. Each ZIP archive contains the data for a specific tenant.
4. Deinstall your old ARIS version and delete all remaining files of your old ARIS installation.
5. Install (page 2) the new ARIS version.
6. Restore the data for all available tenants. In your migration directory, type <ARIS
installationdirectory>\server\bin\work\work_apg<number>\tools\bin\y-restor
e-all.bat or <ARIS
installationdirectory>\server\bin\work\work_apg<number>\tools\bin\y-restor
e-all.sh depending on your operating system, e.g. C:\Program
Files\Aris9.5\server\bin\work\work_apg1\tools\bin\y-restore-all.bat.
7. Open the backup.log file in the logs subdirectory of your migration directory to check
whether the restore and migration of the data was successful. This file contains information
about each migration command and about the restore process.
All data of all tenants are migrated to the new ARIS version.
147
Server Installation and Administration Guide
Procedure
1. Open a command line.
2. Type the following:
register global enhancement <a name for enhancement> <enhancement point> path
"com/dbmsvendor/jdbc/jdbc-driver/<the folder, where the driver is
located>/<jdbc-driver with version>.jar"
Your ARIS installation of version 9.x is now ready for the data migration.
Example
In case the location of the JDBC driver you are currently using with a Postgres database in ARIS
version 7.2, type the following:
register global enhancement MSSQLEnhancement commonsClasspath path "C:\Program
Files\ARIS7.2\server\lib\postgresql-jdbc3.jar"
Procedure
1. Back up the database in ARIS version 7.2.
2. Restore the database in ARIS version 9.x up to 9.5.
The users are added to the Administration and you can administrate them now there. All
passwords are deleted.
All user groups and permissions are transferred as far as the permissions and functional rights are
the same as in version 7.2. The user group names are composed of the database name and the
user group name.
You have to manually check whether the assignment of user groups and permissions are
migrated correctly and correct them manually if not.
In case you have a mixture of users who are administrated in the central user management of
ARIS version 7.2 and local users, please first refer to Migration of ARIS with Process Governance
with central user management (page 150).
148
Server Installation and Administration Guide
Precondition
In case of having used Process Governance, make sure that there are no governance
processes running when migrating the databases.
There will be only one tenant per LDAP server.
Procedure
1. Back up the databases you want to migrate to make sure that you can import the process data
later on.
2. Configure your new system with LDAP. Activate the automatic import of users and user
groups.
3. Restore the databases.
Check whether the user credentials and assignment to user groups are correct.
You can start working with your new system.
Procedure
1. Make sure, that there are no running Governance processes in the affected database.
2. Back up the database in ARIS version 7.2.
3. Restore the database in ARIS version 9.x up to 9.5.
All user groups and permissions are transferred as far as the permissions and functional rights are
the same as in version 7.2. The user group names are composed of the database name and the
user group name.
You have to manually check whether the assignment of user groups and permissions are
migrated correctly and correct them manually if not.
149
Server Installation and Administration Guide
Precondition
You need to have access to the data of version 7.2 and version 9.x for the data migration.
Therefore you have to have installed both ARIS version 7.2 and version 9.x in parallel.
You have enhanced (page 148) you ARIS version 9.x system with the relevant JDBC driver.
Procedure
1. Back up the database in ARIS version 7.2.
2. Copy the JDBC driver in the ARIS 9.x installation folder under
ARIS9.5/server/bin/work/work_umcadmin/base/webapps/umc/WEB-INF/lib.
You find this file in the ARIS 7.2 installation folder under ARISGE1.0\tomcat\lib.
3. Migrate the users from the central user management to the Administration using the batch file
y-datadump.bat.
4. Migrate the users from the central user management to the Administration using the batch file
y-datadump.bat (page 59).
5. Restore the database in ARIS version 9.x up to 9.5.
All user groups and permissions are transferred as far as the permissions and functional rights are
the same as in version 7.2. The user group names are composed of the database name and the
user group name.
You have to manually check whether the assignment of user groups and permissions are
migrated correctly and correct them manually if not.
Precondition
You need to have access to the data of version 7.2 and version 9.x for the data migration.
Therefore you have to have installed both ARIS version 7.2 and version 9.x in parallel.
You have enhanced (page 148) you ARIS version 9.x system with the relevant JDBC driver.
Procedure
1. Install (page 2) the ARIS version 9.x in parallel to your version 7.2.
2. Open a command prompt (Start > Run > cmd).
3. Navigate to the \\<ARIS installation folder\server\bin\work\work_<application
instance name>\tools\bin\ folder, e.g
D:\ARIS9.x\server\bin\work\work_ads_m\tools\bin.
150
Server Installation and Administration Guide
Procedure
1. Back up the database in ARIS version 7.2.
In ARIS, using the backup functionality in the pop-up menu of a database. If the size of the
backup file (ADB) exceeds 2 GB, errors may occur during restoration.
2. Restore the database in ARIS version 9.x up to 9.5.
3. Export filters, templates and script files in ARIS version 7.2.
In ARIS, using the Export functionality in the pop-up menu for a filter (individual back up).
4. Import all files to ARIS version 9.x.
All data will be converted while restoring and importing.
151
Server Installation and Administration Guide
152
Server Installation and Administration Guide
Make sure that the used OS user account can access only the specified directories.
The path data corresponds with Windows conventions. Slashes (/) are used as separators in
UNIX.
Directory/File Privilege
%TEMP% Read (r), execute (x),
write (w)
(pass on to files)
<ARIS installation
directory>\server\bin\work\work_abs_[s,m,l]\base\webapps\abs\lo Write (w)
g (pass on to files)
Write (w)
<ARIS installation (pass on to files and
directory>\server\bin\work\postgres_[s,m,l]\pgworkdata folders)
Write (w)
<ARIS installation (pass on to files and
directory>\server\bin\work\work_cloudsearch_[s,m,l]\rsindex folders)
153
Server Installation and Administration Guide
Directory/File Privilege
Write (w)
(pass on to files and
folders)
Create (c)
(pass on to folders)
Read (r)
(pass on to files)
Create (c)
<ARIS installation
directory>\server\bin\work\work_octopus_[s,m,l]\base\logs (pass on to folders)
Write (w)
(pass on to files and
folders)
Create (c)
(pass on to folders)
Read (r)
(pass on to files)
Delete (d)
<ARIS installation (pass on to folders and
directory>\server\bin\work\work_simulation_[s,m,l]\base files)
154
Server Installation and Administration Guide
The remote access user has access to ARIS Cloud Controller (ACC) (page 61). Change the
password (page 67).
Change the system user's and the superuser's passwords 'manager' and 'superuser'
The system user has all access and function privileges for all database and is automatically
created with every database. The superuser has all privileges in the Administration. Change
the passwords in the user's profiles in the Administration.
Create additional system users
System users have all function and access privileges in a database. To be on the safe side,
create additional system users besides the system system user. This way you can maintain
the database even if you forget the password for the system user (see help page Create
system user).
Back up your data (page 35) regularly
Administrators can back up (page 69) all tenant data to a zip file.
Administrators have various options for backing up the data managed on a ARIS Connect
Server or an ARIS Design Server using ARIS Server Administrator (page 101).
Currently, Java can only process files of up to a maximum of 2 GB safely. Thus, errors may
occur with larger backup files (ADB) and during database recovery. If errors occur during
backup or while restoring please use the backup mechanism in your database management
system (DBMS).
Version your database content
Versioning is used for versioning models. The benefit and purpose of archiving versions of
models is to allow different versions to be accessed.
155
Server Installation and Administration Guide
9 Basic Troubleshooting
If you face problems starting ARIS please read the following pages.
Problem
You cannot access ARIS, even when using a browser on the same machine.
Solution
Use the Start ARIS Connect Server/Start ARIS Design Server link in the start menu. Be
patient, once the command completes, try accessing ARIS again.
Problem
A SSL certificate is available (page 65) but ARIS clients cannot be started using SSL certification.
This may happen due to ARIS clients using Java trust store having trouble verifying the certificate
chain.
Solution
An additional certificate needs to be made available for the load balancer.
1. Download the zip file of the certificate from a certificate authority, e.g. GlobalSign.
2. Start ARIS Cloud Controller (ACC) (page 61).
3. Stop (page 64) the load balancer component.
4. Enhance the certificate using this command:
enhance <instanceID of the load balancer component> with sslCertificate local file
"<path to the downloaded zip file>"
5. Start (page 64) the load balancer component again.
The SSL certificate is available.
156
Server Installation and Administration Guide
Problem
After you have started the server (page 156) you still cannot access ARIS.
Solution
Open the ARIS Cloud Controller (ACC) (page 61) using the link in the start menu. Once the
prompt appears, type list. Check if all components are in state STARTED.
If the output of the list command shows one or more components in state STARTING please wait
a while and type list again.
Problem
Components still are in state STARTING.
Solution
Kill the component using the kill command. For example kill abs_m. Try starting it again with
the start command, e.g. start abs_m.
If the output of the list command shows one or more components in state FAILED or STOPPED.
Type startall. Once the command finishes give the components some time to complete startup
and type list to see their current state.
Problem
You have killed and restarted (page 157) a FAILED/STARTING component several times but it still
doesn't start up properly.
Solution
Port collisions are a common reason for components not starting up at all or not working properly.
Beware of port conflicts, e.g. web servers or programs like World Wide Web Publishing
Service or Routing and Remote Access might use the ports 80 and 443 by default.
1. Check the log files (page 102) for messages indicating port conflicts.
2. Find out the ports used by an ARIS component using the ACC (page 61) command show
instance <instanceId>,
e.g.
ACC+ localhost>show instance abs_m
ID: abs_m state:STARTED
type:com.aris.modeling.components.y-server-run-prod-9.0.
0-RC108-Trunk-SNAPSHOT)
Configuration parameters:
JAVA_OPTS=-server
-Xrunjdwp:transport=dt_socket,address=9704,server=y,suspend=n
157
Server Installation and Administration Guide
JAVA-Dcom.sun.management.jmxremote.port=9604
JAVA-Dcom.sun.management.jmxremote.ssl=false
CATALINA_PORT=10080
JAVA-Dcom.sun.management.jmxremote.authenticate=false
JAVA-XX\:MaxPermSize=256m
JAVA-Dcom.sun.management.jmxremote=/enabled
JAVA-Xmx=8g
zookeeper.connect.retry.time.ms=30000
zookeeper.bundle.type=abs
zookeeper.session.timeout.ms=60000
CATALINA_AJP_PORT=11080
3. Use the Windows netstat command to find ports used by other programs:
netstat –ao |more
4. Look for lines containing the port number(s) of the component that is not starting up properly
and which have the state listening.
Sometimes, two programs might startup and use the same port. Only the first program will be
reachable via this port.
Proto Local Address Foreign Address State PID
TCP 0.0.0.0:9701 MCY137201:0 LISTENING 5524
TCP 0.0.0.0:9702 MCY137201:0 LISTENING 4652
TCP 0.0.0.0:9703 MCY137201:0 LISTENING 5968
TCP 0.0.0.0:9704 MCY137201:0 LISTENING 3632
TCP 0.0.0.0:9705 MCY137201:0 LISTENING 9740
TCP 0.0.0.0:9706 MCY137201:0 LISTENING 6464
TCP 0.0.0.0:9707 MCY137201:0 LISTENING 6836
TCP 0.0.0.0:9708 MCY137201:0 LISTENING 6400
TCP 0.0.0.0:9709 MCY137201:0 LISTENING 7156
TCP 0.0.0.0:10080 MCY137201:0 LISTENING 2992
TCP 0.0.0.0:10080 MCY137201:0 LISTENING 6836
TCP 0.0.0.0:10081 MCY137201:0 LISTENING 3632
TCP 0.0.0.0:10082 MCY137201:0 LISTENING 7922
TCP 0.0.0.0:10083 MCY137201:0 LISTENING 4094
...
5. Use Windows Task Manager to identify the program that is using that port.
After you have stopped the program causing the conflict or redirected ports (page 66), all ARIS
components will start up properly.
158
Server Installation and Administration Guide
10 Known Restrictions
In general, it is advisable to use up-to-date hardware taking into account the number of users
who will be accessing the ARIS. For information about hardware and software requirements,
please refer to the ARIS Platform Matrix document (see installation media or download it
http://aris.softwareag.com/ARISDownloadCenter/ADCDocumentationServer).
Please consider the legal notices http://documentation.softwareag.com/legal/.
Despite the approval of our software for operation with the listed operating system versions and
other software and hardware requirements, we cannot exclude the possibility of problems arising
from unpredictable incompatibility issues with certain hardware/software combinations.
/static/help/{locale}/handling/ca/index.htm#52910.htm
and it should be changed to a version like this:
/static/help/{locale}/handling/connect/ca/index.htm#52910.htm.
The connect directory is missing there. But you also can take a look at a similar, proper
configuration in the default configuration.
159
Server Installation and Administration Guide
160
Server Installation and Administration Guide
11 Support
If you have any questions on specific installations that you cannot perform yourself, contact your
local Software AG sales organization.
By Telephone
If you have a valid support contract, you can contact us internationally at:
+800 ARISHELP
The "+" stands for the prefix required in a given country to dial an international connection.
Example for dialing within Germany with a direct extension line:
00 800 2747 4357
By Web Interface
https://empower.softwareag.com (https://empower.softwareag.com)
161
Server Installation and Administration Guide
12 Glossary
GUID
Globally Unique Identifier (GUID).
The GUID is a character set that uniquely identifies elements worldwide.
JAAS
Java Authentication and Authorization Service (JAAS).
This is a Java interface, which provides services for the authentication and for the access in Java
programs. JAAS supports a user based authentication.
OTP
One-Time-Pad (OTP).
This one-tine encryption is a symmetric encryption method to transfer messages. Its
characteristic is that the length of the encryption key is at least as long as the message itself.
OTP is considered information technology secure and cannot be broken.
SAML
Security Assertion Markup Language (SAML).
XML framework to exchange authentication information. SAML provides features to describe and
transfer security based information.
SSL
Secure Socket Layer (SSL).
Security software to encrypt data that are exchanged between programs.
SSO
Single Sign-on.
Using SSO has the advantage that a user only has to log in once to the network. The user need
only one login name and password to access all computers, services and programs whose usage
is allowed.
162
Server Installation and Administration Guide
System Database
This database manages the content of the configuration and evaluations nodes displayed on
ARIS' Administration tab, e. g. filters, templates and font formates as well as ARIS method
content and scripts.
The database is created while the first user logs in using an ARIS client. This content is available
in all ARIS databases within this tenant.
Tenant
A logical container into which users and groups are placed. It can represent a customer, a
department or another group of users. Tenants do not share any data.
Only users of tenant master are allowed to create, update or delete other tenants.
TLS
Transport Layer Security (TLS).
TLS is known under the name of Secure Sockets Layer (SSL). It is an encryption protocol to
ensure a secure data transfer through the Internet.
163