Schedule Tools

Overview

Schedules define recurring triggers that invoke a Logic Flow at a given frequency and interval, starting from a given date. Logic Assist supports searching, listing, reading, previewing, creating, and updating Schedules. Requires the Logic Composer product.

The get_schedule_preview_url tool takes a cacheEntryStrategy (a CacheEntryStrategy: Volatile, Ephemeral, or Constant) that controls how the previewed schedule value is cached.

ScheduleRunFrequency values:

Value	Meaning
Minute	Runs every n minutes
Hour	Runs every n hours
Day	Runs every n days
Week	Runs every n weeks
Month	Runs every n months

(where n is the interval.)

---

search_schedules

Searches Logic Fabric schedules by name.

Parameter	Type	Required	Description
scheduleName	string	✓	The name of the schedule to search for.

Returns: Matching Schedules including name, frequency, interval, start date, linked logic flow, title, description, and project.

---

list_schedules

Lists Logic Fabric schedules.

Parameter	Type	Required	Description
projectId	GUID		The ID of the project to filter schedules by. Optional.
pageNumber	int		The page number for pagination. If not provided, defaults to the first page. Optional.
pagingCookie	string		The paging cookie for pagination. This should be provided if pageNumber is provided and there are more records to retrieve. Optional.

Returns: A paginated list of Schedules including name, frequency, interval, start date, next run date, last run date, linked logic flow, title, description, and project.

See Pagination for details on iterating through large result sets.

---

get_schedule_details_by_id

Gets the details for a Logic Fabric schedule by schedule ID.

Parameter	Type	Required	Description
scheduleId	GUID	✓	The ID of the schedule.

Returns: Full Schedule details including name, frequency, interval, start date, next run date, last run date, linked logic flow, title, description, and project.

---

get_schedule_preview_url

Get a preview URL for a Logic Fabric schedule.

Parameter	Type	Required	Description
scheduleName	string	✓	The name of the schedule.
projectId	GUID	✓	The ID of the project for the schedule.
value	string	✓	The value for the schedule.
cacheEntryStrategy	CacheEntryStrategy	✓	The cache entry strategy for the schedule.
timeToLive	int	✓	The time to live for the schedule cache entry in minutes.
title	string		The title for the schedule. Optional.
description	string		The description for the schedule. Optional.

Returns: A preview URL for the schedule record.

---

create_schedule

Creates a new Logic Fabric schedule and returns the schedule id.

Parameter	Type	Required	Description
scheduleName	string	✓	The name of the schedule to create.
projectName	string	✓	The name of the project to create the schedule in.
logicFlowId	GUID	✓	The ID of the logic flow associated with the schedule.
frequency	ScheduleRunFrequency	✓	The frequency for the schedule.
interval	int	✓	The interval for the schedule.
startDate	DateTime		The start date for the schedule. Optional.
title	string		The title for the schedule. Optional.
description	string		The description for the schedule. Optional.

Returns: The GUID of the newly created Schedule and its URL.

Restriction: Cannot be called on projects associated with a managed solution. See Managed Solution Protection.

---

update_schedule_value

Updates Logic Fabric schedule metadata.

Parameter	Type	Required	Description
scheduleName	string	✓	The name of the schedule to update.
projectName	string	✓	The name of the project for the schedule to update.
frequency	ScheduleRunFrequency	✓	The frequency for the schedule.
interval	int	✓	The interval for the schedule.
startDate	DateTime		The start date for the schedule. Optional.

Returns: Confirmation that the schedule was updated.

Restriction: Cannot be called on projects associated with a managed solution. See Managed Solution Protection.

Best practice: Always read the current schedule first (via get_schedule_details_by_id or search_schedules) before updating, to avoid unintentionally overwriting the frequency, interval, or start date.