Submit a request Sign In
  • Logout
    Home  >   FAQs   >  What is a Server Script?
    FAQs in this section
    What is VTAP? What tools VTAP provides? What is Module Designer? What is API Designer? Where can I find documentation for VTAP? Which editions and version supports VTAP? What is the pricing of VTAP? What happens to customization done using Customizer in V7 version? How to get in touch with Platform team? What is the intent of Developer edition? What is Vtiger’s Add-on Publisher? Is Add-ons Publisher available in all the CRM editions? How do I publish Email Template add-ons? How do I publish any other module as an add-on? How do I update a published add-on? How do I test an add-on? What are the limitations of the Add-ons Publisher? Which different add-on features can I publish? What can a developer publish using Add-on Publisher? What are the conditions for updating a published add-on? What are the prerequisites for publishing an add-on? What is an Insights Designer? What is the use of Insigts Designer in Vtiger CRM? What are the queries in Insights Designer? What are the components of the Insight Designer? What are the components of a Widget in Insights Designer? What is the Input tab in Insights Designer? What is the Transfer tab in Insights Designer? What is the Output tab in Insights Designer? What are the benefits of using the Insights Designer? How do I access the Insights Designer in Vtiger CRM? How do I create an Insights page? How do I enable filters for a report? How do I pin an Insight to the Dashboard? Is Raw Query support available by default? In which editions of Vtiger CRM is the VTAP - App Creator available? Can I set access to my custom apps? What are Line Item Fields in Insights Designer? What are Server Scripts and Jobs in Vtiger CRM? What are Server jobs? How do I create a Server job? What are the different helper methods to write server scripts? What is the Debugging method to write Server scripts? What are HTTP methods to write server scripts? What is Vtiger REST API method to write server scripts? How to write code for Server Scripts and Jobs? How to write a script for a server job to update stocks weekly in the warehouse system? How to write a script for a server job for importing daily leads from a file? How to write a server script to set case SLA by created day? How to write a server script to calculate the outstanding invoice amount? How to write a server script for contact email validation and data enrichment? how to write a server script to update the credit score of a contact? How can I delete a UI component in the Module Designer?

    What is a Server Script?

    Table of Contents
    Scripts are triggered on a record save, approval, or rejection. Scripts can be configured in workflows, processes, or approvals and triggered on selected actions. These scripts get record data (which is getting saved) as well as user data. If any change is made to record data and returned, changed data will be updated back to the CRM record (like an update field action).

    This should be used for lighter operations like updating some field data based on complex logic, which is impossible through workflow expressions, creating records in other modules based on some logic and different mapping, sending emails through external services on certain conditions, etc. These scripts are run immediately and block the save operation. If your script takes more time, record save also will become slower.
     

    Code format

    async function main(record, user) {
    //Type your code here


    return record;
    }
     
    • record - Data of CRM record getting saved having record id, module name, label and all field values.
    • user - Current user data including user id, label, role, preferred currency details, timezone and all field details.
    You can test the server scripts as soon as you write the code in workflows, processes and approvals with the option provided to select a record and verify the code. Once the test is executed, you will see a response with the text status, execution time, input, output, etc. You can see the logs once published. For Process, you will see a Logs tab beside the script and for Workflows and Approvals, you can access the logs from the List View.
    Was this FAQ helpful?
    0  out of  0  found this helpful.
    Comments 0
    Be the first to comment
    Home
    Privacy Policy
    Terms of Service
    Security Center
    Policy & Legal Center
    Contact Us
    © Copyright 2023 Vtiger. All rights reserved.
    Powered by Vtiger