Document Extensions: Time Series

Actions

1. To view a document's time series, open its document view and click the time series tab on the right.
2. Click 'Add Time Series' to create a new time series see more below.
3. Click to view and modify time series data.

Actions

1. Click to select another time series.
2. Click to add a new entry to this time series (StockPrices), or click the dropdown to create a new time series.
3. Delete all entries from a specified time range.
4. Edit entry.

1. Time Series Type
   • Diasble to create a non-incremental time series.
     (Learn now to create an incremental time series here)
2. Time Series Name
   • Enter time series' name.
   • Name cannot start with 'INC:' as this prefix is reserved for incremental time series.
3. Entry Timestamp
   • Select a timestamp for the new entry.
4. Tag (Optional)
   • Optionally give the entry a tag.
5. Values
   • Add one or more numerical values (up to 32 values).
     
   • Time series entry values can be given meaningful names rather than labels like Value #0 and Value #1.
     To set entry values' names, use Studio's Time Series Settings View.

1. Edit the optional tag.
2. Edit a numerical value.
3. Delete value.
4. Add an additional value (up to 32 values).

To specify a range of time series entries:

1. Start Date
   Check Use minimum to use the first entry's timestamp as the start of the range,
2. End Date
   Check Use maximum to use the last entry's timestamp as the end of the range.

• For either option, you can click the input bar and specify some other date in the date & time dialog shown below.

Actions

1. Enter your RQL query in the query box.
   Depicted here is a query to get all the StockPrices time series values from documents in the Companies collection.
   Learn more about time series queries here.

   Make sure that the time series Name is placed within double quotes (e.g. "StockPrices", "INC:Downloads", etc.), so special characters like ":" would not interfere with the query.
   

2. Click to run the query.

1. Click to open a tab with the time series query results shown in a table.
   
2. Click to open a tab with the time series query results shown in a graph (see below).
3. Multiple documents selection
   
   • A. Select multiple documents to plot their time series.
   • B. Click to view the selected documents' time series results in a unified graph.
     

1. Click to go back to the query results tab.
2. Display tabs with graph or table results.
3. Drag or resize the selected time frame to view the corresponding results.
4. Hover your mouse over the graph to view the data of one particular entry.
5. Toggle viewing points or a continuous line.
6. Check/Uncheck to plot or hide time series entries' values on the graph.

1. Time Series Type
   • Enable to create an Incremental time series.
2. Time Series Name
   • Enter time series' name.
   • Incremental time series names must start with INC: (in either upper or lower case characters).
3. Entry Timestamp
   • Select a timestamp for the new entry.
4. Values
   • Add one or more numerical values (up to 32 values).
     
   • Time series entry values can be given meaningful names rather than labels like Value #0 and Value #1.
     To set entry values' names, use Studio's Time Series Settings View.

1. Show values per node
   • Enable to view the value's contents distribution per cluster node (see below).
     When disabled, only the total value (the value's total contents) is visible.
2. Values
   • Total Value
     This is the value's total contents, which is the accumulation of this value's contents from all cluster nodes.
   • Increment By
     The number you enter here is the delta that will be added to the value's contents on the current node.
     Enter a positive number to increase the value or a negative number to decrease it.
     The change in the value's total contents will be visible after you click the Save button.
3. Add Value
   Add an additional value (up to 32 values).
4. Save
   Click to save your changes.

1. Show values per node
   • Enable to view the value's contents distribution per cluster node.
2. Values
   • Total Value
     This is the value's total contents, which is the accumulation of this value's contents from all cluster nodes.
   • Increment By
     The number you enter here is the delta that will be added to the value's contents on the current node.
     Enter a positive number to increase the value or a negative number to decrease it.
     After clicking Save, both the current node and the total value will be updated with the new accumulated value.
     The value will be modified only when you click the Save button.
3. Add Value
   Add an additional value (up to 32 values).
4. Save
   Click to save your changes.