コンテンツ検索(メタデータクエリ)処理

オペレーション名

コンテンツ検索(メタデータクエリ)

機能概要

メタデータクエリを用いて条件に一致するBoxのコンテンツ(ファイルまたはフォルダ)の一覧を取得します。
本コンポーネントが使用するAPI仕様については、以下のBox APIリファレンスを参照してください。

データモデル

本コンポーネントのデータモデルはテーブルモデル型です。

プロパティ

変数の使用については、「変数」を参照してください。
基本設定
項目名 必須/省略可 変数の使用 説明 備考
名前 必須 使用不可 スクリプトキャンバス上での名前を入力します。  
入力データ 省略可 使用不可 スクリプトキャンバス上にあるコンポーネントを選択します。  
必須設定
項目名 必須/省略可 変数の使用 説明 備考
接続先 必須 使用不可 グローバルリソースを選択します。
グローバルリソースの設定方法については、「グローバルリソースのプロパティ」を参照してください。
  • [追加]:
    新規にグローバルリソースを追加します。
  • [一覧の編集]:
    「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
 
所有者 必須 使用可 フォルダ所有者のログインに使用するメールアドレスを入力します。  
Boxコンテンツの指定方法 必須 使用不可 Boxコンテンツの指定方法を選択します。
  • [パス]:(デフォルト)
    Boxコンテンツをパスで指定します。
  • [ID]:
    BoxコンテンツをIDで指定します。
 
フォルダパス 必須 使用可 Boxのフォルダパスを入力します。
  • [Boxコンテンツの指定方法][パス]の場合のみ表示されます。
  • パスの形式については、「制限事項」を参照してください。
フォルダID 必須 使用可 BoxのフォルダIDを入力します。
  • [Boxコンテンツの指定方法][ID]の場合のみ表示されます。
メタデータテンプレート名 必須 使用可 検索に利用するメタデータテンプレート名を選択または入力します。  
プロパティアクション
項目名 説明 備考
メタデータテンプレート名一覧の更新 指定した接続先にあるメタデータテンプレートを取得して、[メタデータテンプレート名]に設定します。
  • [接続先]を変更した場合、本プロパティアクションを使用することでその変更を反映させることができます。
  • [接続先]が選択されている場合、有効になります。
クエリ設定
項目名 必須/省略可 変数の使用 説明 備考
メタデータフィールド一覧 省略可 - [メタデータテンプレート名]で指定したメタデータテンプレートのメタデータフィールドを表示します。  
メタデータフィールド一覧/表示名 省略可 使用不可 メタデータフィールドの表示名を表示します。  
メタデータフィールド一覧/キー 省略可 使用不可 メタデータフィールドのキーを表示します。  
メタデータフィールド一覧/タイプ 省略可 使用不可 メタデータフィールドのタイプを表示します。  
クエリ 省略可 使用可 コンテンツの検索で使用するクエリを入力します。
  • クエリ引数」を使用できます。
  • クエリの詳細については、Box ガイドの以下のページにある「queryパラメータ」を参照してください。
    • https://ja.developer.box.com/guides/metadata/queries/syntax/
クエリ引数 省略可 - [クエリ]で指定したクエリ引数が設定されます。
  • [クエリ]にクエリ引数を使用しない場合には表示されません。
  • [クエリ引数]で表示されたクエリ引数名がMapperの出力スキーマに表示されます。
クエリ引数/クエリ引数名 必須 使用不可 クエリ引数の名前が設定されます。
  • [クエリ]にクエリ引数を使用しない場合には表示されません。
クエリ引数/タイプ 必須 使用不可 クエリ引数のタイプを選択します。
  • [クエリ]にクエリ引数を使用しない場合には表示されません。
  • 「<タイプ> (<内部データ型>)」形式で表示されます。
ソート設定 省略可 - [メタデータテンプレート名]で指定したメタデータテンプレートをもとに、検索結果のソート順を設定します。

各列は以下のボタンで操作することができます。
  • [追加]:
    列を追加します。
  • [上へ]:
    選択している列の順序を一つ上に上げます。
  • [下へ]:
    選択している列の順序を一つ下に下げます。
  • [削除]:
    列を削除します。
 
ソート設定/メタデータフィールド名 必須 使用不可 ソートするメタデータフィールドを選択します。
ソート設定/順序 必須 使用不可 ソート順序を選択します。
  • [昇順]:(デフォルト)
    昇順でソートします。
  • [降順]:
    降順でソートします。
 
プロパティアクション
項目名 説明 備考
メタデータフィールド一覧の更新 指定したメタデータテンプレートのメタデータフィールドを取得して、[メタデータフィールド一覧]に表示します。また、[メタデータフィールド名]の一覧を更新します。
  • [メタデータテンプレート名]を変更した場合、本プロパティアクションを使用することでその変更を反映させることができます。
  • [接続先]および[メタデータテンプレート名]が選択されている場合、有効になります。
コメント
項目名 必須/省略可 変数の使用 説明 備考
コメント 省略可 使用不可 このアダプタの簡単な説明を記述することができます。
説明を記述すると、仕様書に反映させることができます。
 

スキーマ

入力スキーマ

[クエリ引数]の設定により、カラム数が異なります。
スキーマ構造については、「テーブルモデル型のスキーマ」を参照してください。

出力スキーマ

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>box_content_id</column>
    <column>box_content_type</column>
  </row>
  <row>
    :
  </row>
</table>
要素名 ラベル 説明 備考
row
-
検索したコンテンツの件数分だけ繰り返します。  
column box_content_id IDを出力します。  
box_content_type 種別を出力します。
  • 「file」:ファイル
  • 「folder」:フォルダ
 

Mapperでのスキーマ読み込み

スキーマは自動で読み込まれます。
詳細については、「スキーマ編集」を参照してください。

大容量データ処理

大容量データ処理に対応していません。

トランザクション

トランザクションはサポートしていません。

PSPでの使用について

PSPでは使用できません。

使用できるコンポーネント変数

コンポーネント変数名 説明 備考
count 取得したコンテンツの件数が格納されます。
  • デフォルト値は0です。
file_count 取得したファイルの件数が格納されます。
  • デフォルト値は0です。
folder_count 取得したフォルダの件数が格納されます。
  • デフォルト値は0です。
message_category エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。
  • デフォルト値はnullです。
message_code エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。
  • デフォルト値はnullです。
message_level エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。
  • デフォルト値はnullです。
error_type エラー発生時、発生したエラーの種類が格納されます。
  • デフォルト値はnullです。
  • エラーの種類は、以下のような形式となります。
    例:「java.io.FileNotFoundException」
  • DataSpider Servistaのバージョンにより、格納される内容が変わる可能性があります。
error_message エラー発生時、発生したエラーのメッセージが格納されます。
  • デフォルト値はnullです。
  • DataSpider Servistaのバージョンにより、格納される内容が変わる可能性があります。
error_trace エラー発生時、発生したエラーのトレース情報が格納されます。
  • デフォルト値はnullです。
  • DataSpider Servistaのバージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

クエリ引数

コンテンツ検索(メタデータクエリ)処理では、クエリ引数を使用することができます。

クエリ引数の使用方法

クエリ引数は、以下の条件をすべて満たす文字列を設定できます。 クエリ引数はMapperで値を設定します。

たとえば、[クエリ]に「amount >= :amount AND country = :country」と記述した場合、2つのクエリ引数(amount、country)が動的に変更できます。 このコンテンツ検索(メタデータクエリ)処理をMapperの出力先に設定すると、Mapperの出力スキーマにamount、countryが表示されます。Mapperでamount、countryそれぞれにマッピングすることで値を設定します。

仕様制限

主な例外

例外名 原因 対策
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[]
[接続先]が指定されていません。 [接続先]を指定してください。
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]
[接続先]で選択されたリソース定義が見つかりません。 [接続先]で指定したグローバルリソースを確認してください。
InvalidPropertyConfigurationException
必須項目 <プロパティ名> が入力されていません。
[<プロパティ名>]が入力されていません。 [<プロパティ名>]を入力してください。
InvalidPropertyConfigurationException
項目 所有者 にBoxに存在しない値が入力されました。
指定した[所有者]に該当するユーザが存在しません。 Boxに存在する[所有者]を指定してください。
InvalidPropertyConfigurationException
項目 フォルダパス には有効なフォルダのパスを入力してください。
[フォルダパス]が有効ではありません。 以下のことを確認してください。
  • [フォルダパス]で指定しているコンテンツが存在するか
  • [フォルダパス]で指定しているコンテンツがフォルダであるか
InvalidPropertyConfigurationException
項目 フォルダID には有効なフォルダのIDを入力してください。
[フォルダID]が有効ではありません。 以下のことを確認してください。
  • [フォルダID]で指定しているコンテンツが存在するか
  • [フォルダID]で指定しているコンテンツがフォルダであるか
InvalidPropertyConfigurationException
項目 メタデータテンプレート名 には有効なメタデータテンプレート名を入力してください。
[メタデータテンプレート名]が有効ではありません。 Boxに存在する[メタデータテンプレート名]を指定してください。
InvalidPropertyConfigurationException
クエリ引数 <クエリ引数名> のタイプが入力されていません。
[クエリ引数][タイプ]が入力されていません。 [クエリ引数][タイプ]を入力してください。
InvalidPropertyConfigurationException
メタデータテンプレートに定義されていないメタデータフィールドがソート設定に使用されています。メタデータフィールド名:<メタデータフィールド名>
[ソート設定][メタデータフィールド名]で選択したメタデータフィールドが[メタデータテンプレート名]で指定したメタデータテンプレートに定義されていません。 [メタデータフィールド一覧の更新]を実行し、再度[メタデータフィールド名]を選択してください。
QueryArgumentNotSpecifiedException
クエリ引数 <クエリ引数名> が入力されていません。
クエリ引数に値が設定されていません。 クエリ引数に値を設定してください。
BoxClientException Boxからエラーが返されました。 メッセージの詳細については、Box開発者向けドキュメントポータル(https://ja.developer.box.com/)を参照してください。