CodeXスクリプトの作成と設定

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

前提条件

CodeXを作成する前に、ボードを作成しておく必要があります。設定済みのCodeXスクリプトは、そのボード内で特定の条件が発生したときに有効化できます。

スクリプトの作成と設定

設定にあるQntrl AI HubでAIコードアシスタントを有効にして使用すると、要求に基づいてスクリプトを生成できます。

新しいスクリプトを追加するには、次の手順を実行します。

［設定］→［CodeX］に移動し、メニューの［スクリプト］をクリックします。
［新しいスクリプト］ボタンをクリックします。
業務要件に合わせてスクリプトをコーディングします。
以下の実行情報を入力します。

［スクリプト名］：サーバースクリプトの名前を入力します。
［実行場所］：スクリプトを実行する場所を選択します。
［実行トリガー］：スクリプトを実行するタイミングを指定します。
［ボード］：スクリプトを実行するボードを選択します。

［公開］ボタンをクリックし、操作を確定します。［下書きとして保存］をクリックして下書きとして保存し、後で公開することもできます。

新しいスクリプトがQntrlのCodeXに追加されます。

特定のボードでは、1つの実行トリガーは2回までしか使用できません。
実行場所を遷移に設定している場合、そのボード内の同じ遷移に対して作成できるトリガーは2件までです。

パラメーター設定の上限

デフォルトのJavaScript設定は次のとおりです。

config: {
      cpu_timeout: 1000
      cpu_memory: 50
      file_request_count: 10
      file_size: 100
      http_clientrequest_count: 10
      sdk_call_count: 100
      logger_level: 'INFO'
      execution_timeout: 30000
      execution_log_limit: 30000
     }

上記の単位は「ms」と「MB」です。

詳細オプション（Enterprise限定）

詳細オプションは、Enterpriseのお客さまのみご利用いただけ、ご要望に応じて有効化されます。これらのオプションでは、以下のしきい値を設定して、Enterpriseユーザーがデプロイの動作を細かく調整できます。

Enterpriseユーザーでない場合、デプロイにはシステムの既定の制限が適用されます。

パラメーター名	説明	範囲／許可される値
CPU時間（ms）	関数の実行に割り当てられる最大CPU時間	100 - 240000
メモリー（MB）	関数の実行に割り当てられるメモリー上限	5 - 4000
ファイル要求数	作成可能なファイル数	1 - 2000
最大ファイルサイズ（MB）	ファイルごとの最大サイズ	1 - 8000
HTTPクライアント要求数	許可される外部HTTP要求数	1 - 8000
SDK呼び出し数	許可される内部SDK呼び出し数	1 - 8000
実行タイムアウト（ms）	関数の実行に割り当てられる最大時間	500 - 3600000
実行ログ上限	zlogsに保存される文字ログの最大文字数	3000 - 20,00,000文字
ロガーレベル	関数のログレベル	FATAL, ERROR, WARN, INFO, DEBUG, TRACE

CodeXスクリプトの管理

スクリプトの編集

CodeXでスクリプトを変更するには、以下の手順を実行します。

次の順に、［設定］→［CodeX］に移動し、メニューの［スクリプト］をクリックします。
編集するCodeXスクリプトを選択します。
必要な変更を行います。
［公開］ボタンをクリックし、変更内容を確認します。

CodeXスクリプトが更新されます。

更新したバージョンを正常に実行できるように、スクリプトを公開してください。

CodeXスクリプトの実行順序の設定

CodeXスクリプトの実行順序を指定できます。実行順序を設定するには、次の手順を実行します。

（設定）→CodeX→メニューで［スクリプト］を選択します。
ページ右上の［実行順序の設定］ボタンをクリックします。

スクリプトを実行する［フォーム］を選択し、実行するタイミングの［実行トリガー］を選択します。
選択内容に基づいてスクリプトの一覧が表示されます。
［実行順序］セクションで、スクリプトを希望の実行順序に並べ替えます。
［保存］をクリックします。

設定した順序に従ってスクリプトが実行されます。

スクリプトのフィルター

CodeXスクリプトをフォーム別に分類して絞り込むことができます。特定のフォームのCodeXスクリプトを絞り込むには、次の手順を実行します。

（設定）→CodeX→メニューで［スクリプト］を選択します。
（［すべてのフォーム］列）をクリックし、表示された一覧からフォームを選択します。

該当するフォームのスクリプトが表示されます。

スクリプトの有効化／無効化

公開済みのCodeXスクリプトは、初期設定で有効になっています。サーバースクリプトを無効にすると、その実行が一時的に停止します。

（設定）→CodeX→メニューで［スクリプト］を選択します。

2. ［有効］列で、サーバースクリプトの横にあるボタンを切り替えて、スクリプトを有効または無効にします。

スクリプトの削除

CodeXスクリプトを削除するには、次の手順を実行します。

（設定）→CodeX→メニューで［スクリプト］を選択します。

2. 削除するスクリプト名にカーソルを合わせ、マウスオーバー時に表示される操作メニュー（

）をクリックし、［削除］を選択します。

3. 削除操作を確定します。

スクリプト実行の開始：場所とトリガー

CodeXスクリプトは、Qntrl内のさまざまなタブから実行できます。スクリプトの機能や動作はタブによって異なります。

無料ユーザー：スクリプトは［カード］タブからのみトリガーできます。
Enterpriseユーザー：複数の実行場所と高度なトリガーを利用できます。

CodeXスクリプトを実行できる対応タブと、利用可能なトリガーは以下のとおりです。

カード

読み込み時-このスクリプトは、ページのレンダリング処理の一環として、Qntrlシステムでフォームが最初に読み込まれたときに実行されます。変数の初期化、データの取得、初期値の設定、ユーザーインターフェイスへの動的な動作の適用に使用できます。
作成前-新しいデータが作成される直前にスクリプトが実行されます。開発者は、データが正式にシステムに追加される前に、入力データの検証、初期値の設定、独自ロジックの実行を行えます。
作成後-新しいデータが正常に作成された後に実行されるこのトリガーは、通知の送信、関連データの更新、追加ロジックの実行など、作成後の処理に使用されます。
更新前-このトリガーは、既存のデータが更新される前に実行されます。開発者は、変更が適用される前にデータを検証または操作できます。
更新後-データが更新された後にスクリプトがトリガーされ、開発者はデータの変更後に必要な処理や更新を実行できます。
削除前-Qntrlシステムからデータが削除される直前にスクリプトが実行されます。データが完全に削除される前に、検証、連鎖削除、必要なロジックの実行に使用できます。
削除後-データが正常に削除された後に実行されるこのトリガーは、関連データの更新、イベントのログ記録、必要な独自ロジックの実行など、削除後の処理に使用されます。

メール受信

Qntrlにメールが送信されると、新しいカードが自動的に作成されます。CodeXスクリプトを追加すると、カード作成時にカスタム項目への値の割り当て、サブカードの作成などを行い、この処理をカスタマイズできます。これらのスクリプトは受信メールデータを分析し、カード作成時にアクションを実行します。

遷移

CodeXスクリプトは、遷移処理の各段階でトリガーできます。

遷移前：遷移が開始される直前に実行されます。
遷移中：遷移の進行中に実行されます。
遷移後：遷移が完了するとトリガーされます。

Circuits

CodeXスクリプトは、システムで定義された関数を通じて実行できます。

スケジューラー

スクリプトはスケジュール設定されたタスクに基づいてトリガーされることもあり、定義済みの間隔で自動実行できます。