Versions Compared

Version Old Version 34 New Version Current
Changes made by

Carrie Warner (Unlicensed)

Georg Hentsch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Section
Twitter only allows clients like Twitter Reader to make a limited number of calls for new data in a given hour to protect against querying for Tweets too frequently and to control abuse. If the rate limit reaches zero (0) no new tweets will be retrieved.
To avoid exceeding Twitter’s limits, remove any unnecessary TweetOut topics in Flow. See the Twitter Topic Control module for details.By default,

for the First Time

The first time you run the Twitter Reader, you are prompted to create a new server connection instance. Enter an Instance Name and click OK.

Image Added

Column
width70%

Twitter Reader is

a utility

an agent that runs in the background on the data server, such as TweetOut or Super Ticker. The Twitter Reader

utility

agent connects directly to the

TweetOut or Super Ticker

database.

This utility

It reaches out to Twitter and returns valid content based on your enabled topic searches created in Flow.

Twitter topics are set up and managed in Flow for the Twitter Reader agent to populate using the Flow Configuration > Twitter Topic Control. See the topic Twitter Topic Control for details.


Image Added

Expand
titleClick here to see an example of the screen.

 


Note

Important:

This utility

The Twitter Reader agent must be running in order to receive new content. If you are troubleshooting a lack of new content, ensure that the Twitter Reader

utility

agent is running and functional

. Your troubleshooting steps differ depending on how you access your Bannister Lake solution. See the following sections for details.
Running a Cloud Instance? 

using the Agent Status.

Cloud Instance or Local Instance?

Customers using a cloud instance of

TweetOut or

Super Ticker do not need to manage the Twitter Reader themselves; Bannister Lake manages it for you. For assistance with your instance of Twitter Reader, contact Bannister Lake Support. 

Running a Local Instance?

Customers using a local instance

of TweetOut or Super Ticker

can access and manage their own instance of Twitter Reader.

  • In a standard installation, Twitter Reader is available on the server, also known as the Flow Server or database server.
  • In a custom installation, Twitter Reader may be located elsewhere. See your local system administrator for details.

Access Twitter Reader

To access the Twitter Reader

utility

agent, run the

utility

agent from its desktop icon on the server.

Image Removed

Image Added

Image Removed

Configure

Run Twitter Reader

When the utility opens, you can configure the following options.
OptionDescription
Rate Limit
TopicsYou can review all of the Twitter topics configured via Flow, and review whether or not they are currently enabled.
New TweetsReview the number of new Tweets added on the last data retrieval.
Countdown For Next Read
Expand
titleClick here for more details on setting up Twitter Reader for the first time.

Setup Tab - Connect to a Database

The Twitter Reader agent must be configured to connect to a database. Use the Setup tab to configure the connection.

Setup Tab - Manage Database Connections

Connection and user authentication values would have been correctly configured by your system administrator initially during installation; however, you can modify the values at any time using the Setup tab.

Note

Note: Use caution when modifying these values. 

Image Added

 

Info

Administrators: In an environment where you are securing network ports, you need make sure that the FTP port 21 can still access the internet as the Twitter Reader accesses Twitter credentials from a rotating pool available from the Bannister Lake server.


Setup Tab - Feed Settings

Using the Setup tab, you can also configure the following feed settings:

OptionDescription
Ignore Tweets with Link?

This checkbox will determine whether tweets that contain links are ignored or kept.

Filter on Black List words?

By default, the Twitter Reader automatically removes Tweets that contain words found in the Black List. You can turn off Black List content validation by disabling this option, though it is not recommended.

For more information on Black List filtering, see the topic Black List Control Module for details.

Store Images?You can choose to store images attached to Tweets in the database to use in a broadcast by enabling this option. By default, images are not stored in the database.
Read Tweets Every X Seconds

You can configure how often Tweets are read using this option. This value must be a minimum of 60 seconds.

Run Tab Details

Image Added

The Run tab displays the following details:

The countdown frequency can be adjusted via File > Preferences value Trigger an immediate data retrieval by clicking Read Now to
OptionDescription
Countdown

By default, the Twitter Reader attempts to retrieve data every two (2) minutes.

You can adjust this frequency on the Setup tab; however, the minimum

frequency must be one (1) minute or more.

Click Read Now

to manually retrieve data on demand and bypass the countdown clock.

File > Preferences 

The Twitter Reader utility must be configured to connect to your database. Connection and user authentication values would have been correctly configured by your system administrator initially during installation. Use caution when modifying these values.   

Image Removed

From this dialog you also:

  • Test your connection to your database by clicking Test Connection. This can be a handy troubleshooting step.
  • Control whether Tweets returned include hypertext links or not using the Remove Links From Tweets option. 
  • Configure the reader for a single user or a pool of users that all TweetOut Readers share between them using the User Pool option. When configuring the user pool option you need to restart the Twitter Reader for your changes to take effect.
  • Enable or disable the automatic black list content validation using the Filter on Black List words option.
  • Configure how often Tweets are read using the Read Tweets Every value. You will not be able to set this value lower than 60 seconds.
Help > Open Today’s LogTwitter Reader generates a log file of its activities while it’s running.
You can review this log file. Using the date and time, you can confirm that Twitter Reader is connecting and returning Tweets successfullyRate Limit

Twitter only allows data clients like Twitter Reader to make a limited number of calls for new data in a given 15 minutes to control abuse. If the rate limit reaches zero (0) no new tweets will be retrieved. Currently, the standard rate limit per 15 minutes is 180. What this means is that only 180 searches can be done every 15 minutes. If you find that your rate limit often goes to 0, either read twitter less frequently (see Setup tab) or disable and twitter topics or searches that are not currently needed.

New TweetsThe number of new Tweets added during the last data retrieval.
Status, Database Connection, & Enabled
  • Data retrieval status and time stamp
  • Database connection status
  • Agent status

Authorization Tab

The Authorization tab is used to define the twitter authorization for communicating with the Twitter API.

Image Added

By default, Twitter Reader uses a pool of twitter users setup specially for Twitter Reader. This is a finite set of users and affects the rate limits when retrieving tweets from Twitter. This pool is shared by all Twitter Reader users who have "Use User Pool" defined.

A better approach is to create your own authorization. Here are the steps:

  • Login into twitter using any account (personal or company).
  • Go to the Twitter Application Management Page: https://apps.twitter.com/
  • Click Create New App button
  • Enter in an application name (any name will do)
  • Description can be "Application for Twitter Reader"
  • For website, you can use: http://bannisterlake.com
  • Keep Callback URL empty
  • Agree to the Developer Agreement
  • Press "Create your Twitter application" button.
  • Go to "Keys and Access Tokens" tab for your new app
  • Click "Create my access token" button
  • Deselect the Use User Pool in Twitter Reader's Authorization tab which enables the authorization fields below.
  • You now should have the 4 fields needed to enter in the Authorization fields. They are Consumer Key (API Key), Consumer Secret (API Secret), Access Token and Access Token Secret.
  • After entering the 4 fields, press the Save button.

Topics Tab Details

The Topics tab shows you all of the Twitter topics configured and enabled in Flow.

Expand
titleClick here to see an example of the screen.

Image Added

Check for Updates

When you open Twitter Reader, it automatically checks for updates and prompts you if a newer reader version becomes available.

Image Added

You can manually check for updates at any time by selecting Help > Check for Updates.

Multiple Server Instance Support

You can create and manage multiple server instances for the Twitter Reader.

  1. To create another instance, select File > New Instance.
  2. Assign the instance a name and configure that instance for a specific database.
Column
width30%
Panel
borderColor#0070b1
bgColor#FFFFFF
borderWidth1

In this section:

Table of Contents
indent15px

Include Page
DASXA:Promos TopDAS
XA:Promos Top



Include Page
DASXA:Promos BottomDAS
XA:Promos Bottom