CA IDMS™ 19.0 Web Services for Modernization

World®
’16
CA IDMS™ 19.0
Web Services for Modernization
David Ross, Sr. Principal Product Owner
CA Technologies
MFX102S
MAINFRAME AND WORKLOAD AUTOMATION

2 © 2016 CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD
© 2016 CA. All rights reserved. All trademarks referenced herein belong to their respective companies.
The content provided in this CA World 2016 presentation is intended for informational purposes only and does not form any type of
warranty. The information provided by a CA partner and/or CA customer has not been reviewed for accuracy by CA.
For Informational Purposes Only
Terms of this Presentation

Abstract
CA IDMS™ Web Services enable users to leverage and
extend their investment in CA IDMS by providing callable
services that CA IDMS applications can use to consume
and provide Web Services directly from a CA IDMS
system.
David Ross
CA Technologies
Sr. Principal Product
Owner, CA IDMS

Agenda
LEVERAGING YOUR INVESTMENT WITH WEB SERVICES
CA IDMS WEB SERVICES
XML GENERATION AND PARSING
WEB SERVICES EXAMPLE PROGRAMS
1
2
3
4

CA IDMS Applications
Then…
Batch
ENTER NEXT TASK:
CA IDMS/DC
CA IDMS/DB

Apps Everywhere

CA IDMS Applications
Now…
CA IDMS data
and logic
Apps

How do you maximize business value?
Large investment in legacy
applications
••Costly and risky conversion
••Hard to find legacy skills
Leverage and Extend
••Leverage investment, reduce cost
••Preserve applications, reduce risk
••Use current developer skills

Leveraging and Extending CA IDMS
••Keep your database in place
••Access from web services
••Use standard interfaces
Leverage
CA IDMS
databases
••Reuse your application
business logic
••Invoke web services
••Provide web services
Extend
CA IDMS
applications

The CA IDMS Application Server
CA
IDMS
SQL
ODBC
JDBC
Web
Services
TCP/IP

What are web services?
§ Remote procedure calls
§ Support business processes
§ Invoked by a program
§ Loosely coupled for interoperability
§ Combine to build applications
§ Invoked using SOAP, XML, REST, JSON

Web Services Roles
§ Consumer
– Calling program
– Invokes service
§ Provider
– Called program
– Implements service

Web Services Terminology
§ SOAP: Simple Object Access Protocol
§ WSDL: Web Services Definition Language
§ XML: eXtensible Markup Language
§ REST: Representational State Transfer
§ JSON: Java Simple Object Notation
§ HTTP: Hyper Text Transfer Protocol
– Alternatives JMS, MQ…

CA IDMS Web Services

§ Web Service Consumer
§ Web Service Provider
§ Web Services API

CA IDMS CV
CA IDMS
Application Program
CA IDMS
Web Services
XML
Request
XML
Reply
Web Service
Implementation
SOAP
Request
SOAP
Reply
App Server
Database or
Application Code
CA IDMS as a Web Service Consumer

CA IDMS as a Web Service Provider
Application
CA IDMS CV
SOAP
Request
SOAP
Reply
Web Service
Consumer
CA IDMS
Application Program
CA IDMS
Web Services
XML
Request
XML
Reply

The CA IDMS Web Services API

Web Services API
§ Well defined, extendable interface
– Simplifies application development
– Isolate user code from product changes
– Provide consistent base for product enhancement
§ CA IDMS Callable Service
– COBOL, ADS, PL/1, Assembler
§ WS API Functions
– Data transfer
– Session management
– Option management

Web Services API Functions
Function Code Description Consumer Provider
4 INITIALIZE X X
8 SETOPTION X X
12 GETOPTION X X
16 REQUEST X
20 SEND X
24 RECEIVE X
28 RELEASE X X

Web Services Options
Number Option Name Description
1 LOG-SERVICES Enable and disable logging
2 LOG-PROGRAM Log a specific program
3 REQUIRE-SIGNON Enforce security
4 CHECK-AUTH Require user to be a member of the
services security group
5 CONNECT-TIMEOUT Specify wait time for external services
6 READ-WRITE-TIMEOUT Specify socket wait time
7 XML-CODE-PAGE Set XML code page

Using the Web Services API
Consumer Provider
Operation API Function Operation API Function
Initialize
Environment
WSINITIALIZE Initialize
Environment
WSINITIALIZE
Manage Options WSGETOPTION
WSSETOPTION
Manage Options WSGETOPTION
WSSETOPTION
Send Request
and…
WSREQUEST Receive Request WSRECEIVE
Receive Response Send XML Response WSSEND
Free Resources WSRELEASE Free Resources WSRELEASE

Application Program
(Consumer)
Application Program
(Provider)
IDMSWSSC
(Service Consumer)
IDMSWSI
(Web Services Stub)
IDMSWSRM
(Request Manager)
IDMSWSSP
(Service Provider)
IDMS TCP/IP
Driver
IDMSWSSS
(SOAP Server)
Web Services
API
CA IDMS Web Services Internal Architecture
WSRequest()
WSInitialize()
WSGetOption()
WSSetOption()
WSRelease()
WSReceive()
WSSend()

Calling the Web Services API
CALL 'IDMSWSI' USING
function,
return-code,
error-info,
function-dependent-parameters,
. . .
COBOL
LINK TO PROGRAM ‘IDMSWSI' USING
function,
return-code,
error-info,
function-dependent-parameter1,
. . .
ADS

Web Services API Return Codes
Return Code Severity Description
0 Success Request processed successfully
4 Warning Request processed, warning
message returned
8 Error Request failed, error message
returned
12 Terminated Request failed, service terminated
16 System Error Request failed, all services
terminated

Web Services API Error Information
Error Type Error Text
A API Failure to adhere to Web Services API protocol
X XML Generated if XML Parsing or Generation fails
H HTTP API receives an unexpected HTTP status code
T TCPIP An unexpected TCPIP code received
S SOAP An unexpected SOAP fault code received
I INTERNAL Failures in CA IDMS/DC operations
O OTHER An unclassified error occurred

Web Services API – INITIALIZE (4)
§ Allocate and initialize services resources
§ Used when consuming an external web service
§ Parameters
– WS-INITIALIZE
– return-code
– error-info
– request-handle
– interface-version.

Web Services API – SETOPTION (8)
§ Set an option
§ Overrides default value
§ Parameters
– WS-GETOPTION,
– return-code,
– error-info,
– request-handle,
– option-number,
– option-value.

Web Services API – GETOPTION (12)
§ Gets the current value for an option
§ Parameters
– WS-GETOPTION,
– return-code,
– error-info,
– request-handle,
– option-number,
– option-value.

Web Services API – REQUEST (16)
§ Send service request to the provider
§ Parameters
– WS-REQUEST
– return-code
– error-info
– request-handle
– request-info
– request-message-data
– response-message-data

Web Services API – SEND (20)
§ Send service response to the consumer
§ Parameters
– WS-SEND
– return-code
– error-info
– request-handle
– response-message-data

Web Services API – RECEIVE (24)
§ Receive service request from consumer
§ Parameters
– WS-RECEIVE
– return-code
– error-info
– request-handle
– request-message-data

Web Services API – RELEASE (28)
§ Frees all resources allocated to service the Web Services request
§ Parameters
– WS-RELEASE
– return-code
– error-info
– request-handle

XML Generation and Parsing

XML Message Contents
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/
"
<soap:Body>
<IDMSWSPIOperation
xmlns=“http://www.IDMSWSPI.Request.com">
<InputFields>
<EmplID>0472</EmplID>
<dbname>EMPDEMO</dbname>
</InputFields>
</IDMSWSPIOperation>
</soap:Body>
</soap:Envelope>

XML Generation and Parsing
§ XML Generation
– Uses input variables to create an XML Message
– Final message includes your data as the payload
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body><IDMSWSPIOperation xmlns="http://www.IDMSWSPI.Request.com">
<InputFields>
<EmplID>0472</EmplID>
<dbname>EMPDEMO</dbname>
</InputFields>
</IDMSWSPIOperation></soap:Body>
</soap:Envelope>
§ XML Parsing
– Extracts the payload from a given XML message
– Payload is interpreted as individual variables for use Web services
§ Two main approaches: use of IBM’s COBOL functions or use of built-in SQL/XML functions
EmplID: 0472
dbname: EMPDEMO
EmplID: 0472
dbname: EMPDEMO
Input
Output

Use of SQL/XML Functions for XML Generation
0000-MAINLINE-BEG.
EXEC SQL
set :DOC=
xmlserialize(content
xmlelement(name "soapenv:Envelope“
, xmlnamespaces(
'http://schemas.xmlsoap.org/soap/envelope/‘
as "soapenv“
, default 'HTTP://CA.COM/HR/GLOBALXML'),
, xmlelement(name "soapenv:Header")
, xmlelement(name "soapenv:Body“
, xmlelement(name “IDMSWSPIOperation“
, xmlnamespaces(‘http://www.IDMSWSPI.Request.com’
, xmlconcat(xmlelement(name “InputFields”
, xmlconcat(xmlelement(name “EmplID”, :EMPLID)
xmlelement(name “dbname”, :DBNAME)
)))))) as char(1000))
END-EXEC.
01 DOC PIC X(1000) VALUE SPACES.
COBOL paragraph name Example of generation of an
XML message
01 EMPLID PIC X(4).
01 DBNAME PIC X(8).

XML GENERATE
§ Generates XML document from COBOL data structure
§ Use to return CA IDMS data in XML format
§ XML GENERATE introduced in COBOL for z/OS V3R3
– Also supported for PL/1
§ Compile with XMLSS to use z/OS XML system services parser

COBOL XML Generate Example

COBOL XML Parse
XML string
COBOL PARSE XML string
Evaluate the data tags and populate data into COBOL data structure
Results in:
WS-EMP-ID = 0472

Web Services Example Programs

Web Services Sample Programs

Invoking the Consumer Sample
Task Code ‘IDMSWSDM’

Provider Sample Response

Request API Example
§ To send a Service Request for the Consumer, the ADS dialog uses the
Web Service Request API

Web Services Documentation and Training

https://docops.ca.com/idms

Using Web Services

Web Services API Reference

CA IDMS Web Services Education and Training
§ CA IDMS Web Services 19.0 Introduction
§ Web based training (WBT)
§ education.ca.com

Samples and Doc
Sample programs,
documentation, and web based
training help you get started
with CA IDMS Web Services.
Leverage CA IDMS
CA IDMS Web Services enable
you to leverage and extend
your investment in CA IDMS.
Web Services API
provides an API for CA IDMS
applications to consume and
provide web services.
Summary

Recommended Sessions
SESSION # TITLE DATE/TIME
MFX100S Strategy and Vision for CA IDMS 11/16/2016 at 12:45 pm
MFX101S Legacy is not a Dirty Word 11/16/2016 at 1:45 pm
MFX102S CA IDMS 19.0 Web Services for Modernization 11/16/2016 at 3:00 pm
MFX103S CA IDMS 19.0 SQL Enhancements for Modernization 11/16/2016 at 3:30 pm
MFX104S Java Access to CA-IDMS Data at BT (British Telecom) 11/16/2016 at 4:45 pm
MFX105S
Implementation and Use of Generic VTAM Resources
with Parallel SYSPLEX Features (CA and CAXIA)
11/17/2016 at 12:45 pm
MFX106S CA IDMS Buffer Tuning 11/17/2016 at 1:45 pm
MFX107S M3A Services Monitor, Measure, Manage and Alert 11/17/2016 at 3:00 pm
MFX108S Birds of a Feather/Stump the Techie! 11/17/2016 at 3:45 pm

Must See Demos
Demo Name
Product X
Theater # location
Demo Name
Services Y
Theater # location
Demo Name
Solution Y
Theater # location
Demo Name
Product X
Theater # location

Questions?

Stay connected at communities.ca.com
Thank you.

CA IDMS™ 19.0 Web Services for Modernization

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Viewers also liked

Viewers also liked (7)

Similar to CA IDMS™ 19.0 Web Services for Modernization

Similar to CA IDMS™ 19.0 Web Services for Modernization (20)

More from CA Technologies

More from CA Technologies (20)

Recently uploaded

Recently uploaded (20)

CA IDMS™ 19.0 Web Services for Modernization