Arches Documentation Release 5.2.0 Farallon Geographics, Legion GIS, Coherit Associates Aug 05, 2021 INTRODUCTION 1 Overview 1 1.1 What is Arches?.............................................1 1.2 Who is Arches for?............................................2 1.3 Documentation Overview........................................2 1.4 Contributing To Arches.........................................2 2 Arches Release Process 3 2.1 Feature Releases.............................................3 2.2 Patch Releases..............................................3 2.3 Release Support.............................................3 3 Requirements/Dependencies 5 3.1 System Requirements..........................................5 3.2 Software Dependencies.........................................5 4 Installing Core Arches 7 4.1 Create a Virtual Environment......................................7 4.2 Install Arches with pip..........................................8 5 Creating a New Arches Project9 5.1 Create a Project..............................................9 5.2 Setup the Database............................................9 5.3 View the Project in a Browser...................................... 10 5.4 Configure the Map Settings....................................... 10 5.5 Load a Package.............................................. 11 5.6 What Next?................................................ 11 5.7 Common Errors............................................. 11 6 Understanding Projects 13 6.1 Project Structure............................................. 13 7 Understanding Packages 15 7.1 Loading a Package............................................ 15 7.2 Creating a New Package......................................... 16 7.3 Configuring a Package.......................................... 17 7.4 Updating an Existing Package...................................... 18 8 Arches System Settings 19 8.1 Arches System Settings Interface.................................... 19 8.2 Maintaining Arches System Settings................................... 21 8.3 Changing the Admin Password..................................... 21 i 9 Settings - Beyond the UI 23 9.1 Settings Inheritance........................................... 23 9.2 Password Validators........................................... 24 9.3 Time Wheel Configuration........................................ 25 9.4 Configuring Captcha........................................... 26 9.5 Enabling User Sign-up.......................................... 26 10 Arches Collector Checklist 27 10.1 Install CouchDB............................................. 27 10.2 Register an OAuth Application..................................... 28 10.3 Set WSGIPassAuthorization in Apache Conf.............................. 29 10.4 Configure a Celery Broker........................................ 29 11 Designing the Database 31 11.1 Arches Database Theory......................................... 31 11.2 Arches Designer............................................. 32 11.3 Graph Designer.............................................. 32 12 Ontologies in Arches 39 12.1 Loading an Ontology........................................... 39 12.2 Loading a custom ontology....................................... 39 12.3 Enforcing ontology rules......................................... 40 13 Managing Map Layers 41 13.1 Different Types of Layers........................................ 41 14 Reference Data Manager (RDM) 43 14.1 Concept Schemes............................................. 43 15 Managing Permissions 51 15.1 Managing Users and Groups in Django Admin............................. 51 15.2 Resource Model Permissions...................................... 54 15.3 Resource Instance Permissions...................................... 54 16 Arches Collector Manager 55 16.1 What Are Arches Collector Projects?.................................. 55 16.2 Arches Collector Manager Overview.................................. 55 16.3 Creating Projects in the Arches Collector Manager........................... 57 16.4 Creating an Offline Basemap....................................... 58 17 Creating and Editing Resources 59 17.1 Resource Manager............................................ 59 17.2 Resource Editor............................................. 60 17.3 Related Resources............................................ 61 18 Deleting Resources 63 19 Searching 65 20 Introduction to Arches Collector 67 20.1 General App Navigation......................................... 67 21 Arches Collector Workflow 69 21.1 Connect to an Arches Instance...................................... 69 21.2 Download a Project........................................... 72 21.3 Navigating a Project........................................... 73 ii 21.4 Creating Records............................................. 77 21.5 Editing Records............................................. 77 21.6 Syncing Data............................................... 84 22 Accessibility 87 22.1 Contents................................................. 87 22.2 Summary................................................. 87 22.3 Tools Used................................................ 88 22.4 Key Points................................................ 88 22.5 Alternative solutions where components cannot be made accessible.................. 91 22.6 Additional Points............................................. 92 23 Creating a Development Environment 93 23.1 Setting Everything Up.......................................... 93 24 Arches and Elasticsearch 95 24.1 Installing and Running Elasticsearch.................................. 95 24.2 Using the Kibana Dashboard....................................... 96 24.3 Reindexing The Database........................................ 96 24.4 Using Multiple Nodes.......................................... 96 24.5 Adding a Custom Index......................................... 97 25 Data Model 99 25.1 Resource Model Overview........................................ 99 25.2 Controllers................................................ 101 25.3 Graph Definition............................................. 101 25.4 Ontologies................................................ 106 25.5 RDM Models............................................... 108 25.6 Resource Data.............................................. 109 25.7 UI Component Models.......................................... 113 25.8 Data Model Graph Visualization..................................... 116 26 Command Line Reference 117 26.1 Installation Commands.......................................... 117 26.2 ElasticSearch Management....................................... 118 26.3 Import Commands............................................ 119 26.4 Export Commands............................................ 120 26.5 Other Data Management Commands.................................. 121 26.6 Ontology Commands........................................... 122 26.7 Managing Functions, DataTypes, Widgets, and Card Components................... 122 26.8 Creating Map Layers........................................... 123 26.9 Other Useful Django Commands.................................... 123 27 API 125 27.1 General Notes.............................................. 125 27.2 Authentication.............................................. 126 27.3 Concepts................................................. 127 27.4 Resources................................................. 129 27.5 Activity Stream.............................................. 134 27.6 Mobile Projects.............................................. 137 27.7 GeoJSON................................................. 138 28 Resource Import/Export 141 28.1 Importing Data.............................................. 141 28.2 Importing a CSV............................................. 143 iii 28.3 Shapefile Import............................................. 146 28.4 JSON Import............................................... 147 28.5 Importing Resource Relations...................................... 152 28.6 Exporting Arches Data.......................................... 153 29 Migrating Data from v3 157 29.1 Exporting Your Data From v3...................................... 158 29.2 Migrating Your Data........................................... 159 30 Integrating Arches with ArcGIS 169 31 Creating Custom Components 171 31.1 About Custom Components....................................... 171 31.2 Functions................................................. 171 31.3 Widgets.................................................. 174 31.4 DataTypes................................................ 178 31.5 Card Components............................................ 188 31.6 Plugins.................................................. 199 31.7 Search Filters............................................... 200 32 Creating Resource Reports 201 33 Creating New Map Layers 205 33.1 MapBox Layers............................................. 205 34 Localizing Arches 209 35 Task Management 211 35.1 Dependencies............................................... 211 35.2 Configuration............................................... 211 35.3 Adding Tasks to Your Project...................................... 211 35.4 Running Celery.............................................. 212 36 Managing and Hosting IIIF Servers 213 36.1 Setting Up Cantaloupe.......................................... 213 36.2 Creating IIIF Manifests......................................... 213 36.3 IIIF Viewer...............................................