Skip to main content

Get help for ARIS

How to start ARIS Cloud Controller (ACC)

ACC is a command-line tool for administrating and configuring an ARIS installation. ACC communicates with the ARIS agents on all nodes. You can use ACC in multiple modes (see Technical Help: ARIS Cloud Controller Command-Line Tool). Read the documents on the ARIS Documentation website or download them from the ARIS Download Center.

Warning

ACC commands will majorly impact your system. They require profound knowledge of the technical ARIS infrastructure and environment. This knowledge can be acquired only by attending related training courses. These are provided by ARIS Academy. According to the standard software maintenance agreement, we cannot guarantee proper functioning if you use ACC commands without this knowledge or without our services.

ARIS Cloud Controller (ACC) can be used in three modes:

Interactive mode (default)

ACC runs with an interactive shell, allowing you to manually issue commands.

Batch mode

Batch mode is activated by specifying a command file with the -f command line parameter (see ACC command line parameters below). ACC will execute the commands in the file in the given sequence and exit after execution or if one of the commands fails.

A command file line starting with # will be interpreted as a comment line and ignored by ACC.

Command mode

You can directly pass a single command to ACC as a command line parameter. The command will be executed and ACC will exit.

When passing commands directly as a command line parameter, you must be careful when escaping strings in your command, for example, double-quote-delimited parameters. The operating system command shell will eliminate the double quotes, leaving your string parameter un-escaped. Therefore, make sure to escape the quote characters and special characters.

Examples

If you issue the command in command mode, for example:

    set remote.repository.url="http://something.com/repo"

you must enter:

    acc.bat -h localhost -u <user name> -pwd <remoteAccessPassword> set remote.repository.url=\"https://something.com/repo\"
                     

If you enter:

    acc.bat -h localhost -u <user name> -pwd <remoteAccessPassword> set remote.repository.url="https://something.com/repo"
                     

ACC will return an error message, for example:

    line 1:52 mismatched character '<EOF>' expecting '\n'
    Invalid or erroneous command "set     remote.repository.url=https://something.com/repo ": line 1:30 extraneous i    nput ':' expecting EOF
    Use "help" to display a list of available commands.

This also affects passwords and names containing special characters. If you try to back up your tenants with the following command, make sure to escape the quote characters and the special character & used in the password User&12345.

If your user name or password includes any special character, add a backslash (\) before the character for ACC to process the special character as a string. If your password contains an ampersand (&), add a backslash before the ampersand.

    ./acc.bat -h localhost -u Clous -pwd g3h31m -p 18011 -c     ../generated.apptypes.cfg backup tenant default username=\"admin\"     password=\"User\&12345\"
                     

To obtain information about the usage of ACC commands, enter help or help <command>.

Windows operating system

To start ACC under a Windows operating system, click Start > All Programs > ARIS > Administration > Start ARIS Cloud Controller. If you changed agent user credentials you must enter the user name and/or the password.

Linux operating system

To start ACC under a Linux operating system, execute the acc10.sh shell script. To do so, enter: su -c acc10.sh aris10. After the ARIS server installation was completed on a Linux operating system, the aris10 user is locked and has no password. Command-line tools (sh files), such as ARIS server Administrator or ARIS Cloud Controller can only be started by the aris10 user related to the ARIS agent.

  • To unlock the aris10 user, enter: passwd -u aris10

  • To interactively enter a password, enter: passwd aris10

  • To start the command-line tools, enter: su -c acc10.sh aris10 or su -c arisadm.sh aris10

  • To execute these command-line tools as an ARIS user without root privileges, you must enter the password of the aris10 user.

  • To copy files manually into the ARIS directory, as the aris10 user enter the commands: su aris10 and sudo aris10

    As an ARIS user without root privileges, you must make sure that the files have the correct ownership (aris10 ).

  • To lock the aris10 user again enter: passwd -l aris10