FactoryLink EDI Drivers Utility Program
April 30, 2003 February 2, 2004
This document contains proprietary information of Axisware LLC and is based on information available at the time of publication. While efforts have been made to be accurate, the information contained herein does not purport to cover all details or variations in hardware or software, nor to provide for every possible contingency in connection with installation, operation, or maintenance. Features may be described herein which are not present in all hardware and software systems. Axisware LLC assumes no obligation of notice to holders of this document with respect to changes subsequently made. Axisware LLC makes no representation or warranty, expressed, implied, or statutory with respect to, and assumes no responsibility for the accuracy, completeness, sufficiency, or usefulness of the information contained herein. No warranties of merchantability or fitness for purpose shall apply. Copyright © 1998 – 2004, Axisware LLC, TX, USA. All Rights Reserved
Table of Contents 1 WARNINGS AND RECOMMENDATIONS..................................................................................................................... 1 1.1 Upgrading FactoryLink.........................................................................................................................................................1 1.2 Installing a Product...............................................................................................................................................................1 2 DISTRIBUTION CD-ROM CONTENTS...........................................................................................................................2 2.1 \Win32i................................................................................................................................................................................. 2 2.2 \Manuals............................................................................................................................................................................... 2 2.3 \Sample................................................................................................................................................................................. 2 2.4 \Backup1 & \Backup2...........................................................................................................................................................2 3 SOFTKEY PROTECTION.................................................................................................................................................. 3 3.1 Available Product License Types......................................................................................................................................... 3 3.2 Standard License...................................................................................................................................................................3 3.3 Hot Stand-by License.......................................................................................................................................................... 3 3.4 Demonstration License......................................................................................................................................................... 3 3.5 SoftKey Product Installation and Validation........................................................................................................................ 4 3.6 Explanation of installation, configuration and validation sequences....................................................................................4 3.7 The normal validation procedure..........................................................................................................................................4 3.8 Temporary Installations........................................................................................................................................................ 4 3.9 Reinstalling a Validated Product.......................................................................................................................................... 5 3.10 Backing up a Validated Product......................................................................................................................................... 5 4 UTILITY PROGRAM.......................................................................................................................................................... 6 4.1 Before starting the Utility program.......................................................................................................................................6 4.2 Starting the Utility Program..................................................................................................................................................6 5 UTILITY PROGRAM FUNCTIONS..................................................................................................................................7 5.1 Install specific product..........................................................................................................................................................7 5.2 Create an install directory for a specific product..................................................................................................................7 5.3 Install a demonstration version of a product.........................................................................................................................7 5.4 Restart ‘grace’ period for a product......................................................................................................................................7 5.5 Generate configuration sequence for a product.................................................................................................................... 7 5.6 Enter a validation sequence for a product............................................................................................................................ 7 5.7 Display status of all installed protocol modules................................................................................................................... 7 6 ERROR MESSAGES............................................................................................................................................................ 9 6.1 File Access Errors.................................................................................................................................................................9 6.2 Unable to Perform Function Errors...................................................................................................................................... 9 6.3 Other Errors........................................................................................................................................................................ 10 7 SOFTKEY RUN-TIME MESSAGES................................................................................................................................11 8 PHONETIC ALPHABET................................................................................................................................................... 12
Contacting Axisware We want your experience with our software to be pleasant. If you experience any problems or have any comments or suggestions to make, please contact us This product was previously a Bullet Software or Nova Technologies product and is now an Axisware product. Axisware L.L.C. has assumed all responsibilities for this product: when you see a reference to Bullet Software or Nova Technologies please consider it a reference to Axisware. We appreciate your patience and apologize for any inconvenience this may cause.
Axisware LLC 3213 Peppertree Pl. Plano, TX 75074, USA
http://www.axisware.com T: +1-(214)-764-1876 F: +1-(214)-764-1878
[email protected] [email protected]
Utility Manual
1
1 Warnings and Recommendations We recommend that a multi-platform save of any applications be performed before installing any FactoryLink related product including Axisware/Bullet Software products.
1.1 Upgrading FactoryLink When upgrading FactoryLink, on a system that has a 3rd Party product installed, including those of Axisware/Bullet Software, perform a multi-platform save of any applications before installing the new FactoryLink Software. Always re-install the 3rd party software before restoring the applications.
1.2 Installing a Product The following steps are recommended in all cases when installing an Axisware or Bullet Software product. They may be required when upgrading to a new product version. 1. Shut down FactoryLink, by exiting the Run Manager, Application Editor, Configuration Manager and any other FactoryLink related activities. If any part does not shutdown successfully, reboot the PC. 2. Perform a multi-platform save of any applications. 3. Run the Utility program 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 editing of any “config.sys” file is required, or 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 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 LLC, 1998-2004. www.axisware.com
[email protected]
Utility Manual
2
2 Distribution cd-rom contents The distribution cd-rom contains Axisware and Bullet Software drivers, manuals and sample applications, in the following subdirectories:
2.1 \Win32i \Win32i contains the product files for the Windows platform versions.
2.2 \Manuals This directory contains PDF format versions of the product manuals, and this manual utility.pdf. Each Manual is identified by the driver's 4-character ID followed by the standard .pdf extension. Gehc Pcim Sdkt Snpx Sylk
GE Fanuc Ethernet TCP/IP GE Fanuc Genius Bus PCIM SST 5136-SD A-B Data Highway/Data Highway+ GE Fanuc SNPX Serial Square-D SY/LINK
2.3 \Sample This directory contains multi-platform save files of the sample applications for each product. Each application is identified by the product’s 4-character ID followed by the standard .mps extension. The directory is further divided into sub-directories, based on the FactoryLink version. Use the FactoryLink Restore Application utility to load the appropriate sample application for your environment.
2.4 \Backup1 & \Backup2 These directories contain extra copes of the distribution files. Should you have a problem reading any portion of the distribution files from the CD, you can use “X:\Backup1\” or “X:\Backup2\” in place of “X:\” to access these files. Running the Utility program from one of these directories will ensure that the product files from that directory are accessed.
© Axisware LLC, 1998-2004. www.axisware.com
[email protected]
Utility Manual
3
3 SoftKey Protection Axisware and Bullet Software products require a license for each FactoryLink station using the product at runtime in a non-temporary environment. The demonstration version should be sufficient to handle temporary or configuration use, and does not require an individual license. Products are protected against unlicensed use via SoftKey Protection. The purpose of SoftKey protection is to make unlicensed use difficult; not to impose problems on legitimate customers. There are valid reasons for re-installing products to a target which does not contain the previously validated copy, for example, replacing a hard drive or upgrading a PC. In this case the normal validation procedure must be followed. Axisware maintains a database of validation sequence requests. If Axisware considers the number of validation requests to be questionable, you may be asked the reason for the request.
3.1 Available Product License Types 3.2 Standard License Grace period: 15 days Normal general purpose, single FactoryLink station. This is the one used most often.
3.3 Hot Stand-by License Grace period: 15 days Designed for users who wish to have either a stand-by disk or PC ready to replace or repair a station. Requirements are:
At least one Standard License.
An explanation of stand-by procedure from the End User on company letterhead, explaining how they will ensure that no more FactoryLink stations are in use than the number of Standard Licenses.
3.4 Demonstration License Grace period: 3 days Demonstration versions are the same as standard products, but with the following limits:
Three-day Grace Period: Each time the demonstration version is installed it will start for three days. Demonstration versions can not be validated. You can continue to re-install or to restart the grace period indefinitely to get additional three-day periods. Maximum of 50,000 Successful Packet Transactions: A count is initiated each time the run-time product is started. After 50,000 successful packets have been processed each additional successful packet transaction will report a “demo limit reached” error to FactoryLink. Reads and writes will report
© Axisware LLC, 1998-2004. www.axisware.com
[email protected]
Utility Manual
4
the demo limit reached error only if successful at the driver level, failures will report as usual. This results in the application being unable to read, while still allowing writes for an orderly shutdown. The purpose is for temporary evaluation, demonstration, or support.
3.5 SoftKey Product Installation and Validation An installed product must be validated before the grace period expires in order to continue to start successfully.
3.6 Explanation of installation, configuration and validation sequences The installation and validation of a product uses the following sequence codes:
Installation: This alphanumeric sequence is provided with the product and is required by the Install specific product function of the Utility program. Configuration: This alphanumeric sequence is generated by the Generate configuration sequence function of the Utility program. Send this sequence to Axisware to obtain a validation sequence for the product. A different configuration sequence will be generated every time the Generate configuration 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 require a 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 userwho enters it using the Validate a specific product option of the Utility program.
3.7 The normal validation procedure 1. Axisware supplies an installation sequence 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 product registration 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. The product is now completely validated.
3.8 Temporary Installations If a product is to be installed on a PC other than that intended for final installation, and if the demonstration © Axisware LLC, 1998-2004. www.axisware.com
[email protected]
Utility Manual
5
version is not sufficient for such use, then install the product on the temporary PC, but do not validate it. Use the Restart Grace Period facility of the Utility program once every fifteen days.
3.9 Reinstalling a Validated Product This option of the Utility 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 version is found, then the product will be validated during the installation process and a new configuration sequence will not be needed.
3.10 Backing up a Validated Product To backup and restore a product after it has been validated, backup and restore the entire FactoryLink product directory (defined by the %FLINK% environment variable).
© Axisware LLC, 1998-2004. www.axisware.com
[email protected]
Utility Manual
6
4 Utility Program This utility provides the functions to install and maintain the products.
4.1 Before starting the Utility program The logged-in user must have administrator privileges. Ensure that Utility has write access to the FactoryLink program directory (%FLINK% environment string or the directory chosen by the user). Ensure that the %FLINK% environment string or the FactoryLink product directory chosen by the operator includes the drive letter as well as the path, e.g. “C:\FLINK” not “\FLINK”.
4.2 Starting the Utility Program Place the distribution CD into a cd-rom drive and use your preferred method to run the program X:\Win32i\Blltutil.exe (where X is the drive letter).
© Axisware LLC, 1998-2004. www.axisware.com
[email protected]
Utility Manual
7
5 Utility Program Functions The Utility displays a menu of possible functions, select the function you require.
5.1 Install specific product This function walks you through the installation of a purchased product.
5.2 Create an install directory for a specific product Use this function if the target PC for the product does not have a CD-ROM drive, or if you want to make a copy of the product install files on your hard disk. This function will build a directory structure similar to the one on the distribution CD using only the product files for the FactoryLink version selected.
5.3 Install a demonstration version of a product This function installs a demonstration version of a product from the distribution CD. Refer to the SoftKey Protection description in section 3 of this manual for the usage limits of demonstration versions. Note: This function will also work from a directory created by the Create an install directory for a specific product function above.
5.4 Restart ‘grace’ period for a product This function sets the install date of a previously installed product to the current system date.
5.5 Generate configuration sequence for a product This function walks you through generating a configuration sequence, which is used in the process of validating an installed product.
5.6 Enter a validation sequence for a product This function walks you through the input of a validation sequence which is used in the process of validating an installed product.
5.7 Display status of all installed protocol modules This function displays the installed and validation status of protocol modules found. It can also be used to
© Axisware LLC, 1998-2004. www.axisware.com
[email protected]
Utility Manual
8
display the serial number of an installed product.
© Axisware LLC, 1998-2004. www.axisware.com
[email protected]
Utility Manual
9
6 Error Messages Any message which may appear while running the Utility program has the format: “ERROR: (function : reference) <string>” where function and reference are internal identifiers and <string> gives a verbal description of the error. Follow the instructions given below for each message. If the problem remains, contact Axisware Technical Support, giving the complete error message including the function, reference and string.
6.1 File Access Errors The Utility program requires read access to the product distribution files, and read/write access to the FactoryLink program files or target directory. If you are having problems reading distribution files try one of the backup directories or recreate the install directory. If you experience open, read or write errors on files 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 files File read error: File write error: Install Failed unable to copy Product files Install Failed unable to update FactoryLink Files Install Failed unable to update Product SoftKey Data Invalid Product Install File Invalid Validation File Open Failed on Validation File Read Failed on Validation File Unable to Copy Bullet Utilities Program Unable to open file: Unable to open Product Install file Unable to read Product Install File Unable to Select/Create sub-directory Unable to write new install date to file Write error on validation file If you are still unable to determine the cause of the problem, contact Axisware Technical Support.
6.2 Unable to Perform Function Errors Invalid install sequence for current product The install sequence used is for an earlier version of the product. Contact Axisware Sales for information on obtaining an upgrade.
© Axisware LLC, 1998-2004. www.axisware.com
[email protected]
Utility Manual
10
Invalid Validation Sequence Please check carefully the validation sequence you are entering and if the error persists contact Axisware 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 Axisware Sales for information 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 validation sequence for the installed product. If so, please contact Axisware Technical Support for assistance.
Unable to determine install directory The Utility uses relative paths to access data files and must be able to determine its location in the computer’s directory structure. It was unable to do so. Change the current drive and working directory to the directory containing the blltutil.exe file, and re-run the utility program.
6.3 Other Errors You should never see these or other messages. If you do, contact Axisware Technical Support with complete details.
Duplicate Protected Data Found: filename Empty input Install Failed Panic unknown return from BaseInstall X Invalid choice Invalid intermediate data length Invalid Product Id Invalid Product Install File Invalid Validation File for X Product No Protected Data Found: filename NULL input Open Failed on Validation File Product not found Serial Numbers do not Match Unknown distribution type X Unable to determine Operating System - 95 or NT? Unable to open file: filename
© Axisware LLC, 1998-2004. www.axisware.com
[email protected]
Utility Manual
11
7 SoftKey run-time messages The following messages may appear during run-time:
SoftKey: Grace period for validation has expired The product will not function until validated. Follow the steps outlined above for validating the product.
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 Error Message Section above, or contact Axisware Technical Support for assistance.
Serial #: XXXXXXX Single Processor Run Time License Normal information message displaying the product name and serial number.
© Axisware LLC, 1998-2004. www.axisware.com
[email protected]
Utility Manual
12
8 Phonetic Alphabet Using these names for alphabetic characters reduces the chance of error when obtaining a validation sequence by phone. A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Alpha Bravo Charlie Delta Echo Foxtrot Golf Hotel India Juliet Kilo Lima Mike November Oscar Poppa Quebec Romeo Sierra Tango Uniform Victor Whiskey Xray Yankee Zulu
© Axisware LLC, 1998-2004. www.axisware.com
[email protected]