Codex Scripts for Custom Modules

Codex Scripts for Custom Modules

CodeX Scripts in Zoho Projects are advanced conditional logic scripts that help enforce specific rules and validations. Users can control how and when custom modules can be created, updated, and deleted using the CodeX Scripts.

Info
CodeX Scripts are supported in all data centers except CN, JP and AE.

Notes
ReviewModule custom module is used here as an example to demonstrate how CodeX scripts can enforce business rules within a custom module.

You can replace this module with any custom module that fits your organization's workflow, such as Change Requests, Asset Requests, or any other business process.

Update the module, field names, and validation logic to match your requirements while reusing the same scripts.

Use cases

Validate Start and End Date Order

Ensure the End Date is not earlier than the Start Date during record creation. Records with an invalid date sequence are rejected.

Event: Before Create
Code
  1. function main() {
  2.     const DATE_ORDER_ERROR = "End date cannot be earlier than start date";
  3.     try {
  4.         const record = current.record;
  5.         const startDate = record.starting_date;
  6.         const endDate   = record.ending_date;
  7.         if (!startDate || !endDate) return;   // need both to compare
  8.         const start = new Date(startDate);
  9.         const end   = new Date(endDate);
  10.         start.setHours(0, 0, 0, 0);
  11.         end.setHours(0, 0, 0, 0);
  12.         if (end < start) {
  13.             throw new ScriptError(DATE_ORDER_ERROR);
  14.         }
  15.     } catch (err) {
  16.         const msg = err.getMessage ? err.getMessage() : err.message;
  17.         if (msg === DATE_ORDER_ERROR) {
  18.             throw new ScriptError(msg);
  19.         }
  20.         throw new ScriptError("Error in script, please contact portal admin");
  21.     }
  22. }

 Restrict Past Dates on Update

Restrict users from updating the Start Date, End Date, or Review Completion Date to a past date.

Event: Before Update
Code
  1. function main() {
  2.     const PAST_DATE_ERROR = "Date cannot be in the past";
  3.     const DATE_FIELDS = ["review_completion_date", "starting_date", "ending_date"];

  5.     try {
  6.         const today = new Date();
  7.         today.setHours(0, 0, 0, 0);

  9.         for (let i = 0; i < DATE_FIELDS.length; i++) {
  10.             const diff = current.affectedFields[DATE_FIELDS[i]];
  11.             if (!diff) continue;

  13.             const newDate = new Date(diff.newValue);
  14.             newDate.setHours(0, 0, 0, 0);

  16.             if (newDate < today) {
  17.                 throw new ScriptError(PAST_DATE_ERROR);
  18.             }
  19.         }
  20.     } catch (err) {
  21.         const msg = err.getMessage ? err.getMessage() : err.message;
  22.         if (msg === PAST_DATE_ERROR) {
  23.             throw new ScriptError(msg);
  24.         }
  25.         throw new ScriptError("Error in script, please contact portal admin");
  26.     }
  27. }

 Validate Start and End Date Order on Update

Ensure the End Date is not earlier than the Start Date when updating a record. The script also requires a Start Date if an End Date is provided.

Event: Before Update
Code
  1. function main() {
  2.     const DATE_ORDER_ERROR = "End date cannot be earlier than start date";
  3.     const START_REQUIRED_ERROR = "Start date is required when end date is set";

  5.     try {
  6.         const record = current.record;

  8.         const startDate = current.affectedFields.starting_date
  9.             ? current.affectedFields.starting_date.newValue
  10.             : record.starting_date;
  11.         const endDate = current.affectedFields.ending_date
  12.             ? current.affectedFields.ending_date.newValue
  13.             : record.ending_date;

  15.         if (endDate && !startDate) {
  16.             throw new ScriptError("Start date is required when end date is set");
  17.         }

  19.         if (!startDate || !endDate) return;

  21.         const start = new Date(startDate);
  22.         const end = new Date(endDate);
  23.         start.setHours(0, 0, 0, 0);
  24.         end.setHours(0, 0, 0, 0);

  26.         if (end < start) {
  27.             throw new ScriptError(DATE_ORDER_ERROR);
  28.         }
  29.     } catch (err) {
  30.         const msg = err.getMessage ? err.getMessage() : err.message;
  31.         if (msg === DATE_ORDER_ERROR || msg === START_REQUIRED_ERROR) {
  32.             throw new ScriptError(msg);
  33.         }
  34.         throw new ScriptError("Error in script, please contact portal admin");
  35.     }
  36. }

 Restrict Open Record Limit per User

Restrict users from creating new records when they already have more than 10 open records in the module.

Event: Before Create
Code
  1. function main() {
  2.     const LIMIT_REACHED = "10 or more Open record. limit reached — you cannot create more";
  3.     const MAX_OPEN = 10;

  5.     try {
  6.         const url = "https://projectsforce.localzoho.com";
  7.         const portalId = current.org.zohoOrgId;
  8.         const moduleId = current.record.moduleId;
  9.         const currentUser = current.user;

  11.         let openCount = 0;
  12.         let page = 1;
  13.         const perPage = 100;
  14.         let hasNext = true;

  16.         while (hasNext && openCount <= MAX_OPEN) {
  17.             let req = new HttpRequest();
  18.             req.url(`${url}/api/v3/portal/${portalId}/module/${moduleId}/entities?page=${page}&per_page=${perPage}`);
  19.             req.method("GET");
  20.             req.connection("zconnect");

  22.             const res = req.execute().asJson()?.statusMessage?.responseText;
  23.             // throw new ScriptError(req.execute().asText());
  24.             const records = res.entities || res;

  26.             for (let i = 0; i < records.length; i++) {
  27.                 const rec = records[i];
  28.                 const createdBy = rec.created_by && rec.created_by.zpuid;
  29.                 const isOpen = rec.status && rec.status.is_closed_type === false;

  31.                 if (isOpen && createdBy === currentUser.id) {
  32.                     openCount++;
  33.                     if (openCount > MAX_OPEN) break;
  34.                 }
  35.             }

  37.             hasNext = res.page_info ? res.page_info.has_next_page === true : false;
  38.             page++;
  39.         }

  41.         if (openCount > MAX_OPEN) {
  42.             throw new ScriptError(LIMIT_REACHED);
  43.         }

  45.     } catch (err) {
  46.         // throw new ScriptError(err);
  47.         const msg = err.getMessage ? err.getMessage() : err.message;
  48.         if (msg === LIMIT_REACHED) {
  49.             throw new ScriptError(msg);
  50.         }
  51.         throw new ScriptError("Error in script, please contact portal admin");
  52.     }
  53. }

 Restrict Past Dates on Creation

Restrict users from creating records with a Start Date, End Date, or Review Completion Date set in the past.

Event: Before Create
Code
  1. function main() {
  2.     const PAST_DATE_ERROR = "Date cannot be in the past";
  3.     const DATE_FIELDS = ["review_completion_date", "starting_date", "ending_date"];

  5.     try {
  6.         const record = current.record;
  7.         const today  = new Date();
  8.         today.setHours(0, 0, 0, 0);

  10.         for (let i = 0; i < DATE_FIELDS.length; i++) {
  11.             const value = record[DATE_FIELDS[i]];
  12.             if (!value) continue;

  14.             const newDate = new Date(value);
  15.             newDate.setHours(0, 0, 0, 0);

  17.             if (newDate < today) {
  18.                 throw new ScriptError(PAST_DATE_ERROR);
  19.             }
  20.         }
  21.     } catch (err) {
  22.         const msg = err.getMessage ? err.getMessage() : err.message;
  23.         if (msg === PAST_DATE_ERROR) {
  24.             throw new ScriptError(msg);
  25.         }
  26.         throw new ScriptError("Error in script, please contact portal admin");
  27.     }
  28. }
Allow record updates only for users associated with the record (such as the creator or assigned users) or users with the Administrator role. Unauthorized users cannot edit the record.

Event: Before Update
Code
  1. function main() {
  2.     const NOT_ALLOWED = "You are not allowed to edit this record";

  4.     try {
  5.         const url         = "https://projectsforce.localzoho.com";
  6.         const record      = current.record;
  7.         const currentUser = current.user;        // acting user — confirm name/shape

  9.         // 1. Users related to this record (compare on id / ZPUID)
  10.         const relatedIds = new Set();
  11.         if (record.created_by)            relatedIds.add(record.created_by.id);
  12.         if (record.review_module_cf_0002) relatedIds.add(record.review_module_cf_0002.id);
  13.         if (Array.isArray(record.review_module_cf_0001)) {
  14.             record.review_module_cf_0001.forEach(u => relatedIds.add(u.id));
  15.         }

  17.         if (relatedIds.has(currentUser.id)) {
  18.             return;  // related -> allowed
  19.         }

  21.         // 2. Not related -> fetch acting user, allow only Administrator
  22.         let req = new HttpRequest();
  23.         req.url(`${url}/api/v3.1/portal/${current.org.zohoOrgId}/users/${currentUser.id}`);
  24.         req.method("GET");
  25.         req.connection("zprojects");

  27.         const user = req.execute().asJson().statusMessage.responseText;   // already an object
  28.         const role = (user.role && user.role.name || "").toLowerCase();

  30.         if (role !== "administrator") {
  31.             throw new ScriptError(NOT_ALLOWED);
  32.         }

  34.     } catch (err) {
  35.         const msg = err.getMessage ? err.getMessage() : err.message;
  36.         if (msg === NOT_ALLOWED) {
  37.             throw new ScriptError(msg);
  38.         }
  39.         throw new ScriptError("Error in script, please contact portal admin");
  40.     }
  41. }

 
More Reads
CodeX Scripts - Intro
Working with CodeX Scripts
JavaScript SDK for CodeX Scripts
CodeX Scripts for Projects
CodeX Scripts for Tasks