回路の作成と設定

回路の作成と設定

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

サーキットは、Qntrlのさまざまなタブにわたるタスクの自動化に役立つ視覚的なワークフローです。サーキットは、作成済みテンプレートを使用するか、[ビルダー表示]または[コード表示]で一から作成できます。

Info

サーキットの共通機能  

  • 組織ごとに作成できるサーキットは最大500件です。

  • 1つのサーキットには、1~50個の状態を含めることができます。

  • 各サーキットには一意のサーキットIDがあります。このIDは、SDK、API、サーキットのネストや一括処理で使用されます。

  • サーキットは、次の方法で設定できます。
    • [ビルダー表示](視覚的)
    • [コード表示](JSON)
  • 一方の表示で行った変更は、もう一方に自動的に反映されます


サーキットへのアクセス

  1. Qntrlにログインします。
  2. 左パネルの[サーキット](三角形ノードのアイコン)に移動します。
  3. 次のいずれかをクリックします。
    • [新しいサーキット](最初のサーキットを作成する場合のみ利用可能)、または
    • [自分のサーキット]の横にある[+アイコン](追加のサーキットを作成する場合)
  4. サーキットの作成方法を選択します。
    1. [テンプレートから選択]– 定義済みの状態とロジックを含む作成済みテンプレートを使用します
    2. [一から開始]– 状態とロジックを手動で定義してサーキットを作成します

テンプレートを使用したサーキットの作成  

作成済みテンプレートを使用すると、最小限の設定で自動化フローをすばやく開始できます。

  1. [テンプレートから選択]オプションの[探す]をクリックします。

  2. サーキットテンプレートで利用可能なテンプレートの一覧を確認します。

  3. 必要に応じて、左ペインを使用してカテゴリー別にテンプレートを絞り込みます。


  1. 要件に合ったテンプレートを選択し、その構成要素をプレビューします。

  2. 右上の[このテンプレートを使用]ボタンをクリックしてインストールします。


インストールしたテンプレートは、左ペインの[自分のサーキット]に表示されます。

一からのサーキットの作成  

このオプションでは、状態とロジックを手動で定義してサーキットを作成できます。
  1. 作成]をクリックします([一から開始]オプション)。

  2. 一意の名前を指定し、サーキットの説明を追加します。

  3. 保存をクリックします。


デフォルトで、Pass状態(名前:「State1」)を含むサンプルのサーキットが作成され、[ビルダー表示]に視覚的なワークフローとして表示されます。

最初の状態を作成すると、前の状態と次の状態はデフォルトで「Start」と「End」になります。デフォルトの状態をクリックして、[ビルダー表示]で設定できます。



同様に、[コード表示]では、対応するJSONが自動的に生成されます。エディター上部のアイコンを使用すると、ワークフローグラフのみ、またはグラフと[コード表示]の両方を同時に表示できます。



サーキットを作成すると、サーキットのサーキットIDが作成されます。
このIDは、次の用途で使用されます。
  • SDKとAPIでサーキットを参照する
  • サーキット状態を使用してサーキットをネストする
  • バッチ状態をサーキットに関連付ける

サーキットの設定

Circuitは2つの方法で設定できます。

  • [Builder View]

  • [Code View]

Circuitは、[Builder View]でドラッグ&ドロップ機能を使用して状態を配置するか、[Code View]でシンプルなJSONを作成して構築します。[Builder View]で変更を行うたびに、対応するJSONテキストが[Code View]で自動的に更新されます。その逆も同様です。一方のビューで変更を行い、もう一方のビューでCircuitを確認すると、この動作を確認できます。

 

ワークフロー構造の定義に加えて、Circuitと状態データにJSON Schemaベースの検証を適用できます。詳細については  スキーマ駆動型のデータ検証と保護 を参照してください。
  

[Builder View]でのCircuitの設定  

[Builder View]では、左ペインで利用可能な状態を使用してCircuitを構築できます。状態はCircuitの構成要素であり、アクションの実行、判断、またはある状態から別の状態への出力の受け渡しを行います。

Circuitの状態は、次のグループに分類されます。

  • フロー制御
  • 機能
  • 通知
  • ITオーケストレーション
  • データ変換
各状態の詳細については、Circuitの状態を参照してください。
[Builder View]でCircuitを構築するには、次の2つの手順を行います。
  1. 状態の追加
  2. 状態の定義

ステップ1:[Builder View]での状態の追加

  1. [Builder View]の右ペインには、利用可能な状態カテゴリーが表示されます。状態を選択し、ワークフローキャンバスにドラッグ&ドロップします。この操作により、設定ポップアップが開きます。
  2. 状態に一意の名前を入力します。
  3. 新しい状態を配置する位置として、[前の状態][次の状態]を選択します。
    • [作成]をクリックします。状態がフロー図に表示されます。

    ステップ2:状態の定義      

    1. 視覚的なワークフローで状態をクリックして設定します。
    2. 右ペインで、次の設定を行います。
      • 必要に応じて、上部の[状態名]を編集します。
      • [設定]で:
        • 初期設定では、[種類]項目には、選択した状態に基づく状態の種類が表示されます。
        • 種類はそのままにすることも、ドロップダウンで変更することもできます。
        • 状態の種類を変更すると、以前に保存した設定はリセットされます。
        • 選択した状態の種類に基づいて、対応する設定項目が表示されます。
        • [次の状態]項目には、選択可能な状態が一覧表示されます。
        • 対応している状態では、必要に応じて[エラー処理]オプションを設定します。
        • Circuitの状態を参照して、状態レベルの設定について詳しく確認してください。
      • [入力/出力]で:

        • 入力と出力の処理に必要なパスとパラメーターを設定します。

        • 詳細については、入力と出力の処理セクションを参照してください。

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

          
    Info
    留意点
    • 一部の状態の種類には、追加のパラメーターがあります。
      • Wait状態→期間
      • Batch 状態→コレクションパス、コレクション変数
      • Parallel状態→[パスの追加]
      • Branch状態→[条件の追加]
    • SuccessFailureを除くすべての状態には、次の状態が必要です
    • サーキットの最後の状態は、次の状態にEndを設定して定義します
    • 動的な入力パラメーターを追加できます。
      • Functionの場合→[パラメーターを追加]を使用
      • Webhookの場合→[パラメーターを追加][ヘッダーを追加]を使用

    コードビューでのサーキットの設定   

    コードビューでは、構造化されたJSON形式でサーキットを定義できます。ビルダーのコードビューアイコンを使用して、コードビューに切り替えます。
    サーキットを作成すると、Pass状態(State1)を含むサンプルワークフローがデフォルトで生成されます。
    コードビューでの状態の理解
    • 各状態はJSONオブジェクトとして表されます
    • 状態のプロパティはキーと値のペアとして定義されます
    一般的なプロパティは次のとおりです。
    1. type– 状態の機能を定義します
    2. next– 実行する次の状態を指定します
    その他の動作。
    • 状態にnext項目が含まれていない場合、その状態は最後の状態と見なされます
    • 状態が他のいずれの状態からもnextとして参照されていない場合、その状態は最初の状態として扱われます
    サーキットが標準のJSON構文に従っていることを確認してください。


    コードビューでサーキットを構築する手順は次のとおりです。

    1. 状態は属性で構成されます。状態名を入力します。
    2. 状態の属性をキーと値のペアとして定義します。
    3. 状態の以下の共通項目を定義します
      1. name:すべての状態には、サーキット内で識別するための一意の名前が必要です。上記に表示されているサーキットでは
      2. type状態の実際の機能を示します
      3. next:現在の状態の完了後に実行する次の状態の名前です
    1. 状態の種類に応じて追加の属性を設定します。各状態の詳細については、サーキットの状態を参照してください。
    2. onError属性を使用してエラー処理を設定します。
    3. 次の項目:inputPathoutputPathresultPath入力と出力の処理用に指定します。
    4. [保存]をクリックします。
    JSON定義にエラーがある場合、エラー行の横に赤い×印[]が表示されます。この印にカーソルを合わせると、エラーの理由が表示されます。

    Info
    留意点
    • すべてのサーキットには、開始状態を表すために、項目の値がstart: trueの状態が1つ必要です。
    • SuccessFailureを除くすべての状態には、next 状態が必要です。終端状態の次の状態の値はEndにする必要があります。
    • 状態は任意の順序で定義できます。実行順序は、start項目とnext項目のみによって決まります。
    • すべての項目とその値では、大文字と小文字が区別されます。値を定義したら、サーキット全体で完全に同じ値を指定する必要があります。
    • 状態のすべての標準属性名(コードビューで黒色で表示されるキー名)(type、next、duration、functionName、collectionPathなど)は、キャメルケースで記述する必要があります。

    Circuit設定で使用できる値の種類   

    Circuitを設定する際は、Parameters、Input Path、Result Selector、Output Pathのいずれを定義する場合でも、次のいずれかの方法で値を指定できます。

    静的な値

    設定項目に直接指定する固定値です。

    例。

    URL、文字列リテラル、フラグ、トークンなどの定数には、静的な値を使用します。

    Config Storeの値

    QntrlのConfig Storeに保存され、一元管理されている設定値を、変数参照を使用して取得します。

    例。

    'base_url': '${<config_linkname>}'

    これらの変数の作成方法と使用方法については、Config Storeを参照してください。

    状態入力値

    JSONPathを使用して、状態入力から値を直接抽出します。

    入力JSONの例。

    {
    'employee_details': {
          'emp_name': 'John Doe',
          'emp_id': '357'
    }
    }

    パラメーターでの使用方法。

    'name': '$.employee_details.emp_name',
    'ID': '$.employee_details.emp_id'
    コンテキストオブジェクト

    Circuit ID、実行ID、タイムスタンプ、発生元、リクエスト送信者の詳細など、動的な実行メタデータを取得します。


     'execution_id': '$$.execution.id',
    'requested_by': '$$.requestor.メール'

    これらの値には実行中のコンテキストが反映されるため、高度に動的な自動化を構築できます。

    完全な構造については、コンテキストオブジェクトを参照してください。

    Faker 

    実行中にランダムなテスト値を生成します。テスト実行、デモ、データのシミュレーションに役立ちます。

    Fakerメソッド名は、小文字のアンダースコア形式で指定する必要があります。

    'phone_number': '${#random.phone_number.cell_phone}',
    'city_name': '${#random.address.city}'

    サポートされているジェネレーターの完全な一覧については、Fakerメソッドガイドを参照してください。