Schedule a Test

Introduction

Scheduling is another unique and powerful aspect of API Fortress. We make it simple to schedule a test to run as often as you’d like, from any location you choose (based on account type), and with granular control as to when it runs. Let’s take a look at how it works.

Step 1: Publish the Working Copy

API Fortress has a unique working copy/published copy system. This system allows you to edit a test without affecting the live, currently active version. You can learn more about it here. Step 1 is to publish your working copy. After you finish editing your Working Copy, click the “Publish” button (highlighted below) to publish it.

Step 2: Schedule

Click Schedule button to access the Scheduling control panel.

Step 3: Create a New Schedule

Click + Create New Run to create a new scheduled run of your test. 

schedulerTopPage

schedulerOverrides

 

Step 4: Fill Out the Fields

Name – This is how you will identify your scheduled test in the future. We’d recommend sticking to the “Test Name – Schedule” convention. For example, a good name might be “Test 1 – Every 10 Minutes.”

Pause Toggle – This will prevent the run from triggering if clicked. 

Try Second Execution Toggle – When this checkbox is selected, another execution will be run after 2m 30s if the initial execution fails.

Downloader – This dropdown allows you to choose which datacenter the resources will be retrieved from.

Time configuration – This section allows you to choose which minutes of the hour, which hours of the day, which days of the month, and which months of the year the test is going to run. This feature gives you the degree of granularity required to schedule executions around a weekly scheduled deployment, or any number of other recurring events. 

Variable Override – This is another unique feature of API Fortress. This section allows you to override any variable that is defined in the Global or Data Set sections of the test. One example is to create a new run that executes in the morning and late afternoon where the variable you override is the domain. Therefore, twice a day the staging environment is tested.

 

Global Scheduler

By selecting the Global option from the Test drop down you can schedule a unified run for all or some of the tests available in the project.

Unlike the scheduler for a single test, this one has an additional section where you can select the tests you want to schedule together.

globalSection

Note: The key/value pairs inserted in the overrides section at the bottom of the page will be used for all of the selected tests. If you need to add values for an individual test out of the collectively scheduled tests, you must add them for the single test. To do so, you have first save the scheduled run. Once the schedule is saved, the icon highlighted below will appear next to each individual text. You can add override values via this icon.

overrideGlobal