各定義情報の説明

各情報について、以下の形式で記述します。

バージョン情報

# 福岡市 市の施設(共通フォーマット)
version: 2

先頭のコメント行は任意です。バージョン情報は"2"と記述します。

キー 説明
version 定義ファイルのバージョンを指定します。

変換元データ情報

input:
  source:
    type: Url
    url: https://datasource
  reader:
    type: CSV
    encoding: CP932

変換元データの情報を記述します。入力データ情報は2つの情報を組み合わせて表されます。

キー 説明
source データの所在についての情報を記述します。
type: データ所在の種類について記述します。(現在は「Url」のみ)
url: データのURLについて記述します。
reader データの読み取り方法についての情報を記述します。
type: データの形式について記述します。(現在は「CSV」のみ)
encoding: データのエンコーディングについて記述します。例) CP932、UTF-8 など

変換先データ情報

output:
  storage:
    type: Orion
    url: https://orion
    service: example
    servicepath: /fukuoka_facilities
    token: zzz
キー 説明
storage データ保存先について記述します。
type: データ保存先の種類について記述します。(現在は"Orion"のみ)
url: OrionのURLについて記述します。
tenant: Orionのテナント名を記述します。
path: Orionのサービスパス名を記述します。
token: tokenの項目が存在する場合、指定されたトークンを使用してPEPにアクセスします。

入力カラム情報

columns:
  - 名称
  - 名称かな表記
  - 住所表記
  - 郵便番号
  - 緯度
  - 経度
  - 電話番号
  - FAX番号
  - Eメールアドレス
  - Webサイト
  - 種別

CSVで使用しているカラム名の一覧を記述します。

エンティティ情報

entity:
  type: PointOfInterest
  id:
    name: id
    type: Id
    params:
      - name: id
        values:
          - type: Const
            value: urn:ngsi-ld:fukuoka-facilities
          - type: Count
            value: "000001"
        subs: {}
    metadata: []

エンティティのtypeとidの情報を記述します。

キー 説明
type FIWARE Data Modelの型を記述します。
id エンティティのidについて記述します。記述方法については次頁以降の変換定義を参照してください。

例)

上記の例では以下のような設定を行っています。 「urn:ngsi-ld:fukuoka-facilities」という文字列と、連番の数字を連結してidを生成しています。

urn:ngsi-ld:fukuoka-facilities-000001
urn:ngsi-ld:fukuoka-facilities-000002
urn:ngsi-ld:fukuoka-facilities-000003

属性情報

NGSIデータの各属性について、データの変換ルールを記述します。 変換定義については次頁以降で説明します。


© NEC Corporation 2019-2021