CodeXスクリプトの操作
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。
CodeXスクリプトを使用すると、プロジェクト、タスク、工数が作成、更新、削除されたときなど、標準タブで発生するイベントに応じて自動的に実行されるカスタムロジックを定義できます。これらのスクリプトを使用して、ビジネス要件に応じた検証の適用、操作の制限、条件の設定を行えます。
CodeXスクリプトは、CN、JP、AEを除くすべてのデータセンターで利用できます。
CodeXスクリプトでは、月単位のCodeXクレジットが使用されます。利用できるクレジット数は、サブスクリプションプランによって異なります。
|
プラン |
月間CodeXクレジット数 |
|
無料
|
50
|
|
プレミアム
|
500
|
|
エンタープライズ
|
50,000
|
|
アルティメット
|
500,000
|
- スクリプトを1回実行するたびに、CodeXクレジットが1クレジット消費されます。
- クレジットは毎月自動的にリセットされ、リセット日はポータルのタイムゾーンに応じて調整されます。
- 未使用のクレジットは翌月に繰り越されません。
CodeXスクリプトの概要
CodeXスクリプトのcurrentオブジェクト
CodeXスクリプトを記述する際は、多くの場合、「current」オブジェクトを使用します。このオブジェクトは、タスクやプロジェクトなど、スクリプトが実行されるコンテキストを表します。
例：current.record - 実行対象のデータ（タスクやプロジェクトなど）を参照します。
エディターに「current.」と入力すると、スクリプト環境で利用できるすべての対応オブジェクトとプロパティが表示されます。
組み込みメソッド
clientオブジェクトには、システムを操作するための組み込みメソッドが用意されています。
例：client.save(record) - 更新したデータを保存します。
エディターに「client.」と入力すると、スクリプト環境で利用できるすべての対応メソッドとプロパティが表示されます。
これらは、リアルタイムデータを操作できるように、このスクリプト環境で提供されているJavaScript SDKです。
エディターの概要
CodeXスクリプトエディターには、スクリプトの記述と管理に適した操作画面が用意されています。エディターのツールバーにある主なツールでは、次の操作を実行できます。
［フォントサイズ］：読みやすいようにフォントサイズを調整します。
変数の作成
変数は、CodeXスクリプト内で参照して再利用できる値です。
たとえば、スクリプトで照合する特定のクライアント名やタスク担当者IDを定義できます。各スクリプトに値を直接記述する代わりに、変数を作成して複数のスクリプトで使用できます。
- 右上にある
をクリックします。
- ［開発者向け機能］→［CodeXスクリプト］に移動します。
- 右上にある［変数］をクリックします。
- ［変数を作成］をクリックします。
- 名前を入力し、範囲を選択します。
- すべてのスクリプトで使用する場合は、［グローバル］を選択します。
- 特定のスクリプトだけで使用する場合は、［スクリプト］を選択し、対象のスクリプトを選んで値を入力します。
- ［保存］をクリックします。
CodeXスクリプトで変数を使用するには。
- 変数名がJavaScriptの変数命名規則に従っている場合。
variables.<var_name>.value - その他の名前（スペースや特殊文字などを含む名前）の場合。
variables['<var_name>'].value
または
variables['<var_name>'].value
例：
変数名がclosed_status_idの場合、スクリプト内でvariables.closed_status_id.valueを使用できます。
CodeXスクリプトの作成
Zoho Projectsのプロジェクトやタスクに入力規則や業務固有の条件を追加するには、CodeXスクリプトを作成します。たとえば、アーカイブ済みプロジェクトのタスクが更新されないようにするには、プロジェクトがアーカイブ済みかどうかを確認し、そのタスクを編集できないようにするCodeXスクリプトを作成できます。
- 右上の
- ［開発者向け機能］→［CodeXスクリプト］に移動します。
- 右上の［CodeXスクリプトを作成］をクリックします。
- ［CodeXスクリプト名］を入力します。
- ［タブ］、［レイアウト］、および［イベント］を選択します。
- エディターで処理ロジックを含むスクリプトを作成します。
- 保存するには［保存］をクリックします。保存してCodeXスクリプトの一覧に戻るには、［保存して閉じる］をクリックします。
制限事項
スクリプトの制限
|
制限の種類 |
上限 |
|
タブ、レイアウト、操作ごとに作成できるイベント前スクリプト数 |
2 |
|
タブ、レイアウト、操作ごとに作成できるイベント後スクリプト数 |
5 |
|
スクリプトごとの変数数 |
50 |
|
ポータルごとのグローバル変数数 |
100 |
実行時の制限
各CodeXスクリプトには、タスクやプロジェクトの作成、更新などのイベントの前または後のどちらで実行されるかに応じて、一定の制限があります。
|
操作の種類
|
イベント前
|
イベント後
|
|
スクリプトの最大実行数
|
4（全レイアウト用2件＋レイアウト用スクリプト2件）
|
10（全レイアウト用5件＋レイアウト用スクリプト5件）
|
|
タイムアウト：スクリプトを実行できる最大時間です。
|
3秒
|
10秒
|
|
SDK呼び出し：スクリプトがZoho Projectsのデータを操作できる回数です（例：データの取得、項目の更新）。
|
5
|
10
|
|
HTTPリクエスト：スクリプトが外部サービスやアプリに接続できる回数です。
|
3
|
5
|
CodeXスクリプトの管理
CodeXスクリプトの編集
- 右上の
- ［開発者向け機能］→［CodeXスクリプト］に移動します。
- 編集するCodeXスクリプトをクリックします。
- 必要な変更を行い、［保存］をクリックします。
CodeXスクリプトを保存した後は、タブを編集できません。
CodeXスクリプトの有効化
- 右上の
- ［開発者向け機能］→［CodeXスクリプト］に移動します。
- CodeXスクリプトを有効にするには、ステータスをオンに切り替えます。
- 無効にするには、ステータスをオフに切り替えます。
CodeXスクリプトの並べ替え
CodeXスクリプトを並べ替えると、実行順序を変更できます。
- 右上の
- ［開発者向け機能］→［CodeXスクリプト］に移動します。
- CodeXスクリプトにカーソルを合わせ、並べ替えアイコンをクリックしたまま、上下にドラッグ＆ドロップして並べ替えます。
スクリプトの実行順序
同じタブ、レイアウト、イベントに複数のCodeXスクリプトが設定されている場合、実行順序は一覧内のスクリプトの位置によって決まります。
スクリプトは上から順に評価されます。イベントの種類ごとに、CodeXスクリプトには次の上限が適用されます。
- イベント前スクリプト：最大3件
- イベント後スクリプト：最大5件
有効なスクリプトの数が上限以内の場合、すべてのスクリプトが一覧の順序で実行されます。
上限を超えた場合、上から上限数までのスクリプトのみが実行され、残りのスクリプトはスキップされます。
すべてのレイアウト用に作成されたスクリプトと、特定のレイアウト用に作成されたスクリプトはまとめて評価され、両方にまたがって実行順序が適用されます。
正しい順序を維持することで、意図したスクリプトが実行され、重要なロジックがスキップされるのを防ぐことができます。
CodeXスクリプトの抽出
フィルターを使用すると、設定やステータスに基づいて特定のCodeXスクリプトを検索できます。
- 右上にある
- ［開発者向け機能］→［CodeXスクリプト］に移動します。
- スクリプト一覧の右上にある［フィルター］アイコンをクリックします。
- 一覧から1つ以上の抽出条件を選択します。
- フィルターの適用方法として、［いずれか］または［すべて］を選択します。
- ［検索］をクリックして、フィルターを適用します。
実行ログの表示
- 右上にある
- ［開発者向け機能］→［CodeXスクリプト］に移動します。
- 右上にある
をクリックします。
- 実行ログを表示するには、［ログ］を選択します。
- スクリプトをクリックして、該当するログを表示します。
スクリプトの1回の実行につき、保存できるログは最大30,000文字です。この上限を超えて生成されたログは記録されません。
CodeXスクリプトの削除
- 右上にある
- ［開発者向け機能］→［CodeXスクリプト］に移動します。
- CodeXスクリプトにカーソルを合わせ、
- 操作を確定します。
関連情報