Articles in this section
Server Side Scripts & Jobs User Guide
Table of Contents
Introduction
This User Guide lists all the articles that will aid you in using the Server Scripts & Jobs Add-on.
Server Scripts & Jobs
The Server Scripts & Jobs Add-on aids you in writing server-side scripts for executing diverse tasks.
You can use this Add-on for custom processes on the server, that can be triggered by record updates or scheduled intervals. You can enact custom actions upon record saving or approval/rejection with this capability. You can also devise bespoke background tasks to execute at predetermined intervals. This article also lists samples and use cases.
Click here to read about this add-on.
Writing Code for Server Scripts and Jobs
Learn about writing code for server-side scripts and jobs. This article also lists a few helper methods provided, which are available by default to make your work easier.
Click here to read the article.
Using Custom Server Scripts in Processes, Workflows, and Approvals
Server-side scripts can be written and executed on actions such as record save, approval, or rejection. They can be configured in workflows, processes, or approvals and triggered on selected actions. These scripts should be used for lighter operations like creating records in different modules, sending emails through external services, etc.
Click here to learn how to use custom server scripts in your processes, workflows, and approvals.
Running Custom Background Tasks with Vtiger Server Jobs
Server Jobs are background tasks that run periodically based on a configured frequency (hourly, daily, weekly, etc.). You can use these for heavy and periodic operations like fetching data from external services or applications, creating records from imported data in the CRM, or sending data to external applications.
Click here to learn how to run custom background tasks with Vtiger Server Jobs.
Helper Methods for Server Scripts and Jobs
Here are a few examples of Helper methods that can be used for scripting. Click the links to read the articles.
- Helper Method for Server Scripts and Jobs - Debugging
- Helper Method for Server Scripts and Jobs - HTTP Request
- Helper Methods for Server Scripts and Jobs - Vtiger REST API
Server Scripts Use Cases
Here are a few use cases for Server Scripts. Click the links to read the articles.
- Server Scripts Example - Update the Credit Score of a Contact
- Server Scripts Example - Contact Email Validation and Data Enrichment
- Server Scripts Example - Calculate Outstanding Invoice Amount for an Organization
- Server Scripts Example - Set Case SLA by Created Day
Server Jobs Use Cases
Here are a few use cases for Server Jobs. Click the links to read the articles.