Skip to main content

Schedule How To's

How to's for the Schedule guide.

Triggering A REST API From Scheduler​

Create or open a scheduler file. In the Jobs section, click Add to create a new job. Under the Then section, click Add > RestAPI Invoke Action. In the right-side property panel:
Enter a Name and Description.
Select a valid Datasource containing your REST definition.

Ensure that a trigger is defined to activate this action.

Starting A Workflow From Scheduler​

Open or create a scheduler file in the project. Under the Jobs section, add a new job. In the Then section, select Process Start Invoke Action. In the Property Inspector, configure:
Project: Select the project that contains the target flow.
Flow: Select the workflow to start.
Flow Parameters (optional): Pass data to variables in the flow.

Make sure the selected flow:
Has a Start Immediately node.
Does not require a document in the Flow Start node.

Restricting Trigger Execution With A Calendar​

Go to the Calendars section of the scheduler file. Click Add and choose a calendar type (e.g., Holiday, Weekly). Define the time or date exclusions. In the trigger configuration panel, set the Enable Between field to link the calendar. The trigger will now skip execution during the excluded periods.

Setting A Personal Access Key For A Job​

Open your scheduler file and expand the Jobs section. Click on the job that requires execution. In the Property Inspector, locate the Personal Access Key field. Paste the token obtained from Web Interface > My Account > Personal Access Keys. Make sure the key has permissions to execute the defined action (e.g., Start Flow, Call API).

Configuring A Cron Trigger​

Open your scheduler file and create or select a job. In the Triggers section, click Add > Cron Trigger. In the Property Inspector, enter:

  • Name and Description
  • Enable Between range
  • Expression (e.g., '0 0 12 ? * MON-FRI')
  • Misfire Rule
  • Time Zone

Link the trigger to a job with defined actions. Test using a known Cron format to ensure expected timing.

Adding A Method Invoke Action​

Add a job to your scheduler file under the Jobs section. In the Then section, click Add > Method Invoke Action. In the Property Inspector, fill in the required fields:
Assembly Path: Select the DLL file from Document Management.
Type Name: Enter the namespace and class (e.g., 'MyNamespace.MyClass').
Method Name: Provide the method to be called.
Method Arguments: (If needed) Enter method parameters.
Default Values: (Optional) Set constructor parameters.

Assign a valid Personal Access Key to the job. Add a trigger to activate the action.

Validating Scheduler Configuration​

Ensure all jobs have:
A valid Personal Access Key
At least one defined Trigger
At least one Action in the Then section
Verify Start Immediately is enabled in Flow Start Nodes (if using flows).
Check calendar exclusions don’t conflict with trigger timing.
Review trigger misfire rules and time zones.
Optionally, test the job manually using a short interval trigger before final deployment.

Adding A Trigger To A Job​

Open the scheduler file from the Schedules folder. Under the Jobs section, click Add to create a new job. In the job block, locate the Triggers section. Click Add, then select a trigger type:
Simple Trigger
Daily Time Interval Trigger
Cron Trigger

Configure the trigger's general settings and time constraints in the right panel.

Creating A New Schedule​

Go to the Solution Explorer, right-click on the Schedules folder, then click New Item. Choose Scheduler from the list, enter a name for your scheduler file (e.g., 'MyScheduler'), and click Create to add it to your project.

Configuring A Calendar For Scheduling Exceptions​

Open the scheduler file in the Schedules folder. Scroll to the Calendars section and click Add. Select the type of calendar:

  • Daily
  • Weekly
  • Monthly
  • Holiday
  • Annual
  • Cron
    Set the exclusion rules (e.g., working hours, weekends, holidays). In the trigger section, set the Enable Between calendar field to activate the exclusion.