Rf Builder Um

157
RFBuilder (Developers Studio)  Release 2.6

Transcript of Rf Builder Um

  • 5/22/2018 Rf Builder Um

    1/157

    RFBuilder

    (Developers Studio) Release 2.6

  • 5/22/2018 Rf Builder Um

    2/157

    PSC INC. RF Builder

    END USER SOFTWARE LICENSE AGREEMENT

    NOTICE: Your use of the RF Builder Software and Documentation(Licensed Products) is conditioned on your accepting and agreeing to theterms and conditions set forth in this Agreement. By using the LicensedProducts, you agree to be bound by the terms of this Agreement. If you do

    not intend to be bound to the terms of this Agreement, PSC is unwilling tolicense the Licensed Products to you. In such event, you may not use orcopy the Licensed Products, and you should promptly contact the seller ofthe Licensed Products for instructions on return of the unused LicensedProducts for a refund.

    This End User Software License Agreement (Agreement) is a legal agreement betweenthe entity or person who has purchased the Licensed Products (End User) and PSC Inc.,

    its subsidiaries and affiliates, (PSC), and governs the licensing of the Licensed Products byPSC to End User. Any software provided along with the Licensed Products that is

    associated with a separate end-user license agreement is licensed to you under the terms ofthat license agreement. PSC and End User agree as follows:

    1. Definitions.1.1 Authorized Use means End Users Use of the Licensed Productsexclusively with PSCs Falcon DOS Portable Data Terminals, Falcon DOSVehicle Mount Terminals, and/or Falcon DOS Fixed Station Data Terminals(Falcon terminal) solely for End Users internal business purposes.

    1.2 "Documentation" means materials such as users guides, programming guides,manuals, or other similar materials associated with or related to the Software, whether inprinted, online, or electronic form.

    1.3 "Licensed Products" means the Software and Documentation acquired by End User.

    1.4 "Software" means the RF Builder Software consisting of terminal emulator software

    and server software and includes any related update or upgrade such as enhancements ormodifications, whether obtained directly or indirectly from PSC. Software shall also

  • 5/22/2018 Rf Builder Um

    3/157

    A Guide to Using RF Studio iii

    mean any other software or computer program of PSC or its third party licensors inmachine readable form acquired by End User, including any related update or upgrade

    such as enhancements or modifications, whether obtained directly or indirectly from PSC.

    1.5 "Proprietary Information" means all (a) source code, object code, software,

    documentation, and any related internal design, system design, data base design,algorithms, technology, technical data or information, implementation techniques, and

    trade secrets related to the Licensed Products and (b) any other trade secrets markedappropriately or identified as proprietary or confidential, or any information that End User,under the circumstances, should recognize as confidential. Proprietary Information does

    not include any information that the receiving party can establish was (1) in the publicdomain, (2) already in the receiving partys possession or rightfully known prior to receipt,

    (3) rightfully learned from a third party not in violation of any other's proprietary rights, or(4) independently developed.

    1.6 "Use" means storing, installing, copying, downloading, accessing, executing,

    operating, or displaying any portion of the Licensed Products by End User on anyhardware device.

    2. Scope of License Granted.

    2.1 Unless End User has purchased a multiple user license, this Agreement grants EndUser a license to install a single copy of the Software on a single Falcon terminal. If End

    User has purchased a multiple user license, End User is granted a license to install a copy

    of the Software on the number of Falcon terminals authorized on the printed label of theSoftware package.

    2.2 The license granted to End User by PSC shall be a non-exclusive, non-transferable,terminable license to use the Software in machine-readable form only, solely for EndUser's internal business purposes. This Agreement does not convey ownership of theLicensed Products to End User. Title to the Licensed Products shall be and remain withPSC or the third party licensor from whom PSC has obtained a licensed right. As used inthis Agreement, the term purchase or its equivalents shall mean acquire under license.End User acknowledges that the Licensed Products constitute valuable trade secrets ofPSC or PSCs third party licensors and that the Licensed Products are protected byintellectual property laws and treaties. End User is not entitled to receipt or use of thesource code to any Software.

    2.3 End User represents that the Licensed Products acquired under this Agreement will beacquired for End Users sole use, and not for resale or transfer. End User shall not copy,

  • 5/22/2018 Rf Builder Um

    4/157

    modify, decompile, disassemble, reverse engineer, or otherwise reproduce orremanufacture the Licensed Products, whether modified or unmodified, nor sell, assign,

    sublicense, distribute, lend, rent, give, or otherwise transfer them to any other person or

    organization, for purposes other than as expressly provided in this Agreement, withoutPSCs prior written consent.

    3. Payment and Taxes.

    3.1 Unless otherwise agreed in writing, prices will be as set forth in PSC's price list ineffect for the Licensed Products. Prices and license fees do not include freight, insurance,sales tax, customs duties or other similar charges. Any such charges or taxes will be added

    to the price or separately invoiced to End User unless End User provides PSC with acertificate of exemption from the applicable taxing authority.

    3.2 Any copying, installing, reproduction, reverse-engineering, electronic transfer, or otheruse of the Licensed Products on other than the number of Falcon terminals for which End

    User has purchased a license, or on any non-Falcon equipment, will be a material breach of

    this Agreement. However, PSC may elect not to terminate this Agreement or the grantedlicense, but instead may elect to notify End User that End User is deemed to have orderedand accepted a license for each breaching use. End User shall pay PSC the applicable list

    price fees as of the date of such breach as determined by PSC.

    4. Intellectual Property.

    Software and documentation unpublished copyright 2002, by the DataMAX Software

    Group, Inc., All Rights Reserved under the copyright laws of the United States. Falcon

    is a registered trademark of PSC Inc. and its wholly owned subsidiaries and RF Builderis a trademark of PSC, Inc. The license set forth in this Agreement does not transfer toEnd User any ownership of PSCs or its third party licensors' copyrights, patents,trademarks, service marks, trade secrets, or other intellectual property rights and End User

    shall have no right to commence any legal actions to obtain such rights. End User shall

    not remove, modify, or take any other action that would obscure any copyright,trademark, or other intellectual property notices contained in the Licensed Products.

    5. Proprietary Information.

    5.1 End User acknowledges that Proprietary Information is the confidential, proprietary,and trade secret property of PSC and PSCs third party licensors and End User acquires

    no right or interest in any Proprietary Information.

  • 5/22/2018 Rf Builder Um

    5/157

    A Guide to Using RF Studio v

    5.2 End User shall not disclose, provide, or otherwise make available the ProprietaryInformation of PSC or its third party licensors to any person other than End Users

    authorized officers, directors, employees, agents, or contractors, all of whom must be

    under confidentiality agreement, or use the Proprietary Information for other than theAuthorized Use, without PSCs prior written consent. End User shall take at least

    reasonable steps to protect the Proprietary Information and shall protect it no less securelythan if it were End User's own intellectual property.

    5.3 The provisions of this Proprietary Information Section shall survive and continue forfive (5) years after the termination of this Agreement.

    6. Limited Warranty.

    PSC warrants that, under normal use and operation, the Software will conformsubstantially to the applicable Documentation for a period of ninety (90) days fromdelivery to End User. During this period, for all reproducible nonconformities for which

    PSC has been given written notice, PSC will use commercially reasonable efforts to

    remedy the nonconformities. End User agrees to supply PSC with all reasonably requestedinformation and assistance necessary to help PSC in remedying such nonconformities. Forall defects reported to PSC within the warranty period, PSCs liability is limited to

    providing End User with one copy of corrections or refunding End User's purchase price,at PSC's discretion, and responding to End User's software problem reports according toPSC's standard assistance practices. PSC does not warrant that the Licensed Products will

    meet End User's requirements or that use of the products will be uninterrupted or error

    free, or that PSC's remedial efforts will correct any nonconformance. This limitedwarranty does not cover any software that has been subjected to damage or abuse,whether intentionally, accidentally, or by neglect, or to unauthorized repair orunauthorized installation, and shall be void if End User modifies the Software, uses the

    Software in a manner other than as established in the Documentation, or if End Userbreaches any of the provisions of this Agreement.

    THE LICENSED PRODUCTS ARE PROVIDED AS IS AND, EXCEPT ASPROVIDED IN THIS SECTION, PSC MAKES NO WARRANTIES OF ANY

    KIND, EXPRESS OR IMPLIED, WRITTEN OR ORAL, WITH RESPECT TO

    THE LICENSED PRODUCTS, AND SPECIFICALLY DISCLAIMS THE

    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A

    PARTICULAR PURPOSE.

    7. Infringement.

  • 5/22/2018 Rf Builder Um

    6/157

    7.1 PSC will defend End User against any claim that the Licensed Products furnishedhereunder infringe a United States patent, trademark, or copyright of a third party andPSC will pay any damages finally awarded against End User by a court of competent

    jurisdiction that are attributable to such claim or will pay End Users part of any settlement

    that is attributable to such claim, provided, that 1) End User notifies PSC promptly inwriting of the claim, 2) PSC controls the defense or settlement of the claim, and 3) EndUser cooperates fully with PSC in such defense or settlement. All notices of a claimshould be sent to PSC Inc., Legal Department, 111 SW Fifth Ave. Suite 4100, Portland,OR 97204-3644.

    7.2 In the defense or settlement of any such claim, PSC may, at its option, 1) procure for

    End User the right to continue using the Licensed Products, 2) modify the LicensedProducts so that they become non-infringing, 3) replace the Licensed Products with anequivalent product not subject to such claim, or 4) provide End User an opportunity toreturn the Licensed Products and receive a refund of the purchase price paid, less areasonable allowance for use.

    7.3 PSC shall have no liability to End User for claims of infringement based upon 1) the

    use of any Licensed Product in combination with any product which PSC has not eitherfurnished or authorized for use with such Licensed Product, 2) the use of any LicensedProduct designed, manufactured, or modified to the specifications of End User, or 3) EndUsers modification of the Licensed Products without written authorization from PSC.

    THE FOREGOING STATES PSCS COMPLETE AND ENTIRE OBLIGATION

    TO END USER CONCERNING CLAIMS OF PATENT, TRADEMARK,

    COPYRIGHT, OR OTHER INTELLECTUAL PROPERTY INFRINGEMENT,

    CANCELS AND SUPERCEDES ANY PRIOR AGREEMENTS, WHETHERORAL OR WRITTEN, BETWEEN PSC AND END USER CONCERNING SUCH

    CLAIMS, AND WILL NOT BE MODIFIED OR AMENDED BY ANY PAST,

    CONTEMPORANEOUS, OR FUTURE AGREEMENTS OR DEALINGS

    BETWEEN PSC AND END USER, WHETHER ORAL OR WRITTEN, EXCEPT

    AS SET FORTH IN A FUTURE WRITING SIGNED BY AN AUTHORIZED

    REPRESENTATIVE OF EACH PARTY.

    8. Limitation of Liability.

    EXCEPT AS PROVIDED IN SECTION 7, PSC SHALL NOT BE LIABLE FOR

    ANY CLAIMS AGAINST END USER BY ANY OTHER PARTY NOR SHALL

    PSC'S LIABILITY FOR DAMAGES, IF ANY, WHETHER BASED UPON

    CONTRACT, TORT (INCLUDING NEGLIGENCE), PRODUCT LIABILITY,

    STRICT LIABILITY, WARRANTY, OR ANY OTHER BASIS, EXCEED THE

    PRICE OR FEE PAID BY END USER FOR THE LICENSED PRODUCTS.

  • 5/22/2018 Rf Builder Um

    7/157

    A Guide to Using RF Studio vii

    UNDER NO CIRCUMSTANCES SHALL PSC BE LIABLE TO END USER OR

    ANY THIRD PARTY FOR LOST PROFITS, LOST DATA, INTERRUPTION OF

    SERVICE, OR FOR ANY SPECIAL, CONSEQUENTIAL, CONTINGENT,

    INDIRECT, INCIDENTAL, PUNITIVE, EXEMPLARY, OR OTHER SIMILARDAMAGES, EVEN IF PSC HAS BEEN ADVISED OF THE POSSIBILITY OF

    SUCH DAMAGES.

    9. Government Restricted Rights; International Use.

    The Licensed Products are provided with Restricted Rights. Use, duplication, ordisclosure by the U.S. Government is subject to the restrictions for computer software

    developed at private expense as set forth in the U.S. Federal Acquisition Regulations atFAR 52.227-14(g), or 52.227-19 or in the Rights in Technical Data and Computer

    Software clause at DFARS 252.227-7013(c)(1)(ii), whichever is applicable. If End Useris using the Licensed Products outside of the United States, End User must comply withthe applicable local laws of the country in which the Licensed Products are used, with

    U.S. export control laws, and with the English language version of this Agreement.

    10. Termination.10.1 Either party may terminate this Agreement or any license granted under this

    Agreement at any time upon written notice if the other party fails to comply withany material term or condition. PSC may terminate this Agreement immediatelyin the event that End User (i) fails to pay any amount that is due within thirty (30)days of receiving a written demand, (ii) breaches any provision of this

    Agreement unless such breach is corrected or cured within fifteen (15) days afterreceipt of written notice from PSC, (iii) transfers any substantial part of itsbusiness or in any manner ceases to continue its business, or experiences anymaterial change or transfer in its management or control, or (vi) becomesinsolvent, voluntarily files a petition in bankruptcy, becomes the subject of aninvoluntary bankruptcy proceeding which is not dismissed within thirty (30) days,or is otherwise the subject of an action provided by law which is intended torelieve it from any of its debts.

    10.2 Upon termination of this Agreement, End User immediately shall ceaseusing the Software and shall return to PSC or destroy all Licensed Productscovered by this Agreement, and shall furnish PSC with a certificate ofcompliance with this provision signed by an officer or authorized representativeof End User.

    11. General Provisions.

  • 5/22/2018 Rf Builder Um

    8/157

    11.1 Entire Agreement; Amendment. This document contains the entire agreementbetween the parties relating to the subject matter contained herein and supersedes all prior

    or contemporaneous agreements, written or oral, between the parties. This Agreement

    may not be changed, amended, or modified except by written document signed by anauthorized representative of each party. No promise or representation which is not

    contained herein constituted an inducement to either party or was relied upon by eitherparty in entering into this Agreement.

    11.2 Notice. All notices required or authorized under this Agreement shall begiven in writing and shall refer to this Agreement. Notices to End User shall be

    sent to such address as End User shall provide to PSC in writing. Notices toPSC shall be sent to the attention of Contract Administration, PSC Inc., 959Terry Street, Eugene, OR 97402, or such other address as may be specified byPSC in writing. All notices shall be effective when received, with evidence ofreceipt.

    11.3 Waiver. If either party fails to perform any of its obligations under this Agreement

    and the other party fails to enforce the relevant provisions, such failure to enforce shall notprevent later enforcement of those provisions.

    11.4 Assignment. PSC may assign this Agreement or any of its rights under thisAgreement without giving prior notice to End User. End User may not sublicense, assign,

    pledge, lease, rent, or otherwise transfer this Agreement, and the rights under it, whethervoluntarily or by operation of law, without PSCs prior written consent. No attempt to

    assign or transfer in violation of this provision shall be valid or binding upon PSC.

    11.5 Severability. Should any clause or section of this Agreement be determined to beinvalid or unenforceable, that provision shall be interpreted so as to most closely reflectthe original intent of the parties in an enforceable manner and the remainder of the

    Agreement will remain in full force and effect.

    11.6 Governing Law. This Agreement shall be governed by the laws of the State ofOregon, United States of America, excluding choice of law provisions.

    11.7 Attorneys Fees. In the event an action is brought to enforce the terms and conditionsof this Agreement, the prevailing party shall be entitled to reasonable attorneys fees, both

    at trial and on appeal.-END-

  • 5/22/2018 Rf Builder Um

    9/157

    A Guide to Using RF Studio ix

  • 5/22/2018 Rf Builder Um

    10/157

  • 5/22/2018 Rf Builder Um

    11/157

    A Guide to Using RF Studio i

    Table Of Contents

    1.Introduction................................................................1About The Developers Studio ............................................. 1

    RFBuilder Enterprise vs. Express Release.......................2Before You Begin................................................................2Loading the Software ..........................................................3Database Connection Indicators..........................................4The Studio Menu Bar ..........................................................4Studio Import/Export Utilities...............................................5

    2.Configuring................................................................8Configuring Your (Main) Database Connection ..................8

    Configuring Data Sources................................................ 10Configuring Network Devices............................................12Configuring Network Graphical Devices .......................... 14Configuring RFBuilder System Options ........................... 15Configuring RFBuilder Services.......................................17Identifying Scanner Preamble and Postamble Entries.......18Configuring RFBuilder Function Keys ..............................19Configuring Your RFBuilder Database.............................20Configuring Desktop Settings............................................21RFBuilder Graphical Mode................................................22Configuring Additional Databases....................................24

    3. How RFBuilder Works.............................................26Studio Overview ...............................................................26Comserver Overview........................................................27RFBuilder Basic Implementation Steps............................. 28

    4. Data Fields-Download.............................................29Field Download Procedure................................................29Editing Table Fields ..........................................................30Database Views (Combining Tables)................................. 31Modifications To Your Database(s) ...................................33

    5.RF System Development Tools ..............................34The Studio Forms Tab ...................................................... 34

    The Form Selection Tab..................................................35The Form Design Tab......................................................35The Unlinked Object........................................................36

  • 5/22/2018 Rf Builder Um

    12/157

    A Guide to Using RF Studio ii

    The Options Object......................................................... 37The Listbox Object.......................................................... 37The ComboBox Object.................................................... 38The CheckBox Object..................................................... 38

    The Image Object (Graphical Item)................................. 38The CommandButton (Graphical Item)............................ 38The Form Properties Tab................................................ 39The Form Properties Tab: Primary Key Designation......... 41The Form Properties Tab: Options Object Properties ....... 42The Form Properties Tab: Field Events (VBA ScriptingOverview)......................................................................... 42The Form FormProperties Tab........................................ 45

    The Studio Menus Tab ..................................................... 46The Studio Users Tab....................................................... 47The VBA Modules Tab ..................................................... 48VBA Help/Documentation................................................. 51The Applications Testing Tab ........................................... 52Network Applications Testing............................................ 54The Studio SQL Windows Tab ......................................... 54The Error Log Tab ............................................................ 55

    6. SQL Statements, Lists & Listboxes ........................ 56SQL Statements............................................................... 56Lists ................................................................................. 57Listboxes.......................................................................... 58

    7.To Activate Your RF Network ................................. 59Install the RFBuilder Communications Server .................. 59

    Appendix 1: Data Entry Default Properties ................. 60Defaults Defined............................................................... 60Text Default ..................................................................... 60System Date Default ........................................................ 60System Time Default........................................................ 61Translate Default - Displaying Data From Other Tables.... 61Concatenation Default ...................................................... 62Character String Extraction Default .................................. 62Calculation Defaults ......................................................... 62Last/Prior Entry Default .................................................... 63Skip the Current Entry Default .......................................... 63SQL Statement (List) Default........................................... 64Lists (Listing Choices) Default .......................................... 64

    Appendix 2: Data Entry Validation/ Edit Properties .... 65Validations/Edits Defined.................................................. 65Text (Character String) Validation .................................... 65

    Pattern Match Validation .................................................. 65Pattern Not Allowed Validation ......................................... 66Alpha Only Validation ....................................................... 66

  • 5/22/2018 Rf Builder Um

    13/157

    A Guide to Using RF Studio iii

    Numeric Only Validation ...................................................66Integer Only Validation......................................................66Greater Than Validation....................................................66Less Than Validation.........................................................67

    Not Equal To Validation .................................................... 67Data Range Validation ...................................................... 67Index Validation ................................................................67Contains String Validation.................................................68Branch/Goto Validation..................................................... 68Strip (Data Entry) Validations............................................68

    Appendix 3: Visual Basic Scripts.................................69Visual Basic for Applications (VBA) Scripts Defined ......................69

    Global User Defined Subroutines and Functions............................ 69Using External ActiveX files in the VBA Environment....................70VBA Global Variables/Objects....................................................... 70VBA Declarations ..........................................................................71VBA Events...................................................................................71

    Click ................................................................................. 71GotFocus..........................................................................72Keypress...........................................................................72Load ................................................................................. 72OnConnect .......................................................................72OnDisconnect ...................................................................73OnCursor ..........................................................................73OnEnter ............................................................................73OnEscape.........................................................................74OnFkey.............................................................................74OnIdentify.........................................................................75OnReadData.....................................................................75OnRefresh ........................................................................76OnReturn..........................................................................76OnScan ............................................................................76OnTimer ...........................................................................76OnUpdate .........................................................................77Unload .............................................................................. 77

    VBA Extensions By Type...............................................................77VBA Extensions 1: Field/Prompt Values ........................................78RFClearValues .................................................................78RFGetValue......................................................................78RFSetValue ......................................................................79

    VBA Extensions 2: Prompt Properties............................................79RFPrompt().Caption..........................................................79RFPrompt().Defaults.........................................................80

    RFPrompt().DisplayOnly...................................................80RFPrompt().Edits..............................................................80RFPrompt().ErrMsg...........................................................81

  • 5/22/2018 Rf Builder Um

    14/157

    A Guide to Using RF Studio iv

    RFPrompt().FieldId........................................................... 81RFPrompt().Format.......................................................... 82RFPrompt().LabelLeft....................................................... 82RFPrompt().LabelTop....................................................... 82

    RFPrompt().Length........................................................... 83RFPrompt().Required....................................................... 83RFPrompt().Text .............................................................. 83RFPrompt().TextLeft ........................................................ 84RFPrompt().TextTop ........................................................ 84RFPrompt().ValTable ....................................................... 85RFPrompt().ValField ........................................................ 85RFPrompt().Visible........................................................... 85

    VBA Extensions 3: Listbox Properties ........................................... 86RFPrompt().AddItem ........................................................ 86RFPrompt().Clear............................................................. 87RFPrompt().Highlight........................................................ 87RFPrompt().List................................................................ 87RFPrompt().ListIndex ....................................................... 88RFPrompt().PageDown .................................................... 88RFPrompt().PageUp......................................................... 88

    RFPrompt().RemoveItem................................................. 89RFPrompt().ScrollDown.................................................... 89RFPrompt().ScrollUp........................................................ 89RFPrompt().Sorted........................................................... 90

    VBA Extensions 4: Database Access ............................................ 90DBCount .......................................................................... 90DBExecute ....................................................................... 91DBExtract......................................................................... 91

    DBOpenResultset............................................................. 92DBUseDataSource ........................................................... 93

    VBA Extensions 5: Transaction Control......................................... 93DBBeginTrans.................................................................. 93DBCommitTrans............................................................... 93DBRollbackTrans ............................................................. 94

    VBA Extensions 6: Lists & Input Functions .................................... 94DBMakeList...................................................................... 94RFMakeList...................................................................... 95RFShowList...................................................................... 95RFGetInput ...................................................................... 96RFMsgBox ....................................................................... 96

    VBA Extensions 7: SerIal Device Functions .................................. 97RFSetCommPort.............................................................. 97RFSendCommPort........................................................... 98RFPrinterOn..................................................................... 98RFPrinterOff..................................................................... 98RFSend............................................................................ 98

  • 5/22/2018 Rf Builder Um

    15/157

    A Guide to Using RF Studio v

    VBA Extensions 8: Windows Printer..............................................99PCopies............................................................................99PEndDoc ..........................................................................99PFontBold.........................................................................99

    PFontItalic ......................................................................100PFontName ....................................................................100PFontSize.......................................................................100PFontStrikeThru..............................................................100PFontUnderline...............................................................101PGetName......................................................................101PNewPage......................................................................101POrientation.................................................................... 102

    PPageWidth ...................................................................102PPrint .............................................................................102PPrintQuality ..................................................................102PSelect...........................................................................103

    VBA Extensions 9: RF Environment............................................103RFKeyPressEnabled....................................................... 103RFCallForm....................................................................104RFCallMenu....................................................................104

    RFExitForm ....................................................................104RFExitSession................................................................104RFGetIPAddr..................................................................105RFGetUser .....................................................................105RFGoto...........................................................................105RFPrompNo....................................................................106RFSetDisplay..................................................................106RFSetMenu ....................................................................106

    RFSetUser...................................................................... 108RFGetClientType............................................................108RFSleep .........................................................................108

    VBA Extensions 10: The Stored Procedure Object......................109The dbStoredProc Object..... Error! Bookmark not defined.The dbParam Object............ Error! Bookmark not defined.

    The dbStoredProc Object.................Error! Bookmark not defined.dbStoredProc Properties: .................Error! Bookmark not defined.

    CommandText..................... Error! Bookmark not defined.CommandTimeout .......................................................... 109CommandType ...............................................................109Prepared.........................................................................110Data................................................................................ 110Dict ................................................................................. 111DataSource.....................................................................111

    Results............................................................................111Param.............................................................................111The dbParam Object...................................................................111

  • 5/22/2018 Rf Builder Um

    16/157

    A Guide to Using RF Studio vi

    dbParam Properties: ....................................................................111Datatype..........................................................................112Direction..........................................................................113Size.................................................................................114

    Value...............................................................................114dbStoredProc Methods: ...............................................................115CreateParameter.............................................................115Execute...........................................................................115

    VBA Extensions 10A: Stored Procedures .....................................115DBCallProc (must be used with Sybase)........................116DBCallActionSP (not used with Sybase).......................117DBCallSelectSP (not used with Sybase)........................118

    VBA Extensions 11: Terminal Control...........................................119RFBell.............................................................................119RFClearScreen................................................................119RFClearEOP...................................................................119RFClearEOL....................................................................120RFPrint............................................................................120RFRefresh.......................................................................120RFResetCursor................................................................121

    RFReverseOn .................................................................121RFReverseOff.................................................................121

    VBA Extensions 12: Timer Functions ...........................................121TimerEnabled..................................................................121TimerInterval...................................................................122

    VBA Extensions 13: Error Handling..............................................122dbErr.Clear......................................................................122dbErr.Count.....................................................................122

    dbErr().Description ..........................................................122dbErr().NativeError..........................................................123dbErr().Number ...............................................................123

    VBA Extensions 14: Dynamic Arrays............................................123Dynamic Array Structure .................................................123Why Use RFBuilder Dynamic Arrays? .............................124INSERT...........................................................................124REPLACE .......................................................................125DELETE..........................................................................125EXTRACT .......................................................................126LOCATE..........................................................................126DCOUNT (Delimiter Count) .............................................127Field................................................................................128

    Appendix 4: Reserved Words................................... 129SQL Reserved Words .....................................................129

    Index......................................................................... 132

  • 5/22/2018 Rf Builder Um

    17/157

    Developers Assistant 1

    1.Introduction

    About The Developers Studio(hereafter the Studio)

    The RFBuilder 'Studio' system is a Microsoft Windowsbased software system that gives numerous 'Data Base

    Management System' (DBMS) users the ability to programadvanced 'Radio Frequency Data Collection' (RFDC)applications via an easy-to-use windows based developmentsystem. Studioallows programming results to be achievedin hours, instead of days or weeks. The system is structuredto interface with most Host systems using SQL. A majoradvantage of the Studio is that no investment in datacollection hardware is required until users are ready to place

    their programs into actual use.To place the system into full usage, a second RFBuilderSoftware module, the Communications Server (hereafterthe 'Comserver'), is required to enable RF networkcommunications. Comserver is a communicationsserver/session enabler and manager that allows datacollection devices to interact with your Host system(s) in amulti-user mode. Active devices may be viewed andmanaged from the console of an RFBuilder based computersystem by means of an administrator program included withthe Comserver. This program is installed automatically whenthe Communications Server Software (see separatedocumentation) is installed.

    The visual components of an RFBuilder based developmentprocess are established via the Studio 'Forms', 'Menus', and

    'User' development modules. Each module appears as atab on the Studio main screen display. Many features of theRFBuilder based RF development system are available as'properties. For example, numerous RF data entry features(including data defaults, data edits/validations, tablelookups, etc.) have already been pre-programmed. Inpractice only a minimum of (or no) actual programming maybe required to create a data collection application. The

    programming language used by RFBuilder is compatible

  • 5/22/2018 Rf Builder Um

    18/157

    Developers Assistant 2

    with Visual Basic for Applications (VBA), the language usedby Microsoft in its suite of Office products.

    RFBuilder Enterprise vs. ExpressRelease

    If you are using the entry level RFBuilder Express releaseyoull be pleased to know that your software provides justabout everything contained in the Enterprise release. Hereare the differences:

    RFBuilder Enterprise supports an unlimited number of

    remote users; RFBuilder Express is limited to five, oroptionally to ten.If your needs include more than tenusers, youll need RFBuilder Enterprise.

    RFBuilder Enterprise supports up to five different datasources simultaneously; RFBuilder Express supportsonly one data source.

    RFBuilder Enterprise supports up to five different datasources RFBuilder Enterprise supports Connection

    Pooling, the ability to run many remote users withlimited (or even just one) database licenses. RFBuilderExpress requires a database license for eachRFBuilder user for databases such as SQL Server,Sybase, Oracle, etc. (i.e. products that are licensedby user).In contrast, products that are not licensed by

    user (i.e. Microsoft Access, Excel, FoxPro, and others)function the same with either RFBuilder Enterprise orRFBuilder Express.

    RFBuilder Enterprise may be run as a WindowsService or as a Task, whereas RFBuilder Expressruns as a Windows Task only.

    Before You Begin

    It is necessary to understand the basic concepts of yourData Base Management System (DBMS), and the structureof your particular business system if applicable to fully utilizeStudios capabilities. Please refer to your systemdocumentation for this information. Knowledge of datastructures is of particular importance. Since it is necessaryto understand the basic concepts of 'tables', 'fields/columns',and 'data types' before proceeding further.

  • 5/22/2018 Rf Builder Um

    19/157

    Developers Assistant 3

    Knowing your particular database Structured QueryLanguage (SQL) 'syntax', and the Microsoft VisualBasic/VBA programming language will be helpful in thedevelopment of advanced RF data collection applications.

    Loading the Software

    The RFBuilder CDROM is set to 'Autoplay' when the CD isinserted into your CDROM drive. If the CD does notautoplay, click Start, then Run, then open 'CDSetup.exe' onyour CDROM drive. Installation menu selections include:

    RFBuilder EnterpriseDevelopment Studio (*)Communications Server

    RFBuilder ExpressDevelopment Studio (*)Communications Server

    Windows CE (Graphical Clients)HPC Clients

    Palm PC ClientsPocket PC Clients

    Additional ProgramsMDAC (*)Adobe PDF Reader (*)

    Items marked with an (*) are required for the base Studiomodule. All RFBuilder Software items are loaded to your\Program Files\RFBuilder directory by default. A MicrosoftAccess database called 'RFBuilder.mdb' is also loaded withthe Studio. This database houses the applicationprograms/objects written with the Studio.

    The Communications Server(for licensed RFBuilder users

    only) is the main communications server program, it allows(multiple) remote devices to use the server. RFBuildersNetwork Administrator program allows users to view andmanage remote devices. Control of the communicationsserver is accomplished by RFBuilder Service ControlManager. This program allows the communication server tobe started manually or automatically, as a Windows task oras an NT service when your server hardware is booted.

    To use the Studio, your system will need an additional set ofsoftware programs called MDAC (Microsoft Data Access

  • 5/22/2018 Rf Builder Um

    20/157

    Developers Assistant 4

    Components) that are found under the loading menuAdditional Software section. Also available in this section isthe Adobe PDF Reader which allows users to read andprint RFBuilder memos and system documentation.

    Note

    When installing to an NT platform, one musthave 'Administrator' privileges to successfullyload RFBuilder.

    Database Connection Indicators

    When running Studio, you will note at least one databaseconnection indicator, appearing at the bottom left of yourStudio window like the example shown below:

    The RFBuilder indicator means that communications havebeen established with your RFBuilder programming objects

    database RFBuilder.mdb, the file where RFBuilder objectssuch as forms, menus, users, and VBA scripts are stored.This file is a Microsoft Access database. All databasescommunicating with Studio will display an icon at the bottomof the Studio window. A red x appearing on the indicatormeans that a connection has not been established. TheRFSample indicator (shown above) indicates a connectionwith the RFBuilder sample database RFSample.mdb, acollection of Microsoft Access tables, used for learning anddemonstration purposes.

    If a red x appears in the indicator, you will (typically) needto troubleshoot the Control Panel/ODBC Data Sourceconnection for that database.

    The Studio Menu BarThe Development Studio Menu Bar displays below theRFBuilder banner.

    Here click on:

  • 5/22/2018 Rf Builder Um

    21/157

    Developers Assistant 5

    Exit: to exit/close the Studio,

    Configure: to specify the type and location of a mainapplication database to be used withRFBuilder (i.e. Access, SQL Server, Oracle,

    etc.)

    set general network device types, or tospecify individual network devicecharacteristics,

    set RFBuilder default settings for System,Services, Scanning, Function Keys,RFBuilder Programming Database, and

    RFBuilder Desktop Fonts, or

    specify the types and locations of additionalSQL compliant databases to be used withyour RF applications.

    Tables: to download

    edit application table

    establish or modify database views(combinations of application tables).

    Reset: to reset all database connectionsreset (logoff/on) all current network sessions(Handhelds/other data entry devices).

    Utilities: to permanently authorize just the Studio

    import

    export RFBuilder objects (forms, menus,users, VBA code see the next section), or

    review system communication statistics.

    Help: to access Studio help or About information.

    NOTE

    To activate a menu item, click on the item onthe menu bar; a dropdown menu will appear.

    Studio Import/Export Utilities

    The 'Utilities' Menu Bar selection allows you to transferStudio objects (RF Forms, RF Menus, and RF Users and

  • 5/22/2018 Rf Builder Um

    22/157

    Developers Assistant 6

    VBA code) from/to other RFBuilder Databases, or otherexternal files, for the following purposes:

    production usage

    ongoing development backup/ retrieval.

    These objects are, by default, stored in a Microsoft Accessdatabase called 'RFBuilder.mdb'. It is a good practice tocreate two separate installations of RFBuilder, one forproduction and one for test. Best practices show that it issafest to have a production versionof this file resident ona dedicated RFBuilder based system, serving their activedata collection processes, and a development versionon aseparate system for testing enhancements. Since the StudioSoftware may be loaded onto a separate developmentsystem, this methodology allows off-line programmingenhancements to be tested without affecting productionapplications. The Studio Import/Export utilities support this

    methodology.

    The Studio export window (with sample data entry RFBuilderForms shown) appears below.

    Here we are exporting to another Microsoft Access databasefile named RFBuilder.mdb, located on the E drive, for

    backup purposes.

  • 5/22/2018 Rf Builder Um

    23/157

    Developers Assistant 7

    Enter the path to the remote file and click Export.

    An alternative export process would be to send some or allofthe items from your development system to production again by simply exporting them.

    NOTE

    You must logoff/shutdown all remote datacollection devices attached to the productionsystem for the few moments it takes to updatethe production file.

    Importing objects works similarly, except that you will beoverwriting items in your local RFBuilder application from aremote file.

    When overwriting RFBuilder items, the RFBuilder releasenumber used to create the items must be the same as therelease number for the items being overwritten.

  • 5/22/2018 Rf Builder Um

    24/157

    Developers Assistant 8

    2.Configuring

    Configuring Your (Main) Database

    Connection

    Once Studio has been loaded, communications with yourapplication database(s) must be configured. From yourWindows desktop, execute the Studio Software as follows:

    Click on Start Click on Programs

    Click on RFBuilder

    Click on Development Studio

    Click on the Configure menu bar selection

    Click on Add Database (or on the existing 'DataConnection 1') to establish (or modify) communicationssettings for your main application database.

    The Studio Database Connection Window shown belowappears.

    Upon installation, if you have chosen to load the RFBuilder

    sample files, the system database will be connected to aMicrosoft Access data source called RFSample (as shown).

  • 5/22/2018 Rf Builder Um

    25/157

    Developers Assistant 9

    At some point, you will want to configure Studio to connectto your own application database. In theory, any ODBCcompliant database is usable with RFBuilder. A databaseConnect Using method box is available to specify ifMicrosoft ADO (Active Data Objects) or RDO (RemoteData Objects) methods should be used to access thedatabase. ADO (as shown) is the default used byRFBuilder.

    NOTE

    ADO is required when using Microsoft Access

    2000.Supported/tested database types are displayed as a dropdown menu for the Database entry; select the one thatcorresponds to your database.

    The next entry is your database Data Source name (if youare not familiar with data sources, see the next paragraph).A menu of existing (i.e. previously established) data sources

    will display.Additional entries may specify your database User name (ifrequired), and a Password (if required). Be sure that theUser name entered has read/write privileges to thedatabase. Saveyour configuration settings by clicking OK.When RFBuilder connects to a database it will display aconnection indicator at the bottom of the RFBuilder window.If a red x appears in the indicator, a valid connection hasnot been made. To troubleshoot an invalid databaseconnection, click on the Studio Error Log tab to see if an

  • 5/22/2018 Rf Builder Um

    26/157

    Developers Assistant 10

    error message has been generated; most likely, a problemwas encountered for your Data Source entry (see nexttopic).

    Note that an Unlisted ODBC' type is contained in the list of

    available Databases. Unlisted database types areconfigured in the same manner as listed ones, by specifyinga Data Source name.

    Connection Pooling is Disabled, but may be enabled for theRFBuilder Enterprise edition. Pooling allows multiple remotedevices to share limited database licenses. For example,more than ten(remote devices may typically share database

    access with one license only when pooling is enabled.To delete an established data connection, simply click onthe Delete box.

    Configuring Data Sources

    In the database configuration window we noted that a Data

    Source, and an optional User, and Password needed tobe entered. This is true for each database listed. A browseicon is available to search for data sources.

    Data Sources are normally established prior to configuringStudio by means of the ODBC Data Sources icon in your

    Control Panel window (i.e. click on Start, then Settings,

    th C t l P l th d bl li k ODBC) A i d

  • 5/22/2018 Rf Builder Um

    27/157

    Developers Assistant 11

    then Control Panel; then double-click on ODBC). A windowsimilar to the one shown here will appear.

    If nothing appears in this window, click on the Drivers tab. Ifnothing appears in the Drivers tab window, use the

    RFBuilder CD to load the Microsoft Data AccessComponents (MDAC) drivers. If a special ODBC driver isneeded for your application database and it does notappear, load it using the CD provided by the databasemanufacturer.

    The DSN tabs provide you with a list of established Userdata sources. Clicking on the System DSN or File DSN

    tabs may show more data sources. If a data source namedoes not appear for your application database, you shouldadd a data source at this time.

    When you click Add the driver selection window willappear.

    Here, select the driver used with your application databaseand click Next. If an ODBC driver for your database does

    not appear you will have to load it from the CD provided byyour database manufacturer. Select the ODBC driver to useand click Next.

    The data source window that appears will depend on theODBC driver being used. Shown below is a MicrosoftAccess database data source namedMyRFBuilderDatabase located in the C:\My Documents

    folder.

    Here we simply filled in the Name and Description boxes

  • 5/22/2018 Rf Builder Um

    28/157

    Developers Assistant 12

    Here we simply filled in the Name and Description boxesand clicked on the Select box to browse for the Accessdatabase file MyRFBuilderDatabase.mdb. You can see thepath to the database directly above the Select box.

    Click OK to save your data source.The sample RFBuilder data connection originally configured(Data Source Name: RFSample) contains the tables usedto illustrate Studio and is similar to the above (except thatthe RFSample.mdb Access database is located in theRFBuilder folder, which was created when you loaded theStudio Software).

    Configuring Network Devices

    Note: If you do not currently have a network of remotedevices being used with RFBuilder, the informationcontained in this section may be skipped.

    To configure RFBuilder network device options click themenu bar Configure selection, then click on NetworkDevices. The following window will appear.

  • 5/22/2018 Rf Builder Um

    29/157

    Developers Assistant 13

    Under General Options you may set properties for thePrimary Hardware Type (e.g. majority of devices) you willbe using. Tthe window shown above will appear. Thestandard hardware type for RFBuilder (as shown) is PSC.

    The standard entry for Telnet Emulation Mode is VT220(echo=False) and the default Standard Screen Size is20x16. A Display GUI Menubar (False/True) propertydisplays an optional menu at the bottom of device displayfor network Graphical Devices (see below).

    You may also configure Device Specific Options for non-standard data collection devices that you may be using by

    using the Terminal/ID Address (i.e. TCP/IP address) with aunique IP address set for that device. Dropdown menus areavailable for the Display Size, Echo (characters), andDevice Type boxes.

    Note

    Alternative Form displays may be establishedfor different Display Sizes entered here (see the

    Form FormProperties tab).

    There is no need to configure device specificoptions for devices conforming to entries madeunder General Options.

    Here two devices with different display sizes (20x10) havebeen entered.

  • 5/22/2018 Rf Builder Um

    30/157

    Developers Assistant 14

    All remote terminals running under VT220 Telnet protocolsmust have TCP/IP Telnet software running as a client ontheir remote device. RFBuilder includes the VT-Lite terminalemulator. Please see the VT-Lite product included forinstructions on installing the VT-Lite terminal emulator ontoyour PSC Falcon.

    Click on the OK box to save these individual devicesettings.

    Additional general/overalldefaults and properties are setby means of the System Optionsconfiguration selection.(see below).

    Configuring Network Graphical Devices

    Note

    If you are not currently using remote Windows CEbased devices as terminals, the informationcontained in this section may be skipped.

    To use Windows CE based devices, as remote terminals,you must first have one of the following clients installed onthe CE device:

    The RFBuilder Graphical client, or the

    Microsoft Internet Explorer HTML browser.

    The RFBuilder graphical client program is available on the

  • 5/22/2018 Rf Builder Um

    31/157

    Developers Assistant 15

    The RFBuilder graphical client program is available on theRFBuilder Software CD. See the RFBuilderCommunications Server documentation for informationconcerning the loading and setup of this program.

    For more information on RFBuilder graphical capabilitiessee the documentation section RFBuilder Graphical Modeas shown below.

    Configuring RFBuilder System Options

    To configure RFBuilder System options click the menu barConfigure selection, then click on System Options.

    The window shown here will appear.

    This window allows you to specify general systemcharacteristics such as Echo Characters, TCP/IPDirect, Down Arrow as Enter Key, Enable KeyPressEvent, Use RFBuilder Resource DLL, etc., as shownabove.

    Here 'Echo Characters' is not checked meaning thatcharacters received by RFBuilder from a device will not beechoed back to the device;

    TCP/IP Direct is checked, meaning that communications

  • 5/22/2018 Rf Builder Um

    32/157

    Developers Assistant 16

    , gwill be established with individual remote devices, ratherthan by using an intermediate communications controller(accordingly if using a network communications controller,uncheck TCP/IP Direct);

    Down Arrow is not checked, indicating that it will not beused as an alternative for the key;

    Enable KeyPress Event is not checked indicating thatremote devices are set to line mode rather than charactermode;

    Enable ADO or Enable RDO Language Extensions

    allow you to access database(s) directly in VB rather thanjust through the pre-built RFBuilder programming extensionsavailable for database access (see VBA Extensions 4:Database Access, in Appendix 3). If you are planning towrite your own database access code, you will need tocheck either ADO or RDO. Support for the specified methodwill automatically be loaded as required.

    Enable Double Byte Support allows Chinese, Japanese,and other double byte character sets to display and wrapproperly.

    Enable International Currency Support enables supportfor international currency formats (e.g. $1,234.56 becomes$1.234,56).

    Configuring RFBuilder Services

  • 5/22/2018 Rf Builder Um

    33/157

    Developers Assistant 17

    Configuring RFBuilder Services

    Default RFBuilder services settings are shown below.

    Telnet Services are set to port 23 (the standard defaultsetting for telnet servers such as RFBuilder). If you haveanother telnet server (e.g., another telnet based application)running on your RFBuilder based system which is listening

    on port 23, then your remote devices must be configured tosome port other than the 23 default. That port number willhave to be entered here.

    Simple FTP Services port is the address address thatRFBuilder communicates with host machines via FTP. Thedefault setting is port 21097.

    Similarly, HTML Services (used with remote HTML

    devices) are set to port 80.

    The Windows CE Services port is the address thatRFBuilder communicates with remote Windows CE devicesthat are configured with the RFBuilder Graphical Client.The default setting is port 21098.

    The Administration Servicesport is the address that theRFBuilder Communications Sever uses to communicatewith the RFBuilder Network Administrator. The default

    setting is port 12694. Please leave as is unless instructedh i b PSC h i l

  • 5/22/2018 Rf Builder Um

    34/157

    Developers Assistant 18

    to change it by PSC technical support.

    A Client Inactivity Timeout of 30 minutes is set fornetwork data collection devices (i.e. no activity at the device

    for 30 minutes will cause the device to be logged off) thissetting may be modified as desired.

    Identifying Scanner Preamble andPostamble Entries

    Scanner Preambleand Postambleentries are character

    strings that are automatically sent from a scanner. Theysurroundthe scanned data.

    Common preambles include a location number, or perhapsan operator number. Common postambles include controlcharacters such as a tab or perhaps a carriage return-linefeed. See your scanner documentation for informationconcerning how to establish these entries, or how to disablethem.

    Preamble and postamble entries entered here are used byRFBuilder: (to identify scanner input, and/or to automatically

    strip the pre/post entries from the character sequence

    received from a scanner. They will also cause a VBA FormO S t t t i

  • 5/22/2018 Rf Builder Um

    35/157

    Developers Assistant 19

    OnScan event to trigger.

    Configuring RFBuilder Function Keys

    Default function key settings for RFBuilder are shown here.

    [F1] is used to Clearthe current data field[F2] is used to Refreshthe current screen[F3] proceeds directly from the current prompt to the

    form Optionsprompt[F4] immediately Exitsyour current form or menu.

    These keys may be reset if desired. For example, changingF4 to F10 would make F10 the exit key for RFBuilder forms

    and menus.NOTE

    When first using RFBuilder with remote devices,try using the established default settings beforemaking function key changes.

    Configuring Your RFBuilder Database

  • 5/22/2018 Rf Builder Um

    36/157

    Developers Assistant 20

    By default, a data source called RFBuilder, defines thelocation of the RFBuilder Database, as shown below.

    This data source was created when the Studio software wasloaded and it identifies a Microsoft Access file called'RFBuilder.mdb' located in the RFBuilder directory. This

    database contains the programming items (Form, Menu,and User Objects, and VBA code) written with theStudio.This includes the pre-written example/demo items.

    The Forms, Menus, and Users contained in the RFBuilderDatabase display in your Studio windows.The Data Sourcename contained in this window identifies to the systemwhere this file is located. If the file is relocated, or if multipleprojects exist, you may either modify the RFBuilder DataSource (File or Machine) entries via your Windows ControlPanel ODBC Icon, or specify a new Data Source name inthis window.

    Note

    If you have multiple RFBuilder projects, with

    different data source names, you may use this

    window to switch between them. Any name maybe given to the mdb file

  • 5/22/2018 Rf Builder Um

    37/157

    Developers Assistant 21

    be given to the .mdb file.

    Configuring Desktop Settings

    You may customize your RFBuilder desktop display bymodifying the fonts being used by Studio. To do so, click onthe Desktop tab as shown here. This is typically used todisplay double-byte languages such as Japanese.

    The TrueType Font selection is used for Studio tabs anddisplays (see example VBA Modules window below), theFixed Font selection is used for displays which depict adata collection device screen; i.e., the RF Forms displayarea and the RF Application testing RF display.

    The Tab Width setting (default is 2) is the number ofspaces indented by use of the Tab key when developingVBA programs.

    The RFBuilder VBA Modules window, shown below, hasbeen configured to use the Rockwell 8 font rather than theRFBuilder default font.

  • 5/22/2018 Rf Builder Um

    38/157

    Developers Assistant 22

    To return to the RFBuilder default font,delete the fontselected, then click OK.

    RFBuilder Graphical Mode

    RFBuilder supports both character/text and graphical dataentry forms. Consider the following display differences forthe IMASTER form:

    Character Mode Graphical Mode

    To configure Studio to graphical mode, click on theGraphical radio button that appears below the RF Forms

    Display area. To revert to text mode, click on theCharacter radio button.

  • 5/22/2018 Rf Builder Um

    39/157

    Developers Assistant 23

    In character mode, remote devices use telnet tocommunicate with the RFBuilder Communications Server.

    In graphical mode, remote devices will use the RFBuildergraphical client (or Microsofts Internet Explorer/HTMLbrowser) to communicate with the RFBuilderCommunications Server.

    Graphical mode includes sculpted display screens andallows users to use graphical objects such as Images(pictures) and Command buttons as part of their RFBuilderapplications. Graphical mode displays must use graphicaldevices to display properly.

    A graphical Menubar may be set to display at the bottom ofgraphical screens by setting the Display GUI Menubar toTrue.This option be set as part of the Configure/NetworkDevices/General Options window, see above.

    When using this optional on-screen menu bar:

    [Submit] means to enter the data appearingfor the current prompt

    [Refresh] refreshes the display screen

    [Clear] clears the data entered for thecurrent prompt

    [Exit] exits the current process (same asF4 normally does).

    When configured to graphical mode, Studio data entrydevice test representations will function graphically, whenselected.

    Configuring Additional Databases

  • 5/22/2018 Rf Builder Um

    40/157

    Developers Assistant 24

    The RFBuilder Enterprise Edition has the capability ofhaving up to four additional data connections openedconcurrently.

    For example, your main database may be SQL Server orOracle, but you have a need to do transactions with tablescontained in other databases. Databases may be different intype, as long as they are SQL compliant. The window thatappears for the configuration of additional databases issimilar to the window used when you configured your maindatabase.

    As you did for your main database, a Connect Usingmethod box is available here to specify if Microsoft ADO(Active Data Objects) or RDO (Remote Data Objects)methods should be used to access the database. ADO (asshown) is the default used by RFBuilder.

    Currently supported database types are displayed as a drop

    down menu for the Database entry; select the one thatcorresponds to your database.

    The next entry is your Data Source. A menu of existing(previously established) data sources will display.

  • 5/22/2018 Rf Builder Um

    41/157

    Developers Assistant 25

    Additional entries may specify your database User name (ifrequired), and a Password (if required).

    NOTE

    Be sure that the User name entered hasread/write privileges to the database.

    Saveyour configuration settings by clicking OK.

    When RFBuilder connects to a database it will display aconnection indicator at the bottom of the RFBuilder window.

    If a red x appears in the indicator, a valid connection hasnot been made examine your RFBuilder databaseconfiguration settings, as well as those set for your specifiedData Source.

    3. How RFBuilder

  • 5/22/2018 Rf Builder Um

    42/157

    Developers Assistant 26

    3 o u de

    WorksStudio Overview

    The RFBuilder Development Studio (Studio) (the first ofthe two major RFBuilder software modules) is a MicrosoftWindows based 'point-and-click' RF data collectionApplications Generator. It is important to note that mostcorporate databases contain data tables (and perhapsprocedures) that would be useful in supporting datacollection programming efforts. Studio utilizes databasetable fields (i.e. column names and their associatedproperties) to determine the makeup of a database, and toallow data collection system Development to automatically

    interface with it. A preliminary step is to download tablefields and properties from a database to a PC basedRFBuilder development system (see RFBuilder BasicImplementation Steps). Thereafter, on the PC, adeveloper may construct appropriate RF data entry screensby pointing and clicking on the downloaded items; includingdragging and dropping the items onto a simulated RFdisplay to (see The Studio Forms Tab).

    When RFBuilder based development efforts are complete,applications run closely coupled with remote RF devices,under Windows control, with access to corporate databasesbeing 'SQL driven'. Data processing tasks such as openingdatabase(s) and tables, selecting and updating data records,list box generation, data validations/edits, executing customSQL statements, VBA program execution, and calling stored

    procedures are automatically accomplished by RFBuilder.RFBuilder based Form, Menu,and User objectsare storedand executed on a Windows based server, not on remotedata collection devices. The benefits associated with thismode of operation are) increased processing power, theavailability of higher level programming tools, ease ofsystem deployment, and ease of system maintenance Forexample, program changes are deployed instantaneously,

    without having to flash or re-flash remote devices.

    Organizationally, data entry Forms are listed on Menus(see The Studio Menus Tab), and menus are made

    il bl t RF d t ll ti d i U ( Th

  • 5/22/2018 Rf Builder Um

    43/157

    Developers Assistant 27

    available to RF data collection device Users (see TheStudio Users Tab). All aspects of an RF developmentefforts may be thoroughly tested in a local (non-network)

    mode (see the Applications Testing Tab) prior to beingplaced into service.

    Comserver Overview

    The RFBuilder Communications Server (Comserver) (thesecond major RFBuilder module) enables applications

    written with the Studio to work in a multi-user mode withremote (typically RF) data entry devices. Hard-wired devicesare also supported.

    Technically, a server based client task is spawned for eachremote device as it logs in. The Comserver works in bothcharacter and graphical modes simultaneously to support amultitude of remote devices. Character based devices use

    standard telnet based VT220 communications. Graphicalclients (including WinCE) use the RFBuilder graphicalclient software that must be loaded/activated on the remotegraphical device. A Comserver program called the NetworkAdministrator is available to view and manage the workingsof the Comserver and its clients (active remote devices).

    After your networked devices are configured, and when theComserver is active, to activate a remote device, you

    simply login to (telnet to/connect to) the Comserver from thedevice. For more information, see the Comserverdocumentation.

    RFBuilder Basic Implementation Steps

    After you have installed and configured Studio the Software

  • 5/22/2018 Rf Builder Um

    44/157

    Developers Assistant 28

    After you have installed and configured Studio, the Softwareis normally implemented as follows:

    RF transaction tables specific to your application aredesigned via your main database system (i.e., data tobe captured is defined in your database). Typically, anindividual transaction table with appropriate fielddefinitions is established for each data entry process.

    Database transaction table field definitions aredownloaded to RFBuilder (via the Studio menu bar'Tables' selection). These definitions contain all thenecessary information concerning the transaction datato be written to your database. Table definitions may beedited (inside Studio) if required.

    RF data entry Forms are made for each transactiontable. Pre-programmed data properties such as'defaults', 'validations/edits', 'table validations', etc. areadded, as required.

    RF Forms are listed on RF Menus (e.g., menus allowusers to select an RF Form).

    RF User codes and passwords are defined; a menu isassigned to each user.

    RF System Objects (Forms, Menus, and Users), asconstructed, are tested in conjunction with your

    database. Customized VBA programs and/or SQLstatements are added as required.

    Your data collection hardware (RF and other devices)are configured to support character based or graphicalcommunications sessions with your Windows basedRFBuilder Communications Server (Comserver).

    The Comserver software from the RFBuilder SoftwareCD is installed on your RFBuilder Server to activate full(multi-user) network usage and the remote managementof data collection devices.

    4. Data Fields-Download

  • 5/22/2018 Rf Builder Um

    45/157

    Developers Assistant 29

    Field Download Procedure

    To work with database tables, users must first transfer(download) table field/column definition items from theirconfigured database(s) (i.e., the tables to be used with yourRF application) into Studio. To do so:

    1. Click on 'Tables'on the Menu Bar

    2. Click on 'Download Table Fields'

    3. Select the databaseData Source (if more than onedatabase is configured)Clickthe boxes for tables (4) tobe downloaded (or click Select All), and

    4. then click Download.

    The table field definitions for the Download column

    checked tables will be transferred into Studio. Fielddefinitions normally have all the basic data needed to create

    an RFBuilder application. Information from downloadeditems is used by Studio when creating data entry/ displayforms.

  • 5/22/2018 Rf Builder Um

    46/157

    Developers Assistant 30

    NOTE

    Since RFBuilder is SQL compliant, it isimportant to note that database table and fieldnames should not u se anyof the reserved wo rdsl is ted in Appendix 4.

    Editing Table Fields

    Table data definitions may be viewed and edited underStudio by clicking on the 'Tables - Edit Field Definitionsselections. An edit window will appear.

    Shown above are the field definition items for oursample/demo Microsoft Access database (RFSample.mdb)

    Inventory table. Each transaction table must have at leastone primary key ('PartNo' as indicated above). RFBuilderidentifies database keys simply by determining whichdatabase items are 'indexed'. If more than one item isindexed, the first item encountered will be marked as theprimary key. Use this window (as required) to edit tabledefinition items. Most data fields are/should be'Updateable', some may be Required and 'Null Allowed'.

    In general, use of Numeric, Text/String, Date, and CurrencyData Types in your database is suggested, as more

    esoteric data types may cause problems when trying toupdate your database table(s).

    Only fields defined as updateable will be sent to the

  • 5/22/2018 Rf Builder Um

    47/157

    Developers Assistant 31

    Only fields defined as updateable will be sent to thedatabase when an RF transaction is completed.

    Fields not defined as 'null allowed' will send a space or a0 (zero) if no RF data is collected for them.

    Fields marked as 'primary key' are used to access thetable data and may be used to retrieve selected data.

    Click Savewhen done with your field editing.

    Database Views (Combining Tables)Tables may be 'combined' under Studio to form a 'DatabaseView' by clicking on the 'Tables: Modify Database Views'selection. A database views window will appear.

    Here three tables (Receipts, POBooks and Inventory) havebeen combined into a view named 'viewReceipts'. TheReceipts table (on the left) is the 'primary table' for this view.Views are used (by name) just as individual tables are, whendesigning RF forms.

    To select an existing view, click on the drop-down menuselector at the 'Select View' prompt.

    To create a new view, click 'New', then the drop-down menuselector for 'Add Table'. A list of database tables will appear.

    Select the table you want to include in the view and pressthe icon in the upper right-hand side of the window.

    Once a Part is scanned (or entered) the Description is

  • 5/22/2018 Rf Builder Um

    48/157

    Developers Assistant 32

    Once a Part is scanned (or entered), the Description isautomatically retrieved from the Inventory table. Once aPO# (the OrderNo field) is entered, all data concerning theorder in the POBooks table is selected (i.e. becomesavailable for usage) by RFBuilder.

    A listing of fields for each selected table (up to four) displays

    in the views window. The primary purpose for using a viewis to automatically link the tables for data selection, display(and possibly update) purposes. The specified 'links'between the primary table and the other tables in the viewallow data selection and update to occur automatically.

    Note the links established in this sample views window:'PartNo' in the Receipts table is linked to 'PartNo' to thePOBooks table and 'PartNo' in the Inventory table. 'OrderNo'in the Receipts table is linked to 'OrderNo' in POBooks.

    Links are used just like table keys, when a PartNo is enteredfor the Receipts table, all data for the part (in the Inventorytable) automatically for the part becomes 'available' (i.e. isselected). For the POBooks table, the data becomesavailable when data is entered for both linked fields in theReceipts (primary) table. Consider the following sample

    RECEIPTS form included with Studio.

    To investigate views more, click on the RF Forms taband double-click on the RECEIPTS form. Note that theDesign window contains the Table and Field names,rather than only the field names since the viewReceiptsview uses three tables.

    To create a link between tables: left click on a table fieldand drag the '+' sign to the linked field in another table;the link will appear.

    To break/delete a link between tables: highlight eithertable linked field, and press the 'Delete' key on yourkeyboard; the link will disappear. Clicking on the Delete

  • 5/22/2018 Rf Builder Um

    49/157

    Developers Assistant 33

    box will entirely delete the view.

    Modifications To Your Database(s)

    If modifications are made to your main (or additional)database tables after field definition items have beendownloaded into RFBuilder, the following actions aresuggested so that RFBuilder remains in-sync with (i.e.matches) your database:

    1. If tables have been added, re-run the Configure Database Connection selection for the appropriatedatabase.

    2. Re-run the Tables Download Table Fields selectionfor at least the affected database tables, and better forall tables (redo any field edits, if applicable).

    5.RF System

  • 5/22/2018 Rf Builder Um

    50/157

    Developers Assistant 34

    Development ToolsThe Studio Forms Tab

    Single-click on the Formstabto display the window used tocreate device forms. Forms are data entry or displayscreens that appear on your RF or other data collection

    devices.Note that there are four vertical tabs used for creatingforms:

    Form 'Selection'

    Form 'Design'

    Form 'Properties'

    Form 'Form Properties

    An RF Displayarea appears on the right hand side of thewindow. This is where the RF form displays as it isconstructed.

    The Form Selection Tab

    Prior to creating an RF form, the table f ields from your

    (configured) database(s) mu st have been dow nloaded

  • 5/22/2018 Rf Builder Um

    51/157

    Developers Assistant 35

    (configured) database(s) mu st have been dow nloaded.

    To select an existing form, double-click on the form name inthe Forms On-Filewindow. Data and the screen display forthe selected form will appear. Above, we double-clicked onthe IMASTER form.

    To create a new form, click on New; then enter the name forthe new form in the Form Name dialog box. Pressing thetab key will move to the Description box. The 'TableName' entry is the name of your database table or database

    view (multiple tables) to which you will be writing RFtransactions. Enter a 'Form Heading' if desired.

    Click on the Save selection to save a form, or Delete todelete a selected form. To exit (close) an RF form withoutsaving it, simply click on Newfor a new form.

    The Form Design TabClick the Forms Design tab to create or modify yourselected form. Note that a list of table items (table fieldspreviously downloaded) appears. You can scroll the displaywindow down to see standard additional objects, Unlinked,Options, Listbox, ComboBox, CheckBox, andgraphical objects Image and CommandButton.

    To build an RF form, click on Append Mode at the bottomof the window, and then double-click on the field/column

    item (object) that will represent your first data entry ordisplay field. Double-click on the additional items to beplaced on the form, in the desired sequence. Each itemappearing on a form is treated as a separate data 'object'

  • 5/22/2018 Rf Builder Um

    52/157

    Developers Assistant 36

    appearing on a form is treated as a separate data objectwith certain specific properties. Your first RF Display screen

    may not appear exactly as desired; accordingly, it may bereformatted. To do this:

    Click on the xy coordinate(s), Prompt, or Length boxes andmodify the existing parameters; or drag and drop the RFform items with your mouse (see below). Note that a Promptand its related data are two separate objects.

    The upper left-hand corner of the prompt display area is

    '0,0'; the next line is at 0,1, and so forth.

    To drag a displayed item, position your mouse on thedesired form object (prompt or data area), and depress theleft mouse button. Drag the item to the desired position,and then release the mouse button.

    Note the Prompt#double arrows (< >), which may be usedto position to other RF form prompts. Click on the left orright arrow to set to a different prompt.

    To insert an item, click on the Insert Mode Buttonand setthe Prompt# counter to the desired prompt number; double-click the item(s) to be inserted at that point. Rearrangeitems in the RF Display area as necessary.

    To delete an item, click the Delete Mode Button and

    double-click on the item (in the RF Display area). The itemwill disappear.

    To reorder items, click the ReOrder Mode Button anddouble-click the item to be reordered (in the RF Displayarea), enter the new prompt sequence number for the itemin the window that appears.

    The Unlinked ObjectThe Unlinked Object allows you to use a prompt on theform display for a multitude of purposes. Double-clicking onthe forms design 'Unlinked' field assigns an Unlinkedprompt and associated data area into your display. Onceassigned, you may set the properties for the object includingthe data to appear in it (see the Form Properties Tab). For

    example, to display descriptive text only, simply enter thetext as the Prompt in the Properties window. If no data is to

    be displayed, the data 'Length' of the prompt may be set to'0' (zero). This completely removes the data display area.Alternatively, the data display area may be used to printtranslate data from your database using the '@T' default

  • 5/22/2018 Rf Builder Um

    53/157

    Developers Assistant 37

    translate data from your database using the @T defaultProperty (see Appendix 2). Translate data is typically data

    from your database; i.e. CA is entered at a prompt,California is retrieved from your database and displayed inthe unlinked field. Defaults other than translate may also beused.

    The Options Object

    The Options Object (when used) is typically the last object ina data entry or display form. The object is a prompt thatprovides a pause in the data entry process so that thedevice user may select which of four options should betaken next.

    Here four choices are available:

    'V'= verify (cycle through) the current data

    'F' = file the data (write to the appropriate table)

    'N' = next, i.e. don't write this data

    'Q'= quit, i.e. dont write, then quit the process.

    When the Options Object appears all processing is

    suspended until one of the choices above is entered. 'F' isthe normal default, so that if just the device key ispressed, the data collected in the form is filed (i.e. written) tothe associated database table(s). When the Options Objectis used, the choice made overrides the any settings madefor Transaction Type in the Form FormProperties window.

    The Listbox ObjectThe Listbox Object is a form prompt that allows items to bedisplayed in an area of the form. Items may be sorted and/orselected as required by the needs of the application.

    To use a Listbox VBA script can be used to populate andmanage items displayed in the box or the Listbox field cancontain the values itself by entering them in the ListData

    property. A Listbox is different from an RFBuilder List. AList is displayed by clearing the form prompts and

    displaying the items in the List in a full screen display. SeeSection 6 SQL Statements, Lists & Listboxes for moreinformation.

  • 5/22/2018 Rf Builder Um

    54/157

    Developers Assistant 38

    The ComboBox ObjectThe ComboBox Object is a form prompt that allows multipleitems to be displayed in an area of the form and then theyare removed leaving the chosen item. Items may be sortedand/or selected as required by the needs of the application.

    To use a ComboBox VBA script can be used to populateand manage items displayed in the box or the ComboBox

    field can contain the values itself by entering them in theListData property.

    The CheckBox Object

    The CheckBox Object is a form prompt that allows the userto select a True or False option based on the objects label.

    To use a CheckBox simply place it on the screen andchoose its Default Value of checked or unchecked in theproperties tab.

    The Image Object (Graphical Item)

    The Image Object is used to display a picture on the form.

    This object supports a large variety of image formats. Thisobject can only be seen in the graphical version ofRFBuilder.

    To use the Image object enter or browse for the desiredimages path and enter it in the properties tab. TheOn_Focus and On_Enter events are executed when theimage is next in the tab order or when the user clicks on theimage. In this case the On_Clicked event will also execute.The On_Focus and On_Enter events will execute in textmode.

    The CommandButton (Graphical Item)

    The Command Button Object is used to allow easy accessto a function on the form such as Save or Exit. This object

    can only be seen in the graphical version of RFBuilder.

    To use a Command Button place it on the form and give itthe appropriate caption. In text mode the On_Focus andOn_Enter events are executed when the image is next in thetab order. In the graphical mode the On_Clicked event will

  • 5/22/2018 Rf Builder Um

    55/157

    Developers Assistant 39

    also execute.

    The Form Properties Tab

    In its simplest form, Studio allows you to construct a datacollection entry or display form by double clicking on itemsfrom a list of table fields that have been downloaded fromyour database. During the forms design process, Studiouses these field definitions to determine:

    The name(or ordinal field number) for eachprompt

    The defaultpromptto print on the form

    Data types/properties

    Data entry lengths

    For each prompt on your form, you may set ad