モジュール

NO IMAGE

 ホーム > 外部サービス連携 > Make > モジュール

モジュールの説明・使い方

モジュール種別モジュール名説明
トリガーWatch BOT Done BOT実行完了をトリガーとして、フローを開始する事ができます。
BOTの出力値を取得し、以降のフローで利用できます。
アクションExecute BOTクラウドBOT上のBOTをアクションとして実行する事ができます。
BOT実行時の入力値を指定できます。また、BOT完了時の出力値を以降のフローで利用できます。
アクションUpload FileファイルデータをクラウドBOTへアップロードします。
File ref値が出力値として取得でき、その出力値はExcute BOTで使うことができます。
アクションDownload FileクラウドBOTからファイルデータをダウンロードします。
File ref値からファイルを取り出すことができます。
アクションMake an API CallMake上で設定したConnectionを使用し、クラウドBOTが提供しているAPIを呼び出す事ができます。

Watch BOT Done (トリガー)

BOT実行完了をトリガーとして、フローを開始する事ができます。BOTの出力値を取得し、以降のフローで利用できます。

Watch BOT Doneの設定

WebhookWebhookを指定します。
このWebhookで設定したBOTが実行完了したときにトリガーが発動します。
Webhook設定についてはこちらをご覧ください。

Webhook 設定について

Webhook name任意の名前を指定します。
ConnectionConnectionを選択します。
コネクション作成についてはこちらをご覧ください。
LanguageBOT実行言語を選択します。
ContractクラウドBOTの契約を選択します。
クラウドBOTで外部連携が有効の契約を選択できます。
BOTトリガーをかけるBOTを選択します。
クラウドBOTで外部連携済みのBOTが選択できます。

Watch BOT Doneの実行結果(OUTPUT)

モジュールの実行結果(OUTPUT)として、BOT Result Collectionが出力されます。

詳細はBOT Result Collectionを参照してください。

Execute BOT (アクション)

クラウドBOT上のBOTをアクションとして実行する事ができます。
BOT実行時の入力値を指定できます。また、BOT完了時の出力値を以降のフローで利用できます。

Execute BOTの設定値

ConnectionConnectionを選択します。
コネクション作成についてはこちらをご覧ください。
LanguageBOT実行言語を選択します。
ContractクラウドBOTの契約を選択します。
クラウドBOTで外部連携が有効の契約を選択できます。
BOT実行するBOTを選択します。
クラウドBOTで外部連携済みのBOTが選択できます。
BOT入力値BOTの入力値を設定します。
未設定の場合、BOTのデフォルト値で実行されます。
*BOTとAsyncの間にデータ名が表示されます。
BOT入力値の入力について
Async[Yes]BOTを非同期で実行します。BOTの実行開始をもって即時レスポンスを返します。
[No]BOTを同期で実行します。BOT実行完了時にレスポンスを返します。
*BOTを非同期で実行、またはBOT実行開始から30秒を超える場合は、BOTが実行中であってもその時点でレスポンスを返します。statusは"2"(実行中)になります。また、Cast URLが発行されます。

Execute BOTのINPUT Bundle Collectionの定義はこちらをご覧ください。

BOT入力値の入力について

BOT入力値のデータタイプによって入力の仕方が変わります。クラウドBOTのデータビューア入力インターフェースと比較しています。

テキストタイプ
テキストタイプのデータは、単一の文字列を指定します。

複数テキストタイプ
複数テキストタイプのデータは、複数文字列(配列/Array)を指定します。

ファイルタイプ
ファイルタイプのデータは、File ref値(配列/Array)を指定します。

グループの場合
グループの行は配列(Array)で表します。"Add item"を押すことでグループ行を増やすことができます。

追加した1行内の入力の仕方は、データタイプによって変わります。クラウドBOTのデータビューア入力インターフェースと比較しています。

テキストタイプ
テキストタイプのデータは、単一の文字列を指定します。

複数テキストタイプ
複数テキストタイプのデータは、複数文字列(配列/Array)を指定します。

ファイルタイプ
ファイルタイプのデータは、File ref値(配列/Array)を指定します。

Execute BOTの実行結果(OUTPUT)

モジュールの実行結果(OUTPUT)として、BOT Result Collectionが出力されます。

詳細はBOT Result Collectionについてを参照してください。

Upload File (アクション)

ファイルデータをクラウドBOTへアップロードします。File ref値が出力値として取得でき、その出力値はExcute BOTで使うことができます。

Upload Fileの設定値

ConnectionConnectionを選択します。
コネクション作成についてはこちらをご覧ください。
LanguageBOT実行言語を選択します。
ContractクラウドBOTの契約を選択します。
クラウドBOTで外部連携が有効の契約を選択できます。
Fileアップロードするファイルデータを指定します。
デフォルトでは、前にあるモジュールの出力値からファイルデータを自動識別します。
*Mapで指定することもできます。

* FileをMapで指定する場合

File nameファイルの名前を指定します。前にあるモジュールの出力値からNameを関連付けます。
Dataファイルのバイナリデータを指定します。前にあるモジュールの出力値からDataを関連付けます。

Upload FileのINPUT Bundle Collectionの定義はこちらをご覧ください。

Upload Fileの実行結果(OUTPUT)

モジュールの実行結果(OUTPUT)として、Upload Result Collectionが出力されます。

詳細はUpload Result Collectionを参照してください。

Download File (アクション)

クラウドBOTからファイルデータをダウンロードします。File ref値からファイルを取り出すことができます。

Download Fileの設定値

ConnectionConnectionを選択します。
コネクション作成についてはこちらをご覧ください。
LanguageBOT実行言語を選択します。
ContractクラウドBOTの契約を選択します。
クラウドBOTで外部連携が有効の契約を選択できます。
File refFile ref値を指定します。

Download FileのINPUT Bundle Collectionの定義はこちらをご覧ください。

Download Fileの実行結果(OUTPUT)

モジュールの実行結果(OUTPUT)として、Download Result Collectionが出力されます。

詳細は Download Result Collectionを参照してください。

Make an API Call (アクション)

Make上で設定したConnectionを使用し、クラウドBOTが提供しているAPIを呼び出す事ができます。

Make an API Callの設定値

APIリファレンスを参照してください。

ConnectionConnectionを選択します。
コネクション作成についてはこちらをご覧ください。
URLリクエストエンドポイントを指定します。https://api.c-bot.pro/からの相対パスを指定します。
Methodリクエストメソッドを選択します。
Headers任意数のリクエストヘッダーを指定します。
Query String任意数のクエリ文字列を指定します。
Bodyリクエストペイロードを指定します。

Make an API CallのINPUT Bundle Collectionの定義はこちらをご覧ください。

Make an API Callの実行結果

モジュールの実行結果(OUTPUT)として、API Result Collectionが出力されます。

詳細は API Result Collectionを参照してください。

Collection定義

Execute BOT Parameter Collection (INPUT Bundle Collection)

Execute BOTの設定値を格納するCollectionです。構造は以下の通りです。

キー名
Languagetextリクエスト言語( 日本語:ja 英語:en)
ContracttextAPIの公開パス
BOTtextBOT ID
{データ名}または{グループ名[データ名]}textまたはArrayBOT入力値
Asyncboolean同期モード(ture:同期 false:非同期)

BOT入力値について

BOT入力値はデータタイプにより値が変わります。

データタイプ
テキストタイプtext文字列
複数テキストタイプArray文字列の配列
ファイルタイプArrayファイル ref値の配列

グループの場合

データタイプ
テキストタイプArray文字列の配列
複数テキストタイプ・ファイルタイプArrayGroup Row Data Collectionの配列

Upload Parameter Collection (INPUT Bundle Collection)

Upload Fileの設定値を格納するCollectionです。構造は以下の通りです。

キー名
Languagetextリクエスト言語(日本語:ja 英語:en)
ContracttextAPIの公開パス
File nametextファイル名
DataBufferバイナリデータ

Download Parameter Collection (INPUT Bundle Collection)

Download Fileの設定値を格納するCollectionです。構造は以下の通りです。

キー名
Languagetextリクエスト言語(日本語:ja 英語:en)
ContracttextAPIの公開パス
File reftextファイルのref値

API Call Parameter Collection (INPUT Bundle Collection)

Make an API Callの設定値を格納するCollectionです。構造は以下の通りです。

キー名
URLtextリクエストエンドポイント
Methodtextリクエストメソッド
HeadersArrayHeaders Collectionの配列
Query StringArrayQuery String Collectionの配列
Bodytextリクエストペイロード

Bot Result Collection (OUTPUT Bundle Collection)

Watch BOT DoneExecute BOTの実行結果(OUTPUT)を格納するCollectionです。構造は以下の通りです。

キー名
Codeuintegerレスポンスコード
Job IDtextジョブID
BOT IDtextBOT ID
BOT nametextBOT名
Statusinteger実行ステータス(0:正常終了 1:エラー 2:実行中)
Start timedate実行を開始した日時
Elapsed timeinteger実行に要した秒数
Cast URL *textキャストURL
Messagetextアナウンスメッセージ
OutputCollectionOutput Collection

* Statusが2の場合、表示されます。

Upload Result Collection (OUTPUT Bundle Collection)

Upload Fileの実行結果(OUTPUT)を格納するCollectionです。構造は以下の通りです。

キー名
File reftextファイルのref値

Download Result Collection (OUTPUT Bundle Collection)

Download Fileの実行結果(OUTPUT)を格納するCollectionです。構造は以下の通りです。

キー名
Databufferバイナリデータ
File nametextファイル名
File sizenumberファイルサイズ(byte)

API Call Result Collection (OUTPUT Bundle Collection)

Make an API Callの実行結果(OUTPUT)を格納するCollectionです。構造は以下の通りです。

キー名
BodyCollectionリクエストボディ
HeadersCollectionリクエストヘッダ

Output Collection

実行結果(OUTPUT)の出力値を格納するCollectionです。データ、グループではそれぞれ値が異なります。構造は以下の通りです。

キー名
{データ名}または{グループ名}データ名…textまたはArray / グループ名…Collectionデータ名… 出力データ値 / グループ名…Group Collection

出力データ値について

出力データ値はデータタイプにより値が変わります。

データタイプ
テキストタイプtext文字列
複数テキストタイプArray文字列の配列
ファイルタイプArrayFile Collectionの配列

File Collection

ファイルを格納するCollectionです。構造は以下の通りです。

キー名
File reftextファイルのref値
MetaCollectionMeta Collection

Meta Collection

ファイルのメタデータを格納するCollectionです。構造は以下の通りです。

キー名
File nametextファイル名
File sizenumberファイルサイズ(byte)
Timestampnumberファイルの作成日時(UNIXタイムスタンプ)

Group Collection

グループを格納するCollectionです。構造は以下の通りです。

キー名
{データ名}Array出力データ名の配列 / Group Row Data Collection の配列

Group Row Data Collection

グループの行データを格納するCollectionです。構造は以下の通りです。

キー名
ValuesArray入力データ値の配列 / 出力データ値の配列

Headers Collection

リクエストヘッダーを格納するCollectionです。構造は以下の通りです。

キー名
Keytextヘッダ名
Valuetextヘッダ値

Query String Collection

クエリ文字列を格納するCollectionです。構造は以下の通りです。

キー名
Keytextクエリパラメータ名
Valuetextクエリパラメータ値

Connection作成

MakeシナリオでクラウドBOTのモジュールを使用する際は、Connection作成が必要です。使用するモジュールの設定から作成できます。

1. Connectionの"Add"をクリックします。

2. サービスへのサインインが要求されますのでそのままサインインします。
*すでにサインイン済みの場合はスキップします。

3. 認可リクエスト画面が表示されますので、利用規約、プライバシポリシーを確認の上、"許可する"をクリックします。

4. Connection nameに任意の名前を入力し、"Save"をクリックします。