axisware abei setup manual: fl allen-bradley ethernet driver

Upload: axisware-llc

Post on 30-May-2018

215 views

Category:

Documents


0 download

TRANSCRIPT

  • 8/14/2019 Axisware ABEI setup manual: FL Allen-Bradley Ethernet driver

    1/18

    FactoryLink ProductsSetup & Utility Program

    April 30, 2003

    February 2, 2004

  • 8/14/2019 Axisware ABEI setup manual: FL Allen-Bradley Ethernet driver

    2/18

    This document contains proprietary information of Axisware and is based on information available at thetime of publication. While efforts have been made to be accurate, the information contained herein doesnot purport to cover all details or variations in hardware or software, nor to provide for every possiblecontingency in connection with installation, operation, or maintenance. Features may be described hereinwhich are not present in all hardware and software systems. Axisware assumes no obligation of notice toholders of this document with respect to changes subsequently made. Axisware, L.L.C. makes norepresentation or warranty, expressed, implied, or statutory with respect to, and assumes no responsibilityfor the accuracy, completeness, sufficiency, or usefulness of the information contained herein. No

    warranties of merchantability or fitness for purpose shall apply.

    All Trademarks Acknowledged

    Copyright 2000 2004, Axisware LLC, TX, USA.All Rights Reserved

  • 8/14/2019 Axisware ABEI setup manual: FL Allen-Bradley Ethernet driver

    3/18

    Software License

    Please carefully read the following licensing agreement. By using this Axisware, L.L.C. product, you are

    thereby indicating your acceptance of and agreement with all the terms specified and your commitment to

    abide by them.

    Product Use

    Axisware L.L.C. grants to you a non-exclusive license to use the Software programs and related

    documentation in this package on a single processing unit. No one other than a current Axisware L.L.C.employee is permitted to modify or tamper with in any way the computer files(s) associated with this license.

    This license applies solely to Axisware L.L.C. software and documentation contained in this package, and doesnot apply to any software or documentation provided by other parties which may be required for the proper

    operation of this product. You should check the license conditions provided by the originators of software

    supplied by others.

    Warranty

    Except as modified by an in-force written agreement executed by an authorized officer of Axisware L.L.C.,

    Axisware L.L.C. expressly disclaims any and all warranties, conditions or representations, either expressed orimplied, with respect to software, other products and any part thereof delivered to Customer hereunder,

    including any and all implied warranties or conditions of title, non-infringement, merchantability or fitness orsuitability for any purpose (whether or not Axisware L.L.C. knows, has reason to know, has been advised or is

    otherwise in fact aware of any such purpose), whether alleged to arise by law, by reason of custom or usage inthe trade or by course of dealing. In addition, Axisware L.L.C. expressly disclaims any warranty orrepresentation to any person other than Customer with respect to the software or any part thereof. No written

    or oral information or advice given by Axisware L.L.C., its agents or employees shall create any warranty or inany way increase the scope of the limited warranty set forth in such license agreement and Customer may not

    rely on any such information or advice.

    Customers sole and exclusive remedy for any breach of this Agreement, including any breach of warranty,

    shall be, to the exclusion of all other remedies therefor, in contract, tort or otherwise, at Axisware, L.L.C. soleoption, either the return of the price paid for or the correction or replacement of any product that does not meet

    the limited warranty, if any, set forth in a written agreement signed by an authorized officer of Axisware,L.L.C. that is returned to Axisware, L.L.C.. In no event shall Axisware L.L.C. be liable to Customer (nor toany person claiming rights derived from Customers rights) for incidental, consequential, special, punitive or

    exemplary damages of any kind, including without limitation lost profits, loss of business or other economicdamage and further including injury to property, as a result of a breach of this agreement, including any breach

    of warranty, regardless of whether Axisware, L.L.C. was advised, had other reason to know or in fact knew ofthe possibility thereof. In no event shall Axisware, L.L.C. aggregate liability to Customer (including liability to

    any person or persons whose claim or claims are based on or derived from a right or rights claimed byCustomer), with respect to any and all claims at any and all times arising from or related to this Agreement, in

    contract, tort or otherwise, exceed the aggregate amounts paid to Axisware, L.L.C. by Customer.

  • 8/14/2019 Axisware ABEI setup manual: FL Allen-Bradley Ethernet driver

    4/18

    Contacting Axisware

    We want your experience with our software to be a pleasant one. If you experience any problems or haveany comments or suggestions to make, please contact us

    [email protected]@axisware.com

    http://www.axisware.com

    Axisware LLC3213 Peppertree Pl.Plano, TX 75074, USA

    +1-(214)-764-1876 (T)

    +1-(214)-764-1878 (F)

  • 8/14/2019 Axisware ABEI setup manual: FL Allen-Bradley Ethernet driver

    5/18

    Table of Contents

    1 OVERVIEW................... .............. .............. .............. ............... .............. .............. .............. .............. .............. ............. 1

    2 WARNINGS AND RECOMMENDATIONS..........................................................................................................2

    2.1 Upgrading FactoryLink............................................................................................................................................. 22.2 Installing a Product................................................................................................................................................... 2

    3 DISTRIBUTION CD-ROM CONTENTS................... .............. .............. .............. .............. .............. ............... ....... 3

    3.1 \Win32i......................................................................................................................................................................33.2 \Manuals....................................................................................................................................................................33.3 \Samples.................................................................................................................................................................... 33.4 \Backup1 & \Backup2............................................................................................................................................... 3

    4 SOFTKEY PROTECTION................... ............... .............. .............. .............. .............. ............... .............. .............. .4

    4.1 Explanation of Installation, Configuration and Validation Codes............................................................................ 44.2 Explanation of Product License Types..................................................................................................................... 44.3 Standard License....................................................................................................................................................... 44.4 Hot Stand-by License............................................................................................................................................... 44.5 Demonstration License..............................................................................................................................................54.6 SoftKey Product Installation and Validation............................................................................................................ 54.7 The Normal Validation Procedure............................................................................................................................54.8 Temporary Installations............................................................................................................................................ 54.9 Reinstalling a Validated Product...............................................................................................................................54.10 Backing up a Validated Product..............................................................................................................................5

    5 THE AW-SETUP PROGRAM................. .............. ............... .............. .............. .............. .............. .............. ............. 7

    5.1 Before starting the program...................................................................................................................................... 75.2 Starting the program..................................................................................................................................................7

    6 AW-SETUP FUNCTIONS..................... .............. .............. .............. .............. ............... .............. .............. .............. .. 8

    6.1 Install specific product..............................................................................................................................................86.2 Create an install directory for a specific product...................................................................................................... 86.3 Install a demonstration version of a product............................................................................................................. 86.4 Restart grace period for a product.......................................................................................................................... 86.5 Generate configuration sequence for a product.........................................................................................................86.6 Enter a validation sequence for a product.................................................................................................................86.7 Display status of all installed protocol modules........................................................................................................8

    7 ERROR MESSAGES.................................................................................................................................................9

    7.1 File Access Errors..................................................................................................................................................... 97.2 Unable to Perform Function Errors...........................................................................................................................9

    7.3 Other Errors.............................................................................................................................................................108 SOFTKEY RUN-TIME MESSAGES.................... .............. ............... .............. .............. .............. .............. ........... 11

    9 PHONETIC ALPHABET............... .............. .............. .............. ............... .............. .............. .............. .............. ....... 12

  • 8/14/2019 Axisware ABEI setup manual: FL Allen-Bradley Ethernet driver

    6/18

  • 8/14/2019 Axisware ABEI setup manual: FL Allen-Bradley Ethernet driver

    7/18

    Aw-setup Manual 1

    1 Overview

    This manual describes how to use the Axisware SetUp program, aw-setup, which is required tosuccessfully install and license Axisware software products for FactoryLink. The manual contains the

    following:

    Warnings and RecommendationsOutlines recommended procedures for upgrading and installing

    Distribution CD-ROM ContentsDescribes the directory structure and files contained on the distribution CD.

    SoftKey ProtectionDescription of SoftKey protection and product validation procedure.

    Aw-setup ProgramInstructions for and capabilities of this utility

    Appendix APhonic Alphabetic character codes for suggested use when communicating configuration and validationsequences by phone.

    Axisware [email protected] www.axisware.com

  • 8/14/2019 Axisware ABEI setup manual: FL Allen-Bradley Ethernet driver

    8/18

    Aw-setup Manual 2

    2 Warnings and Recommendations

    We recommend that a multi-platform save of any applications be performed before installing any

    FactoryLink related product including Axisware products.

    2.1 Upgrading FactoryLink

    When upgrading FactoryLink, on a system that contains a 3rd Party driver or other product, perform a

    multi-platform or "single save file" save of any applications before installing the new FactoryLinkSoftware. Always reinstall the 3rd party software before restoring the applications.

    2.2 Installing a Product

    The following steps are recommended in all cases when installing an Axisware software product. Theymay be required when upgrading to a new product version.

    1. Shut down FactoryLink, by exiting the Run Manager, Application Editor, ConfigurationManager and any other FactoryLink related activities. If any part does not shutdownsuccessfully, restart the PC.

    2. Perform a multi-platform or single save file save of any applications.3. Run the Axisware setup program, aw-setup, to install the product.4. Perform any finishing steps as outlined on screen at the end of the installation process, or

    detailed in the specific product manual.5. If the install procedure states that the system must be restarted before the product will

    function correctly, restart the PC.6. Restore the application from the multi-platform or "single save file" save file created in step

    2 above. If conversion is required due to a FactoryLink upgrade, do the conversion.7. Run the Configuration Manager and check the product tables for any additional fields that

    may need editing.8. Run the application.

    Axisware [email protected] www.axisware.com

  • 8/14/2019 Axisware ABEI setup manual: FL Allen-Bradley Ethernet driver

    9/18

    Aw-setup Manual 3

    3 Distribution cd-rom Contents

    The distribution cd-rom supplied in the product package contains products, manuals and sampleapplications in the following sub-directories:

    3.1 \Win32i

    This directory contains the product files and the SetUp program executable, aw-setup.exe, for theMicrosoft Windows platform versions (32bit Intel).

    3.2 \Manuals

    This directory contains PDF versions of the product manuals, and this manual aw-setup.pdf. Eachmanual is identified by the letters aw- followed by a product id (listed below) followed by the .pdf fileextension.

    Abei Allen-Bradley Ethernet Interface

    3.3 \Samples

    This directory contains multi-platform or "single save file" save files of the sample applications for eachproduct. Each application is identified by the products 4-character ID followed by the standard .mpsextension. The directory is divided into sub-directories containing the actual files, based on theFactoryLink version.

    Use the FactoryLink Restore Application utility to load the appropriate sample application for yourenvironment.

    3.4 \Backup1 & \Backup2

    These directories contain images of the distribution files. If you have problems reading any portion of thebase distribution files from the CD, you can use X:\Backup1\ or X:\Backup2\ in place of X:\ toaccess these files. Running the Set Up & Utility program from one of these directories will ensure thatthe product files from that directory are accessed.

    Axisware [email protected] www.axisware.com

  • 8/14/2019 Axisware ABEI setup manual: FL Allen-Bradley Ethernet driver

    10/18

    Aw-setup Manual 4

    4 SoftKey Protection

    Axisware products require a separate license for each FactoryLink station using the product at run-timein a non-temporary environment. The demonstration version should be sufficient to handle temporary or

    configuration use, and it does not require an individual license. Products are protected against unlicenseduse via SoftKey Protection.

    The purpose of SoftKey protection is to make unlicensed use difficult; not to impose problems onlegitimate customers. There are valid reasons for re-installing products to a target which does notcontain the previously validated copy, for example, replacing a bad hard drive or upgrading a PC. In thiscase the normal validation procedure must be followed. Axisware maintains a database of validationsequence requests. If Axisware considers the number of validation requests to be questionable, you may

    be asked the reason for the request.

    4.1 Explanation of Installation, Configuration and Validation Codes

    Installation: This alphanumeric sequence is provided with the product and is required by theInstallspecific productfunction of the Utility program.

    Configuration: This alphanumeric sequence is generated by the Generate configuration sequencefunction of the Utility program. Send this sequence to Axisware to obtain a validation sequence forthe product. A different configuration sequence will be generated every time the Generateconfiguration sequence function is used. The latest sequence (or only) generated from an install will

    be sufficient to generate a validation sequence. Re-installing or restarting the grace period will requirea new configuration sequence to be generated.

    Validation: This alphanumeric sequence is generated by Axisware from the serial number and

    configuration sequence, and sent to the user who enters it using the Validate a specific productoptionof the Setup program.

    4.2 Explanation of Product License Types

    4.3 Standard LicenseGrace period: 15 days

    Normal general purpose, single FactoryLink station. This is the one used most often.

    4.4 Hot Stand-by LicenseGrace period: 15 days

    Designed for users who wish to have either a stand-by disk or PC ready to replace or repair a station incase of a problem. Qualification requirements are:

    At least one Standard License.

    Axisware [email protected] www.axisware.com

  • 8/14/2019 Axisware ABEI setup manual: FL Allen-Bradley Ethernet driver

    11/18

    Aw-setup Manual 5

    An explanation of stand-by procedure from the End User on company letterhead, thatexplains how they will ensure that no more FactoryLink stations are in use than the numberof Standard Licenses.

    4.5 Demonstration License

    The purpose of this license is for temporary evaluation, demonstration, application development orsupport. Demonstration versions are the same as the standard product but will run for three hours eachtime they are started. When the time limit is reached the task will allow pending solicited operations tocomplete, however; no new operations either solicited or unsolicited will be initiated.

    4.6 SoftKey Product Installation and Validation

    An installed product must be validated before the grace period expires in order to continue to startsuccessfully.

    4.7 The Normal Validation Procedure

    1. Axisware provides an installation sequence and supplies it with the product.2. The user installs the product using the install sequence, and has the grace period to get the

    product functioning.3. Before the end of the grace period the user generates a configuration sequence and sends it,

    with product serial number, to Axisware. This can be done on-line from the productregistration page at www.axisware.com, or by fax or email

    4. Axisware produces a validation sequence and sends it to the user.5. The user enters the validation sequence, using the Validate a specific productoption of the

    aw-setup program. The product is now completely validated.

    4.8 Temporary Installations

    If a product is to be installed on a PC other than that intended for final installation, and if thedemonstration version is not sufficient for such use, then install the product on the temporary PC, but donot validate it. Use theRestart Grace Periodfacility of the aw-setup program once every fifteen days.

    4.9 Reinstalling a Validated Product

    TheInstall specific productfunction of the aw-setup program looks for an existing copy of the product in

    the target location. If a validated copy with the same serial number and of the same or previous versionis found, then the product will be validated during the installation process and a new configurationsequence will not be needed.

    4.10 Backing up a Validated Product

    To backup and restore a product after it has been validated, backup and restore the entire FactoryLink

    Axisware [email protected] www.axisware.com

  • 8/14/2019 Axisware ABEI setup manual: FL Allen-Bradley Ethernet driver

    12/18

    Aw-setup Manual 6

    product directory (%FLINK% environment string).

    Axisware [email protected] www.axisware.com

  • 8/14/2019 Axisware ABEI setup manual: FL Allen-Bradley Ethernet driver

    13/18

    Aw-setup Manual 7

    5 The aw-setup program

    This utility provides the functions to install and maintain the software products.

    5.1 Before starting the program

    The logged-in user must have administrator privileges. Ensure that the program has write access to theFactoryLink directory structure (%FLINK% environment string or the directory chosen by the user).

    Ensure that the %FLINK% environment string or the FactoryLink product directory chosen by theoperator includes the drive letter as well as the path, e.g. C:\FLINK not \FLINK.

    Ensure that FactoryLink is not running (otherwise files may not be written during the installation and/orvalidation).

    5.2 Starting the program

    Place the distribution CD into a cd-rom drive and use your preferred method to run the programX:\Win32i\aw-setup.exe (WhereXis the drive letter).

    Axisware [email protected] www.axisware.com

  • 8/14/2019 Axisware ABEI setup manual: FL Allen-Bradley Ethernet driver

    14/18

    Aw-setup Manual 8

    6 aw-setup functions

    6.1 Install specific product

    This option walks you through the installation of a purchased product.

    6.2 Create an install directory for a specific product

    Use this option if the target PC for the product does not have a cd-rom drive, or if you want to make acopy of the product install files on your hard disk. This will build a directory structure similar to the oneon the distribution CD using only the product files for the FactoryLink version selected.

    6.3 Install a demonstration version of a product

    This option installs a demonstration version of a product from the distribution CD. Please refer to theSoftKey Protection description in section 4 of this manual for the usage limits imposed on demonstrationversions.

    Note: This option will also work from a directory created by Create an install directory for a specificproduct, see above.

    6.4 Restart grace period for a product

    This option sets the install date of a previously installed product to the current system date.

    6.5 Generate configuration sequence for a product

    This option walks you through generating a configuration sequence, which is used in the process ofvalidating an installed product.

    6.6 Enter a validation sequence for a product

    This option walks you through the input of a validation sequence which is used in the process ofvalidating an installed product.

    6.7 Display status of all installed protocol modules

    This option displays the installed and validation status of Axisware products. It can also be used todisplay the serial number of an installed product.

    Axisware [email protected] www.axisware.com

  • 8/14/2019 Axisware ABEI setup manual: FL Allen-Bradley Ethernet driver

    15/18

    Aw-setup Manual 9

    7 Error Messages

    Error messages which may appear while running the aw-setup program have the format:

    ERROR: (function

    :reference

    )

    wherefunction and reference are internal identifiers and gives a verbal description of the error.Follow the instructions given below for each message. If the problem remains, contact AxiswareTechnical Support, giving the complete error message including thefunction, reference andstring.

    7.1 File Access Errors

    The Utility program requires read access to the product distribution files, and read/write access to theFactoryLink program files or target directory. If you are having trouble reading distribution files try oneof the backup directories or recreate the install directory. If you experience open, read or write errors onfiles in the target directory, ensure that the Utility program has proper file access and that all FactoryLink

    programs are shut down. Typical error messages might be:

    Error coping files to Failure copying product FactoryLink filesFile read error: File write error:

    Install Failed unable to copy Product filesInstall Failed unable to update FactoryLink FilesInstall Failed unable to update Product SoftKey DataInvalid Product Install FileInvalid Validation FileOpen Failed on Validation File

    Read Failed on Validation FileUnable to Copy Bullet Utilities ProgramUnable to open file: Unable to open Product Install fileUnable to read Product Install FileUnable to Select/Create sub-directoryUnable to write new install date to fileWrite error on validation file

    If you are still unable to determine the cause of the problem, contact Axisware Technical Support.

    7.2 Unable to Perform Function Errors

    Invalid install sequence for current product

    The install sequence used is for an earlier version of the product. Please contact Axisware Sales forinformation on obtaining an upgrade.

    Invalid Validation Sequence

    Axisware [email protected] www.axisware.com

  • 8/14/2019 Axisware ABEI setup manual: FL Allen-Bradley Ethernet driver

    16/18

    Aw-setup Manual 10

    Please check carefully the validation sequence you are entering and if the error persists contactAxisware Technical Support.

    The install directory for this Version of FactoryLink does not exist

    The distribution CD does not contain FactoryLink files for the selected version of FactoryLink. If you

    are building an install directory to use in place of the distribution media, ensure that the proper product, platform, and FactoryLink version are selected. Otherwise please contact Axisware Sales forinformation on obtaining this product for the required platform and FactoryLink version.

    Protected data does not match: filename

    The validation sequence does not match the installed product. Ensure you are using the validationsequence for the installed product. If so, please contact Axisware Technical Support for assistance.

    Unable to determine install directory

    The aw-setup program uses relative paths to access data files and it must be able to determine itslocation in the computers directory structure. It was unable to do so. Change the current drive and

    working directory to the directory which contains the aw-setup.exe file, and then re-run the utilityprogram.

    7.3 Other Errors

    You should never see these or other messages. If you do, please contact Axisware Technical Supportwith complete details.

    Duplicate Protected Data Found: filenameEmpty inputInstall Failed Panic unknown return from

    BaseInstall XInvalid choiceInvalid intermediate data lengthInvalid Product IdInvalid Product Install FileInvalid Validation File for X ProductNo Protected Data Found: filenameNULL inputOpen Failed on Validation File

    Product not foundSerial Numbers do not MatchUnknown distribution type X

    Unable to determine Operating System - 95 or NT?Unable to open file: filename

    Axisware [email protected] www.axisware.com

  • 8/14/2019 Axisware ABEI setup manual: FL Allen-Bradley Ethernet driver

    17/18

    Aw-setup Manual 11

    8 SoftKey run-time messages

    The following messages may appear during run-time execution of the product:

    SoftKey: Grace period for validation has expired

    The product will not function until validated. Follow the steps outlined above for validating theproduct.

    SoftKey: Grace period for validation will expire in X days.

    Information message.

    SoftKey: Improperly installed, please reinstall

    The product was either not installed using the Utility program, or an error occurred during installation.Please use the Utility program to install the product, refer to the appropriate Error message in the ErrorMessage Section above, or contact Axisware Technical Support for assistance.

    Serial #: XXXXXXX Single Processor Run Time License

    Normal information message displaying the product name and its Serial Number.

    Axisware [email protected] www.axisware.com

  • 8/14/2019 Axisware ABEI setup manual: FL Allen-Bradley Ethernet driver

    18/18

    Aw-setup Manual 12

    9 Phonetic Alphabet

    Using these names for alphabetic characters reduces the chance of error when obtaining a validation

    sequenceby phone.

    A AlphaB BravoC CharlieD DeltaE EchoF FoxtrotG Golf H HotelI IndiaJ JulietK KiloL LimaM Mike

    N November O Oscar P PoppaQ QuebecR RomeoS SierraT TangoU UniformV Victor W WhiskeyX Xray

    Y YankeeZ Zulu

    Axisware [email protected] www.axisware.com