Difference between revisions of "ARK2/UX"

From ARK
Jump to: navigation, search
(Data Schema)
Line 16: Line 16:
Description of Single Context Recording model, also Trench-based variation.
Description of Single Context Recording model, also Trench-based variation.
* Context
* Plan
* Photo
* Section
* Sample
* Find
* Timber
* Subgroup
* Group
== User Profiles ==
== User Profiles ==

Revision as of 12:47, 12 December 2016


ARK, the Archaeological Recording Kit, is a web application for recording, analysing, and publishing archaeology data. ARK provides a very flexible platform akin to a CMS to allow different clients to configure their site to meet their data recording needs. This flexibility applies to the UX and UI as well as the data schema.

ARK1 is largely custom code that is showing its age and hard to customise. ARK2 is a ground-up rewrite to bring ARK into line with modern web technology including a REST API, while also making it easier to configure and maintain.

While clients are able to build custom web or app interfaces using whatever technology they prefer, most will choose to use and possibly adapt the default Bootstrap/Twig web interface which needs to be both feature-complete and flexible, albeit at the cost of some efficiency. They are also likely to use variations on the standard 'Site Recording' data schema with 'Sites' or 'Projects' at the top level, as will the hosted ARK-as-a-service, so the default UX should be weighted towards that scenario.

Data Schema

The ARK data schema is configurable using the concept of Modules. A Module can be thought of as an Object in the Object-Oriented model or a Resource in the REST model, with a set of data properties or fields, and relationships to other Modules. This schema is completely configurable by the website admin, but a number of industry-standard configurations are available to use.

Field Recording

The primary use for ARK is recording data in the field, analysing the data in the office, and publishing the data online. It reflects the paper-based field recording systems originally used in Archaeology, being based around Registers and Forms. The UX primarily needs to support this field recording role, but be adaptable to .

Description of Single Context Recording model, also Trench-based variation.

  • Context
  • Plan
  • Photo
  • Section
  • Sample
  • Find
  • Timber
  • Subgroup
  • Group

User Profiles

  • Anonymous
  • Field Operative
  • Field Supervisor
  • Office Operative
  • Office Supervisor
  • Site Admin
  • System Admin

Generic Pages

Website Home

Landing page for a Website. If private ARK then usually login page. If public ARK then usually some project brochure-ware and links to browse site if anonymous access enabled.

User Home

Landing page for user after logging in, usually some kind of dashboard, but may be User Profile page.

Collection View

  • List Items by Module
  • View modes: Text, Table, Thumbnails
  • Filter Items by properties in view
  • Select properties to view
  • Paging
  • Export
  • Integrate Advanced Search? (see below)

Item View / Edit

  • View item details
  • Edit Item details
  • Subforms (think Drupal Blocks)
  • Item navigation

Map View

  • OpenLayers
  • Display advanced search results?
  • Spatial Search

Advanced Search

Version of Collection View with more advanced search tools, possibly same page with mode switch or hidden panel?

  • Cross-module search
  • Set based queries
  • By Module / Type
  • By Property
  • By Actor / Action / Event
  • By Period
  • By Spatial
  • Free Text
  • Save Search Definition
  • Choose from saved Search definitions

Site Recording Pages

Register View

Short-form add new Item.

Site/Project Dashboard

Dashboard for a Site/Project

User Security

ARK2 will provide a very flexible User Security system using an RBAC model. Website admins will have a choice of registration and authentication options and the UX/UI should adapt to these as configured.

  • Register
  • Login
  • Optional Captcha
  • Optional OAuth2 (Facebook, Google, etc)
  • Request password reset
  • Profile
    • Personal details
    • Contact details
    • Security details

Admin Screens

See Admin Screens. UX required is primarily layout and flow, plus User Admin, Translation and Vocabulary pages.