Schedule Series EAP

What are Schedule Series

Schedule Series allow you to schedule multiple updates and sequentially apply them to a specific field of your entry.

As an example, Schedule Series can be used to update discounts and prices according to a set schedule when running a sales campaign.

How Schedule Series work

Schedule Series is an app that is installed in a space and enabled on a content type level. In the content type, a "Reference" field with "One reference" relationship type is set up. When creating or editing an entry, a user adds nested entries (referred to as future values) to this field and schedules each of them to be published on a specific date and time in the future. When the scheduled date and time set for a specific future value come, the entry is updated with this future value and published.

Optionally, a user can also add a default value that is applied to the field till the moment the future values are applied.

Structure of a Schedule Series entry

The image and description below explain the structure of a Schedule Series entry:

• Schedule series field—The field in the entry to which a default value and future values are added.

• Default field value—A nested entry or asset that is displayed when no future values are applied to the field.

• Future values—Nested entries or assets that are applied to the field when their scheduled date and time come.

Schedule series setup

To start using Schedule series, go through the following setup stages:

1. Install Schedule Series App.

2. Enable Schedule Series App in the content type.

Install Schedule Series App

To install Schedule Series App:

1. Log in to the Contentful web app.

2. In the top pane, click Apps and select Manage apps.

3. Navigate to the "Schedule Series App" and click Install.

4. Select a space and an environment in which the "Schedule Series App" will be installed.

Enable Schedule Series App in the content type

To enable Schedule Series App in the content type:

1. Log in to the Contentful web app.

2. Go to the Content model tab.

3. Either create new content type for scheduled field updates by clicking Add content type or open an existing one to edit it.

4. Click Add field.

5. Select Reference as a field type. New "Reference Field" window is displayed.

6. In the Name field, enter a custom name for your field.

7. Make sure that One reference radio button is selected.

8. Click Create and configure.

9. Go to the Appearance tab and select Schedule Series App as a field display option.

10. Click Confirm. Your field is saved and the Schedule Series App is enabled for the selected content type.
    

    

Schedule series in an entry

To set up schedule series in an entry:

1. Log in to the Contentful web app.

2. Go to the Content tab.

3. Access the required entry by either creating a new entry or editing an existing one. The entry editor page is displayed.

   NOTE: Make sure the entry belongs to a content type with Schedule Series App enabled.
   

4. Optional: Click Add Content and select an entry to be displayed as a default value in the schedule series field.

5. Under the SCHEDULE SERIES area, click + Add to Series. The entity selector is displayed.
   

   

6. Select the required entry to add it as a future value to the SCHEDULE SERIES area. The "Set schedule" window is displayed.

7. Select the required date, time and timezone for publishing your scheduled update.

8. Click Schedule. The future value is added and scheduled for publishing.
   

   

9. Repeat steps 5-8 to add another future value to the SCHEDULE SERIES area.

   IMPORTANT! Make sure the entries added as future values are in a Published state or are scheduled to be published at the same time as the future values.

   NOTE: The entry with schedule series can be in either "Draft" or "Published" state. Whenever a future value is applied, the entry is republished.

Technical limits

• During the EAP, Schedule Series app is supported for "Reference" fields with only "One reference" relationship type.

• A maximum of 10 future values can be added to a single reference field (if you need more, please let us know).

• Schedules made through the Schedule Series app will count towards the limits for Scheduled Actions within your space (500 upcoming scheduled in total & no more than 200 at the exact same time).

Known limitations

• Creating new environments—The schedules made when using the Schedule Series app will not be copied across to new environments upon creation. Keep in mind that if you change the target environment of your master alias, your schedule series will be lost (notably during your CI/CD process).

• Schedule Series preview—There is currently no way to select an upcoming scheduled value within an entry that has the app implemented, for the purpose of preview.

  NOTE: To preview an entry with a specific future value, edit the"Draft" state of your entry adding this future value as default one and then opening your preview as you would ordinarily.
  

• Compatibility with Launch—Schedule Series are not be compatible with releases in Launch, although we plan to add support in the future.

• Locales—Schedule Series EAP only supports the default locale in the entry. Other locales won't be displayed. You can define multiple locales on the level of future values.