CodeX スクリプトの操作

CodeX スクリプトの操作

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

CodeX Scriptsでは、プロジェクトやタスクが作成、更新、削除されたときなど、タブ内のイベントに基づいて自動実行されるカスタムロジックを定義できます。これらのスクリプトにより、ビジネス要件に沿った検証の適用、操作の制限、条件の適用を行えます。
InfoCodeX Scriptsは、CN、JP、AEを除くすべてのデータセンターでサポートされています。
CodeX Scriptsは、月間のCodeXクレジットを使用して実行されます。利用できるクレジット数はサブスクリプションプランによって異なります。

プラン

月間CodeXクレジット
無料
50
Premium
500
Enterprise
50000
Ultimate
500000

 

  1. スクリプトを1回実行するごとに、CodeXクレジットを1クレジット消費します。
  2. クレジットは毎月自動でリセットされ、リセット日はポータルのタイムゾーンに基づいて調整されます。
  3. 未使用のクレジットは翌月に繰り越されません。

CodeX Scriptsの概要

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

CodeX Scriptsを記述する際は、'current'オブジェクトを使用することがよくあります。このオブジェクトは、タスクやプロジェクトなど、スクリプトがトリガーされるコンテキストを表します。

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

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

組み込みメソッド

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

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

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

これらは、このスクリプト環境で利用できるJavaScript SDKで、実際のデータを操作するために使用します。

エディターの概要

CodeX Scriptエディターには、スクリプトの記述と管理に適した操作画面が用意されています。エディターのツールバーにある主なツールは、次の用途で使用できます。
［フォントサイズ］：読みやすくするためにフォントサイズを調整します。
：直前の変更を元に戻します。
：元に戻した操作をやり直します。
：選択したコードを切り取ります。
：選択したコードをコピーし、次の行に貼り付けます。
 ：コードを左揃えにします。
：コードを右揃えにします。
：選択したコードをスクリプト内のコメントにします。
：選択したコードをスクリプトから削除します。
：テキストまたはコードを検索、置換します。
：コードを次の行に折り返します。
：コード全体を自動で整形し、読みやすくします。
：コーディング中にコードを整形します。
：利用可能なキーボードショートカットをすべて表示します。
：ヘルプリソースを開きます。
：エディターのライトテーマとダークテーマを切り替えます。

変数の作成

変数は、CodeX Scripts内で参照できる再利用可能な値です。
たとえば、スクリプトで照合する特定のクライアント名やタスク所有者IDを定義できます。各スクリプトに値を直接記述する代わりに、変数を作成して複数のスクリプトで使用できます。
  1. 右上のをクリックします。
  2. ［開発者スペース］→［CodeX Scripts］に移動します。
  3. 右上の［変数］をクリックします。
  4. ［変数を作成］をクリックします。
  5. 名前を入力し、スコープを選択します。
  6. すべてのスクリプトで使用するには、［グローバル］を選択します。
  7. 特定のスクリプトに使用を制限するには、［スクリプト］を選択し、スクリプトを選択して値を入力します。
  8. ［保存］をクリックします。

CodeX Scriptで変数を使用するには、次の形式を使用します。
  1. 変数名がJavaScriptの変数命名規則に従っている場合：
    variables.<var_name>.value
  2. その他の名前（スペースや特殊文字を含む場合など）の場合：
    variables['<var_name>'].value
    または
    variables['<var_name>'].value
例：
変数名がclosed_status_idの場合、スクリプトでvariables.closed_status_id.valueを使用できます。

CodeX Scriptの作成

Zoho Projectsのプロジェクトやタスクに検証や業務固有の条件を追加するには、CodeX Scriptsを作成します。たとえば、アーカイブ済みプロジェクトでタスクの更新を禁止したい場合、プロジェクトがアーカイブ済みかどうかを確認し、ユーザーがそのタスクを編集できないようにするCodeX Scriptを記述できます。
  1. 右上のをクリックします。
  2. ［開発者スペース］→ ［CodeX Scripts］に移動します。
  3. 右上の［CodeX Scriptsを作成］をクリックします。
  4. ［CodeX Script名］を入力します。
  5. ［タブ］、［レイアウト］、および［イベント］を選択します。
  6. エディターでロジックを含むスクリプトを記述します。
    1. current.を使用して、対応しているオブジェクトとプロパティを確認します。
    2. client.を使用して、操作を実行するための対応メソッドを確認します。
  7. ［保存］をクリックして保存するか、［保存して閉じる］をクリックして保存し、CodeX Scripts一覧に戻ります。

既存の例のコードを使用することもできます。

制限事項

スクリプトの制限

制限の種類

上限

タブ、レイアウト、アクションごとに作成できるイベント前スクリプト

2

タブ、レイアウト、アクションごとに作成できるイベント後スクリプト

5

スクリプトごとの変数

50

ポータルごとのグローバル変数

100

実行の制限

各CodeX Scriptは、タスクやプロジェクトの作成、更新などのイベントの前後どちらで実行されるかに応じて、一定の制限のもとで実行されます。
 

アクションの種類

イベント前
 
 

イベント後
スクリプトの最大実行回数
4（全レイアウト2件＋レイアウトスクリプト2件）
10（全レイアウト5件＋レイアウトスクリプト5件）

タイムアウト-スクリプトの実行が許可される最大時間。

3秒

10秒

SDK呼び出し-スクリプトがZoho Projectsのデータを操作できる回数（たとえば、データの取得、項目の更新）。


5

10

HTTPリクエスト-スクリプトが外部サービスやアプリに接続できる回数。


3

5

CodeX Scriptsの管理

CodeX Scriptの編集

  1. 右上のをクリックします。
  2. ［開発者スペース］→ ［CodeX Scripts］に移動します。
  3. 編集するCodeX Scriptをクリックします。
  4. 必要な変更を行い、［保存］をクリックします。
Notes
CodeX Scriptを保存すると、タブは編集できません。

CodeX Scriptの有効化

  1. 右上のをクリックします。
  2. ［開発者スペース］→ ［CodeX Scripts］に移動します。
  3. ［ステータス］をオンに切り替えて、CodeX Scriptを有効にします。
    1. 無効にするには、［ステータス］をオフに切り替えます。

CodeX Scriptの並べ替え

CodeX Scriptsを並べ替えて、実行順序を変更します。
  1. 右上のをクリックします。
  2. ［開発者スペース］→ ［CodeX Scripts］に移動します。
  3. CodeX Scriptにカーソルを合わせ、並べ替えアイコンをクリックしたまま、上または下にドラッグ＆ドロップして並べ替えます。
スクリプトの実行順序
同じタブ、レイアウト、イベントに対して複数のCodeX Scriptsが設定されている場合、実行順序は一覧内のスクリプトの位置によって決まります。
スクリプトは上から下の順に評価されます。各イベント種別におけるCodeX Scriptsの上限は次のとおりです。
  1. イベント前スクリプトは最大3件
  2. イベント後スクリプトは最大5件
有効なスクリプトの数がこれらの上限内であれば、すべてのスクリプトが一覧の順序で実行されます。
上限を超えた場合は、上から許可された件数内にあるスクリプトのみが実行され、残りのスクリプトはスキップされます。
Notes
すべてのレイアウト用に作成されたスクリプトと、特定のレイアウト用に作成されたスクリプトはまとめて評価され、両方を含めた順序が適用されます。
正しい順序を維持することで、意図したスクリプトが実行され、重要な処理がスキップされるのを防げます。

CodeX Scriptsのフィルター

フィルターを使用して、設定やステータスに基づいて特定のCodeX Scriptsを検索できます。

  1. 右上のをクリックします。
  2. ［開発者スペース］→ ［CodeX Scripts］に移動します。
  3. スクリプト一覧の右上にある［フィルター］アイコンをクリックします。
  4. 一覧から1つ以上のフィルター条件を選択します。
  5. フィルターの適用方法を定義するため、［いずれかに一致］または［すべてに一致］を選択します。
  6. ［検索］をクリックしてフィルターを適用します。

実行ログの表示

  1. 右上のをクリックします。
  2. ［開発者スペース］→ ［CodeX Scripts］に移動します。
  3. 右上のをクリックします。
  4. 実行ログを表示するには、［ログ］を選択します。
  5. 該当するログを表示するには、スクリプトをクリックします。
1回のスクリプト実行につき、保存できるログは最大30,000文字です。この上限を超えて生成されたログは記録されません。

CodeX Scriptの削除

  1. 右上のをクリックします。
  2. ［開発者スペース］→ ［CodeX Scripts］に移動します。
  3. 対象のCodeX Scriptにカーソルを合わせ、→ ［削除］をクリックします。
  4. 操作を確定します。
関連情報
ヘルプに戻る
CodeX Scriptの概要
タスク用CodeX Scripts
プロジェクト用CodeX Scripts
CodeX Scripts用JavaScript SDK