Schedule Data Entity

Overview

This article reviews how to create and use the Schedule Data Entity feature. Schedule Data Entity is an Entity that stores and tracks custom schedules. Different Schedule Data may be created in the same Folder in Decisions, allowing all Schedule Data Entities in that Folder to be treated as a single complex schedule. This feature saves time when building processes that require complex schedule calculations.

Example

This example creates a Schedule Data Entity that simulates 'working days schedule' and demonstrates how to use it in a Flow.

1.  Begin in a Designer Folder.
2. Select All > Add > Entity > Schedule Data on the Folder Actions Panel.
3. In the Schedule Data dialog, provide a name for the Schedule (ex: Meeting).
4. Click Start Date Time (when the Schedule starts); set the time to 9:00:00, the equivalent of 9 am.
5. Set the Type Of Schedule to Included.

   Type of Schedule	Property
   Included	will run on defined days/times
   Excluded	will NOT run on defined days/times

6. Set the Schedule Length (duration of each instance of a schedule) to 8 hours.
7. In Schedule Type, select a suitable schedule template (ex: Daily Schedule).
8. Select the desired days of the week in Schedule Data > Day Info (ex: Monday - Friday).
9. Use the EndType drop down to set when the Schedule should end, then select OK to save the changes.

   EndType	Property
   No End	Schedule is indefinite, or has no end
   By Date	define a constant date when the Schedule ends.
   By Occurrences	ends the schedule after a provided number of runs.

10. The Schedule Data is created and can be managed in the Folder it was created in.

Schedule Data Entity in a Flow

1. In a Designer Folder, select CREATE FLOW in the bottom Folder Actions Panel.
2. Name the Flow and select CREATE.

3. Navigate to All Steps [Catalog] > Integrations > Internal Services > Scheduling Service in the Flow Designer.

4. Add the ReturnNextValidSlotInSchedule step to the Flow.  
5. Provide the Input data (Folder ID and proposed Date).

Folder ID

1. This is the Folder ID of the Designer Folder where the Schedule Data lives; To find it, select All > Manage > Get Designer Folder ID on the Folder Actions Panel.
2. Copy the Folder ID (click Copy Text) and select DONE to close the dialog window.
3. Return to the ReturnNextValidSlotInSchedule step in the Flow Designer.
4. Paste the Folder ID into the folder Id > Constant input field.

Proposed Date

Pick Constant; to test if the configured dates are respected, choose Saturday (not in the previously configured Schedule).

Complete the Flow by connecting the ReturnNextValidSlotInSchedule step's outcome path to the End step.

Select Debug on the top panel of the Flow Designer to test the Flow.

The Flow should execute in the Debugger with no issues. 

Select the ReturnNextValidSlotInSchedule step on the execution diagram and select View Input/Output Data.

Note the View Input/Output Data window displays that the next available slot is on Monday, as configured.