Cyclotron

Cyclotron is included in the platform as a fork of Expedia’s software. Head over to https://www.cyclotron.io/ for an in-depth description of its functionalities. The fork introduces the following features:

• security based on Authentication and Authorization Control Module (AAC)
• new widgets: time slider, OpenLayers map, Google charts, Deck.gl, widget container
• new data sources: OData
• parameter-based interaction between dashboard components

• AAC Integration
  • Authentication Methods
  • Authentication Configuration with OAuth2
    • Frontend Configuration
    • Backend Configuration
    • Role mapping
  • Client Application Configuration on AAC
  • Using Cyclotron API
    • AAC Roles and Cyclotron Permissions
    • Creating Private and Public Dashboards
    • Restricting Access to Dashboards in JSON
    • Testing
• Time Slider Widget
  • Configuration
    • Player
    • Pips
    • Specific Events
  • Examples
    • Basic slider with four pips matching slider values
    • Vertical slider with Player and Tooltips
    • Slider with two handles and Parameter generation
• OpenLayers Widget
  • Configuration
    • Layers
    • Overlay Groups
    • Controls
    • Data Source Mapping
    • Specific Events
  • Examples
    • OSM layer and WMS layer with zoom control
    • Default OSM layer and some overlays
    • Parametric ImageWMS layer
    • Vector layer with GeoJSON features
  • Notes
• Google Charts Widget
  • Configuration
    • Options
    • Columns
    • Formatters
  • Examples
    • Basic column chart
    • Column chart with formatter
    • Line chart with date column
• Deck.gl Widget
  • Configuration
    • Layers
  • Examples
    • Basic ScatterplotLayer
    • Adding a tooltip
    • Multiple interactive layers
• Widget Container
  • Layout Configuration
  • Example
• OData Data Source
  • Configuration
    • URL
    • Response Adapter
• Parameter-based Interaction
  • Parameter Generation
  • Subscription to Parameter Updates

Installation

Note that the detailed installation procedure is only summarized here and is better described on Expedia’s page.

Requirements:

• AAC
• Node.js
• MongoDB 2.6+ (installation instructions)

Installation steps:

0. Ensure that MongoDB and AAC are running. Cyclotron will automatically create a database named “cyclotron”.
1. Clone this repository.
2. Install the REST API and create the configuration file cyclotron-svc/config/config.js. Paste in it the content of sample.config.js, which contains the configurable properties of the API, such as MongoDB instance and AAC endpoints.
3. Install Cyclotron website.
4. Start both:
   • API: from cyclotron-svc run the command node app.js
   • website: from cyclotron-site run the command gulp server

Now Cyclotron is running with its default settings and authentication is disabled.