Quick Start Guide¶
This quick start guide describes how you can start using Social Feed Manager to select, harvest, explore, export, process and analyze social media data. This covers just the basics of using the software; technical information about installing and administering SFM can be found in the Installation and Technical Documentation.
SFM in operation¶
This quick start guide assumes SFM is already set up and running. For details about installing and administering SFM, see :ref:’technical-documentation’.
An SFM account¶
You can sign up for an account by clicking the Sign Up link from within SFM.
If you’d like to set up shared collecting at your institution, you’ll need to have your systems administrator set up groups in SFM.
You will need API credentials for each of the social media platforms from which you want to collect. This is more than the Twitter/Flickr/Weibo account that you may already have. To get API credentials:
- Request credentials from the social media platform and enter them into Credentials section. The API Credentials page provides instructions for each platform.
- For Twitter, you have the option to connect your account without leaving SFM. With your permission, SFM will get credentials on your behalf. Click Credentials and then Connect Twitter Account.
- If you are part of a group, you’ll be able to use the credentials already provided by another member of the group.
Setting up collections¶
Hopefully you’ve considered what you want to use SFM to collect: which social media accounts, which queries/hashtags/searches/etc., and on which platform(s). You may also have learned a bit about the social media platforms’ APIs and best practices for collecting from social media APIs. Now you’d like to set up your collections in SFM.
Create a collection set¶
At the top of the page, go to Collection Sets and click the Add Collection Set button. A collection set is just a group of collections around a particular topic or theme. For example, you might set up a “2016 U.S. Elections” collection set.
Create a collection¶
On the collection set detail page, under Collections click the Add Collection button and select a type.
Collection harvest types differ based on the social media platform and the part of the API from which the social media is to be collected. For example, a “Twitter search” collects tweets from Twitter’s search API.
The collection types supported by SFM include:
- Twitter search
- Twitter filter
- Twitter user timeline
- Twitter sample
- Flickr user
- Weibo timeline
SFM allows you to create multiple collections of each type within a collection set. For example, you might create a “Democratic candidate Twitter user timelines” collection and a “Republican candidate Twitter user timelines” collection. Collections are one way of organizing harvested content.
Each collection’s harvest type has specific options, which may include:
- Schedule of how often to collect (e.g. daily, monthly). Streaming harvest types such as Twitter filter don’t have a schedule – they’re either on or off.
- Whether to perform web harvests of images, videos, or web pages embedded or linked from the posts.
- Whether to harvest incrementally. For example, each time a Twitter user timeline harvest runs, it can either collect only new items since the last harvest, or it can try to re-collect each entire timeline.
Some harvest types require seeds, which are the specific targets for collection.
As shown in the chart below, what a seed is and the number of seeds varies by harvest type. Note that some harvest types don’t have any seeds.
|Harvest type||Seed||How many?|
|Twitter search||Search query||1 or more|
|Twitter filter||Track/Follow/Locations||1 or more|
|Twitter user timeline||Twitter Account Name or ID||1 or more|
|Flickr user||Flickr Account Name or ID||1 or more|
Each collection’s detail page has a Turn On button.
Once you turn on the collection, harvesting will proceed in the background according to the collection’s schedule. It will stop when it hits the end date or you turn it off.
The collection’s detail page will also show a message noting when the next harvest is scheduled for.
As harvesting progresses, SFM will list the results of harvests on the collection’s detail page.
Within SFM, harvesting is performed by (you guessed it) harvesters. Harvesters make calls to the social media platforms’ APIs and records the social media data in WARC files. (WARC is a standard file format used for web archiving.)
Depending on the collection options you selected, SFM may also extract URLs from the posts; these URLs link to web resources such as images, web pages, etc. SFM passes the URLs to the web harvester, which will collect these web resources (similar to more traditional web archiving).
To monitor harvesting:
- View details on each harvest in the Harvests section of the collection detail page.
- Check the visualizations of the number of items harvested for each collection on the home page. (Click Social Feed Manager in the top left of the page).
If you want to make changes to the collection’s options and/or its seeds after harvesting is started, turn off the collection and then click the Edit button.
You’ll be able to turn it back on and resume collecting afterwards.
Access and display¶
SFM does not currently provide a web interface to the collected social media content. However, this should be possible, and we welcome your ideas and contributions.