Documentation

How to Create a Custom Extraction Template

There are two ways to create a custom extraction template:

  • Click the Create a template button in the top right corner of the Extraction Templates page.
  • Click the Create template button on step 2 of the extraction order creation flow.
  • ~In this case, the difference is that you will create a custom template for a predefined data source. You can not edit it.

Step 1

Let’s start with configuring the general settings. 

General settings

  • Set a template name
  • ~It must be unique for the same agency and connector
  • Fill in the custom template description
  • Select the necessary connector from the drop-down list
  • Сhoose an existing template to use its settings as a pre-fill setting for a new template
  • ~This drop-down list contains only global templates, which can be the base for a new custom template.

Step 2

This step is similar to step 3 of the extraction order creation flow. It contains the following settings blocks: 

  • Custom settings
  • Scheduling settings
  • Dimensions and metrics

Custom settings

Custom settings depend on the global template that you selected in the Pre-fill settings from an existing template field. For example, this settings block may include:

  • Historical data depth
  • ~Here you need to specify the period (in days) for which historical data will be loaded
  • Load data since
  • ~Custom parameter allowing to set up an initial date to data loading (instead of lifetime)

Scheduling settings

Here you can set the frequency of data extraction for your custom extraction template by changing the scheduling settings and adding or deleting schedules.

One schedule is always created by default. You can add one or several more by clicking Add Schedule on the top right corner of this section. If this is not available, it means you have reached your limit. The contract determines the limit. To increase it, please get in touch with your Customer Success Manager.

Also, can delete the schedule by clicking the “trash bin” icon, but it is impossible to delete a schedule if it is the only one.

The schedule has three fields:

  • extraction period allows you to set how often Improvado attempt to load your data to Improvado database.
  • extraction time determines the exact time for the Improvado extraction schedule.
  • extraction time zone determines the time zone for this extraction schedule.
  • lookback window is the period before data extraction, for which data is extracted regularly.

Extraction period

Now you can schedule data extraction daily, weekly (by selecting the day of the week), and monthly (by choosing a day of the month).

Lookback window

The first schedule will always have a default lookback window:

  • in days for daily extraction template
  • in weeks for weekly extraction template
  • in months for monthly extraction template

IMPORTANT: no lookback window for last day and last day (inc) extraction templates.

Previously the subsequent schedules had a Live lookback window. Now we’ve added the possibility to choose the max lookback window option.

Dimensions and metrics

Some dimensions and metrics are selected by default. You can not deselect them because they define the data table structure.

After making all the necessary changes, you can click the Create button to finish the custom template editing process and save a new custom template. If you need to discard changes, click the Cancel button.

In both cases, you will be redirected to the page where you started this process. It could be:

  • Extraction Templates Page
  • ~If you have created a new custom template, you will see it in the extraction templates list
  • The 2 step of extraction order creation flow
  • ~If you have created a new custom template, you will see it in the list of the available templates.
Related articles
No items found.
No items found.