CodeXスクリプトの操作方法

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

CodeX Scripts を使用すると、ユーザーはタブ内での処理（プロジェクトやタスクの作成・更新・削除時など）に応じて自動的に実行されるカスタムロジックを定義できます。これらのスクリプトにより、入力値の検証を強制したり、処理を制限したり、法人の要件に沿った条件を適用したりできます。

CodeX Scripts は、CN、JP、AE を除くすべてのデータセンターでサポートされています。
ただし、これらのデータセンターでポータルの CodeX Scripts を有効にするには、support@zohoprojects.com までお問い合わせください。

CodeX Scripts は、月間の CodeX クレジットを消費して動作します。利用可能なクレジット数は、ご利用のサブスクリプションプランによって異なります。

プラン	月間 CodeX クレジット
無料	50
プレミアム	500
エンタープライズ	50000
アルティメット	500000

スクリプトの実行 1 回につき、CodeX クレジットを 1 消費します。
クレジットは毎月自動的にリセットされ、リセット日付はポータルのタイムゾーンに合わせて調整されます。
未使用のクレジットを翌月に繰り越すことはできません。

CodeX Scripts の概要

CodeX Scripts における current オブジェクト

CodeX Scripts を記述する際は、頻繁に「current」オブジェクトを扱います。このオブジェクトは、スクリプトが実行されるコンテキスト（タスクやプロジェクトなど）を表します。

例: current.data - 実行対象のデータ（タスクやプロジェクトなど）を指します。

エディターで current. と入力すると、スクリプト環境で利用可能なすべてのサポート対象オブジェクトとプロパティが表示されます。

組み込みメソッド

client オブジェクトには、システムと連携するための組み込みメソッドが用意されています。

例: client.save(data) - 更新されたデータを保存します。

エディターで client. と入力すると、スクリプト環境で利用可能なすべてのサポート対象メソッドとプロパティが表示されます。

これらは、このスクリプト環境で利用できる JavaScript SDK であり、有効なデータと連携する際に役立ちます。

エディターについて

CodeX Script エディターは、スクリプトの作成と管理に適したコードフレンドリーなインターフェイスを提供します。エディターツールバーの主なツールは、次の用途で使用できます。

フォントサイズ: 読みやすくなるようにフォントサイズを調整します。

: 直前の変更を元に戻します。

: 元に戻した操作をやり直します。

: 選択したコードを切り取ります。

: 選択したコードをコピーして、次の行に貼り付けます。

: コードを左揃えにします。

: コードを右揃えにします。

: 選択したコードをスクリプト内のコメントとして追加します。

: スクリプトから選択したコードを削除します。

: テキストまたはコードを検索して置き換えます。

: コードを次の行に折り返します。

: コード全体を自動整形し、読みやすくします。

: コーディング中にコードを整形します。

: 利用可能なすべてのキーボードショートカットを表示します。

: ヘルプリソースを開きます。

: エディターのテーマをライトとダークの間で切り替えます。

変数を作成する

変数は、CodeX Scripts 内で参照できる再利用可能な値です。

たとえば、特定のクライアント名やタスク担当者 ID をスクリプトでチェックしたい場合があります。そのたびに値をスクリプトに直接記述する代わりに、変数を作成して複数のスクリプトで共通して使用できます。

右上隅のをクリックします。
開発者向け情報 > CodeX Scripts に移動します。
右上隅の Variables をクリックします。
作成 Variable をクリックします。
名前を入力し、スコープを選択します。
Global を選択すると、すべてのスクリプトで使用できます。
Script を選択すると、特定のスクリプトでのみ使用できます。スクリプトを選択し、値を入力します。
保存をクリックします。

CodeX Script で変数を使用するには:

変数名が JavaScript の変数命名規則に従っている場合:
variables.<var_name>.value
スペースや特殊文字などを含むその他の名前の場合:
variables['<var_name>'].value
または
variables['<var_name>'].value

例:

変数名が closed_status_id の場合、スクリプト内で variables.closed_status_id.value として使用できます。

CodeX Script を作成する

CodeX Scripts を作成して、Zoho プロジェクト内のプロジェクトやタスクに対して、検証ルールや法人固有の条件を追加できます。たとえば、アーカイブ済みプロジェクトでタスクが更新されないようにしたい場合、プロジェクトがアーカイブ済みかどうかを確認し、そのタスクの編集をユーザーに対してブロックする CodeX Script を作成できます。

画面右上のをクリックします。
開発者向け情報 > CodeX Scripts に移動します。
画面右上の CodeX Script を作成 をクリックします。
CodeX Script 名 を入力します。
タブ、レイアウト、イベント を選択します。
エディターでロジックを含むスクリプトを作成します。

サポートされているオブジェクトとプロパティを確認するには、current を使用します。
処理を実行するためにサポートされているメソッドを確認するには、client を使用します。

保存する場合は保存、保存して CodeX Scripts の一覧に戻る場合は 保存して閉じる をクリックします。

また、既存のサンプルからコードを利用することもできます。

制限事項:

スクリプトの制限

制限の種類	最大許容値
タブ、レイアウト、操作ごとの事前イベントスクリプト数	3
タブ、レイアウト、操作ごとの事後イベントスクリプト数	5
スクリプトごとの変数数	50
ポータルごとのグローバル変数数	100

実行制限

各 CodeX Script には、タスクやプロジェクトの作成・更新などのイベントの事前または事後に実行されるかどうかに応じて、一定の制限があります。

操作の種類	事前イベント	事後イベント
タイムアウト - スクリプトの実行が許可される最大時間。	3 秒	10 秒
SDK コール - スクリプトが Zoho Projects のデータとやり取りできる回数（例: データの取得、項目の更新）。	5	10
HTTP リクエスト - スクリプトが外部サービスやアプリに接続できる回数。	3	5