Application Programming Guide

CallPath®/CICS® for OS/390®
Application Programming Guide
Version 2, Release 1
5655-B34
Document Number SC34-5393-01
| Note! |
|---|
|
Before using this information and the product it supports, be sure to
read the general information under "Notices".
|
| Note! |
|---|
|
Text with yellow background indicates features available only after application of
CallPath PTF UU07340.
|
Second edition (June 2000)
This edition applies to
IBM
CallPath®/CICS® for OS/390®, Version 2 Release 1 (program number 5655-B34),
and to any subsequent releases and modifications until otherwise
indicated in new editions.
This edition replaces SC34-5393-00.
Order publications through your IBM representative,
they are not stocked at the address given below.
You can make comments on this book by sending an e-mail to
idrcf@hursley.ibm.com.
Alternatively you can mail your comments to:
IBM United Kingdom Laboratories,
User Technologies,
Mail Point 095,
Hursley Park,
Winchester,
Hampshire,
SO21 2JN
United Kingdom
When you send information to IBM,
you grant IBM a nonexclusive
right to use or distribute the information in any way it believes
appropriate without incurring any obligation to you.
© Copyright International Business Machines Corporation 1991, 2000. All rights reserved.
Note to U.S. government Users -- Documentation related to restricted rights -- Use, duplication or disclosure is subject to restrictions set forth in GSA ADP Schedule Contract with IBM Corp.
Part 1. Introduction
Chapter 1. CallPath/CICS Terms and Concepts
Conventions Used in this Book
Approval of Applications
Computer-Switch Communication
Model of a Telephone Call
Connection IDs
Telephone Connection States and Transitions
Program Calls
Program Identification
Program Versioning
Call Profile Characteristics
Monitoring Call Activity
Composition of Directory Numbers
Operating Environment
Notification to an Application of Problems with a Request
Combining CallPath/CICS Program Calls with Telephone Activity
Functional Support by Different Switches
Part 2. Designing Applications
Chapter 2. Example Message Flows
Introduction
Examples in Application Mode
Examples in Handset Mode
Chapter 3. Sample Application Programs
Installation Procedure
Components of the Sample System
How to Use the Sample System
Part 3. Compiling and Testing Applications
Chapter 4. Compiling Application Programs
Chapter 5. Testing Applications Using the Switch Simulator
Simulation Mode
Getting Started
Planning the Order of Work
Creating and Using a Test Switch ID
Loading Messages
Starting the Administration Subsystem
Returning Messages to the Application
Starting a Switch in Simulation Mode
Changing the Type of Response
Stopping a Simulated Switch
Problem Determination Checklist
Function Keys and Summary of Help
Chapter 6. Problem Determination
General Program Debugging
Symptoms
Part 4. Reference Information
Chapter 7. Introduction to the Reference Section
Program calls
Chapter 8. CallPath/CICS Program Calls
Add_Party (STLADDP)
Alternate_Call (STLALTR)
Answer_Call (STLANSR)
Conference_Call (STLCONF)
Delete_Call_Profile (STLDEL)
Disconnect (STLDISC)
Extend_Call (STLXTND)
Hold_Call (STLHOLD)
Identify_Program_Name (STLIDEN)
Identify_Program_Version (STLIPGV)
Immediate_Transfer (STLIMMT)
Initialize_Call_Profile (STLINIT)
Invoke_Feature (STLINVK)
Make_Call (STLMAKE)
Monitor (STLMON)
Monitor CDR (STLMONC)
Monitor_System_Messages (STLMONS)
Provide_Call_Action (STLPCA)
Query_Party_Status (STLQPS)
Receive (STLRCV)
Redirect_Call (STLRED)
Register_Ownership (STLREG)
Reject_Call (STLREJ)
Release_Program_Name (STLREL)
Retrieve_Call (STLRETR)
Return_Control (STLRTNC)
Send_Device_Data (STLSEDD)
Transfer_Call (STLTRAN)
Trigger (STLTRGR)
Chapter 9. Set Program Calls
Set_Add_Party_Direction (STLSAPD)
Set_Automatic_Answer (STLSAA)
Set_Call_Action_Option(STLSCAO)
Set_Billed_Party (STLSBP)
Set_Called_Party_Alerting_Time (STLSCDA)
Set_Call_Type (STLSCT)
Set_Destination_Detect_Action (STLSDDA)
Set_Disconnect_Execution_Option (STLSDEO)
Set_Extend_Purpose (STLSEP)
Set_Held_Call_Connection (STLSHCC)
Set_Held_Call_Recording (STLSHCR)
Set_Holding_Party_Callback (STLSHPB)
Set_Holding_Party_Calling (STLSHPC)
Set_Make_Call_DND_Override (STLSMCD)
Set_Make_Call_Forward_Override (STLSMCF)
Set_Make_Call_Notification (STLSMCN)
Set_Make_Call_Party_Order (STLSMCP)
Set_Monitor_Tracking (STLSMT)
Set_Party_Specification (STLSPS)
Set_Remaining_Parties_Option (STLSRPO)
Set_Return_Response (STLSRR)
Chapter 10. Message Formats and Codes
Message Syntax
How to Use the Message Formats
Summary of Messages
Call_Action_Provided
Call_Alerting
Call_Alternated
Call_Conferenced
Call_Connected
Call_Held
Call_Parked
Call_Picked
Call_Rejected
Call_Routed
Call_Transferred
CDR Message
Data_Collected
Disconnected
Feature_Invoked
Network_Reached
Party_Status
Request_Instruction
Response
Setup
Switch_Status
Structures
Advanced_Party_Structure
Data_Element_Structure
Data_Format_List_Structure
Party_Structure
Time_And_Date
Status_Structure
Chapter 11. Call Action Formats and Codes
Summary of Call Action Codes
"Billing Change" Call Action
"Default" Call Action Format
"Listen Path Blocking" Call Action Format
"Music" Call Action Format
"Ringback" Call Action Format
"Switch Specific" Call Action Format
Chapter 12. Feature Formats and Codes
Feature Data Syntax
Summary of Feature Codes
"Account Code" Feature Format
"Advanced Agent Activity" Feature Format
"Agent Activity" Feature Format
"Call Waiting" Feature Format
"Camp for Callback" Feature
"Class of Service" Feature
"Do Not Disturb" Feature Format
"Forward" Feature Format
"Mute" Feature
"Party Information" Feature
"Speaker" Feature
"Switch Specific" Feature
Chapter 13. Trigger Program Call Formats and Codes
Trigger Program Call Action Syntax
Summary of Trigger Program Call Codes
Make_Call Action Data Format
Request_Instruction Action Data Format
Chapter 14. Variables and Characteristics
Pseudonyms and Integer Values
Character Sets
Variable Types
Chapter 15. Return Codes
Chapter 16. T-Server Functions
Part 5. Glossary and Index
Glossary
Index
