Developing with Arches

Arches is very flexible and customizable. This section provides guidance on how to use APIs to integrate Arches with other information systems, enhance accessibility, build custom extensions, and modify Arches to deploy custom features beyond the capabilities of standard (uncustomized, core) Arches.

If you are considering software development to customize Arches, please read the Arches Customization Considerations for an introduction about good practices to help make customizations easier to develop, sustain, and maintain.

Getting Started

• Arches Customization Considerations
  • More Sustainable Pathways toward Customization
  • Customizations Beyond Extensions
  • API Based Customizations
  • Strive for Graceful Degradation
• Creating a Development Environment
  • Setting Everything Up
  • Overwriting Core Arches Content
  • Handling Upgrades
  • Running Tests
• Arches and Elasticsearch
  • Installing Elasticsearch
  • Development Configuration
  • Running Elasticsearch
  • Using the Kibana Dashboard
  • Reindexing The Database
  • Using Multiple Nodes
  • Adding a Custom Index

Reference Guide

• API
  • General Notes
  • Register an OAuth Application
  • Authentication
  • Concepts
  • Resources
  • Activity Stream
  • Mobile Projects
  • GeoJSON
• Command Line Reference
  • Installation Commands
  • ElasticSearch Management
  • Import Commands
  • Export Commands
  • Other Data Management Commands
  • Ontology Commands
  • Managing Functions, DataTypes, Widgets, and Card Components
  • Creating Map Layers
  • Other Useful Django Commands
• Data Model
  • Resource Model Overview
  • Controllers
  • Graph Definition
  • Ontologies
  • RDM Models
  • Resource Data
  • UI Component Models
  • Naming Conventions
• Resource Import/Export
  • Importing Data
  • Datatype Formats
  • CSV Import
  • Shapefile Import
  • JSON Import
  • Importing Resource Relations
  • SQL Import
  • Exporting Arches Data

Extending Arches

• Creating Applications
  • What’s an App?
  • When are Arches Apps Useful?
  • Getting Started with Arches Apps
• Creating Extensions
  • Types of Extensions
  • Extension Architecture
  • Managing Extensions
  • Adding JavaScript Dependencies
• Creating New Map Layers
  • MapBox Layers
• Creating HTML Export Templates
  • Template Location
  • Templating Language
  • Resources Context Data
  • Custom Template Filters
  • Basic Template
  • Advanced Template Example

Advanced

• Accessibility
  • Contents
  • Summary
  • Tools Used
  • Key Points
  • Alternative solutions where components cannot be made accessible
  • Additional Points
• Integrating Arches with ArcGIS
• Localizing Arches
  • Localizing Graph Strings within Arches
  • Setting up Localized Languages for Business Data
  • RDF Imports and Exports
  • CSV Exports and Imports
• Managing and Hosting IIIF Servers
  • Setting Up Cantaloupe
  • Creating IIIF Manifests / Image Services
  • IIIF Viewer / Annotation data
• Task Management
  • Dependencies
  • Configuration
  • Adding Tasks to Your Project
  • Running Celery
• Two-factor Authentication
  • How Two-factor Authentication Works
  • Enabling Two-factor Authentication in Arches
  • Setting up Two-factor Authentication for User Accounts
• Using Arches Offline

Legacy Support

• Migrating Data from v3
  • Exporting Your Data From v3
  • Migrating Your Data