Schedule Data Entity Overview
  • 09 Dec 2020
  • 2 Minutes to read
  • Dark
    Light

Schedule Data Entity Overview

  • Dark
    Light

Article summary

Overview

This article reviews how to create and use Schedule Data Entity. Schedule Data Entity is an Entity that stores and tracks custom schedules. Different Schedule Data may be created within 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 a 'working days schedule' and demonstrates how to use it in a Flow.

  1. Begin in a Designer Project.
  2. Right-click the Designer Project and select Add > Entity > Schedule Data.
  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.
    For reference:
    Included - will run on defined days/times
    Excluded - will NOT run on defined days/times
  6. Set the Length to 8 hours.
  7. In ScheduleType, select a suitable schedule template (ex: DailySchedule).
  8. Select the desired days of the week in Schedule Data > Day Info (ex: Monday - Friday).
  9.  Use the EndType dropdown to set when the Schedule should end, then select OK to save the changes.
    • No End - Schedule is indefinite.
    • By Date - define a constant date when the Schedule ends
    • By Occurrences - ends the schedule after a provided number of runs.
      The Schedule Data is created and can be managed in the Folder it was created in.
      9_LookAtScheduleData.png 

Schedule Data Entity in a Flow

Schedule Data Flow Steps
From Toolbox tab, Integrations > All Integrations > Internal Services > SchedulingService
  1. In a Designer Project, select CREATE FLOW from the top Actions bar.
  2. Select Flow, Name the Flow and select CREATE.
  3.  Select the Done path of the Start step.
  4. ADD the ReturnNextValidSlotInSchedule step to the Flow.
  5. On ReturnNextValidSlotInSchedule provide the Inputs.
    In a separate window or tab, find the Folder Id of the Designer Project; right-click the Designer Project and select Manage > Get Designer Folder ID.
  6. Click Copy Text then select DONE to close the dialog window.

  7. Return to the ReturnNextValidSlotInSchedule step's Properties in the Flow Designer, then select Constant mapping for the folder id input, and paste in the Folder ID.

  8. Under proposed Date, select a Constant Date mapping.
    To test if the configured dates are respected, choose Saturday (not in previously configured Schedule).

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

  10. Save the Flow then, if desired, select to close the Flow.


Debug

  1. Select Debug from the top Action bar of the Flow Designer to test the Flow.
  2. Run the Flow in FULL
  3. Select the ReturnNextValidSlotInSchedule step on the execution diagram and select View Output Data.
    Note the data Output displays the next available slot is on Monday, as configured.

Was this article helpful?