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

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

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

前提条件

CodeXスクリプトを作成する前に、ボードを作成する必要があります。これは、設定したCodeXスクリプトを、特定の条件が満たされたときに、そのボード内で実行できるためです。  
  

スクリプトの作成と設定

Idea
[設定]の[Qntrl AI Hub]でAIコードアシスタントを有効にして使用すると、要求に基づいてスクリプトを生成できます。
  1. AIコードアシスタントを有効にする方法
  2. AIコードアシスタントを使用する方法
新しいスクリプトを追加するには、次の手順を実行します。
  1. 次の順に[設定]→[CodeX]に移動し、メニューの[スクリプト]をクリックします。
  2. [新しいスクリプト]ボタンをクリックします。
  3. 次の実行情報を入力します。
    1. [スクリプト名]:サーバースクリプトの名前を入力します。
    2. [実行場所]:スクリプトを実行する場所を選択します。
    3. [実行トリガー]:スクリプトを実行するタイミングを指定します。
    4. [ボード]:スクリプトを実行するボードを選択します。
  1. 業務要件に応じてスクリプトを記述します。
  2. [公開]ボタンをクリックし、操作を確定します。また、[下書きとして保存]をクリックして下書きとして保存し、後で公開することもできます。 
Info
[実行場所]項目の[遷移]オプションは、エンタープライズプランの利用者にのみ、申請に応じて提供されます。有効にするには、サポートチームにメールでお問い合わせください。

                   

 

QntrlのCodeXに新しいスクリプトが追加されます。
Notes
  1. 1つのボードにつき、同じ実行トリガーは2回まで使用できます。
  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」です。

Info

詳細オプション(エンタープライズ限定)

詳細オプションは、エンタープライズ顧客のみが利用でき、要求に応じて有効になります。エンタープライズユーザーは、以下のしきい値を設定して、デプロイの動作を細かく調整できます。有効にするには、サポートチームにメールでお問い合わせください。

エンタープライズユーザーでない場合、デプロイにはシステムの初期設定の上限が適用されます。

パラメーター名

説明

範囲/許容値

CPU時間(ミリ秒)

関数の実行に割り当てられるCPU時間の上限

100 - 240,000

 

メモリー(MB)

 

関数の実行に割り当てられるメモリーの上限

5 - 4,000

 

ファイル要求数

 

作成可能なファイル数

 

1 - 2,000

最大ファイルサイズ(MB)

ファイル1件あたりの最大サイズ

1 - 8,000

HTTPクライアント要求数

許可される外部HTTP要求の数

1 - 8,000

SDK呼び出し数

許可される内部SDK呼び出しの数

1 - 8,000

実行タイムアウト(ミリ秒)

 

関数の実行に割り当てられる時間の上限

500 - 3,600,000

実行ログの上限

 

zlogsに保存されるログの最大文字数

3,000 - 2,000,000文字

 

ロガーレベル

 

関数のログ出力レベル

FATAL, ERROR, WARN, INFO, DEBUG, TRACE

 


CodeXスクリプトの管理

スクリプトの編集 

CodeXでスクリプトを変更するには、次の手順を実行します。
  1. まず、[設定]→[CodeX]→の順に移動し、メニューの[スクリプト]をクリックします。
  2. 編集するCodeXスクリプトを選択します。
  3. 必要な変更を行います。
  4. [公開]ボタンをクリックし、変更内容を確定します。
CodeXスクリプトが更新されます。
Notes
更新版を正常に実行できるよう、スクリプトを公開してください。

 


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

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

  1. (設定)→[CodeX]→メニューから[スクリプト]」を選択します。

  2. ページ右上の[実行順序の設定]ボタンをクリックします。

       

  1. スクリプトを実行する[フォーム]と、スクリプトを起動するタイミングを示す[実行トリガー]を選択します。

  2. 選択内容に応じたスクリプトの一覧が表示されます。

  3. [実行順序]セクションで、スクリプトを目的の実行順序に並べます。

  4. 保存]をクリックします。

スクリプトは設定した順序で実行されます。
 

スクリプトの絞り込み   

CodeXスクリプトをフォーム別に絞り込んで分類できます。特定のフォームのCodeXスクリプトを絞り込むには、次の手順を実行します。
  1. (設定)→[CodeX]→メニューから[スクリプト]」を選択します。
  2. [すべてのフォーム]列のをクリックし、表示されたリストからフォームを選択します。       


選択したフォームのスクリプトが表示されます。

 

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

公開済みのCodeXスクリプトは、初期設定で有効になっています。サーバースクリプトを無効にすると、その実行が一時的に停止します。
1. 「(設定)→[CodeX]→メニューから[スクリプト]」を選択します。
2. [有効]列で、サーバースクリプトの横にある切り替えボタンを使用して、スクリプトを有効または無効にします。

 



スクリプトの削除 

CodeXスクリプトを削除するには、次の手順を実行します。
1. 「(設定)→[CodeX]→メニューから[スクリプト]」を選択します。
2. 削除するスクリプト名にカーソルを合わせ、マウスオーバー時に表示される操作メニューのをクリックして、[削除]を選択します。
3. 削除を確定します。

 


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

CodeXスクリプトは、Qntrl内のさまざまなタブから起動できます。スクリプトの機能と動作は、タブによって異なります。
Info
  • 無料プランのユーザー:スクリプトは[カード]タブからのみ実行できます。
  • エンタープライズプランのユーザー複数の実行場所と高度なトリガーを利用できます。

CodeXスクリプトを実行できるタブと、それぞれで使用可能なトリガーは次のとおりです。   

[カード]

  1. 読み込み時このスクリプトは、ページの表示処理の一環として、Qntrlシステムでフォームが最初に読み込まれたときに実行されます。変数の初期化、データの取得、初期値の設定、操作画面への動的な処理の適用に使用できます。
  2. 作成前このスクリプトは、新しいデータが作成される直前に実行されます。データがシステムに正式に追加される前に、入力データの検証、初期値の設定、カスタムロジックの実行が可能です。
  3. 作成後このトリガーは、新しいデータが正常に作成された後に実行されます。通知の送信、関連データの更新、追加ロジックの実行など、作成後の処理に使用します。
  4. 更新前:このトリガーは、既存のデータが更新される前に実行されます。変更が適用される前に、データを検証または編集できます。
  5. 更新後:このスクリプトは、データの更新後に実行されます。データの変更後に必要な処理や更新を行うことができます。
  6. 削除前:このスクリプトは、Qntrlシステムからデータが削除される直前に実行されます。データが完全に削除される前の検証、連鎖削除、その他の必要なロジックの実行に使用できます。
  7. 削除後:このトリガーは、データが正常に削除された後に実行されます。関連データの更新、イベントの記録、必要なカスタムロジックの実行など、削除後の処理に使用します。

 

メール受信 

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

遷移 

CodeXスクリプトは、遷移処理のさまざまな段階で実行できます。
  1. 遷移前:遷移が開始される直前に実行されます。
  2. 遷移中:遷移の実行中に処理されます。
  3. 遷移後:遷移が完了した後に実行されます。

 

サーキット 

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


 

スケジューラー 

スクリプトは、スケジュール設定されたタスクに基づいて実行することもでき、あらかじめ設定した間隔で自動実行できます。