Skip to content

CDP data export schedule

Configuration key

Configuration in Ibexa CDP allows you to automate the process of exporting content, users, and products. An ibexa_cdp.data_export configuration key looks as below:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
ibexa_cdp:
    data_export:
        schedule:
            user:
                -
                    interval: '*/15 * * * *'
                    options: '--stream-id=00000000-00000000-00000000-00000000 --user-content-type=user --no-draft'
                -
                    interval: '0 */6 * * *'
                    options: '--stream-id=00000000-00000000-00000000-00000000 --user-content-type=user --no-draft'
            content:
                -
                    interval: '*/30 * * * *'
                    options: '--stream-id=00000000-00000000-00000000-00000000 --content-type=article --no-draft'
                -
                    interval: '0 */12 * * *'
                    options: '--stream-id=00000000-00000000-00000000-00000000 --content-type=article --no-draft'
            product:
                -
                    interval: '*/30 * * * *'
                    options: '--stream-id=00000000-00000000-00000000-00000000 --product-type=computer --no-draft'
                -
                    interval: '0 */12 * * *'
                    options: '--stream-id=00000000-00000000-00000000-00000000 --product-type=computer --no-draft'

Under the schedule setting you can find separate sections for exporting user, content, and product. Structure of each section is exactly the same and includes interval and options elements:

  • Interval - sets the frequency of the command invoke, for example, '*/30 * * * *' means "every 30 minutes", '0 */12 * * *' means "every 12 hours". It uses a standard crontab format, see examples.
  • Options - allows you to add arguments that have to be passed to the export command.

This configuration allows you to provide multiple export workflows with parameters. It's important, because each type of content/product must have its own parameters on the CDP side, where each has a different Stream ID key and different required values, which are configured per data source.

Accepted options can be listed with the command below:

  • for User:
1
php bin/console ibexa:cdp:stream-user-data --help
  • for Product:
1
php bin/console ibexa:cdp:stream-product-data --help
  • for Content:
1
php bin/console ibexa:cdp:stream-content-data --help