Arches Installation Guide

77

description

Installation Guide For Arches

Transcript of Arches Installation Guide

  • Arches: heritage inventory & managementsystem - Installation GuideInstallation Guide

    Arches ProjectThis book is for sale at http://leanpub.com/ArchesInstallationGuide

    This version was published on 2014-02-21

    This is a Leanpub book. Leanpub empowers authors and publishers with the Lean Publishingprocess. Lean Publishing is the act of publishing an in-progress ebook using lightweight toolsand many iterations to get reader feedback, pivot until you have the right book and buildtraction once you do.

    This work is licensed under a Creative Commons Attribution 3.0 Unported License

  • Also By Arches ProjectArches: heritage inventory & management system - User Guide

  • Contents

    Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iAcknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ii

    Contributors: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iiCover image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iiCover design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ii

    What is Arches? An overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iiiKey features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iiiApplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iiiFurther information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv

    Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1What do I need to know to use this guide? . . . . . . . . . . . . . . . . . . . . . . . . 1

    Express Installation Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Before You Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Option 1: Installing Arches on your own Computer . . . . . . . . . . . . . . . . . . . . 2

    Step 1: Download the Arches VM . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Step 2: Install VirtualBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Step 3: Import the Arches VM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Step 4: Start the Virtual Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Step 5: Log on to the VM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Step 6: Start the Arches Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5A note on Ubuntu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

    Option 2: Installing Arches on the Amazon Cloud . . . . . . . . . . . . . . . . . . . . 8Step 1: Set up an Amazon Account . . . . . . . . . . . . . . . . . . . . . . . . . . 8Step 2: Get the Arches AMI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Step 3: Select the Arches Server Size . . . . . . . . . . . . . . . . . . . . . . . . . 9Step 4: Review the Arches Instance . . . . . . . . . . . . . . . . . . . . . . . . . . 10Step 5: Create Key Pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Step 6: Edit the Arches Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Step 7: Configure HTTP Access on your Server . . . . . . . . . . . . . . . . . . . 13Step 8: Log on to Arches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

    Deploying Arches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Before you start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

  • CONTENTS

    Arches and Cultural Heritage Standards . . . . . . . . . . . . . . . . . . . . . . . . . . 17Step 1: Install Core Arches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

    Installation Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Option 1: Install Arches on a Windows Server . . . . . . . . . . . . . . . . . . . . . . 18

    Step 1: Download Arches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Step 2: Install PostgreSQL 9.x, PostGIS 2.x . . . . . . . . . . . . . . . . . . . . . . 18Step 3: Install GEOS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Step 4: Install Python 2.7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Step 5: Install the latest Java Development Kit (JDK) . . . . . . . . . . . . . . . . 20Step 6: Install Web Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Step 7: Install Arches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Next Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

    Option 2: Install Arches on a Linux Server . . . . . . . . . . . . . . . . . . . . . . . . . 22Step 1: Download Arches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Step 2: Install PostgreSQL/PostGIS . . . . . . . . . . . . . . . . . . . . . . . . . . 22Step 3: Install Web Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Step 4: Install and Build Arches . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Next Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

    Option 3: Install Arches on a Vagrant Virtual Machine . . . . . . . . . . . . . . . . . . 26Step 1: Download Arches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Step 2: Install Vagrant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Step 3: Install VirtualBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Step 4: Download Virtual Machine File . . . . . . . . . . . . . . . . . . . . . . . . 26Step 5: Build Arches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Step 6: Start Arches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27A Note on Vagrant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

    Step 2: Load Resource Type Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . 30What are Resources? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Arches Resource Type Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

    Heritage Resources: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Actors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

    Creating Your Own Resource Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Loading Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

    Step 1: Select Resources to Load . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Step 2: Load Resource Type Definitions . . . . . . . . . . . . . . . . . . . . . . . . 34

    Next Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Step 3: Load Controlled Vocabularies . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

    What are Controlled Vocabularies? . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Thesauri . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

    Default Authority Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Understanding the Structure of an Authority Document . . . . . . . . . . . . . . . . . 39Understanding Authority Document Values . . . . . . . . . . . . . . . . . . . . . . . . 41

  • CONTENTS

    What Value Types Can I Define? . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Modifying the Default Authority Files . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Loading the Controlled Vocabularies . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Next Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

    Step 4 (optional): Load Data into Arches . . . . . . . . . . . . . . . . . . . . . . . . . . 45Resources and Their Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Creating a Data Load File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

    Adding Multiple Values to an Attribute . . . . . . . . . . . . . . . . . . . . . . . 48Attribute Goups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Which Attributes can be Grouped? . . . . . . . . . . . . . . . . . . . . . . . . . . 50

    Loading the Data File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Next Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

    Step 5: Running and Configuring Arches . . . . . . . . . . . . . . . . . . . . . . . . . . 51Running Arches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Arches Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Managing User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

    Updating the Default Administrator Password . . . . . . . . . . . . . . . . . . . . 53Adding a New Editor Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

    Setting Default Map Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Managing Basemaps and External GIS Layers . . . . . . . . . . . . . . . . . . . . . . . 56

    Adding a new Basemap/GIS Service to Arches . . . . . . . . . . . . . . . . . . . . 57Removing a GIS Map Service from Arches . . . . . . . . . . . . . . . . . . . . . . 61

    Cosmetic Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Changing the Image on the Arches Splash Screen . . . . . . . . . . . . . . . . . . 61Changing the Style of a Resource Layer . . . . . . . . . . . . . . . . . . . . . . . 62

    Using Arches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Backup Your Arches Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Performance Tuning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67User Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Feedback and Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

  • VersionThis version is issued to support Version 1.0 of Arches, released in October 2013.February 21, 2014 update:* For Windows users we added an explicit step to load GEOS library* Updated section on Amazon deployment to include latest AMI user interface* Clarified some of the steps around installing the web server and search engine

  • AcknowledgmentsContributors:Ryan Anderson, Farallon GeographicsYiannis Avramides, World Monuments FundKieran Byrne, English HeritagePhil Carlisle, English HeritageAlison Dalgity, Getty Conservation InstituteRob Gaston, Farallon GeographicsEdmund Lee, English HeritageAdam Lodge, Farallon GeographicsDavid Myers, Getty Conservation InstituteAlexei Peters, Farallon GeographicsKoen Van Daele, Flanders Heritage AgencyDennis Wuthrich, Farallon Geographics

    Cover imageExtract from a technical survey of the 18th century arch of the Ironbridge, England, part of theIronbridge World Heritage Site. Courtesy of Paul Bryan, English Heritage.

    Cover designKen Feisel, World Monuments Fund

  • What is Arches? An overviewArches is a new open-source geospatial software system for cultural heritage inventory andmanagement, developed jointly by the Getty Conservation Institute and World MonumentsFund. Arches grew out of the widespread need within the heritage field for the ability to createelectronic inventories at low cost that are easy to use and access. Arches combines state-of-the-art software development with insights and perspectives of heritage professionals from aroundthe world.The need for functional heritage inventories has grown over the last decades, together with therise of a global awareness of the importance of heritage management. Nevertheless, inventoriesremain complicated to establish andmaintain, and frequently rely on costly proprietary softwarethat does not always fit the needs of the heritage field. Arches provides a common platform thatis easy to use and customize, and yet one that takes advantage of the latest available technologyto allow users to create and manage heritage information in all its richness and diversity.

    Key featuresPurpose-built. Arches has been purpose-built for the international cultural heritage field, andcan be used to inventory and document all types of immovable heritage, including buildings andother structures, cultural landscapes, heritage ensembles or districts, as well as archaeologicalsites.Open Source. As open source software, Arches is freely available to use and customize, withoutlicensing costs, and it is capable of being configured and extended to meet the needs of particularusers.Standards-based. Arches incorporates internationally adopted standards for heritage inventory,semantic modeling, and information technology, leading to better practices in the creation andmanagement of heritage data and facilitating data exchange and longevity in spite of advancesin technology.

    ApplicationArches has been designed to serve a number of purposes fundamental to the understanding,appreciation, and management of heritage places. These include:

    identification and inventory research and analysis monitoring and risk mapping determining needs and priorities for investigation, research, conservation and manage-ment

  • What is Arches? An overview iv

    planning for investigation, conservation, and management activities raising awareness and promoting understanding among the public, as well as governmen-tal authorities and decision makers

    Further informationDetailed background to the project, fact sheets, conference presentations, a project blog andactive online community are all available at http://www.archesproject.org.

  • IntroductionWelcome to the Arches Installation Guide. This document is intended to help you quickly getArches running on your server. If you cant wait to get started, skip straight to the DeployingArches chapter. Or, if youd simply like to evaluate Arches using an example dataset, jumpstraight to the Express Installation chapter.Otherwise, read on to learn more about how Arches manages cultural heritage data.Once you have installed Arches there is a companion book to this one, the Arches User Guide,with more information about how to use the software, and how to join the Arches community,a growing online network of Arches developers and users.

    What do I need to know to use this guide?Arches is designed to let you manage many types of cultural heritage data. And while wevetried to make it easy to install Arches, youll need to make some decisions on how you wish todescribe and manage the information that goes into Arches. But dont worry, weve also includedlots of examples and well-thought-out defaults for setting up the software.So, installing Arches means loading software and deciding how you want to describe the culturalheritage information thats important to you. Weve written this guide assuming that you arecomfortable working with your computers command line, and that you can edit text files withease.Thats it! Feel free to tap a colleague on the shoulder if you need a little help along the way, orcheck out the resources at www.archesproject.org for more support.

  • Express Installation GuideThe Express Installation Guide allows you to quickly install and use Arches with its defaultsettings and an example dataset from northern England, courtesy of English Heritage. If yourprimary goal is to test Arches to determine whether it might be a good fit for your project ororganization, then the Express Installation is for you.

    Before You StartYoull need to decide where you want to install Arches. You have two options:

    Local Installation (on a computer that you own), or Cloud Installation on an Amazon server

    Arches runs best with at least 2GB of RAM (but feel free to give it more!), so check to make surethat your computer has enough memory to support the installation.If you decide to install Arches on your own computer, youll need to download and install anapplication to support the express installation.Weve designed the express installation to install Arches on a Virtual Machine (VM). Dont worrytoo much if you dont know what a VM is; just know that it will streamline the work needed toinstall Arches. And, as an added bonus, the VM will ensure that Arches can be easily started ordeleted from your host computer.OK, lets begin!

    Option 1: Installing Arches on your own ComputerYou can install Arches on a laptop, PC, or server. The steps include downloading a VirtualMachine (VM) file (think of this as a complete computer all bundled up in a single file) andthe software necessary to run the VM.

    Step 1: Download the Arches VMStart by downloading the following Arches Virtual Machine file to your computer:https://s3-us-west-1.amazonaws.com/arches.v1.0.0/ArchesVM.ovaIts a pretty large file (about 3 GB), so depending on the speed of your Internet connection, thismight take a while.

  • Express Installation Guide 3

    Step 2: Install VirtualBoxVirtualBox is an open source application that runs Virtual Machines. You will use VirtualBox toimport and run the Arches VM that you downloaded in Step 1.Navigate to https://www.virtualbox.org; download and install VirtualBox for your OS.

    VMWare works too!If you already use VMWare software to run virtual machines you can skip this step anduse your current VMWare product to run Arches.

    Step 3: Import the Arches VMStart VirtualBox, click File and then Import Appliance. Navigate to the folder where youdownloaded the Arches VM files and click on ArchesVM.ova.You should see the following screen:

    Arches Default Screen: Simple Search

    Click the Continue button. VirtualBox will start the import process; youll be presented with asummary of the VM:

  • Express Installation Guide 4

    Arches Default Screen: Simple Search

    Press the Import button. VirtualBox will create a new VM.

    Step 4: Start the Virtual MachineHighlight the newly created Virtual Machine in the VirtualBox Manager, then press Start:

    Arches Default Screen: Simple Search

    During the startup process, VirtualBox may alert you with messages about how it has configuredthe mouse and keyboard. Go ahead and accept each message.

  • Express Installation Guide 5

    Step 5: Log on to the VMYou will see the following log on screen:

    Arches Default Screen: Simple Search

    The user account is called Arches admin. The password is arches.

    Step 6: Start the Arches ServerOnce youve logged on to the VM, youll see 2 shortcuts on the desktop:

    Step 1: Start Arches Web Server Step 2: Open Arches

  • Express Installation Guide 6

    Arches Default Screen: Simple Search

    Double-click Step 1 icon, and then click the Run in Terminal button. Minimize the TerminalWindow (Dont close it!), then double click on the Step 2 icon. If everythings gone right, youllsee the Arches welcome screen:

  • Express Installation Guide 7

    Arches Default Screen: Simple Search

    If you want to test adding or editing cultural heritage data in Arches, youll need to sign in. ClickMap in the upper right corner of the screen, then click

    Arches Sign In

    The Username and Password are both admin (omit the quotes when entering the usernameand password).For more help in understanding the Arches app, check out the Arches User Guide to learn howto work with Arches.

    Using the test data-setAll test data supplied is for experimentation inArches only. The records are not certifiedfor accuracy or completeness.

    A note on UbuntuThe VM youre working with is running Ubuntu 12.04. One reason were using Ubunutu isbecause of its nice user interface. Check out http://www.ubuntu.com/desktop to learnmore aboutUbuntu and to see a quick tutorial on using the interface.

  • Express Installation Guide 8

    Option 2: Installing Arches on the Amazon CloudYou can install Arches on the Amazon cloud. The steps are pretty simple; you just have to startan Amazon server using the Arches amazon machine instance. Dont worry, its pretty easy!Before you start, you may want to familiarize yourself with the Amazon EC2 cloud athttp://aws.amazon.com/ec2/. Youll find lots of useful information on what the Amazon cloudcan do, as well as the costs for using it.

    Step 1: Set up an Amazon AccountGo to http://aws.amazon.com and then click Sign Up and follow the on-screen instructions.Part of the sign-up procedure involves receiving a phone call and entering a PIN using the phonekeypad.

    Step 2: Get the Arches AMIGo to your EC2 Dashboard and click on the blue Launch Instance button.

    Amazon EC2 Dashboard

  • Express Installation Guide 9

    Confirm your region.You need to be in the USWest(N. California) region to find the Arches AMI. You canchange the region by selecting from the dropdown on the right hand top of the screennext to your login name.

    Next, navigate to the Community AMIs tab on the left and type Arches into the text box.Select the Arches_Seed2 AMI.

    Amazon Choose Arches AMI

    Step 3: Select the Arches Server SizeYoull need to decide what size server you want to run Arches (the Instance Type in Amazonlingo). We recommend either M1 Medium or C1 High CPU Medium. When you are done,click the Review and Launch button.

  • Express Installation Guide 10

    Amazon Select Server Size

    Step 4: Review the Arches InstanceHere you can review your selections before actually launching the ami. When youre done, clickon Launch button.

    The clock has started!As soon as you press Launch, Amazon will start billing your account for your usageof the Arches server that youve just launched. Remember that youre only chargedwhile your Arches server is running. Using the Amazon console, you can start andstop Arches as often as you wish, thereby minimizing your costs to evaluate Arches.

  • Express Installation Guide 11

    Amazon Launch Instance

    Step 5: Create Key PairIf you havent ever created a key/pair before then this window will pop up. If you have thenyoull automatically skip to the next step. Enter a name for your key pair, then click the Createand Download your Key Pair.Youll be prompted to select a security group. You can just select the default group. Moreadvanced Amazon users may wish to create a custom group. Next, click Launch InstancesThe next screen should be the Launch Status screen, from here click the View Instances buttonto view your newly created Arches AMI.

  • Express Installation Guide 12

    Amazon Key Pair

    Step 6: Edit the Arches ServerYoull need to tell Amazon to let users access your brand-new Arches server. To do this, youllneed to update your security group:

    Highlight your Arches server in the Amazon console, paying special attention to thethe security group name (you may have to scroll right), in this example launch-wizard-1. Note: After highlighting your Arches instance, youll see the public URL thatyoull use to access Arches. In this example, the URL is http://ec2-54-193-0-31.us-west-1.compute.amazonaws.com

    Click Security Groups on the lower left of the screen.

  • Express Installation Guide 13

    Amazon View Instance

    Step 7: Configure HTTP Access on your Server Select the security group based on the name noted in the previous step (in this examplelaunch-wizard-1)

    Click the Inbound tab From the Create a new rule dropdown, select HTTP Click Apply Rule Changes

    When youre done, you should see port 80 (HTTP) added to your security settings.

  • Express Installation Guide 14

    Amazon Update Security Group

    Step 8: Log on to ArchesYoure now ready to log on to Arches. The web address for your instance of Arches has thefollowing form:

    http:///FGI/Arches/#

    In this example, you would type the following address into your web browser (note: Archesworks with Firefox, Chrome, Safari, Opera, and Internet Explorer 10 or higher):

    http://ec2-54-193-0-31.us-west-1.compute.amazonaws.com/FGI/Arches/#

    If everythings gone right, you should see:

  • Express Installation Guide 15

    Arches Default Screen: Simple Search

    If you want to test adding or editing cultural heritage data in Arches, youll need to sign in. ClickMap in the upper right corner of the screen, then click

    Arches Sign In

    The Username and Password are both admin (omit the quotes when entering the usernameand password).For more help in understanding the Arches app, check out the User Guide at http://Arches UserGuide/ to learn how to work with Arches.

    Using the test data-setAll test data supplied is for experimentation inArches only. The records are not certifiedfor accuracy or completeness.

  • Deploying ArchesInstalling Arches for production purposes consists of the following steps:

    Acquiring and installing the Arches software Determining what immovable cultural heritage data you wish to include in your Archesinventory

    Identifying (or creating) the controlled vocabularies (simple lists or more sophisticatedthesauri) that you will use to describe your cultural heritage data

    (Optionally) Loading any pre-existing cultural heritage data that youmay have into Arches Setting some basic configuration options for your Arches user community

    The following chapters provide step-by-step instructions for completing each of these systemdeployment steps.Dont worry if youre unsure about how to define cultural heritage resources or thesauri.Arches comes with a set of default cultural heritage resource types and simple thesauri to makeit easier for you to adapt Arches for your specific data management needs.

    Before you startThere are a few things to know about Arches before we get started. Arches has the followingsoftware dependencies:

    PostgreSQL relational database (version 9.x) PostGIS (version 2.x) spatial module for PostgreSQL Python (version 2.7) Django (version 1.5) Lucene Search Engine (version 4.4) and ElasticSearch (version 0.90)

    Youll need to make sure that your server has these applications loaded before Arches will work.Dont worry, these instructions will walk you through the necessary steps!Please note that Arches has been developed for modern browsers. It supports Firefox, Chrome,Safari, Opera, and Internet Explorer 10 or higher.

    System RequirementsArches runs best with 2GB (ormore) of RAM.Diskspace requirements will vary depending on thesize of your dataset, but we have found that installing PostgreSQL with default settings shouldget you up and running without any problems.

  • Deploying Arches 17

    Arches and Cultural Heritage StandardsArches can be configured to manage a wide variety of cultural heritage data. And the softwarehas been designed to allow for easy customization and enhancement.But the rich and complex nature of heritage data make building a system like Arches challenging.To ensure that Arches can meet the data management and interoperability needs of the culturalheritage community, Arches has been designed to comply with the following standards:

    CIDOC Conceptual Reference Model (CRM) (www.cidoc-crm.org). The CRM providesdefinitions and a formal structure for describing the implicit and explicit concepts andrelationships used in cultural heritage documentation.

    International Core Data Standard for Archaeological and Architectural Heritage. This isa soon-to-be finalized standard for the inventory of both archaeological and architecturalheritage, which is based on the earlier Core Data Index to Historic Buildings andMonuments of the Architectural Heritage (adopted by the Council of Europe in 1992) andthe Core Data Standard for Archaeological Sites and Monuments (adopted by CIDOC in1995). The new standard under preparation (referred to here as the CDS) was used toidentify the data fields of Arches. Organizations that deploy Arches can customize thosedata fields to meet their specific requirements.

    Youmaywish to familiarize yourself with these data standards as part of your Arches installationand deployment effort. If you ever wish to further customize Arches, familiarity with both willhelp you greatly along the way.

  • Step 1: Install Core ArchesThis chapter presents the steps necessary to acquire and install the Arches core software on yourserver. In contrast to the Express Installation of Arches, this chapter summarizes the steps toinstall Arches in preparation for customization and a production deployment.

    Installation OptionsThis guide describes the steps to complete a basic installation and configuration of Arches on:

    Windows Linux Vagrant Virtual Machines (For Developers)

    Of course, you may use the same instructions to install Arches on both in-house or remoteservers. And, while this guide does not cover it, Arches can be installed across multiple machinesfor deployments that demand high fault tolerance.

    Option 1: Install Arches on a Windows Server

    Step 1: Download ArchesStart by getting a copy of the Arches code. You can always find the most up-to-date codebase at:https://bitbucket.org/arches/arches/get/default.zipCreate a folder called Arches on your computer and unzip the archive to this folder.

    Step 2: Install PostgreSQL 9.x, PostGIS 2.xDownload and install the latest version of PostgreSQL for Windows from:http://www.postgresql.org/download/.Notes:

    Select all the default options when installing and take special note of the password yousupply for the superuser (youll need this later)

    At the end of the install leave the checkbox checked to run Stack Builder (which youll useto install PostGIS) then click the Finish button

    In the Stack Builder drop-down menu, select the local Postgres database (something likePostgreSQL 9.2 on port 5432) then click Next

  • Step 1: Install Core Arches 19

    Expand the Spatial Extensions link and check the box for PostGIS. Click Next Select your download directory and click Next again Click Next to start the installation of PostGIS Select all the defaults until you get to the screen where it asks for your password. Type inthe password that you created earlier.

    Select Yes to register the GDAL_DATA environment variable ,unless you have itcurrently set to something else and you dont want to override it.

    Click Close and then Finish to complete the setup of Postgres with PostGIS

    To confirm that you have installed PostgreSQL, open a command window and type: psql. Youshould be prompted for a password. If so, then PostgreSQL is installed and you may close thecommand prompt.If you received an error like psql is not recognized as an internal or external command, operableprogram or batch file then you probably need to add an entry to your path.Assuming that your Postgres installation is in C:Program FilesPostgreSQL\9.x, add this to yourpath: C:Program FilesPostgreSQL\9.x\bin (Note: make sure to replace 9.x with your version ofPostgres)

    PostgreSQL WarningsIf you experience errors during the installation, please check that the setting stan-dard_conforming_strings in postgresql.conf is uncommented and set to off. See thisquestion on stackoverflow for more information.

    Step 3: Install GEOSDownload and install GEOS from http://trac.osgeo.org/osgeo4w/Notes:

    Make sure to select the x86 version for 32bit machines, or x86-64 for 64bit machines

    Step 4: Install Python 2.7Download Python at http://www.python.org/downloadNotes:

    Download the latest MSI Installer for version 2.7.x (Note: make sure to select the x86version for 32bit machines, or x86-64 for 64bit machines)

    Run the installer and select all the default options when prompted. Assuming that your Python installation is in C:Python27\, add this to your PATH:

  • Step 1: Install Core Arches 20

    C:\Python27\;C:\Python27\Scripts

    If you are unsure how to do this, look here: http://java.com/en/download/help/path.xml

    Python VersionsArches is only compatible with Python 2.7. Python 3.x is right out.

    Step 5: Install the latest Java Development Kit (JDK)Download and install the JDK fromhttp://www.oracle.com/technetwork/java/javase/downloads/index.htmlNotes:

    Select all the default options, except at the very end, uncheck the box that asks to installthe Ask.com toolbar.

    Right-click the My Computer icon on your desktop and select Properties to set theJAVA_HOME environment variable.

    Click the Advanced tab. Click the Environment Variables button. Under System Variables, click New. Enter the variable name as JAVA_HOME. Enter the variable value as the installation path for the Java Development Kit. (If youused the default path for the Java Development Kit during installation, use C:ProgramFilesJava\jdk1.7.0_25. This string should be your variable value.)

    Click OK. Click Apply Changes. Close any command window which was open before you made these changes, and open anew command window. There is no way to reload environment variables from an activecommand prompt. If the changes do not take effect even after reopening the commandwindow, restart Windows.

    Step 6: Install Web FrameworkOpen a command window and navigate to:

    arches/Install

    Then run the following bat file. This installs theDjangoweb framework (https://www.djangoproject.com/)and search engine (http://www.elasticsearch.org/) that Arches uses:

  • Step 1: Install Core Arches 21

    install.bat

    Once this bat file runs youll need to start the Django development server (hint: never use inproduction) and ElasticSearch search engine, by navigating to the root folder and running thefollowing bat file:

    cd ..runserver.bat

    Windowsmay automatically open 2 commandwindows as part of this step (if you double clickedrunserver.bat for example). Feel free to minimize these windows, but dont close them. Doing sowill stop your either your web server or search engine depending on which one you closed.

    Step 7: Install ArchesOpen a new command window, and navigate to:

    arches/build

    Run the following script to build Arches:

    build_core_arches.bat

    Database PasswordYou may be prompted for a password to the Arches database. The default password is:postgis. You can open Settings.py in the arches root folder to change the default archespassword, or to install Arches on to an existing instance of PostgreSQL/PostGIS.

    Next StepsYouve just completed the steps needed to install the core Arches application on your server. Butyoure not done yet! You still have the following steps to complete:

    Define the cultural heritage resources you want Arches to manage (see Step 2: LoadHeritage Resource Definitions)

    Define the controlled vocabularies that youll use to describe heritage (see Step 3: LoadControlled Vocabularies)

    (Optionally) Import data from a legacy system into Arches (see Step 4: Load Data intoArches)

    Configure the default settings for Arches (see Step 5: Configuring Arches)

  • Step 1: Install Core Arches 22

    Option 2: Install Arches on a Linux ServerThe following instructions were written with Ubuntu 12.04 LTS in mind. Other versions ofUbuntu or other Linux distributions might have some different steps, but the general outlineshould be similar. All instructions assume that they are entered through the terminal and thatthe user has root privileges.

    Step 1: Download ArchesNavigate to the Arches download page at https://bitbucket.org/arches/arches and click on thedownload link. Create a folder called Arches on your computer and unzip the archive to thisfolder.Or use the command line:

    sudo wget https://bitbucket.org/arches/arches/get/default.tar.gzsudo tar -xzf default.tar.gz

    After unzipping, rename Arches archive folder to Arches.

    Step 2: Install PostgreSQL/PostGISInstall PostgreSQL, PostGIS and the PostgreSQL development library (needed to compile thePython bindings). Start by getting the repositories:

    sudo apt-get update -ysudo apt-get install -y make python-software-propertiessudo add-apt-repository -y ppa:pitti/postgresqlsudo add-apt-repository -y ppa:sharpie/for-sciencesudo add-apt-repository -y ppa:sharpie/postgis-stablesudo add-apt-repository -y ppa:ubuntugis/ubuntugis-unstablesudo apt-get update -y

    Install the database:

    sudo apt-get install -y build-essential postgresql-9.2 postgresql-server-dev-9\.2 libxml2- dev libproj-dev libjson0-dev xsltproc docbook-xsl docbook-mathml\

    libgdal1-dev postgresql- contrib-9.2 postgresql-server-dev-9.2 libpq-dev

    sudo -u postgres psql -d postgres -c "ALTER USER postgres with encrypted passw\ord 'postgis';"

    sudo echo "*:*:*:postgres:postgis" >> ~/.pgpasssudo chmod 600 ~/.pgpass

    Configure the connection parameters:

  • Step 1: Install Core Arches 23

    cd ..cd ..sudo chmod 666 /etc/postgresql/9.2/main/postgresql.confsudo echo "standard_conforming_strings = off" >> /etc/postgresql/9.2/main/post\gresql.confsudo echo "listen_addresses = '*'" >> /etc/postgresql/9.2/main/postgresql.conf

    sudo chmod 666 /etc/postgresql/9.2/main/pg_hba.confsudo echo "#TYPE DATABASE USER CIDR-ADDRESS METHOD" >> /etc/postgresql/9.\2/main/pg_hba.conf

    sudo echo "local all all trust" >> /etc/postgresql/9.2\/main/pg_hba.conf

    sudo echo "host all all 127.0.0.1/32 trust" >> /etc/postgresql/9.2\/main/pg_hba.conf

    sudo echo "host all all ::1/128 trust" >> /etc/postgresql/9.2\/main/pg_hba.conf

    sudo echo "host all all 0.0.0.0/0 md5" >> /etc/postgresql/9.2/m\ain/pg_hba.conf

    sudo service postgresql restart

    Install the GEOS library:

    sudo wget http://download.osgeo.org/geos/geos-3.3.8.tar.bz2sudo tar xvfj geos-3.3.8.tar.bz2cd geos-3.3.8./configuremakesudo make installcd ..

    Get PostGIS:

  • Step 1: Install Core Arches 24

    sudo wget http://download.osgeo.org/postgis/source/postgis-2.0.3.tar.gzsudo tar xfvz postgis-2.0.3.tar.gzcd postgis-2.0.3./configuremakesudo make install

    sudo ldconfigsudo make comments-installsudo ln -sf /usr/share/postgresql-common/pg_wrapper /usr/local/bin/shp2pgsqlsudo ln -sf /usr/share/postgresql-common/pg_wrapper /usr/local/bin/pgsql2shpsudo ln -sf /usr/share/postgresql-common/pg_wrapper /usr/local/bin/raster2pgsqlcd ..

    sudo -u postgres psql -d postgres -c "CREATE EXTENSION postgis;"sudo -u postgres createdb -E UTF8 -T template0 --locale=en_US.utf8 template_po\stgis_20sudo -u postgres createlang -d template_postgis_20 plpgsqlsudo -u postgres psql -d postgres -c "UPDATE pg_database SET datistemplate='tr\ue' WHERE datname='template_postgis_20'"

    sudo -u postgres psql -d template_postgis_20 -f /usr/share/postgresql/9.2/cont\rib/postgis-2.0/postgis.sql

    sudo -u postgres psql -d template_postgis_20 -f /usr/share/postgresql/9.2/cont\rib/postgis-2.0/spatial_ref_sys.sql

    sudo -u postgres psql -d template_postgis_20 -f /usr/share/postgresql/9.2/cont\rib/postgis-2.0/rtpostgis.sql

    sudo -u postgres psql -d template_postgis_20 -c "GRANT ALL ON geometry_columns\TO PUBLIC;"sudo -u postgres psql -d template_postgis_20 -c "GRANT ALL ON geography_column\s TO PUBLIC;"

    sudo -u postgres psql -d template_postgis_20 -c "GRANT ALL ON spatial_ref_sys \TO PUBLIC;"sudo -u postgres createdb training -T template_postgis_20

    Get the latest JDK:

    sudo apt-get install -y openjdk-7-jdk python-setuptools python-dev

    Finally, install the PostGIS template database:

  • Step 1: Install Core Arches 25

    sudo -u postgres createdb -E UTF8 -T template_postgis_20 --locale=en_US.utf8 a\rches

    PostgreSQL WarningsIf you experience errors during the installation, please check that the settingstandard_conforming_strings in postgresql.conf is uncommented and set to off.See http://stackoverflow.com/questions/7667724/error-saving-geodjango-pointfield formore information.

    Step 3: Install Web FrameworkNavigate to:

    cd ./Install

    Then run the following script. This installs theDjangoweb framework (https://www.djangoproject.com/)and search engine (http://www.elasticsearch.org/) that Arches uses:

    ./install.sh

    Once this script runs youll need to start the Django development server (hint: never use inproduction) and ElasticSearch search engine, by navigating to the root folder and running thefollowing script:

    cd .../runserver.sh

    Step 4: Install and Build ArchesOpen a new terminal window, and navigate to:

    cd ./build

    Run the following script to build Arches:

    ./build_core_arches.sh

    Database PasswordYou may be prompted for a password to the Arches database. The default password is:postgis. You can open Settings.py in the arches root folder to change the default archespassword, or to install Arches on to an existing instance of PostgreSQL/PostGIS.

  • Step 1: Install Core Arches 26

    Next StepsYouve just completed the steps needed to install the core Arches application on your server. Butyoure not done yet! You still have the following steps to complete:

    Define the cultural heritage resources you want Arches to manage (see Step 2: LoadHeritage Resource Definitions)

    Define the controlled vocabularies that youll use to describe heritage (see Step 3: LoadControlled Vocabularies)

    (Optionally) Import data from a legacy system into Arches (see Step 4: Load Data intoArches)

    Configure the default settings for Arches (see Step 5: Configuring Arches)

    Option 3: Install Arches on a Vagrant Virtual MachineDevelopers may wish to install Arches using Vagrant. Vagrant ensures that all developers canwork on the same platform. And if you decide to use a local Mercurial client (like SourceTree),Vagrant will allow you to quickly test your code in a virtual environment.Check out http://www.vagrantup.com/ for more information.

    Step 1: Download ArchesStart by getting a copy of the Arches code. You can always find the most up-to-date codebase at:https://bitbucket.org/arches/arches/get/default.zipCreate a folder called Arches on your computer and unzip the archive to this folder.Or, consider using a local Mercurial client to manage the Arches codebase locally.

    Step 2: Install VagrantNavigate to http://www.vagrantup.com; download and install the Vagrant software for youroperating system (OS).

    Step 3: Install VirtualBoxVirtualBox is an open source Virtual Machine application.Navigate to https://www.virtualbox.org; download and install VirtualBox for your OS.

    Step 4: Download Virtual Machine FileOpen a command prompt and type the following command to download an empty Ubuntu server(version 12.04, 32-bit) VM file

  • Step 1: Install Core Arches 27

    vagrant box add precise32 \ http://files.vagrantup.com/precise32.box

    You can consult the Vagrant website if you prefer to use an alternate base OS for your ArchesVM.

    Pro Tip: Windows InstallationFor some versions of Windows you may get an error when running the vagrant boxadd command. Try running the command again, this time WITHOUT the / afterthe precise32. Check the latest vagrant documentation for additional troubleshootinghelp.

    Step 5: Build ArchesOpen a command prompt and navigate to the Arches folder:

    cd arches

    once youve navigated to your arches folder, type:

    vagrant init precise32 http://files.vagrantup.com/precise32.box

    then:

    vagrant up

    Pro Tip: Making Arches run with less than 2 GB ofRAMBefore you vagrant up, open this file: arches/Vagrantfile with a text editor. Scrolldown to vb.customize [modifyvm, :id, memory, 2048]. Replace the 2048 with1024, and Arches will only request 1GB of RAM.

    Vagrant will create a Virtual Machine with a complete Arches install, including all requiredsoftware dependencies, as well as a sample dataset ready for you to test Arches with.

    How long will it take to build Arches?Depending on your computer, it may take anywhere from 10 minutes to an hour or twoto build Arches.Youll know that Arches is ready when the command prompt returns.

    Step 6: Start ArchesAt the command prompt type:

  • Step 1: Install Core Arches 28

    vagrant ssh

    This commandwill log you onto your virtual Linux server. To start Arches, navigate to the Archesfolder in your virtual server. Run the Arches build script by typing the following command:

    ./runserver-vagrant.sh

    Windows Users: Get an ssh clientBecause Windows doesnt usually come with ssh, youll need to installa ssh client like PuTTY. See the Vagrant documentation (http://docs-v1.vagrantup.com/v1/docs/getting-started/ssh.html) for more information.

    Arches will start and be ready for use in just a moment or two. To access Arches, open a browser(note: Arches works with Firefox, Chrome, Safari, Opera, and Internet Explorer 10 or higher),and type:http://localhost:8000/Arches/index.htm#You should see the following screen:

    Arches Default Screen: Simple Search

    If you want to test adding or editing cultural heritage data in Arches, youll need to sign in. ClickMap in the upper right corner of the screen, then click

    Arches Sign In

  • Step 1: Install Core Arches 29

    The Username and Password are both admin (omit the quotes when entering the usernameand password).For more help in understanding the Arches app, check out the Arches User Guide to learn howto work with Arches.

    Using the test data-setAll test data supplied is for experimentation inArches only. The records are not certifiedfor accuracy or completeness.

    A Note on VagrantVagrant is a handy way to quickly set up a server for software testing.If you review the Vagrant documents, youll see that you can halt the Arches VM simply bytyping:

    vagrant halt

    Starting Arches again is a simple vagrant up command. You can completely remove Archesfrom your computer by typing:

    vagrant destroy

    While Vagrant is a great way to evaluate Arches, its not necessarily the way youd want todeploy Arches for a project. For one thing, we havent built-in a back-up of the Arches databasefor vagrant.So if you vagrant destroy your version of Arches, be prepared to lose any data that you mayhave entered. Dont worry though. You can always type vagrant up and get a pristine versionof Arches running again.

  • Step 2: Load Resource TypeDefinitionsIn this chapter youll learn that Arches manages cultural heritage data as resources, and youllunderstand how to install the resource files that you want to use to manage your data.

    What are Resources?Arches is designed to manage cultural heritage data anywhere in the world. Needless to say,thats an ambitious goal. After all, architecture considered culturally significant in San Francisco- a city founded in 1776 - might not merit much comment in Cairo or London.So, how does Arches resolve this?Arches requires you to define the set of Resource Types that youwish to include in your inventoryand the terms that you will use to describe them.

    What is an Arches Resource Type?In Arches, the term Resource Type refers to a class of cultural heritage records. Thingslike Architectural Heritage, Investigation Activity, and Person are all examples ofResource Types.Think of Resource Types as the categories of information that Archeswill manage.A Resource is simply one instance of a particular Resource Type.

    Resource Types are described following the CIDOC Conceptual Reference Model (CRM). TheCRM is an ontology for cultural heritage information that has been developed by a the Interna-tional Committee for Documentation (CIDOC) of the International Council of Museums. Archesuses the CRM because it was adopted by the International Organization for Standardization asthe standard (ISO 21127:2006) for the interchange of cultural heritage information.

    Arches Resource Type CategoriesBy default, Arches groups Resource Types into the following categories:

    Heritage Resources:Heritage Resources are archaeological, built, landscape, or other immovable cultural heritage. InArches, Heritage Resources include:

  • Step 2: Load Resource Type Definitions 31

    Archaeological Heritage (element)a single archaeological entity that could stand alone or be an element of a largerarchaeological group (e.g., a bath house within a Roman villa)

    Archaeological Heritage (site)an area of archaeological potential or an area of known or discovered archaeologicalelements

    Whats the difference between archaeological elements andsites?While conceptually these categories overlap, Arches differentiates between the twobecause of the way that they are represented using the CIDOC CRM.

    Architectural Heritageculturally significant buildings, structures, and groups thereof

    Landscape Heritageareas of land designed and created intentionally by man, such as garden and parklandlandscapes constructed for aesthetic reasons, organically evolved areas of land resultingfrom an initial social, economic, administrative, and/or religious imperative and that hasdeveloped its present form by association with and in response to its natural environment,or areas of land that are culturally significant due to powerful religious, artistic or culturalassociations of the natural element rather than material cultural evidence, which may beinsignificant or even absent (UNESCO)

    Maritime Heritageunderwater heritage (both under sea and inland), which may include heritage inundatedby sea level rise and dam construction, shipwrecks and aircraft, as well as heritage afloat(e.g., ships, sailing vessels)

    ActivitiesActivities are events or actions that may take place during a given time span and at a locationor area. In Arches, Activities include:

    Investigation Activityan activity undertaken with the explicit intention of gathering information about, andunderstanding of, a Heritage Resource, and the creation of an information source to recordthat information and understanding

    Management Activityan activity undertaken to prevent damage to, promote the survival of, and promote theunderstanding and appreciation of Heritage Resources.

  • Step 2: Load Resource Type Definitions 32

    Designation and Protection Activityan activity which implements or revokes statutory and non-statutory designation andprotection regimes which may apply to Heritage Resources

    Historical Eventany activity that took place in the past, including both human and natural events

    DocumentsDocuments are information carriers such as books, texts, periodicals, inscriptions, audio files,video files, 3-D models, or images. In Arches, Documents include:Document

    an information carrier, other than an Image, whether physical or digital, eg. books, maps,pdfs, word-processed documents

    Imagean information carrier that represent an external form, whether physical or digital, eg.photographs, slides, drawings, jpegs or tiff files

    ActorsActors refer to individuals or groups of people. In Arches, Actors include:Person

    real persons (i.e., who live or are assumed to have lived)Organization

    A group or legally identifiable body

    Creating Your Own Resource TypesYou may decide that Arches does not include a Resource Type that you need. If thats the case,you can create you own Resource Type definitions.Defining an Arches Resource Type requires you to build a graph of entities. Youll need theCIDOC CRM to define the set of entities, their relationships, and any controlled vocabulariesnecessary to describe your custom Resource Type.Take a look at one of Arches default Resource Type definition files, such as ArchitecturalHeritage, to see what a Resource Type definition looks like. You can find those files at:

    arches/db/ETL/CDS Package/Mappings

    You can view a Resource Type graph using a tool such as Gephi. Or you can just create a file ofnodes and a file of edges to define a resource.Creating your own Resource Type definitions requires that you are comfortable with usingthe CIDOC CRM, and that you have a good working knowledge of how to define thesauri.Consequently, defining your own resource is an advanced topic, and you may wish to checkwww.archesproject.org site for additional guidance.

  • Step 2: Load Resource Type Definitions 33

    Loading ResourcesAlthough Arches provides a suite of Resource Type definitions, you are not required to use themall. Before you can start creating andmanaging cultural heritage data, youll need to decidewhichResource Types you want to use and then load the corresponding Resource Type definitions intoArches.

    Step 1: Select Resources to LoadNavigate to the arches directory and open:

    settings.py

    Scroll down until you find the LIMIT_ENTITIES_TO_LOAD parameter:

    Settings.py: Simple Search

    By default, Arches loads all 13 Resource Type definitions (hence the limit to load is None).You can define the specific definitions to load by providing a comma-delimited listing of just theresources you want to manage:

    LIMIT_ENTITY_TYPES_TO_LOAD = ('ARCHAEOLOGICAL HERITAGE (ARTIFACT).E18', 'LANDS\CAPE HERITAGE.E27)

    This would limit Arches to just loading the definitions for the Archaeological Heritage element)and Landscape Heritage types.

    Tip: Resource Type NamesUse the following following formal names to identify the Resource Types you wish toload into Arches:

  • Step 2: Load Resource Type Definitions 34

    ARCHAEOLOGICAL HERITAGE (ARTIFACT).E18ARCHAEOLOGICAL HERITAGE (SITE).E27ARCHITECTURAL HERITAGE.E18LANDSCAPE HERITAGE.E27MARITIME HERITAGE.E18INVESTIGATION.E7MANAGEMENT.E7DESIGNATION AND PROTECTION.E7HISTORICAL EVENT.E5DOCUMENT.E31IMAGE.E38PERSON.E21ORGANIZATION.E74

    Step 2: Load Resource Type DefinitionsOpen a terminal and navigate to the following folder:

    db/ETL/CDS Package

    and run the following script:

    install_package.bat (./install_package.sh for Linux)

    Arches will install the set of Resource Types that youve defined.

    Next StepsYouve just completed one of the most important installation steps: deciding which culturalheritage Resource Tsypes you will be managing.The next step in installing Arches is to decide which controlled vocabularies you will use todescribe your cultural heritage resources. Turn to Step 3: Load Controlled Vocabularies.

  • Step 3: Load Controlled VocabulariesIn this chapter youll learn how to configure the drop-down lists Arches uses to support consistentand valid cultural heritage data entry.

    What are Controlled Vocabularies?Like any good data-editing tool, Arches supports consistent and valid data entry. Almost everyone is familiar with this concept: its the ability to select a valid value from a list:

    Selecting a value from a Controlled Vocabulary

    Notice that in this Arches data entry form, youre able to select the kind of ArchaeologicalHeritage Element from among the list of approved types or classifications. In Arches, these listsare called controlled vocabularies.But what if you want to use a particular list of period names, instead of the names that comewith Arches? Arches allows you to define exactly the set of names you want to use for everyresource.

    ThesauriSo, why do we use the term controlled vocabulary if all were doing is selecting values from adrop-down list? The answer is that Arches treats each drop-down list as if its a thesaurus.

  • Step 3: Load Controlled Vocabularies 36

    And whats so special about thesauri? They provide a potent way organize concepts and aconvenient way to attach labels to concepts. This makes data entry and searching a large databasefor specific resources much easier.Lets say we want to create a list of dwellings where people live as a drop-down list in Arches.Our list might look like this:

    dwellingapartmenthousehutlog cabin

    The thesaurus allows you to define concepts and give them labels. For example, dwelling is thelabel associated with the concept of a place where people live.Note also that each concept under dwelling is a more precise (or narrower) type of dwelling.In this example, there are four additional narrower concepts of dwelling. One such concept (eg.:a place where families live) has the term house associated with it.This ability to build hierarchies of concepts makes thesauri very powerful. We can use thestructure of a thesaurus to help make clear the relationships between concepts.But wait just a moment. We know that in some areas, people use different terms to mean thesame thing. A thesaurus allows us to attach many labels to the same concept. For example:

    dwellingsapartmenthouse [aisled house, bungalow, chalet]hutlog cabin

    This is a representation that adds more, alternate labels for the concept house. In this example,the labels aisled house, bungalow, and chalet all represent alternate labels for the sameconcept. Note that we could add Haus and maison if we wanted to include labels for thesame concept in additional languages such as German or French.Its up to you to decide how you want to organize your terms. Is a chalet really an alternatelabel for house, or should it be considered a narrower concept of dwelling?At this point you may be wondering why weve made a simple drop-down list so complicated.Well, by using thesauri to power the drop-down lists, Arches will know that when you searchfor a resource using the term chalet you really mean house. And if you search for a resourceusing the term dwelling, youll get all the narrower concepts for dwelling, even if you didntknow that a hut a dwelling.

  • Step 3: Load Controlled Vocabularies 37

    Default Authority DocumentsRecall from the last chapter that Arches includes 13 Resource Types grouped into four categories.And each resource has a set of attributes associated with it. Arches comes with a default setof controlled vocabularies and automatically matches each vocabulary with the appropriateresource attribute.Arches the term Authority Documents is used to denote the files that hold the concepts,preferred label, alternate labels, and parent concept (to support hierarchies of concepts) for eachdrop-down list. Some Authority Documents are common to all Resource Types, while others areparticular to specific categories of Resource Types. Here is a list of all of them:Authority Documents common to all Resource Types:

    ABSOLUTE AND SCIENTIFIC DATING METHOD AUTHORITY DOCUMENT.E32.csvADMINISTRATIVE SUBDIVISION AUTHORITY DOCUMENT.E32.csvADMINISTRATIVE SUBDIVISION AUTHORITY DOCUMENT.E32.values.csvADMINISTRATIVE SUBDIVISION TYPE AUTHORITY DOCUMENT.E32.csvARCHES RESOURCE CROSS-REFERENCE RELATIONSHIP TYPE AUTHORITY DOCUMENT.E32.csvARCHES RESOURCE CROSS-REFERENCE RELATIONSHIP TYPE AUTHORITY DOCUMENT.E32.value\s.csvCONDITION AUTHORITY DOCUMENT.E32.csvCONDITION AUTHORITY DOCUMENT.E32.values.csvCULTURAL PERIOD AUTHORITY DOCUMENT.E32.csvCULTURAL PERIOD AUTHORITY DOCUMENT.E32.values.csvDESIGNATION AND PROTECTION TYPE AUTHORITY DOCUMENT.E32.csvEXTERNAL XREF TYPE AUTHORITY DOCUMENT.E32.csvGEOMETRY QUALIFIER AUTHORITY DOCUMENT.E32.csvMATERIAL AUTHORITY DOCUMENT.E32.csvMEASUREMENT TYPE AUTHORITY DOCUMENT.E32.csvNAME TYPE AUTHORITY DOCUMENT.E32.csvSUBJECT AUTHORITY DOCUMENT.E32.csvTYPE OF DESIGNATION OR PROTECTION AUTHORITY DOCUMENT.E32.csvTYPE OF DESIGNATION OR PROTECTION AUTHORITY DOCUMENT.E32.values.csvUNIT OF MEASUREMENT AUTHORITY DOCUMENT.E32.csvUNIT OF MEASUREMENT AUTHORITY DOCUMENT.E32.values.csv

    Archaeological Heritage Authority Documents:

    ARCHAEOLOGICAL COMPONENT TYPE AUTHORITY DOCUMENT.E32.csvARCHAEOLOGICAL HERITAGE (ARTIFACT) TYPE AUTHORITY DOCUMENT.E32.csvARCHAEOLOGICAL HERITAGE (SITE) TYPE AUTHORITY DOCUMENT.E32.csvARCHAEOLOGICAL TECHNIQUE AUTHORITY DOCUMENT.E32.csv

    Architectural Heritage Authority Documents:

  • Step 3: Load Controlled Vocabularies 38

    ARCHITECTURAL COMPONENT TYPE AUTHORITY DOCUMENT.E32.csvARCHITECTURAL HERITAGE TYPE AUTHORITY DOCUMENT.E32.csvARCHITECTURAL TECHNIQUE AUTHORITY DOCUMENT.E32.csv

    Landscape Heritage Authority Documents:

    LANDSCAPE COMPONENT TYPE AUTHORITY DOCUMENT.E32.csvLANDSCAPE HERITAGE TYPE AUTHORITY DOCUMENT.E32.csvLANDSCAPE TECHNIQUE AUTHORITY DOCUMENT.E32.csv

    Maritime Heritage Authority Documents:

    MARITIME COMPONENT TYPE AUTHORITY DOCUMENT.E32.csvMARITIME HERITAGE TYPE AUTHORITY DOCUMENT.E32.csvMARITIME TECHNIQUE AUTHORITY DOCUMENT.E32.csv

    Investigation Activity Authority Document:

    INVESTIGATION TYPE AUTHORITY DOCUMENT.E32.csv

    Management Activity Authority Document:

    MANAGEMENT TYPE AUTHORITY DOCUMENT.E32.csv

    Historical Event Authority Document:

    HISTORICAL EVENT TYPE AUTHORITY DOCUMENT.E32.csv

    Document Authority Document:

    DOCUMENT COMPONENT TYPE AUTHORITY DOCUMENT.E32.csvDOCUMENT TECHNIQUE AUTHORITY DOCUMENT.E32.csvDOCUMENT TYPE AUTHORITY DOCUMENT.E32.csv

    Image Authority Documents:

    IMAGE COMPONENT TYPE AUTHORITY DOCUMENT.E32.csvIMAGE MATERIAL AUTHORITY DOCUMENT.E32.csvIMAGE TECHNIQUE AUTHORITY DOCUMENT.E32.csvIMAGE TYPE AUTHORITY DOCUMENT.E32.csv

    Person Authority Document:

  • Step 3: Load Controlled Vocabularies 39

    TITLE AUTHORITY DOCUMENT.E32.csv

    You can find all the Authority Documents in the following folder:

    arches/db/ETL/Logical Concept Model/Authority Files

    Whats up with all the .E Numbers?Resource Types, attributes, and all other entities in Arches are instances of CIDOCCRM classes. The CRM uses a E.xx naming style to define its classes, so we appendthe CRM class identifier to our Arches entities so that its clear what each Arches entityactually represents.

    Understanding the Structure of an AuthorityDocumentYou will have noticed that most of the controlled vocabularies in Arches have the wordsAuthority Document.E32 as part of their file name. This is to make it clear that Archesimplements controlled vocabularies in a way that is consistent with the CIDOC CRM.Lets look at an authority document in more detail:

    ARCHITECTURAL HERITAGE TYPE AUTHORITY DOCUMENT.E32

    This authority document holds the list of Architectural Heritage types that Arches will use. Typesare just what youd guess: a list of the kinds of Architectural Heritage that you will allow peopleto choose from when they enter a new Architectural Heritage resource to Arches.Your ARCHITECTURAL HERITAGE TYPE Authority Document can contain any entries thatyou think are appropriate. Here are some examples:

    Air Raid SirenChurchHouseChaletFountainStreet Lamp

    Adding these concepts to Arches will require you to update the Architectural Heritage authoritydocument. The good news is that all Arches authority files are simple text files with the following5 columns:

    ConceptIDa unique identifier for the concept

  • Step 3: Load Controlled Vocabularies 40

    PrefLabelthe default label that you wish to use for this concept

    AltLabelsalternative ways to identify the concept

    Parent ConceptIDthe unique identifier of a broader concept (this will construct hierarchies)

    Provideridentifies the source of the concept

    Building an authority document is just a matter of adding a row for every concept that you wantto include in your Arches drop down lists. In our example, the authority document might looklike this:

    ConceptID PrefLabel AltLabels ParentConceptID

    Provider

    1 Air Raid Siren EH2 Church House of

    WorshipEH

    3 House EH4 Chalet 3 EH5 Fountain fount;jet;spout EH6 Street Lamp EH

    Notice that in one line, we can add a concept, define its preferred label, optionally providealternate labels, and define broader/narrower relationships between concepts.There are a few things to be aware of:

    ConceptIDs must be unique!Make sure that you use a truly unique identifier for each record that you want to loadinto Arches.

    Use a semicolon to separate more than oneAlternate LabelsCommas are used to separate columns, so we need a different way to indicate all thedifferent alternate labels for a concept

    Narrower TermsUse the ConceptID of the broader term in the Parent ConceptID field if you want totell Arches that concepts are related. Arches will use this information tomake searchingthe inventory better and more intuitive.

  • Step 3: Load Controlled Vocabularies 41

    Required TermsArches has only one required term: The term Primary is required to appear in NAMETYPE AUTHORITY DOCUMENT.E32. Why? Because Arches supports multiple namesfor any resource, it needs a way to define the preferred name for a resource.

    Understanding Authority Document ValuesYou might have noticed that a few Authority Documents seem to come in pairs. For example:

    CULTURAL PERIOD AUTHORITY DOCUMENT.E32.csvCULTURAL PERIOD AUTHORITY DOCUMENT.E32.values.csv

    Whats going on here? Sometimes its convenient to know a bit more about some of the conceptsin a thesaurus than just a set of labels and its parent. For example, when discussing specificcultural periods (such as Middle Paleolithic), its often useful to reference the start and endyears of the period.Arches values files let us do this. OpenCULTURAL PERIODAUTHORITYDOCUMENT.E32.values.csvand youll see the following:

    Cultural Period Values

    Note the first row in this file: conceptid, Value, Value Type, ProviderThese headers define a simple structure of the value file. You simply have to reference a conceptIDfrom the CULTURAL PERIOD AUTHORITY DOCUMENT.E32.csv file, provide the value andits type, and the provider of the value.For cultural periods, the values file allows you to attach the start year and end year for each Periodconcept in the CULTURAL PERIOD AUTHORITY DOCUMENT.E32.csv file. Look at lines 7 and9 in the image above and you will see:

  • Step 3: Load Controlled Vocabularies 42

    7 PERIOD_UID:55, -150000, minimum date, EH9 PERIOD_UID:55, -40000, maximum date, EH

    If you look up PERIOD_UID:55 in CULTURAL PERIOD AUTHORITY DOCUMENT.E32.csv,youll see that its record is:

    PERIOD_UID:55,MIDDLE PALAEOLITHIC,,PERIOD_UID:5,EH

    So, the Arches default list of Cultural Periods includes the Middle Palaeolithic (as PE-RIOD_UID:55 in CULTURAL PERIOD AUTHORITY DOCUMENT.E32.csv), and that periodis defined to start at -150,000 years (row 7 in CULTURAL PERIOD AUTHORITY DOCU-MENT.E32.values.csv) and end at -40,000 years (row 9 in the same file).

    What Value Types Can I Define?You can define any set of key/value pairs that you wish. Arches will load your values andassociate them with the concept identifier that you provide.By default, Arches defines values for the following Authority Document value files:

    ADMINISTRATIVE SUBDIVISION AUTHORITY DOCUMENT.E32.values.csvARCHES RESOURCE CROSS-REFERENCE RELATIONSHIP TYPE AUTHORITY DOCUMENT.E32.value\s.csvCONDITION AUTHORITY DOCUMENT.E32.values.csvCULTURAL PERIOD AUTHORITY DOCUMENT.E32.values.csvTYPE OF DESIGNATION OR PROTECTION AUTHORITY DOCUMENT.E32.values.csvUNIT OF MEASUREMENT AUTHORITY DOCUMENT.E32.values.csv

    If you look at these files, youll see that Arches already knows how to handle the following valuetypes:SortOrderYou can use the *.values.csv file to define the order in which terms appear for:

    UNIT OF MEASUREMENT AUTHORITY DOCUMENT.E32.csvTYPE OF DESIGNATION OR PROTECTION AUTHORITY DOCUMENT.E32csvCONDITION AUTHORITY DOCUMENT.E32.csv

    Minimum Date, Maximum DateYou can use the *.values.csv file to define the starting and ending dates for:

    CULTURAL PERIOD AUTHORITY DOCUMENT.E32.values.csv

    Geometry, Administrative Area TypeYou can use the ADMINISTRATIVE SUBDIVISION AUTHORITY DOCUMENT.E32.values.csvfile to define administrative subdivision types and the geometry associated with each adminis-trative area. For example:

  • Step 3: Load Controlled Vocabularies 43

    LOC_UID:97317,PARISH,admin area type filter,EH

    would define the concept LOC_UID:97317 (in the ADMINISTRATIVE SUBDIVISIONAUTHOR-ITY DOCUMENT.E32.csv file) as an admin area type filter with a value of PARISH. AndLOC_UID:97345,"POLYGON((-1.32078640715254 54.3728610449506,-1.33713112471483 5\4.3586411276027,-1.3584180849332 54.371070777731,-1.34399265906457 54.37671018\0739,-1.32078640715254 54.3728610449506))",geometry,EH

    would define the concept LOC_UID:97345 (in the ADMINISTRATIVE SUBDIVISIONAUTHOR-ITY DOCUMENT.E32.csv file) as having a geometry with a set of particular coordinates thatmake up a polygon.Resource Cross-Reference, Cross-Reference Type Filter Arches allows you to build relation-ships between resources. For example, you can relate a Person resource to an ArchitecturalHeritage resource. Arches implements an Authority File that allows you to define the typesrelationships between resources.ARCHES RESOURCE CROSS-REFERENCE RELATIONSHIP TYPE AUTHORITY DOCUMENT.E32

    Custom Key/Values PairsArches will allow you to load any set of key/value pairs, treating the information that you loadas descriptive data about the concept.If you want to use your key/value pairs to support data entry (like the from/to dates for CulturalPeriods), you may need to extend the Arches codebase he codebase to use your key/value pairs.

    Modifying the Default Authority FilesArches comes with a set of concepts and labels for each controlled vocabulary. Of course, youare welcome to use the Arches defaults but youll probably want to use your own concepts andterms.To modify the default authority files, just open an authority document with a text editor andbegin. You can remove records from a file, or add new records that better represent the concepts,labels, and concept-relationships that you use to describe cultural heritage.

    Back up the original Authority Documents First!Its a good idea to make copies of the original files, just in case you want to go backand confirm that your edits make sense.

    Dont Forget about the values Files!If you change an Authority Document that has an associated values file, youll wantto make sure that the conceptIDs match between the Authority Document and thecorresponding value file. By the way, Arches will work without any values files.Theyre just a convenient way to augment Authority Documents.

  • Step 3: Load Controlled Vocabularies 44

    Loading the Controlled VocabulariesOnce youve finished editing the authority files youll need to load them into Arches.Open a terminal and navigate to the following folder:

    db/ETL/CDS Package

    and run the following script:

    load_concepts.bat (./load_concepts.sh for Linux)

    Database PasswordYou may be prompted for a password to the Arches database. The default password is:postgis. You can open Settings.py in the arches root folder to change the default archespassword, or to install Arches on to an existing instance of PostgreSQL/PostGIS.

    Arches will load and index each concept that youve defined, as well as their labels and anyhierarchical relationships that you may have defined.Depending on the size and complexity of your controlled vocabularies, Arches may takeanywhere from a few minutes to a few hours to process your data.

    Next StepsYouve now completed an important installation step: defining and loading the controlledvocabularies that will populate the drop-down lists your data editors will use to create and editcultural heritage data.If you wish to load data from a database or spreadsheet, proceed to Step 4: (Optional) Load Datainto Arches. Otherwise, you may complete the Arches installation procedure by proceeding toStep 5: Configuring Arches.

  • Step 4 (optional): Load Data intoArchesIn this chapter youll learn how to create a file that will allow you to bulk load data into Arches.You may skip this chapter if you dont have cultural heritage data, or if you dont want to importdata into Arches.Remember: Arches provides a simple yet powerful web interface to let you enter and edit dataif you prefer to skip this chapter.

    Resources and Their AttributesAs youve seen, Arches comes with the following 13 Resource Types:

    Heritage Resources Archaeological Heritage (element) Archaeological Heritage (site) Architectural Heritage Landscape Heritage Maritime Heritage

    Activities Investigation activity Management activity Designation and protection activity Historical event

    Documents Document Image

    Actors Person Organization

    Each of these Resource Types has a set of attributes. Attributes are really just pieces ofinformation about each resource. For example, one of the Attributes of the ArchaeologicalHeritage (Element) resource is its cultural period. In the Arches user interface, Attributesare organized into Information Themes. See the companion Arches User Guide for moreinformation on the user interface.Some attributes are common to many Resource Types. Name is a good example, which iscommon to all Resource Types. Every resource can have a name associatedwith it. Most ResourceTypes have quite a few attributes.

  • Step 4 (optional): Load Data into Arches 46

    Why do I need to know about attributes?If you already have heritage data in a database or spreadsheet, you can build a file thatwill let you import your data into Arches. And to do this, you need to know exactlywhich attributes each Arches resource has.

    To see exactly which attributes are associated with a resource, open the this file:

    Arches/db/ETL/CDS Package/Mappings/CDS attributes.csv

    Here are the first few records of CDS attributes.csv:

    Resources Attributes.txt

    Each line in this file simply states that an Arches resource has an attribute that is associated withit. Notice the three columns:ResourceType: The Arches Resource Type of the Resource AttributeName: The attributeassociated with the Resource TypeAuthorityDocument: If this column is populated, then the attribute value must be a uniqueidentifier found in the authority file that is named in this column.You can think of the Resource Attributes.txt file as a listing of the set of data that you can loadinto Arches.

    Whats up with all the .E Numbers?Resources, attributes, and all other entities in Arches are instances of CIDOC CRMclasses. The CRM uses a E.xx naming style to define its classes, so we append theCRM class identifier to our Arches entities so that its clear what each Arches entityactually represents.

    Creating a Data Load FileArches comes with a file that you can use to load information into Arches. The is located at:

  • Step 4 (optional): Load Data into Arches 47

    Arches/db/ETL/resource_info.csv

    Arches reads the content of resource_info.csv and loads it into a database. If you open this file,youll see that it already contains data for a set of heritage resources. Youll need to replace theinformation in this file with your own data if you want to automatically populate Arches withdata.By the way, dont let the file name fool you, resource_info.csv is a | delimited file (a pipedelimited file) that illustrates the structure of a valid Arches import file.

    Why use a | instead of commas?The Arches import file allows you to include text blocks (so that you can import freetext). Text often includes commas, but rarely includes a |. So we use the | character todistinguish columns in the resource_info.csv file.

    Here are some representative records from a load file:

    Resource_Info.csv

    And heres how to understand whats going on: Each line in the file defines a resource and anattribute to load into Arches. Each of the column headers RESOURCEID, RESOURCETYPE,ATTRIBUTENAME, ATTRIBUTEVALUE, and GROUPID define the content of the file. Mostare self-explanatory, with the exception of the GROUPID field (which well look at in moredetail later).Lets look at line 1:

    15897|ARCHITECTURAL HERITAGE.E18|COMPILER.E82|ROD FITZGERALD|COMPILER.E82-0

    This record tells Arches that:

    Were going to load information about an ARCHITECTURAL HERITAGE.E18 resource(RESOURCETYPE)

  • Step 4 (optional): Load Data into Arches 48

    Our resource can be uniquely identified by the string 15897 (RESOURCEID) Were going to load a value for the COMPILER.E82 attribute (ATTRIBUTENAME) The value of the Compiler.E82 attribute is ROD FITZGERALD (ATTRIBUTEVALUE) This record is part of a group of records identified as COMPILER.E82-0 (GROUPID)

    Notice that we can import lots of information about a single resource simply by referencing thesame RESOURCEID and RESOURCETYPE.

    Adding Multiple Values to an AttributeWhy all this formalism and complexity?Because many cultural heritage objects have more than value for a given attribute. For example,a single resource can often have many names. Or the characteristics of a resource may changeover time. Without allowing for multiple values for an attribute, Arches wouldnt be able to trackthe evolution of a resource.So, the Arches data import file structure is important because many resource attributes mayhave multiple values. Indeed, an Architectural Heritage resource may be associated with severalcultural periods, have many addresses, and have several protection grades.Thats why Arches allows you load many attribute values for a single resource attribute.Notice in the file shown that we can add several compilers into Arches for the same resource. Infact, lines 3, 4, and 5 also define compilation records. In general, Arches will allow you to addmultiple values for a given attribute.

    Single AttributesAt present, Arches user interface can show multiple values for all entities except forthe Summary Description, Distinguishing Features, and Location Description entities.

    Attribute GoupsNow look at lines 8 through 11 in the example file.Individually, each row assigns a value for a specific attribute. The FROM DATE.E49 and TODATE.E49 attributes are years. Line 8 seems to be describing a Cultural Period, and Line 10 theArchitectural Resource type.But notice that each record in rows 8 through 11 all share the same PHASETYPEASSIGNMENT.E17-0 GROUPID. This means that these 4 records together describe a resource.By grouping these rows together with the same GROUPID, you can tell Arches that these 4records are not independent; rather together they describe the resource.Heres how to interpret whats going on. Each of the records starts with:

  • Step 4 (optional): Load Data into Arches 49

    15897|ARCHITECTURAL HERITAGE.E18

    This means that each record contains information about the Architectural Heritage.E18 Resourcewith the unique identifier of 15897. Okay, lets focus on what comes next:

    8 CULTURAL PERIOD.E55|PERIOD_UID:28|PHASE TYPE ASSIGNMENT.E17-09 FROM DATE.E49|1066|PHASE TYPE ASSIGNMENT.E17-010 ARCHITECTURAL HERITAGE TYPE.E55|AH:THE_TE_UID:68841|PHASE TYPE ASSIGNMENT.\E17-011 TO DATE.E49|1540|PHASE TYPE ASSIGNMENT.E17-0

    Look at line 8. Its ATTRIBUTENAME is CULTURAL PERIOD.E55, and the value of thisattribute is PERIOD_UID:28. Recall from the Chapter Step 3: Load Controlled Vocabular-ies that we use an Authority Document for Cultural Periods. So, the ATTRIBUTEVALUEPERIOD_UID:28 in line 8 is a pointer to a concept in CULTURAL PERIOD AUTHORITYDOCUMENT.E32.csv (which works out to Medieval).OK, now look at line 9. Its ATTRIBUTENAME is FROM DATE.E49 and its ATTRIBUTE-VALUE is 1066. Simple enough: from date is the year 1066.Line 10 tells Arches to use the unique identifier AH:THE_TE_UID:68841 in ARCHITECTURALHERITAGE TYPE AUTHORITY DOCUMENT.E32.csv to define the value for ARCHITEC-TURAL HERITAGE TYPE.E55 (a Motte), and line 11 says that the resource has a TODATE.E49 value of 1540.And heres the payoff: by giving these 4 records the sameGROUPID, we are telling Arches that:

    The ARCHITECTURAL HERITAGE.E18 resource with unique identifier of 15897was a Motte during the Medieval cultural period, specifically between the years1066 and 1540.

    Recall that Arches will support many combinations of cultural period, heritage type, and from/todates for a single resource.Now, we can understand that the purpose of the GROUPID is to allow for grouping a set ofrelated attributes into a coherent record.The actual values that you use forGROUPID are arbitrary, just make sure that you use a uniquevalue for each set of attributes that you want to group.

    Required DataBy design, Arches can accommodate a wide variety of data. The only real datarequirement is this: If you want to name a resource, you must provide one namewith a NAME TYPE.E55 of Primary. Because you can give a resource as manynames as you want, Arches uses the Primary designation to identify the preferredname of the resource.

  • Step 4 (optional): Load Data into Arches 50

    Which Attributes can be Grouped?Not all attributes can (or should) be grouped together. Based on the Core Data Standard forArchaeological and Architectural Heritage (introduced in the Deploying Arches chapter),Arches allows for the following attributes to be grouped:

    NAME.E41 and NAME TYPE.E55 SPATIAL COORDINATES_GEOMETRY.E47 and SPATIAL COORDINATES QUALI-FIER

    Any combination of attributes starting with ADRESS_ Any combination of PERIOD AUTHORITY DOCUMENT.E32, FROM DATE.E49, TODATE.E49, and HERITAGE RESOURCE TYPE AUTHORITY DOCUMENT.E32 (e.g.:Archaeological Heritage (Element), Archaeological Heritage (Site), Architectural Heritage,Landscape Heritage, Maritime Heritgae)

    Loading the Data FileOnce youve prepared your data load file, you may insert its contents into Arches. Be sure toconfirm that you are referencing your Authority Documents properly (e.g.: the unique ID youuse in your load file should also exist in the appropriate Authority Document).Open a terminal and navigate to the following folder:

    db/ETL/CDS Package

    and run the following script:

    load_test_data.bat (./load_test_data.sh for Linux)

    Test Data?Dont let the name of this script fool you; it really does load your production data. Thescripts name comes from the fact that we use it to load the default (e.g.: test) datasetthat comes with Arches.

    Arches will load and index each of the cultural heritage data records that youve defined in yourload file. Dont worry if it takes a few attempts to get your data to load cleanly. You can alwaysre-run the Arches build scripts to get a pristine instance of Arches.

    Next StepsCongratulations, youre almost done! You just need to complete the final few Arches configura-tion steps summarized in Step 5: Configuring Arches.

  • Step 5: Running and ConfiguringArchesIn this chapter youll learn how to define important configuration settings and define useraccounts. You will have the ability to customize Arches, but also the potential to alter theapplication in profound ways. Make sure that you back-up all the default settings before youcommit your changes!

    Running ArchesStarting Arches is easy: you just have to make sure that you run the runserver command in theArches root folder. Stopping Arches is also easy: just press Control-C in the terminal windowthat you used to start Arches.By default, users can log onto Arches (from the host server) with the following URL:

    http://localhost:8000/Arches/index.htm#

    You may wish to configure your web server to support access for users from client machines andthe internet. This will require you to replace the localhost:8000 part of the URL with a domainor IP address.Based on the resources (RAM, storage, CPU(s)) of the server that youve installed Arches on, youmay wish to tune how you allocate memory to PostgreSQL (the underlying Arches database)and your web server (e.g.: Apache or IIS). You can find guidance on these topics by visiting thePostgreSQL, Microsoft, or Linux web sites.

    Arches ConfigurationArches is really two applications in one:

    A map-based cultural heritage data management tool A searchable online inventory of cultural heritage

    Before you start using Arches, youll probably need to update a few configuration settings.Perhaps the most important of these settings are:

    Managing user accounts Updating default map settings (mapConfig)

  • Step 5: Running and Configuring Arches 52

    Managing basemaps and GIS layers Managing resource layers

    Arches implements Django, a high-level Python Web framework that supports rapid androbust application development. One of several nice features that Django offers is a simpleAdministration Console.Arches can be configured using the Django Administration Console. You may access the consoleby typing:

    http://localhost:8000/admin

    Be sure to replace localhost:8000 with the domain name or IP address of the server hostingyour version of Arches.Next, youll need to log in. Arches comes with the following default account:

    user: adminpassword: admin

    Change the default admin password!Its too easy for someone to guess this password! See the section on managing useraccounts and change the default password for this account as soon as possible!

    Once youve signed in to the Django Administration Console, you should see a screen that lookssomething like this:

    Djangos Site Administration Console

    This interface will let you Manage users, define the state of the map display in Arches, configureresources for display, and add GIS maps to Arches.

    Managing User AccountsArches implements a simple user access model with the following 3 tiers of users:

  • Step 5: Running and Configuring Arches 53

    Guests Editors Administrators

    Guests can access Arches and view information (either via the search screens or through theMap screen) without having to sign on to the system.Editors require a user account to add, edit, or delete data.Administrators may configure Arches and manage users.

    Updating the Default Administrator PasswordArches automatically creates a single Administrator account with the following credentials:

    user: adminpassword: admin

    You will definitely want to change the default password. To do so, log in and click the Changepassword link at the upper right. Youll be prompted to type in your current password (adminin this case), as well as a new password.Click the Change my password button when youre done (and be sure that you dont forgetyour new password!).

    Adding a New Editor AccountFrom the Django Administration Console, simply click the Add button next to Users. Youllsee a screen that looks something like this:

    New User Input Form

    Add the Username and Password for the user account, then click the Save button. Djangowill confirm that you are adding a unique user name and valid password. If so, youll see thefollowing screen:

  • Step 5: Running and Configuring Arches 54

    New User Detais

    At this point, you can click the Save button at the bottom of the form to create a user accountwith data-editing privileges.

    Optional User InformationThe Change user screen allows you to add additional information about the user,such as name and e-mail address. You may optionally also grant specific administrativepermissions to this account in the User permissions section of the screen. Arches onlyrequires a unique username and valid password to create an Editor account.

    Feel free to explore the User adminstration functions available in the Django Console. Youll seethat it provides a suite of easy-to-use tools for managing your Arches users.One thing to note: the Django Administrator Console allows you to define Groups. As ofSeptember 2013, Arches does not recognize Django Groups for authentication.

    Setting Default Map SettingsNow that you have Arches running, youll probably want to configure Arches for your particulargeographic area of interest. You do this by defining the map center point and initial zoom scalethat you want Arches to use.From the main Django Administration Console, Click App configs and then select mapConfigto access the configuration settings for the map display in Arches display. You should see thefollowing screen:

  • Step 5: Running and Configuring Arches 55

    mapConfig

    Notice that this page lists the variable (Name: mapConfig), its Defaultvalue, Datatype, andassociated Notes. Were most interested in the Defaultvalue:

    {maxExtent: new OpenLayers.Bounds(-200000, -200000, 200000, 200000),center: new OpenLayers.LonLat(-224149.03751366, 6978966.6705368),zoom: 6,numZoomLevels: 19,minZoomLevel: 1,fallThrough: false,controls: [new OpenLayers