Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 5 Next »

Platform URL

https://[enterprise].cvtr.io/v2/campaigns/{campaignId}/admin/scheduled-delivery

API Endpoints

Not Applicable

Epic

CON-5548 - Getting issue details... STATUS

Document status

IN PROGRESS

Document owner

Danny Hannah Adam Carter

Technical writers

Arunima Kurup Prasad

Related Content

Scheduled Delivery

🏠 Feature Overview

Using Scheduled Delivery, leads are scheduled to be delivered at different times and at different intervals. The schedule is configured using the ‘configuration’ widget available in the ‘Schedule’ column on the Scheduled Delivery page. This widget is the basis for both Campaign based Scheduled Delivery and Publisher based Scheduled Delivery and allows us to configure the schedule at various intervals as explained below.

When Scheduled Delivery toggle is enabled, the configuration widget can be seen in the ‘Schedule’ column as shown in the screenshot.

Screenshot 2024-03-26 at 14.02.01.png

By default, there are 4 mandatory fields to be filled in by the user.

  1. Start Date: This is a calendar field that can be used to configure the date on which Scheduled Delivery must begin on the campaign.

Validation

There is validation on the platform to ensure that the Start Date lies between the campaign’s start and end dates.

Screenshot 2024-03-26 at 14.18.53.png
  1. Repeat Every

This setting determines the schedule interval. By default, the value is set to ‘1' and repeat unit is set as ‘Week(s)’. This means, the configured schedule will repeat every 1 week from the 'Start Date’ configured.

Screenshot 2024-03-26 at 14.20.07.png

The user can configure ‘Repeat Every’ to be any positive whole number. 0 and negative numbers are not permitted.

The user can select the repeat unit from:

  • Day(s)

  • Week(s) and

  • Month(s)

Validation

If the repeat unit selected is Week(s) or Month(s), then the ‘Repeat On’ configuration will be available. If the repeat unit selected is Day(s), then the ‘Repeat On’ configuration will not be available.

  1. Repeat On

The ‘Repeat On’ option will be available only if repeat unit selected is Week(s) or Month(s).

When repeat unit is ‘Week(s)’, user will be able to select the days of the week on which the schedule must repeat. In the below example, the schedule is configured to run on all weekdays beginning from the Start Date.

Screenshot 2024-03-26 at 14.27.18.png

The days of the week can be configured as per the requirements of the campaign. The next scheduled date is calculated as below when the repeat unit is ‘Week(s)’:

Start date

Repeat interval (weeks)

Repeat on

Schedule previously run on:

Current date

Expected next scheduled date

2024-09-01 (Fri)

2

Fri, Wed

Not available

2024-09-01

2024-09-01 (Fri)

2024-09-01 (Fri)

2

Fri, Wed

Not available

2024-09-02

2024-09-13 (Wed)

2024-09-01 (Fri)

2

Fri, Wed

Not available

2024-09-07

2024-09-13 (Wed)

2024-09-01 (Fri)

2

Fri, Wed

Not available

2024-09-13

2024-09-13 (Wed)

2024-09-01 (Fri)

2

Fri, Wed

2022-09-13

2024-09-13

2024-09-15 (Fri)

2024-09-13 (Wed)

2

Fri, Wed

Not available

2024-09-13

2024-09-13 (Wed)

When repeat unit is ‘Month(s)’, user will be able to select the day of the month on which the schedule must repeat. The following options are available for monthly scheduled delivery:

i. 'N’th day of the month

ii. First day of the month

iii. First day of the month excluding weekends

iv. Last day of the month

v. Last day of the month excluding weekends

Screenshot 2024-03-26 at 14.29.27.png

The first option 'N’th day of the month depends on the Start Date selected. In the above example, the Start Date is the 14th of the month. Hence, the schedule can be configured to repeat on the 14th of every month. If the Start Date is configured as the 1st, then the first option would be 1st day of the month as shown below.

Screenshot 2024-03-26 at 14.32.56.png

The rest of the options can be selected if the schedule is to be repeated on day 1 of the month (including/excluding weekends) or on the last day of the month (including/excluding weekends).

Validation

When the option ‘Last day of the month’ is selected, the platform will schedule the lead to be sent on the last day of the month, which could be the 30th or 31st, depending on the month.

It could also be the 28th if the schedule runs in February of a non leap year.

It could be the 29th if the schedule runs in February of a leap year.

The next schedule date is calculated as below when the repeat unit is ‘Month(s)’:

Start date

Repeat interval (months)

Repeat on

Schedule previously run on:

Current date

Expected next scheduled date

2024-09-01

2

First day of month

Not available

2024-09-01

2024-09-01

2024-09-02

2

First day of month

Not available

2024-09-01

2024-11-01

2024-09-01

2

First day of month

Not available

2024-09-02

2024-11-01

2024-09-01

2

First day of month

Not available

2024-10-01

2024-12-01

2024-09-01

2

First day of month

Not available

2024-11-01

2024-11-01

2024-09-01

2

First day of month

2024-09-01

2024-09-01

2024-11-01

2024-09-01

2

First day of month

Not available

2024-09-15

2024-11-01

2024-08-28

1

nth day of the month (n=28)

Not available

2024-09-01

2024-09-28

2024-08-28

1

nth day of the month (n=28)

Not available

2024-09-30

2024-10-28

2024-01-29

1

nth day of the month (n=29)

Not available

2024-01-15

2024-01-29

2025-01-29

1

nth day of the month (n=29)

2025-01-29

2025-02-01

2025-03-29 (2025 not being a leap year, feb is skipped)

2024-01-29

1

nth day of the month (n=29)

2024-01-29

2024-02-01

2024-02-29 (2024 being a leap year)

2025-01-30

1

nth day of the month (n=30)

2025-01-30

2025-02-01

2025-03-30 (feb is skipped)

2025-01-31

1

nth day of the month (n=31)

2025-01-31

2025-02-01

2025-03-31 (feb is skipped)

2024-09-15

1

15th (nth) day of the month

Not available

2024-09-15

2024-09-15

2024-09-15

1

15th (nth) day of the month

2024-09-15

2024-09-15

2024-10-15

2024-08-01

1

Last day of the month

Not available

2024-08-01

2024-08-31

2024-07-01

1

Last day of the month

2024-07-31

2024-07-31

2024-08-31

2024-07-01

2

Last day of the month

Not available

2024-07-01

2024-07-31

2024-07-01

2

Last day of the month

2022-07-31

2024-09-30

2024-09-30

2025-01-01

1

Last day of the month

2025-01-31

2025-02-01

2025-02-28

2024-02-01

1

Last day of the month

Not available

2024-02-01

2024-02-29 (2024 being a leap year)

2025-02-01

1

Last day of the month

2025-02-28

2025-03-01

2025-03-31

2025-02-01

2

Last day of the month

2025-02-28

2025-02-28

2025-04-30

2024-01-01

1

Last day of the month

2024-01-31

2024-02-01

2024-02-29 (2024 being a leap year)

2022-07-01 (Fri)

1

Last day of the month (excl. weekends)

Not available

2022-07-20

2022-07-29 (Fri) since 2022-07-31 is a Sunday

2024-03-01 (Fri)

1

First day of the month (excl. weekends)

Not available

2024-06-01 (Sat)

2024-07-01 (Mon)

2024-03-01 (Fri)

3

First day of the month (excl. weekends)

Not available

2024-06-01 (Sat)

2024-07-01 (Mon)

\uD83D\uDDD2 Summary

Summarise the functionalities in a table

Functionality

User Story

1

2

3

Table Filtering

Allows the user to filer the table values using column names

4

Custom Tables

A user can add, remove and reset columns for custom table

\uD83D\uDDD2 User Permissions

Mention if access needs to be enabled for any user roles and attach the user matrix.

https://docs.google.com/spreadsheets/d/1i4qTTKkC3rF3EyEOh2585ktDDGge0L0IMVDNCwriFR0/edit#gid=415459484

  • No labels