Create a console export file schedule

  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 Console Export Files.

    The Console Export Files page appears.

  3. In the tab pane, click Console Export File Schedules.
  4. Above the table, to the right, click Create Console Export File Schedule.
  5. In the Create Console Export File Schedule dialog box, enter the required information:
    OptionDescription
    EnvironmentThe Collibra environment for which to create an export file.
    Include

    You can create a full export file by selecting all of the options or a partial file by excluding some of the options.

     Data

    The core database data of the Collibra environment. This encompasses all data related to communities, domains, assets, users, operating model, and similar objects.

     History

    Data activity and snapshot-related information. This can result in a very large file, depending on the activity in Collibra.

    If you exclude the data history when creating an export file, you export a subset of the database content. This results in a much smaller file that still provides a complete picture of the current content. This is useful when attaching a backup to a technical support ticket, allowing support to reproduce a problem.

    Warning If you apply an export file from a 5.7.x version or older without history, the data quality metrics do not work correctly. To resolve this issue, apply the file in your latest environment, upgrade the data, create a new export file, and apply the new file 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 includes 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), such as the ones in:

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

    The name of the console export file schedule.

    Description

    The description of the console export file schedule.

    Schedule Retention

    The retention period for the export file, after which the file is automatically removed:

    • 7 days (default)
    • 30 days
    • 60 days

    Max retained

    The number of export files kept on disk. When this number is reached, a new file is created and the oldest file is deleted.

    Values must be between 1 and 50. Scheduled exports count towards the total limit. Only successful exports are counted. Failed exports are retained until expiration date.

    The default is 5.

    Cron expression

    The schedule of the export files. For more information about cron, see cron syntax.

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

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

Note The console export files created with a schedule are full exports, not incremental exports.

Tip You can create multiple schedules for one environment, such as a monthly schedule for export files with larger retention periods and a weekly schedule for export files with smaller retention periods.