CodeXスクリプトの操作方法

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

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

CodeX Scripts は現在、限定リリースとして提供されています。この機能をポータルで有効にするには、support@zohoprojects.com までお問い合わせください。

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

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

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

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 を作成する

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

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

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

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

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

CodeX Scripts を作成および管理できるのは、ポータル管理者のみです。

実行制限

各 CodeX Script には、タスクやプロジェクトの作成・更新などのイベントを実行する前か後かによって、特定の制限が適用されます。

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