COMPAQ Software Product Description ___________________________________________________________________ PRODUCT NAME: DIGITAL[TM] SNA Application Programming SPD 26.86.07 Interface for OpenVMS[TM], Version 2.5 This SPD describes DIGITAL[TM] SNA Application Programming Interface for OpenVMS[TM], which is available for the OpenVMS Alpha and OpenVMS VAX[TM] platforms. All information applies to both platforms un- less otherwise indicated. DESCRIPTION The DIGITAL SNA Application Programming Interface for OpenVMS (API) is a layered software product that allows user-written applications running on suitably configured OpenVMS systems within a DECnet[TM] or TCP/IP network or on suitably configured OpenVMS systems within an OpenVMS SNA environment to exchange information with cooperating appli- cations on an IBM[R] host. The API software exists in the OpenVMS sys- tem as a shareable image. Access between the cooperating Compaq and IBM applications is via one of the following products: TCP/IP or DECnet Connections o DIGITAL SNA Peer Server o DIGITAL SNA Domain Gateway o DIGITAL SNA Access Server for Windows NT[R] DECnet Only Connections o DECnet SNA Gateway for Synchronous Transport o DECnet SNA Gateway for Channel Transport November 1998 AE-EV67H-TE Single OpenVMS VAX System o OpenVMS SNA (VAX only), an OpenVMS VAX layered product that sup- ports local access as well as remote DECnet clients Features The DIGITAL SNA Application Programming Interface for OpenVMS (API) is a collection of subroutines designed to provide an easy-to-use in- terface 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 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 OpenVMS SNA software. These include SNA path control functions, data link control functions, and upper- level functions such as checking access information. API provides as- sistance with some functions such as brackets and chaining. In addi- tion, API supports negotiable binds and handles exception responses for the user application. For complete details about which SNA func- tions are provided by this product, refer to the product documenta- tion. 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 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. Source Code Sources of message files are available only for translation to lan- guages other than English. Source code will not be distributed for gen- eral purposes. 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. 4 Customer Responsibilities Before installation of the software, the customer must: o Previously have installed all prerequisite software and hardware, including terminals. o Have demonstrated, to Compaq's satisfaction, any necessary IBM host software that will be communicating with the SNA gateway and the SNA LU0 programming interface. o Make available for a reasonable period of time, as mutually agreed by Compaq and the customer, all hardware, communications facili- ties, and terminals that are to be used during installation. Installation service is available on a time and material basis. Con- tact your local Compaq office for more detailed information. HARDWARE REQUIREMENTS Processors Supported o DIGITAL Alpha, VAX, MicroVAX[TM], VAXstation[TM], or VAXserver[TM] 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) 5 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 For OpenVMS Alpha Systems o OpenVMS Operating System for Alpha and VAX (SPD 25.01.xx) o DECnet for OpenVMS AXP[TM] (SPD 42.25.xx) o DIGITAL TCP/IP Services for OpenVMS (SPD 46.46.xx) For VAX Systems in a DECnet SNA Gateway Environment o OpenVMS Operating System for Alpha and VAX (SPD 25.01.xx) o DECnet for OpenVMS VAX and Alpha (SPD 48.48.xx) o DEC[TM] TCP/IP Services for OpenVMS VAX (SPD 25.A4.xx) Required SNA Gateway One of the following SNA gateways is required: o DECnet SNA Gateway for Channel Transport (SPD 29.76.xx) o DECnet SNA Gateway for Synchronous Transport (SPD 25.C6.xx) o DIGITAL SNA Domain Gateway (SPD 38.69.xx) o DIGITAL SNA Peer Server (SPD 51.08.xx) o DIGITAL SNA Access Server for Windows NT (SPD 64.79.xx) 6 For VAX Systems in an OpenVMS SNA Environment o OpenVMS Operating System for Alpha and VAX (SPD 25.01.xx) o OpenVMS SNA Software (SPD 27.01.xx) SOFTWARE LICENSING This software is furnished only under a license. For more information about Compaq's licensing terms and policies, contact your local Compaq 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. 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. 7 DISTRIBUTION MEDIA For Alpha Systems This product is available as part of the OpenVMS Alpha Software Prod- uct Library on CD-ROM. The software documentation for this product is available as part of the OpenVMS Alpha Online Documentation Library on CD-ROM. Documenta- tion in hardcopy format can be ordered separately. For VAX Systems This product is available as part of the OpenVMS VAX Software Prod- uct Library on CD-ROM. The software documentation for this product is available as part of the OpenVMS VAX Online Documentation Library on CD-ROM. Documentation in hardcopy format can be ordered separately. YEAR 2000 READY The product was installed on a test machine and the system date was set so that the rollover to 1-JAN-2000 and date handling in the twenty- first century were observed to work correctly. SOFTWARE WARRANTY This software is provided by Compaq with a 90-day conformance warranty in accordance with the Compaq warranty terms applicable to the license purchase. 8 WARRANTY LIMITATIONS IBM Supported Configurations This software has been tested and is warranted against IBM System/370[TM] and IBM System/390[R] (includes 9xxx, 30xx, and 43xx series) class pro- cessor systems configured with the following IBM software. While this software may function correctly with other IBM software and equipment, and with software other than that supported by IBM, Compaq cannot of- fer its standard warranty for this software unless it has been tested with such equipment and software configurations. The API software interoperates with the following IBM software: ___________________________________________________________________ Software Product Version Release ___________________________________________________________________ CICS/VSE[R] 2 All CICS/ESA[R] 4 1.0 IMS/ESA[R] All All Transaction Server All All ACF/VTAM[R] 4 4.0 Communications Server All All ___________________________________________________________________ Since the introduction of this software, other configurations may have been tested. Please contact your local Compaq office for up-to-date information regarding listed configurations. 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. ORDERING INFORMATION For OpenVMS Alpha Systems Software Licenses: QL-10VA*-** Software Documentation: QA-455AA-GZ Software Product Services: QT-10VA*-** 9 Media and documentation for this product are available on the OpenVMS 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 Media: QA-455A*-** Software Documentation: QA-455AA-GZ Software Product Services: QT-455A*-** Media and documentation for this product are available on the OpenVMS 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. The above information is valid at time of release. Please contact your local Compaq office for the most up-to-date information. SOFTWARE PRODUCT SERVICES A variety of service options are available. For more information on these or other services, please contact your local Compaq office. [R] IBM, CICS/ESA, CICS/VSE, IMS/ESA, System/390, and VTAM are registered trademarks of International Business Machines Corporation. [R] Windows NT is a registered trademark of Microsoft Corporation. [TM] System/370 is a trademark of International Business Machines Corporation. [TM] AXP, DEC, DECnet, DIGITAL, MicroVAX, OpenVMS, VAX, VAXserver, VAXstation, and VMS are trademarks of Compaq Computer Corporation. 10 Compaq and the Compaq logo are registered in the United States Patent and Trademark Office. Other product names mentioned herein may be trademarks and/or registered trademarks of their respective companies. © 1998 Compaq Computer Corporation. All rights reserved. 11