Satellite Tag Documentation

Satellite Tag is a live experience platform.

The platform has been successfully used by a wide range of events - conferences, showcases, exhibitions, consumer activations and music festivals, and has been used by major brands including Spark Digital, Coca-Cola, Fonterra, ASB, Microsoft, Google and Te Papa and Auckland Museum.

Satellite Tag’s designed to:

• Create a streamlined, innovative and elegant delegate experience
• Build data on the attendees and their experience
• Use technology to add value to and improve the overall live experience
• Provide ease of connection between exhibitors, sponsors or vendors and delegates

Index

• Basic Concepts
• Configuration
  • Exceptions
  • Inheritance
  • Reference
    • Global settings
      • Admin Title
      • Admin Dashboard
      • SuperSet Dashboard
      • Other Settings
    • Comm settings
      • Email
      • SMS
    • Device Interaction Settings
      • Allow Interaction
      • Limit Interactions
      • Accept Invalid RFID
      • Enable ACL
      • Filter Interactions
      • Single Entry (aka Require Check-out)
    • Integration settings
      • Adapters definition
    • Tickets settings
      • Tickets
    • Registration settings
      • Registration
• Control Room
  • Cockpit
    • Collections
    • Regions
• Admin REST API
  • Request Format
  • Response Format
  • Response Status Code
  • Error Responses
  • Authentication
  • Reference
    • Task
      • GET /task/list
      • POST /task/new
      • GET /task/{id}
      • PATCH /task/{id}
      • DELETE /task/{id}
      • GET /task/category/list
• REST API
  • Request Format
  • Response Format
  • Response Status Code
  • Error Responses
  • Interaction Types
  • Barcode
    • Barcode Parts
    • Barcode Generation
  • Reference
    • Device Discovery
      • POST /device-request/new
    • Authentication
      • POST /oauth/v2/token
    • Event
      • POST /event/new
      • GET /event/{id}
      • PATCH /event/{id}
      • DELETE /event/{id}
    • Delegate
      • Delegate Flags
      • GET /delegate/list
      • GET /delegate/{idType}:{id}
      • PATCH /delegate/{idType}:{id}
      • POST /delegate/new
      • DELETE /delegate/{idType}:{id}
      • GET /delegate/cache
      • POST /delegate/send-comm
    • Device (session, sponsor, product …)
      • GET /{deviceType}/list
      • GET /{deviceType}/{idType}:{id}
      • POST /{deviceType}/new
      • PATCH /{deviceType}/{idType}:{id}
      • DELETE /{deviceType}/{idType}:{id}
      • GET /{deviceType}/cache
      • POST /{deviceType}/log/{interactionType}
      • POST /device/{idType}:{id}/ping
    • Device Interaction
      • GET /device-interaction/list
    • Device (generic)
      • POST /device/log/{interactionType}
      • POST /device/seen
      • POST /device/log-batch
    • Lead
      • POST /lead/new
    • Questionnaire
      • GET /questionnaire/list
      • GET /questionnaire/{idType}:{id}
    • Config
      • GET /config/summary
    • Credit Token
      • Successful Response
      • Error Responses
      • GET /credit-token/balance/{accountName}/{idType}:{id}
      • GET /credit-token/history/{accountName}/{idType}:{id}
      • POST /credit-token/transaction/init
      • POST /credit-token/transaction/add
      • POST /credit-token/transaction/subtract
    • Ticket
      • POST /ticket/transaction
    • User
      • POST /user/new
      • PUT /user/me
      • GET /user/me
    • Cockpit CMS
• Web API
  • Web API vs REST API
  • GET /delegate/myself
  • GET /delegate/list
  • GET /device/list
  • POST /device-interaction/log
  • POST /lead
• Development
  • Server Side
    • Architecture
    • Pre-requirements
    • Quick Setup
    • Manual Setup
      • Install system and dependencies
      • Initialise the database
      • Get access to the backend
      • Install Cockpit
      • Initialise the Satellite Tag configuration
      • Build the frontend
    • Deploy
      • Capistrano (Shared Hosting)
      • CodeDeploy (Tier 2 and 3 Hosting)
    • Configuration Parameters
    • Upgrade
      • Update the codebase
      • Update the dependencies
      • Migrate the database
    • Guidelines
    • Reporting with Superset
      • Database Source
      • Table Source
      • Public Dashboards
    • Scripts and automated tasks
      • Ansible
      • Cron Jobs
      • Other scripts
  • Satellite Tag Units
    • Mobile Companion
    • Registration Form
      • Define steps, fields and classes
      • Overriding the templates
      • Serving the form behind a proxy
  • Third Party Sofware
    • Installing CouchDB
    • Installing Cockpit
      • Preload the default content
      • Content migration
      • Starting from scratch
    • Cockpit Integration
      • Symfony Service
      • Twig Templates
      • One-way And Two-ways Binding
    • Cockpit Conventions