Delivering quotes

Keeping a user's portfolio

Tracking stocks

Nuts and bolts

Related links:
Sample code in the Sandbox

Creating Lotus Instant Messaging interactive agents with the BuddyScript SDK

Building your own Sametime bots, Part 1

Building your own Sametime bots, Part 2

A tour of Sametime toolkits

BuddyScript home page

Get the PDF:
(90 KB)

STRING = ""
or SYMBOL in STOCK_LIST
STRING = StringConcat(STRING, SYMBOL, "+")
return STRING

preprocess
SYMBOL_STRING = SymbolString(SYMBOL_LIST)
http
http://finance.yahoo.com/d/quotes.csv?s=SYMBOL_STRING&f=sl1d1t1c1ohgv&e=.txt
buddyscript
R.Symbol, R.Current, R.Date, R.Time = {}, {}, {}, {}
R.Change, R.Open, R.High, R.Low, R.Volume = {}, {}, {}, {}, {}
MATCHES = {}
while StringMatch(DATA, "MACRO_STOCK_REGEX", "s", MATCHES) > 0
insert last in R.Symbol MATCHES[0]
insert last in R.Current MATCHES[1]
insert last in R.Date MATCHES[2]
insert last in R.Time MATCHES[3]
insert last in R.Change MATCHES[4]
insert last in R.Open MATCHES[5]
insert last in R.High MATCHES[6]
insert last in R.Low MATCHES[7]
insert last in R.Volume MATCHES[8]
DATA = MATCHES[9]
R.Offset = 0
R.Count = Count(R.Symbol)
return R

load Company {index=thawed}, Symbol {index=case-insensitive}, Exchange from file
NSD.txt

load Company {index=thawed}, Symbol {index=case-insensitive}, Exchange from file
NYE.txt

return STOCK

STOCK_LIST[STOCK] = 0
return STOCK_LIST

- <blank/>
<tab align="rl">
Stock:|STOCK.Symbol
Now:|Round(STOCK.Current, ".2")
Chg:|Round(STOCK.Change, "+.2")
Hi/Lo:|Round(STOCK.High, ".2")/Round(STOCK.Low, ".2")
Vol:|Round(STOCK.Volume/1000000, ".2") Million
</tab>

STOCK <= GetStockInfo(SYMBOL_LIST) show 5
if SYS.Data.Count = 1
// Only one stock -- display all details.
call DisplayStockDetails(STOCK)
else
// Multiple stocks -- display a table.
* <blank/>
<tab>
- STOCK.Symbol:|Round(STOCK.Current, ".2") Round(STOCK.Change, "+.2") {call=DisplayStockDetails(STOCK)}
* </tab>
<ifmore>>> Type "more" for the rest of your quotes...</ifmore>

NUM = Count(SYMBOL_LIST)
STR, COUNTER = "", 1
for SYMBOL in SYMBOL_LIST
STR = StringConcat(STR, SYMBOL)
if COUNTER < NUM - 1
STR = StringConcat(STR, ", ")
else if COUNTER = NUM - 1
STR = StringConcat(STR, " and ")
COUNTER = COUNTER + 1
return STR

call DisplayStockInfo(STOCK_LIST)
- <blank/>
>> Type "add" to add DisplaySymbolString(STOCK_LIST) to your portfolio
+ add
call AddToPortfolio(STOCK_LIST)

if MY_PORTFOLIO = {}
- Your portfolio is currently empty.
exit
- Your portfolio contains:
call DisplayStockInfo(MY_PORTFOLIO)

ADDED = 0
for SYMBOL in STOCK_LIST
if !Exist(MY_PORTFOLIO[SYMBOL])
MY_PORTFOLIO[SYMBOL] = 0
ADDED = 1
if ADDED
// At least one stock was added.
- Added. \c
else
// All of these stocks were already in the portfolio.
- Already in your portfolio. \c
call ShowPortfolio

REMOVED = 0
for SYMBOL in STOCK_LIST
if Exist(MY_PORTFOLIO[SYMBOL])
remove MY_PORTFOLIO[SYMBOL]
REMOVED = 1
if REMOVED
// At least one stock was removed.
- Removed. \c
else
// None of these stocks were in the portfolio.
- Not in your portfolio. \c
call ShowPortfolio

MY_PORTFOLIO = {}
- OK. Your portfolio has been cleared.

call ShowPortfolio

call ClearPortfolio

call AddToPortfolio(STOCK_LIST)

call RemoveFromPortfolio(STOCK_LIST)

• If there are items in a user’s watchlist, the interactive agent checks every five minutes to see if any of the target values have been reached.
• Each time it checks the watchlist, the interactive agent checks the user’s presence. Notifications are sent immediately if the user is active, but stored for later delivery if the user is off-line or away.
• If all of the target values on the watchlist are reached, the list is emptied and the interactive agent stops making periodic checks (until the user adds new items to the list).

if TYPE eq "<"
return "falls to or below"
else
return "climbs to or above"

if TYPE eq "<*"
return "fell below"
else
return "climbed above"

if WATCHLIST_NOTIF_ID ne -1
// If we're being called by the periodic timer...
if THIS_NOTIF_ID ne WATCHLIST_NOTIF_ID
//...and the timer has been "reset," then don't execute.
exit
if MY_WATCHLIST = {}
// If the watchlist has been cleared, don't execute.
exit
REMAINING_WATCHLIST = {}
ADDED, TRIGGERED = "", ""
STOCK <= GetStockInfo(MY_WATCHLIST)
for VALUE in MY_WATCHLIST[STOCK.Symbol]
for TYPE in MY_WATCHLIST[STOCK.Symbol][VALUE]
ORIG_TYPE = TYPE
if TYPE eq "<*" or TYPE eq ">*"
// If this item has already been triggered but not yet output
// because the user was away...
DATE_REACHED = MY_WATCHLIST[STOCK.Symbol][VALUE][TYPE]
if PRESENT
//...then prepare a notice to be output, if the user is now present...
MSG - STOCK.Symbol Reached(TYPE) $VALUE on DATE_REACHED. Its current value is $STOCK.Current.
TRIGGERED = StringConcat(TRIGGERED, "\n ", MSG)
else
//...or put the item back in storage if the user is still away.
REMAINING_WATCHLIST[STOCK.Symbol][VALUE][TYPE] = DATE_REACHED
continue
if TYPE eq "?"
// If the user has just added this item and didn't explicitly specify
// a type ("<" or a ">"), infer the type from the current price
// and the target value.
if STOCK.Current = VALUE
// If the current price is equal to the target value, then the item
// is triggered.
CONDITION_MET = 1
else
// Otherwise, set the type.
CONDITION_MET = 0
if STOCK.Current > VALUE
TYPE = "<"
else
TYPE = ">"
else
// If we already know the type, just check to see if the item is triggered.
CONDITION_MET = if(TYPE eq ">", STOCK.Current >= VALUE, STOCK.Current <= VALUE)
if CONDITION_MET
// If the item is triggered...
if PRESENT
// ...and the user is present, then prepare a notice to be output.
MSG - STOCK.Symbol is now valued at $STOCK.Current per share.
TRIGGERED = StringConcat(TRIGGERED, "\n ", MSG)
else
// If the user is away, store the item for later notification.
NOW = GetShortDisplayCurrentDate() "at" GetDisplayCurrentTime()
REMAINING_WATCHLIST[STOCK.Symbol][VALUE][StringConcat(TYPE, "*")] = NOW
else
// If the item is not triggered, put it back in the watchlist to be
// checked again later.
if MY_WATCHLIST[STOCK.Symbol][VALUE][ORIG_TYPE] = 0
// If this item has just been added, prepare a confirmation notice
// to be output.
MSG - STOCK.Symbol Reaches(TYPE) VALUE
ADDED = StringConcat(ADDED, "\n ", MSG)
REMAINING_WATCHLIST[STOCK.Symbol][VALUE][TYPE] = 1
if ADDED
// If any items were added, output the associated notices.
- OK, I will notify you when...ADDED
if TRIGGERED
// If any items were triggered, output the associated notices...
if ADDED
// ...but break them out into separate messages if items were also
// added during this pass.
- <brk/>
- Watchlist alert:TRIGGERED
MY_WATCHLIST = REMAINING_WATCHLIST
WATCHLIST_NOTIF_ID = notify MACRO_UPDATE_INTERVAL : CheckPresence

THIS_NOTIF_ID = SYS.Notification.Id
ABSendServiceEvent(addbuddy SYS.User.ScreenName)

PRESENT = if(EVENT.status = "active", 1, 0)
ABSendServiceEvent(removebuddy SYS.User.ScreenName)
call CheckWatchlist

MY_WATCHLIST = {}
- Your watchlist has been cleared.

if MY_WATCHLIST = {}
- You are currently not watching any stocks.
exit
- I will notify you when...
for SYMBOL in MY_WATCHLIST
for VALUE in MY_WATCHLIST[SYMBOL]
for TYPE in MY_WATCHLIST[SYMBOL][VALUE]
WATCHLIST_OBJ = {}
WATCHLIST_OBJ[SYMBOL][VALUE][TYPE] = 0
- SYMBOL Reaches(TYPE) VALUE {call=RemoveFromWatchlist(WATCHLIST_OBJ)}
- <blank/>
>> To remove an item, type its number.
>> To clear your entire watchlist, type "clear."
+ =Clear
call ClearWatchlist

for SYMBOL in WATCHLIST
for VALUE in WATCHLIST[SYMBOL]
for TYPE in WATCHLIST[SYMBOL][VALUE]
MY_WATCHLIST[SYMBOL][VALUE][TYPE] = 0
WATCHLIST_NOTIF_ID = -1
PRESENT = 1
call CheckWatchlist

REMOVED = 0
for SYMBOL in WATCHLIST
for VALUE in WATCHLIST[SYMBOL]
for TYPE in WATCHLIST[SYMBOL][VALUE]
if TYPE eq "?"
for EVERY_TYPE in MY_WATCHLIST[SYMBOL][VALUE]
remove MY_WATCHLIST[SYMBOL][VALUE][EVERY_TYPE]
REMOVED = 1
continue
if Exist(MY_WATCHLIST[SYMBOL][VALUE][TYPE])
remove MY_WATCHLIST[SYMBOL][VALUE][TYPE]
REMOVED = 1
if MY_WATCHLIST[SYMBOL][VALUE] = {}
remove MY_WATCHLIST[SYMBOL][VALUE]
if MY_WATCHLIST[SYMBOL] = {}
remove MY_WATCHLIST[SYMBOL]
if REMOVED
- Removed. \c
call ShowWatchlist

return ">"

return "<"

return "?"

LIST[FLOAT] = 0
return LIST

TYPE |= "?"
for VALUE in VALUES
TARGET[VALUE][TYPE] = 0
return TARGET

return TARGET

for VALUE in TARGET
for TYPE in TARGET[VALUE]
LIST[VALUE][TYPE] = 0
return LIST

FRAG = {}
for SYMBOL in STOCK_LIST
for VALUE in TARGET_LIST
for TYPE in TARGET_LIST[VALUE]
FRAG[SYMBOL][VALUE][TYPE] = 0
return FRAG

return FRAG

for SYMBOL in FRAG
for VALUE in FRAG[SYMBOL]
for TYPE in FRAG[SYMBOL][VALUE]
LIST[SYMBOL][VALUE][TYPE] = 0
return LIST

call AddToWatchlist(WATCHLIST)

call ShowWatchlist

call ClearWatchlist

call RemoveFromWatchlist(WATCHLIST)

• We have chosen to be sensitive to linguistic cues as to the type of target you want to set—for example, that you want to be notified when IBM climbs to 90 as opposed to when it falls to 90. In the typical case (where you know what the current value of the stock is and haven't made an error in your request), this information doesn’t add anything. However, if you are mistaken about the stock’s value or misstate your request, the interactive agent can use the extra information to catch the error. Of course, these linguistic cues are not required—if you type “Tell me when IBM hits 90” or just “IBM 90,” the interactive agent will infer the type of target, using the current price as the starting point.
• Although we could have allowed just one target to be added to the watchlist at a time, we have built recursive subpatterns allowing the interactive agent to recognize complex watchlist requests containing multiple stocks and multiple targets per stock. Among the requests recognized are IBM 90, IBM 70 90, MSFT GE 20 30, IBM 70 90 MSFT GE 20 30, “Tell me if IBM hits 70 or 90 and if MSFT or GE falls to 20 or climbs to 30,” and so on.

- I can:
Give you stock quotes {action=ExplainQuotes}
Manage a portfolio of your favorite stocks {action=ExplainPortfolio}
Notify you when stocks hit target values {action=ExplainWatchlist}
do nothing
- <blank/>
>> Type "help" at any time to return to this menu...
action ExplainQuotes
- To get stock quotes, just type a list of one or more stock symbols. For example:
IBM {*}
IBM GM GE {*}