Avid Data Receiver. Installation and Administration Guide. v 1.6. Avid make manage move media

Transcription

1 Avid make manage move media Avid Data Receiver Installation and Administration Guide v 1.6

2 Copyright and Disclaimer Product specifications are subject to change without notice and do not represent a commitment on the part of Avid Technology, Inc. The software described in this document is furnished under a license agreement. You can obtain a copy of that license by visiting Avid's Web site at The terms of that license are also available in the product in the same directory as the software. The software may not be reverse assembled and may be used or copied only in accordance with the terms of the license agreement. It is against the law to copy the software on any medium except as specifically allowed in the license agreement. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, for any purpose without the express written permission of Avid Technology, Inc. Copyright 2005 Avid Technology, Inc. and its licensors. All rights reserved. Printed in USA. The following disclaimer is required by Sam Leffler and Silicon Graphics, Inc. for the use of their TIFF library: Copyright Sam Leffler Copyright Silicon Graphics, Inc. Permission to use, copy, modify, distribute, and sell this software [i.e., the TIFF library] and its documentation for any purpose is hereby granted without fee, provided that (i) the above copyright notices and this permission notice appear in all copies of the software and related documentation, and (ii) the names of Sam Leffler and Silicon Graphics may not be used in any advertising or publicity relating to the software without the specific, prior written permission of Sam Leffler and Silicon Graphics. THE SOFTWARE IS PROVIDED AS-IS AND WITHOUT WARRANTY OF ANY KIND, EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. The following disclaimer is required by the Independent JPEG Group: Portions of this software are based on work of the Independent JPEG Group. The following disclaimer is required by Ray Sauers Associates, Inc.: Install-It is licensed from Ray Sauers Associates, Inc. End-User is prohibited from taking any action to derive a source code equivalent of Install-It, including by reverse assembly or reverse compilation, Ray Sauers Associates, Inc. shall in no event be liable for any damages resulting from reseller s failure to perform reseller s obligation; or any damages arising from use or operation of reseller s products or the software; or any other damages, including but not limited to, incidental, direct, indirect, special or consequential Damages including lost profits, or damages resulting from loss of use or inability to use reseller s products or the software for any reason including copyright or patent infringement, or lost data, even if Ray Sauers Associates has been advised, knew or should have known of the possibility of such damages. Attn. Government User(s). Restricted Rights Legend U.S. GOVERNMENT RESTRICTED RIGHTS. This Software and its documentation are commercial computer software or commercial computer software documentation. In the event that such Software or documentation is acquired by or on behalf of a unit or agency of the U.S. Government, all rights with respect to this Software and documentation are subject to the terms of the License Agreement, pursuant to FAR (a) and/or DFARS (a), as applicable. Trademarks 888 I/O, Adrenaline, AirPlay, AirSPACE, AirSPACE HD, AniMatte, AudioSuite, AudioVision, AutoSync, Avid, Avid DNA, Avid DNxHD, AVIDdrive, AVIDdrive Towers, Avid Mojo, AvidNet, AvidNetwork, AVIDstripe, Avid Unity, Avid Xpress, AVoption, AVX, CamCutter, ChromaCurve, ChromaWheel, DAE, D-Fi, D-fx, Digidesign, Digidesign Audio Engine, Digidesign Intelligent Noise Reduction, DigiDrive, Digital Nonlinear Accelerator, DigiTranslator, DINR, D-Verb, Equinox, ExpertRender, FieldPak, 2

3 Film Composer, FilmScribe, FluidMotion, HIIP, HyperSPACE, HyperSPACE HDCAM, IllusionFX, Image Independence, Intraframe, is9, is18, is23, is36, Lo-Fi, Magic Mask, make manage move media, Marquee, Matador, Maxim, MCXpress, Media Composer, MediaDock, MediaDock Shuttle, Media Fusion, Media Illusion, MediaLog, Media Reader, Media Recorder, MEDIArray, MediaShare, Meridien, MetaSync, NaturalMatch, Nearchive, NetReview, NewsCutter, Nitris, OMF, OMF Interchange, OMM, Open Media Framework, Open Media Management, ProEncode, Pro Tools, QuietDrive, Recti-Fi, RetroLoop, rs9, rs18, Sci-Fi, Softimage, Sound Designer II, SPACE, SPACEShift, Symphony, the Avid DS logo, Trilligent, UnityRAID, Vari-Fi, Video Slave Driver, VideoSPACE, and Xdeck are either registered trademarks or trademarks of Avid Technology, Inc. in the United States and/or other countries. inews, inews ControlAir, and Media Browse are trademarks of inews, LLC. All other trademarks contained herein are the property of their respective owners. Footage Arizona Images KNTV Production Courtesy of Granite Broadcasting, Inc., Editor/Producer Bryan Foote. Canyonlands Courtesy of the National Park Service/Department of the Interior. Tornados + Belle Isle footage Courtesy of KWTV News 9. WCAU Fire Story Courtesy of NBC-10, Philadelphia, PA. Women in Sports Paragliding Courtesy of Legendary Entertainment, Inc. GOT FOOTAGE? Editors Filmmakers Special Effects Artists Game Developers Animators Educators Broadcasters Content creators of every genre Just finished an incredible project and want to share it with the world? Send us your reels and we may use your footage in our show reel or demo!* For a copy of our release and Avid s mailing address, go to *Note: Avid cannot guarantee the use of materials submitted. Avid Data Receiver Installation and Administration Guide Rev A November 2005 TLM 3

4 4

5 Contents Chapter 1 Chapter 2 Chapter 3 Using This Manual Who Should Use This Manual About This Manual If You Need Help Related Information How to Order Documentation Avid Educational Services Symbols and Conventions The Data Receiver Overview Overview Components Avid Data Receiver Service NRCS Communication Module Administration Application Site Preparation The inews Server Installing & Configuring the Data Receiver Installation and Configuration Checklist Installing the Data Receiver Software Removing The Data Receiver Software Upgrading the Data Receiver Software Data Receiver Administration Application Administration Application Overview Starting the Administration Application Menu Bar The Wire Services Menu The Help Menu Summary & Wire Instance Configuration Tabs The Summary Tab

6 Chapter 4 Chapter 5 Appendix A The Wire Configuration Tabs Making Configuration Changes Wire Service Name Section Input Section Process Section Output Section Logging Section Wire Service Instance Controls Auto Scroll Check Box Auto Scroll Check Box Start/Stop Button Get Status Button Summary Panel Wire Service Instances Wire Service Instance Overview Adding a New Wire Service Instance Starting the New Instance Removing a Wire Service Instance Adding a Previously Configured Instance Troubleshooting Data Receiver Does Not Start After Installation New Wire Service Instance Does Not Start A Previously Functional Instance Does Not Run All Previously Functional Instances Do Not Run Problems After Hardware Configuration Changes Testing COM Ports COM Port Test Shows Illegal Device Name Instance Won t start or Can t Find a COM Port Story to NRCS & Story Output Not in Sync Data Receiver Parsing Language Parsing Language Overview Parsing Language Commands Command Descriptions

7 Appendix B Appendix C Appendix D Example Parsing Language for ANPA ASCII Hexadecimal Information ASCII Hexadecimal Overview Definitions ASCII Hexadecimal Table Remote File Directory Access Remote File Directory Access Overview Prior to Setting Permissions: Setting Service Permissions Custom Code Page Support Custom Code Page Overview Custom Single Byte Custom Multi Byte Custom Shifted Index 7

8 8

9 Using This Manual The Avid Data Receiver ingests commercial news wire feeds, such as AP, Reuters, UPI and others, and formats them into individual stories within the host system to which it is attached. This manual describes the features and hardware for basic Data Receiver installation and operation. Your system may not contain certain features and hardware that appear in this manual. Who Should Use This Manual This manual is written for information systems technicians, network administrators, and any other technical personnel responsible for purchasing the equipment, preparing a site for installation, and connecting the Avid Data Receiver to the network. Portions of the manual provide operations information for system administrators who are managing the Data Receiver and guidelines for general system users. This manual provides requirements and specifications for your Data Receiver system in the following areas: System requirements Installation and set up procedures System configuration and maintenance Use this manual to prepare for and set up your system on the network, after you purchase Data Receiver components, according to Avid Technology, Inc. requirements and specifications. Before installing any equipment, the site must already have a configured network.

10 Using This Manual About This Manual This manual is designed to keep pace with current advances in the Avid Data Receiver s capabilities by consolidating in one comprehensive resource all the information you will need to take advantage of the many options available to you. The Contents lists all topics included in this manual. They are presented with the following overall structure: The Introduction helps you get oriented with beginning concepts and general workflow and provides valuable pointers to keep in mind as you proceed. The main body of this manual follows the natural flow of your work, with clear and comprehensive step-by-step procedures. Finally, a detailed Index helps you quickly locate specific topics. If You Need Help n If you are having trouble using the Avid Data Receiver: 1. Retry the action, carefully following the instructions given for that task in this manual. It is especially important to check each step of your workflow. 2. Check for the latest information that might have become available after the documentation was published in one of two locations: - If release notes are available, they ship with your application. - If ReadMe files are available, they are supplied in your Avid application folder. ReadMe files are also available from Help. Release notes and ReadMe files are also available on the Avid Knowledge Base. 3. Check the documentation that came with your Avid application or your hardware for maintenance or hardware-related issues. 10

11 Symbols and Conventions Related Information 4. Visit the online Knowledge Base at Online services are available 24 hours per day, 7 days per week. Search this online Knowledge Base to find answers, to view error messages, to access troubleshooting tips, to download updates, and to read/join online message-board discussions. 5. For Technical Support, call AVID ( ). For Broadcast On-Air Sites and Call Letter Stations, call 800-NEWSDNG ( ). n The following documents may provide more information about some of the other Avid products that integrate with the Data Receiver: Avid inews System Administration Doc Set For the latest information and documentation on all Avid products, see the Avid Knowledge Base: How to Order Documentation Avid Educational Services To order additional copies of this documentation from within the United States, call Avid Sales at AVID ( ). If you are placing an order from outside the United States, contact your local Avid representative. For information on courses/schedules, training centers, certifications, courseware, and books, please visit or call Avid Sales at AVID ( ). Symbols and Conventions Unless noted otherwise, the material in this manual applies to Windows-based operating systems. Avid documentation uses the following symbols and conventions: 11

12 Using This Manual Symbol or Convention n c w Meaning or Action A note provides important related information, reminders, recommendations, and strong suggestions. A caution means that a specific action you take could cause harm to your computer or cause you to lose data. A warning describes an action that could cause you physical harm. Follow the Manual lines in this document or on the unit itself when handling electrical equipment. > This symbol indicates menu commands (and sub commands) in the order you select them. For example, File > Import means to open the File menu and then select the Import command. t Margin tips Italic font Courier Bold font Click Double-click Right-click Drag Ctrl+key This symbol indicates a single-step procedure. Multiple arrows in a list indicate that you perform one of the actions listed. In the margin, you will find tips that help you perform tasks more easily and efficiently. Italic font is used to emphasize certain words and to indicate variables. Courier Bold font identifies text that you type. Quickly click and release the left mouse button (Windows). Click the left mouse button (Windows) twice rapidly. Quickly click and release the right mouse button (Windows only). Click and hold the left mouse button (Windows) while you move the mouse. Press and hold the first key while you press the second key. 12

13 Chapter 1 The Data Receiver Overview This chapter introduces the Data Receiver, its required components, and site preparation specifications. This section contains the following topics: Overview Components Site Preparation

14 1 The Data Receiver Overview Overview 14 The Data Receiver is a highly configurable wire server designed to handle all of a newsroom s subscription wire feeds in a single server, while enabling all inews users to have access to the data from their desktops. It replaces the legacy inews PCU by allowing all wire services to be handled by a single server or by multiple servers. It processes incoming wire data from multiple input sources including , telnet, file and traditional serial feeds in multiple data formats. It s compatible with existing inews newsroom computer systems v2.0 and later. The Data Receiver delivers wire content under demanding conditions; it caches stories as they come in so no data is lost even if the inews system is taken offline. The system captures status and error events in Data Receiver logs, and may optionally send system notifications to specified users. The administrative interface allows configuration of wire or data feeds. Individual content streams each of different formats, such as ANPA, IPTC, and NewsML, are accepted. Each instance of the Data Receiver is configurable to ingest data from these formats, as well as from the different input sources supported. The Data Receiver supports four input types: Serial allows the Data Receiver to ingest stories from a serial port on the local PC allows the Data Receiver to ingest data from a pop3 server and deletes s after they are read Telnet allows the Data Receiver to logon to a Telnet server and detect data streamed from the Telnet port File allows the Data Receiver to poll a directory on a local or remote PC at a given interval. Any files placed into this directory are ingested by the Data Receiver and deleted from the directory. Components The Data Receiver is comprised of two major components: Avid Data Receiver Service Administration Application The Data Receiver service performs the majority of the Data Receiver processing, while the Administration application allows for configuring of wire feeds and provides diagnostic tools for troubleshooting and maintaining the Data Receiver.

15 Components Avid Data Receiver Service The Data Receiver service performs the majority of the Data Receiver processing, except processing specifically related to the inews newsroom computer system. The inews communication module handles communications and the specific formatting of wire data between a wire service and the NRCS. NRCS Communication Module The Newsroom Computer System (NRCS) communications module handles the communications and formatting between a Data Receiver service and the specified NRCS. For instance, the inews communications module handles the connectivity between a wire service and the Avid inews newsroom computer system. 15

16 1 The Data Receiver Overview 16 The NRCS communication module is configurable through the wire instance configuration file. It accepts acknowledgement from the NRCS for each received story and passes it to the Avid Data Receiver Service. The communication module sends each wire item to the NRCS as a complete story rather than sending it line-by-line. inews Communication Module The inews newsroom computer system communication module communicates with the inews newsroom computer system using a wire connection service on the newsroom computer system. The module specifies the destination server through the wire instance configuration file. It supports the keyword search feature offered in inews v2.0 and provides translation of characters for instance from Unicode or code pages to the code page appropriate for the inews newsroom computer system. Additional character mapping through the Avid Data Receiver Service configuration file is supported. Administration Application The Administration application is a graphical user interface (GUI) that may be used to configure parameters or select and monitor any of the configured Data Receiver services. This application displays a summary of configured wire services and also shows their current status. The current status of each configured wire service includes: Server the name of the server on which the wire instance is running always localhost Name the name of a configured wire service Status the current state (running/stopped/disabled) of a wire service Story Input The time stamp for which something (serial data, a file, an , or the Telnet connection, depending on the instance configuration) was received on that particular Data Receiver service instance. Story To NRCS the time the last story was successfully processed and sent to the newsroom computer system #Stories the number of stories sent to the newsroom computer system Site Preparation For a successful and productive Data Receiver installation, the customer must do the following: Network and Power Requirements Provide a fully functional LAN/WAN network using TCP/IP networking protocols and install power and cable for all equipment at the site.

17 Site Preparation When serial data feeds are used, proper cabling from the receiver/modem to the Data Receiver computer is required. Hardware Purchase and install required hardware, software, and other needed equipment. The Data Receiver is supported, compatible with, and qualified with the following: t Windows XP Professional or Windows Server 2003 t inews Server v2.0 and higher The inews Server t t Digi Acceleport 8r serial card (Avid part number ) required when a site has more than one serial wire or multiple serial inputs For the latest information on hardware specifications visit: n The following steps must be completed on the inews Server. See the inews Setup and Configuration Manual, Chapter 12 - Wires, for more information. 1. The inews server license must have wire server resources added to it. Each Data Receiver instance requires its own wire server resource licensed and configured on the inews Server. 2. Wire service information must be added to the configuration file (/site/config) in the Site directory on the inews Server(s). The following format is used in the configuration file: wireserver <dev #> news <source> <join option> Parameter device # source Description The Data Receiver instance device number. The wire s source name (capitalized portion of the distribution name AP, UP, and so forth). It is the same as the source name used in the Data Receiver. join option Links stories that have the same title. It is used with wire services that routinely break stories into multiple takes. If you place join in this position, users can view all takes of a story with the get all or read all workstation commands. To leave this option out of the configuration line, enter a hyphen (-). 17

18 1 The Data Receiver Overview n n Example: wireserver 801 news AP 3. Modify the inews configuration file (/site/config) by adding the device number to a resource list entry under the host section. The format is: reslist <device #> ;<comments> For instance: reslist 801 ;data receiver instance For dual or triple server systems, the configuration file has multiple host sections to define which server handles which devices under various circumstances. Resource list entries must be added to each host section depending on which server you want the Data Receiver instances to run. 4. The Data Receiver may have a wire profile in the /site/wires directory. The only profile options associated with the Data Receiver are form and idle.the wire profile must have the same name as the Data Receiver instance s device number. To modify the wire profile, use the line editor command, ed with the following format: ed /site/wires/<device#> For help with using the line editor command, see the inews Setup and Configuration Manual, Appendix A. 5. Each Data Receiver instance must have its own set of instructions in a story, called the wire distribution story, located on the inews system in the Distribution queue in the SYSTEM.WIRES directory. This procedure is the same as Phase 3 for setting up a wire connected to a PCU port. See the inews Setup and Configuration Manual, Chapter 12 for more information. 6. After making the previous changes, do the following: a. Take the inews Server offline using the offline command. While the inews Server is offline, users will not be able to login to the system. b. Make the new resources take affect by using the configure command. c. Put the server back online using the online command. 18 n The Data Receiver processes incoming information wire stories using information obtained in the inews keyword server story. If the keyword story is updated in inews the Data Receiver automatically recognizes the updates during processing. For more information about inews Keyword Servers, see the inews Setup and Configuration Manual, Chapter 13 - Servers. The proceeding steps must be performed for each instance of the Data Receiver.

19 Chapter 2 Installing & Configuring the Data Receiver This chapter explains the installation and configuration of the Data Receiver. This section contains the following topics: Installation and Configuration Checklist Installing the Data Receiver Software Upgrading the Data Receiver Software Removing The Data Receiver Software

20 2 Installing & Configuring the Data Receiver Installation and Configuration Checklist Before you begin check the following table. It provides a checklist of steps for installing and configuring the Data Receiver and references on where to find more information about each step. Task Reference! Check requirements Site Preparation on page 16! Install the Data Receiver software Installing the Data Receiver Software on page 20! Add New Wire Service Instance(s) Adding a New Wire Service Instance on page 62 Installing the Data Receiver Software Before installing Data Receiver software, ensure the network configuration conforms to hardware and software requirements as specified by Avid. For the latest information, contact Avid Customer Support. To Install the Data Receiver software: 1. Log on to the computer on which the Data Receiver software will be installed as the System Administrator. 2. Navigate to the folder containing the installer for the Data Receiver. 3. Double click the Data Receiver setup file. The InstallShield Wizard starts configuring the Windows installer. 20

21 Installing the Data Receiver Software The InstallShield Wizard prepares to install Microsoft.NET Framework and a dialog box presents a License Agreement. 4. Read the license agreement. 5. Click the I agree radio button. 6. Click the Install button. The setup installs the.net Framework files. The following appears: 21

22 2 Installing & Configuring the Data Receiver After the.net Framework files are installed, the following dialog box appears. 7. Click the OK button. The following Data Receiver Setup dialog box appears. 22

23 Installing the Data Receiver Software 8. Click the Next Button. The Data Receiver Setup License Agreement appears. 9. Read the license agreement. 10. Click the Yes button. The Data Receiver Setup Choose Destination Location dialog box appears. 23

24 2 Installing & Configuring the Data Receiver 11. Do one of the following: t Use the Browse button to navigate and change the destination folder in which Data Receiver is to be installed. t Accept the default destination folder in which Data Receiver is to be installed. 12. Click the Next button. The Start Copying Files dialog appears allowing verification of the destination file folder. 13. Click the Next button. The Setup Status dialog appears. 24

25 Installing the Data Receiver Software After the installation is completed, the following appears: 14. Do one of the following: a. Click the Yes, I want to restart my computer radio button now. b. Clock the No, I will restart my computer later. 25

26 2 Installing & Configuring the Data Receiver 15. Click the Finish button. Removing The Data Receiver Software Avid recommends removing previously installed Data Receiver software prior to upgrading to a newer version of the Data Receiver. To Remove the Data Receiver Software: 1. Select Start > Control Panel. 2. Double click Add or Remove Programs. 3. Select Data Receiver from the list. 4. Click the Change/Remove button as shown in the following. The InstallShield Wizard appears followed by the Data Receiver Setup dialog box. 26

27 Upgrading the Data Receiver Software 5. Select the Remove radio button. 6. Click the Next button. The Data Receiver program software is removed. The Maintenance Complete dialog box appears. 7. Click the Finish button. Upgrading the Data Receiver Software n Prior to upgrading the Data Receiver software, ensure the network configuration conforms to hardware and software requirements as specified by Avid. For the latest information, contact Avid Customer Support. Avid recommends removing previously installed Data Receiver software prior to upgrading to a newer version of the Data Receiver. 27

28 2 Installing & Configuring the Data Receiver To Upgrade an Existing Data Receiver: 1. Remove previously installed Data Receiver software prior to upgrading. See Removing The Data Receiver Software on page 26 for more information. 2. From a CD or by accessing a shared network drive, double click on the setup.exe. The following dialog appears. 3. Select the Repair radio button. 4. Click the Next button. The Setup Status dialog appears showing the progress. When the upgrade is complete, the following dialog is displayed. 28

29 Upgrading the Data Receiver Software 5. Click the Finish button. 29

30 2 Installing & Configuring the Data Receiver 30

31 Chapter 3 Data Receiver Administration Application This chapter explains the Data Receiver Administration application. This chapter contains the following main sections: Administration Application Overview Menu Bar Summary & Wire Instance Configuration Tabs Wire Service Instance Controls Summary Panel

32 3 Data Receiver Administration Application Administration Application Overview The Administration application is a graphical user interface (GUI) which is used to configure parameters, select, and monitor any of the configured wire services. It also displays a summary of configured wire services and shows their current status. The current status of each configured wire service includes the wire service name, current state (running/stopped/disabled), the time the last story was sent to the newsroom computer system, and the number of stories sent to the newsroom computer system. The Data Receiver Administration window is made up of a menu bar, Summary and Configuration tabs, an Auto Scroll check box, two control buttons, and a Summary panel as shown in the following. Starting the Administration Application To start the Administration application: 1. Do one of the following: t Select Start > All Programs > Avid > Data Receiver Administration Application. t Click the Data Receiver desktop shortcut shown below. 32 The Data Receiver Administration window appears.

33 Menu Bar Menu Bar The Menu bar contains the following: The Wire Services Menu The Help Menu The Wire Services Menu The Wire Services menu has five menu options as shown in the following. The Create New Instance option is used to configure and add a new wire service instance. See Adding a New Wire Service Instance on page 62 for more information. The Add Previously Configured Instance is used to add a previously configured wire service instance to the Administration application. See Adding a Previously Configured Instance on page 65 for more information.the Remove Selected Configured Wires Services option is used to remove a selected configured instance of a wire service from the Administration application. See Removing a Wire Service Instance on page 64 for more information. The Print submenu contains two print options; Print Current Wire Service and Print Preview Current Wire Service. These options allow a user to print or preview all current instances of configured wire services. A user may preview prior to or instead of printing the wire service details. Your PC must have a printer installed to use the Print Preview option. The following is an example of a print preview. 33

34 3 Data Receiver Administration Application The Exit menu option may be used to close the Administration application window. The Help Menu The Help menu contains the following selections: Help Topics provides access to the Data Receiver help system. About displays the Data Receiver version number of the product. Summary & Wire Instance Configuration Tabs The Summary and Wire Instance Configuration tabs are the tabs displayed in the Data Receiver Administration window. The summary tab shows the details of each wire service instance configured. See The Summary Tab on page 35 for more information. The number of Wire Instance Configuration tabs and their names will vary depending on the number of wire service instances configured. See Adding a New Wire Service Instance on page 62 for more information. 34

35 Summary & Wire Instance Configuration Tabs The Summary Tab The Summary tab displays a list showing the details of each wire service instance configured. n The details of each configured instance include: Server the name of the server on which the wire instance is running always localhost Name the name of a configured wire service instance Status the current state (running/stopped/disabled/unknown) of a wire service Story Input The time stamp for which something (serial data, a file, an , or the Telnet connection, depending on the instance configuration) was received on that particular wire service instance Story To NRCS the time the last story was successfully processed and sent to the newsroom computer system The time stamp in the Story to NRCS column must must be within 1 minute of the time stamp in the Story Input column. If the time stamps for these two columns differ by more than 1 minute then the processed stories are not being successfully sent to the NRCS system and are being cached on the Data Receiver #Stories the number of stories sent to the newsroom computer system since the instance was started (the number of stories is reset each time the instance is restarted) The Summary tab has a right-click menu shown in the following graphic which allows users to start and stop a specified wire service instance and also get its current status. 35

36 3 Data Receiver Administration Application To stop or start a specific wire service instance: 1. Right-click on the row corresponding to the instance of a wire service on the Summary tab. 2. Do one of the following: t Click Start Wire Service to start the selected instance of the wire service. t Click Stop Wire Service to stop the selected instance of the wire service. t Click Get Wire Status to display the current status of the selected wire service instance. These actions may also be done by selecting the wire service instance row on the Summary tab and using the buttons located to the right of the Summary & Wire Configuration tabs. Confirmation of the operation selected appears on the Summary panel in the lower part of the Administration application window. The most current action information appears at the bottom of the list displayed. See Summary Panel on page 59 for more information. The Wire Configuration Tabs The number of tabs and their names will vary depending on the number of wire services wire service instances which have been configured. If no instances of wire services are set up, no Wire Configuration tabs appear. The Wire Configuration tabs may be used to configure and make changes to the particular wire service instance they represent. For instance, to change the details about the DD wire service instance shown in the example below, do the following: t Click the DD tab to bring it forward. 36

37 Summary & Wire Instance Configuration Tabs The tab is divided into the Wire Service Name, Input, Process, Output, and Logging sections.these sections are explained on the following pages. Making Configuration Changes After making configuration changes to the following information, the Data Receiver must be restarted. Input Type Input Character Translations Changes Changes to the story Start and End Sequence Characters Custom Code Page Translation Table Changes Output Character Translations Output inews Server Name 37

38 3 Data Receiver Administration Application Wire Service Name Section The wire service name is the name that appears on both the wire service instance s Wire Configuration tab and on the Summary tab list. The Wire Service Name section consists of a text box and a Change button as shown in the previous graphic. To change the name of the wire service instance: 1. Click the Change button to the right of the Wire Service Name text box. The Wire Service Name dialog box appears. n 2. Enter a new name for the wire service instance in the text box. 3. Click the OK button. If you have questions about making changes to the information contained in the following sections, contact Avid Customer Support. Input Section The Input section of the Wire Configuration tab allows for changing of the input configuration details for the wire service instance. These details include the source Type, Translations, and Data Capture settings. This section also allows the user to change, enable or disable an individual instance of a wire service if it is not being used currently or is only used occasionally. For instance, when a wire service is used for reporting election information, after the election is over, the wire is still providing input to the Data Receiver log file. Maintaining and purging the log file requires PC resources. The user may want to disable the wire service when it is not in use in order to conserve resources but still be able to quickly re-enable the wire service again in the future for use as needed without having to reconfigure all of the settings each time. 38

39 Summary & Wire Instance Configuration Tabs This section describes how to change, enable or disable an individual instance of a wire service. To change a wire service input type: 1. Click the Change button located next to the Type text box. The Select Input Type dialog box appears. The Data Receiver also supports the accessing of file directories over a network connection. Its File Input module may be configured to use a share on a remote PC. See Appendix C for more information on this configuration. 39

40 3 Data Receiver Administration Application n The information displayed on each tab varies depending on the input type selected. The sections that follow contain more information concerning other specific input types. 2. Select the input type from the list using the down arrow. 3. Adjust settings for the input type selected. 4. After making the configuration changes the Data Receiver must be restarted. To disable a wire service: 1. Click the Change button located next to the Input Type text box. The Select Input Type dialog box appears. 2. Select the Disable option from the Input Type list using the down arrow. n n c To enable a wire service: 1. Click the Change button located next to the Input Type text box. The Select Input Type dialog box appears. 2. Select the Input Type from the list using the down arrow. 3. Additional steps are necessary depending on details which are provided below. The majority of these settings are recommendations based on information supplied by the wire service provider. If you have questions about making changes to the information contained in the following sections, contact Avid Customer Support. For Serial Input: Select the COM Port using the down arrow. No two wire services may use the same COM port. Valid values range When configuring a wire service which is presented to the Data Receiver using 1.5 Stop bits, set the Data bits to 5 and the Stop Bits to 2. This forces the Data Receiver to use 1.5 Stop bits. Select the Baud Rate using the down arrow. Valid values are; 50, 75, 110, 150, 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 33600, 38400, Not all serial cards support all the baud rates listed in the drop-down. Before changing a baud rate, verify which baud rates your serial card can support. Select the Data Bits using the down arrow. Valid values are; 5, 6, 7, or 8. Select the Parity using the down arrow. Valid values are; None, Even, Odd, Mark, or Space. 40

41 Summary & Wire Instance Configuration Tabs Enable or disable the Parity Error Handling using the down arrow. Parity Error Handling is disabled if Parity is set to None. Enter the Parity Error Character a hexadecimal entry in the appropriate text box. The Parity Error Character is only enabled if Parity Error Handling is set to Enabled. Select the Stop Bits using the down arrow. Valid values are; 1 or 2. Select the Flow Control using the down arrow. Valid values are Disable, Hardware or Software. A setting of Hardware or Software allows the operating system to handle the Flow Control. When Flow Control is set to Software and the source parameter is serial, the following parameters must be set: Enter the XON Character hexadecimal code for a single ascii character in the appropriate text box. Enter the hexadecimal XOFF Character hexadecimal code for a single ascii character in the appropriate text box. Enter the XON Limit in the appropriate text box. Valid entries are 1-49 percent. The XON character is sent when the space available in the input buffer falls below the percent specified. Enter the XOFF Limit in the appropriate text box. Valid entries are percent. The XOFF character is sent when the space available in the input buffer rises above the percent specified. Select the Time-out settings using the up and down arrows.this is an inactivity timeout. A notification is sent when no data is received within this period. Valid values are zero (no time-out) through 24 (hours). Start Sequence The string of characters that specify the start of a story byte sequence. Valid values for the Start Sequence are one or more hexadecimal numbers between 00 and ff, separated by commas. End Sequence The string of characters that specify the end of a story byte sequence. Valid values for the End Sequence is one or more hexadecimal numbers between 0 and ff, separated by commas. Enter the Buffer Size kilobytes in the appropriate text box. This buffer holds data that has not yet been processed. The buffer needs to be large enough to collect data while the Wire Service is processing the last story it identified. Avid recommends a buffer size of 32k for a typical setup. This size may be adjusted when needed. For File Input: Select a Directory using the Select button located to the right of the text box. The directory name is limited to alpha numeric characters. 41

42 3 Data Receiver Administration Application n n Select the Poll Time settings using the up and down arrows. The Poll Time controls how often the directory is examined for new files. Valid values for Poll Time are from one second to one day. Select the Time-out settings using the up and down arrows. This is an inactivity timeout. A notification is sent if no new files are found within the specified period. Valid values are the numbers zero or from one second to one day. If the time-out is not zero, the time out must be greater than the Poll Time Interval. A value of zero will disable Time-out and a warning message is logged. Files read by the Data Receiver are deleted from the directory after they are read. For Input: Enter the Server name. Enter a valid Port Number. Values allowed are 1 through The default value is 110. Enter the User Name. Enter the User Password. Select the Poll Time settings using the up and down arrows. The Poll Time controls how often a connection to the server is made. Valid entries are from one second to one day. Select the Time-out settings using the up and down arrows. Valid entries for the CFG file are the numbers 1 through If the time-out is not zero, the time out must be greater than the Poll Interval. A value of zero will disable Time-out and a warning message is logged. Check the Enable Secure Password Authentication check box if the server uses Secure Password Authentication (SPA). The Data Receiver also supports the accessing of file directories over a network connection. Its File Input module may be configured to use a share on a remote PC. See Appendix C for more information on this configuration. Files read by the Data Receiver are deleted from the POP3 server after they are read. For Telnet Input: Enter the Server name. Enter the Port Number in the text box. The standard Telnet port is 21. Valid values for port numbers are 1 through Enter the User Name. 42

43 Summary & Wire Instance Configuration Tabs n Enter the User Password. Select Logout time using the up and down arrows. Valid values are zero or from one second to one day. If Logout Time is zero, the Wire Service remains connected to the Telnet server. If Logout Time is anything other than zero, the Wire service disconnects from the Telnet server if it does not read any data from the Telnet server during the specified Logout time period, and logs a warning message. After the disconnection, the Wire Service attempts to log on to the Telnet server at the next Poll Time Interval. Select the Poll Time settings using the up and down arrows. The Poll Time controls how often a connection to the server is made. Valid entries are from one second to one day. Select the Time-out settings using the up and down arrows. Valid entries for the CFG file are the numbers 1 through If the time-out is not zero, the time out must be greater than the Poll Interval. A value of zero will disable Time-out and a warning message is logged. Start Sequence The string of characters that specify the start of a story byte sequence. Valid values for the Start Sequence are one or more hexadecimal numbers between 0 and ff, separated by commas. End Sequence The string of characters that specify the end of a story byte sequence. Valid values for the End Sequence is one or more hexadecimal numbers between 0 and ff, separated by commas. Telnet files read by the Data Receiver are deleted from the Telnet server after they are read. n Changing the input translations involves selecting the correct character mapping and the proper custom code page for the input. After making any custom code page translation table changes or changes to the Start and End sequence characters, the Data Receiver must be restarted. 43

44 3 Data Receiver Administration Application To change the Input Translations: 1. In the Input section, click the Change button located next to the Translations text box. A dialog box appears. 2. Use the down arrow to select an input from the Character Mapping list. The following selections are available: Character Map IBM ANSI Type(s) 437 United States 1250 (Central European), 1251(Cyrillic), 1252(Latin 1), 1253(Greek), 1254(Turkish), 1255(Hebrew), 1256(Arabic), 1257(Baltic), 1258(Vietnamese) UTF -8, -16 Baudot TTS BIG5 GB Traditional Chinese Simplified Chinese Shift-JIS Japanese (Windows 932 KS Korean (Windows Hindi, Devanagari Dialect 44

45 Summary & Wire Instance Configuration Tabs Character Map Custom Type(s) Single Byte, Multi Byte, Shifted n n Select the character mapping recommended by the wire service provider. Only incoming data formatted to match the input character mapping code page selected are translated properly. Data not formatted to match the input character mapping code page selected, may not display properly. 3. Custom Code Page text box allows the user to specify the path to the text file containing the byte to byte translations table. A file and path must be specified here when Custom Single, Custom Multi Byte, or a Custom Shifted character mapping is selected in the previous Character Mapping text box. Both Custom Multi Byte or Custom Shifted code pages may also be used with single byte data input streams. See Appendix A for more information about custom code pages. 4. Check the Reverse check box to specify if certain characters, which are adjacent to each other in a data stream, are to be order reversed relative to the rest of the data stream. This option accommodates some Arabic language wires that send numeral strings in a reversed character order relative to the other alpha text of a wire story. 5. The Reverse List text box is used to specify the list of characters to be order reversed if they appear immediately adjacent to each other in the data stream. These characters must be entered in 4 Byte hex Unicode with coma separators between the 4 Byte entries. The following example Reverse List entry reverses the digits 0-9: 0030,0031,0032,0033,0034,0035,0036,0037,0038,0039 This Reverse List entry example changes the character input string of and numbers is into the character input string of and numbers is 6. Optionally, if a character(s) needs to be converted, enter the hex or other value of the input stream that you want to convert and the hex or other value of the character to which you want that character converted. As soon as you begin to populate a row, an additional row appears in case there is more than one character to convert. Character mapping is intended for use with a small number of letters or words. It is not intended for translation of entire character sets. When it is necessary to translate an entire character set, use one of the custom code page options available in the Character Mapping text box. 7. Click the OK button. 8. After making the configuration changes the Data Receiver must be restarted. 45

46 3 Data Receiver Administration Application n To change the input Data Capture: These settings are configured during the creation of the wire service instance and rarely need to be changed. If you have questions about making changes to the information in the following, contact Avid Customer Support. 1. In the Input section, click the Change button located next to the Data Capture text box. 2. When the Input Data Logging dialog box appears, check or clear the Enabled check box to turn on or off the logging feature. Process Section 3. Navigate, using the Browse button, to the path where the raw data is to be captured. 4. The name for the capture file appears in the File Name text box. 5. Enter a maximum size (in bytes) for the data log file in the Size text box. When this size is reached, raw data capturing will stop. The initial value is Click the OK button. w If you have questions about making changes to the information contained in the following section, contact Avid Customer Support. If the same process information (SFC) is used with multiple wire service instances, any changes within one instance affects the behavior of all of the other instances using that same (SFC). Making minor changes to one instance may break all other instances using that same (SFC). The Process section of the Wire Configuration tab allows for changing of the process information details contained in the SFC file for the wire service instance. 46

47 Summary & Wire Instance Configuration Tabs c Avid recommends saving a backup copy of the SFC file prior to making any changes. To change the process information: 1. In the Process section, click the Change button located next to the Information text box. The Process Information dialog box appears. 2. Click the Select button to locate and open an input file. An Open dialog box appears containing input file selections. 3. Select the Time-out duration using the up and down arrows. The time-out is used to complete the processing of a story. It also prevents looping if a story is sent which is missing a critical part the process won t endlessly search for the missing part. If processing a story takes longer than the time allowed, a Story Time-out error is logged and the story is dropped. 47

48 3 Data Receiver Administration Application 4. To change a Command, click the arrow in the command column and select the new command from the list, as shown below. 5. To add or remove a command line, right-click on the line and select the appropriate option from the pop-up menu. Output Section (Optional) click the Print button to print a copy of the input file content. 7. Click the Save button to save the changes to the Process information. 8. Click the Save As button to save this configuration as another file name creating a new SFC. The newly created file may now be easily modified and saved. this simplifies creation and management of different SFC files. If you have questions about making changes to the information contained in the following section, contact Avid Customer Support. The Output section of the Wire Configuration tab allows for changing of the output information details for the wire service instance. These details include the type and the cache settings.

49 Summary & Wire Instance Configuration Tabs To change the output type information: 1. Click the Change button located next to the Type text box. The inews Configuration dialog box appears. 2. Enter the name of the Primary server in the Primary Server text box. The Data Receiver must have a corresponding wireserver resource on the inews Server to which it may connect. The Primary server is the inews Server running the corresponding wireserver resource for this particular instance. If the name of the Primary server is changed, the Data Receiver must be restarted. 3. For Data Receiver redundancy and failover protection on second or third inews Servers, enter the server name(s) in the Backup Server1 and Backup Server2 text boxes. 49

50 3 Data Receiver Administration Application 4. Enter the port number in the Port Number text box. When an inews system is used, the port number must be set to Enter the wire source in the Wire Source text box. This must match the source specified in the /site/config file entry for a wireserver session configured on the inews Server. It is also used by the inews Server for story distribution. 6. Select the Poll Time duration using the up and down arrows. Valid Poll Time entries are one (1) second to one(1) day. This is the frequency with which the Data Receiver checks for incoming stories from inews. If there is no response, it times out. 7. Select the Time-out duration using the up and down arrows.this is the amount of time the Data Receiver checks for incoming stories. If no stories are received, Data Receiver waits until the next Poll Time before it checks for any incoming stories. Valid Timeout values are zero (0) or from one (1) second to one (1) day. 8. Click the arrow to select the code page to use for output, which matches the code page used by the newsroom computer system workstations. For instance, a news room at a station in the United States may use code page 1252 with a non-unicode version of inews. If the workstations are inews v2.5 or later, always select Unicode. If the output Character Translations are changed, the Data Receiver must be restarted. 9. Click the add and remove buttons to add or remove additional character mapping. This is used to create any custom character mapping. Output Cache Settings Data Receiver caches incoming wire stories for output later if it cannot connect to the inews Server. This is so no wire stories are lost in a situation where the inews Server is not available. Options are available for setting the maximum cache size and directory. The next time the Data Receiver successfully connects to the inews Server, processes the stories in its cache according to the cache priority setting. 50

51 Summary & Wire Instance Configuration Tabs To change the output cache settings: 1. Click the Change button located next to the Cache Setting text box. The output cache contains stories which are ready to be sent to the newsroom computer system. The Output Cache Configuration dialog box appears. 2. Click the Select button located to the right of the Cache Directory text box to select a cache directory where the available stories are stored. 3. Enter the numeric cache size in the Cache Size text box. This determines the maximum size of all of the stories contained in the cache directory. 4. Click the Select button located to the right of the Backup Directory text box to select a backup directory location. This is where the stories are moved after they are removed from the cache directory. This is done after the story is successfully sent to the newsroom computer system and aids for troubleshooting purposes, if needed. 5. Enter the numeric backup size in the Backup Size text box. This is the maximum size of all of the stories contained in the backup directory. When the backup size is reached, all the stories are purged by First In, First Out (FIFO) that is, the oldest stories are removed to make room for the newer stories. 6. Select a Cache Priority using the down-arrow. This is the order in which stories are sent to the NRCS from the wire service. The options are: 51

52 3 Data Receiver Administration Application Logging Section Bulletin this is the default option it sends stories containing Bulletin strings to NRCS first followed by any other stories. If this is used and there are no bulletin stories in the cache, the stories are sent to the newsroom computer system in the order in which they were ingested. Normal this option sends stories to NRCS in the order in which they were ingested. New sends new stories to NRCS first. Selecting this option means new stories are always sent ahead of cached stories; cached stories are sent only if there are no new stories to send. Alternating this option sends new and cached stories to NRCS alternating them so that all stories are sent. When there are no cached stories, there is nothing to alternate. 7. Click the add and remove buttons to add or remove the Bulletin strings. Bulletin strings are only used when the Cache Priority is bulletin. When this is the case, stories which are bulletins get sent to the NRCS before non-bulletin stories. The processed stories are searched for each of the bulletin strings. If any bulletin string is found anywhere in the story, the story is considered a bulletin and handled appropriately. Also, multiple bulletin strings may be specified. Since the entire story is searched for the matching string, a more finely tuned search can be made by adding functionality to the story format configuration file and adding more specific strings to the final story when necessary. For instance, <!--BULLETIN--> or <!--URGENT--> and adding those same strings as Bulletin Strings. If you have questions about making changes to the information contained in the following section, contact Avid Customer Support. The Logging section of the Wire Configuration tab allows for changing of the Logging information details for the wire service instance. Logging options may include: Starting and stopping of the Wire Service Wire Service configuration changes 52

53 Summary & Wire Instance Configuration Tabs Story processing time-outs Raw data logging errors Cache status and errors Story received information Story sent information NRCS communication failures Changing Log Information Details To change the log information details: 1. Click the Change button in the Logging section.the Logging Level dialog box appears. 2. In the Event Log section, ensure the check boxes are selected for all of the types of events for which logging is needed. This is a useful troubleshooting tool particularly if you need logging for a specific area of the Data Receiver. 53

54 3 Data Receiver Administration Application w w n 3. In the OS Logging section, use the arrow to select the logging level from the list. This selection determines what messages errors, warnings, and so forth are entered in the Windows Event Viewer. Avid recommends using discretion when selecting the Info-log high-level information, warnings and errors and All-log all information, warnings, and errors OS logging options. These settings add increase the workload on the wireserver and may impede performance. 4. In the File Logging section, Use the down arrow to select a logging level and click the Select button next to the Log File Path text box to change the log file path. Avid recommends using discretion when selecting the Info-log high-level information, warnings and errors and All-log all information, warnings, and errors File logging options. These settings add increase the workload on the wireserver and may impede performance. The system administrator typically configures the path for the location in which the Data Receiver log files are stored. In the previous example, the log file path is: c:\program Files\Avid\Data Receiver\<instance_name>\logs This directory contains separate log folders for each wire service instance. By default, separate folders are created for log files belonging to each instance of wire server. This makes it easier to tell the log files apart. The Data Receiver creates a log file for each wire service instance, for each day of the week, so at any given time there are one weeks worth of logs per wire service instance. There will never be more than 7 log files per wire service instance. For example, If there are 5 wire service instances there would be 35 log files. The log file for each day is unlimited in size, so it is important to have enough hard disk space. For the latest information on hardware specifications visit: The following is the naming convention used for a log file: <GUID>.log.<Day of the week> Example: E11CD531.log.Monday In the previous example, when Monday rolls around, the log file from last week will be flushed out and a new Monday log file will be started. 54

55 Summary & Wire Instance Configuration Tabs n By default Windows hides file extensions for known file types. When Data Receiver log files are associated with a program, such as WordPad or Notepad, the extensions.monday,.tuesday, and so forth are hidden making it difficult to tell which day of the week a particular file is from. Avid recommends changing the Windows folder settings to always show file extensions. 5. When notification is needed, use the Notification section, to enter an e- mail server name, a from and destination address, and for setting the Consecutive Max. To add an destination address: t Click the Add button.the New Address dialog box appears. t t Enter the address in the text box. Click the radio button(s) that correspond to the logging levels about which notification is required. Use discretion when selecting the Logging Level. Selecting options other than Errors only will generate an extreme amount of unnecessary e- mails. t Click the OK button. To edit an destination address: t Click the Edit button.the Edit Address Information dialog box appears. 55

56 3 Data Receiver Administration Application t t t Edit the address in the text box. Click the radio button(s) that correspond to the logging levels about which notification is required. Use discretion when selecting the Logging Level. Selecting options other than Errors only will generate an extreme amount of unnecessary e- mails. Click the OK button. The Consecutive Max setting is the maximum number of consecutive s regarding any single error reported by the service. It applies to errors of the same type reported consecutively. If a different error is reported, the count is reset. When the maximum number is reached, the last will indicate that no more s will be sent regarding the problem until the instance of the service is restarted. s for other errors will continue. The value for this option is set it is placed inside the <Consecutive Max> tags located in the <Misc> section of the configuration file. Setting the value to zero (0) means there is no limit. Use the arrow to set the maximum number of consecutive s regarding errors of the same type, as shown in the following. 56

57 Summary & Wire Instance Configuration Tabs Viewing Data Receiver Log Files To view the Data Receiver log file: 1. Navigate to the location of the folder containing the log files. By default they are found in: c:\program files\<instance_name>\logs In the following example the <instance_name> is Wire2. 2. Right-click on the log you want to view. 3. Select Open from the menu. Open the file using WordPad or Notepad as shown in the following example. 57

58 3 Data Receiver Administration Application The previous example shows a Log file for a wire instance with a GUID of 2905C09F, for Wednesday, opened with WordPad. The log shows stories coming in from a serial AP wire and being filed to inews. Wire Service Instance Controls The Wire Service Instance controls are located to the right of the Summary & Wire Configuration tabs. The controls are as follows: Auto Scroll Check Box Start/Stop Button Get Status Button These controls allow immediate updates with respect to a specific instance of a wire service. Auto Scroll Check Box When checked, the Auto Scroll immediately allows for the newest information to appear on the bottom of a specific Information tab rather than waiting for the next specified interval. 58

59 Summary Panel Auto Scroll Check Box When checked, the Auto Scroll immediately allows for the newest information to appear on the bottom of a specific Information tab rather than waiting for the next specified interval. Start/Stop Button The Start/Stop button allows the user to immediately start or stop the specific instance of the wire service selected. c To stop or start a specific instance of a wire service: 1. Click the row corresponding to the instance of a wire service on the Summary tab. 2. Click the Start/Stop button located to the right of the Summary & Configuration tabs. The status of the specific instance selected changes. Stopping a wire service instance results in the loss of any data arriving while the instance is stopped. This may also be done by selecting the instance of a wire service on the Summary tab and using the right-click menu selection. Get Status Button The Get Status button allows the user to immediately Get the current status of the specific instance of the wire service selected. To get the status of a specific instance of a wire service: 1. Click the row corresponding to the instance of a wire service on the Summary tab. 2. Click the Get Status button. The current status is updated for the specific instance selected and is displayed in the in the status column of the Summary tab. This may also be done by selecting the instance of a wire service on the Summary tab and using the right-click menu selection. Summary Panel The lower portion of the Administration application window is known as the Summary panel. It displays information about a specified service s activity. 59

60 3 Data Receiver Administration Application For instance, to view information about the DD wire service instance: t Click the row corresponding to the DD wire service instance, as shown below.the most current activity appears at the bottom of the list and is updated at predetermined intervals or when the Get Status button is clicked.use the scroll bar to view all activity appearing on the list. 60

61 Chapter 4 Wire Service Instances This chapter explains wire service instances.this section contains the following topics: Wire Service Instance Overview Adding a New Wire Service Instance Starting the New Instance Removing a Wire Service Instance Adding a Previously Configured Instance

62 4 Wire Service Instances Wire Service Instance Overview Each wire service instance contains built in parsing language that allows it to input many kinds of raw data including data received from a commercial news service and convert that data into an acceptable format for the connected inews newsroom computer system. A wire feed or data feed refers to data received from a commercial news service such as the Associated Press (AP), Reuters, United Press International (UPI) and others. Typically these wire providers conform to one or more standards, such as ANPA, and are delivered as serial data. It uses a basic two buffer concept: the input data buffer, and the output buffer. The input buffer is not comprised of true raw data but rather, data converted to Unicode (UTF-16) where additional character modifications may be applied to it if they are required. See To change the Input Translations: on page 44 for more information. The input buffer contains a single story, and includes any StartSequence and StopSequence characters. The output buffer is initially empty and is populated as data is formatted for output to the inews newsroom computer system. Adding a New Wire Service Instance n Wire service instances are configured after the Data Receiver software is installed.this section contains the following procedures related to wire service configuration: When a new instance is created and added to the Administration application, the instance resource must also be added to the inews Server. See the Avid inews Operations & Troubleshooting Manual for more information. To create a new wire service instance: 1. Start the Data Receiver Administration application. See Starting the Administration Application on page 32 for more information. 2. Select the Create New Instance option from the Wire Services menu. The Configure an Instance of the Data Receiver dialog box appears. 62

63 Adding a New Wire Service Instance 3. Enter a name for this new instance in the Instance Name text box. 4. Click the Find button located next to the Process File text box. 5. Select the story format configuration file (SFC) for use by this instance. 6. Click the OK button. The Configure Directories dialog box appears. 7. Accept the default Logging, Cache, and Backup directories these paths may vary and click the OK button. The following dialog appears: 8. Click the OK button.the new instance appears in the Data Receiver Application window. 63

64 4 Wire Service Instances 9. Click the newly added instance tab. Make any necessary changes to the Input, Process, Output, and Logging information as required to enable the new instance to work properly with the wire input source and the inews newsroom computer system. See The Wire Configuration Tabs on page 36 for more information. 10. Start the new instance. Starting the New Instance To start the new instance: 1. Click the Summary tab and select the row in the grid containing the new instance. 2. Do one of the following: t Click the Start/Stop button. The new instance starts and begins to process stories. t Right-click on the row corresponding to the instance of a wire service on the Summary tab and select the Start Wire Service option from the menu. Removing a Wire Service Instance n To completely remove a wire service instance, it must be removed from the Data Receiver Administration window and the WS.exe.config file. If an instance is removed only from the Data Receiver Administration window it may be added again later, if needed. Procedures for doing both are provided in this section. The following action removes the Wire Service from the view of the Administration Application. The WS.exe.config file is what the back-end service actually reads to determine what Wire Service to run. So, to fully stop a Wire Service from running, it must be removed from the WS.exe.config file as well. The Data Receiver Service must be restarted, from the control panel, anytime something is added, deleted or changed by a user in the WS.exe.config file. To remove an instance of a wire service from the Data Receiver Administration window: 1. Start the Data Receiver. See Starting the Administration Application on page 32 for more information. 2. On the Summary tab, click the row containing the instance you want to remove. 3. Click the Wire Services menu. 4. Select the Remove Selected Configured Wires Services option.the instance is removed from the Data Receiver Administration window. 64

65 Adding a Previously Configured Instance 5. Restart the Data Receiver. See Starting the Administration Application on page 32 for more information. n To remove the line entry for a wire service from the WS.exe.config file: When an instance is removed from the WS.exe.config file, it may not be added back using the Add Previously Configured Instance option. 1. Navigate to Start > Control Panel > Services and stop the Avid Data Receiver service. 2. Navigate to the directory where the Avid Data Receiver is installed. 3. Right-click the WS.exe.config file. 4. Select Open With and Choose Program. Use WordPad or Notepad to open the WS.exe.config file. Four instances are circled in the previous WS.exe.config file example. 5. Select the entry for the instance you want to remove. 6. Delete the entry. 7. Save and close the file. Adding a Previously Configured Instance If a previously configured instance was removed from the Data Receiver Administration window but not removed from the WS.exe.config file, it may be added back to the application at any time. 65

66 4 Wire Service Instances To add a previously configured instance to the Data Receiver Administration window: 1. Start the Data Receiver Administration application. See Starting the Administration Application on page 32 for more information. 2. Click the Wire Services menu. 3. Select the Add Previously Configured Instance option. The Add New Wire Service dialog box appears. 4. Click the Sel button located to the right of the Filename text box. The Open dialog box appears. 5. Select the previously configured CFG file from the list. 6. Click the Open button. The Add New Wire Service dialog box appears with the Filename, GUID, and Name information filled in as shown in the following example. 66

67 Adding a Previously Configured Instance n 7. Click the Add button. The previously configured instance appears in the Data Receiver Application window. 8. Start the instance. See Starting the New Instance on page 64 for more information. In the summary section of the Data Receiver Administration window, if a status of unknown is displayed in the status column for a wire service instance, it may mean that the instance was removed from the WS.exe.config file. You may need to create a new instance or manually edit the WS.exe.config file. 67

68 4 Wire Service Instances 68

69 Chapter 5 Troubleshooting This chapter contains Data Receiver troubleshooting information. This chapter contains the following main sections: Data Receiver Does Not Start After Installation New Wire Service Instance Does Not Start A Previously Functional Instance Does Not Run All Previously Functional Instances Do Not Run Problems After Hardware Configuration Changes Testing COM Ports Story to NRCS & Story Output Not in Sync

70 5 Troubleshooting Data Receiver Does Not Start After Installation If a newly installed Data Receiver wire instance does not run after the installation it may be because the PC has not been restarted. Restart the PC to correct the problem. New Wire Service Instance Does Not Start If a newly installed Data Receiver wire service instance does not run after the installation it may be because a specified resource, such as COM port cannot be located. There may have been a COM port hardware failure on the PC running the Data Receiver, such as lightning damage to a serial port or there may be an invalid parameter in the configuration file for the instance or the SFC file. If one or more COM ports specified in the wire instance configuration have failed it may affect all COM ports on a Digi board. See Testing COM Ports on page 71 for more information. Review the Windows Event Viewer logs and Data Receiver log files for more information about the instance not starting. A Previously Functional Instance Does Not Run If a previously functional wire service instance using a serial input fail to start and the following appear in the Windows Event log there may be a COM port failure. Lower DTR error:6 CreateFile error:2 inews StartOutput ERROR:2: Read signon exception: No Service available This may happen after adding or changing an instance. See Testing COM Ports on page 71 for more information. Review the Windows Event Viewer logs and Data Receiver log files for more information about the instance not starting. All Previously Functional Instances Do Not Run If all previously functional wire service instances, using a serial input, fail to start and there are Lower DTR 6 errors in the Windows Event log there may be a COM port failure. See Testing COM Ports on page 71 for more information. 70

71 Problems After Hardware Configuration Changes Review the Windows Event Viewer logs and Data Receiver log files for more information about the instance not starting. Problems After Hardware Configuration Changes If a Data Receiverwire instance does not run after hardware configuration changes are made it may be that after making the configuration changes the Data Receiver was not restarted. Another possibility may be an invalid parameter in the configuration file for the instance or the SFC file. If one or more COM ports specified in the wire instance configuration have failed it may affect all COM ports on a Digi board. See Testing COM Ports on page 71 for more information. Review the Windows Event Viewer logs and Data Receiver log files for more information about the instance not starting. Testing COM Ports Sometimes the Digi board COM ports may appear in the Windows Device Manager but are not actually functioning properly. The following test is used to definitively confirm whether or not the COM ports are functioning correctly. To test for the existence of a COM port: 1. Stop the Avid Data Receiver service using Windows Control Panel > Administration > Services. If the following warning message appears: Click the OK button, start the Avid Data Receiver service, and stop the service again. No warning appears and the service is stopped. 2. Select Start > Run from the Windows menu. 3. Enter CMD command. A command prompt appears similar to the one shown in the following: 71

72 5 Troubleshooting 4. Type Mode COM3 at the command prompt and press Enter on the keyboard. Information about COM port 3 appears. When the Avid Data Receiver service is stopped, a result like the one shown in the previous example means that the port does exist and is not in use by any application. The COM port does not exist if the result is like the following: Illegal device name - COM3 The COM port does exist and is in use if the result is like the following: Device COM3 is not currently available 5. Repeat step 4 to verify the information for each COM port. You can also determine if the Data Receiver is using the COM ports by restarting the Avid Data Receiver service and repeating steps 2-5 for each COM port. In this case each port being used by Data Receiver should report back with the following: Device COM3 is not currently available If it does not then the Data Receiver is not using the port. 72

73 Testing COM Ports COM Port Test Shows Illegal Device Name If the COM port test results show the COM port does not exist, do one of the following: t Remove and reinstall the Digi board if driver or other serial board installation problems are suspected. t Replace the Digi board if it has been damaged or has failed Instance Won t start or Can t Find a COM Port Occasionally, when a wire service instance won t start or has problems finding a COM port it may be due to a duplicate entry in the WS.exe.config file. To check for and remove duplicate entries: 1. Stop the Avid Data Receiver service using Windows Control Panel > Administration > Services. See step1 in the previous procedure. 2. Navigate to the location of the WS.exe.config file. 3. Open the WS.exe.config file with WordPad. 4. If a duplicate entry exists delete the one of the entries, save, and close the file. 5. Restart the Avid Data Receiver service using Windows Control Panel > Administration > Services. 73

74 5 Troubleshooting Story to NRCS & Story Output Not in Sync Previously Working Configuration If in a previously working configuration, the Story to NRCS column is out of sync with the Story Input column and is not updating as new stories come in, the probable cause may be that the Data Receiver is unable to communicate with the inews server. Do the following: 1. Ensure the network connection to the inews Server or servers is present. 2. Ensure that the inews Server is running. 3. Ensure that the wiresever process is properly configured and is running on the inews Server. 4. If you suspect a problem with the inews Server,see the Avid inews Operations & Troubleshooting Manual for more information. New Configuration If in a new configuration, the Story to NRCS column is out of sync with the Story Input column and is not updating as new stories come in, the probable cause may be that the Data Receiver is unable to communicate with the inews Server. Do the following: 1. Ensure the network connection to the inews Server or servers is present. 2. Ensure that the inews Server is running. 3. Ensure the wiresever process is properly configured and is running on the inews Server. 4. Ensure the inews Server name(s) are set correctly for the inews Server(s) with which the Data Receiver is attempting to communicate. 5. Ensure the Data Receiver Wire Source setting matches the source parameter in the site config file of the inews Server. 74

75 Appendix A Data Receiver Parsing Language Parsing Language Overview The Data Receiver has a built in parsing language. This parsing language allows it to input almost any kind of raw data and transform it into an acceptable data format for the connected NRCS. The parsing language is based on buffers: the input data buffer, and the output buffer. The input buffer is raw data which has been transformed into Unicode (UTF-16). Additional character transformations may have been applied. The input buffer has a single story, and includes any StartSequence and StopSequence characters. The output buffer is initially empty for each corresponding input buffer. This appendix contains the following sections: Parsing Language Commands Command Descriptions Example Parsing Language for ANPA

76 A Data Receiver Parsing Language Parsing Language Commands The parsing language includes the following commands: Comment BeginMark EndMark ClearBeginMark ClearEndMark Move FindForward FindReverse FindMarked DeleteMarked ReplaceMarked Delete Replace Insert CopyMarked IfFound IfNotFound If IfNot ElseIf ElseIfNot Else 76

77 Parsing Language Commands The Following commands ignore any argument data: IfFound IfNotFound Else EndIf BeginMark EndMark ClearBeginMark ClearEndMark DeleteMarked CopyMarked CopyWireSource All other commands require argument data. Leading and trailing white space is significant for required argument data, except for the Replace command. The meaning of the argument data is explained with each command description following this section. The parsing language has a current position and a marked data block. The current position applies to the input buffer and is initially positioned at the first character in the buffer for each story to be processed. The current position can be changed by executing commands like Move, FindForward, FindReverse, and FindMarked. The current position may also be affected by the Delete, DeleteMarked, Replace, or ReplaceMarked commands. A marked data block consists of a beginning pointer and an end pointer. Both pointers are initially cleared for each story to be processed. By manipulating the current position, the beginning pointer and the end pointer may be set to mark one or more characters in the input buffer. Both pointers must be set to mark a block of characters, and it is considered an illegal marked data block if the end pointer precedes the beginning pointer. The marked data block may be used for comparisons, such as If, IfNot, ElseIf, ElseIfNot. The marked data block may also be used for data manipulation, such as Delete, DeleteMarked, Replace, ReplaceMarked, FindMarked, or copied to the output buffer by using the command CopyMarked. 77

78 A Data Receiver Parsing Language Command Descriptions 78 The Comment command displays the argument data in the console window. This command can be used for informational messages to aid in the debugging of a parsing script. This command does not change the input or output buffers. The BeginMark and EndMark commands use the current position to set the beginning pointer and end pointer for a marked data block. The ClearBeginMark and ClearEndMark commands clear the beginning pointer and end pointer. Both pointers must be set to mark a data block, and the beginning pointer must precede the end pointer for the marked block to be valid. Some commands will behave differently if the beginning pointer and end pointer are both set even if the end pointer precedes the begging pointer. The BeginMark, EndMark, ClearBeginMark, and ClearEndMark commands ignore any argument data. The Move command changes the position of the current position in the input buffer. The argument data is required and it specifies the movement of the current position. The individual characters of the argument data are processed from left to right, and are case insensitive. The plus (+) character moves the current position one position forward, but not beyond the end of the buffer. The minus (-)character moves the current position one position backwards, but not beyond the beginning of the buffer. The letter B moves the current position to the beginning of the buffer. The letter E moves the current position to the end of the buffer. The letter M moves the current position to the beginning pointer if it is set; otherwise it moves the current position to the beginning of the buffer. The letter Z moves the current position to the end pointer if it is set; otherwise it moves the current position to the end of the buffer. Any other character is ignored. The FindForward, FindReverse, and FindMarked commands search for an exact match (case sensitive) to a match string. The argument data is the required match string. The FindForward command finds the first match starting from the current position through the end of the buffer. The FindReverse command finds the last match starting from beginning of the buffer through the current position. The FindMarked command finds the first match starting from the start of the marked data block to the end of the marked data block. If a proper marked data block does not exist, the FindMarked command will always fail. After any of the find commands are executed, the found flag is set appropriately. The found flag can then be tested with the IfFound or IfNotFound commands. If the match string is found, the current position will be changed to the first character position of the matched string. For repeated find commands, the current position must be moved after a match is found; otherwise the subsequent find commands find the original matched string. The DeleteMarked command deletes the entire marked data block. If a proper marked data block doesn t exist, then the command has no effect. If the current position was in the marked data block, the current position is changed to the beginning of the buffer; otherwise

79 Command Descriptions the current position remains on the same character before the deletion. If a marked data block is deleted, the beginning pointer and the end pointer are cleared. The DeleteMarked command ignores any argument data. The ReplaceMarked command replaces the marked data block with a replacement string. The argument data is the required replacement string. If a proper marked data block doesn t exist, then the command has no effect. If the current position was in the marked data block, the current position is changed to the beginning of the buffer; otherwise the current position remains on the same character before the replacement. If a marked data block is replaced, the beginning pointer and end pointer are set to the beginning and end of the replaced string. The Delete command deletes all occurrences of a match string. The argument data is the required match string. If a valid marked data block exists, only matched strings in the marked data block will be deleted; otherwise all matched strings in the buffer will be deleted. If a valid marked data block exists, and the current position was not in the marked data block, then the current position will remain on the same character before the deletion(s); other wise the current position will be changed to the beginning of the buffer. The Replace command replaces all occurrences of a match string with a replacement string. The argument data contains the required match and replacement strings. The formatting of the argument data for the match and replacement string is as follows: leading and trailing white space is ignored; the first non-white space character is designated the delimiter character; the match string is first delimited before and after by the delimiter character, followed by the replacement string which is also delimited before and after by the delimiter character. For instance, in the following; <Process Command="Replace">?match?-?replacement?</Process> First, the Replace command is detected with the specifics of?match?-?replacement? Then, the first non-whitespace character is detected and is saved as the delimiter. In the previous example this is the question mark(?) character. Next, it finds the phrase between the first two of these, and saves it as the word to replace. It also finds the word between the third and fourth instances of this character in this example, the word replacement and saves it as the word to replace with. The program throws ignores everything else, so the hyphen does not do anything, it is there for readability. The command would not be any different if the hyphen was replaced with a comma, period, whitespace, word, no word, etc. 79

80 A Data Receiver Parsing Language 80 Finally, the program finds all of the instances of the word to be replaced in this case the word, match in the marked section and replaces it with the replacement word in this case the word replacement. The Insert command copies the argument data to the output buffer. The argument data is required. This command is generally used for adding XML tags to the output buffer. This command does not change the input buffer or any of its state variables. The CopyMarked command copies the marked data block to the output buffer. This command does not change the input buffer or any of its state variables. The CopyMarked command ignores any argument data. The IfFound and IfNotFound commands test the state of the found flag. Any argument data will be ignored. Subsequent commands will be executed or ignored until a matching Else, ElseIf, ElseIfNot, or EndIf command. The initial state of the found flag is false (not found). The If and IfNot commands compare a match string to the input buffer. The argument data is the required match string. If a valid marked data block exists, the commands compare the match string to the entire marked data; otherwise the commands compare the match string to the data in the buffer starting at the current position. If the match string matches exactly (case sensitive match), the next commands up until the next Else, ElseIf, ElseIfNot, or EndIf will be executed (ignored for IfNot). If the size of the argument data is not the same as the size of the marked data block, or if the size of the argument data is greater than the number of characters from the current position to the end of the input buffer, the comparisons will always fail. The ElseIf and ElseIfNot commands work exactly like the If and IfNot commands, but these commands must be preceded by an IfFound, IfNotFound, If, or IfNot command. Multiple ElseIf and ElseIfNot commands can be chained together to make an equivalent switch type statement. These commands will execute the subsequent commands (until the next Else, ElseIf, ElseIfNot, or EndIf command) only if none of the previous if and else type commands were considered true, and the match string matches exactly. Else command The Else command may follow any of the IfFound, IfNotFound, If, IfNot, ElseIf, of ElseIfNot commands. The Else command must be terminated by an EndIf command, and may not be followed by an ElseIf or ElseIfNot command. The Else command will cause the commands up until the EndIf command to be executed only when none of the previous if and else type commands was considered true. The EndIf command terminates a set of if and else type commands. Nesting of if commands is allowed, with no maximum nesting level.

81 Command Descriptions The CopyWireSource command pulls the wire source from the configuration file instead of hard coding it in the SFC file. The following is an example. <Process Command="Insert"><f id=create-by></process> <Process Command="CopyWireSource"></Process> <Process Command="Move">b</Process> <Process Command="FindForward">&#x01;</Process> <Process Command="Move">+</Process> 81

82 A Data Receiver Parsing Language Example Parsing Language for ANPA The following is an example of the parsing language which might be used for an ANPAtype wire. <WireProcess Type="ANPA"> <Process Command="Comment">test ANPA parse</process> <Process Command="Insert"><WireStory> </Process> <Process Command="Insert"><Source></Process> <Process Command="Insert">Associated Press</Process> <Process Command="Insert"></Source> </Process> <Process Command="FindForward">&#x01;</Process> <Process Command="Insert"><SLD></Process> <Process Command="Move">+</Process> <Process Command="BeginMark"></Process> <Process Command="EndMark"></Process> <Process Command="CopyMarked"></Process> <Process Command="Insert"></SLD> </Process> <Process Command="Insert"><StoryNumber></Process> <Process Command="Move">+</Process> <Process Command="BeginMark"></Process> <Process Command="Move">+++</Process> <Process Command="EndMark"></Process> <Process Command="CopyMarked"></Process> <Process Command="Insert"></StoryNumber> </Process> <Process Command="Insert"><SelectorCode></Process> <Process Command="FindForward">&#x1F;</Process> <Process Command="Move">+</Process> <Process Command="BeginMark"></Process> <Process Command="Move">++++</Process> <Process Command="EndMark"></Process> <Process Command="CopyMarked"></Process> <Process Command="Insert"></SelectorCode> </Process> <Process Command="Insert"><Priority></Process> <Process Command="FindForward"> </Process> <Process Command="Move">+</Process> <Process Command="BeginMark"></Process> <Process Command="EndMark"></Process> <Process Command="CopyMarked"></Process> <Process Command="Insert"></Priority> </Process> <Process Command="Insert"><Category actual="</process> <Process Command="FindForward"> </Process> <Process Command="Move">+</Process> <Process Command="BeginMark"></Process> <Process Command="EndMark"></Process> <Process Command="CopyMarked"></Process> 82

83 Example Parsing Language for ANPA <Process Command="Insert">"></Process> <Process Command="If">d</Process> <Process Command="Insert">Headlines</Process> <Process Command="ElseIf">h</Process> <Process Command="Insert">Headlines</Process> <Process Command="ElseIf">j</Process> <Process Command="Insert">Headlines</Process> <Process Command="ElseIf">g</Process> <Process Command="FindReverse"> </Process> <Process Command="Move">----</Process> <Process Command="BeginMark"></Process> <Process Command="Move">+</Process> <Process Command="EndMark"></Process> <Process Command="FindForward"> </Process> <Process Command="Move">+</Process> <Process Command="FindForward"> </Process> <Process Command="Move">+</Process> <Process Command="If">wi</Process> <Process Command="Insert">Headlines</Process> <Process Command="Else"></Process> <Process Command="Insert">State</Process> <Process Command="EndIf"></Process> <Process Command="ElseIf">q</Process> <Process Command="Insert">Sports Scores</Process> <Process Command="ElseIf">s</Process> <Process Command="Insert">Sports</Process> <Process Command="ElseIf">l</Process> <Process Command="Insert">Lifestyle</Process> <Process Command="ElseIf">c</Process> <Process Command="Insert">Features</Process> <Process Command="ElseIf">e</Process> <Process Command="Insert">Features</Process> <Process Command="ElseIf">k</Process> <Process Command="Insert">Political</Process> <Process Command="ElseIf">p</Process> <Process Command="Insert">Political</Process> <Process Command="ElseIf">o</Process> <Process Command="Insert">Weather</Process> <Process Command="ElseIf">f</Process> <Process Command="Insert">Financial</Process> <Process Command="ElseIf">m</Process> <Process Command="Insert">Markets</Process> <Process Command="Else"></Process> <Process Command="FindReverse"> </Process> <Process Command="Move">----</Process> <Process Command="BeginMark"></Process> <Process Command="Move">+</Process> <Process Command="EndMark"></Process> <Process Command="FindForward"> </Process> <Process Command="Move">+</Process> <Process Command="FindForward"> </Process> <Process Command="Move">+</Process> <Process Command="If">ki</Process> <Process Command="Insert">Farm</Process> 83

84 A Data Receiver Parsing Language <Process Command="ElseIf">wi</Process> <Process Command="Insert">State</Process> <Process Command="ElseIf">ia</Process> <Process Command="Insert">Regional</Process> <Process Command="ElseIf">il</Process> <Process Command="Insert">Regional</Process> <Process Command="ElseIf">mi</Process> <Process Command="Insert">Regional</Process> <Process Command="ElseIf">mn</Process> <Process Command="Insert">Regional</Process> <Process Command="Else"></Process> <Process Command="BeginMark"></Process> <Process Command="EndMark"></Process> <Process Command="If">a</Process> <Process Command="Insert">National</Process> <Process Command="ElseIf">w</Process> <Process Command="Insert">National</Process> <Process Command="ElseIf">i</Process> <Process Command="Insert">International</Process> <Process Command="Else"></Process> <Process Command="Insert">Other</Process> <Process Command="EndIf"></Process> <Process Command="EndIf"></Process> <Process Command="EndIf"></Process> <Process Command="Insert"></Category> </Process> <Process Command="FindForward">&#x12;</Process> <Process Command="IfNotFound"></Process> <Process Command="Insert"><Text/> </Process> <Process Command="Else"></Process> <Process Command="Insert"><Tabular/> </Process> <Process Command="EndIf"></Process> <Process Command="FindForward"> </Process> <Process Command="Move">+</Process> <Process Command="BeginMark"></Process> <Process Command="FindForward"> </Process> <Process Command="Move">-</Process> <Process Command="EndMark"></Process> <Process Command="Insert"><Keyword></Process> <Process Command="CopyMarked"></Process> <Process Command="Insert"></Keyword> </Process> <Process Command="Move">++</Process> <Process Command="BeginMark"></Process> <Process Command="Move">+</Process> <Process Command="FindForward"> </Process> <Process Command="Move">-</Process> <Process Command="EndMark"></Process> <Process Command="IfNot"> </Process> <Process Command="Insert"><Version></Process> <Process Command="CopyMarked"></Process> <Process Command="Insert"></Version> </Process> <Process Command="EndIf"></Process> 84

85 Example Parsing Language for ANPA <Process Command="Move">++</Process> <Process Command="BeginMark"></Process> <Process Command="Move">+</Process> <Process Command="FindForward"> </Process> <Process Command="Move">-</Process> <Process Command="EndMark"></Process> <Process Command="IfNot"> </Process> <Process Command="Insert"><Reference></Process> <Process Command="CopyMarked"></Process> <Process Command="Insert"></Reference> </Process> <Process Command="EndIf"></Process> <Process Command="Move">++</Process> <Process Command="BeginMark"></Process> <Process Command="FindForward"> </Process> <Process Command="Move">-</Process> <Process Command="EndMark"></Process> <Process Command="Insert"><Date></Process> <Process Command="CopyMarked"></Process> <Process Command="Insert"></Date> </Process> <Process Command="Move">++</Process> <Process Command="BeginMark"></Process> <Process Command="FindForward"> </Process> <Process Command="Move">-</Process> <Process Command="EndMark"></Process> <Process Command="Insert"><WordCount></Process> <Process Command="CopyMarked"></Process> <Process Command="Insert"></WordCount> </Process> <Process Command="FindForward">&#x02;</Process> <Process Command="EndMark"></Process> <Process Command="Move">b</Process> <Process Command="BeginMark"></Process> <Process Command="DeleteMarked"></Process> <Process Command="ClearBeginMark"></Process> <Process Command="ClearEndMark"></Process> <Process Command="Delete">&#x00;</Process> <Process Command="Delete">&#x01;</Process> <Process Command="Delete">&#x04;</Process> <Process Command="Delete">&#x05;</Process> <Process Command="Delete">&#x06;</Process> <Process Command="Delete">&#x07;</Process> <Process Command="Delete">&#x0B;</Process> <Process Command="Delete">&#x0C;</Process> <Process Command="Delete">&#x0E;</Process> <Process Command="Delete">&#x0F;</Process> <Process Command="Delete">&#x10;</Process> <Process Command="Delete">&#x11;</Process> <Process Command="Delete">&#x12;</Process> <Process Command="Delete">&#x13;</Process> 85

86 A Data Receiver Parsing Language <Process Command="Delete">&#x14;</Process> <Process Command="Delete">&#x15;</Process> <Process Command="Delete">&#x16;</Process> <Process Command="Delete">&#x17;</Process> <Process Command="Delete">&#x18;</Process> <Process Command="Delete">&#x19;</Process> <Process Command="Delete">&#x1A;</Process> <Process Command="Delete">&#x1B;</Process> <Process Command="Delete">&#x1C;</Process> <Process Command="Delete">&#x1D;</Process> <Process Command="Delete">&#x1E;</Process> <Process Command="Delete">&#x1F;</Process> <Process Command="Replace">"< ","&#x1b;&#x1b;"</process> <Process Command="Replace">"<","&#x1B;"</Process> <Process Command="Replace">"^","&#x1B;"</Process> <Process Command="Replace">" ","&#x1b;&#x1b;"</process> <Process Command="Replace">"&#x08;","&#x1B;"</Process> <Process Command="Replace">" ","&#x1b;&#x1b; "</Process> <Process Command="Delete"> </Process> <Process Command="Delete"> </Process> <Process Command="Move">b</Process> <Process Command="FindForward">&#x1B;</Process> <Process Command="IfFound"></Process> <Process Command="Move">+</Process> <Process Command="FindForward">&#x1B;</Process> <Process Command="IfFound"></Process> <Process Command="Move">+</Process> <Process Command="FindForward">&#x1B;</Process> <Process Command="IfFound"></Process> <Process Command="Move">+</Process> <Process Command="FindForward">&#x1B;</Process> <Process Command="IfFound"></Process> <Process Command="Move">+</Process> <Process Command="FindForward">&#x1B;</Process> <Process Command="IfFound"></Process> <Process Command="Replace">" "," "</Process> <Process Command="EndIf"></Process> <Process Command="EndIf"></Process> <Process Command="EndIf"></Process> <Process Command="EndIf"></Process> <Process Command="EndIf"></Process> <Process Command="Replace">" ","&#x1b;"</process> <Process Command="Replace">" &#x1b;","&#x1b;"</process> <Process Command="Replace">" &#x1b;","&#x1b;"</process> <Process Command="Replace">" &#x1b;","&#x1b;"</process> <Process Command="Replace">"&#x1B;&#x1B;&#x1B;&#x1B;&#x1B;","&#x1B;&#x1B;"</Process> <Process Command="Replace">"&#x1B;&#x1B;&#x1B;&#x1B;","&#x1B;&#x1B;"</Process> <Process Command="Replace">"&#x1B;&#x1B;&#x1B;","&#x1B;&#x1B;"</Process> <Process Command="Replace">"&#x1B;"," "</Process> 86

87 Example Parsing Language for ANPA <Process Command="Replace">" ["," 1/8"</Process> <Process Command="Replace">" \"," 1/4"</Process> <Process Command="Replace">" ]"," 3/8"</Process> <Process Command="Replace">" {"," 1/2"</Process> <Process Command="Replace">" "," 5/8"</Process> <Process Command="Replace">" }"," 3/4"</Process> <Process Command="Replace">" ~"," 7/8"</Process> <Process Command="Replace">"["," 1/8"</Process> <Process Command="Replace">"\"," 1/4"</Process> <Process Command="Replace">"]"," 3/8"</Process> <Process Command="Replace">"{"," 1/2"</Process> <Process Command="Replace">" "," 5/8"</Process> <Process Command="Replace">"}"," 3/4"</Process> <Process Command="Replace">"~"," 7/8"</Process> <Process Command="Replace">.''.,.".</Process> <Process Command="Replace">.``.,.".</Process> <Process Command="Replace">"&","&amp;"</Process> <Process Command="Replace">"<","&lt;"</Process> <Process Command="Replace">">","&gt;"</Process> <Process Command="Replace">"&apos;","&apos;"</Process> <Process Command="Replace">.".,.&quot;.</Process> <Process Command="Move">b</Process> <Process Command="BeginMark"></Process> <Process Command="EndMark"></Process> <Process Command="If"> </Process> <Process Command="Move">++</Process> <Process Command="BeginMark"></Process> <Process Command="EndMark"></Process> <Process Command="If"> </Process> <Process Command="Move">++</Process> <Process Command="BeginMark"></Process> <Process Command="EndIf"></Process> <Process Command="EndIf"></Process> <Process Command="FindForward"> </Process> <Process Command="Move">-</Process> <Process Command="EndMark"></Process> <Process Command="FindMarked">,</Process> <Process Command="IfFound"></Process> <Process Command="Move">-</Process> <Process Command="EndMark"></Process> <Process Command="EndIf"></Process> <Process Command="Insert"><Slug></Process> <Process Command="CopyMarked"></Process> <Process Command="Insert"></Slug> </Process> <Process Command="FindForward"> </Process> <Process Command="Move">++</Process> <Process Command="FindForward"> </Process> <Process Command="Move">++</Process> 87

88 A Data Receiver Parsing Language <Process Command="FindForward"> </Process> <Process Command="EndMark"></Process> <Process Command="FindMarked"> EBS </Process> <Process Command="IfFound"></Process> <Process Command="Insert"><EBS/> </Process> <Process Command="EndIf"></Process> <Process Command="FindMarked">FLASH</Process> <Process Command="IfFound"></Process> <Process Command="Insert"><FLASH/> </Process> <Process Command="EndIf"></Process> <Process Command="FindMarked">URGENT</Process> <Process Command="IfFound"></Process> <Process Command="Insert"><URGENT/> </Process> <Process Command="EndIf"></Process> <Process Command="FindMarked">BULLETIN</Process> <Process Command="IfFound"></Process> <Process Command="Insert"><BULLETIN/> </Process> <Process Command="EndIf"></Process> <Process Command="FindForward">&#x03;</Process> <Process Command="Move">-</Process> <Process Command="EndMark"></Process> <Process Command="Insert"><Body> </Process> <Process Command="CopyMarked"></Process> <Process Command="Insert"> </Body> </Process> <Process Command="Move">++</Process> <Process Command="BeginMark"></Process> <Process Command="FindForward"> </Process> <Process Command="Move">-</Process> <Process Command="EndMark"></Process> <Process Command="Delete">APTV-</Process> <Process Command="Delete">APEX-</Process> <Process Command="Insert"><DateTime></Process> <Process Command="CopyMarked"></Process> <Process Command="Insert"></DateTime> </Process> <Process Command="Insert"></WireStory> </Process> </WireProcess> 88

89 Appendix B ASCII Hexadecimal Information ASCII Hexadecimal Overview Some information in the Data Receiver configuration is entered in hexadecimal format. This appendix contains some helpful definitions and also includes an ASCII Hexadecimal table.

90 B ASCII Hexadecimal Information Definitions ASCII ASCII stands for American Standard Code for Information Interchange and was developed by the American National Standards Institute (ANSI). It is the most common format for text files in computers and on the Internet. In an ASCII file, each alphabetic, numeric, or special character is represented with a 7-bit binary number (a string of seven 0s or 1s). There are 128 possible characters defined. This format may be understood by any computer and the file may be imported into their own applications without issues. Notepad.exe creates ASCII text, or in MS Word you can save a file as text only. Character A character is one of a limited number of symbols, including the letters of a particular language's alphabet, the numerals in the decimal number system, and certain characters such as the ampersand (&) and at sign (@). There are several standards of computer encoding for characters the most common of which is ASCII. Decimal The term decimal describes the base-10 number system. The system consists of ten singledigit numbers: 0, 1, 2, 3, 4, 5, 6, 7, 8, and 9. The number after 9 is 10. The number after 19 is 20 and so forth. Additional powers of 10 require the addition of another positional digit. 90

91 ASCII Hexadecimal Table Hexadecimal Hexadecimal also known as hex describes a base-16 number system. The hexadecimal numbers are 0-9 and then use the letters A-F. Hex notation is a convenient way to express binary numbers in which a byte is defined as containing eight binary digits. For instance, when expressing a string of text characters or a string of binary values in coding a program or HTML page, one hex digit can represent the arrangement of four binary digits and two hex digits can represent eight binary digits, or a byte. ASCII Hexadecimal Table The following is an ASCII character table including decimal & hexadecimal characters. Character Name Char Code Decimal Hex Null NUL 0 00 Start of Heading SOH Ctrl A 1 01 Start of Text STX Ctrl B 2 02 End of Text ETX Ctrl C 3 03 End of Transmit EOT Ctrl D 4 04 Enquiry ENQ Ctrl E 5 05 Acknowledge ACK Ctrl F 6 06 Bell BEL Ctrl G 7 07 Back Space BS Ctrl H 8 08 Horizontal Tab TAB Ctrl I 9 09 Line Feed LF Ctrl J 0 0A Vertical Tab VT Ctrl K 11 0B Form Feed FF Ctrl L 12 0C Carriage Return CR Ctrl M 13 0D Shift Out SO Ctrl N 14 0E Shift In SI Ctrl O 15 0F 91

92 B ASCII Hexadecimal Information Character Name Char Code Decimal Hex Data Line Escape DLE Ctrl P Device Control 1 DC1 Ctrl Q Device Control 2 DC2 Ctrl R Device Control 3 DC3 Ctrl S Device Control 4 DC4 Ctrl T Negative Acknowledge NAK Ctrl U Synchronous Idle SYN Ctrl V End of Transmit Block ETB Ctrl W Cancel CAN Ctrl X End of Medium EM Ctrl Y Substitute SUB Ctrl Z 26 1A Escape ESC Ctrl [ 27 1B File Separator FS Ctrl \ 28 1C Group Separator GS Ctrl ] 29 1D Record Separator RS Ctrl ^ 30 1E Unit Separator US Ctrl _ 31 1F Space Exclamation Point! Shift Double Quote Shift Pound/Number Sign # Shift Dollar Sign $ Shift Percent Sign % Shift Ampersand & Shift Single Quote Left Parenthesis ( Shift Right Parenthesis ) Shift

93 ASCII Hexadecimal Table Character Name Char Code Decimal Hex Asterisk * Shift A Plus Sign + Shift B Comma,, 44 2C Hyphen/Minus Sign D Period E Forward Slash / / 47 2F Zero digit One Digit Two Digit Three Digit Four Digit Five Digit Six Digit Seven Digit Eight Digit Nine Digit Colon : : 58 3A Semicolon ; ; 59 3B Less Than Sign < Shift < 60 3C Equals Sign = = 61 3D Greater Than Sign > Shift > 62 3E Question Mark? Shift? 63 3F At Capital A A Shift A Capital B B Shift B Capital C C Shift C

94 B ASCII Hexadecimal Information Character Name Char Code Decimal Hex Capital D D Shift D Capital E E Shift E Capital F F Shift F Capital G G Shift G Capital H H Shift H Capital I I Shift I Capital J J Shift J 74 4A Capital K K Shift K 75 4B Capital L L Shift L 76 4Cc Capital M M Shift M 77 4D Capital N N Shift N 78 4E Capital O O Shift O 79 4F Capital P P Shift P Capital Q Q Shift Q Capital R R Shift R Capital S S Shift S Capital T T Shift T Capital U U Shift U Capital V V Shift V Capital W W Shift W Capital X X Shift X Capital Y Y Shift Y Capital Z Z Shift Z 90 5A Left Bracket [ [ 91 5B Backward Slash \ \ 92 5C Right Bracket ] ] 93 5D 94

95 ASCII Hexadecimal Table Character Name Char Code Decimal Hex Caret ^ Shift E Underscore _ Shift _ 95 5F Back Quote Lower-Case A a A Lower-Case B b B Lower-Case C c C Lower-Case D d D Lower-Case E e E Lower-Case F f F Lower-Case G g G Lower-Case H h H Lower-Case I i I Lower-Case J j J 106 6A Lower-Case K k K 107 6B Lower-Case L l L 108 6C Lower-Case M m M 109 6D Lower-Case N n N 110 6E Lower-Case O o O 111 6F Lower-Case P p P Lower-Case Q q Q Lower-Case R r R Lower-Case S s S Lower-Case T t T Lower-Case U u U Lower-Case V v V Lower-Case W w W

96 B ASCII Hexadecimal Information Character Name Char Code Decimal Hex Lower-Case X x X Lower-Case Y y Y Lower-Case Z z Z 122 7A Left Brace { Shift{ 123 7B Vertical Bar/Pipe Shift 124 7C Right Brace } Shift } 125 7D Tilde ~ Shift ~ 126 7E Delta r 127 7F 96

97 Appendix C Remote File Directory Access Remote File Directory Access Overview When required, the Data Receiver supports accessing of file directories over a network connection. If Network share access is required, the Data Receiver s File Input module must be configured, as described in this appendix, to use that share. To support accessing a remote share the Windows user account which the Data Receiver service uses to log on must be a regular user account. By default, the Data Receiver service is installed to use the local system account. The local system account cannot be used for accessing shares over a network. The user account which has access permissions to the remote share directory must be the same user account that the Data Receiver service uses. This may be a Windows domain based account or a local account which uses Pass-through authentication. Pass-through authentication is achieved when the user accounts designated for this purpose have the exact same user name and passwords on both computers. For the purpose of this Appendix, a local DataRX user account is used to illustrate this configuration requirement. Because both user accounts must be identical, this is done for both the PC with the share directory, and the PC where the Data Receiver is installed. Prior to Setting Permissions: To verify file sharing: 1. Launch Windows Explorer. 2. Select Tools > FolderOptions. 3. Click the View tab.

98 C Remote File Directory Access 4. In the Advanced settings section, ensure the Use Simple File Sharing check box is not selected. 5. In the Folder views section, click the Apply to all folders button. 6. Click OK To set up the Data Receiver User Account (DataRX): 1. Using Windows Explorer, browse to the folder Data Receiver will be accessing. 2. Right-click that folder and then choose properties. 3. Click the Security tab. 98

99 Prior to Setting Permissions: 4. Click to select the DataRX user account. 5. In the Permissions for DataRX section, set the file and share permissions for the file share to use this account. Assign this account full permissions as shown in the previous graphic. 6. Click the Apply button. 7. Click the OK button. 8. Click the Sharing Tab. 99

100 C Remote File Directory Access 9. Ensure the Share this folder radio button is selected. 10. Ensure the Maximum allowed radio button is selected. 11. Click the Permissions button. 100

101 Prior to Setting Permissions: n 12. In the Permissions for Data RX section, ensure the Full Control check box is selected. The user account used for the Avid Data Receiver Service must have Full Control access permissions to the local cache directories, backup directories, and logging directories. If these permissions are not set the file backup, caching, and logging directories will not be able to be updated properly. The following are the default directory names that must have their user access permissions changed to match the user account used for the Avid Data Receiver Service: <install dir>\raw.log c:\logs c:\wirecache c:\wirebackup A typical installation has a series of unique directory names for each Data Receiver input instance, all of these directories must have their permissions set correctly. 13. Click the Apply button. 101

102 C Remote File Directory Access 14. Click the OK button and close Windows Explorer. Setting Service Permissions To set the service permissions: 1. Select Start > Control Panel > Administrative Tools. 2. Double-click Services. 3. Double-click Avid Data Receiver. 4. If a Services warning dialog appears, click the OK button. 5. The Avid Data Receiver Properties (Local Computer) dialog box appears. 6. Select the Log On tab. 7. Click the This account radio button. 8. Enter the account name. 102