Introduction

Server Jobs are background jobs which run periodically based on configured frequency (hourly, daily, weekly, etc). This should be used for heavy and periodic operations like fetching data from external services and creating them in CRM, or sending specific data based on a particular logic to external services, etc.

These are run in the background and no CRM operation is blocked. Based on configured frequency, they are picked and sent to service for execution. Service queues them and executes based on its own load. After execution, the service sends the result back to the CRM. No user or record data is passed to the script and it runs on owner user context.

Use Cases

• Update available stocks to the warehouse system weekly.
• Importing daily leads from the website to CRM.
• Generating periodic reports using CRM data based on custom business logic.

Creating Server Jobs

You can create server jobs in the Server Jobs module in the CRM.
Follow these steps to create a new server job:

1. Log in to your CRM account.
2. Click the Main Menu.
3. Click Platform.
4. Select Server Jobs. You will see a list of available server jobs.
5. Click the Add Server Job.
6. Enter or select information for the following
   1. Job Name: Enter a name for the job.
   2. Assigned to: Select a user from the drop-down to assign the job.
   3. Frequency: Select a frequency from the drop-down and select the desired duration.
7. Click Save.
8. Type your code in the provided editor.
9. Click the Playground tab.
10. Click Execute and Verify to validate your code.
11. Change the Status to Active to run the job.

You can view the execution logs of Server Jobs running in the background. To view logs, click on the Logs button on the Server Jobs page. You can click on each log to see its full details.

Code Format

Kindly refer this document to learn more about how to code, helper methods, etc.