カスタムモジュール用Codexスクリプト

カスタムモジュール用Codexスクリプト

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

Zoho ProjectsのCodeXスクリプトは、特定のルールや検証を適用するための高度な条件ロジックスクリプトです。CodeXスクリプトを使用すると、カスタムタブの作成、更新、削除の方法やタイミングを制御できます。

Info
CodeXスクリプトは、CN、JP、AEを除くすべてのデータセンターで利用できます。

Notes
こちらでは、CodeXスクリプトを使用してカスタムタブ内にビジネスルールを適用する方法を説明するため、ReviewModuleカスタムタブを例として使用します。

このタブは、変更申請、資産申請、その他のビジネスプロセスなど、組織のワークフローに適した任意のカスタムタブに置き換えることができます。

同じスクリプトを再利用しながら、要件に合わせてタブ、項目名、検証ロジックを更新してください。

ユースケース

開始日と終了日の順序の検証

データの作成時に、終了日が開始日より前にならないようにします。日付の順序が正しくないデータは拒否されます。

イベント：作成前
コード
  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. }

更新時の過去日付の制限

ユーザーが開始日、終了日、またはレビュー完了日を過去の日付に更新できないようにします。

イベント：更新前
コード
  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. }

更新時の開始日と終了日の順序の検証
データの更新時に、終了日が開始日より前にならないようにします。また、終了日を指定する場合は、開始日も必須になります。

イベント：更新前
コード
  1. function main() {
  2. const DATE_ORDER_ERROR = '終了日を開始日より前に設定することはできません';
  3. const START_REQUIRED_ERROR = '終了日を設定する場合は、開始日の入力が必要です';

  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('終了日を設定する場合は、開始日の入力が必要です');
  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('スクリプトでエラーが発生しました。ポータル管理者にお問い合わせください');
  35. }
  36. }

ユーザーごとの未完了データ数の制限

タブ内に未完了のデータがすでに10件を超えて存在する場合、ユーザーが新しいデータを作成できないようにします。

イベント：作成前
コード
  1. function main() {
  2. const LIMIT_REACHED = '未完了のデータが10件以上あります。上限に達したため、これ以上作成できません';
  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('スクリプトでエラーが発生しました。ポータル管理者にお問い合わせください');
  52. }
  53. }

 作成時の過去の日付の制限

ユーザーが、開始日、終了日、またはレビュー完了日に過去の日付を設定してデータを作成できないようにします。

イベント：作成前
コード
  1. function main() {
  2. const PAST_DATE_ERROR = '過去の日付は指定できません';
  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('スクリプトでエラーが発生しました。ポータル管理者にお問い合わせください');
  27. }
  28. }
データを更新できるユーザーを、作成者や担当ユーザーなど、そのデータに関連付けられているユーザー、または管理者権限を持つユーザーのみに制限します。権限のないユーザーはデータを編集できません。

イベント：更新前
コード
  1. function main() {
  2. const NOT_ALLOWED = 'このデータを編集する権限がありません';

  4. try {
  5. const url = 'https://projectsforce.localzoho.com';
  6. const record = current.record;
  7. const currentUser = current.user; // 操作ユーザー — 名前と構造を確認

  9. // 1. このデータに関連するユーザー（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; // 関連ユーザー -> 許可
  19. }

  21. // 2. 関連ユーザーではない -> 操作ユーザーの情報を取得し、管理者のみ許可
  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; // すでにオブジェクト
  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('スクリプトでエラーが発生しました。ポータル管理者にお問い合わせください');
  40. }
  41. }
 
関連記事
CodeX Scriptsの概要
CodeX Scriptsの使用方法
CodeX Scripts向けJavaScript SDK
プロジェクト向けCodeX Scripts
タスク向けCodeX Scripts