Report-based

The report-based Outbound generator works similarly to the SqlDef-based processer, using a report’s SqlDef directly instead of a custom SqlDef. This allows the user to leverage the report’s custom DateRange filters as the Start and End Date values, which will then be used during Outbound processing.

images/download/attachments/144836091/image-2023-2-2_10-21-40-1-version-1-modificationdate-1675354900000-api-v2.png

The generator must include the fully qualified report name (i.e., ZBKS.AllBooks). If we want the report to filter by a DateRange, the generator must provide the fully qualified DateRange field (i.e., ZBKS.Book.PromotionalPeriod). We can see that ZBKS.Book.PromotionalPeriod matches with our filter field within our report. The platform will bind the last execution date as the START_DATE and the present date as END_DATE. You can also provide an “Initial Net Change Interval”, which applies to the initial execution of the generator. If omitted, START_DATE will default to Jan 1, 1970. If provided, START_DATE will be the present-day minus the number of days given.

images/download/attachments/144836091/image-2023-2-2_10-22-56-1-version-1-modificationdate-1675354976000-api-v2.png

images/download/attachments/144836091/image-2023-2-2_10-23-14-1-version-1-modificationdate-1675354994000-api-v2.png

Once the Report Name and DateRange bindings are provided, we can schedule this Outbound to run on our custom schedule. Every time the Outbound runs, it generates our file based on the report SqlDef with the report DateRange filters applied. As mentioned above, the START_DATE will be the last execution date, and the END_DATE will be the present date.

images/download/attachments/144836091/image-2023-2-2_10-23-53-1-version-1-modificationdate-1675355033000-api-v2.png

Complete the following steps to create an Integration Subscription for your report-based Outbound:

  1. Open your report.

  2. Favorite the report by clicking the star button.

    images/download/attachments/144836091/image-2023-2-2_10-24-14-1-version-1-modificationdate-1675355054000-api-v2.png



  3. Click the Schedule Report button.

    images/download/attachments/144836091/image-2023-2-2_10-24-21-1-version-1-modificationdate-1675355061000-api-v2.png



    A popup appears.

    images/download/attachments/144836091/image-2023-2-2_10-24-59-1-version-1-modificationdate-1675355100000-api-v2.png



  4. Click the Schedule Report button again.
    A confirmation popup appears.

  5. Click Yes.
    The New Integration Subscription screen appears.

    images/download/attachments/144836091/image-2023-2-2_10-25-31-1-version-1-modificationdate-1675355131000-api-v2.png



  6. Fill out the following fields. Fields marked with an asterisk ( * ) are required.

    Field

    Description

    * Category

    Select a category from the dropdown menu.

    * Outbound Interface

    Select an outbound interface from the dropdown menu.

    * Outbound Interface Version

    Select an outbound interface version from the dropdown menu.

    Use Favorite

    Select this checkbox to use this subscription as a favorite.

    Favorite Name

    Select a favorite name from the dropdown menu.

    At this point, you can create your schedule and finish setting up the Integration Subscription as normal.