Introduction
Arranger is a data-agnostic search API that utilizes Elasticsearch index mappings to generate interactive and configurable search components.
Arranger integrates with your underlying Elasticsearch cluster to automatically generate a powerful search API based on your configured index mapping. It consists of two main modules, Arranger Server and Arranger Components.
Arranger Server is a GraphQL API that communicates with an Elasticsearch index. One unique feature of Arranger Server is its use of a consistent and custom filter notation called SQON. SQON is designed to be user-friendly, allowing humans to easily understand and create custom filters while also being straightforward for software systems to interpret and process.
Arranger Components are interactive and configurable UI components specifically designed to display and query complex datasets. The example below showcases the Arranger Components that form the foundation of the VirusSeq data portal.
- The left hand box (in red) is Arranger's faceted search component
- The bottom box (in blue) is Arranger's Data Table component
- The top box (in yellow) is Arranger's SQON Viewer component
Stage
Arranger works best when paired with a user interface (UI) to host its search components. We recommend using the Stage, a React-based UI specifically designed to facilitate Arranger components and the integration of our OAuth tool, Ego. Stage offers an extensible layout, reusable components, and a themeable front-end interface. Ultimately, Stage enables you to integrate these services into any web-based application.
