別紙 1-2 「情報連携用基本語彙データベース ユーザー支援ツールの構築」 技術仕様書 1 内容 1. 2. 3. 4. 5. 6. 7. 概要 ...................................................................................................................................................... 4 1.1. 共通語彙基盤のユーザーシナリオ例 ............................................................................................ 4 1.2. ツールの利用者 ............................................................................................................................. 5 1.3. 構築するツール及びライブラリ ................................................................................................... 6 1.4. 全体要件 ........................................................................................................................................ 7 1.5. 本仕様書での表記について .......................................................................................................... 8 語彙作成支援ツール ............................................................................................................................. 8 2.1. 概要 ............................................................................................................................................... 8 2.2. 対象者 ........................................................................................................................................... 9 2.3. 機能概要 ........................................................................................................................................ 9 2.4. 機能要件 ...................................................................................................................................... 10 コード・コードリスト作成支援ツール ............................................................................................. 11 3.1. 概要 ............................................................................................................................................. 11 3.2. 対象者 ......................................................................................................................................... 11 3.3. 機能概要 ...................................................................................................................................... 12 3.4. 機能要件 ...................................................................................................................................... 12 DMD 作成支援ツール ........................................................................................................................ 13 4.1. 概要 ............................................................................................................................................. 13 4.2. 対象者 ......................................................................................................................................... 14 4.3. 機能概要 ...................................................................................................................................... 14 4.4. 機能要件 ...................................................................................................................................... 15 4.5. 概念的な動作イメージの例 ........................................................................................................ 17 データ形式変換ツール ....................................................................................................................... 21 5.1. 概要 ............................................................................................................................................. 21 5.2. 対象者 ......................................................................................................................................... 21 5.3. 機能概要 ...................................................................................................................................... 21 5.4. 機能要件 ...................................................................................................................................... 22 DMD 検証ツール ............................................................................................................................... 23 6.1. 概要 ............................................................................................................................................. 23 6.2. 対象者 ......................................................................................................................................... 23 6.3. 機能概要 ...................................................................................................................................... 23 6.4. 機能要件 ...................................................................................................................................... 23 データ検証ツール .............................................................................................................................. 23 7.1. 概要 ............................................................................................................................................. 23 7.2. 対象者 ......................................................................................................................................... 24 7.3. 機能概要 ...................................................................................................................................... 24 2 7.4. 8. 9. 機能要件 ...................................................................................................................................... 24 共通語彙基盤利用登録及びロゴ取得ツール ...................................................................................... 24 8.1. 概要 ............................................................................................................................................. 24 8.2. 機能要件 ...................................................................................................................................... 25 共通語彙基盤ライブラリ ................................................................................................................... 25 9.1. 概要 ............................................................................................................................................. 25 9.2. 機能概要 ...................................................................................................................................... 25 10. マニュアル及びドキュメント類 ........................................................................................................ 27 10.1. 概要 ......................................................................................................................................... 27 10.2. 要件 ......................................................................................................................................... 27 3 1. 概要 本事業では、共通語彙基盤を活用し、相互運用性が高く二次利用が容易なデータを作成するために必 要な各作業を支援するツール及びライブラリを構築する。 共通語彙基盤の利活用に際しては、図 1 のように、情報連携用基本語彙データベース（以下、語彙 データベース）を中心とし、語彙の作成、データ構造（DMD）の作成、データの作成、データを利用 するアプリケーションソフトウェアの開発などの作業が行われることが想定される。 本仕様書では、各作業を行う者をそれぞれ、語彙作成者、DMD 作成者、データ作成者、データ利用 者と呼ぶ。 図 1 共通語彙基盤の利用とツール 1.1. 共通語彙基盤のユーザーシナリオ例 共通語彙基盤及び本事業で開発するツール群の利用に関しては次のようなユーザーシナリオが考え られる。ただし、本事業で開発する個々のツールの適用範囲はこれらのシナリオに限られたものではな く、CSS への組み込みや民間システムでの利用など、様々なシナリオが考えられる。ツール等の実装 に当っては、以下に従い、具体的利用者像、利用シーンを設定し、それに沿ったものとすることが求め 4 られる★。 (1) 自治体又は自治体システム設計者によるオープンデータ構築、情報共有の効率化等における利用 (2) 自治体向けシステム等の開発での利用 1.2. ツールの利用者 本事業で開発するツールは、ツールを利用して行う作業ごとに要求される知識の種類やレベルが異 なる。そこで、作業ごとに語彙作成者、DMD 作成者、データ作成者、データ利用者として、次のよう なプロファイルを想定する。 実際の運用においては、1.1 に示すように、DMD の作成とデータの作成など、一人のユーザーが複 数の作業を行うことも多いが、このような場合は、一人のユーザーが複数のプロファイルを併せもって いることを前提とする。 語彙作成者 特定の業務に詳しく、かつ、語彙やデータ構造等に関する十分な知識をもつ。ただし、多 くの場合、前述のような単独の人物は多くは存在せず、多くの場合チームとしてこのよう なスキルを有することになる。 省庁や業界を主導する団体などによって設置されたドメイン語彙作成チームなどを想定 する。 DMD 作成者 特定の業務に詳しく、語彙やデータ構造に関してもある程度の知識を有する。 省庁、自治体及び業界団体の職員、または、それらのもとシステム開発を行う技術者など を想定する。 データ作成者 Excel などによりデータを作成・編集できる、または CMS などを用いて Web ページの 作成・編集ができる程度の技術力を有する。 省庁、自治体及び業界団体の職員、または、それらのもとデータ入力を行う者などを想定 する。 データ利用者（アプリ開発者） 共通語彙基盤の提供するツール等を用いて作成された RDF あるいは XML 形式等の構造 化データを活用する者。当該データを活用して付加価値を創造するビジネスや、当該デー タを他の形式（Web ページなど）へ変換する業務、変換のためのツール開発等を行う者を 想定。 5 語彙やデータ構造にある程度の知識を有するソフトウェア開発者や Web 開発者を想定す る。 1.3. 構築するツール及びライブラリ 本事業では、上記のそれぞれの想定利用者を対象とした次の７種類のツール及び共通に用いられる ライブラリを構築する。 ユーザー支援ツール (1) 語彙作成支援ツール 組織、ドメイン等で使用している言葉を整理し、階層をもつ語彙を作成する作業を支援するツール (2) コード・コードリスト作成支援ツール コード表や分類表の内容を整理し、上位・下位関係をもつ複数のコードリストの作成作業を支援す るツール (3) DMD 作成支援ツール データ構造の設計を支援するツール (4) データ形式変換ツール 表形式のデータを共通語彙基盤等の語彙を用いて構造化されたデータに変換するツール (5) DMD 検証ツール DMD に問題がないかを検証するツール (6) データ検証ツール 共通語彙基盤等の語彙を用いて作成されたデータを検証するツール (7) 共通語彙基盤利用登録及びロゴ取得ツール 共通語彙基盤の利用を登録し、共通語彙基盤ロゴを取得するためのツール 共通語彙基盤ライブラリ 上記のツールが共通で用いる機能やデータを利用するアプリケーションの開発を容易にする機能 を提供するライブラリ これらのツールを用いた、語彙、データ構造、並びに、データの作成、及びデータの利用の流れは、 図 2 に示すようなモデルが想定される。ユーザー支援ツールは▬、共通語彙基盤ライブラリは で示 す。 6 図 2 共通語彙基盤の利用フロー 1.4. (1) 全体要件 個別に指定がない場合、プログラミング言語は下記のいずれかとし、利用する実装は提案時点で サポートされているバージョンとする。基本的には、クライアント側、サーバー側はそれぞれ１ つの言語に統一されているのが好ましい。 (2) ECMAScript(ISO/IEC 16262:2011)(TypeScript 及び Dart を含む) Ruby(ISO/IEC 30170:2012) C#(ISO/IEC 23270:2006) Web アプリケーションとして作成されるツールについては、 全てのツールで共通のデザインとし、 左上に IPA が指定するロゴを配置する。また、全体の配色については、ロゴに合わせたものとす る。 (3) (1)語彙作成支援ツール、(2)コード・コードリスト作成支援ツール、(3)DMD 作成支援ツール、(4) データ形式変換ツール、(5)DMD 検証ツール、(6)データ検証ツールの６種類のツールについては、 単独のツールとしての使用だけでなく、これらのツールを組み合わせて業務プロセスに即した一 連の作業を行う１ツールとして構成できるようにする。ツールを組み合わせての構成する機能に ついては、実際にツールを組み合わせて１ツールとして構成し、協力自治体の協力のもと実際の 使用を通して検証すること。 7 (4) すべてのツールは、IPA の共通基盤上で動作する Web アプリケーション として構築する。それ ぞれ任意の URL 配下に配置できるように実装すること。ツールのユーザーインターフェースの 表記で用いる言語は日本語とするが、将来、表示言語を容易に他の言語（英語等）へ変更・拡張 できるよう、表示に係るデータ等はモジュール化した実装とすること。 (5) ツール類が DMD、IMI の語彙・用語など語彙データベースが扱う主要なリソース及び、構築され た構造化データ（RDF 等）へアクセスする手段は、個々のツールに作りこむことはせず、ライブ ラリ（9.「共通語彙基盤ライブラリ」の項を参照）として構築すること。 1.5. 本仕様書での表記について (1) コア語彙の用語を個別に表記する際には、「ic:住所型」のように、先頭に「ic:」をつけて表記する。 2. 語彙作成支援ツール 2.1. 概要 業務において使用している言葉や、用語集などから抽出した言葉の一覧に対して、それぞれの言葉の 関連性（同義、類似、上下関係、特性・属性の関係など）などを整理することや、言葉のグループ化な どを通し、オントロジーを見出し、語彙を設計・作成する支援をするツール。 本ツールを使用した語彙作成の全体的な流れは図 3 のようになる。本ツールは語彙設計の際に、語 彙に詳しい技術者と特定のドメインに詳しい非技術者の間における情報共有のためのツールという意 味合いをもち、語彙を設計する技術者を支援する以外に、非技術者のためのレビュー用のツールとして も機能する。 本ツールは、対話的なユーザーインターフェースをもち、対象ユーザーによる対話的なユーザーイン ターフェース上での操作により、本ツールが提供する機能を利用できるツールである。 8 図 3 語彙作成支援ツールの概要 2.2. 対象者 このツールは、語彙作成者を主な対象とする。 2.3. 機能概要 入力： (1) 対象とするドメインにおいて使用されている既存用語の一覧 (2) 語彙データベースに格納されている既存の IMI 用語（本仕様書では、語彙データベースに格納 された、IMI 語彙に含まれる用語を「IMI 用語」と呼ぶ） (3) 編集中間ファイル 出力： (1) 用語間の関係及びグループを表すグラフ（印刷可能形式） (2) 編集中間ファイル (3) 表形式語彙フォーム（別紙 1-4） 機能： (1) 入力された既存用語間の関係の設定・編集機能 (2) 入力された既存用語のグループ化機能 (3) 入力された既存用語と既存の IMI 用語との間の関係の設定・編集機能 (4) 用語間の関係とグループをもとにした語彙設計機能 9 (5) 用語間の関係及びグループを表すグラフ（印刷可能形式）、及び、設計された語彙のデータを含 む表形式語彙フォームの出力 2.4. 機能要件 (1) IPA 共通基盤システム（★）上で動作する Web アプリケーションとし構築する。 (2) 対話型ユーザーインターフェースは対象ユーザーが容易に使用できるものとする。★ (3) 既存用語の入力については、CSV 形式、又は、表形式（表計算ソフトウェアなどの出力形式。少 なくとも、Microsoft Excel からの出力形式に対応する。 ）のファイルから読み込む機能を提供す る。他に、ドキュメントファイルからの抽出など効率的な入力方法を提供する。 (4) 既存用語の入力については、(2) のファイルからの読み込みを行ったかどうかに関わらず、ツール 内で利用者が入力及び編集できるようにする。 (5) 用語間の関連性の編集、用語のグループ化などの作業は、複数の表示形式（ 「ビュー」と呼ぶ）で 表示・編集できるようにする。ビューと内部データは明確に分離し、将来必要に応じてビューを 追加できるような設計とする。また、一つのビューで変更した結果は、その変更が他のビューに 随時反映されるような設計とする。ただし、ビューをソースコードの変更せずに追加する機能や 動的に追加する機能を実装する必要はない。 (6) 本事業で実装するビューは、有向グラフやクラス図などのグラフ形式と表形式の二つとする。 (7) 用語と用語の関係については、少なくとも同義語、類義語、上下関係、意味的抱合関係、物・事 と属性・特性の関係について設定できるようにする。 (8) 用語のグループ化については、利用者が任意のグループを追加できるようにし、各グループには 任意の名前を付けることができるようにする。 (9) 用語間の関係の設定に際して、語彙データベースが提供するオントロジーデータベースの活用に より部分的な自動化をするなど効率良く作業を行うことができるツールとする。 (10) 入力された既存用語、用語間の関係、グループ化の状態を編集中間ファイルとして適当なファイ ル形式にて取得できるようにし、後日、編集中間ファイルを読み込むことで編集作業を継続でき るようにする。 (11) このツールの利用者は、語彙やデータ構造について十分な知識を有することを前提とするが、可 能な限り少ない知識で目的を達成することができるような、ユーザーインターフェースを提供す る。 10 (12) 語彙設計機能は、次のことを行う。 A) 用語間の関係やグループ化の結果から可能な限り自動的な語彙の生成（ドラフト） B) 任意のクラス用語の追加及びクラス用語へのプロパティの追加 C) 任意のプロパティ用語の追加 D) 各用語の説明の編集 E) 語彙のメタデータの編集 F) クラス用語の各プロパティに対する回数の設定 G) 既存語彙との類似・重複の指摘 H) 共通語彙基盤のルールに従っていることの確認及びエラーの指摘 (13) 語彙設計機能により設計された語彙は表形式語彙フォームとして出力できるようにする。 (14) このツールは、技術者と非技術者の間の情報共有ツールとして機能する必要がある。したがって、 このツールによる用語間の関係の設定や語彙の設計の作業者は語彙に詳しい技術者を想定するが、 関係の設定、グループ化及び語彙の設計などの状態は、いつでも非技術者が理解しやすいよう工 夫された表示を行えるようにする。 (15) 常に、利用者が直前に行った作業の取り消しが行えるようにする。それが不可能な作業について は、事前にそのことを警告する。 3. コード・コードリスト作成支援ツール 3.1. 概要 業務において使用しているコードから IMI 形式のコード及びコードリストの作成を支援する。また、 分類表などから、項目のグループ化（分類）などを通し、上位・下位関係をもつ複数のコード及びコー ドリストの作成する支援をするツール。 本ツールはコード及びコードリスト設計の際に、語彙に詳しい技術者と特定のドメインに詳しい非 技術者の間における情報共有のためのツールという意味合いをもち、コード及びコードリストを設計 する技術者を支援する以外に、非技術者のためのレビュー用のツールとしても機能する。 本ツールは、対話的なユーザーインターフェースをもち、対象ユーザーによる対話的なユーザーイン ターフェース上での操作により、本ツールが提供する機能を利用できるツールである。 3.2. 対象者 このツールは、語彙作成者及び DMD 作成者を主な対象とする。 11 3.3. 機能概要 入力： (1) 既存のコード表または分類表（項目一覧） (2) 編集中間ファイル 出力： (1) コードやコード間の関係を表すグラフ（印刷可能形式） (2) 編集中間ファイル (3) 表形式コード・ID フォーム（別紙 1-5） 機能： (1) コード表の入力に対して、表形式コード・ID フォームを出力する機能 (2) 分類表の入力に対して、入力された項目をグループ化（分類）する作業を通し、分類条件の整理 及び明確化をする機能。 (3) また、グループの上位・下位関係を定義する機能 (4) コードリスト及びコードリストの関係を表すグラフ（印刷可能形式） 、及び、設計された語彙の データを含む表形式コード・ID フォームの出力 3.4. 機能要件 (1) IPA 共通基盤システム（★）上で動作する Web アプリケーションとし構築する。 (2) 対話型ユーザーインターフェースは対象ユーザーが容易に使用できるものとする。★ (3) コード表及び分類表の入力については、CSV 形式、又は、表形式（表計算ソフトウェアなどの出 力形式。少なくとも、Microsoft Excel からの出力形式に対応する。）のファイルから読み込む機 能を提供する。 (4) コード表及び分類表の入力については、(2) のファイルからの読み込みを行ったかどうかに関わ らず、ツール内で利用者が追加入力及び編集できるようにする。 (5) 入力がコード表の場合は、入力されたコード表を表形式コード・ID フォームに出力する変換ツー ルのように機能する。 (6) 入力が分類表の場合は、入力された項目をグループ化（分類）し直すことで、分類条件の整理及 び明確化を行う。また、グループの関係を定義し、上位・下位関係をもつ複数のコードリストの 設計を支援する。 (7) 項目のグループ化などの作業は、複数の表示形式（「ビュー」と呼ぶ）で表示・編集できるように 12 する。ビューと内部データは明確に分離し、将来必要に応じてビューを追加できるような設計と する。また、一つのビューで変更した結果は、その変更が他のビューに随時反映されるような設 計とする。ただし、ビューをソースコードの変更せずに追加する機能や動的に追加する機能を実 装する必要はない。 (8) 本事業で実装するビューは、有向グラフやクラス図などのグラフ形式と表形式の二つとする。 (9) 項目のグループ化については、利用者が任意のグループを追加できるようにし、各グループには 任意の名前を付けることができるようにする。 (10) このツールの利用者は、語彙やデータ構造について十分な知識を有することを前提とするが、可 能な限り少ない知識で目的を達成することができるような、ユーザーインターフェースを提供す る。 (11) コード・コードリスト設計機能は、次のことを行う。 A) 項目のグループ化（分類） B) グループ間の上位・関係の定義 (12) コード・コードリスト設計機能により設計された語彙は表形式コード・ID フォームとして出力で きるようにする。 (13) このツールは、技術者と非技術者の間の情報共有ツールとして機能する必要がある。したがって、 このツールによるグループ化（分類）やグループ間の関係の設定などの作業は語彙に詳しい技術 者を想定するが、関係の設定、グループ化及びコード・コードリストの設計などの状態は、いつ でも非技術者が理解しやすいよう工夫された表示を行えるようにする。 (14) 常に、利用者が直前に行った作業の取り消しが行えるようにする。それが不可能な作業について は、事前にそのことを警告する。 4. DMD 作成支援ツール 4.1. 概要 DMD 作成支援ツールは、データの項目一覧を元に DMD の作成や既存の DMD の編集を行うための ツールとする。 本ツールは、対話的なユーザーインターフェースをもち、対象ユーザーによる対話的なユーザーイン ターフェース上での操作により、本ツールが提供する機能を利用できるツールである。 このツールでは、構造化データの専門家でなくとも、表形式のデータに代表される階層をもたないデ ータをもとにして、 IMI 語彙を利用した相互運用性の高いデータ構造を構築するためのツールである。 13 また、実際にデータ構造を作成しながら、語彙やデータ構造について学ぶためのチュートリアルとして も機能するものである。 図 4 DMD 作成支援ツール概要 4.2. 対象者 このツールは、DMD 作成者を主な対象とする。 4.3. 機能概要 入力： (1) 既存の DMD（語彙データベースに保存されているもの、又は、ローカルファイルとして保存さ れているもの） (2) データ項目一覧 出力： (1) DMD 機能： (1) DMD の検索機能 (2) データ項目一覧の編集（項目の追加、削除及び変更） (3) データ構造の設計（データ項目一覧と IMI 語彙による構造のマッピング） 14 (4) 各データ項目に対する、値制限の設定、回数の設定 (5) チュートリアル機能 4.4. 機能要件 (1) IPA 共通基盤システム（★）上で動作する Web アプリケーションとし構築する。 (2) 対話型ユーザーインターフェースは対象ユーザーが容易に使用できるものとする。★ (3) 語彙データベースに保存されている、又は、ローカルファイルとして保存されている、 既存の DMD を元にした DMD 作成、及び、データ項目一覧を元にした新規 DMD の作成の 2 種類の方法で利 用者が DMD を作成できるようにする。 (4) データ項目一覧の入力については、CSV 形式、又は、表形式（表計算ソフトウェアなどの出力形 式。少なくとも、Microsoft Excel からの出力形式に対応する。）のファイルから読み込む機能を 提供する。 (5) データ項目一覧の入力については、(1) のファイルからの読み込みを行ったかどうかに関わらず、 ツール内で利用者が随時入力及び編集できるようにする。 (6) 最初に既存の DMD の検索を行うようにする、データ項目一覧の入力後に既存の DMD に同様な ものがあれば表示するなど、同様な DMD が語彙データベースに格納されていることを利用者が 気づかず、 既存の DMD と同様な DMD が新規に作られてしまうことを抑制する機能を実装する。 (7) DMD の検索機能を提供する。DMD の検索では、DMD の ID、名称、説明文、作成者、作成者 URI、ライセンス、公開ステータスの一つ又は複数を組み合わせて絞り込み検索ができるように する。検索方法については、名称、説明文、作者については部分一致とし、その他については完 全一致とする。 (8) データの構造を直接設計する代わりに、データ項目に対して用語を割り当てることで結果的にデ ータ構造が生成されるような考え方でもデータ構造の設計ができるようなにするなど、データの 構造化について詳しくない利用者でもデータ構造の設計が可能なユーザーインターフェースとす る。 (9) データ項目と用語をマッピングしデータ構造を設計する作業は、複数の表示形式（「ビュー」と呼 ぶ）で表示・編集できるようにする。ビューと内部データは明確に分離し、将来必要に応じてビ ューを追加できるような設計とする。また、一つのビューで変更した結果は、その変更が他のビ ューに随時反映されるような設計とする。ただし、ビューをソースコードの変更せずに追加する 機能や動的に追加する機能を実装する必要はない。 15 (10) 本事業で実装するビューは、有向グラフやクラス図などのグラフ形式と表形式の二つとする。 (11) ツールは、コア語彙の各クラス用語に対して、代表的ないくつかの構造パターンをもち、データ 構造の設計の際には、一から設計するのではなく、それらの代表的な構造パターンを活用して効 率よくデータ構造設計が行えるようにする。例えば、ic:住所型であれば、ic:表記のみをもつパタ ーン、ic:都道府県、ic:市区町村などに分割するパターン、ic:住所コードを用いる場合など複数の パターンが考えられる。また、パターンの選択によりデータ項目に増減がある場合には、整合が とれるようにデータ項目一覧も更新する。 (12) 作業が必要な項目・箇所に対して、アイコンを表示するなど、必要な作業をユーザーが認識でき るように対策を講じる。 (13) 型が一致しないなどのエラーがある項目に対して、アイコンを表示するなどユーザーがエラーを 認識できるように対策を講じる。また、前述のアイコンにヘルプドキュメントへのリンクを付加 するなど、ユーザーがエラーを修正するために必要な情報を別途検索等することなく得られるよ うに対策を講じる。 (14) データ項目と用語のマッピングに際して、語彙データベースが提供するオントロジーデータベー スを活用するなど効率良く作業を行うための機能を実装する。 (15) このツールの利用者は、語彙やデータ構造についてある程度の知識を有することを前提とするが、 可能な限り少ない知識で目的を達成することができるような、ユーザーインターフェースを提供 する。 (16) 各ビューでは、各データ項目について、項目名、マッピングされた用語、回数、値の制限を表示 及び編集できるようにする。一つのビューですべての作業が行えることを基本とする。 (17) 回数については下限値と上限値を指定できるようにし、下限値は 0 以上の整数、上限値には、1 以 上の整数または制限なしをそれぞれ設定できるようにする。 (18) 回数の設定に際しては、数字による指定だけではなく、下限に「必須」「省略可」、上限に「一つ のみ」 「複数化」を選択できるようにするなど、利用者にわかりやすいユーザーインターフェース を提供する。 (19) 値の制限については、少なくとも下記のものに対応する。 値の範囲 値のリスト 正規表現による値のパターン 16 (20) 文字セット このツールは、チュートリアルとしても機能も合わせもつようにし、ツールを使用しながらデー タを構造化する目的や意味、構造化の考え方。具体的な方法などを学習できるようにする。 (21) チュートリアル機能として、ツールの立ち上げ時及び各画面遷移の際にそこで行われる作業の意 味や目的、具体的な操作などについて詳述する。動画を用いることが有効な手段であれば、説明 において動画を用いてもよい。 (22) DMD 仕様書が定める、DMD のメタ情報を利用者が設定できるようにする。 (23) 生成する DMD には、Microsoft Word 形式などのドキュメントのひな型を含める。DMD のメタ 情報や設計されたデータ構造などから自動的に生成できるものについては、可能な限り自動生成 しひな型にあらかじめ含める。 (24) 常に、利用者が直前に行った作業の取り消しが行えるようにする。それが不可能な作業について は、事前にそのことを警告する。 (25) 作成された DMD は、利用者がダウンロード可能とする。また、語彙データベースに登録し共有 することもできるようにする。 4.5. 概念的な動作イメージの例 以下に、概念的な動作イメージの例を示す。この例では、有向グラフを用いているが、UML のクラ ス図のようなグラフ形式より有向グラフの使用を推奨するものではない。また、概念的な動作を表すた めに各ビューや画面遷移の際の説明などは簡略してある。実際のユーザーインターフェースは機能要 件を満たし、様々な機能を容易に呼び出せるものとする。 17 18 19 次の例は、表を編集してマッピングに「住所」を指定した場合。値の型が一致しないためエラーとな る。 20 ツールはチュートリアルとしての機能ももち、初回には、画面遷移の際に行う作業の説明を表示す る。 5. データ形式変換ツール 5.1. 概要 DMD を利用して、表形式のデータを主に IMI 語彙によって表現される構造化されたデータに変 換するためのツールとなる。 5.2. 対象者 このツールは、データ作成者および DMD 作成者を主な対象とする。 5.3. 機能概要 入力： (1) DMD（語彙データベースに保存されているもの、又は、ローカルファイル） (2) 表形式のデータ 出力： (1) 共通語彙基盤で規定された RDF (RDF/XML, Turtle, JSON-LD)形式のデータ (2) 共通語彙基盤で規定された XML 形式のデータ (3) 表形式入力フォーム(別紙 1-4 参照) 機能： 21 (1) 表形式データと DMD 内の項目一覧との対応付け (2) 表形式データの DMD が定める形式の構造化されたデータへの変換 (3) 変換 API の提供 5.4. 機能要件 (1) IPA 共通基盤システム（★）上で動作する Web アプリケーションとし構築する。 (2) 使用する DMD については、ファイルのアップロードの他、利用者が語彙データベースに登録さ れている DMD を検索・選択できるようにする。DMD の検索では、DMD の ID、名称、説明文、 作成者、作成者 URI、ライセンス、公開ステータスの一つ又は複数を組み合わせて絞り込み検索 ができるようにする。検索方法については、名称、説明文、作者については部分一致とし、その 他については完全一致とする。 (3) 入力された表形式のデータを、入力または選択された DMD が定める形式の構造化されたデータ に変換する (4) 入力となる表形式データと DMD 内の項目一覧との対応付け（データ構造との直接の対応付けで はない）を利用者が行うことによって、項目名や項目の順番が異なる場合でも変換できるように する。また、一部のデータ項目のみ対応付けを行うことによって DMD のすべての項目に対応し ない表形式データであっても変換できるようにする。 (5) DMD の項目一覧に対応する表形式のファイルを表形式入力フォーム(別紙 1-4 参照)として利用者 が取得できるようにする。 (6) 変換結果は、DMD が定める形式の XML、RDF のいずれか又は両方を出力できるようにする。ま た、RDF の場合は、Turtle、RDF/XML、JSON-LD のいずれかを選択できるようにする。 (7) 特定の出力形式のために必要となる情報の入力は出力形式選択後に行うようにするなど、不要な 情報の入力は求めない設計とする。 (8) 入力されたデータの値が、DMD が定める値制限に合致したものであるかどうかを検証し、合致 していない場合には適切なエラー表示を行う。 (9) ツールのユーザーインターフェースは非技術者でも容易に扱えるものでなければならない。 (10) 語彙データベースに登録されている DMD を用いて、データを変換するための Web API を提供す る。 (11) Web API は Restful な設計とし、入力として表形式のデータ、使用する DMD の DMD ID と返還 22 後の形式を受け取る。DMD ID により指定された DMD を使用し、渡された表形式のデータを指 定された形式に変換する。 6. DMD 検証ツール 概要 6.1. DMD の検証を行うツール。DMD 内の各種ファイルが DMD 仕様の要件を満たしているかどうか及 び IMI 用語が IMI のルールに従って利用されているかどうかを検証する。 対象者 6.2. このツールは、DMD 作成者を主な対象とする。 機能概要 6.3. 入力： (1) DMD 出力： (1) 検証結果 機能： (1) DMD の構成および含まれる各ファイルの検証 機能要件 6.4. (1) IPA 共通基盤システム（★）上で動作する Web アプリケーションとし構築する。 (2) 入力された DMD について以下の項目を検証する。 A) DMD の構成が DMD 仕様書（別紙 1-3）に定められたものになっているか B) 項目一覧とスキーマの内容は整合がとれたものである C) DMD の各ファイルの書式が DMD 仕様書に定められたものになっているか D) ドキュメントファイルが実行可能形式でないか E) ドキュメントファイルが実行可能コードを含んでいないか (3) DMD の問題を検知した場合は、適切なエラーを出力する。エラーメッセージには、利用者自らが 問題を解決できるよう。十分な内容を含める。 7. データ検証ツール 7.1. 概要 データの検証を行うツール。DMD に記述されたデータ構造や値制限に適合しているかどうかを検証 23 する。 対象者 7.2. このツールは、データ作成者及び DMD 作成者を主な対象とする。 機能概要 7.3. 入力： (1) DMD (2) データファイル 出力： (1) 検証結果 機能： (1) データファイルが DMD に合致しているかどうかの検証 機能要件 7.4. (1) IPA 共通基盤システム（★）上で動作する Web アプリケーションとし構築する。 (2) 入力となるデータファイルとして、XML 形式、RDF（RDF/XML, Turtle, JSON-LD）形式に対 応する。 (3) 入力されたデータファイルが DMD に合致しているどうか、以下の項目について検証する。 A) データの構造や値域（型）が DMD 及び使用されている語彙のスキーマに適合しているか B) データの構造や値域（型）が共通語彙基盤のルールに適合しているか C) (4) データの各項目が DMD の定める値の制限に合致しているか データファイルに問題が発見された場合は、適切なエラーを出力する。エラーメッセージには、 利用者自らが問題を解決できるよう。十分な内容を含める。 8. 共通語彙基盤利用登録及びロゴ取得ツール 8.1. 概要 共通語彙基盤の語彙を利用しているユーザーが、その利用状況を登録すると同時に共通語彙基盤の ロゴを取得するためのツール。 24 8.2. 機能要件 (1) 任意のドメイン・パスで動作可能な Web アプリケーションとして作成する。 (2) 登録は以下の情報の入力を求める。 登録者氏名 連絡先メールアドレス 表示名 登録者の種別（省庁・地方自治体・非営利団体・営利団体・個人など） 参照先 (3) 登録にあたっては連絡先メールアドレスへの登録確認を行う (4) 登録が正常に行われた場合に、IPA により提供される共通語彙基盤ロゴを任意の Web サイトに張 り込むための HTML の断片を表示する。 (5) 登録された情報はデータベース等に保存する。 (6) 上記(1) のうち、連絡先メールアドレス、表示名、登録者の種別、参照先については、RDF によ り公開する。 (7) ツール画面において、入力項目に関する説明を行い、ドキュメントやヘルプなどを参照すること なく使用できるようにする。また、各入力項目について公開・非公開の別を明示する。 9. 共通語彙基盤ライブラリ 9.1. 概要 本事業で構築するツール類の構築、及び、将来第三者によって構築されることが想定されるデータ入 力ツールやデータを利用するアプリケーション、CMS 等へ共通語彙基盤対応機能を組み込む際等に利 用され、これらが DMD、IMI 語彙・用語など語彙データベースが扱う主要なリソース及び、構築され た構造化データ（RDF 等）を容易に扱えるようにするためのライブラリ。 9.2. 機能概要 (1) 対象とするプログラミング言語は、Ruby 又は EcmaScript（TypeScript 及び Dart を含む）のいず れか一つとする。 25 (2) ライブラリでは、以下の機能を提供するとともに、本事業で構築するツールの複数個所で共有される 機能については、可能な限りコンポーネント化し本ライブラリに収納する。 (3) 語彙データベース API ラッパー DMD クラスライブラリ データクラスライブラリ 値検証機能 語彙データベース API ラッパー A) OAuth2.0 クライアントとして、語彙データベースへのログインを容易に行うための機能を提供 する。 B) ログイン情報及び状態をコンテキストとして扱うオブジェクトを提供する。語彙データベースに ログインした際にはコンテキストを返却する。語彙データベース API ラッパーの呼び出しに使用 できるようにする。 C) ログイン機能と連動し、認証情報の送信、引数の設定などを行い、容易に語彙データベース API を呼び出せるようにするためのラッパー。 D) (4) 語彙データベースが提供するすべての API に対するラッパーメソッドを提供する。 DMD クラスライブラリ A) DMD の情報の読み取りや DMD の作成を容易にするためのクラスライブラリであり、DMD を 対象プログラミング言語のオブジェクトとして扱うためのラッパーオブジェクト（以下、DMD オブジェクト）を実装する。 B) DMD オブジェクトの新規作成機能を有する。 C) 既存の DMD ファイルを読み込み DMD オブジェクトを作成する機能を有する。 D) DMD オブジェクトの内容を DMD としてファイルに保存する機能を有する。 E) DMD オブジェクトでは、DMD ヘッダーに含まれる全ての内容を取得及び設定可能とする。 F) DMD へのファイルの追加及び DMD からのファイルの除外が行えるようにする。 G) 表形式のデータ（配列又は連想配列などによる）を変換し、後述のデータオブジェクトを得る機 能を有する。 (5) データクラスライブラリ A) DMD により規定された形式のデータインスタンスを、プログラム言語から容易に扱えるように するためのライブラリ。データインスタンスを対象プログラミング言語のオブジェクト（データ オブジェクト）として扱えるようにする。 B) データオブジェクトを新規に作成する機能を有する。 C) 既存のデータファイル及びメモリ上に読み込まれたデータからデータオブジェクトを作成する 26 機能を有する。 D) データオブジェクトの内容をデータファイルとして保存する機能を有する。 E) データに対して、DMD に既定された値制限に応じた検証を行う機能を提供する。 (6) 値検証機能 A) DMD に既定される文字セットや値範囲などの値制限に応じて、渡された値を検証する。 B) データ入力ツールなどを作成する際に、値の検証を行うためのライブラリ。(4) に記述される DMD に対応するオブジェクトから各データ項目に対応する適切な検証関数が取得できるように する。 10. マニュアル及びドキュメント類 10.1. 概要 上記の語彙作成支援ツール、コード・コードリスト作成支援ツール、DMD 作成支援ツール、データ 形式変換ツールの利用者マニュアル、共通語彙基盤ライブラリのリファレンスドキュメント、及び、ツ ールを利用するにあたり必要となる、語彙や DMD 等についてのドキュメントを整備する。 10.2. 要件 (1) 次のツールの利用者マニュアルを作成する。 A) 語彙作成支援ツール B) コード・コードリスト作成支援ツール C) DMD 作成支援ツール D) データ形式変換ツール E) DMD 検証ツール F) データ検証ツール (2) 上記 A)～D)の利用者マニュアルは、単にツールの使用方法を解説したものではなく、それぞれの 操作の意味や目的について詳述すること。また、各操作において起こりうるエラーや起こりがち な間違いなどについて言及し、エラーや間違いの原因について詳しく解説すること。動画を用い ることが効果的な学習に繋がるのであれば、ドキュメントに動画を含めてもよい。 (3) 共通語彙基盤ライブラリのリファレンスドキュメントを作成する。 (4) ツールを利用するために必要となる次のドキュメント類を IPA による技術的な監修のもと整備す る。 コード作成ガイド 27 データ作成ガイド DMD 作成ガイド (5) ドキュメント類は HTML で記述するものとし、HTML には適切にメタデータを挿入する。 (6) メタデータの記述については、共通語彙基盤のルールに従って作成された「文書」を表現するク ラス用語を用いる。 「文書」を表現するクラス用語の定義は、Dublin Core などが定めるものと同 等なものを基本とし、日本において特に必要となる項目の追加を行ったものとする。 「文書」を表 現するクラス用語の定義の詳細については、IPA と協議して決定するものとする。 28
© Copyright 2024 ExpyDoc
