VersaLex Getting Started Guide

Transcription

1 VersaLex Getting Started Guide

2 RESTRICTED RIGHTS Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (C)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS Manufacturer is: Cleo Communications 4203 Galleria Drive Rockford, IL USA Phone: Fax: Support: , , or Cleo Communications reserves the right to, without notice, modify or revise all or part of this document and/or change product features or specifications and shall not be responsible for any loss, cost or damage, including consequential damage, caused by reliance on these materials. This document may not be reproduced, stored in a retrieval system, or transmitted, in whole or in part, in any form or by any means (electronic, mechanical, photo-copied or otherwise) without the prior written permission of Cleo Communications CLEO COMMUNICATIONS ALL RIGHTS RESERVED. CLEO IS A REGISTERED TRADEMARK AND LEXICOM AND VERSALEX ARE TRADEMARKS OF CLEO COMMUNICATIONS. ALL OTHER BRAND NAMES USED ARE TRADEMARKS OR REGISTERED TRADEMARKS OF THEIR RESPECTIVE COMPANIES.

3 TABLE OF CONTENTS BEFORE YOU BEGIN... 4 RELATED DOCUMENTATION... 4 CONFIGURATION STEPS Install VersaLex Launch VersaLex and Register Your Serial Number Update VersaLex to the Most Recent Software Update Configure VersaLex Configure Your Firewall Test with Cleo (if applicable) Integrate VersaLex with Translator (if applicable)... 7 TECHNICAL SUPPORT... 8 Page 3

4 Before You Begin VersaLex powers Cleo LexiCom, a client solution for communication with major trading networks and VersaLex Trader, a server-level solution for the implementation and management of communications both up and down the supply chain Verify that your system meets the LexiCom ( or VLTrader ( requirements. Related Documentation The VersaLex User s Guide and other related documentation are located at for LexiCom and for VLTrader. Configuration Steps Follow these steps to ensure the VersaLex installation and setup process goes smoothly. 1. Install VersaLex 2. Launch VersaLex and Register Your Serial Number 3. Update VersaLex to the Most Recent Software Update 4. Configure VersaLex 5. Configure Your Firewall 6. Test with Cleo (if applicable) 7. Integrate VersaLex with Translator (if applicable) Please complete each section of this worksheet. It is important that you complete each of these items as accurately as possible. Should you have trouble installing Cleo VersaLex, this information will help Cleo Technical Support to effectively assist you. 1. Install VersaLex Install VersaLex per the instructions for your operating system below. Windows The VersaLex installation program is named "INSTALL.EXE". The install program will automatically run when the VersaLex CD is inserted in a Windows system. If you acquired VersaLex by download, go to the folder where you saved the downloaded file and double-click on "INSTALL.EXE". Follow the on-screen instructions to complete the installation. UNIX The VersaLex installation program for a UNIX type operating system (AIX, Solaris, Linux, or HPUX) is named install.bin. To begin the VersaLex installation, do the following: 1. Copy the appropriate "install.bin" file to a directory on your UNIX system. The appropriate "install.bin" is either the file you downloaded, or if you have the VersaLex CD, it will be the "install.bin" file located on the CD in a subdirectory that matches your operating system. (e.g., the install program for HPUX is located on the CD in the directory \HPUX\). 2. Open a shell. 3. cd to the directory where you placed install.bin. 4. Change the file permissions to Execute : chmod +x install.bin. 5. At the command prompt, type: sh./install.bin. Page 4

5 6. Follow the on-screen instructions to complete the installation. NOTE: If the console of your UNIX system has a graphical user's interface, it may allow you to use the console's file manager to select and run "install.bin" directly from the CD. AS/400 If you are installing LexiCom directly on the AS/400, refer to the "AS/400 Setup and Installation" section (Appendix E) in the VersaLex User's Guide. If you are installing on a Windows PC and mapping to the AS/400 through a networked drive, refer to the "AS/400 Network Access Setup" section (Appendix F) in the VersaLex User's Guide. After referring to the appropriate section in the VersaLex User's Guide and the installation is complete, continue to step Launch VersaLex and Register Your Serial Number In order for VersaLex to be fully operational, you must first register your serial number. VersaLex will automatically prompt for registration when invoked for the first time. For a detailed description of how to register, refer to the topic "Register" in the "Basics" section of the VersaLex User s Guide. The following is a summary of the steps to register. 1. Launch VersaLex * 2. Enter your serial number and contact information. 3. If the registration is successful, a 30-day VersaLex temporary license is activated. If you have trouble connecting during the registration process you may need to configure VersaLex for a proxy. Select the Help button on the registration panel for instructions on configuring for a proxy. Once you have purchased and installed VersaLex into its final production destination, and before the end of the 30-day period, you will want to request your Permanent License (Tools > License ). For a description of how to do this, refer to the topic "Request a Permanent License" located in the "Basics" section of the VersaLex User s Guide. *Note: If VersaLex is installed on a computer without a native GUI (graphical user interface), a web browser GUI is available for use. The web browser GUI is included in VLTrader and is an add-on feature for LexiCom. This option is automatically enabled when LexiCom is installed and will remain functional with your temporary license. If you desire to continue using the web browser GUI with LexiCom make sure you have purchased this option prior to requesting your permanent license. VersaLex must be running as a service or daemon to use the web browser GUI. Once VersaLex is running as a service/daemon, the web browser GUI is automatically activated at or for VLTrader or LexiCom, respectively; where "VersaLexComputer" is the name of the computer where VersaLex is installed. If the computer's name contains an underscore character "_", use the computer's IP address instead of the computer's name. If VersaLex is not already running as a service/daemon, it can be temporarily run from the command line as follows: For VLTrader use: VLTraderc -s service m For LexiCom use: LexiComc -s service m If port 5080 is already used by another application, you can specify a different port using the following command line; where nnnn is the new port number. For VLTrader use: VLTraderc -p "Local Listener" -t "<Host><Httpport>nnnn" For LexiCom use: LexiComc -p "Local Listener" -t "<Host><Httpport>nnnn" After changing the port number, restart the VersaLex service/daemon. Then use the new port number when starting the web browser GUI: or for VLTrader or LexiCom, respectively. Page 5

6 The web browser interface will display a VersaLex login screen. Select the edit option and enter your password, which by default is set as the product serial number. 3. Update VersaLex to the Most Recent Software Update Cleo allows you to download the latest software updates from within VersaLex. Software updates are released on an as-needed basis. To make sure that your copy of VersaLex is completely up-to-date, perform the following steps within VersaLex. 1. From the VersaLex main menu, click Tools > Software Update 2. Fill in the appropriate fields, and then click Check for Update. 3. Follow the prompts to download and apply the updates. 4. Configure VersaLex Launch VersaLex and refer to the options below. I am an AS2 user and a pre-configured host exists for the host I am connecting to Refer to both the Preconfigured AS2 Host Guide (see Related Documentation) under the heading Host Guides and the "Notes" tabs within the pre-configured host for configuration instructions. I am an AS2 user and a pre-configured host does not exist for the host I am connecting to Refer to the "Local Listener" and "AS2 Hosts" sections in the VersaLex User's Guide. Follow the instructions in these sections for configuring your Local Listener and your AS2 host. I am a non-as2 user and a pre-configured host exists for the host I am connecting to Refer to the "Notes" tabs within the pre-configured host for configuration instructions. Additionally check for a host-specific document in Related Documentation. If there is a host-specific document for the host you are connecting to, also follow the instructions in that document. I am a non-as2 user and a pre-configured host does not exist for the host I am connecting to Refer to the appropriate section in the VersaLex User's Guide for instructions on configuring a generic host for the required protocol. The following sections contain the protocol specific information: a. FTP and FTP/s Hosts b. HTTP and HTTP/s Hosts c. AS3 Hosts d. ebxml Hosts e. SSH FTP Hosts f. OFTP Hosts g. MQ Hosts h. SMTP and SMTP/s Hosts i. MLLP Hosts j. WS Hosts Page 6

7 For example, refer to the "FTP and FTP/s Hosts" section to configure a generic FTP or FTP/s host. Note: The currently available preconfigured hosts are listed at If you need assistance adding a host other than one that is preconfigured, you may want to take advantage of Cleo s consulting service. Cleo s regular Technical Support Subscription includes only rudimentary assistance with configuring new hosts. Many new hosts are easy to configure; however, some hosts will require you to purchase this value-added service. Contact Cleo Sales at for details. 5. Configure Your Firewall Firewall configuration is dependent on your connection method and host requirements and must be completed for VersaLex to work. Generate the VersaLex TCP/IP Port Usage Report for a description of firewall requirements for the activated and configured host(s). Present the information from this report to your system administrator to verify that your Firewall has been configured properly. To generate and print a TCP/IP Port Usage Report, click Tools > TCP/IP Port Usage from the VersaLex main menu. Summary Checklist Generate Report Firewall Configured Firewall Verified 6. Test with Cleo (if applicable) Cleo provides a test host for many of the VersaLex pre-configured hosts. Clone and Activate the appropriate test host, then run the test action for that host. A successful result confirms that the firewall is configured correctly and that you are ready to test directly with your VAN or trading partner(s). I am an AS2 user Refer to the Cleo AS2 System Test guide (see Related Documentation) under the heading Host Test Instructions. I am a non-as2 user Perform the following 4 simple steps to configure VersaLex. 1. Activate the appropriate Test host: Right-mouse click the test host located on the pre-configured tab within VersaLex and select Clone and Activate. 2. Select the test action: Click <send> from the left-hand tree panel. 3. Run the test: Click the run button. 4. Identify success or failure: Look for a success or error message in the VersaLex message pane. 7. Integrate VersaLex with Translator (if applicable) Translator location (e.g. directory path): VersaLex can be set up to work with a number of different translators. Refer to Related Documentation under the heading Translator Guides for a list of Translator Integration guides. If a guide is not available for your translator, refer to the VersaLex User s Guide. Note: If you need assistance with integration to other Translators or external systems, Cleo offers specially designed consulting services. Cleo s regular Technical Support Subscription does not include assistance with non-integrated translators; this is a value-added service. Contact Cleo Sales at for details. Page 7

8 Technical Support A support subscription is required to work with a Cleo technical support analyst. Information on Cleo support options may be found at: and For a detailed description of Cleo s support services, refer to For quick reference, visit our VersaLex FAQ s at or our technical support web page at To request technical support: Use the request form at: Call the automated support line at CLEO(2536) or Cleo Technical Support is available from 8am - 5pm CST, Monday through Friday and is handled on a callback basis, where requests are returned in the order they are received. The Cleo automated support line or web form will collect your information and your request for support will be placed in our callback queue. To ensure your support process goes quickly and smoothly: 1. Please have your VAN or trading partner(s) account information, such as username and password, available for the host(s) that you will be communicating with through VersaLex. This account information should be available from your VAN or trading partner(s). 2. Please note which step of the setup or installation process you are currently on within the documentation. Also note any diagnostic measures taken. Page 8