PlatioGet - Platioからの入力

Platioアプリケーションのコレクションからレコードを取得します。
レコードに添付ファイルがある場合にダウンロードし指定フォルダーに保存することができます。
Platioビルダーを使って、Platioのコレクション一覧やカラム定義を取得します。詳細については下記トピック「Platioビルダーの使い方」を参照してください。

■ストリーム情報

入力フォーマットすべて
接続数無制限
説明 入力ストリームは使用せず、すべて無視します。
出力フォーマットRecord
説明 指定したPlatioアプリケーションのコレクションから取得したレコードを、出力ストリームのフィールド定義に従ってレコード形式で出力します。
Platioビルダーで設定する出力ストリームのフィールド名はカラム名を使用して作成されます。Platioアプリケーションが更新されカラム名が変更になった場合でもレコードを出力できます。また、Platioビルダーを再度起動することで出力ストリームのフィールド名をPlatioアプリケーションのカラム名と同期することができます。
Attachmentタイプのカラムからは、以下の5フィールドを取得することができます。
  • 「カラム名」:ダウンロードした添付ファイルのファイルパス
  • 「カラム名+半角スペース+size」:添付ファイルのサイズ
  • 「カラム名+半角スペース+name」:添付ファイルのファイル名
  • 「カラム名+半角スペース+id」:添付ファイルのID
  • 「カラム名+半角スペース+contentType」:添付ファイルのContent-Type
添付ファイルをダウンロードした場合に、「カラム名」フィールドにダウンロードしたファイルパスを出力します。
添付データ保存先で指定したフォルダーに同名のファイルが存在している場合の処理方法は、上書き処理で指定します。
「カラム名+_name」に出力されるファイル名はPlatioに保存されているファイル名であり、ダウンロードされたファイルと別名である場合があります。
上書き処理で「別名で保存する」を選択した場合は、ファイル名に別名をつけて保存できます。

例:添付ファイル名「data.txt」と同名のファイルが存在してる場合、別名は「data_1.txt」になります。


Objectタイプのカラムからは、スキーマに含まれるキーをそれぞれ取得することができます。
フィールド名は「カラム名+半角スペース+キー名」となります。

例:カラム名「血圧」、キー名「systolic」の場合のフィールド名は「血圧 systolic」となります。


Arrayタイプのカラムから取得する値が複数の値を保持している場合、全ての値を区切り文字で指定した文字列で繋げて出力します。
参照型のReferenceStringタイプ、ReferenceNumberタイプ、ReferenceUserタイプは参照先カラムの実際の値を出力します。参照先のレコードIDは「カラム名+半角スペース+recordId」で取得することができます。
全タイプに共通して、カラムが値を持たない場合は、出力ストリームのフィールド値はnullになります。
レコードのカラム以外に、レコードのIDを「_RecordId」というフィールド名で取得することができます。

■コンポーネントプロパティ

名前プロパティ型マッピング説明
コネクションを使用boolean- 接続先に以下のコネクション名 を使用するかどうか選択します。
はい [true] - 以下のコネクション名 で指定されたPlatio接続名を接続先として使用します。
いいえ [false] - コネクション情報 以下のプロパティを使ってPlatioに接続を行います。
コネクション名connection-コネクションを使用 が「はい」の場合に、Platioアプリケーションへの接続用コネクションを指定します。
コネクションペインまたは管理コンソールにて作成した接続名を選択します。
コネクション情報group-コネクションを使用 プロパティが「いいえ」の場合に使用されるプロパティ群です。
アプリケーションベースURLstring入力&出力 PlatioのアプリケーションベースURLを指定します。
指定するURLは「 https://api.plat.io/v1/[アプリケーションのID] 」の形式で指定します。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
トークンIDstring入力&出力 Platioの開発者向け情報ページから取得したAPIトークンのトークンIDを指定します。
詳細については下記トピック「APIトークンの取得方法」を参照してください。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
秘密トークンpassword入力&出力 Platioの開発者向け情報ページから取得したAPIトークンの秘密トークンを指定します。
詳細については下記トピック「APIトークンの取得方法」を参照してください。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
プロキシ設定を使用boolean- 管理コンソールで設定したプロキシ設定を使用するかどうかを指定します。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
はい [true] - プロキシ設定を使用します。
いいえ [false] - プロキシ設定を使用しません。
コレクションstring入力&出力 コレクションのIDかコレクションの名前を指定します。
Platioビルダーで選択することができます。
レコードIDstring入力&出力 取得するレコードのIDを指定します。
レコードのIDを指定した場合は、スキップ件数取得件数ソートキーソート順ソートするカラム検索条件検索条件内タイムゾーンの各プロパティ値は使用されず、指定したIDのレコードのみ取得します。
スキップ件数int入力&出力 読み飛ばすレコード数を指定します。
「30」を指定した場合、レコード先頭から30レコードは出力されず、31番目のレコードから出力されます。
取得件数int入力&出力 取得するレコード数を指定します。
指定しない場合は全てのレコードを取得します。
ソートキーchoice入力&出力 ソートキーを指定します。
作成日時 [createdAt] - 作成日時でソートします。
更新日時 [updatedAt] - 更新日時でソートします。
作成者 [createdBy] - 製作者でソートします。
更新者 [updatedBy] - 更新者でソートします。
カラム指定 [column] - カラムでソートします。
ソート順choice入力&出力 ソートの向きを指定します。
昇順 [ascending] - 昇順にソートします。
降順 [descending] - 降順にソートします。
ソートするカラムstring入力&出力ソートキー が「カラム指定」の場合に、ソートキーに使用するカラムを指定します。
Platioビルダーで選択することができます。
※指定できるカラムは「ソート可能」である必要があります。
検索条件string入力&出力 検索条件を指定します。
指定する「レコード検索書式」については、Platioのヘルプを参照してください。
Platioビルダーでカラムを指定して検索条件を作成することができます。
※指定できるカラムは「検索可能」である必要があります。
検索条件内タイムゾーンchoice入力&出力検索条件 プロパティで指定された$from、$toのタイムゾーンを指定します。
選択項目に無い場合タイムゾーンを入力することも可能です。
UTC(協定世界時) [UTC] - UTC
東京 [Asia/Tokyo] - 東京
添付データ保存先string入力&出力 添付データを保存するフォルダーを指定します。
相対パスの場合は、添付データ保存先パスの起点 の指定に基づいて解釈されます。
添付データ保存先パスの起点pathResolver入力&出力添付データ保存先 が相対パス指定の場合に、ベースフォルダーを指定します。
プロジェクトフォルダ [Relative]
プロジェクトファイルと同じフォルダーを起点にします。
ホームフォルダー [ProjectOwner]
プロジェクトオーナーのホームフォルダーを起点にします。
実行ユーザーのホームフォルダー [ExecuteUser]
実行ユーザーのホームフォルダーを起点にします。
上書き処理choice- 添付データを保存するときの処理を選択します。
上書きしない [Never] - 添付データと同名のファイルが存在する場合に上書きしません。
上書きする [Force] - 添付データと同名のファイルが存在する場合に添付データで上書きします。
別名で保存する [Rename] - 添付データと同名のファイルが存在する場合に添付データを別名で保存します。
エラーにする [Error] - 添付データと同名のファイルが存在する場合にエラーにします。
区切り文字choice入力&出力 取得したカラムの型がArray型だった場合に使用する、値を区切る文字列を指定します。
ループを開始loopProcess- 取得したレコードをまとめて出力するか、1レコードずつループして出力するかを選択します。
はい [true] - ループの起点となって1レコードずつストリームに出力されます。
いいえ [false] - すべてのレコードがまとめてストリームに出力されます。

■ループ処理

ループを開始 が「はい」の場合、取得したレコードを1つずつ出力します。「いいえ」の場合は、取得したすべてのレコードを一度に出力します。

■トランザクション処理

コミット何もしません。
ロールバック何もしません。

■エラー処理

タイプパラメーターエラー処理フロー
へのストリーム
エラー
コード
説明
APIエラー「APIエラーのパラメーター 」
を参照してください。
コンポーネントの入力ストリーム1 Platio APIがエラーを返した場合
  • パラメーターが不正な場合
  • ユーザー認証に失敗した場合
  • リクエストが許可されていない場合
  • 幾つかのリソースが見つからない場合
  • リクエスト数の制限に達した場合
  • サーバー上で問題が発生した場合
  • 一時的にサービスを使用することができない場合
接続エラー なし コンポーネントの入力ストリーム2Platioとの通信中にエラーが発生した場合
3Platioとの通信中、もしくは通信前処理でエラーが発生した場合
レコードが無い なし コンポーネントの入力ストリーム4取得するレコードが無い場合
汎用 なし コンポーネントの入力ストリーム5コネクション名 に指定したコネクションが見つからない場合
8ディレクトリの作成に失敗した場合
9Platioに関連するその他のエラーが発生した場合

■「APIエラー」のパラメーター

No.名前説明
1ErrorCodePlatio APIのエラーコードが返されます。
2StatusCodeHTTPのステータスコードが返されます。
3ErrorResponseエラーレスポンスのJSONが返されます。

■Platioのフィールドへのマッピングについて

Platioのカラム型とデータ型

Platioから取得した値、設定する値と、フィールド定義のデータ型の対応を以下に示します。

Platio型データ型
String型String
※複数行テキストのカラムに設定する場合の改行コードはLFを指定してください。
Number型Integer
Boolean型Boolean
DateTime型DateTime
Date型String
Time型String
Location型
  • 緯度(latitude):Decimal
  • 経度(longitude):Decimal
  • 高度(altitude):Decimal
Attachment型
  • ID(id):String
  • 名前(name):String
  • 内容の形式(contentType):String
  • サイズ(size):Integer
User型
  • ID(id):String
  • 名前(name):String
Object型Object型に含まれるValueのタイプに合わせて設定されます。
Array型String
複数の値を区切り文字で繋げた値になります。
※Array型のvalueがObject型のような複雑なカラムを作成・更新する場合は入力ストリームにTextストリームのJSON文字列を使用する必要があります。
ReferenceString型String
参照先のレコードのカラムの値になります。
作成・更新する場合はカラム値を設定します。その値から検索して得られた1つ目のレコードのIDを参照先とします。
  • レコードID(recordId):String
    レコードIDを指定した場合、指定されたレコードを参照先とし値による検索は行われません。
ReferenceNumber型Integer
参照先のレコードのカラムの値になります。
作成・更新する場合はカラム値を設定します。その値から検索して得られた1つ目のレコードのIDを参照先とします。
  • レコードID(recordId):String
    レコードIDを指定した場合、指定されたレコードを参照先とし値による検索は行われません。
ReferenceUser型String
参照先のレコードのカラムの値(名前、ID)になります。
作成・更新する場合は名前を設定します。その値から検索して得られた1つ目のレコードのIDを参照先とします。
  • レコードID(recordId):String
    レコードIDを指定した場合、指定されたレコードを参照先とし値による検索は行われません。

■APIトークンの取得方法

Platio APIを使用するためにはAPIトークンを生成する必要があり、PlatioGetコンポーネントは生成したAPIトークンを指定する必要があります。
APIトークンには「トークンID」と「秘密トークン」がありPlatioの「開発者向け情報」ページで生成することができます。
「トークンID」はAPIトークンを生成後、Platioの「開発者向け情報」ページよりいつでも確認することができますが、「秘密トークン」はAPIトークン生成時のみ表示され、その後、値を確認することはできません。
「秘密トークン」はAPIトークン生成時に「クリップボードにコピー」アイコンをクリックしてコピーし保存してください。

■Platio APIリクエスト回数

PlatioGetコンポーネントのPlatio APIリスエスト回数は以下のようになります。
API説明
レコードリスト・レコード・ユーザーリスト・アプリケーション定義の取得 「アプリケーション定義の取得」は実行時に必ず1回実行します。
「レコードリスト」は、取得するレコード件数、100レコードごとにリクエスト回数が増加します。
検索条件にユーザー名などを指定した場合に「ユーザーリスト」を1回実行します。
レコードのIDを指定して1レコードを取得する場合は「レコード」を1回実行します。
添付ファイルの取得 レコード数×1レコード内の添付ファイル数の回数リクエストします。
例:1レコードに2つの添付ファイルを持つ250レコードを検索条件を指定しないで全件取得し全添付ファイルを取得する場合
「レコードリスト・レコード・ユーザーリスト・アプリケーション定義の取得」:4回
「添付ファイルの取得」:500回

※Platio APIは、Platioビルダー使用時にも使用されます。

■Platioビルダーの使い方

Platioビルダーは、コネクション名 で接続できるPlatioアプリケーションからコレクション一覧を取得し、そのコレクションのカラムを出力ストリームのフィールドとして設定する専用ツールです。

●Platioビルダーを起動する

以下のいずれかの操作でPlatioビルダーを起動します。

●コネクションの選択

コネクションを使用 で「はい」を設定し、コネクション名 が設定されていない場合、Platioビルダー起動時にコネクションダイアログが表示されます。
新規にコネクションを作成する場合は「新規コネクション」を選択してください。
既存のコネクションを使用する場合は「名前」のプルダウンリストより使用するコネクション名を選択してください。選択したコネクションを使用してPlatioアプリケーションへ接続します。

●新規コネクションの作成

「新規コネクション」を選択した場合「コネクションの作成」ダイアログが表示されますので、作成するコネクション名を入力し「OK」ボタンをクリックしてください。



コネクションのプロパティ入力するダイアログが表示されますので、コネクションの各プロパティを設定し「保存」ボタンをクリックしてください。

注意

この時点で新規コネクションが保存されます。

作成したコネクションでPlatioアプリケーションへ接続します。


Platioアプリケーションへの接続が成功すると以下のようなダイアログが表示されます。

●取得するフィールドを指定する

(2)のコレクション一覧からコレクションを選択すると(3)に選択したコレクションから取得できるフィールド一覧が表示されます。 フィールド一覧でフィールド名の左にあるチェックボックスをオンにします。指定したフィールドを取り消すには、チェックボックスをオフにします。

●検索条件

検索条件を指定する

(3)のフィールド一覧でフィールドをクリックし、右クリックして表示されるメニューから「検索条件へ追加」を選択します。 (4)に指定したフィールドを選択した検索条件の行が追加されます。追加された行で演算子を選択し、値を入力します。
検索条件に指定できる名前は、「検索可能」なカラム名の他に「$from」「$to」があります。この検索条件はレコードの更新時刻で検索する場合に使用します。 「$from」「$to」で使用できる演算子は「:」のみとなります。
例:2017年1月13日の0時よりも新しい(この時刻を含む)レコード

			$from:2017-01-13
			
例:2016年10月3日の15時よりも古い(この時刻を含まない)レコード
			$to:2016-10-03T15:00:00
			
PlatioタイプがUser.id、User.nameのフィールドを右クリックして追加された検索条件の名前は、そのフィールドに対応するPlatioのUser型の名前となります。

検索条件を編集する

(4)の条件一覧で編集する条件を直接編集します。

検索条件を削除する

(4)の条件一覧で削除する条件をクリックし、右クリックして表示されるメニューから「検索条件削除」を選択します。 (4)から指定した条件が削除されます。

●取得条件オプション

スキップ件数を指定する

(5)のスキップ件数にスキップする件数を入力します。

取得件数を指定する

(5)の取得件数に取得するレコードの件数を入力します。

レコードの並び替え

レコードを昇順または降順にソートして読み込むには、ソートキーとソート順を指定します。 (5)のソートキープルダウンリストからソートキーを選択します。 ソートキーを指定後、(5)の「昇順」「降順」プルダウンリストからソート順を選択します。 ソートキーで「カラム指定」を選択した場合は、ソートに使用するカラムを2通りの方法で選択可能です。

  1. (3)のフィールド一覧でフィールドをクリックし、右クリックして表示されるメニューから「ソートするカラムへ設定」をクリックします。
  2. (5)のソートするカラムプルダウンリストからカラムを選択します。
ソートキーに指定できるカラムは「ソート可能」である必要があります。
PlatioタイプがUser.id、User.nameのフィールドを右クリックして設定されたソートするカラムは、そのフィールドに対応するPlatioのUser型の名前となります。

タイムゾーンを指定する

(4)の検索条件で日時を扱う場合にタイムゾーンを選択します。

Arrayセパレーターを指定もしくは入力する

Array型のセパレーターをプルダウンリストから選択します。

他の文字列をセパレーターとして使用したい場合は、文字列を入力します。