入力 | フォーマット | すべて |
---|---|---|
接続数 | 無制限 | |
説明 | 入力ストリームは使用せず、すべて無視します。 | |
出力 | フォーマット | Record |
説明 |
指定したPlatioアプリケーションのコレクションから取得したレコードを、出力ストリームのフィールド定義に従ってレコード形式で出力します。 Platioビルダーで設定する出力ストリームのフィールド名はカラム名を使用して作成されます。Platioアプリケーションが更新されカラム名が変更になった場合でもレコードを出力できます。また、Platioビルダーを再度起動することで出力ストリームのフィールド名をPlatioアプリケーションのカラム名と同期することができます。 Attachmentタイプのカラムからは、以下の6フィールドを取得することができます。
添付データ保存先で指定したフォルダーに同名のファイルが存在している場合の処理方法は、上書き処理で指定します。 添付ファイルのダウンロード時に何らかのエラーが発生した場合、そのレコードで処理は停止します。ただし、エラーのタイプがAPIエラーで取得するフィールドに「カラム名+半角スペース+status」フィールドを選択している場合は、APIエラーのステータスコードが「カラム名+半角スペース+status」フィールドに格納されて処理が継続されます。またこの時、添付ファイルを正常にダウンロードした場合の値は「200」、レコードが添付ファイルを保持していない場合の値はnullに設定されます。 「カラム名+_name」に出力されるファイル名はPlatioに保存されているファイル名であり、ダウンロードされたファイルと別名である場合があります。 上書き処理で「別名で保存する」を選択した場合は、ファイル名に別名をつけて保存できます。 例:添付ファイル名「data.txt」と同名のファイルが存在してる場合、別名は「data_1.txt」になります。 Objectタイプのカラムからは、スキーマに含まれるキーをそれぞれ取得することができます。 フィールド名は「カラム名+半角スペース+キー名」となります。 例:カラム名「血圧」、キー名「systolic」の場合のフィールド名は「血圧 systolic」となります。 Arrayタイプのカラムから取得する値が複数の値を保持している場合、全ての値を区切り文字で指定した文字列で繋げて出力します。 参照型のReferenceStringタイプ、ReferenceNumberタイプ、ReferenceUserタイプは参照先カラムの実際の値を出力します。参照先のレコードIDは「カラム名+半角スペース+recordId」で取得することができます。 全タイプに共通して、カラムが値を持たない場合は、出力ストリームのフィールド値はnullになります。 レコードのカラム以外に、レコードのIDを「_RecordId」というフィールド名で取得することができます。 |
名前 | プロパティ型 | マッピング | 説明 | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
コネクションを使用 | boolean | - |
接続先に以下のコネクション名 を使用するかどうか選択します。
|
||||||||||||||||||
コネクション名 | connection | - | コネクションを使用 が「はい」の場合に、Platioアプリケーションへの接続用コネクションを指定します。 コネクションペインまたは管理コンソールにて作成した接続名を選択します。 |
||||||||||||||||||
コネクション情報 | group | - | コネクションを使用 プロパティが「いいえ」の場合に使用されるプロパティ群です。 | ||||||||||||||||||
アプリケーションベースURL | string | 入力&出力 |
PlatioのアプリケーションベースURLを指定します。 指定するURLは「 https://api.plat.io/v1/[アプリケーションのID] 」の形式で指定します。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。 |
||||||||||||||||||
トークンID | string | 入力&出力 |
Platioの開発者向け情報ページから取得したAPIトークンのトークンIDを指定します。 詳細については下記トピック「APIトークンの取得方法」を参照してください。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。 |
||||||||||||||||||
秘密トークン | password | 入力&出力 |
Platioの開発者向け情報ページから取得したAPIトークンの秘密トークンを指定します。 詳細については下記トピック「APIトークンの取得方法」を参照してください。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。 |
||||||||||||||||||
タイムアウト | int | 入力&出力 |
Platioアプリケーションへの接続時のタイムアウト値を指定します。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。 |
||||||||||||||||||
プロキシ設定を使用 | boolean | - |
管理コンソールで設定したプロキシ設定を使用するかどうかを指定します。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
|
||||||||||||||||||
コレクション | string | 入力&出力 |
コレクションのIDかコレクションの名前を指定します。 Platioビルダーで選択することができます。 |
||||||||||||||||||
レコードID | string | 入力&出力 |
取得するレコードのIDを指定します。 レコードのIDを指定した場合は、スキップ件数、取得件数、ソートキー、ソート順、ソートするカラム、検索条件、検索条件内タイムゾーンの各プロパティ値は使用されず、指定したIDのレコードのみ取得します。 |
||||||||||||||||||
スキップ件数 | int | 入力&出力 |
読み飛ばすレコード数を指定します。 「30」を指定した場合、レコード先頭から30レコードは出力されず、31番目のレコードから出力されます。 |
||||||||||||||||||
取得件数 | int | 入力&出力 |
取得するレコード数を指定します。 指定しない場合は全てのレコードを取得します。 |
||||||||||||||||||
ソートキー | choice | 入力&出力 |
ソートキーを指定します。
|
||||||||||||||||||
ソート順 | choice | 入力&出力 | ソートキー を指定する場合に、ソートの向きを指定します。
|
||||||||||||||||||
ソートするカラム | string | 入力&出力 | ソートキー が「カラム指定」の場合に、ソートキーに使用するカラムを指定します。 Platioビルダーで選択することができます。 ※指定できるカラムは「ソート可能」である必要があります。 |
||||||||||||||||||
検索条件 | string | 入力&出力 |
検索条件を指定します。 指定する「レコード検索書式」については、Platioのヘルプを参照してください。 Platioビルダーでカラムを指定して検索条件を作成することができます。 ※指定できるカラムは「検索可能」である必要があります。 |
||||||||||||||||||
検索条件内タイムゾーン | choice | 入力&出力 | 検索条件 プロパティで指定された$from、$to、$fromTimestamp、$toTimestampのタイムゾーンを指定します。 選択項目に無い場合タイムゾーンを入力することも可能です。
|
||||||||||||||||||
添付データ保存先 | string | 入力&出力 |
添付データを保存するフォルダーを指定します。 相対パスの場合は、添付データ保存先パスの起点 の指定に基づいて解釈されます。 |
||||||||||||||||||
添付データ保存先パスの起点 | pathResolver | 入力&出力 | 添付データ保存先 が相対パス指定の場合に、ベースフォルダーを指定します。
|
||||||||||||||||||
上書き処理 | choice | - |
添付データを保存するときの処理を選択します。
|
||||||||||||||||||
区切り文字 | choice | 入力&出力 | 取得したカラムの型がArray型だった場合に使用する、値を区切る文字列を指定します。 | ||||||||||||||||||
ループを開始 | loopProcess | - |
取得したレコードをまとめて出力するか、1レコードずつループして出力するかを選択します。
|
||||||||||||||||||
パラメーター | category | 入力&出力 |
Platioアプリケーションへの接続時などに使用されるパラメーターを指定します。本プロパティは将来の拡張用のために存在し、基本的に使用することはありません。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。 |
コミット | 何もしません。 |
---|---|
ロールバック | 何もしません。 |
タイプ | パラメーター | エラー処理フロー へのストリーム | エラー コード | 説明 |
---|---|---|---|---|
APIエラー | 「APIエラーのパラメーター
」
を参照してください。 | コンポーネントの入力ストリーム | 1 |
Platio APIがエラーを返した場合
|
接続エラー | なし | コンポーネントの入力ストリーム | 2 | Platioとの通信中にエラーが発生した場合 |
3 | Platioとの通信中、もしくは通信前処理でエラーが発生した場合 | |||
レコードが無い | なし | コンポーネントの入力ストリーム | 4 | 取得するレコードが無い場合 |
汎用 | なし | コンポーネントの入力ストリーム | 5 | コネクション名 に指定したコネクションが見つからない場合 |
8 | ディレクトリの作成に失敗した場合 | |||
9 | Platioに関連するその他のエラーが発生した場合 |
No. | 名前 | 説明 |
---|---|---|
1 | ErrorCode | Platio APIのエラーコードが返されます。 |
2 | StatusCode | HTTPのステータスコードが返されます。 |
3 | ErrorResponse | エラーレスポンスのJSONが返されます。 |
Platioから取得した値、設定する値と、フィールド定義のデータ型の対応を以下に示します。
Platio型 | データ型 |
---|---|
String型 | String ※複数行テキストのカラムに設定する場合の改行コードはLFを指定してください。 |
Number型 | Decimal |
Boolean型 | Boolean |
DateTime型 | DateTime |
Date型 | String |
Time型 | String |
Location型 |
|
Attachment型 |
|
User型 |
|
Object型 | Object型に含まれるValueのタイプに合わせて設定されます。 |
Array型 | String 複数の値を区切り文字で繋げた値になります。 ※Array型のvalueがObject型のような複雑なカラムを作成・更新する場合は入力ストリームにTextストリームのJSON文字列を使用する必要があります。 |
ReferenceString型 | String 参照先のレコードのカラムの値になります。 作成・更新する場合はカラム値を設定します。その値から検索して得られた1つ目のレコードのIDを参照先とします。
|
ReferenceNumber型 | Decimal 参照先のレコードのカラムの値になります。 作成・更新する場合はカラム値を設定します。その値から検索して得られた1つ目のレコードのIDを参照先とします。
|
ReferenceUser型 | String 参照先のレコードのカラムの値(名前、ID)になります。 作成・更新する場合は名前を設定します。その値から検索して得られた1つ目のレコードのIDを参照先とします。
|
Platio APIを使用するためにはAPIトークンを生成する必要があり、PlatioGetコンポーネントは生成したAPIトークンを指定する必要があります。
APIトークンには「トークンID」と「秘密トークン」がありPlatioの「開発者向け情報」ページで生成することができます。
「トークンID」はAPIトークンを生成後、Platioの「開発者向け情報」ページよりいつでも確認することができますが、「秘密トークン」はAPIトークン生成時のみ表示され、その後、値を確認することはできません。
「秘密トークン」はAPIトークン生成時に「クリップボードにコピー」アイコンをクリックしてコピーし保存してください。
PlatioGetコンポーネントのPlatio APIリスエスト回数は以下のようになります。
API | 説明 | |
---|---|---|
レコードリスト・レコード・ユーザーリスト・アプリケーション定義の取得 |
「アプリケーション定義の取得」は実行時に必ず1回実行します。 「レコードリスト」は、取得するレコード件数、100レコード(*1)ごとにリクエスト回数が増加します。 検索条件にユーザー名などを指定した場合に「ユーザーリスト」を1回実行します。 レコードのIDを指定して1レコードを取得する場合は「レコード」を1回実行します。 (*1)Platioアプリケーションのデフォルトの最大値です。 |
|
添付ファイルの取得 | レコード数×1レコード内の添付ファイル数の回数リクエストします。 |
Platioビルダーは、コネクション名 で接続できるPlatioアプリケーションからコレクション一覧を取得し、そのコレクションのカラムを出力ストリームのフィールドとして設定する専用ツールです。
以下のいずれかの操作でPlatioビルダーを起動します。
コネクションを使用 で「はい」を設定し、コネクション名 が設定されていない場合、Platioビルダー起動時にコネクションダイアログが表示されます。
新規にコネクションを作成する場合は「新規コネクション」を選択してください。
既存のコネクションを使用する場合は「名前」のプルダウンリストより使用するコネクション名を選択してください。選択したコネクションを使用してPlatioアプリケーションへ接続します。
「新規コネクション」を選択した場合「コネクションの作成」ダイアログが表示されますので、作成するコネクション名を入力し「OK」ボタンをクリックしてください。
コネクションのプロパティ入力するダイアログが表示されますので、コネクションの各プロパティを設定し「保存」ボタンをクリックしてください。
(2)のコレクション一覧からコレクションを選択すると(3)に選択したコレクションから取得できるフィールド一覧が表示されます。 フィールド一覧でフィールド名の左にあるチェックボックスをオンにします。指定したフィールドを取り消すには、チェックボックスをオフにします。
(3)のフィールド一覧でフィールドをクリックし、右クリックして表示されるメニューから「検索条件へ追加」を選択します。
(4)に指定したフィールドを選択した検索条件の行が追加されます。追加された行で演算子を選択し、値を入力します。
検索条件に指定できる名前は、「検索可能」なカラム名の他に「$from」「$to」「$fromTimestamp」「$toTimestamp」があります。この検索条件はレコードの更新時刻やレコードのタイムスタンプで検索する場合に使用します。
「$from」「$to」「$fromTimestamp」「$toTimestamp」で使用できる演算子は「:」のみとなります。
例:2017年1月13日の0時よりも新しい(この時刻を含む)レコード
$from:2017-01-13例:2016年10月3日の15時よりも古い(この時刻を含まない)レコード
$to:2016-10-03T15:00:00PlatioタイプがUser.id、User.nameのフィールドを右クリックして追加された検索条件の名前は、そのフィールドに対応するPlatioのUser型の名前となります。
(4)の条件一覧で編集する条件を直接編集します。
(4)の条件一覧で削除する条件をクリックし、右クリックして表示されるメニューから「検索条件削除」を選択します。 (4)から指定した条件が削除されます。
(5)のスキップ件数にスキップする件数を入力します。
(5)の取得件数に取得するレコードの件数を入力します。
レコードを昇順または降順にソートして読み込むには、ソートキーとソート順を指定します。
(5)のソートキープルダウンリストからソートキーを選択します。
ソートキーを指定後、(5)の「昇順」「降順」プルダウンリストからソート順を選択します。
ソートキーで「カラム指定」を選択した場合は、ソートに使用するカラムを2通りの方法で選択可能です。
(4)の検索条件で日時を扱う場合にタイムゾーンを選択します。
Array型のセパレーターをプルダウンリストから選択します。
他の文字列をセパレーターとして使用したい場合は、文字列を入力します。