Skip to main content

Get help for ARIS

Manage databases

Databases contain all information of your models and objects, classified in groups. The database content is available in Published content Published content or in ARIS Repository (Models and objects Models and objects). Only authorized users have access to database content, depending on the privileges assigned to the user and the privileges specified for each database.

If you have the Admin role and the Configuration administration function privilege, you can manage all databases available on a tenant. Click Application launcher Application launcher > Administration Administration and click Databases to get an overview about all settings for each database.

For each database, you can select a method filter that is automatically used to log in authorized users. Filters ensure that users see only the information and methods that are relevant to them.

  1. To change the the default filter, click the current Default filter name in the row of the relevant database. The available filters are displayed.

    If <Invalid filter> is displayed, the database was restored to the tenant but the related default method filter was not available at that time. In this case, first import the method filter and then assign it as the default filter.

  2. Select the filter and click Save.

The method filter is automatically assigned to authorized users and user groups.

To ensure that users can read text regardless of the selected language, you can choose a default database language. The default language of a database is used to display text that was not entered in the current language. For example, names that are not entered in the current language are otherwise displayed as <Untitled>, which makes work more difficult. If users enter all language-dependent text attributes in the default language, the displayed written text is legibly, though not uniformly in one language.

  1. To change the default language, click the current Default language name in the row of the relevant database. The available languages are displayed.

  2. Select the language in which all attribute values are specified and click Save.

The selected language is used as an alternative database language. Note that you must enter all language-dependent attribute values in the selected language to prevent items from being displayed as <Untitled>.

Font formats for databases define the representation of database content in models. They are available only in the database for which they are created. Font formats are closely related to templates.

For each database, you can select the font format that is automatically used if users have not assigned a template to models.

  1. To change the default font format, click the current Default font format name in the row of the relevant database. The available font formats are displayed.

  2. Select the font format that you want to use and click Save.

The font format is automatically used to display model content if no template is assigned.

For each database, you can apply a default symbol palette. You can change the default palette to display all model objects of a database in a different style. The ARIS default palette contains the most current symbols. The ARIS default palette (classic) contains all object symbols used in ARIS 7.2 Method.

  1. To change the default palette, click the current Default palette name in the row of the relevant database. The available default palettes are displayed.

  2. Select the relevant palette and click Save.

The palette is assigned as the default palette. All objects are displayed in the database using the symbols of the selected palette.

If you have switched from the classic to the current symbol palette, all model objects are enlarged. Therefore, you may need to adapt the layout of the models in Administration client.

You can add databases to the tenant and make them available to authorized users.

  1. Click Create database Create database.

  2. Enter the database name. You can enter numbers, spaces, letters, and the following special characters: - _ . ( ). Note that using special characters can cause problems when such databases are called by command-line tools and special characters are not escaped correctly.

  3. Select whether the database should be empty or filled with predefined content.

  4. Specify the default filter. This option is disabled if you have selected predefined content.

  5. Enable Versionable if you want to allow users to create multiple model versions. Keep in mind that for versionable databases, the amount of required memory increases.

  6. Click Create.

The database is added to the list. Specify all database Properties Properties as required.

You can restore databases using ADB backup files that you created in ARIS, Administration client, or Tenant Management. You can also use the Restore database function to copy databases to multiple tenants or to convert an existing database to a versionable database.

  1. Click Import Restore. Make sure that sufficient disk space is available for restoring large databases. This may exceed the memory requirements stated in the document ARIS System Requirements.

  2. Click Select file, navigate to the ADB backup file, and click Open.

  3. If a database of the same name already exists on this tenant, enter a different database name. Otherwise, the action is stopped to prevent the database content from being overwritten. You can enter numbers, spaces, letters, and the following special characters: - _ . ( ). Note that using special characters can cause problems when such databases are called by command-line tools and special characters are not escaped correctly.

  4. If the backup file is protected by a password, enter the password that was specified when the database was backed up.

  5. Choose whether you want to store multiple data versions in the restored database. Versionable databases increase the amount of memory required. To reduce the size of a versionable database, select Versionable database with current data only, no previous versions. This will only import current data from the backup file, but no versions.

  6. Click Restore.

The database is available on this tenant.

You can duplicate databases to use them for similar projects. A duplicated database is an exact copy of its source, but has a new GUID, so the copy has no relation to its source. This prevents accidental overwriting of data by older backup copies of the source.

  1. Select the database and click Duplicate Duplicate.

  2. Enter the database name that you want to use for the copy. You can enter numbers, spaces, letters, and the following special characters: - _ . ( ). Note that using special characters can cause problems when such databases are called by command-line tools and special characters are not escaped correctly.

  3. Click Duplicate.

The database is available for all users of the tenant who have access to the source database.

Change the database settings as required.

You can delete databases that you no longer want to use. Make sure that the database that you want to delete is not published in ARIS.

Warning

All data contained will be lost. Make sure to back up the database before you delete it. You can always restore a database from its backup file.

  1. Select the database and click Delete Delete.

  2. To confirm the action, click Delete.

The database is no longer available.

You can change the name of a database in the current language. Note that renaming the database will result in the loss of comments on models and objects.

  1. Select the database and click Rename Rename.

  2. Enter the database name. You can enter numbers, spaces, letters, and the following special characters: - _ . ( ). Note that using special characters can cause problems when such databases are called by command-line tools and special characters are not escaped correctly.

  3. Click Rename.

The database is renamed.

You can automatically delete object and connection definitions that do not have occurrences in any model in the database. This reduces the size of databases.

For safety, back up databases before reorganization. Then you can restore the data at any time.

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.

  1. Select the database and click Reorganize Reorganize.

  2. Enable the required settings.

  3. Click Reorganize.

If you do not change the default settings, the result overview is displayed automatically. The result overview lists all results of the reorganization jobs cumulatively. If you disable Show always, the results are shown only if you click Show reorganization jobs.

You can check detailed results for each reorganization, download details as a text file, or delete results that you no longer need from the overview.

Save the content of your databases before making any major changes.

  1. Select the database and click Export Back up. The name of the database is used as the name of the backup file.

  2. If multiple versions are available, select the database content that you want to back up.

    Workspace: Includes the editable version and the entire versioned content of a database.

    Current version: Corresponds to the last versioned database content. This version includes the entire versioned content of a database.

    Change list number: Number and description of a version of the database content. You can select a specific change list. This reduces the size of the backup file because only the content of the selected change list is included.

  3. Enable Encrypt backup file to prevent unauthorized users from restoring the database and having full access to the content.

  4. Enter a password and confirm it. Make sure to remember the specified password. Otherwise, you cannot restore the database content using this backup file.

  5. Click Back up, specify the file path and file name if required, and click Save.

The file is saved according to the settings specified in your browser. If errors occur when you back up large databases, use the backup mechanism in your database management system (DBMS). Make sure that sufficient disk space is available. This may exceed the memory requirements stated in the document ARIS System Requirements.

You can restore database content based on the content saved in this file or make the databases available to multiple tenants.