The Job Scheduler allows you to schedule code to run at specified intervals. You schedule code to run by creating a job. Each job defines what code to run and when to run it. The code your job runs can be any backend function. You can schedule that code to run on an hourly, daily, weekly, or monthly basis. For example, you might create jobs that: Import data from an external source once a day. Delete collection data that is no longer relevant once a week. Send a status report to relevant parties once a month. Configuring Jobs You configure what jobs to run and when to run them in the file found in your site's Velo Sidebar, in the section. jobs.config Code Files, Backend To create a jobs.config file: Hover over the section in the Velo Sidebar. Code Files, Backend Click the add icon. Select . Job Scheduler The file contains a JSON object which defines the scheduled jobs. The object consists of the properties listed below. jobs.config You must publish your site to save changes to your jobs configuration. Note: jobs (Array) The jobs object contains one top-level key named "jobs". The key maps to an array of objects, each of which represents a scheduled job. Each scheduled job object contains the "functionLocation", "functionName", "description" and "executionConfig" properties that are detailed below. You can configure up to 20 jobs. The first 2 options below are for 1 job only. The 3rd option describes what a jobs file looks like with multiple jobs. Note: Option 1 - Using a CRON expression { : [
    { : , : , : , : { : }
    }
  ]
} "jobs" "functionLocation" "/module/filename.js(w)" "functionName" "funcName" "description" "describe your job" "executionConfig" "cronExpression" "0 8 * * *" Option 2 - Setting the time, day of week, and day of month Both lines 9 and 10 provide optional interval controls for your job. If you don't want that level of control you can delete either or both from your code. If you delete line 10 make sure to also delete the comma at the end of line 9. Important: { : [
    { : , : , : , : { : , : , : }
    }
  ]
} "jobs" "functionLocation" "/module/filename.js(w)" "functionName" "funcName" "description" "describe your job" "executionConfig" "time" "08:00" "dayOfWeek" "Monday" "dateInMonth" 1 jobs.config with more than 1 job The following is an example of what the jobs.config file looks like with more than 1 job (3, in this case), using a CRON expression. It is meant to display the structure of the array of objects with more than one object. As noted above, you can schedule up to 20 jobs, and to do that you would add more objects following the pattern described here. Note that there is a comma between each object (lines 10 and 18) but that the final object does not have a comma afterwards (line 26). Note: { : [
    { : , : , : , : { : }
    },
    { : , : , : , : { : }
    },
    { : , : , : , : { : }
    }
  ]
} "jobs" "functionLocation" "/module/filename.js(w)" "functionName" "funcName1" "description" "describe your job1" "executionConfig" "cronExpression" "0 8 * * *" "functionLocation" "/module/filename.js(w)" "functionName" "funcName2" "description" "describe your job2" "executionConfig" "cronExpression" "0 8 * * *" "functionLocation" "/module/filename.js(w)" "functionName" "funcName3" "description" "describe your job3" "executionConfig" "cronExpression" "0 8 * * *" functionLocation (String) The location of the file of the backend function that contains the function you want to run at the scheduled time. The function can be any function in any backend or file. The function location is a relative path within the folder. .js .jsw Backend For example, if you want to run the deleteExpired() function as shown below: Set the " functionLocation " value to " /utils/dbUtils.js ". functionName (String) Name of the function you want to run at the scheduled time. Make sure you the function that you want the job scheduler to call. Important: export For example, if you want to run the deleteExpired() function as shown below: Set the " functionName " value to " deleteExpired ". description (String) - optional A description of the job. executionConfig (Object) An object containing information about when the job should run. You can define when the job runs using a cron expression or by specifying a time of day and optionally a day of the week or date in the month. Important: Jobs occuring more than once a day must be defined using a cron expression. If both specifications exist for a single job, only the cron expression will be used. Cron Expression When using a to specify when a job runs, the " " object contains a single property, named " ", whose value is a valid cron expression. cron expression executionConfig cronExpression cronExpression (String) A valid . For example, to run a job every day at 8:00 in the morning, use: cron expression : "cronExpression" "0 8 * * *" When using a cron expression, you can schedule your job to run at intervals as short as one hour apart, but not shorter. If you define your job to run more frequently, the job will be ignored. Important: Time, Day, and Date Jobs defined using the " ", " ", and " " properties can run on a daily, weekly, or monthly basis. In all cases using this option, the " " object must contain a " " property which defines the time of day the job will run. time dayOfWeek dateInMonth executionConfig time For daily jobs, the " " object only contains the " " property. executionConfig time For weekly jobs, the " " object contains the " " property and a " " property that defines on what day of the week the job runs. executionConfig time dayOfWeek For monthly jobs, the " " object contains the " " property and a " " property that defines on what day of the month the job runs. executionConfig time dateInMonth time (String) The time of day the job runs. The time is specified as in format. UTC time HH:MM The job will run within 5 minutes after the specified time. Note: dayOfWeek (String) - optional For weekly jobs, add the property to the object. The property defines what day of the week the job runs on. dayOfWeek executionConfig dayOfWeek For daily or monthly jobs, omit the property. dayOfWeek The value of the dayOfWeek property is one of: " ", " ", " ", " ", " ", " ", or " ". Sunday Monday Tuesday Wednesday Thursday Friday Saturday dateInMonth (Number) - optional For monthly jobs, add the property to the object. The property defines what day of the month the job runs on. dateInMonth executionConfig dateInMonth For daily or weekly jobs, omit the dayOfWeek property. The value of the property is a number between and . dateInMonth 1 31 Previously published at https://support.wix.com/en/article/velo-scheduling-recurring-jobs

How To Use Velo API To Work with Forms

How To Run Recurring Jobs using Velo by Wix

About Author

Comments

TOPICS

THIS ARTICLE WAS FEATURED IN

Related Stories

Untitled Story

5 Hot Velo Practices to Test and Debug Your Website Code

10 VSCode Extensions To Make Your Life Easier

10 Ways Stand Out as a Java Developer and Land that Dream Job

10 Tips For Junior Developers To Succeed in Code

10 Things Every Beginner Should Know When Learning Javascript And React

5 Hot Velo Practices to Test and Debug Your Website Code

10 VSCode Extensions To Make Your Life Easier

10 Ways Stand Out as a Java Developer and Land that Dream Job

10 Tips For Junior Developers To Succeed in Code

10 Things Every Beginner Should Know When Learning Javascript And React

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps