Upload
others
View
4
Download
0
Embed Size (px)
Citation preview
TIBCO® EMS Client
for z/OS (MVS)
Installation and ReferenceSoftware Release 7.0August 2012
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc.TIBCO, The Power of Now, TIB, Information Bus , TIBCO Enterprise Message Service, TIBCO Rendezvous, TIBCO Enterprise, TIBCO SmartSockets, TIBCO ActiveMatrix BusinessWorks, and TIBCO Hawk are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries.EJB, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries.All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only.THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.Copyright © 1995-2012 TIBCO Software Inc. ALL RIGHTS RESERVED.TIBCO Software Inc. Confidential Information
| iii
Contents
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .v
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .viiiTIBCO Enterprise Message Service Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .viiiTIBCO EMS Client for z/OS (CICS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .viiiThird Party Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiiiHow to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiiiHow to Access TIBCO Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiiiHow to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiii
Chapter 1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Installation Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Storage Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3TCP/IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3SSL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Language Environment (LE). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5User Profile Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Chapter 2 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Before Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Distribution Media and Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Obtaining the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Checklist for Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Uploading the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Initial Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Installing the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Verifying the Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Optional Installation Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Compiling C Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Compiling COBOL Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Compiling Assembler Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
TIBCO EMS Client for z/OS (MVS) Installation and Reference
iv | Contents
Customizing System SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Customizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20RACF FACILITY Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Signature Verification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Chapter 3 Use and Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Case Sensitivity in Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
JCL Statements for Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
JCL Statements for Applications Using SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Sites with Multiple Stacks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Chapter 4 Programmer's Guide and Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
C Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
COBOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
DLL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Appendix A MVS Batch Sample Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Messaging Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
JCL and General Procedure Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Sample Program Data Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Appendix B Installed Data Set Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Appendix C Assembler Calls for C Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Tables | v
Tables
Table 1 Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Table 2 General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Table 3 Syntax Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
Table 4 General Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Table 5 Installation Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Table 6 File Tailoring Variables for Installation JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Table 7 File Tailoring Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Table 8 Sample Program and JCL Member Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Table 9 C Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Table 10 Assembler Sample and JCL Members. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Table 11 General JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Table 12 General Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Table 13 Installed Data Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Table 14 Assembler Calls: Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Table 15 Assembler Calls: Bytes Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Table 16 Assembler Calls: Map Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Table 17 Assembler Calls: Object Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Table 18 Assembler Calls: Stream Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Table 19 Assembler Calls: Text Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Table 20 Assembler Calls: Message Enumerate and Print. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Table 21 Assembler Calls: Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Table 22 Assembler Calls: Consumer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Table 23 Assembler Calls: Producer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Table 24 Assembler Calls: Requestor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Table 25 Assembler Calls: Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Table 26 Assembler Calls: Connection Factory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Table 27 Assembler Calls: Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Table 28 Assembler Calls: Queue Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
TIBCO EMS Client for z/OS (MVS) Installation and Reference
vi | Tables
Table 29 Assembler Calls: Name Server Lookup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Table 30 Assembler Calls: XA External Transaction Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Table 31 Assembler Calls: Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Table 32 Assembler Calls: Admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Table 33 Assembler Calls: Exception. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
TIBCO EMS Client for z/OS (MVS) Installation and Reference
| vii
Preface
This manual describes how to install and configure the TIBCO® EMS Client for z/OS (MVS) software. It is primarily intended for z/OS programmers who are involved in setting up and maintaining the system, but is also useful for applications programmers.
Topics
• Related Documentation, page viii
• Typographical Conventions, page xi
• How to Contact TIBCO Support, page xiii
This software may be available on multiple operating systems. However, not all operating system platforms for a specific software version are released at the same time. Please see the readme file for the availability of this software version on a specific operating system platform.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
viii | Preface
Related Documentation
This section lists documentation resources you may find useful.
TIBCO Enterprise Message Service DocumentationThe following documents form the TIBCO EMS documentation set:
• TIBCO Enterprise Message Service User’s Guide Read this manual to gain an overall understanding of the product, its features, and configuration.
• TIBCO Enterprise Message Service Central Administration Read this manual for information on the central administration interface.
• TIBCO Enterprise Message Service Installation Read the relevant sections of this manual before installing this product.
• TIBCO Enterprise Message Service C & COBOL API Reference The C API reference is available in HTML and PDF formats.
• TIBCO Enterprise Message Service Java API Reference The Java API reference can be accessed only through the HTML documentation interface.
• TIBCO Enterprise Message Service .NET API Reference The .NET API reference can be accessed only through the HTML documentation interface.
• TIBCO Enterprise Message Service Release Notes Read the release notes for a list of new and changed features. This document also contains lists of known issues and closed issues for this release. This document is available only in PDF format.
TIBCO EMS Client for z/OS (CICS)• TIBCO EMS Client for z/OS (CICS) Installation and Reference If you wish to run
the TIBCO EMS Client for z/OS in a batch environment, refer to this manual for instructions on installation and operations.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Related Documentation | ix
Third Party DocumentationTable 1 lists IBM publications you may find useful. You can find many of the IBM documents in these CD-ROM sets:
• Online Library Omnibus Edition MVS Collection
• Online Library Omnibus Edition z/OS Collection
Table 1 Related Documents
Publication Title
IBM RACF User’s Guide
IBM z/OS Security Server RACF User’s Guide
IBM RACF Messages
BM z/OS SecureWay Security Server RACF Messages
IBM RACF System Programmer’s Guide
IBM z/OS Security Server RACF System Programmer’s Guide
IBM MVS/ESA OpenEdition MVS User’s Guide
IBM z/OS UNIX System Services User's Guide
IBM MVS/ESA Planning: OpenEdition MVS
IBM z/OS UNIX System Services Planning
IBM TCP/IP for OpenEdition MVS Applications Feature Guide
IBM TCP/IP for MVS: Messages and Codes
IBM TCP/IP for MVS: Customization and Administration Guide
IBM TCP/IP for MVS: User’s Guide
IBM TCP/IP Performance Tuning Guide
IBM TCP/IP for MVS: Planning and Migration Guide
IBM ISPF Dialog Developer’s Guide and Reference
IBM z/OS ISPF Dialog Developer's Guide
IBM TSO/E CLISTS
IBM z/OS TSO/E CLISTs
TIBCO EMS Client for z/OS (MVS) Installation and Reference
x | Preface
IBM z/OS Cryptographic Services System Secure Sockets Layer Programming
IBM REXX/370 User’s Guide
IBM Online Library Omnibus Edition MVS Collection
IBM Online Library Omnibus Edition z/OS Collection
Table 1 Related Documents (Cont’d)
Publication Title
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Typographical Conventions | xi
Typographical Conventions
The following typographical conventions are used in this manual.
Table 2 General Typographical Conventions
Convention Use
TIBCO_HOME Many TIBCO products must be installed within the same home directory. This directory is referenced in documentation as TIBCO_HOME. The default value of TIBCO_HOME depends on the operating system. For example, on Windows systems, the default value is C:\tibco.
code font Code font identifies commands, code examples, filenames, pathnames, and output displayed in a command window. For example:
Use MyCommand to start the foo process.
bold code
font Bold code font is used in the following ways:
• In procedures, to indicate what a user types. For example: Type admin.
• In large code samples, to indicate the parts of the sample that are of particular interest.
• In command syntax, to indicate the default parameter for a command. For example, if no parameter is specified, MyCommand is enabled: MyCommand [enable | disable]
italic font Italic font is used in the following ways:
• To indicate a document title. For example: See TIBCO ActiveMatrix BusinessWorks Concepts.
• To introduce new terms For example: A portal page may contain several portlets. Portlets are mini-applications that run in a portal.
• To indicate a variable in a command or code syntax that you must replace. For example: MyCommand PathName
Key combinations
Key name separated by a plus sign indicate keys pressed simultaneously. For example: Ctrl+C.
Key names separated by a comma and space indicate keys pressed one after the other. For example: Esc, Ctrl+Q.
The note icon indicates information that is of special interest or importance, for example, an additional action required only in certain circumstances.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
xii | Preface
The tip icon indicates an idea that could be useful, for example, a way to apply the information provided in the current section to achieve a specific result.
The warning icon indicates the potential for a damaging situation, for example, data loss or corruption if certain steps are taken or not taken.
Table 2 General Typographical Conventions (Cont’d)
Convention Use
Table 3 Syntax Typographical Conventions
Convention Use
[ ] An optional item in a command or code syntax.
For example:
MyCommand [optional_parameter] required_parameter
| A logical OR that separates multiple items of which only one may be chosen.
For example, you can select only one of the following parameters:
MyCommand para1 | param2 | param3
{ } A logical group of items in a command. Other syntax notations may appear within each logical group.
For example, the following command requires two parameters, which can be either the pair param1 and param2, or the pair param3 and param4.
MyCommand {param1 param2} | {param3 param4}
In the next example, the command requires two parameters. The first parameter can be either param1 or param2 and the second can be either param3 or param4:
MyCommand {param1 | param2} {param3 | param4}
In the next example, the command can accept either two or three parameters. The first parameter must be param1. You can optionally include param2 as the second parameter. And the last parameter is either param3 or param4.
MyCommand param1 [param2] {param3 | param4}
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Connecting with TIBCO Resources | xiii
Connecting with TIBCO Resources
How to Join TIBCOmmunityTIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is a place to share and access the collective experience of the TIBCO community. TIBCOmmunity offers forums, blogs, and access to a variety of resources. To register, go to http://www.tibcommunity.com.
How to Access TIBCO DocumentationYou can access TIBCO documentation here:
http://docs.tibco.com
How to Contact TIBCO SupportFor comments or problems with this manual or the software it addresses, contact TIBCO Support as follows:
• For an overview of TIBCO Support, and information about getting started with TIBCO Support, visit this site:
http://www.tibco.com/services/support
• If you already have a valid maintenance or support contract, visit this site:
https://support.tibco.com
Entry to this site requires a user name and password. If you do not have a user name, you can request one.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
xiv | Preface
TIBCO EMS Client for z/OS (MVS) Installation and Reference
| 1
Chapter 1 Introduction
This manual provides information about the TIBCO EMS Client for z/OS (MVS) product. It is intended primarily for programmers who are responsible for installing and maintaining the software. Some of the information contained here may also be useful for application programmers involved in creating or modifying programs that work in conjunction with this product. We recommend that you read through this manual before attempting to install the product, and keep a copy handy for future reference.
Topics
• Overview, page 2
• Installation Requirements, page 3
TIBCO EMS Client for z/OS (MVS) Installation and Reference
2 | Chapter 1 Introduction
Overview
The TIBCO EMS Client for z/OS (MVS) software allows applications running on IBM z/OS systems to produce and consume messages that are transported via TIBCO EMS servers. TIBCO EMS client applications can use SSL for secure communications with TIBCO EMS servers using standard API calls.
Messages are structured data that one application sends to another. TIBCO EMS servers, running on platforms outside the traditional z/OS environment, act as intermediaries for messages and route them to recipients. This message flow is illustrated in the diagram below:
Figure 1 User Application and TIBCO EMS Messaging
An application participates in this messaging environment as follows:
1. The application embeds TIBCO EMS API function calls to facilitate message communication.
2. The TIBCO EMS Client for z/OS (MVS) establishes connections to a TIBCO EMS server using standard TCP/IP.
3. The application sends messages to or receives messages from the TIBCO EMS server using destinations for message routing.
4. Other TIBCO EMS clients exchange messages with the application via the TIBCO EMS server.
TIBCO EMS API function calls are coded by programmers and included into the application at compilation time. The product <USERHLQ>.LIBRARY dataset contains the objects that are included during the pre-link step of a compilation. Program can also compile and bind an application using the EMS supplied DLL side-deck.
TIBCO EMS Client for
z/OS (MVS)
MVS
TIBCOEMSClient
TIBCOEMSClient
TIBCOEMSClient
TIBCOEMS
Server
UserApplication
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Installation Requirements | 3
Installation Requirements
The TIBCO EMS Client for z/OS (MVS) software runs as a z/OS batch task. The product is supported on z/OS 1.8 and later (64-bit).
Before installing the product under z/OS, you must ensure that the following are installed and properly configured:
Storage RequirementsThe TIBCO EMS Client for z/OS (MVS) product requires approximately 100 cylinders of Direct-Access Storage Device (DASD) space. This space calculation is based on an IBM 3390 DASD device.
TCP/IPThe TIBCO EMS Client for z/OS (MVS) is expected to be installed and operated within a previously existing, fully functional and integrated network. At a minimum, this includes the following:
• The TCP/IP protocol stack within the z/OS Communications Server.
• A DNS server that provides the hostname and host address of the z/OS client and the TIBCO EMS server.
• Unrestricted network connectivity between the DNS, the TIBCO EMS Client for z/OS (MVS), and the TIBCO EMS server.
Customers should be running a properly configured RESOLVER address space.
Customers should review their TCPCONFIG parameters to ensure that they meet the installation’s needs. If the customer chooses to run the TIBCO EMS Client for z/OS (MVS) non-APF authorized, the RESTRICTLOWPORTS parameter should be used. If customers want to control TCP buffering, to limit storage usage, or to support large bandwidth devices, the TCPSENDBFRSIZE, TCPRCVBUFRSIZE, and TCPMAXRCVBUFRSIZE parameters may be needed. TIBCO typically recommends customers override the IBM default of 16K by setting TCPRCVBUFRSIZE and TCPSENDBFRSIZE to a minimum value of 48K.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
4 | Chapter 1 Introduction
SSLAs of Release 7.0, TIBCO EMS Client for z/OS (MVS) uses the IBM System SSL facility to create secure connections to the EMS server. To use System SSL, you may need to configure:
• IBM Integrated Cryptographic Support Facility (ICSF)
• IBM Resource Access Control Facility (RACF), or a Security Authorization Facility (SAF)-compatible equivalent
• An SSL Started Task, configured as defined in the IBM System SSL Programming guide
To create the security context required by System SSL for TIBCO EMS Clients, you must also be prepared to use RACF or an equivalent product to:
• Generate and manage digital certificates.
• Create and manage key rings.
• Authorize intended users to utilize key rings and certificates.
• In some cases, configure security to codesign programs and allow users access to code-signed programs.
For more information about the permissions required to use IBM System SSL, see the IBM z/OS Cryptographic Services ICSF System Programmer's Guide for your operating system version.
For more information about using IBM System SSL with TIBCO Enterprise Message Service, see the TIBCO Enterprise Message Service C & COBOL API Reference.
FIPS Mode
The Federal Information Processing Standard Security Requirements for Cryptographic Modules referred to as 'FIPS 140-2' is referred to in most documentation as “FIPS” or “FIPS Mode”. Customers wishing to run TIBCO EMS Client for z/OS (MVS) in FIPS mode on an IBM System Z processor must have the appropriate level of hardware or software installed.
You must install one of these:
• The Crypto Express3 (CEX3C) feature, supplied and installed by IBM.
• The appropriate levels of the IBM Java with IBM® Java™ JCE (Java Cryptographic Extension) FIPS Provider (IBMJCEFIPS).
Refer to Customizing System SSL on page 20 for additional information.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Installation Requirements | 5
Language Environment (LE)LE is the language environment. The Assembler, C and COBOL for MVS compilers are required for application development under this environment.
Note that IBM TCP uses the OE socket interface. Therefore, all user ids running EMS client programs must have an OMVS UID and GID. Define these values in the OMVS segment of the USERID and GROUP records in RACF.
For more information, see User Profile Requirements on page 5.
User Profile Requirements Any userid used to run a TIBCO EMS Client for z/OS (MVS) application must have a valid RACF OMVS segment defined.
• If you are starting such an application as a batch job, verify that the submitter's userid has a valid OMVS segment defined.
• If you are starting such an application as a started task, verify that the userid assigned by the RACF STARTED class or ICHRIN03 started procedures table has a valid OMVS segment. Verification can be done by using the RACF LISTUSER command.
TSO LISTUSER TIBCO01 OMVS NORACF
USER=TIBCO01
OMVS INFORMATIONUID= 0000012345HOME= /tibco/tibco01PROGRAM= /bin/shCPUTIMEMAX= NONEASSIZEMAX= NONEFILEPROCMAX= NONEPROCUSERMAX= NONETHREADSMAX= NONEMMAPAREAMAX= NONE***
TIBCO Software recommends running TIBCO messaging applications with a userid without resource limits specified in the OMVS segment, as shown in the example userid TIBCO01. This allows TIBCO messaging applications to run within the limits defined to the overall system in BPXPRMxx. There are no special requirements for UID, HOME, or PROGRAM in order to run TIBCO messaging applications.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
6 | Chapter 1 Introduction
If an existing userid does not have an OMVS segment, you can define one by using the RACF ALTUSER command. For more information regarding the use of the various RACF commands and the setup of an OMVS segment, refer to "SecureWay Security Server RACF Command Language Reference" or equivalent documentation published by IBM.
If the installation is using the FACILITY class profile BPX.DEFAULT.USER instead of defining OMVS segments for every userid, the userid defined in the FACILITY class profile BPX.DEFAULT.USER should be examined to ensure that it does not have resource limits defined if the user submits TIBCO EMS jobs. For more information about managing the FACILITY class profile BPX.DEFAULT.USER, see SecureWay Security Server RACF Security Administrator's Guide (documentation published by IBM).
TIBCO EMS Client for z/OS (MVS) Installation and Reference
| 7
Chapter 2 Installation
This chapter describes how to install the TIBCO EMS Client for z/OS (MVS) software.
Topics
• Before Installation, page 8
• Distribution Media and Contents, page 9
• Checklist for Installation, page 11
• Uploading the Software, page 12
• Installing the Software, page 14
• Verifying the Installation, page 17
• Optional Installation Changes, page 18
• Customizing System SSL, page 20
TIBCO EMS Client for z/OS (MVS) Installation and Reference
8 | Chapter 2 Installation
Before Installation
The table below provides a checklist of variables and data set HLQs (High Level Qualifiers) that you should obtain before performing the installation. All TIBCO EMS supplied JCL and procedures have a standard naming convention. You must replace TIBCO site-specific installation-defined variables, such as JCL SET statements, procedure overrides, SYSIN data and system data set HLQ with user values. You must also replace TIBCO Software variables before the JCL's can be submitted for execution.
It is recommended that you copy of the table below, then review and complete the entries. Column headings are defined as follows:
Description – provides instructional information.
Variable – the variable name as it will appear in the provided JCL(S) and/or the member names. There may be several instances of the same variable within a specific member.
User Value – left blank so you can insert the appropriate values for your site.
Table 4 General Variables
Description Variable User Value
Obtain a High Level Qualifier for your TIBCO EMS libraries. Typically, TIBCO.SXJ is used.
<USERHLQ>
Obtain a hard disk Volume Serial where the TIBCO EMS files are to be installed.
<USERVOL>
Replace these <JOBNAME> variables with user define values.
<JOBNAM>
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Distribution Media and Contents | 9
Distribution Media and Contents
This section describes how to obtain the software, and the installation files included in the distribution media. The software is distributed in IBM XMIT format.
Complete Replacement Package
By default, the TIBCO EMS Client for z/OS (MVS) software is delivered as a non SMP/E stand-alone, base function package. Subsequent modifications and updates are version and product dependent. Therefore, a complete product replacement is preformed with each installation.
Component Code
The component code for the TIBCO EMS Client for z/OS (MVS) products is SXJ. This component code is registered with the IBM product codes division.
Obtaining the SoftwareTo obtain the software, you can download it directly from the TIBCO Software web site, or you can request the software on CD.
Downloading from the Web Site
To download the software from the TIBCO Software web site, follow these steps:
• Contact TIBCO Software for a password, directory information, and so forth.
• Connect to the TIBCO Software web site with the required information.
• Download the appropriate files, which are in the standard IBM XMIT format.
Some TIBCO EMS Client for z/OS (MVS) installation file names, including the software package name, include the current three-digit software release version number. Throughout the documentation, this version number is referenced as version. For example, the distribution file name is referred to as:
TIB_ems_version_zos_mvs.xmit.zip
where version is the TIBCO EMS Client for z/OS (MVS) software release version. For software release 7.0.0, the distribution file name is:
TIB_ems_7.0.0_zos_mvs.xmit.zip
TIBCO EMS Client for z/OS (MVS) Installation and Reference
10 | Chapter 2 Installation
Requesting a CD
If you do not want to download the software over the network, you can obtain a CD containing the software and load it directly onto your system. The minimum time period for delivery of a CD is five working days. Contact TIBCO Support and request the desired media for your environment. For details, see How to Contact TIBCO Support on page xiii.
Product Installation Files for z/OS Version 1.8 and Later
TIBCO EMS Client for z/OS (MVS) for DFSMSdss
Download this file:
TIB_ems_version_zos_mvs.xmit.zip
The zip file contains these files:
TIB_ems_version_zos_mvs.xmit.instTIB_ems_version_zos_mvs.xmit.main
TIBCO EMS Client for z/OS (MVS)for non DFSMSdss
Download this file:
TIB_ems_version_zos_mvs.xmit.nondfs.zip
The zip file contains all non DFSMSdss install files.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Checklist for Installation | 11
Checklist for Installation
The table below provides a checklist of variables or required items that should be obtained before performing the installation process. The data set suffix and member names are included as reference to where they occur.
Column headings are defined as follows:
Description – provides instructional information.
Suffix – lists the suffix of the data set containing the reference.
Member – contains the variable in question. There may be several instances of the same variable within a specific member.
Table 5 Installation Checklist
Description Suffix Member
If you are transferring the installation files from a server, obtain the IP address or server name for the FTP process.
INSTALL SXJ$3FT
SXJ$3FT@
Obtain the data set and or member name where your site FTPDATA information resides.
INSTALL SXJ$3FT
SXJ$3FT@
TIBCO EMS Client for z/OS (MVS) Installation and Reference
12 | Chapter 2 Installation
Uploading the Software
If you have acquired the TIBCO EMS Client for z/OS (MVS) software by downloading it from the TIBCO Software web site, you need to upload the software to the z/OS host system using the FTP file transfer utility. Sample JCL for performing the initial installation file transfer is shown below.
Initial Installation
Sample JCL for an Upload
This sample uses IBM's FTP to copy the installation file(s) from a LAN server or PC to the z/OS host.
//<JOBNAM> JOB (&SYSUID),'EMS FTP',CLASS=A//* // SET FTPADDR=10.10.2.99 < IP Address or Host Name //* //FTP EXEC PGM=FTP,REGION=0M,PARM='&FTPADDR (TIMEOUT 20' //SYSPRINT DD SYSOUT=* //OUTPUT DD SYSOUT=* //SYSTCPD DD DISP=SHR,DSN=TCPIP.PROFILE(FTPDATA) < Host Member //INPUT DD * <lan-userid> <lan-password> cd /<lan-file-dir> binary LOCSITE RECFM=FB LRECL=80 BLKSIZE=27920 TR PRI=60 SEC=15 get <userhlq>.xmit.inst' <USERHLQ>.XMIT.INST' (REPLACE quit /*//
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Uploading the Software | 13
Receive the Initial Installation File
The <USERHLQ>.XMIT.INST file contains JCL that is required to receive other files and to create the appropriate libraries. To complete this process, the TIBCO supplied variables must be substituted with the appropriate site-specific user values.
Perform the following steps:
1. From the ISPF Command Shell Panel, type the following command to receive a file containing the JCL required to begin a first-time installation:
receive inda('<USERHLQ>.XMIT.INST')
TSO will prompt with the following:
INMR906A Enter restore parameters or 'DELETE' or 'END' +
2. Supply the following:
DA('<USERHLQ>.INSTALL')
After a successful receive, the following message is displayed:INMR001I Restore successful to dataset '<USERHLQ>.INSTALL'
The data set name supplied in step 2 is output and populated with the members that are required in order for you to continue with the installation.
This step must be performed during a TIBCO EMS Client for z/OS (MVS) installation on the z/OS Host.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
14 | Chapter 2 Installation
Installing the Software
The following steps are required to install the MVS components for the TIBCO EMS Client for z/OS (MVS) product.
All members reside within the <USERHLQ>.INSTALL dataset.
Edit the selected members listed in the steps below. Substitute the variables, follow any instructions contained in the member, and then submit the JCL for execution.
The following table defines the user substitution variables for the installation JCL.
STEP 1: Make CLIST temporary file
Change the #JOBNAME, #USERHLQ, #USERVOL statement variables according to your sites requirements.
Member: SXJ$1MKT
Table 6 File Tailoring Variables for Installation JCL
Variable Default and Structure User Value
USERHLQ TIBCO.SXJ.VxRxMx
VOLSERVolume Serial
TIB999
JOBNAME SXJEMSFirst 6 characters
STEP 2: Execute file tailoring CLIST for installation JCL.
If an error is made during input, press the attention key (PA1) and execute starting at step 1 again.
Member: SXJ$2EX1 (EX member)
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Installing the Software | 15
STEP 3: Upload the TIBCO EMS Client for z/OS (MVS) installation file(s) to z/OS.
Upload the files via FTP to your host.
Member: • For DFSMSdss sites, use SXJ$3FT
• For non DFSMSdss sites, use SXJ$3FT@
STEP 4: Define and allocate the TIBCO EMS Client for z/OS (MVS) product libraries
Only to be performed on initial installation
Member: SXJ$4ALL
STEP 5: Convert product installation files to appropriate data sets.
The installation can be restarted multiple times at this step if required.
Member: • For DFSMSdss sites, use SXJ$5RC
• For non DFSMSdss sites, use SXJ$5RC@
TIBCO EMS Client for z/OS (MVS) Installation and Reference
16 | Chapter 2 Installation
The following table defines the user substitution variables within JCL and parameter members that will be required during the file tailoring process. Ensure that you have all the necessary information before executing this step.
Table 7 File Tailoring Variables
Variable Default and Structure User Value
IBM Assembler Libraries HLQ
ASM*.SASMMAC2
COBOL for MVS Libraries HLQ
IGY*.SIGYCOMP
TIBCO EMS Server Location
hostname: 7222
STEP 6: Execute file tailoring CLIST to update the product supplied variables.
If an error is made during input, press the attention key (PA1) and execute the clist again.
Member: SXJ$6EX2 (EX member)
STEP 7: Populate the TIBCO EMS Client for z/OS (MVS) datasets with all the update and downloaded members.
Member: SXJ$7UPD
STEP 8: Check the user’s profile and verify that the OMVS Segment has been created.
To verify the output, use:
TSO LISTUSER <USERID>
For details, see User Profile Requirements on page 5.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Verifying the Installation | 17
Verifying the Installation
To verify that TIBCO EMS Client for z/OS (MVS) components have been correctly installed and configured, perform the steps listed below.
Step I1: TIBCO EMS messaging consumer startup JCL
Data Set: <USERHLQ>.JCL
Member: RUNGMC
Step I2: TIBCO EMS messaging producer startup JCL
Data Set: <USERHLQ>.JCL
Member: RUNGMP
This member will initiate a TIBCO EMS consumer that receives messages from the producer. By substituting the PGMNAME parameter, the JCL can be used to execute the C or COBOL sample programs.
This member will initiate a TIBCO EMS producer that publishes a message to an executing consumer. By substituting the PGMNAME parameter, the JCL can be used to execute the C or COBOL sample programs.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
18 | Chapter 2 Installation
Optional Installation Changes
TIBCO EMS Client for z/OS (MVS) sample programs are supplied as source and executable modules as part of the installation. However, users may desire to change the source code to perform additional functions. JCLs and procedures have been supplied to compile the sample programs that normally have to be modified to be used within a user's environment.
Edit the data sets and selected members listed in the steps below. Substitute the variables, follow any instructions that are contained in the member and then submit it for execution.
Compiling C ProgramsStep 1a: C language options file
Data Set: <USERHLQ>.CNTL
Member: OPTFSXJ
Step 1b: TIBCO EMS C language compilation JCL
Data Set: <USERHLQ>.JCL
Member: SXJ3NCB
This member is the Options File used for TIBCO EMS C compiles that needs to include members from the system C and TIBCO EMS libraries. Substitute the appropriate values and installation variables that are located within this member.
The JCL listed below uses a procedure that may have to be modified so that it conforms to your site’s requirements and executes correctly.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Optional Installation Changes | 19
Compiling COBOL ProgramsStep 1c: TIBCO EMS COBOL compilation JCL
Data Set: <USERHLQ>.JCL
Member: SXJCNCB
Compiling Assembler ProgramsStep 1d: TIBCO EMS Assembler compilation JCL
Data Set: <USERHLQ>.JCL
Member: SXJANCB
The JCL listed below uses a procedure that may have to be modified so that it conforms to your site's requirements and executes correctly. This member will compile COBOL supplied sample program(s).
The JCL listed below uses a procedure that may have to be modified so that it conforms to your site's requirements and executes correctly. This member will compile Assembler supplied sample program(s).
TIBCO EMS Client for z/OS (MVS) Installation and Reference
20 | Chapter 2 Installation
Customizing System SSL
In order to create a secured environment for the TIBCO EMS Client for z/OS (MVS), you must be familiar with the IBM System SSL environment. To ensure that the System SSL environment meets your local security requirements, you may need to customize the existing System SSL environment.
This section includes a broad outline of steps to take or items to check when reviewing the System SSL environment. However, every system will have unique requirements that cannot be fully addressed in this guide.
Additionally, this discussion is limited to the IBM Security Server (RACF). If you intend to use another vendor’s equivalent security product, please refer to that product’s documentation for guidance.
CustomizationsCheck and if necessary configure the IBM Integrated Cryptographic Support Facility (ICSF):
• Ensure the started task is running (CSFSTART or equivalent).
• Verify any coprocessor hardware is configured and the keys are loaded.
• If FIPS mode is required, verify parmlib options include FIPSMODE(YES,FAIL(YES)).
RACF FACILITY ClassIndividuals who are assigned the tasks of administering certificates and key rings must have the necessary authority levels granted in these FACILITY class profiles:
• IRR.DIGTCERT.CONNECT
• IRR.DIGTCERT.EXPORT
• IRR.DIGTCERT.EXPORTKEY
• IRR.DIGTCERT.KEYRING
• IRR.DIGTCERT.LIST
• IRR.DIGTCERT.LISTRING
This guide does not replace the documentation and guidance supplied by IBM.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Customizing System SSL | 21
• IRR.PASSWORD.RESET
• IRR.PROGRAM.SIGNATURE.VERIFICATION
In many of these profiles, administrators require higher authority levels than end users; some profiles will not require end users to have any authorization. To ensure that the proper authorization levels are assigned in accordance with the intended usage, follow the guidelines outlined in IBM’s Security Server (RACF) documentation for the RACDCERT command.
RACF Key Rings
RACF Key rings must meet these requirements:
• The EMS client (batch job or started task) has a key ring.
• The user assigned to the job or started task can read the key ring.
• The EMS client has a certificate on the key ring.
• The key ring includes the certificate authority (CA or certauth) certificate that was used to sign the client certificate.
• The key ring name is specified in parameter ssl_ring in the startup JCL.
RACF Certificates
RACF Certificates must meet these requirements:
• The EMS client has a certificate uniquely identifying it and its user.
• The EMS client certificate is exported and installed on the EMS Server.
• The certificate is signed by the same certauth certificate that was placed on the client key ring.
• The certificate label as given in the parameter WITHLABEL is specified in parameter ssl_label in the startup JCL.
In many cases, during the installation and install verification of the EMS Client, it is useful for the installation team to have the ability to verify that the certificates and rings have been installed as intended, either for internal verification or at the direction of TIBCO Support. If this capability is desired and the install team members can logon with the user ID used to run the EMS Client, they must have READ authority to IRR.DIGTCERT.LIST and IRR.DIGTCERT.LISTRING. Otherwise, they need UPDATE authority to list the certificates and the ring.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
22 | Chapter 2 Installation
Sample JCL
An example JCL is provided below. This sample assumes that the user intends to generate the certificate using the RACF GENCERT function. This is one of several methods that can generate certificates usable by IBM System SSL.
Data Set: <USERHLQ>.JCL
Member: SSLGCERT
Note that:
• SIZE must be determined by usage. IBM places restrictions on size depending on where the certificate is stored and how it is used. SIZE is also used to determine the strength of the key. For example, a size of 1024 results in a medium-strength key.
• NOTAFTER must be a date that does not exceed the ending date of the signing CA or certauth certificate. For example, if the end date of the CA is 2013-01-01, NOTAFTER must be 2013-01-01 or earlier. The GENCERT function fails otherwise.
Signature VerificationSignature verification, also known as Module Verification, is only required to support FIPS mode and can optionally be ignored for non-FIPS mode operations. The process to achieve signature verification is best described by the IBM document, SSL Programming, in the chapter covering module verification. However, an overview is provided here.
Your system may already meet some or all of these requirements for signature verification:
• IBM's Security Level 3 FMID must be installed.
• The RACF PROGRAM class must be active.
• The IBM root CA must be marked trusted.
• The FACILITY class profile IRR.PROGRAM.SIGNATURE.VERIFICATION must be activated.
• A key ring for the code signing CA must be present or created.
• PROGRAM class profiles must be defined for those System SSL modules that must be indicated as signed.
• The user ID associated with the running EMS client must be authorized to read the PROGRAM secured modules.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Customizing System SSL | 23
Sample JCL
A sample setup JCL, based on IBM documentation, is provided as-is below. Before implementing the sample, ensure that it is appropriate for your requirements and intentions:
Data Set: <USERHLQ>.JCL
Member: SSLRACFA
You must change the user ID RACFADM to the use the ID needed to perform RACF security administration.
Next, find the user ID associated with the EMS client batch job or started task and authorize it to use the programs just secured which will be used by the EMS client.
Data Set: <USERHLQ>.JCL
Member: SSLCODES
TIBCO EMS Client for z/OS (MVS) Installation and Reference
24 | Chapter 2 Installation
TIBCO EMS Client for z/OS (MVS) Installation and Reference
| 25
Chapter 3 Use and Administration
This chapter describes the administration and use of TIBCO EMS Client for z/OS (MVS). Before performing any administrative procedures, you must have completed the installation of the TIBCO EMS Client for z/OS (MVS) software, and executed the IVP steps successfully (as described in Verifying the Installation on page 17).
Topics.
• Case Sensitivity in Input Parameters, page 26
• JCL Statements for Applications, page 27
• JCL Statements for Applications Using SSL, page 28
• Sites with Multiple Stacks, page 29
TIBCO EMS Client for z/OS (MVS) Installation and Reference
26 | Chapter 3 Use and Administration
Case Sensitivity in Input Parameters
JCL Input Parameters
The JCL used to execute TIBCO messaging applications are case sensitive. When editing the JCL, turn CAPS OFF.
TIBCO Messaging Applications
TIBCO messaging applications are also case sensitive. Any application program that uses TIBCO EMS Client for z/OS (MVS) API calls must use the correct case when specifying the API call.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
JCL Statements for Applications | 27
JCL Statements for Applications
The JCL used for running an application is shown below (when SSL is not needed).
General Form //EMSPGM EXEC PGM=<EMSPGM>//STEPLIB DD DISP=SHR,DSN=your.user.loadlib//SYSIN<EMS parameter 1>...<EMS parameter N>
Alternate Form Consider this example from <USERHLQ>.JCL(RUNCMC):
//EMSPGM EXEC PGM=RUNCMC//STEPLIB DD DISP=SHR,DSN=your.user.loadlib//SYSIN-server tcp://tibcoBox:7222-topic ems.test.dest-user Tibco
The program uses the user ID Tibco to connect to the TIBCO EMS server running on the machine with the host name tibcoBox with 7222 as the default port. It listens to topic ems.test.dest.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
28 | Chapter 3 Use and Administration
JCL Statements for Applications Using SSL
In order to create an SSL connection, your user ID must have access to a SAF Key Ring with a user certificate on it. This user certificate must have been signed by a CA certificate which is trusted by the EMS server. This can be accomplished either by signing your certificate with the self signed root CA from the EMS server distribution, or by importing that CA certificate onto your ring.
The JCL used for running an application that connects to a TIBCO EMS server using SSL is shown below.
//EMSPGM EXEC PGM=<EMSPGM>//STEPLIB DD DISP=SHR,DSN=your.user.loadlib //... Check the supplied JCL for appropriate certificate files//... to be included.//SYSIN-server ssl://tibcoBox:7243-topic ems.test.dest-user Tibco-password password ...-ssl_hostname server-ssl_ring EMS_Client_KeyRing-ssl_label EMS_Client_label-ssl_proto_tlsv1 enabled
The program uses the user ID Tibco to connect to the TIBCO EMS server running on the machine with the host name tibcoBox, with 7243 as the default port. It listens to topic ems.test.dest.
The program uses a SAF Key Ring client certificate EMS_Client_KeyRing and the Key Ring client certificate label EMS_Client_label. The TLSV1 protocol is enabled.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Sites with Multiple Stacks | 29
Sites with Multiple Stacks
When the system uses multiple TCP/IP stacks, insert the following JCL statement before the EMS application execution steps:
//TCAFF EXEC PROC=TIBTCAFF,STACK=TCPIP-STACK-NAME
This statement identifies the stack that the application will use.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
30 | Chapter 3 Use and Administration
TIBCO EMS Client for z/OS (MVS) Installation and Reference
| 31
Chapter 4 Programmer's Guide and Checklist
This chapter provides details for programmers developing EMS Client applications.
Topics
• Overview, page 32
• C Language, page 33
• COBOL, page 34
• SSL, page 35
• DLL, page 36
TIBCO EMS Client for z/OS (MVS) Installation and Reference
32 | Chapter 4 Programmer's Guide and Checklist
Overview
All application programmers in a z/OS environment should make the following checks.
• User options file (CEEUOPT)
A Language Environment user options object is supplied as part of the installation. When compiling a TIBCO EMS Client for z/OS (MVS) application, you must include the object during the link-edited step. The installation- supplied procedures already cater for this.
Including the supplied user options object ensures that POSIX(ON) is set at run-time and memory allocations are optimized.
• Execution
The TIBCO EMS Client for z/OS (MVS) API uses the TCP/IP socket interface. Most installations require a SYSTCPD DD statement in the execution JCL. Contact your organization’s TCP/IP support personnel for additional details.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
C Language | 33
C Language
C language application programmers in a z/OS environment can use this checklist.
• Code
Include the appropriate TIBCO EMS C header files.
• Compile/Pre-link/Link
Sample JCL for compiling C programs is member SXJ3NCB.
— Application source files normally reside in the <USERHLQ>.C dataset.
— Requirements are specified in the applicable compile procedure.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
34 | Chapter 4 Programmer's Guide and Checklist
COBOL
COBOL application programmers in an z/OS environment can use this checklist.
• Code
Include the appropriate TIBCO EMS COBOL copybooks.
• Compile/Pre-link/Link
Sample JCL for compiling COBOL programs is member SXJCNCB.
— Application source files normally reside in the <USERHLQ>.COB dataset.
— Requirements are specified in the applicable compile procedure.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
SSL | 35
SSL
TIBCO EMS Client for z/OS (MVS) supports SSL, and the C and COBOL language samples illustrates SSL usage. We supply run-time JCL to support the usage of SSL (see RUNSMC and RUNSMP).
The TIBCO EMS server installation provides sample keys which you can import onto your Key Ring for use with the samples, however these certificates should not be used in a production application.
Please consult your security officer for information about SSL certificates and keys.
Please see TIBCO Enterprise Message Service User’s Guide for a more complete description of SSL usage in TIBCO EMS.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
36 | Chapter 4 Programmer's Guide and Checklist
DLL
TIBCO EMS Client for z/OS (MVS)is provided as a DLL (Dynamic-link library) with an accompanying side deck file (to be used as input to the linker). As of software release 7.0, all TIBCO EMS client applications for z/OS must be compiled with the DLL compiler option and the DYNAM=DLL linker option.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
| 37
Appendix A MVS Batch Sample Programs
This appendix describes members required to build and run MVS Batch transactions that use the TIBCO EMS Reliable API.
Topics
• Messaging Samples, page 38
• JCL and General Procedure Samples, page 40
• Sample Program Data Sets, page 41
TIBCO EMS Client for z/OS (MVS) Installation and Reference
38 | Appendix A MVS Batch Sample Programs
Messaging Samples
Messaging sample programs are described below. The members listed in the tables pertain specifically to MVS Batch. In Table 8, the JCL can be used to execute the C or COBOL sample programs by specifying the desired program using the PGMNAME parameter.
In Table 9, the C functions use non-typed connections and sessions.
Table 8 Sample Program and JCL Member Names
Native C SampleProgram Name C Member COBOL
MemberJCL Member(C & COBOL)
tibemsAdmin SXJ3ADMN SXJCADMN RUNGADMN
tibemsAsyncMsgConsumer.c
SXJ3AMC RUNGAMC
tibemsBrowser.c SXJ3BR SXJCBR RUNGBR
tibemsDurable.c SXJ3DTSB SXJCDTSB RUNGDTSB
tibemsMsgConsumer.c SXJ3MC SXJCMC RUNGMC
RUNSMC (SSL)
tibemsMsgProducer.c SXJ3MP SXJCMP RUNGMP
RUNSMP (SSL)
tibemsXAMsgConsumer.c SXJ3XAMC RUNGXAMC
tibemsXAMsgProducer.c SXJ3XAMP RUNGXAMP
tibemsMsg.c SXJ3MSG SXJCMSG RUNGMSG
tibjmsMsgConsumerPerf SXJ3MCPF RUN3MCPF
tibjmsMsgProducerPerf SXJ3MPPF RUN3MPPF
Table 9 C Samples
C Member Description
SXJ3ADMN TIBCO EMS Administration Client simple example demonstrating use of the Admin API.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Messaging Samples | 39
SXJ3AMC TIBCO EMS Asynchronous Message Consumer
SXJ3BR TIBCO EMS Queue Browsers
SXJ3DTSB TIBCO EMS Durable Topic Subscriber
SXJ3MC TIBCO EMS Message Consumer
SXJ3MP TIBCO EMS Message Producer
SXJ3MCPF Same as tibjmsMsgConsumer, except that it supports multiple threads and connections to show the performance of the TIBCO EMS server when multiple consumers are receiving messages from a queue.
SXJ3MPPF Same as tibjmsMsgProducer, except that it supports multiple threads and connections to show the performance of the TIBCO EMS server when multiple producers are sending messages.
SXJ3MSG TIBCO EMS message consumer demonstrating how to enumerate message properties and fields.
SXJ3XAMC Like SXJ3MC, except that it uses the tibemsXAResource interface to consume messages using transaction semantics.
SXJ3XAMP Like SXJ3MP, except that it uses the classic X/Open DPT XA interface to send messages using transaction semantics.
Table 10 Assembler Sample and JCL Members
Assembler / JCL Member Description
SXJAMC / RUNAMC Sample code segments of TIBCO EMS Message Consumer and JCL for execution.
SXJAMP / RUNAMP Sample code segments of TIBCO EMS Message Producer and JCL for execution.
Table 9 C Samples
C Member Description
TIBCO EMS Client for z/OS (MVS) Installation and Reference
40 | Appendix A MVS Batch Sample Programs
JCL and General Procedure Samples
JCL and general procedure samples are described below.
Table 11 General JCL
Member Description
SXJANCB JCL to compile Assembler EMS API applications
SXJCNCB JCL to compile COBOL EMS API applications using DLL side-deck
SXJ3NCB JCL to compile C EMS API applications using DLL side-deck
SXJPNCB JCL to compile PL/I EMS API applications
SXJCNCO JCL to compile MVS batch COBOL objects
Table 12 General Procedures
Member Description
TIBTCAFF Procedure to set TCPIP stack affinity
TIBANABD Procedure to compile prelink & link Assembler application
TIBCNCBD Procedure to compile & bind DLL COBOL application
TIBPNCBD Procedure to compile prelink & link PL/I application
TIBIGYCO Procedure to compile prelink & link COBOL application
TIB3NCBD Procedure to compile & bind DLL C application
SXJEXEC Procedure to execute the C and COBOL sample programs.
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Sample Program Data Sets | 41
Sample Program Data Sets
The sample programs are contained in the following data sets:
Assembler source code <USERHLQ>.ASM
COBOL source code <USERHLQ>.COB
Copybook <USERHLQ>.COPY
C source code <USERHLQ>.C
Header file <USERHLQ>.H
Run JCL <USERHLQ>.JCL
TIBCO EMS Client for z/OS (MVS) Installation and Reference
42 | Appendix A MVS Batch Sample Programs
TIBCO EMS Client for z/OS (MVS) Installation and Reference
| 43
Appendix B Installed Data Set Specifications
This appendix lists all of the installed data sets.
Table 13 Installed Data Sets
Data Set Space (1st/2nd) DSORG RECFM LRECL BLK
SIZE
<USERHLQ>.ASM CYL (3/1) PO FB 80 27920
<USERHLQ>.C CYL (10/1) PO VB 140 27998
<USERHLQ>.CNTL CYL (5/1) PO FB 80 27920
<USERHLQ>.CNTLSAMP CYL (5/1) PO FB 80 27920
<USERHLQ>.COB CYL (5/1) PO FB 80 27920
<USERHLQ>.COPY CYL (5/1) PO FB 80 27920
<USERHLQ>.H CYL (5/1) PO VB 140 27998
<USERHLQ>.INSTALL BLK (10/2) PO FB 80 27920
<USERHLQ>.JCL CYL (5/1) PO FB 80 27920
<USERHLQ>.JCLSAMP CYL (5/1) PO FB 80 27920
<USERHLQ>.LIBRARY CYL (20/1) PO FB 80 3120
<USERHLQ>.LOAD CYL (30/1) PO U 0 27920
<USERHLQ>.OBJ CYL (5/1) PO FB 80 27920
<USERHLQ>.PLI CYL (3/1) PO FB 80 27920
<USERHLQ>.PROC CYL (2/1) PO FB 80 27920
<USERHLQ>.PROCSAMP CYL (2/1) PO FB 80 27920
<USERHLQ>.SKEL CYL (1/1) PO FB 80 27920
TIBCO EMS Client for z/OS (MVS) Installation and Reference
44 | Appendix C Assembler Calls for C Functions
Appendix C Assembler Calls for C Functions
This appendix specifies the assembler call equivalent of TIBCO EMS API calls. The tables are organized in the sequence in which function descriptions appear in TIBCO Enterprise Message Service C & COBOL API Reference.
Multicast functions (found in the Connection Factory and Utilities chapters in TIBCO Enterprise Message Service C & COBOL API Reference) are not supported.
Table 14 Assembler Calls: Messages
Function Assembler Call
tibemsMsg_Acknowledge EM_ACK
tibemsMsg_ClearBody EM_CBDY
tibemsMsg_ClearProperties EM_CPRP
tibemsMsg_Create EM_CR
tibemsMsg_CreateCopy EM_CRCPY
tibemsMsg_CreateFromBytes EM_CRFBS
tibemsMsg_Destroy EM_DSY
tibemsMsg_GetAsBytes EM_GABS
tibemsMsg_GetAsBytesCopy EM_GABSC
tibemsMsg_GetBodyType EM_GBDYT
tibemsMsg_GetBooleanProperty EM_GBOOP
tibemsMsg_GetByteProperty EM_GBPRP
tibemsMsg_GetByteSize EM_GBSZ
tibemsMsg_GetCorrelationID EM_GCID
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Assembler Calls for C Functions | 45
tibemsMsg_GetDeliveryMode EM_GDM
tibemsMsg_GetDestination EM_GDEST
tibemsMsg_GetDoubleProperty EM_GDP
tibemsMsg_GetEncoding EM_GENC
tibemsMsg_GetExpiration EM_GEXP
tibemsMsg_GetFloatProperty EM_GFLP
tibemsMsg_GetIntProperty EM_GIP
tibemsMsg_GetLongProperty EM_GLP
tibemsMsg_GetMessageID EM_GMID
tibemsMsg_GetPriority EM_GPRI
tibemsMsg_GetProperty EM_GPRP
tibemsMsg_GetPropertyNames EM_GPRPN
tibemsMsg_GetRedelivered EM_GRED
tibemsMsg_GetReplyTo EM_GRT
tibemsMsg_GetShortProperty EM_GSP
tibemsMsg_GetStringProperty EM_GSTRP
tibemsMsg_GetTimestamp EM_GTS
tibemsMsg_GetType EM_GT
tibemsMsg_MakeWriteable EM_MW
tibemsMsg_Print EM_PRINT
tibemsMsg_PrintToBuffer EM_PTB
tibemsMsg_PropertyExists EM_PEX
tibemsMsg_SetBooleanProperty EM_SBOOP
Table 14 Assembler Calls: Messages
Function Assembler Call
TIBCO EMS Client for z/OS (MVS) Installation and Reference
46 | Appendix C Assembler Calls for C Functions
tibemsMsg_SetByteProperty EM_SBP
tibemsMsg_SetCorrelationID EM_SCID
tibemsMsg_SetDeliveryMode EM_SDM
tibemsMsg_SetDestination EM_SDEST
tibemsMsg_SetDoubleProperty EM_SDPRP
tibemsMsg_SetEncoding EM_SENC
tibemsMsg_SetExpiration EM_SEXP
tibemsMsg_SetFloatProperty EM_SFLP
tibemsMsg_SetIntProperty EM_SIP
tibemsMsg_SetLongProperty EM_SLP
tibemsMsg_SetMessageID EM_SMID
tibemsMsg_SetPriority EM_SPRI
tibemsMsg_SetRedelivered EM_SRED
tibemsMsg_SetReplyTo EM_SRTO
tibemsMsg_SetShortProperty EM_SSP
tibemsMsg_SetStringProperty EM_SSTRP
tibemsMsg_SetTimestamp EM_STS
tibemsMsg_SetType EM_STYPE
Table 15 Assembler Calls: Bytes Messages
Function Assembler Call
tibemsBytesMsg_Create EBM_CR
tibemsBytesMsg_GetBodyLength EBM_GBL
Table 14 Assembler Calls: Messages
Function Assembler Call
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Assembler Calls for C Functions | 47
tibemsBytesMsg_GetBytes EBM_GBS
tibemsBytesMsg_ReadBoolean EBM_RBOO
tibemsBytesMsg_ReadByte EBM_RB
tibemsBytesMsg_ReadBytes EBM_RBS
tibemsBytesMsg_ReadChar EBM_RCH
tibemsBytesMsg_ReadDouble EBM_RD
tibemsBytesMsg_ReadFloat EBM_RFL
tibemsBytesMsg_ReadInt EBM_RI
tibemsBytesMsg_ReadLong EBM_RL
tibemsBytesMsg_ReadShort EBM_RS
tibemsBytesMsg_ReadUnsignedByte EBM_RUB
tibemsBytesMsg_ReadUnsignedShort EBM_RUS
tibemsBytesMsg_ReadUTF EBM_RUTF
tibemsBytesMsg_Reset EBM_RES
tibemsBytesMsg_SetBytes EBM_SBS
tibemsBytesMsg_WriteBoolean EBM_WBOO
tibemsBytesMsg_WriteByte EBM_WB
tibemsBytesMsg_WriteBytes EBM_WBS
tibemsBytesMsg_WriteChar EBM_WCH
tibemsBytesMsg_WriteDouble EBM_WD
tibemsBytesMsg_WriteFloat EBM_WFL
tibemsBytesMsg_WriteInt EBM_WI
tibemsBytesMsg_WriteLong EBM_WL
Table 15 Assembler Calls: Bytes Messages
Function Assembler Call
TIBCO EMS Client for z/OS (MVS) Installation and Reference
48 | Appendix C Assembler Calls for C Functions
tibemsBytesMsg_WriteShort EBM_WS
tibemsBytesMsg_WriteUTF EBM_WUTF
Table 16 Assembler Calls: Map Messages
Function Assembler Call
tibemsMapMsg_Create EMM_CR
tibemsMapMsg_GetBoolean EMM_GBOO
tibemsMapMsg_GetByte EMM_GB
tibemsMapMsg_GetBytes EMM_GBS
tibemsMapMsg_GetChar EMM_GCH
tibemsMapMsg_GetDouble EMM_GD
tibemsMapMsg_GetField EMM_GF
tibemsMapMsg_GetFloat EMM_GFL
tibemsMapMsg_GetInt EMM_GI
tibemsMapMsg_GetLong EMM_GL
tibemsMapMsg_GetMapMsg EMM_GMM
tibemsMapMsg_GetMapNames EMM_GMN
tibemsMapMsg_GetShort EMM_GS
tibemsMapMsg_GetString EMM_GSTR
tibemsMapMsg_ItemExists EMM_IEX
tibemsMapMsg_SetBoolean EMM_SBOO
tibemsMapMsg_SetByte EMM_SB
tibemsMapMsg_SetBytes EMM_SBS
Table 15 Assembler Calls: Bytes Messages
Function Assembler Call
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Assembler Calls for C Functions | 49
tibemsMapMsg_SetChar EMM_SCH
tibemsMapMsg_SetDouble EMM_SD
tibemsMapMsg_SetDoubleArray EMM_SDA
tibemsMapMsg_SetFloat EMM_SFL
tibemsMapMsg_SetFloatArray EMM_SFLA
tibemsMapMsg_SetInt EMM_SI
tibemsMapMsg_SetIntArray EMM_SIA
tibemsMapMsg_SetLong EMM_SL
tibemsMapMsg_SetLongArray EMM_SLA
tibemsMapMsg_SetMapMsg EMM_SMM
tibemsMapMsg_SetReferencedBytes EMM_SRBS
tibemsMapMsg_SetShort EMM_SS
tibemsMapMsg_SetShortArray EMM_SSA
tibemsMapMsg_SetStreamMsg EMM_SSM
tibemsMapMsg_SetString EMM_SSTR
Table 17 Assembler Calls: Object Messages
Function Assembler Call
tibemsObjectMsg_Create EOM_CR
tibemsObjectMsg_GetObjectBytes EOM_GOB
tibemsObjectMsg_SetObjectBytes EOM_SOB
Table 16 Assembler Calls: Map Messages
Function Assembler Call
TIBCO EMS Client for z/OS (MVS) Installation and Reference
50 | Appendix C Assembler Calls for C Functions
Table 18 Assembler Calls: Stream Messages
Function Assembler Call
tibemsStreamMsg_Create ESM_CR
tibemsStreamMsg_FreeField ESM_FFLD
tibemsStreamMsg_ReadBoolean ESM_RBOO
tibemsStreamMsg_ReadByte ESM_RB
tibemsStreamMsg_ReadBytes ESM_RBS
tibemsStreamMsg_ReadChar ESM_RCH
tibemsStreamMsg_ReadDouble ESM_RD
tibemsStreamMsg_ReadFloat ESM_RFL
tibemsStreamMsg_ReadField ESM_RFLD
tibemsStreamMsg_ReadInt ESM_RI
tibemsStreamMsg_ReadLong ESM_RL
tibemsStreamMsg_ReadShort ESM_RS
tibemsStreamMsg_ReadString ESM_RSTR
tibemsStreamMsg_Reset ESM_RES
tibemsStreamMsg_WriteBoolean ESM_WBOO
tibemsStreamMsg_WriteByte ESM_WB
tibemsStreamMsg_WriteBytes ESM_WBS
tibemsStreamMsg_WriteChar ESM_WCH
tibemsStreamMsg_WriteDouble ESM_WD
tibemsStreamMsg_WriteDoubleArray ESM_WDA
tibemsStreamMsg_WriteFloat ESM_WFL
tibemsStreamMsg_WriteFloatArray ESM_WFLA
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Assembler Calls for C Functions | 51
tibemsStreamMsg_WriteInt ESM_WI
tibemsStreamMsg_WriteIntArray ESM_WIA
tibemsStreamMsg_WriteLong ESM_WL
tibemsStreamMsg_WriteLongArray ESM_WLA
tibemsStreamMsg_WriteMapMsg ESM_WMM
tibemsStreamMsg_WriteShort ESM_WS
tibemsStreamMsg_WriteShortArray ESM_WSA
tibemsStreamMsg_WriteStreamMsg ESM_WSM
tibemsStreamMsg_WriteString ESM_WSTR
Table 19 Assembler Calls: Text Messages
Function Assembler Call
tibemsTextMsg_Create ETM_CR
tibemsTextMsg_GetText ETM_GTXT
tibemsTextMsg_SetText ETM_STXT
Table 20 Assembler Calls: Message Enumerate and Print
Function Assembler Call
tibemsMsgEnum_Destroy EME_DSY
tibemsMsgEnum_GetNextName EME_GNN
tibemsMsgField_Print EMF_PRNT
tibemsMsgField_PrintToBuffer EM_PFTB
Table 18 Assembler Calls: Stream Messages
Function Assembler Call
TIBCO EMS Client for z/OS (MVS) Installation and Reference
52 | Appendix C Assembler Calls for C Functions
Table 21 Assembler Calls: Destination
Function Assembler Call
tibemsDestination_Copy ED_COPY
tibemsDestination_Create ED_CR
tibemsDestination_Destroy ED_DSY
tibemsDestination_GetName ED_GETNM
tibemsDestination_GetType ED_GETTY
tibemsQueue_Create EQ_CR
tibemsQueue_Destroy EQ_DSY
tibemsQueue_GetQueueName EQ_GQN
tibemsTopic_Create ET_CR
tibemsTopic_Destroy ET_DSY
tibemsTopic_GetTopicName ET_GTN
Table 22 Assembler Calls: Consumer
Function Assembler Call
tibemsMsgConsumer_Close EMC_CLO
tibemsMsgConsumer_GetDestination EMC_GD
tibemsMsgConsumer_GetMsgListener EMC_GML
tibemsMsgConsumer_GetMsgSelector EMC_GMSL
tibemsMsgConsumer_GetNoLocal EMC_GNL
tibemsMsgConsumer_Receive EMC_R
tibemsMsgConsumer_ReceiveNoWait EMC_RNOW
tibemsMsgConsumer_ReceiveTimeout EMC_RTO
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Assembler Calls for C Functions | 53
tibemsMsgConsumer_SetMsgListener EMC_SML
Table 23 Assembler Calls: Producer
Function Assembler Call
tibemsMsgProducer_Close EMP_CLO
tibemsMsgProducer_GetDeliveryMode EMP_GDM
tibemsMsgProducer_GetDestination EMP_GD
tibemsMsgProducer_GetDisableMessageID EMP_GDMI
tibemsMsgProducer_GetDisableMessageTimestamp EMP_GDMT
tibemsMsgProducer_GetNPSendCheckMode EMP_GSCM
tibemsMsgProducer_GetPriority EMP_GPRI
tibemsMsgProducer_GetTimeToLive EMP_GTTL
tibemsMsgProducer_Send EMP_SN
tibemsMsgProducer_SendEx EMP_SNX
tibemsMsgProducer_SendToDestination EMP_SND
tibemsMsgProducer_SendToDestinationEx EMP_SNDX
tibemsMsgProducer_SetDeliveryMode EMP_SDM
tibemsMsgProducer_SetDisableMessageID EMP_SDMI
tibemsMsgProducer_SetDisableMessageTimestamp EMP_SDMT
tibemsMsgProducer_SetNPSendCheckMode EMP_SSCM
tibemsMsgProducer_SetPriority EMP_SPRI
tibemsMsgProducer_SetTimeToLive EMP_STTL
Table 22 Assembler Calls: Consumer
Function Assembler Call
TIBCO EMS Client for z/OS (MVS) Installation and Reference
54 | Appendix C Assembler Calls for C Functions
Table 24 Assembler Calls: Requestor
Function Assembler Call
tibemsMsgRequestor_Create EMR_CRT
tibemsMsgRequestor_Close EMR_CLO
tibemsMsgRequestor_Request EMR_REQ
Table 25 Assembler Calls: Connection
Function Assembler Call
tibemsConnection_Close EC_CLO
tibemsConnection_Create EC_CR
tibemsConnection_CreateSession EC_CRS
tibemsConnection_CreateSSL EC_CRSSL
tibemsConnection_GetActiveURL EC_GAURL
tibemsConnection_GetClientId EC_GCLI
tibemsConnection_GetExceptionListener EC_GEXL
tibemsConnection_SetClientId EC_SCLI
tibemsConnection_SetExceptionListener EC_SEXL
tibemsConnection_Start EC_START
tibemsConnection_Stop EC_STOP
tibemsSSL_System_GetDebugTrace EPS_GDT
tibemsSSL_System_GetTrace EPS_GT
tibemsSSL_System_SetDebugTrace EPS_SDT
tibemsSSL_System_SetFipsMode EPS_SFIP
tibemsSSL_System_SetTrace EPS_ST
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Assembler Calls for C Functions | 55
tibemsSSL_System_Version EPS_VER
tibemsSSLParams_System_Create EPS_CR
tibemsSSLParams_System_Destroy EPS_DSY
tibemsSSLParams_System_SetAuthOnly EPS_SAO
tibemsSSLParams_System_SetCiphers EPS_SCIP
tibemsSSLParams_System_SetEnableSSLV3 EPS_SEV3
tibemsSSLParams_System_SetEnableTLS1 EPS_SETL
tibemsSSLParams_System_SetExpectedHostName EPS_SEHN
tibemsSSLParams_System_SetKeyRingFile EPS_SKRF
tibemsSSLParams_System_SetLabel EPS_SLAB
tibemsSSLParams_System_SetLdapServerPassword EPS_SLPW
tibemsSSLParams_System_SetLdapServerUrl EPS_SLUR
tibemsSSLParams_System_SetLdapServerUserid EPS_SLID
tibemsSSLParams_System_SetVerifyHostName EPS_SVHN
Table 26 Assembler Calls: Connection Factory
Function Assembler Call
tibemsConnectionFactory_Create ECF_CR
tibemsConnectionFactory_CreateConnection ECF_CRC
tibemsConnectionFactory_CreateXAConnection ECF_CXAC
tibemsConnectionFactory_Destroy ECF_DSY
tibemsConnectionFactory_GetSSLProxyHost ECF_GSPH
tibemsConnectionFactory_GetSSLProxyPort ECF_GSPP
Table 25 Assembler Calls: Connection
Function Assembler Call
TIBCO EMS Client for z/OS (MVS) Installation and Reference
56 | Appendix C Assembler Calls for C Functions
tibemsConnectionFactory_GetSSLProxyUser ECF_GSPU
tibemsConnectionFactory_GetSSLProxyPassword ECF_GSPW
tibemsConnectionFactory_Print ECF_P
tibemsConnectionFactory_SetClientID ECF_SCLI
tibemsConnectionFactory_SetConnectAttemptCount ECF_SCAC
tibemsConnectionFactory_SetConnectAttemptDelay ECF_SCAD
tibemsConnectionFactory_SetConnectAttemptTimeout ECF_SCAT
tibemsConnectionFactory_SetMetric ECF_SM
tibemsConnectionFactory_SetPkPassword ECF_SPKP
tibemsConnectionFactory_SetReconnectAttemptCount ECF_SRAC
tibemsConnectionFactory_SetReconnectAttemptDelay ECF_SRAD
tibemsConnectionFactory_SetReconnectAttemptTimeout ECF_SRAT
tibemsConnectionFactory_SetServerURL ECF_SSUR
tibemsConnectionFactory_SetSSLParams ECF_SSLP
tibemsConnectionFactory_SetSSLProxy ECF_SSP
tibemsConnectionFactory_SetSSLProxyAuth ECF_SSPA
Table 27 Assembler Calls: Session
Function Assembler Call
tibemsSession_Close ES_CLO
tibemsSession_Commit ES_COMT
tibemsSession_CreateBrowser ES_CRBR
tibemsSession_CreateBytesMessage ES_CRBSM
Table 26 Assembler Calls: Connection Factory
Function Assembler Call
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Assembler Calls for C Functions | 57
tibemsSession_CreateConsumer ES_CRCNS
tibemsSession_CreateDurableSubscriber ES_CRDS
tibemsSession_CreateMapMessage ES_CRMM
tibemsSession_CreateMessage ES_CRMS
tibemsSession_CreateProducer ES_CRPRD
tibemsSession_CreateStreamMessage ES_CRSMS
tibemsSession_CreateTemporaryQueue ES_CRTQ
tibemsSession_CreateTemporaryTopic ES_CRTT
tibemsSession_CreateTextMessage ES_CRTM
tibemsSession_CreateTextMessageEx ES_CRTMX
tibemsSession_DeleteTemporaryQueue ES_DLTQ
tibemsSession_DeleteTemporaryTopic ES_DLTT
tibemsSession_GetAcknowledgeMode ES_GACKM
tibemsSession_GetTransacted ES_GTRN
tibemsSession_Recover ES_REC
tibemsSession_Rollback ES_ROLB
tibemsSession_Unsubscribe ES_USUB
Table 28 Assembler Calls: Queue Browser
Function Assembler Call
tibemsQueueBrowser_Close EQB_CLO
tibemsQueueBrowser_GetMsgSelector EQB_GMS
tibemsQueueBrowser_GetNext EQB_GN
Table 27 Assembler Calls: Session
Function Assembler Call
TIBCO EMS Client for z/OS (MVS) Installation and Reference
58 | Appendix C Assembler Calls for C Functions
tibemsQueueBrowser_GetQueue EQB_GQ
Table 29 Assembler Calls: Name Server Lookup
Function Assembler Call
tibemsLookupContext_Create ELC_CR
tibemsLookupContext_CreateSSL ELC_CSSL
tibemsLookupContext_CreateExternal ELC_CREX
tibemsLookupContext_Destroy ELC_DSY
tibemsLookupContext_Lookup ELC_LUP
tibemsLookupParams_Create ELP_CR
tibemsLookupParams_Destroy ELP_DSY
tibemsLookupParams_GetLdapServerUrl ELP_GSU
tibemsLookupParams_SetLdapBaseDN ELP_SBDN
tibemsLookupParams_SetLdapCAFile ELP_SCAF
tibemsLookupParams_SetLdapCAPath ELP_SCAP
tibemsLookupParams_SetLdapCertFile ELP_SCF
tibemsLookupParams_SetLdapCiphers ELP_SCIP
tibemsLookupParams_SetLdapConnType ELP_SCT
tibemsLookupParams_SetLdapCredential ELP_SCD
tibemsLookupParams_SetLdapKeyFile ELP_SKF
tibemsLookupParams_SetLdapPrincipal ELP_SPR
tibemsLookupParams_SetLdapRandFile ELP_SRF
tibemsLookupParams_SetLdapSearchScope ELP_SSS
Table 28 Assembler Calls: Queue Browser
Function Assembler Call
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Assembler Calls for C Functions | 59
tibemsLookupParams_SetLdapServerUrl ELP_SSU
Table 30 Assembler Calls: XA External Transaction Manager
Function Assembler Call
tibemsXAConnection_Close EXC_CLO
tibemsXAConnection_Create EXC_CR
tibemsXAConnection_CreateSSL EXC_CSSL
tibemsXAConnection_CreateXASession EXC_CXAS
tibemsXAConnection_Get EXC_GET
tibemsXAConnection_GetXASession EXC_GXAS
tibemsXAResource_Commit EXR_COM
tibemsXAResource_End EXR_END
tibemsXAResource_Forget EXR_FGET
tibemsXAResource_GetRMID EXR_GRMI
tibemsXAResource_GetTransactionTimeout EXR_GTT
tibemsXAResource_isSameRM EXR_ISRM
tibemsXAResource_Prepare EXR_PREP
tibemsXAResource_Recover EXR_RECV
tibemsXAResource_Rollback EXR_ROLL
tibemsXAResource_SetRMID EXR_SRMI
tibemsXAResource_SetTransactionTimeout EXR_STT
tibemsXAResource_Start EXR_STA
tibemsXASession_Close EXS_CLO
Table 29 Assembler Calls: Name Server Lookup
Function Assembler Call
TIBCO EMS Client for z/OS (MVS) Installation and Reference
60 | Appendix C Assembler Calls for C Functions
tibemsXASession_GetSession EXS_GS
tibemsXASession_GetXAResource EXS_GXAR
Table 31 Assembler Calls: Utilities
Function Assembler Call
tibems_Close E_CLO
tibems_GetAllowCloseInCallback E_GACIC
tibems_GetConnectAttemptCount E_GCTC
tibems_GetConnectAttemptDelay E_GCAD
tibems_GetConnectAttemptTimeout E_GCAT
tibems_GetExceptionOnFTSwitch E_GEOFT
tibems_GetReconnectAttemptCount E_GRAC
tibems_GetReconnectAttemptDelay E_GRAD
tibems_GetReconnectAttemptTimeout E_GRAT
tibems_GetSocketReceiveBufferSize E_GSRBZ
tibems_GetSocketSendBufferSize E_GSSBZ
tibems_Open E_OPN
tibems_SetAllowCloseInCallback E_SACIC
tibems_SetConnectAttemptCount E_SCAC
tibems_SetConnectAttemptDelay E_SCAD
tibems_SetConnectAttemptTimeout E_SCAT
tibems_SetExceptionOnFTSwitch E_SEOFT
tibems_SetReconnectAttemptCount E_SRAC
Table 30 Assembler Calls: XA External Transaction Manager
Function Assembler Call
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Assembler Calls for C Functions | 61
tibems_SetReconnectAttemptDelay E_SRAD
tibems_SetReconnectAttemptTimeout E_SRAT
tibems_SetSocketReceiveBufferSize E_SSRBZ
tibems_SetSoketSendBufferSize E_SSSBZ
tibems_SetTraceFile E_STF
tibems_Sleep E_SLEEP
tibems_Version E_VER
Table 32 Assembler Calls: Admin
Function Assembler Call
tibemsAdmin
tibemsAdmin_Close EA_CLOSE
tibemsAdmin_Create EA_CREAT
tibemsAdmin_GetCommandTimeout EA_GCTO
tibemsAdmin_GetConsumer EA_GCON
tibemsAdmin_GetConsumers EA_GCONS
tibemsAdmin_GetInfo EA_GINFO
tibemsAdmin_GetProducerStatistics EA_GPST
tibemsAdmin_GetQueue EA_GETQ
tibemsAdmin_GetQueues EA_GETQS
tibemsAdmin_GetTopic EA_GETT
tibemsAdmin_GetTopics EA_GETTS
tibemsAdmin_SetCommandTimeout EA_SCTO
Table 31 Assembler Calls: Utilities
Function Assembler Call
TIBCO EMS Client for z/OS (MVS) Installation and Reference
62 | Appendix C Assembler Calls for C Functions
tibemsAdmin_SetExceptionListener EA_SETXL
tibemsCollection
tibemsCollection_Destroy EA_CDEST
tibemsCollection_GetCount EA_CGC
tibemsCollection_GetFirst EA_CGF
tibemsCollection_GetNext EA_CGN
tibemsConsumerInfo
tibemsConsumerInfo_Destroy EA_CID
tibemsConsumerInfo_GetCreateTime EA_CIGCT
tibemsConsumerInfo_GetCurrentMsgCountSentByServer EA_CGCBS
tibemsConsumerInfo_GetCurrentMsgSizeSentByServer EA_CGMSS
tibemsConsumerInfo_GetDestinationName EA_CIGN
tibemsConsumerInfo_GetDestinationType EA_CIGDT
tibemsConsumerInfo_GetDetailedStatistics EA_CIGDS
tibemsConsumerInfo_GetDurableName EA_CIGDN
tibemsConsumerInfo_GetElapsedSinceLastAcknowledged
EA_CESLA
tibemsConsumerInfo_GetElapsedSinceLastSent EA_CGESL
tibemsConsumerInfo_GetID EA_CIGID
tibemsConsumerInfo_GetPendingMessageCount EA_CIPMC
tibemsConsumerInfo_GetPendingMessageSize EA_CIPMS
tibemsConsumerInfo_GetStatistics EA_CIGS
tibemsConsumerInfo_GetTotalAcknowledgedCount EA_CGTAC
Table 32 Assembler Calls: Admin
Function Assembler Call
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Assembler Calls for C Functions | 63
tibemsConsumerInfo_GetTotalMsgCountSentByServer EA_CGTCS
tibemsConsumerInfo_IsActive EA_CIIA
tibemsConsumerInfo_IsConnected EA_CIIC
tibemsConsumerInfo_IsConnectionConsumer EA_CIICC
tibemsDetailedDestStat
tibemsDetailedDestStat_GetDestinationName EA_DSGDN
tibemsDetailedDestStat_GetDestinationType EA_DSGDT
tibemsDetailedDestStat_GetStatData EA_DSGSD
tibemsProducerInfo
tibemsProducerInfo_Destroy EA_PDEST
tibemsProducerInfo_GetCreateTime EA_PGCT
tibemsProducerInfo_GetDestinationName EA_PGDN
tibemsProducerInfo_GetDestinationType EA_PGDT
tibemsProducerInfo_GetDetailedStatistics EA_PGDS
tibemsProducerInfo_GetID EA_PGID
tibemsProducerInfo_GetStatistics EA_PGS
tibemsQueueInfo
tibemsQueueInfo_Create EQI_CR
tibemsQueueInfo_Destroy EA_QIDES
tibemsQueueInfo_GetDeliveredMessageCount EA_QIGDC
tibemsQueueInfo_GetFlowControlMaxBytes EA_QIFMB
tibemsQueueInfo_GetInboundStatistics EA_QIGIS
tibemsQueueInfo_GetMaxBytes EA_QIGMB
Table 32 Assembler Calls: Admin
Function Assembler Call
TIBCO EMS Client for z/OS (MVS) Installation and Reference
64 | Appendix C Assembler Calls for C Functions
tibemsQueueInfo_GetMaxMsgs EA_QIGMM
tibemsQueueInfo_GetName EA_QIGN
tibemsQueueInfo_GetOutboundStatistics EA_QIGOS
tibemsQueueInfo_GetOverflowPolicy EA_QIGOP
tibemsQueueInfo_GetPendingMessageCount EA_QIGPC
tibemsQueueInfo_GetPendingMessageSize EA_QIGPS
tibemsQueueInfo_GetReceiverCount EA_QIGRC
tibemsServerInfo
tibemsServerInfo_Destroy EA_SID
tibemsServerInfo_GetConsumerCount EA_SIGCC
tibemsServerInfo_GetProducerCount EA_SIGPC
tibemsServerInfo_GetQueueCount EA_SIGQC
tibemsServerInfo_GetTopicCount EA_SIGTC
tibemsStatData
tibemsStatData_GetByteRate EA_SDGBR
tibemsStatData_GetMessageRate EA_SDMR
tibemsStatData_GetTotalBytes EA_SDGTB
tibemsStatData_GetTotalMessages EA_SDGTM
Table 32 Assembler Calls: Admin
Function Assembler Call
TIBCO EMS Client for z/OS (MVS) Installation and Reference
Assembler Calls for C Functions | 65
tibemsTopicInfo
tibemsTopicInfo_Create ETI_CR
tibemsTopicInfo_Destroy EA_TIDES
tibemsTopicInfo_GetActiveDurableCount EA_TGADC
tibemsTopicInfo_GetDurableCount EA_TIGDC
tibemsTopicInfo_GetFlowControlMaxBytes EA_TIFMB
tibemsTopicInfo_GetInboundStatistics EA_TIGIS
tibemsTopicInfo_GetMaxBytes EA_TIGMB
tibemsTopicInfo_GetMaxMsgs EA_TIGMM
tibemsTopicInfo_GetName EA_TIGN
tibemsTopicInfo_GetOutboundStatistics EA_TIGOS
tibemsTopicInfo_GetOverflowPolicy EA_TIGOP
tibemsTopicInfo_GetPendingMessageCount EA_TIGPC
tibemsTopicInfo_GetPendingMessageSize EA_TIGPS
tibemsTopicInfo_GetSubscriberCount EA_TIGSC
Table 33 Assembler Calls: Exception
Function Assembler Call
tibemsStatus_GetText EST_GTXT
tibemsErrorContext_Create ERC_CR
tibemsErrorContext_Close ERC_CLO
tibemsErrorContext_GetLastErrorString ERC_GLES
tibemsErrorContext_GetLastErrorStackTrace ERC_GLET
Table 32 Assembler Calls: Admin
Function Assembler Call
TIBCO EMS Client for z/OS (MVS) Installation and Reference
66 | Appendix C Assembler Calls for C Functions
TIBCO EMS Client for z/OS (MVS) Installation and Reference