Software Product Description ___________________________________________________________________ PRODUCT NAME: Compaq SNA Application Programming SPD 26.86.08 Interface for OpenVMS, Version 2.5 This SPD describes Compaq SNA Application Programming Interface for OpenVMS, which is available for the OpenVMS Alpha and OpenVMS VAX plat- forms. All information applies to both platforms unless otherwise in- dicated. DESCRIPTION The Compaq SNA Application Programming Interface for OpenVMS (API) is a layered software product that allows user-written applications run- ning on suitably configured OpenVMS systems within a DECnet or TCP/IP network or on suitably configured OpenVMS systems within an OpenVMS SNA environment to exchange information with cooperating applications on an IBM host. The API software exists in the OpenVMS system as a share- able image. Access between the cooperating Compaq and IBM applications is via one of the following SNA server or gateway products: TCP/IP or DECnet Connections o Compaq SNA Peer Server o Compaq SNA Domain Gateway o Compaq SNA Access Server for Windows NT o Compaq SNA Server for OpenVMS Alpha, a layered product that sup- ports local access as well as TCP/IP and DECnet clients DECnet Only Connections o Compaq DECnet SNA Gateway for Synchronous Transport o Compaq DECnet SNA Gateway for Channel Transport April 2001 Compaq SNA Application Programming SPD 26.86.08 Interface for OpenVMS, Version 2.5 o Compaq SNA Server for OpenVMS VAX, an OpenVMS VAX layered product that supports local access as well as remote DECnet clients Features The Compaq SNA Application Programming Interface for OpenVMS (API) is a collection of subroutines designed to provide an easy-to-use inter- face for the OpenVMS application programmer who has a specific need to interface to an IBM application subsystem. It supports many dif- ferent types of sessions between OpenVMS applications and applications running on an IBM host. API implements all of the path control layer and portions of the trans- mission and data flow control layers of SNA. The interface supports a number of different applications, each of which uses the SNA func- tion management, data flow control, and transmission control layers in a different way. API is not limited to supporting a particular ap- plication, such as 3270 terminals or Remote Job Entry (RJE) worksta- tions; the supported session types are Logical Unit types 0, 1, 2, and 3, using the FM and TS profile types 3 and 4, as described in the prod- uct documentation. API provides extensive parameter checking, state machine management, and other high-level services, relieving the OpenVMS application pro- grammer of tedious protocol details such as state machine processing or "standard" SNA message format checking. The interface appears to the OpenVMS application as a set of subroutines that it calls to re- quest the following operations: o Establish an SNA session with an application running on an IBM host o Respond to a session request initiated by an IBM application o Reestablish a session if the connection is broken o Disconnect from a session o Receive messages from an IBM host on the normal or expedited flow o Send messages to an IBM host on the normal or expedited flow 2 Compaq SNA Application Programming SPD 26.86.08 Interface for OpenVMS, Version 2.5 o Provide positive or negative responses to messages transmitted from an IBM host Asynchronous Event Notification API provides a mechanism for an OpenVMS user application to receive control when an asynchronous "network event" occurs, such as the dis- connection of a DECnet logical link, an SNA circuit failure, or the receipt of an Unbind Type 2 from IBM. The OpenVMS application is called at a notification entry point defined by the application at connec- tion time; an indication of the event that occurred is reported. SNA Functions API provides OpenVMS applications with access to the SNA functions per- formed by either an SNA gateway or SNA server. These include SNA path control functions, data link control functions, and upper-level func- tions such as checking access information. API provides assistance with some functions such as brackets and chaining. In addition, API sup- ports negotiable binds and handles exception responses for the user application. For complete details about which SNA functions are pro- vided by this product, refer to the product documentation. The application must provide the remaining SNA functions it requires. For example, the application must be designed to: o Process all FMD layer protocols o Take into account all data flow control and session control request/response units o Keep track of any "states" relevant to the application o Translate between ASCII and EBCDIC, and vice versa o Parse the bind request o Respond to request units 3 Compaq SNA Application Programming SPD 26.86.08 Interface for OpenVMS, Version 2.5 User Interface Users of API should be experienced OpenVMS application programmers. They can use any of the OpenVMS programming languages that conform to the OpenVMS Calling Standard to create application programs that in- teract with application programs on an IBM system. The user documen- tation provides example programs written in the following languages: o MACRO-32 o ADA o BASIC o BLISS o C o COBOL o FORTRAN o PASCAL o PL/I Users of this product should be familiar with SNA and have some knowl- edge of the type of logical unit that will be used. INSTALLATION Installation services from Compaq are recommended for a customer's first purchase of this software product. These services provide for instal- lation of the software product by an experienced software specialist. HARDWARE REQUIREMENTS 4 Compaq SNA Application Programming SPD 26.86.08 Interface for OpenVMS, Version 2.5 Processors Supported o Alpha and VAX configuration as specified in the OpenVMS Operating System for Alpha and VAX Software Product Description (SPD 25.01.xx). Disk Space Requirements (Block Cluster Size = 1) Disk space required for installation: OpenVMS Alpha 18,000 blocks (9.0 MB) OpenVMS VAX 17,900 blocks (9.0 MB) Disk space required for use (permanent): OpenVMS Alpha 7,900 blocks (4.0 MB) OpenVMS VAX 6,800 blocks (3.4 MB) These counts refer to the disk space required on the system disk. The sizes are approximate; actual sizes may vary depending on the user's system environment, configuration, and software options. SOFTWARE REQUIREMENTS OpenVMS Operating System for Alpha and VAX, Version 6.2, 7.1 (VAX), 7.1-2 (Alpha), 7.2, 7.2-1 (Alpha), or 7.3 (SPD 25.01.xx). Using Compaq SNA Application Programming Interface for OpenVMS soft- ware requires a networking product appropriate for the version of Open- VMS, plus one of the SNA products listed below. Networking options include: o TCP/IP Services for OpenVMS (SPD 46.46.xx) o DECnet for OpenVMS (Phase IV, SPD 48.48.xx) 5 Compaq SNA Application Programming SPD 26.86.08 Interface for OpenVMS, Version 2.5 o DECnet-Plus (Phase V, SPD 50.45.xx for Alpha, SPD 25.03.xx for VAX). Choose a networking option appropriate for OpenVMS Versions 6.2, 7.1 (VAX), 7.1-2 (Alpha), 7.2, 7.2-1 (Alpha), or 7.3 from the following table: ___________________________________________________________________ DECnet OpenVMS_____TCP/IP______IV__________DECnet_V_______________________ 6.2 4.2 6.2 6.3 7.1 5.1 7.1 7.1 7.1-2 5.1 7.1-2 7.1 7.2 5.1 7.2 7.2 7.2-1 5.1 7.2-1 7.2-1 7.3_________5.1_________7.3_________7.3____________________________ Choose one of the following SNA options: o Compaq DECnet SNA Gateway for Channel Support (SPD 29.76.xx) o Compaq DECnet SNA Gateway for Synchronous Transport (SPD 25.C6.xx) o Compaq SNA Domain Gateway (SPD 38.69.xx) o Compaq SNA Peer Server (SPD 51.08.xx) o Compaq SNA Server for OpenVMS Alpha (SPD 70.89.xx) o Compaq SNA Server for OpenVMS VAX (SPD 27.01.xx) o Compaq SNA Access Server for Windows NT (SPD 64.79.xx) GROWTH CONSIDERATIONS The minimum hardware and software requirements for any future version of this product may be different from the requirements for the cur- rent version. 6 Compaq SNA Application Programming SPD 26.86.08 Interface for OpenVMS, Version 2.5 DISTRIBUTION MEDIA This product is available as part of the OpenVMS Alpha and VAX Soft- ware Product Libraries on CD-ROM. The software documentation for this product is available as part of the OpenVMS Alpha and VAX Online Documentation Library on CD-ROM. Doc- umentation in hardcopy format can be ordered separately. SOFTWARE WARRANTY This software is provided by Compaq with a 90-day conformance to war- ranty in accordance with the Compaq warranty terms applicable to the license purchase. WARRANTY LIMITATIONS IBM Supported Configurations This product is warranted with the IBM software configurations listed in the following table. ___________________________________________________________________ Table_1:__IBM_Software_Configurations______________________________ Software Prod- uct________________Version__Release________________________________ ACF/VTAM 4 3.0, 4.0 CICS/ESA 4 1.0 CICS/VSE 2 3.0 Communications All All Server IMS/ESA All All Transaction All All Server 7 Compaq SNA Application Programming SPD 26.86.08 Interface for OpenVMS, Version 2.5 ___________________________________________________________________ Table_1_(Cont.):__IBM_Software_Configurations______________________ Software Prod- uct________________Version__Release________________________________ z/OS_______________1________1.0____________________________________ Refer to SNA server or gateway Software Product Descriptions for ad- ditional information on supported IBM operating systems, access meth- ods, and communications front-end software. Note: Compaq will support IBM software configurations, version and re- lease numbers, as long as support for such configurations is gener- ally available from IBM. Other configurations may have been tested since this SPD was published. Please contact your local Compaq office for up-to-date information regarding listed configurations. ORDERING INFORMATION For OpenVMS Alpha Systems Software Licenses: QL-10VA*-** Software Documentation: QA-455AA-GZ Media and documentation for this product are available on the Open- VMS Alpha Software Product Library and Online Documentation Library on CD-ROM. Documentation in hardcopy format can be ordered separately. For OpenVMS VAX Systems Software Licenses: QL-455A*-** Software Documentation: QA-455AA-GZ Media and documentation for this product are available on the Open- VMS VAX Software Product Library and Online Documentation Library on CD-ROM. Documentation in hardcopy format can be ordered separately. * Denotes variant fields. For additional information on available li- censes, services, and media, refer to the appropriate price book. 8 Compaq SNA Application Programming SPD 26.86.08 Interface for OpenVMS, Version 2.5 The above information is valid at time of release. Please contact your local Compaq office for the most up-to-date information. SOFTWARE LICENSING This software is furnished only under a license. For more information about Compaq's licensing terms and policies, contact your local Com- paq office. License Management Facility Support This layered product supports the OpenVMS License Management Facil- ity. License units for this product are allocated on a CPU-capacity basis. For more information on the License Management Facility, refer to the OpenVMS Operating System for Alpha and VAX Software Product Descrip- tion (SPD 25.01.xx) or the License Management Facility manual of the OpenVMS Operating System documentation set. For more information about Compaq's licensing terms and policies, con- tact your local Compaq office. SOFTWARE PRODUCT SERVICES Installation Installation provides comprehensive installation and of Compaq and non- Compaq hardware, software, and networks products. These products in- clude systems, servers, upgrades, workstations, terminals, PCs, pe- ripherals, network equipment, operating systems, and layered products. Optional pieces of the Installation offer include site planning and preparation, orientation, and other projects which are based on the installation of computer equipment (e.g. relocation services). License Subscription 9 Compaq SNA Application Programming SPD 26.86.08 Interface for OpenVMS, Version 2.5 License Subscription provides the license rights to use all new ver- sions of those products, which are released during the contract pe- riod. Also included are the rights to use certain server-resident prod- ucts whose license is included in a corresponding client license. Telephone Software Support Software Support provides software problem identification and reso- lution and operational support for system managers, technical support/helpdesk personnel who manage Compaq and popular multivendor server software in either a standalone or networked environment. This service provides access both to technical resources to assist in problem diagnosis and resolution and to Compaq's information database. This combination of support resources will address system management questions and inquiries on a wide variety of topics including information on the latest prod- uct features, known problems and available solutions, and operational advice and assistance to help the system manager, system administra- tor better manage its information technology environment. Please contact your local Compaq office for additional information on specific services in your area. © 2001 Compaq Computer Corporation COMPAQ and the Compaq logo Registered in U.S. Patent and Trademark Of- fice. DECnet and OpenVMS are trademarks of Compaq Information Tech- nologies Group, L.P. in the United States and other countries. UNIX and The Open Group are trademarks of The Open Group. All other product names mentioned herein may be trademarks or regis- tered trademarks of their respective companies. Confidential computer software. Valid license from Compaq required for possession, use, or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Tech- nical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. 10 Compaq SNA Application Programming SPD 26.86.08 Interface for OpenVMS, Version 2.5 Compaq shall not be liable for technical or editorial errors or omis- sions contained herein. The information in this document is subject to change without notice. 11