Prerequisite

Create and Configure a Script

1. Navigate to (settings) >> CodeX >> click Scripts in the menu.
2. Click the New Script button.
   
3. Code the script according to your business requirements.
4. Provide the following execution details:
   
1. Script Name: Enter a name for your server script.
   
2. Execution Location: Select the location where the script should run.
   
3. Execution Trigger: Specify when the script should be executed.
   
4. Board: Choose the board for which the script will be executed.
   

4. Click the Publish button and confirm your action. You also have the option to save it as a draft and publish it later by clicking Save as Draft. 

An execution trigger can only be used twice for a particular board.

Parameter Configuration Limits

The default JavaScript configuration will be as follows:

config: {
      cpu_timeout: 1000
      cpu_memory: 50
      file_request_count: 10
      file_size: 100
      http_clientrequest_count: 10
      sdk_call_count: 100
      logger_level: "INFO"
      execution_timeout: 30000
      execution_log_limit: 30000
}

Units for the a above are in 'ms' and 'MB'.

Advanced Options (Enterprise Only)

Advanced Options are available exclusively to enterprise customers and are enabled on request. These options allow enterprise users to fine-tune deployment behavior by configuring the following thresholds.

If you're not an enterprise user, your deployments will adhere to the default system limits.

Parameter Name	Description	Range/Allowed Values
Cpu Time (ms)	Maximum CPU time allocated for the function's execution	100 - 240000
Memory (MB)	Memory limit allocated for the function's execution	5 - 4000
File Request Count	Number of files that can be created	1 - 2000
Maximum File size (MB)	Maximum size per file	1 - 8000
HTTP Client Request Count	Number of external HTTP requests allowed	1 - 8000
SDK Call Count	Number of internal SDK calls allowed	1 - 8000
Execution Timeout (ms)	Maximum time allocated for the function's execution	500 - 3600000
Execution Log Limit	Maximum number of character logs to be stored in zlogs	3000 - 20,00,000 characters
Logger Level	Logging level of the function	FATAL, ERROR, WARN, INFO, DEBUG, TRACE

 

Managing CodeX Scripts

Edit a Script 

1. Navigate to (settings) >> CodeX >> click Scripts in the menu.
2. Select the codex script you wish to edit.
3. Make the necessary modifications.
4. Click the Publish button and confirm your changes.

Publish your scripts so that the updated versions can be executed effectively.

 

Set Execution Order for CodeX Scripts    

Filter Scripts   

1. Navigate to (settings) >> CodeX >> select Scripts in the menu.
2. Click on in the All Forms column and select a form from the displayed list.       

Enable or Disable Scripts   

1. Navigate to (settings) >> CodeX >> select Scripts in the menu.

 

Delete a Script 

1. Navigate to (settings) >> CodeX >> select Scripts in the menu.

2. Hover over the name of the script you want to delete, click mouse over action menu, , and select Delete.

Triggering Script Execution: Locations and Triggers

• Free users: Scripts can be triggered only from the Cards module.
  
• Enterprise users: Can access multiple execution locations and advanced triggers.

Cards

1. On Load - This script runs when a form is first loaded in the Qntrl system as part of the page rendering process. It can be used to initialize variables, retrieve data, set default values, or apply dynamic behaviour to the user interface. 
2. Before Create - Script runs just before a new record is created. It allows developers to validate input data, set default values, or run custom logic before the record is officially added to the system.
3. After Create - Executed after a new record is successfully created, this trigger is used for post-creation tasks like sending notifications, updating related records, or executing additional logic.
4. Before Update - This trigger runs before an existing record is updated. Developers can use it to validate or manipulate data before the changes are applied.
5. After Update - The script is triggered after a record is updated, allowing developers to perform actions or updates that should follow the modification of the record.
6. Before Delete - Script runs just before a record is deleted from the Ql system. It can be used for validation, cascading deletions, or any necessary logic before the record is permanently removed.
7. After Delete - Executed after a record is successfully deleted, this trigger is used to perform post-deletion tasks such as updating related records, logging events, or running any required custom logic.
   

Email In 

Transition 

1. Before Transition: Executed just before the transition starts.
2. During Transition: Runs while the transition is in progress.
3. After Transition: Triggered once the transition has completed.

Circuits 

CodeX scripts can be executed through functions defined in the system.

Scheduler