Documentation

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

1. Set a unique title for a new custom extraction template.
2. Add a short description (optional).
   
3. Choose the Data Source for which you want to create a custom template. This drop-down list contains only global templates, which can be the base for a new custom template.
4. Click Continue to move to the second step.

Step 2

1. Set the Aggregation by date filter to show only parent templates of the particular data class (e.g., Daily).
2. Choose the parent template from the drop-down list.
3. Configure the extraction template.

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 as a parent template. 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 settings include three main fields, the additional fields depend on the chosen extraction period:

• 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 have the option to schedule data extractions on an hourly basis (every 4, 6, 8, or 12 hours), as well as daily, weekly (by selecting a specific day of the week), and monthly (by choosing a particular day of the month).
If you choose the Hourly extraction period, start now and start at set time options will appear:

Start Now Option:

• This option is designed for immediate data extraction. As soon as you select 'Start Now,' the extraction process will commence using the current time as its starting point.
• This is particularly useful for obtaining real-time data, conducting immediate analyses, or when working with time-sensitive information. It ensures that you have the most current data without any delay.

Start at Set Time Option:

• With this option, you can schedule the extraction to begin at a specific time of your choosing. This is ideal for planning extractions to align with specific business processes or reporting schedules.
• You can set the extraction to start at a time that ensures data is fresh and relevant for your daily operations, such as the beginning of your workday, or just before important meetings or decision-making processes.

After choosing either of these options, the system will automatically calculate the timing for the next extraction based on your initial choice.

Note:  Hourly schedule is available by request only. Please contact your Customer Success Manager for more details.  

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.