ARIS Server Administrator Command-Line Tool
ARIS Server Administrator Command-Line Tool
ARIS Server Administrator Command-Line Tool
SERVER ADMINISTRATOR
COMMAND-LINE TOOL
Contents
1 ARIS Server Administrator ...........................................................................................................1
1.1 Execute the backupsystemdb command..................................................................... 11
1.2 Execute the restoresystemdb command .................................................................... 12
1.3 Execute the updatesystemdb command .................................................................... 12
1.4 Execute the userwipeout command ............................................................................ 13
2 Legal information....................................................................................................................... 15
2.1 Documentation scope ................................................................................................... 15
2.2 Support........................................................................................................................... 15
I
SERVER ADMINISTRATOR COMMAND-LINE TOOL
1
SERVER ADMINISTRATOR COMMAND-LINE TOOL
▪ If you use values with special characters (example: & in the password), you must enclose
the value in quotes. For additional information, please refer to the help and support
center for your operating system.
▪ On the server, system messages in ARIS Server Administrator are always output in the
ARIS installation language.
▪ For example, if you use scripts for daily backups, we strongly recommend that you
protect these scripts at the operating system level, or enter passwords encrypted.
Option Description
-s <server[:<port>]> Server on which the command should be carried out.
-u <user> <password> User name and password of a system user with the
required privileges.
-sc <schema context> Context the schema uses. ARIS is set as the default.
-t <tenant> Tenant for which the command should be carried out. The
default is no tenant.
Replace the text surrounded by <pointed brackets> by your individual values. The parts of the
command that are surrounded by [brackets] are optional. You can use them if necessary.
Default commands are listed below. Advanced commands are described in related documents
if required.
2
SERVER ADMINISTRATOR COMMAND-LINE TOOL
3
SERVER ADMINISTRATOR COMMAND-LINE TOOL
4
SERVER ADMINISTRATOR COMMAND-LINE TOOL
5
SERVER ADMINISTRATOR COMMAND-LINE TOOL
migrate Migrates an ARIS 7.1 or 7.2 database <dbname> from an ADB file
<archive>, or migrates all ADB files from a directory
<archivedir>. You need the password of the system user
system to migrate an individual database. To migrate multiple
databases the passwords must be supplied to every single
database in command-line mode. Use the -fv option (forward
versioning) to store database versions only for ARIS versions
prior to 10.0.14.
Syntax
migrate [<archive>|<archivedir>]|<systempassword> [-fv]
6
SERVER ADMINISTRATOR COMMAND-LINE TOOL
7
SERVER ADMINISTRATOR COMMAND-LINE TOOL
8
SERVER ADMINISTRATOR COMMAND-LINE TOOL
setindexrank Sets the initial index rank for a database <dbname>. The higher
the rank <rank>, the earlier the index is started during cloud
search startup. The rank is a number, for example, 5.
Syntax
setindexrank <dbname> <rank>
statistic Returns the number of all database objects.
Syntax
statistic <dbname>|all
threaddump Triggers a thread dump on instance <instanceID>. An instance
ID can refer to a runnable, such as abs <s, m, or l> or report <s,
m, or l>, or to a runnable type, such as abs or report.
The thread dump is written to the threaddump.log file.
Syntax
threaddump <instanceID>
unlockdb Unlocks the database with the name <dbname>, or all
databases.
Syntax
unlockdb <dbname>|all
9
SERVER ADMINISTRATOR COMMAND-LINE TOOL
In the following example, a database is reorganized, whereby all of the objects and
connections in the database that do not have an occurrence are deleted.
Warning
If you are using an object library, you should reorganize databases only when each object
definition occurs in at least one overview model. If elements have already been created for
later use but do not yet occur in models, these elements are deleted during the consolidation.
Reorganization in interactive mode
1. Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0. The
MS DOS input window opens and ARIS Server Administrator is launched in interactive
mode.
2. Use the server command to connect to the relevant ARIS Server:
Syntax
server <server name>[:<port number>] <tenant> <user name>
The parts of the command that are surrounded by brackets are optional, that is, you can
use them if necessary.
Example
server arissrv.eur.ag:80 default system
The password is requested.
3. Enter the user's password. In this example, manager. The connection is established.
4. Enter the command for the reorganization of the United Motor Group database:
10
SERVER ADMINISTRATOR COMMAND-LINE TOOL
Prerequisites
▪ ARIS Server Administrator is installed.
▪ You know the credentials of the superuser, or you have the Server administrator function
privilege.
Procedure
1. Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if
you accepted the program group suggested by the installation program. Under a Linux
operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c
arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is
launched in interactive mode.
2. Establish a connection to the server and tenant:
Syntax: server <server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager
3. Enter backupsystemdb <archivedir>[<alternatename>].
11
SERVER ADMINISTRATOR COMMAND-LINE TOOL
The system configuration, managing, for example, ARIS method extensions, report scripts,
scheduled reports, macros, semantic checks, filters and templates, of this tenant will be
saved.
Prerequisites
▪ ARIS Server Administrator is installed.
▪ You know the credentials of the superuser, or you have the Server administrator function
privilege.
▪ You have access to the backup file (<archive>)
Procedure
1. Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if
you accepted the program group suggested by the installation program. Under a Linux
operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c
arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is
launched in interactive mode.
2. Establish a connection to the server and tenant:
Syntax: server <server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager
3. Enter restoresystemdb <archive>.
The system configuration, managing, for example, report scripts, macros, semantic checks,
filters and templates, of this tenant will be restored.
Prerequisites
▪ ARIS Server Administrator is installed.
12
SERVER ADMINISTRATOR COMMAND-LINE TOOL
▪ You know the credentials of the superuser, or you have the Server administrator function
privilege.
▪ You have access to the most recent system database (<installation DVD
3>/Content/SystemDB/<ADB file>)
▪ You have backed up all data that will be overwritten during the update.
Procedure
1. Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if
you accepted the program group suggested by the installation program. Under a Linux
operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c
arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is
launched in interactive mode.
2. Establish a connection to the server and tenant:
Syntax: server <server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager
3. Enter updatesystemdb <name of ADB file on DVD>.
The system configuration of this tenant, managing, for example, ARIS method extensions,
report scripts, scheduled reports, macros, semantic checks, filters, and templates, will be
updated. User-defined changes made in the configuration will remain.
Warning
Make sure to only anonymize deleted users. If you anonymize existing users, the user names
are anonymized in all attributes, such as Creator, Last modifier, and the user names in
change list descriptions.
Prerequisites
▪ ARIS Server Administrator is installed.
▪ You know the credentials of the superuser, or you have the Server administrator function
privilege.
▪ The database must be locked for other users.
13
SERVER ADMINISTRATOR COMMAND-LINE TOOL
Procedure
1. Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if
you accepted the program group suggested by the installation program. Under a Linux
operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c
arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is
launched in interactive mode.
2. Establish a connection to the server and tenant:
Syntax: server <server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager
3. Enter: userwipeout <dbname>|all <user>,<user>
User identifications of one or multiple users are deleted from one or all databases. The
attributes Last modifier, Creator, and the user name in change list descriptions is set to
unknown.
14
SERVER ADMINISTRATOR COMMAND-LINE TOOL
2 Legal information
2.2 Support
If you have any questions on specific installations that you cannot perform yourself, contact
your local Software AG sales organization
(https://www.softwareag.com/corporate/company/global/offices/default.html). To get
detailed information and support, use our websites.
If you have a valid support contract, you can contact Global Support ARIS at: +800
ARISHELP. If this number is not supported by your telephone provider, please refer to our
Global Support Contact Directory.
15
SERVER ADMINISTRATOR COMMAND-LINE TOOL
ARIS COMMUNITY
Find information, expert articles, issue resolution, videos, and communication with other ARIS
users. If you do not yet have an account, register at ARIS Community.
TECHCOMMUNITY
On the TECHcommunity website, you can find documentation and other technical
information:
▪ Use the online discussion forums, moderated by Software AG professionals, to ask
questions, discuss best practices, and learn how other customers are using Software AG
technology.
▪ Access articles, code samples, demos, and tutorials.
▪ Find links to external websites that discuss open standards and web technology.
▪ Access product documentation, if you have TECHcommunity credentials. If you do not,
you will need to register and specify Documentation as an area of interest.
16
SERVER ADMINISTRATOR COMMAND-LINE TOOL
17