Newtek Datalink™: Installation Guide and Reference Manual
Newtek Datalink™: Installation Guide and Reference Manual
Newtek Datalink™: Installation Guide and Reference Manual
Rev. Nov.07.08
Table of Contents
1 DATALINK END USER LICENSE AGREEMENT ........ 2
2 INTRODUCTION ..................................................... 8
6 INDEX ...................................................................... 40
CREDITS ........................................................................ 42
1 DATALINK END USER LICENSE AGREEMENT
1. Grant of License
This License allows you to use one copy of the Software on a single
computer at a time. To "use" the Software means that the Software
is either loaded in the temporary memory (i.e., RAM) of a computer,
or installed on the permanent memory of a computer (i.e., hard disk,
CD ROM, etc.).
You may use at one time as many copies of the Software as you have
licenses for. You may install the Software on a common storage
device shared by multiple computers, provided that if you have more
Page 2
computers having access to the common storage device than the
number of licensed copies of the Software, you must have some
software mechanism which locks out any concurrent user in excess
of the number of licensed copies of the Software (an additional
license is not needed for the one copy of Software stored on the
common storage device accessed by multiple computers).
You may make one copy of the Software in machine readable form
solely for backup purposes. The Software is protected by copyright
law. As an express condition of this License, you must reproduce on
the backup copy the NEWTEK copyright notice in the following
format "(c) 1990 - 2008 NEWTEK"
You may permanently transfer all your rights under this License to
another party by providing such party all copies of the Software
licensed under this License together with a copy of this License and
all written materials accompanying the Software, provided that the
other party reads and agrees to accept the terms and conditions of
this License.
2. Restrictions
3. Termination
You agree that neither the Software nor any direct product thereof is
being or will be shipped, transferred or re-exported, directly or
indirectly, into any country prohibited by the United States Export
Administration Act and the regulations thereunder or will be used for
any purpose prohibited by the Act.
Page 4
OUT OF THE USE OR INABILITY TO USE THE SOFTWARE OR
ACCOMPANYING WRITTEN MATERIALS, REGARDLESS OF THE BASIS
OF THE CLAIM AND EVEN IF NEWTEK OR AN AUTHORIZED NEWTEK
REPRESENTATIVE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
The above limitations will not apply in case of personal injury only
where and to the extent that applicable law requires such liability.
Because some jurisdictions do not allow the exclusion or limitation of
implied warranties or liability for consequential or incidental
damages, the above limitations may not apply to you.
6. General
This License will be construed under the laws of the State of Texas,
except for that body of law dealing with conflicts of law. If any
provision of this License shall be held by a court of competent
jurisdiction to be contrary to law, that provision will be enforced to
the maximum extent permissible and the remaining provisions of this
License will remain in full force and effect. If you are a US
Government end-user, this License of the Software conveys only
"RESTRICTED RIGHTS," and its use, disclosure, and duplication are
subject to Federal Acquisition Regulations, 52.227-7013 (c)(1)(ii).
(See the US Government Restricted provision below.)
7. Trademarks
Page 5
8. US Government Restricted Provision
Page 6
(f) Use of this Software and documentation shall be limited to the
facility for which it is required, and,
Page 7
2 INTRODUCTION
2.1 OVERVIEW
With DataLink installed, special ‘key name’ entries (typed into your Title
Templates, in the same way you normally enter static text) are updated
‘on the fly’ when displayed. The text actually displayed is drawn from
the external data source, but retains its original formatting.
You could think of “DataLink” this way: the “Data” portion refers to
external information (data) expressed as a ‘key-value pair’.
Page 8
Here’s a typical key-value pair:
The “Link” part of the “DataLink” reflects the fact that the plugin links
data from the key-value pairs with matching key entries in your Text
Templates. To provide dynamic updates in this manner, DataLink
operates quietly in the background, patiently monitoring external
sources for changes.
Page 9
2.1.2 TXT AND DATABASE LINKERS
These two Linkers each keep an eye on their namesake file types,
refreshing the display as required. Prepared in advance, data files can
serve many handy and creative purposes.
Note: TXT Linker monitors files (.txt) you place in the folder
C:\TriCaster\Stats Plugins\Text Input.
For example, a simple ASCII text file (.txt) containing a list of names
(prepared as key-value pairs) could be used to automatically update a
credits slate, or perhaps to populate the name fields in a series of
individual lower thirds used in a weekly production (Section 4.2 explains
the details of this example).
The TXT Linker continuously watches for changes in the values assigned
to keys. If a value changes in the file, the display is immediately updated.
Thus, third-party programs may be designed for various applications that
continuously update the onscreen text display by changing values
assigned to keys in the file.
Page
10
3 GETTING STARTED
Or …
Page
12
3.2.1 USB-SERIAL ADAPTERS
Newer external devices may use USB connections, but others use older
RS-232 (25-pin) connectors, or occasionally (slightly more recent) 9-pin
style connectors.
Page
13
Several methods are available to transfer and install the drivers
on a TriCaster system. You may either:
Page
14
Figure 1 - Device Manager
6. Click the + sign next to Ports (COM and LPT) in the right-hand pane
to disclose available communication ports
7. Locate the entry for your scoreboard controller - note which COM
port number is assigned to it (such as COM 1 or COM2)
Page
15
(If it does appear, but shows a ! icon next to the entry, this may
indicate a problem with the USB connection or your adapter driver
installation – try re-installing the adapter driver, following the
directions supplied with it.)
1. (TriCaster only) - If necessary, click the Close button (the [x] gadget
in the upper-right corner of the TriCaster window) and then click
Admin in the Shut Down dialogue that pops up, to access the
Windows™ desktop.
3. The DataLink installer will now present a dialog (Figure 2) to ask you
to accept the End User License Agreement. Please read the EULA
Page
16
and, if you agree with its terms, click the switch indicating that you
accept these and wish to proceed with the installation.
Page
17
Figure 3 – Registration
Note: If you do not obtain and enter the code, the installation will abort
and you will need to re-install again at another time.
Page
18
Figure 4
3. Locate the section (of the .ini file) appropriate for the brand of
scoreboard controller connected
4. Change the value for Port in the connected device brand’s section
to correspond to the Port number you noted earlier in Section 3.2.2
(enter Port=1 if the device was found at COM1, and so on)
For any and all brands of controller that are not connected, Enabled
should be set to 0 (so the relevant entry in their sections would be
Enabled=0).
Page
20
Important Note: In some environments, Windows may arbitrarily
reassign the external device to a different COM port following a reboot.
If this happens, you could simply update COM port entry in the .ini file.
However, you may prefer instead to lock the connected device to a
specific COM port, using the Windows Device Manager.
To do this, please locate the current port entry for your scoreboard
controller. Right-click the entry name, and select Properties in the
drop-down menu.
Next, click the Port Settings tab at the top of the Properties panel,
and click the button labeled “Advanced”. Use the Com Port Number
drop-down menu to choose an unused port number, and click the OK
button. OK the Properties panel too, then close the Device
Manager. The Port Number you assigned should now be retained on
subsequent reboots.
Page
21
4 USING DATALINK
The quickest way to become familiar with DataLink is to ‘dive right in’
and try it out.
Page
22
Figure 5
Title Templates contain text fields that you can edit to suit your
needs. When you move your mouse over an editable field, a
thin marquee is shown to indicate that you can modify that
entry.
2. Move the mouse over the number “55” next to the “Burger
Boys” team name – notice the marquee that appears.
Page
23
3. Click inside this marquee, and a text entry popup will appear.
(Initially, it will contain “55”, the default entry).
You can type anything you like into this popup, but of course
for DataLink provides special abilities for specific entries.
The value we want to appear for our example is the home team score.
For our example, we’ll assume you have a Daktronics™ unit – the key
name we want is listed as %DakHomeScore%. You should use the
correct value for your brand of device, of course.
Figure 6
Page
24
6. Press Enter on the keyboard to end text entry, closing the
popup
Figure 7
Notice that the name entry is replaced by [DL] in the preview (Figure 7).
This indicates DataLink recognizes the name you entered as a valid
DataLink key (if this doesn’t happen, check your typing for errors).
Figure 8
Page
25
Now, whenever you have this template displayed in your live production
system (and assuming the scoreboard is connected and running), the
home team score will be automatically updated with the true value.
To supply usable values for DataLink, the text file should contain nothing
other than key-value pairs, arranged in the following format:
[key] = [value]
The [key] entry should be a short string which will be entered into your
TriCaster Title Templates. The [value] field supplies the actual title that
will be displayed for that key.
Page
26
Note: Both keys and values may contain punctuation and
spaces.
Hint: to type the degrees sign (°) –> keep the ALT key pressed
while using the keyboard number pad to type 017 6 … then
release ALT (standard notation for this combination is
ALT+0176).
4. Launch the TriCaster, and click the Text tab on the Live
Production screen.
Page
27
Figure 9- Add to List
Figure 10
Page
28
Figure 11
Note that - after you press Enter - the Text Preview updates to
show the letters [DL] where key names have been entered
(Figure 12).
Figure 12
Note: don’t be alarmed if the key name you enter seems too
long. When DataLink replaces the key with an actual value, it
will fit just fine.
Hint: For this reason, when creating custom templates for DataLink
use, it’s a good idea to initially place and format text lines using
temporary ‘stand-in’ values. When everything looks just right,
replace the stand-in values with key names surrounded by % signs
(these % signs tell DataLink that the enclosed entry is a key name,
and that it should be replaced with the true value on display).
Page
29
10. Delete the little degree sign (°)
from the page.
See how DataLink replaces the key names in the template with value
data drawn from the file?
Page
30
Actually, if you still had Notepad® open with the text file open
in it -- you could change the data displayed on the screen
instantly by modifying a value next to a key, and then pressing
Ctrl+s to save the modified file.
Let’s briefly consider a more elaborate example using the TXT Linker:
Or, you could prepare the pages once, and let DataLink update them
all for you automatically every time! To do that, you could proceed
as follows:
4. Click the second thumbnail (no need to edit the first one) in the
Pages column at right to select it for modification, and click the
T button (to activate text entry).
5. Click in the DataLink key field on the Work Area, and replace
%guest1% with %guest2%
6. Click the next page, and change the key name to %guest3%,
and so-on until all done.
7. Select Export Project for Live in the Project area (above the
Pages column) – note that export may take a few moments.
Page
31
8. Leave Edit Text (or CG Designer), and go to TriCaster’s Live
Production panel (or VT*5+’s Text Template module).
10. Use Save List to save a Template playlist containing this set of
Text Templates as guest-slates.vto (so you can reload these
pages en masse in seconds whenever you like).
That’s all you need to do. Before each episode, your production
assistant can take a few moments to update the guest.txt file content,
and the work is done!
This component also monitors an external file for keys (and changes to
their corresponding values), but in this case it can access a more complex
and powerful file structure -- the database.
Page
32
The feature allows users to take advantage of supported MySQL
database query functions to derive replacement values for the keys on
the text page.
Hint: If you plan to use this feature, you (or someone in your
employ) will need a measure of familiarity with database
queries.
In this case, DataLink monitors the folder Database Input, located inside
the Stats Plugins folder mentioned earlier. However -- the database file
itself doesn’t need to be located in this folder. Rather, a special .xml
type file goes here; in turn, the XML file content provides the
information that DataLink needs in order to access the external database
values. Here’s a sample xml file:
<!—
Example connection string and query for DataLink
using MySQL.
This produces the keys %book.1%, %book.2%... etc
-->
<sql_databases>
<query>
command = "SELECT title FROM Books;"
key = "book"
timeout = "10000"
multiple_keys = "true"
</query>
</database>
</sql_databases>
Replacing the Server, user, password, etc. values with the correct ones
for your environment permits the Database Linker to supply values to
Page
33
DataLink keys as described in the commented lines (an array in the
format book.1, book.2, and so on).
With respect to the line that states timeout = “10000” in the xml file, this
tells DataLink to how often (in milliseconds) to update its values from the
database. Lower values result a faster refresh rate. Rates that are overly
high are undesirable as the data may not seem to be updated in a timely
manner.
The multiple_keys = “true” entry tells DataLink that more than one
match to the SQL query is acceptable. In this case, DataLink will create a
key/value pair for each qualified result. For example, a keyword
“author” could produce an array of matches, which DataLink would
arrange as follows:
Page
34
5 KEY NAME LIST
In this chapter we’ll list the actual key names that are
available for use with DataLink and the different
brands of external equipment it supports.
Page
36
%DakHomeTOPart% - Home Time Outs Left – Partial
Page
37
%WWClock% - Game Clock Time – “MM:SS.T”
Page
38
6 INDEX
Linker
A
ASCII Text File, 9, 26
ASCII Text File, 9, 26 Database, 9, 32
Scoreboard, 9, 22
C Key Definitions, 22
TXT, 9, 26
COM port, 16
P
D
Port
Database Linker, 9, 32 COM, 16
DataLink, 8, 22
Device Manager, 15 R
E Requirements, 12
Installation, 16 T
K Template, 26, 29, 31
Title Template, 26, 29, 31
Key-value pairs, 22, 26 Txt Linker, 26
TXT Linker, 9
L
LICENSE, 2, 16
Page
40
CREDITS
NewTek Marketing
NewTek Content Development
NewTek Technical Support
NewTek Customer Service
NewTek Sales
Copyright 2008 NewTek Inc., 5131 Beckwith Blvd. San Antonio, TX USA 78249.
DataLink, LiveText, TriCaster, TriCaster Pro, TriCaster Pro FX, TriCaster STUDIO,
TriCaster Broadcast, SpeedEDIT, LiveControl, 3Play, VT, VT[3], VT[4], VT[5], Video
Toaster, Toaster, Inspire 3D, 3D Arsenal and Aura are trademarks of NEWTEK.
LightWave and LightWave 3D are registered trademarks of NEWTEK. All other
brand names, product names, or trademarks belong to their respective holders.
Page
42