Data Streams & Project Management
Mangaging & creating streams and projects in the speckle admin interface. • Last modified on 7/5/2019 • edit

Speckle has an online management interface that enables you to manage your data. Specifically, you can:

  • search amongst your streams, and archive/unarchive them
  • share them with other persons, and manage their permissions
  • see who & where is receiving them, and where they originate from
  • check out the a stream's history
  • group them into projects to share them "in bulk"
  • add tags to both projects and streams, as well as other metadata
  • and more...

This interface is called speckle admin, and it can be usually found at the root of your speckle server address. If you have a test account on the hestia server, you can find it here:

Once you login, you will be greated with your dashboard that includes a selection of news, streams and projects. In here you have an omni-search box that will attempt to find any stream or project by its name.

stream search

Managing Streams

Over in the streams section you can search for and manage your streams. There's a bunch of functionality that we'll let you discover! Below there's some hints towards what you can do and what insights you can get.

detail

By clicking on a stream's "details" button, you will be taken to its primary information and management page. There's a couple of tabs that separate some concerns. First off, the overview tab!

Stream Overview

overview stream

Here you can:

  • change the stream's name,
  • edit its description (you can use markdown)
  • see its units
  • see where it's coming from
  • see who is receiving it, and where

Sharing

Under the sharing tab, you can toggle link sharing. If link sharing is ON, anyone that knows that streamId can access it and read its data. It's a useful setting to start with, but not good for sensitive information.

sharing

Once you've turned link sharing off, only you will be allowed to access that stream's data. To enable others to access that stream, search for their accounts using the form below, and add them to the permission tier you want (read/write):

  • Read permissions will allow your colleague to only read, for example, by receiving the stream somewhere.
  • Write permissions will allow them to open up your, for example, grasshopper file and use your sender components.
When you share a stream with someone, it will start showing up in their dashboard too!

History

history

Under the history tab you can see previous instances of your stream (and, if the stream is a child, its parent stream too!). History instaces are created automatically by some plugins, and manually by some connectors. They are just like any other stream - so you can tag them, receive them, view them online, diff them via the api, etc.

Specifically, the following clients create history instances when:

  • Grasshopper: History instances are created only when the sender is in manual mode (right click on the sender component to make it a "manual" sender),
  • Dynamo: Same as grasshopper; you can set the sender to "manual" mode through the toggle present on the component itself.
  • Revit: Every push will create a history instance.
  • Rhino: I really don't remember, need to check!

Projects

Projects serve a simple purpose: group a bunch of streams with a team of people. That being said, here is how you can create one:

  • First, go to the project overview page
  • Click the friendly blue button in the lower right corner
  • Edit the description, tags, etc. if you so need to
  • Add the streams you want to share with your team in the left side (search by stream name)
  • Add the people you want to share with in the right side (search by their name)

Here's a quick gif going through the motions:

overview stream

Done. That's it - now everyone in the right hand list will have read access to the streams in the left side. If you add a new team member, or a new stream, permissions will be propagated amongst this group.

Project permissions work like this:

  • People with read project rights will just be able to see the project.
  • People with write project rights will be able to add and remove streams and other people from the project.

For stream permissions, see above!

Archive

The archive is the buggy place where all your deleted resources go. It's like the recycle bin; I'm a bit tired of writing things now so I'll let you figure it out. It should be rather self-explanatory! If not, remember there's an "edit" button on the top of this page ;)