SaffronSierra Documentation

Below you will find information on how to use the SaffronSierra service.  There are a few sections up front that review the concepts and objects so that you can gain an understanding of SaffronMemoryBase (SMB).  We recommend that you read the quick start, but then start using the APIs as soon as you can.  For more background on SaffronMemoryBase, you will find more material under Concepts and Terms, Creating Spaces and Getting Results.  You can download sample code that will allow you to put data in and get results our of your service instance.  We also invite you to register and visit TweetDive, a new way to look at a Twitter feed, based on SaffronSierra.  If you are an enterprise cutomer, you can find additional documentation here.  Finally, if you have any questions, feel free to contact Saffron Support for additional help.  Congratulations on pursuing new ways to exploit your data!

Quick Start

Concepts and Terms

• The SMB Store
• The Matrix
• Inputs and Outputs

Creating Spaces

• Pushing your data into SMB - Taking your data from it's native format into SMB.
• Ingestion Templates - Listing and explanation of the input data formats.

Getting Results

• Queries
• Attribute Query Language - Explanation of the query language used by a number of API calls.
• Result Objects
• JSON Properties - Explanation of the properties that might come back in a JSON response. 
• Query Metrics - Explanation of metrics and their impact on query parameters and JSON properties.
• Result Paging - Explanation of how result set paging works.
• The Virtual Attribute System
• Variants - Explanation of how to use variant scopes when making API calls.

REST Basics and Authentication

• Authentication - How to authenticate REST API request.
• Basic REST Mechanics
• REST/JSON Examples
• Test Harness

The Sierra Console

• Starting and Stopping your Service
• Your Secret Code 

Data Sets

• UK  Security Data

REST API Reference Guide

Enterprise SMB Documentation

Saffron Open Source

Change History