このドキュメントは、MAGELLAN BLOCKS のフローデザイナーサービスで使用するブロックのリファレンスです。

2020 年 06 月 22 日時点で、12 種類のカテゴリー、92 個のブロックを公開しています。

以下は、現在公開しているブロックの一覧です。ダウンロードして、印刷したりスマートフォンやタブレットなどのデバイスで閲覧するのに適しています。

（画像をクリックすると拡大表示されます。）

ブロックのプロパティによっては、「%Y/%m/%d %H:%M:%S」のような % 形式の文字列書式が記述できます。この書式は、そのブロックが処理されるときに、所定の日時に変換されます。

変換される日時は、フローの実行が定期実行か手動実行で異なります。

• 定期実行されるフローの場合は、「フローの開始」ブロックの「開始時間」プロパティの値です。
• 手動実行されるフローの場合は、フローの手動実行を MAGELLAN BLOCKS が受け付けた日時です。

例えば、「Slack通知ブロック」の「通知メッセージ」プロパティに、以下のように記述されているとします。

処理日時: %Y/%m/%d %H:%M:%S

また、このブロックを含むフローが、毎時 0 分に定期実行されるように「開始時間」プロパティで「0 * * * *」と指定されているとします。

このとき、フローが 2016/4/13 11:01:23 に実行された場合、以下のように変換されます。定期実行の場合は、実際に実行された日時ではないことに注意してください。

処理日時: 2016/04/13 11:00:00

info_outline 11:01:23 に実行されたということは、11:00:00 に実行するようにスケジューリングされたものが実行されたため。

フローには、「変数」機能があります。変数とは、フローの実行中に文字列や整数などのデータを格納・参照できる記憶領域のことで、固有の名称で識別できます。

この変数には、「フロー間共通変数」と「フロー実行内変数」の 2 種類があります。ここでは、フロー実行内変数について解説します。

フロー実行内変数には、以下の特徴があります。

• 複数持つことができ、それぞれに名前を付けて区別します。名称のルールは以下のとおりです。
  • 名称に使える文字は、英大文字・英小文字・数字・_（アンダースコアー）です。
  • 数字のみの変数名は使用できません。
  • _ で始まる名称は、BLOCKS が定義するフロー実行内変数として使います。現在、以下のフロー実行内変数が定義されています（今後も追加予定）。

    フロー実行内変数	説明
    _flow_aliases	フローの ID が格納されています。
    _flow_id	フローごとに自動採番された番号が格納されています。
    _flow_name	［フローの開始］ブロックのブロック名が格納されています。
    _board_url	フローデザイナーの URL が格納されています。 ［例］https://*****.magellanic-clouds.net/ のような URL です。
    _board_id	フローデザイナー URL のサブドメインが格納されています。 ［例］https://*****.magellanic-clouds.net/ の ***** 部分です。
    _execute_user_id	フローを実行したユーザーの ID が格納されています。
    _execute_user_name	フローを実行したユーザーの名前が格納されています。

    info_outline _ 始まりの名称でフロー実行内変数を命名すると、今後追加される BLOCKS 定義のフロー実行内変数と重複する可能性があります。名称が重複した場合、予期しない動作となる可能性があるため、_ 始まりの名称で命名しないことをおすすめします。

    また、FOO_BAR のようなすべて大文字の名称は、フロー間共通変数での命名を推奨しているため、すべて大文字の名称で命名しないこともおすすめします。

• フローの実行中にのみ有効です。
• ブロックの入力や出力に使えます。

ブロックのプロパティの一部では、「変数展開」機能が使えます。

「変数展開」とは、ブロックのプロパティの値の全部または一部を変数の内容で置き換えることです。

変数展開の書き方は、以下のとおりです。

${変数}

${ と } の間に変数を記述すると、ブロックが処理されるときに、その変数が参照する内容に置き換わります。

たとえば、「クエリーの実行」ブロックの「結果格納先のテーブル」プロパティに、${table_name} と設定します。

この「クエリーの実行」ブロックを実行したときに、変数 table_name の内容が samples だった場合、「結果格納先のテーブル」プロパティの値は、samples となります。

この変数展開が使えるプロパティは、「% 形式の文字列書式」が使えるプロパティと同じです。

変数に格納されたデータが配列やオブジェクトの場合は、そのデータの一部を取得できます。

配列とは、複数の値を連続して並べて、それをひとまとまりのデータとして表現したものです（下図参照）。変数に配列が格納されている場合は、インデックスを指定した値の取得ができます。インデックスは、値が先頭から何番目にあるのかという位置を示します（先頭の値は 0 番目）。

オブジェクトとは、キーと値のペアを基本とし、このペアの集合をひとまとまりのデータとして表現したものです（下図参照）。変数にオブジェクトが格納されている場合は、キーを指定した値の取得ができます。

info_outline BLOCKS では、「オブジェクト生成」ブロックを使ってオブジェクトが作成できます。また、BLOCKS のブロックでよく取り扱う JSON のオブジェクト値もこれと同義です。

書式

＜配列の場合＞

変数.インデックス

＜オブジェクトの場合＞

変数.キー

info_outline 変数が _ の場合は、変数を省略した .インデックス および .キー という書き方もできます。

変数 y に下図の配列が格納されている場合は、y.1 は ”API” を取得します。

変数 x に下図のオブジェクトが格納されている場合は、x.name（キー "name" の " は外す）は ”John Smith” を取得します。

オブジェクトの中にオブジェクトがあるとか、オブジェクトの中に配列があるようにオブジェクトと配列が入れ子になっている場合は、変数.キー.キー や 変数.キー.インデックス などのように .（ピリオド）をつないで、入れ子になった中の値も取得できます。

変数 x に上図のオブジェクトが格納されている場合は、x.languages.0 は、”English” を取得します。

info_outline この記法は、${x.name} や ${y.1} などのように、変数展開でも使用できます。