あなたの街のオープンデータ推進をサポートします!

CKANユーザーマニュアル

本マニュアルは、2015年1月末時点でのCKAN.orgのUser guideを翻訳したものです。未翻訳の箇所も若干あり、随時更新を進めていきますが、指摘事項や要望等ありましたら、お問合せフォームよりご連絡をお願い致します。


 

CKANユーザーガイド

このユーザガイドはCKANのWebインターフェスを使用したデータの整理・公開・検索を対象としています。またCKANは、他の情報システムへの連携やExtensionsの開発を可能にする強力なAPI(マシン-インタフェース)を持っています。APIに関しては、APIガイドに記載されています。

サイトの管理に関連する一部のWeb UI機能はシステム管理者のステータスを持つユーザーに利用可能であり、それらはsysadminガイドに記載されています。

What is Ckan?

CKANは、オープンデータのWebサイトを作るためのツールです。 (Wordpressのようなコンテンツ管理システムだと思ってください。 -違いは扱うものが、ページやブログ記事ではなくデータになっただけです)Ckanは集められたデータの管理や公開することを可能にします。また、大量のデータを収集する、国や地方公共団体、研究機関、および他の組織で使用されています。

いったんあなたのデータが公開してしまえば、開発者、ジャーナリスト、研究者、NGO、市民であること、または あなた自身のスタッフかどうかにかかわらず、ユーザーは、必要なデータを検索や参照することができ、マップやグラフや表形式にしてプレビューすることが可能です。

データ・セットとリソース

CKANの目的は、データはデータセットと呼ばれる単位で公開されることです。データセットとはデータのまとめたものです。例えばそれは、地域の犯罪統計や、政府の支出、各気象観測所が公開している気温の情報であるかもしれません。ユーザがデータを検索した場合、その検索結果が個々のデータセットになります。

データセットは以下の2つの内容を含みます:

  • データに関する情報やメタ情報について。例えば、データの件名や公開者、日付、対応可能なフォーマットどのライセンスの下で公開されているか等
  • 含まれいてるデータの数.CKANはデータがどのフォーマットで格納されているか気にしません。CSVやエクセル、XML、PDF、画像、RDF形式におけるリンクドデータ等を取り扱うことが可能です。CKANは、内部にリソースを格納するだけでなく、実体がウェブ上の他の場所に存在するリースをリンクとして格納することが可能です。データセットはリソースをいくつでも含むことが可能です。例えば、異なるリソースに対して、異なる年のデータに含まれている場合もありますし、同じリソースに同じデータの異なるフォーマットで含まれている場合もあります。

ユーザー、組織および認証

CKANユーザーは、ユーザーアカウントを作成し、ログインすることができます。通常、(サイトの設定によりますが)、データを検索・閲覧の際にログインは必須ではありませんが、データの公開機能(適切な権限を持つユーザによるデータセットの作成、編集、等)を利用する際には必要になります。

通常、各データセットは「組織」が所有しています。一つのCKANインスタンスの中には、組織の数に制限はありません。例として、ある国がCKANをデータポータルとして使用している場合、異なる政府部門がそれぞれのデータを公開する可能性があります。その場合でも、各組織は、自身の公開プロセスを管理できるよう、独自のワークフローや承認を持つことが可能になります。

組織の管理者は、個々のユザーに対して、異なるロール(役割)を設定することが可能です。ユーザーは、その組織に所有するデータセットを作成することができます。デフォルトの設定では、作成したデータセットは、最初は同じ組織内の他のユーザーにしかみることができない設定(プライベート)となります。一般公開する準備がでているのであれば、ボタンを押すだけで公開することができます。これには組織内でより高度な承認を必要とするかもしれません。

通常、データセットは組織に所属しない形で作成することはできません。ただし、どの組織にも所属しないデータセットの登録をCKANに許可することも可能です。このようなデータセットは、すべてのログイン中のユーザーが編集することができ、wikiのようなDataHubとしてしようすることが可能になります。

Note

ユーザーガイドは、Webユーザーインターフェイス( UI)の主要な機能をカバーしています。実際には、サイトの設定に応じて、これらの機能の一部がわずかに異なる、または利用できない場合があります。例えばあるCKANの公式サイトの設定では、サイト管理者は、ユーザに対してUIから新しい組織を作成出来ないようにしているかもしれません。http://demo.ckan.orgではすべての機能を試すことが可能です。

Using CKAN

アカウントの作成とログイン

Note

アカウント作成はほとんどの公開機能と「データセットをフォローする」といったパーソナライズな機能を利用するために必要となります。データの検索やダウンロードには必要ありません.

ユーザIDを作成は、任意のページのトップの「登録」リンクをクリックして下さい。以下の項目が要求されます:

  • ユーザ名 – アルファベット、数字、アンダースコア(_)が仕様可能です。例: “jbloggs” or “joe_bloggs93”.
  • フルネーム – ユーザプロファイルに表示します
  • E-mail アドレス – 他のユーザから見ることはできません
  • パスワード – パスワード(確認にも入力が必要です)

https://opendatastack.jp/wp-content/uploads/2015/01/ckan1.png

入力項目に問題がある場合は、CKANは問題の項目がハイライトされるため修正を行って下さい。フィールドが正しく入力されている場合には、CKANは、ユーザーアカウントを作成し、自動的にログインします。

Note

一つのメールアドレスに対して一つ以上のアカウントをひもづける事が可能です。この理由から、ログイン時にユーザ名を使用する必要があります。

Features for publishers

Adding a new dataset

Note

データセットを追加・編集するためには組織のメンバーである必要があります。以下の「組織の作成」を確認してください。http://demo.ckan.orgでは、組織に所属していなくてもデータセットの追加が可能ですが、承認や組織に関連するデータセットの機能をご利用頂けません。

ステップ1.次の2つの方法で、CKANの「データセットの作成」画面にアクセスすることができます。

  1. 任意のページの上部にある「データセット」リンクをクリックします。次に、検索ボックスの上に、「データセットを追加」ボタンをクリックします。
  2. もう一つの方法としてページトップの”組織”を選択していください。次に新しいデータセットを登録する組織を選択します。あなたがその組織のメンバーであれば検索ボックスの上に、「データセットを追加」ボタンをクリックすることができます。

Step 2. CKANは、追加するデータに関する以下の情報を要求します。 (実際のデータは、ステップ4で追加されます) *

  • タイトル – タイトルはCKAN全体で一意である必要があります。そのため、タイトルは簡潔でありますが具体的なものとする必要があります。例えば“UK population density by region” の場合は “Population figures” の方がベターです.
  • 説明 – 個々にデータセットに対してデータの諸元やこのデータを使うにあたって必要となる情報などの説明を追加することが可能です。
  • タグ – データを探しやすくしたり他の関連データとのリンクとしてタグを追加することが可能です。 タグの例ですが、“population”, “crime”, “East Anglia”となります。キーを叩けば、新たなタグが追加可能です。 もし、間違ったタグを入力した場合は、データセットを保存する前にタグを選択して削除を実行してください。
  • ライセンス – データをどのように扱ってよいのかライセンス情報を明記する必要があります。 この項目はドロップダウンで選択します。もし選択肢に使用したいライセンスがなければサイト管理者にご連絡ください。
  • 組織 – あなたがいずれかの組織の所属している場合、ここでデータセットを所有さえる組織を選択します。先に進む前に、デフォルトの選択が正しいものであることを確認してください。(おそらくほとんどのユーザーは、所属している組織は一つだけだと思います。その場合は、デフォルトでその組織が選択されているため、特に選択し直す等の必要はありません)

https://opendatastack.jp/wp-content/uploads/2015/01/ckan2.png

Note

デフォルトでは、このページでの必須項目はタイトルだけです。 しかし、最低でも短い説明と、可能な場合は、ライセンス情報を含めることをお勧めします。現状では、選択した組織は後で変更はできませんので、正しい組織が選択されている必ず確認してください。他のフィールドに関しては、後で変更が可能です。

Step 3. このページで項目の入力が完了したら「Next:データの追加」ボタンをクリックしてください.

Step 4. ”データの追加”画面が表示されます.

https://opendatastack.jp/wp-content/uploads/2015/01/ckan3.png

ここではデータセットに含めたい一つ以上のリソースを追加します。
画面上から、ファイルかリンクを選択してください。

  • もしCKANにhttp://example.com/mydata.csvの様なデータへのリンクを登録する場合は、“リンク”を選択してください。
  • もし、登録するデータがあなたのコンピュータ上のファイルの場合は“アップロード”を選択してください.

Step 5. 他の情報を追加します。以下の情報は必須ではありませんが、追加することを強くお勧めします:

  • 名前 – リソースの名前です。例. “Population density 2011, CSV”. データセットの中の異なるリソースは違う名前にする必要があります。
  • 説明 – リソースに対する説明.
  • データ形式 – リソースのデータ形式。 例. CSV (comma-separated values), XLS, JSON, PDF, etc.

Step 6. データセットに続けて別のリソース(ファイルまたはリンク)を追加したければ“保存して他を追加” ボタンをクリックしてください。リソースの追加が完了している場合は “次へ: 追加情報”を選択してください.

Step 7. 追加情報画面が表示されます.

  • Visibility – a Public dataset is public and can be seen by any user of the site. A Private dataset can only be seen by members of the organization owning the dataset and will not show up in searches by other users.
  • バージョン – データセットのバージョンを指定します
  • 作成者 – データを作成した責任者や組織の名前.
  • 作成者のemail – データに対する問い合わせ先としての作成者の e-mail アドレス.
  • メンテナー / メンテナーのemail – 必要に応じして、データに対する第二責任者の詳細を入力します.
  • カスタムフィールド – データセットへ他の項目を追加したければ、ここで項目名と値を追加することが可能です. 例. “公開した年”。データセットの大多数にフィールドの追加が必要な場合は、デフォルトのスキーマの変更等に関してサイト管理者に相談してください。

https://opendatastack.jp/wp-content/uploads/2015/01/ckan4.png

Note

この画面での項目は全て必須項目ではありませんが、“Visibility” を正しくセットされているか確認してください。作成者の名前の確認も忘れずに.

version 2.2での変更: CKANの以前のバージョンでは、このステップでは、既存のグループにデータセットを追加できました。 2.2以降では変更され、既存のグループにデータセットを追加するには、データセットのページで「グループ」タブに移動してください。

Step 8. “完了”ボタンをクリックしてください. データセットが作成されました!登録作業は完了です!

登録したデータセットを検索ボックスにタイトルや説明に含まれる単語を入力して検索することができるはずです。データの検索の詳細については、データの検索を参照してください。

Editing a dataset

作成したデータセットや所属する組織のデータセットを編集することが可能です。 (データセットがどの組織も所有していない場合は、CKANに登録されているユーザー全員が編集可能です.)

  1. データセットのページへ移動します。 任意のページで検索ボックスからタイトルを入力することで検索が可能です.
  2. データセットのタイトルの上部に表示される”管理”ボタンをクリックしてください.
  3. 編集画面が表示されます。 全ての項目 (タイトル, 説明, データセット, etc)の編集, (Private/Public)の変更, タグやカスタムフィールドの追加と削除. これらのフィールドの詳細は Adding a new dataset を確認してください。
  4. 編集が終わりましたら “データセットを更新”をクリックして変更を保存してください。

https://opendatastack.jp/wp-content/uploads/2015/01/ckan5.png

Adding, deleting and editing resources

  1. 対象のデータセットの”データセットの編集”ページへ移動してください(上のsteps 1-2 と一緒です).
  2. 左のサイドバーにリソース編集用のオプションがあります。 You can select an existing resource (to edit or delete it), or select “Add new resource”.
  3. You can edit the information about the resource or change the linked or uploaded file. For details, see steps 4-5 of “Adding a new resource”, above.
  4. When you have finished editing, select the button marked “Update resource” (or “Add”, for a new resource) to save your changes. Alternatively, to delete the resource, select the “Delete resource” button.

データセットの削除

  1. 削除したいデータセットのデータセットの編集画面へ移動して下さい.
  2. “削除” ボタンをクリックして下さい.
  3. 確認ダイアログが表示されます。”確認”ボタンをクリックするとデータセットが削除されます.

Note

データセットの削除は実際にデータが削除されるわけではありません。検索結果等へ表示されなくなるだけです(論理削除)。ただし、データセットのページへURLから直接参照した場合は、(適切な権限をもつユーザーによって)確認することが可能であり、必要であれば未削除の状態へ戻すことが可能です。完全にデータセットを削除したい場合は、サイト管理者へ連絡してください。

Creating an organization

組織内にて異なるアクセス権限をユーザーに設定可能です。 例えば、あるユーザーはデータセットの編集は可能だが作成は許可されていない、または、あるユーザーはデータの作成は許可されているが公開は許可さてない等。各組織には、ユーザーがその組織の情報を確認しそのデータセットを検索可能なホームページが割り当てられます。このことにより異なるデータを公開する部門、団体などが独自の公開ポリシーを適用することができます。

組織の作成:

  1. 各ページの上部にある”組織”リンクをクリックしてください.
  2. 検索ボックス上の”組織を追加”をクリックしてくだし.
  3. “組織の作成”ページが表示されます.
  4. 組織の名前、説明、CKAN内の組織のホームページ用の画像といった項目を埋めてください.
  5. “組織の作成” ボタンをクリックしてください. 組織が作成され、そのホームページが表示されます。最初は、もちろん何のデータセットを持っていません。

https://opendatastack.jp/wp-content/uploads/2015/01/ckan6.png

これで他のユーザーへ組織でのアクセス権限を変更することが可能です。- see Managing an organization below. また、組織が所有するデータセットの作成が可能になりました; see Adding a new datasetabove.

Note

CKANの設定次第では、新しい組織を作成することを許可されない場合があります。この場合、新しい組織が必要な場合は、サイト管理者に連絡する必要があります。

Managing an organization

組織を作成するさいに、CKANは自動的に作成者を”管理者”に設定します。組織のページにて検索ボックスの上に”管理”ボタンが表示されるはずです。このボタンをクリックすると組織の管理者ページが表示されます. このページは2つのタブページで構成されています:

  • 編集 – 個々では組織作成時に登録した情報(名前、説明等)の編集が可能です.
  • メンバー – 組織に属するためのメンバーのアクセス権限の編集が可能です. Note:CKAN上でのユーザ名を知っておく必要があります。.

https://opendatastack.jp/wp-content/uploads/2015/01/ckan7.png

デフォルトでは、CKANは以下のロールがメンバーに対して設定可能です:

  • Member – 組織の private データセットを参照できます
  • Editor – データセットの編集・公開が可能です
  • Admin – メンバーに対してロールの追加・編集・削除が可能です

Finding data

Searching the site

CKAN内のデータセットを検索するには、検索語(例えば「健康」、「輸送」など)の組み合わせたものを任意のページ上の検索ボックスにを入力します。 検索結果の最初のページが表示されます:

  • 検索結果が多数の場合はページングされます
  • 検索条件を変更して繰り返し検索が可能です。
  • ページ浸りがわのタグやデータ形式等のフィルタを利用して、データセットを絞り込んで検索が可能です

検索結果が多数の場合、フィルターを非常に有用です。既存のフィルタを追加・削除し再検索を行うことが可能です。

地理的領域にタグ付けされている場合は、CKANは地図上から検索可能にする拡張を使用することが可能です。

https://opendatastack.jp/wp-content/uploads/2015/01/ckan8.jpg

Searching within an organization

特定の組織に属したデータを検索したい場合は、CKAN内の組織のホームページから検索が可能です。

  1. 任意のページの上部メニューから”組織”を選択してください.
  2. 対象とする組織を選択し、組織のホームページを表示させます.
  3. 検索ボックスから検索を実行します。

これで選択した組織に限定した検索結果を表示することが可能です。

その組織に感心がある場合には、組織内のページにある”Follow”ボタンをクリックすることにより、データセットの追加や更新があった場合に通知されるようにすることが可能です。 See the sectionManaging your news feed below. この機能を使用するにはCKANにアカウントを持っている必要があります。 もしデータセット(もしくは組織)のフォローを辞めたい場合は、そのデータセットのページへ移動し”Unfollow”ボタンをクリックしてます。

Exploring datasets

関心のあるデータセットを見つけた場合、それをクリックすることによりデータセットの詳細ページを確認することができます。

  • 名称、説明等他のデータセットの情報
  • データセットに含まれる各リソースへのリンクと概要 絵 リソースの説明は、各リソースへの専用ページへリンクしています。

https://opendatastack.jp/wp-content/uploads/2015/01/ckan9.png

このリソースページは、リソースに関する情報を記載され、また、リソースのダウンロードが可能です。 リソースは、その形式により各リソースのページでプレビュー表示が可能です。 .CSVと.XLSスプレッドシートは、データが適切である場合にはマップやグラフビューや表形式にてプレビューが可能です。リソースが一般的な画像形式やPDF,HTMLの場合もプレビューが可能です。

データセットページの以下の2つのタブに関して説明します:

  • アクティビティストリーム – データセットに最近の変更履歴が表示されます
  • 関連 – このデータセットに関連するウェブページへのリンクが表示されます。また、独自のリンクを追加することも可能です。

このデータセットに関心がある場合は、データセットのページの”Follow”ボタンをクリックすることにより、データセットの追加や更新があった場合に通知されるようにすることが可能です。 See the section Managing your news feed below. You must have a user account and be logged in to use this feature.

Personalization

CKAN では、データの公開や検索のパーソナライズ化するための機能を提供しています。これらの機能を使用するためにはログインが必要です。

Managing your news feed

任意のページのトップメニューのダッシュボードのアイコンをクリックしてください(あなたの名前の隣です)。ニュースフィードが表示されます. ここでは、あなたがフォローしているデータセットや組織が変更や追加が発生した場合にその通知が表示されます。ダッシュボードの横には新着通知の数が表示されます. データセットや個人と同様に、 (フォローしたユーザーがデータセットへ変更を加えた場合に通知されるように)ユーザーのフォローも可能です。.

https://opendatastack.jp/wp-content/uploads/2015/01/ckan10.png

データセットや組織、ユーザーのフォローを辞めたい場合はニュースフィードから各々のページへ移動して“Unfollow” ボタンをクリックしてください

Managing your user profile

ユーザプロファイルを編集することにより他のユーザーへ公開するあなたの情報を変更することが可能です (あなたがデータセットの編集をしたりアップロードしたさいにあなたの情報を確認する可能性は高いです) 。 これを行うには、ページの上部のメニューの歯車のアイコンをクリックします。

https://opendatastack.jp/wp-content/uploads/2015/01/ckan11.png

設定画面が表示されます.個々では以下の情報が編集可能です:

  1. ユーザー名
  2. フルネーム
  3. Email (note: これは他のユーザへは表示されません)
  4. About – あなたに付いての簡単な情報
  5. パスワード

必要な変更を行い、その後、「プロフィールを更新」ボタンを選択します。

Note

If you change your username, CKAN will log you out. You will need to log back in using your new username.

お気軽にお問い合わせください TEL 03-5244-4113 受付時間 10:00 - 18:00 [ 土・日・祝日除く ]

PAGETOP