Boxのメタデータ管理の入門ガイド
この記事では、メタデータがデータを明確にする場合やユーザーに役立つようにする場合に重要なツールであること説明します。ドキュメントへのリンクについては、後述の参照資料をご確認ください。
Box管理者は、メタデータテンプレートを作成して、コンテンツに関連付けるメタデータの構造を定義した後、それをコンテンツに関連付けて、メタデータインスタンスを作成できます。
適切なメタデータを使用すると、データを実用的な情報に変換できます。また、メタデータ検索により、メタデータ属性による検索が強化され、ユーザーのニーズに特化した検索が可能になります。
メタデータは、データを明確にする場合やユーザーに役立つようにする場合に重要なツールです。データの情報源、目的、意味に関する情報を示すことで、データのコンテキストを提供します。
適切なメタデータを使用すると、コンテンツを実用的な情報に変換できます。
メタデータには、データに意味を持たせるものにするために役立つ説明、タグ、ラベルなどの属性を含めることができます。また、他のシステムと統合する際に使用できる識別子、分類などの情報も含めることができます。
仕組み
管理者の場合、最初のタスクとして、コンテンツに関連付けるメタデータの構造を定義し、メタデータテンプレートを作成します。
その後、このテンプレートをコンテンツに関連付けて、メタデータインスタンスを作成できます。
最後に、ユーザーまたはサービスが特定のコンテンツのメタデータ属性を設定できます。この処理は、プログラムで行うこともできます。
メタデータテンプレート
テンプレートは、取得するメタデータの構造を表します。テンプレートは多数所有することができ、データには複数のテンプレートを適用できます。
各テンプレートには、テキスト、日付、数値、単一選択、複数選択を表す属性を含めることができます。
テンプレートを作成するには、管理コンソールの [コンテンツ]、[メタデータ] の順に移動します。
検索に使用する場合、テキストについては部分一致が可能になるのに対し、日付と数値については間隔の検索が可能になります。
単一選択ドロップダウンでは、リストから1つのオプションを選択できますが、何も選択しないことも可能です。オプションは独自に並べ替えることができます。
複数選択ドロップダウンも仕組みは同じですが、複数の選択が可能です。
属性を独自に並べ替えることができるほか、テンプレートを非表示にすることもできます。これは、テンプレートをサービスまたは統合専用にして、テンプレートとメタデータがユーザーに表示されないようにする場合に便利です。
テンプレートの作成は、Box CLI、REST API、またはBox SDKのいずれかを使用してプログラムで行うことができます。
CLIを使用した例は次のとおりです。
❯ box metadata-templates:create --display-name "Customer data" \
--string "Customer Name" \
--enum "Document Type" --option Contract --option Invoice上記のコマンドでは、テキスト属性「Customer Name」と、オプションとして「Contract」と「Invoice」が設定された単一選択ドロップダウン「Document Type」を含む「Customer Data」という名前のメタデータテンプレートを作成しています。
ユーザーがメタデータを入力できるようにする場合は、ユーザーが自由形式のテキストを使ってどれだけ自由に入力できるか、ユーザーがいくつの属性を設定しなければならないかを考慮してください。
メタデータに一貫性がない場合やメタデータが空の場合は、メタデータに依存する一括処理やBoxの強化されたメタデータ検索の効率が低下することになります。
メタデータインスタンス
メタデータインスタンスは、メタデータテンプレートとコンテンツの項目 (Box内のファイルやフォルダなど) との関連付けを表します。異なるテンプレートに含まれるインスタンスであれば、1つの項目に複数のインスタンスを設定できます。
上の画像は、ユーザーがBoxにメタデータインスタンスを作成する方法を示していますが、これは一括またはプログラムで行うこともできます。
例えば、Box CLIを使用して、テンプレート「Customer Data」をフォルダ (id=195811920048) に関連付けます。
❯ box folders:metadata:add 195811920048 \
--template-key customerData \
--data "customerName=Acme Corp" \
--data documentType=Contract \
--as-user 18622116055 \
--csv
### output ###
customerName,documentType,$parent,...
Acme Corp,Contract,folder_195811920048,...上記のコマンドでは、メタデータテンプレートをフォルダに関連付けるだけでなく、同時にメタデータ属性customerNameとdocumentTypeを設定します。
結果は次のとおりです。
これまでと同様、この処理はさらに自動化できます。
例えば、こちらの記事では、外部サービスを使用して、50を超える属性を含むメディアファイルのメタデータを自動的に入力する方法を紹介しました。
今後は、Boxメタデータのカスケードポリシーを使用してメタデータを入力する方法を説明した記事を予定しています。ぜひご確認ください。
メタデータ検索
コンテンツにメタデータが設定されると、Boxを利用している直接的なメリットとして、メタデータによる検索が強化されます。
通常の検索は「あいまい」検索で、名前、説明、タグ、コンテンツ内の文字列が検索されます。多くの場合、返される結果が多すぎるため、ユーザーは検索結果で必要な情報を探すのに手間がかかります。
一方、メタデータ検索 (別名、メタデータフィルタ) はメタデータ属性に限定されています。
請求書と契約書のドキュメントを含む顧客用フォルダがある次のシナリオを考えてみましょう。
これらのドキュメントには、通常、そのドキュメントを発行した会社にとって意味があるものの、ユーザーにとっては意味のない暗号のような名前が設定されています。また、その内容はありふれたもののため、検索時にそれらを区別することは困難です。
ここで、顧客別にすべてのコンテンツが必要なユーザーやすべての請求書が必要なユーザー、さらにすべての契約書が必要なグループがいることを想像してください。
これを説明するために、顧客名とドキュメントの種類を設定したシンプルなテンプレートを作成したので、検索の動作を見てみましょう。
ドキュメントのメタデータのサンプルは次のとおりです。
カスタマーサクセスは、「Acme Corp」と関連したすべての請求書と契約書を必要としています。
会計担当者は、会社に関係なくすべての請求書を必要としています。
Box管理者がメタデータを使用して統合をさらに進めることもよくあります。メタデータに参照や一意の識別子を設定して、簡単に他のアプリやデータベースと統合することも考えられます。
参照資料
メタデータの詳細については、以下を参照してください。
このシリーズの以下の記事もご覧ください。
