Advanced ARIS Server Administrator commands

The command line tool ARIS Server Administrator is available if you have installed ARIS Server or the ARIS Administrator Tools (see ARIS Client Installation Guide contained in the downloaded ARIS installation package, ARIS Download Center, or Empower).

If you have installed ARIS Server, navigate to ARIS installation path>\server\bin\work\work_abs_<s, m, or l>\tools\arisadm and run the batch file.

You can find detailed information about default commands in the ARIS Architect online help (see: ARIS Configuration and Administration > ARIS Server and Tenant Management > ARIS Server Administrator) or in the related user guide.

The following commands are meant only for advanced administration.

Command

Description and syntax

checkdb

Checks one or all databases for integrity.

This command must not be used for standard database administration. Use this command only to check your database for integrity problems after having performed a manual database migration. If the checkdb command prompted the message needs optimization for a database, run the prepareoptimizedb command. The prepareoptimizedb command generates a repair file that you can use together with the optimizedb command to bring databases back to optimal use.

You can use the following options:

  • <dbname>: If you enter the name of a database, only this specific database is checked.

  • all: Checks all databases.

  • WORKSPACE_ONLY: Checks only the workspace of one or all databases.

  • INCL_ARCHIVE: Checks the workspace and all versions of one or all databases.

  • FULL: Performs the full set of tests. Full is the default setting. Therefore, there is no need for you to enter this parameter if you want to use it.

Syntax

<dbname>|all WORKSPACE_ONLY|INCL_ARCHIVE FULL

prepareoptimizedb

Checks one or all databases for integrity.

This command must not be used for standard database administration. Use this command only to check your database for integrity problems after having performed a manual database migration. If the checkdb command prompted the message needs optimization for a database, run the prepareoptimizedb command. The prepareoptimizedb command generates a repair file that you can use together with the optimizedb command to bring databases back to optimal use.

You can use the following options:

  • <dbname>: If you enter the name of a database, only this specific database is checked.

  • all: Checks all databases.

  • WORKSPACE_ONLY: Checks only the workspace of one or all databases.

  • INCL_ARCHIVE: Checks the workspace and all versions of one or all databases.

  • FULL: Performs the full set of tests. Full is the default setting. Therefore, there is no need for you to enter this parameter if you want to use it.

Syntax

<dbname>|all WORKSPACE_ONLY|INCL_ARCHIVE FULL

optimizedb

Restores the integrity of one or all databases if required.

This command must not be used for standard database administration. Use this command only to bring your database back to optimal use after having performed a manual database migration and having run the checkdb and prepareoptimizedb commands. To use the repair file generated by the prepareoptimizedb command, specify the path to the downloaded file as a parameter, for example:

optimizedb <copied path to the repair file>

You can use the following options:

  • <dbname>: If you enter the name of a database, only this specific database is checked.

  • all: Checks all databases.

  • WORKSPACE_ONLY: Checks only the workspace of one or all databases.

  • INCL_ARCHIVE: Checks the workspace and all versions of one or all databases.

  • FULL: Performs the full set of tests. Full is the default setting. Therefore, there is no need for you to enter this parameter if you want to use it.

Syntax

<dbname>|all WORKSPACE_ONLY|INCL_ARCHIVE FULL