Create a backup schedule

A backup schedule allows you to automatically create backups in a defined schedule. This reduces the risk of forgetting to create backups and possible data loss.

Note The backups that are taken with a backup schedule are full backups, not incremental backups.

Steps

  1. Open Collibra Console with a user profile that has at least the ADMIN role.
    Collibra Console opens with the Infrastructure page.
  2. In the main menu, click Backups.
    The backups page appears.
  3. In the tab pane, click Backup schedules.
  4. In the upper-right corner, click Create backup schedule.
  5. Enter the required information:
    OptionDescription
    EnvironmentThe Collibra environment that you want to back up.
    Include

    You can create:

    • a full backup: Includes all backup options.
    • a partial backup: Includes only a couple of the backup options.
     Data

    The core (database) data contained in the Collibra environment. This is all the data related to communities, domains, assets, users, operating model and so on.

     History

    The history of the data (activity and snapshot-related). This can result in a very large file, depending on the activity in Collibra.

    If you create a backup of the data and exclude the data history, you are taking a backup of a subset of the database content. This results in a much smaller backup file, but it still contains a complete picture of the current content. This is useful when attaching a backup to a technical support ticket, if support has to reproduce a problem.

    Warning If you restore a backup that does not include history and was made from a version older than 5.7.x, the data quality metrics will not work correctly. To solve this issue, after you restore the backup in your latest environment, upgrade the data, create a new backup and restore the new backup in the same environment.

     Configuration

    The configuration of the Collibra environment.

     Customizations

    The customizations such as custom modules, styling, page-definitions and email template files.

    This will add files that are located in the Collibra user home directory and files that are used to customize the Collibra environment (/opt/collibra_data/console/config). This concerns all the files located in the following directories:

    • email-templates
    • groovy-lib
    • images
    • page-definitions
    • security
    • styling
    • translations
    • modules (if available)

    Name

    The name of the backup. You can only use the following characters in the backup name:

    • letters
    • numbers
    • hyphen ( - )
    • underscore ( _ )
    • period ( . )
    DescriptionThe description to provide more information on the backup.

    Max retained

    The number of backups that you want to retain. The default value is 30.

    Cron expression

    The schedule of the backups. For more information about the CRON syntax, see the CRON appendix.

    If you create an invalid cron pattern, Collibra stops responding.

  6. Click Create backup schedule.
    The schedule appears in the schedule table.

Tip You can create multiple schedules for one environment. For example, one schedule for monthly backups that are kept for two years and another schedule for weekly schedules that are kept for only a couple of months.