Pre-Con Ed: Beyond the AE CLI - Leveraging CA Workload Automation AE Web Services

World®
’16
Beyond the AE CLI - Leveraging CA
Workload Automation AE Web Services
Lee Roberson / Senior Principal Consultant / CA Technologies
MFX20E
MAINFRAME

1 © 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
Learn how you can integrate with CA Workload Automation (CA WA) AE via
lightweight, scalable and maintainable CA WA AE Web Services. This session
will provide:
• Overview of the CA WA AE Web Services REST architecture
• Security Implementation
• Provide example job monitoring and control use cases such as retrieving
job statuses, and performing job actions through the CA WA AE Web
Services
• Introduction to the CA WA REST Client that can be used by any CA
Scheduling engine to call RESTful Web Service operations
• A demonstration of calling CA AE Web Services with the CA WA REST Client
Lee Roberson
Senior Principal
Consultant, CA
Technologies

Agenda
INTRODUCTION TO CA WA AE REST WEB SERVICES
CA WA AE WEB SERVICES ARCHITECTURE
CA WORKLOAD AUTOMATION REST CLIENT
IMPLEMENTATION
SUPPORTED RESTFUL REQUESTS
SECURITY IMPLEMENTATION
1
2
3
4
5
6
DEMO EXAMPLES AND TROUBLESHOOTING7

APIs – The Sharp-end of the Application Economy
“Today, a firm without application program interfaces (APIs) … is like the internet without the
World Wide Web.”
“In a modern enterprise, you must be able to use both internal and
external APIs in a reliable, secure and scalable manner”
10,000+
Publically listed API’s
50%
B2B collaboration through
APIs by 2017
$750M
Amazon business lost if
latency increases by 100ms

WA AE Web ServicesJava API C++ APICLIs / DB Access
RESTful Light-weight AE SDK AE SDKAE Client Utilities
Introduced in 11.3.5Introduced in 11.0Traditional Approach
CA WA AE Programmatic Interfaces
Introduced in 11.0

CA Workload Automation AE APIs
Programmatic Interfaces and APIs to define, monitor and control
workload management and batch scheduling
Light-weight modern REST Web Service API
Provides job monitoring and job control
interfaces
Uses standard HTTP GET/POST requests
Perform tasks such as retrieving a job status and
performing job actions
Ready-to-use programmatic interface to
CA Workload Automation AE
Uses JNI to interface with the same native
code Client libraries
Provides job actions, status retrieval and
object administration (create, update,
delete
C++ SDK Client Applications interface with
the Unicenter AutoSys JM Client libraries
Libraries use proprietary
Request/Response Protocol (RRP) to
communicate with Application Server
AE Web Services Java SDK C++ SDK

CA WA AE Web Services
§ New REST Web Services interface
§ First introduced in CA WA AE 11.3.5
§ Provides job monitoring and management interfaces:
– Retrieve (limited) job attributes, runtime data, dependencies, and
relationships
– Send event
§ Start, restart, cancel, on/off hold, on/off ice, on/off no_exec, force start
– Manage resources and global variables
– Reply to job outstanding response
7

CA WA AE Web Services
§ Full security/policy support
– New policies to grant access to web services added
§ Auditing (accessible via autotrack)
§ Installed with AS and Scheduler installation options
§ Includes a new web services programming guide
§ Will continue to be extended and enhanced in future releases
8

CA WA AE Web Services – Key Capabilities
§ Alternative to CA WA AE Client Utilities (CLI), direct
database access or CA WA AE SDK (Java, C++)
§ Light-weight as opposed to C++ and Java APIs (SDK)
§ Exposes key CA WA AE operational management and
monitoring functions including:
– Manage Jobs, Machines, Global Variables, Connection Profiles
§ Does not provide job administration / creation
9

CA WA AE REST Web Services – Key Benefits
§ Light-weight modern REST Web Services
§ Abstraction from other methods employed in the past like
directly access the CA WA AE database
§ Insulates you from database schema changes
§ Retrieve Information on objects (Jobs status, job
dependencies, global variables, machines, connection profiles
§ Object Controls (Control Jobs, Machines, Global variables)

CA WA AE Web Services Architecture
Web
Services
Consumer
Apache
Tomcat
Web
Server
Scheduler
Application
Server
System
Agent
RDBMS
System
AgentSystem
Agent
EEM
5520
8443
7507
7520
7500
7520
JDBC port
§ A web services transaction interfaces
with the following components:
– CA WA AE Web server (Apache Tomcat)
§ host web services
– RDBMS (database)
§ access to CA WA AE database is enabled as
a RESTful web service
§ Entities are queried, created, and modified
using HTTP methods such as GET and POST
– CA EEM (security)
§ Session authentication in web services is
secured using CA EEM

AE Web Server (Apache Tomcat)
AE Event Server (RDBMS)
CA EEM (Security)
CA WA AE Instance
§ Used to host the Web Services
§ Installed and configured as part of the CA WA AE install
§ Web Services uses port 9443 to communicate with Tomcat
§ Tomcat server uses port 5520 to communicate with CA EEM
§ Access to the CA WA AE database enabled as a RESTful web
service
§ Entities are queried, created, and modified using HTTP
methods such as GET and POST
§ Sharing same CA EEM
§ Requires external EEM security configured (Native AE
security not supported)
CA WA AE Web Services Components
§ Session authentication in web services secured using CA EEM
§ ensures transactions security by providing identity
authentication, authorization, and access mgmt. services
§ Access controlled by Local EEM Application Group

CA WA AE Web Services - Implementation
§ RESTful style, using the CA guidelines
§ Document exchange in JSON or XML formats
§ Standard HTTP GET/POST requests
§ Standard HTTP return codes
§ Requires EEM (Native Security not supported)
§ Authentication with EEM
§ Authorization with EEM security polices
13

CA WA AE Web Server Install Option
14

CA WA AE Web Server Services – (Windows)
15

CA WA AE Web Server – UNIX/Linux
§ CA WA AE Web Server Status:
§ Start CA WA AE Web Server:
§ Stop CA WA AE Web Server:
16

Authentication
§ Security of web services transaction implemented using HTTPS
§ Authentication performed using Tomcat JavaTM Authentication and Authorization Service (JAAS) realm with EEM
security
§ Requires EEM (Native Security not supported)
§ CA EEM-specific JAAS Login Module authenticates login credentials uses BASIC authentication over SSL
§ Access controlled by Local EEM Application Group called WorkloadAutomationAEWebService
§ User MUST belong to this group
Authorization
§ Authorization checks performed based on authenticated user ID and existing EEM WAAE policies
CA WAAE Web Services – Security

CA WA AE Web Services Security - Authentication
18
security of a web services
transaction is implemented
using a HTTPS connection,
which is HTTP basic
authentication over a
Secure Sockets Layer (SSL)
connection

CA WA AE Web Services Security - Authorization
19

Authentication over Secure Socket Layer (SSL) Connection
Must have SSL connection to secure login credentials
§ Two Options:
– Use a Self Signed Certificate
§ Cannot be revoked if compromised / do not provide an acceptable security
level
§ can use self-signed certificates for testing and non-commercial
environments
– Use a Trusted Certificate issued from a Trusted Certificate Authority
§ Can be revoked if compromised
§ Recommended for production environments

Generate and use a self-signed certificate
§ Generate a Private Key and Self-Signed Certificate
– Remove previous key from the keystore
– keytool -delete -alias tomcat -keystore $AUTOUSER/webserver/conf/.keystore -storepass changeit
– Generate a new key
– keytool -delete tomcat -keyalg RSA –keystore $AUTOUSER/webserver/conf/.keystore
– -storepass changeit -keypass changeit -keysize 1024 -dname "cn=SERVER_NAME" -validity 14600
§ Restart the Web Server service
– unicntrl restart waae_webserver.$AUTOSERV

Request and use a Trusted certificate
§ Generate a Private Key and Self-Signed Certificate
– Remove previous key from the keystore
– keytool -delete -alias tomcat -keystore $AUTOUSER/webserver/conf/.keystore -storepass changeit
– Generate a new key
– keytool –genkey -alias tomcat -keyalg RSA –keystore $AUTOUSER/webserver/conf/.keystore
– -storepass changeit -keypass changeit -keysize 1024 -dname "cn=SERVER_NAME" -validity 14600
§ Request a Certificate
– Generate a certificate request file (certreq.csr)
– keytool -certreq -alias tomcat -keystore $AUTOUSER/webserver/conf/.keystore
– -storepass changeit –file certreq.csr

Request and use a Trusted certificate
§ Request a Certificate in PEM format
§ Download the Certificate chain
§ Add the Certificates to the Keystore
– keytool -importcert -alias RootCA -file RootCA.cer -keystore
$AUTOUSER/webserver/conf/.keystore -storepass changeit
– keytool -importcert -alias SubCA -file SubCA.cer -keystore
$AUTOUSER/webserver/conf/.keystore -storepass changeit
unicntrl restart waae_webserver.$AUTOSERV

Reuse existing KeyStore File
§ Copy existing KeyStore File
– Copy from existing to new webserver location
– $AUTOUSER/webserver/conf/.keystore

Import existing Private Key and Certificate
§ Import Certificate from Pkcs12
– keytool -importkeystore
– -srckeystore myp12.p12 -srcstoretype PKCS12 -srcstorepass my-password
– -deststorepass changeit -destkeypass changeit
– -destkeystore $AUTOUSER/webserver/conf/.keystore
– -alias 1 -destalias tomcatCopy from existing to new webserver location

Service Directory
§ Web service generates a Web Application Definition Language (WADL) dynamically at runtime
§ WADL is generated in XML format and it provides a machine-readable description of a HTTP-based
web application
§ Web service lets you access either the full WADL, in case of an application, or a single resource
WADL
§ Following Uniform Resource Identifiers (URIs) are available:
– GET /AEWS/application.wadl -- full WADL
– OPTIONS /AEWS/resource -- single resource WADL
26

CA WA AE RESTful Web Services
CA WA AE Web Services use REST
– Resource identification using URI
§ Identifies resource by name, location or both
– Example: http://www.ca.com/NA/Pages/Home.aspx
– Uniform Interface
§ Interact with resources using basic HTTP methods :
– Create (HTTP PUT), Update (HTTP POST), Read (HTTP GET), Delete( HTTP
DELETE), Options (HTTP OPTIONS)
– Self-descriptive
§ Content easily accessed in formats XML, JSON etc
– Stateful interactions through hyperlinks
§ Points to valid future states of the interaction
Standards require that this is
CASE-SENSITIVE. This includes
the URIs as well as the
documents exchanged.

AEWS
event
gvar
job-run-info
job-dependencies
job
job1
job2
job2
job5
job3
job4
var1
application
schema
Full WADL
Resource Retrieval
Resource Control
Schema in detail
CA WA AE Web Services - URI Directory

Sample URI
§ Example resource URI to get a job:
https://WSServer:9443/AEWS/job/sleep1
§ https - secure protocol
§ WSServer - name of the web server host computer
§ 9443 - port number for the web server computer
§ AEWS/job - resource name
§ sleep1 - jobname parameter associated with the resource

CA WA AE Web Service Configuration
§ Log4j.xml
– Contains logging configuration
§ Tomcat-wrapper-license.conf
– License generated for Java Service Wrapper (Tanuki ) 3.5.13 64-bit
§ Wrapper.conf
– License “Tomcat-wrapper-license.conf” included here
§ KeystoreFile
– Contains SSL Java keystore and self signed certificate
– /opt/CA/WorkloadAutomationAE/webserver/apache-tomcat-7.0.22/conf/.keystore

CA WA AE Web Service Configuration
§ Tomcat Server.xml
– Contains connector port and SSL configuration
§ Eiam.ws.config
– Contains EEM information like EEM server, ApplicationInstance, user/pasword etc
§ JAAS logon.conf
– Contains EEM config information
§ Wrapper.conf
– Contains CA WA AE environment details, logon.conf etc
§ NATIVEJDBCJARPATH pointing to SYBASE jconn4.jar (DO NOT USE IT FOR NOW)
§ RUN_AS_USER=autosys (should match what as_server and event_demon run as)

Logging
Implemented using log4j
§ Logging by functionality
— General WS query tracing - com.ca.waae.wsquery
— Configuration - com.ca.waae.aehome
— Database Access - com.ca.waae.dbaccess
— Security - com.ca.waae.security
§ Output file: $AUTOUSER/out/waae-webservices.log
§ Default level is warn
— Suffices with Debug level
§ Changes automatic
— No need to recycle tomcat

Supported RESTful requests
§ Resource retrieval
‒ Supported resources: jobs, job-runs, job-dependencies, gvar
‒ Handled by HTTP GET
‒ Response Formats: XML/JSON
§ Resource control
‒ Supported resources: events to control jobs and gvar
‒ Handled by HTTP POST
‒ Request Formats: XML/JSON
‒ Need to post the data

Job Retrieval
Supported requests
GET AEWS/job method—Retrieve Information of a Single or Multiple Jobs
– URL: https://webserver:port/AEWS/job?parameters
– Example: https://WSServer:8443/AEWS/job?filter=machine==localhost
Parameters:
§ Jobname -Name of the job to retrieve
§ Version=n -Version for the request. Default: current version
§ Locale -User locale. Default: en-US
§ Filter= FilterCriteria Set of expressions using operators.
§ Count=n -Maximum number of records to be
returned
§ startIndex=n -Starting logical page number
§ sortBy=col1[,col2]... -Order to sort the results
Note: Multiple expressions can be linked with either the and (;) and or (|)
boolean operators
Example: application==abc;group=yyy|machine=abc
Operators:
== Match exactly
!= Not an exact match
=@ Match the pattern.
A wildcard can be used.
!@ Not match the pattern.
A wildcard can be used.
< Less than
<= Less than or equal to
> Greater than
>= Greater than or equal to

Job Retrieval
Supported requests
-- request --
GET https://WSServer:8443/AEWS/job?filter=machine==localhost
-- response --
200 OK
Server: Apache-Coyote/1.1
Cache-Control: private
Expires: Wed, 31 Dec 1969 19:00:00 EST
Content-Type: application/xml
Transfer-Encoding: chunked
Content-Encoding: gzip
Vary: Accept-Encoding
Date: Fri, 03 Feb 2012 15:25:12 GMT
<?xml version="1.0" encoding="UTF-8"
standalone="yes"?><jobs>
<job><name>MAINT_CLEAN_AGENT_OUT</name><jobType>CMD</jobType><mac
hine>localhost</machine>
<self rel="self"
href="https://WSServer:8443/AEWS/job/MAINT_CLEAN_AGENT_OUT"/><status>4</status><
/job>
<job><name>MAINT_CLEAN_ARCHIVE</name><jobType>CMD</jobType><machine
>localhost</machine>
<self rel="self"
href="https://WSServer:8443/AEWS/job/MAINT_CLEAN_ARCHIVE"/><status>4</status></jo
b>
<self rel="self"
href="https://WSServer:8443/AEWS/job?filter=machine==localhost"/></jobs>
-- request --
GET https://WSServer:8443/AEWS/job?filter=machine==localhost
-- response --
200 OK
Content-Type: application/json
Date: Fri, 03 Feb 2012 15:32:16 GMT
{"job":[{"name":"MAINT_CLEAN_AGENT_OUT","jobType":"CMD","machine":"localhost",
"self":{"@rel":"self","@href":"https://WSServer:8443/AEWS/job/MAINT_CLEAN_AGENT
_OUT"
},"status":"4"},{"name":"MAINT_CLEAN_ARCHIVE","jobType":"CMD","machine":"localho
st",
"self":{"@rel":"self","@href":"https://WSServer:8443/AEWS/job/MAINT_CLEAN_ARCHIV
E"},
"status":"4"}],"
self":{"@rel":"self","@href":"https://WSServer:8443/AEWS/job?filter=machine==localho
st"}}

Job Retrieval
Supported requests
GET AEWS/job/jobname method—Retrieve Information of a Specific Job
– URL: https://webserver:port/AEWS/job/jobname?parameters
– Example: https://WSServer:8443/AEWS/job/sleep1
-- request --
GET https://WSServer:8443/AEWS/job/sleep1
-- response --
200 OK
Date: Wed, 01 Feb 2012 20:27:01 GMT
<?xml version="1.0" encoding="UTF-8"
standalone="yes"?><job><name>sleep1</name><jobType>CMD</jobType>
<machine>WSServer</machine><self rel="self"
href="https://WSServer:8443/AEWS/job/sleep1"/>
<status>4</status></job>
-- request --
GET https://WSServer:8443/AEWS/job/sleep1
-- response --
200 OK
Date: Wed, 01 Feb 2012 20:27:14 GMT
{"name":"sleep1","jobType":"CMD","machine":"WSServer","self":{"@r
el":"self",“
@href":"https://WSServer:8443/AEWS/job/sleep1"},"status":"4"}
Parameters:
• Jobname
• Version
• locale

Job Retrieval
Supported requests
§ GET AEWS/job-dependencies/jobname method—Retrieve Job
Dependency Information of a Specific Job
– URL: https://webserver:port/AEWS/job-dependencies/jobname?parameters
– Example: https://WSServer:8443/AEWS/job-dependencies/SAPjob
§ GET AEWS/job-run-info/jobname method—Retrieve Job Run
Information of a Specific Job
– URL: https://webserver:port/AEWS/job-run-info/jobname?parameters
– Example: https://WSServer:8443/AEWS/job-run-info/test
§ GET AEWS/job-run-info method—Retrieve Job Run Information of a
Single or Multiple Jobs
– URL: https://webserver:port/AEWS/job-run-info?parameters
– Example: https://WSServer:8443/AEWS/job-run-info?filter=name=@test*

Job Control
Supported requests
POST AEWS/event/cancel-job method—Cancel a Job, Application or Group
– URL: https://webserver:port/AEWS/event/cancel-job?parameters
Request Response
XML Format
POST https://WSServer:8443/AEWS/event/cancel-job
<command>
<jobName>test</jobName>
<comment>testing cancel-job</comment>
</command>
JSON Format
POST https://WSServer:8443/AEWS/event/cancel-job
{"jobName":"test","comment": "testing cancel-job"}
201 Created
Date: Tue, 31 Jan 2012 13:06:47 GMT

Job Control
Supported requests
§ POST AEWS/event/force-start-job method—Start a Job, Application or Group by Force
– URL: https://webserver:port/AEWS/event/force-start-job?parameters
§ POST AEWS/event/hold-job method—Put a Job, Application or Group in ON_HOLD status
– URL: https://webserver:port/AEWS/event/hold-job?parameters
§ POST AEWS/event/ice-job method—Put a Job, Application or Group in ON_ICE status
– URL: https://webserver:port/AEWS/event/ice-job?parameters
§ POST AEWS/event/noexec-job method—Put a Job, Application or Group in ON_NOEXEC status
– URL: https://webserver:port/AEWS/event/noexec-job?parameters
§ POST AEWS/event/off-hold-job method—Take a Job, Application or Group Off Hold
– URL: https://webserver:port/AEWS/event/off-hold-job?parameters

Job Control
Supported requests
§ POST AEWS/event/off-ice-job method—Take a Job, Application or Group Off Ice
– URL: https://webserver:port/AEWS/event/off-ice-start-job?parameters
§ POST AEWS/event/off-noexec-job method—Take a Job, Application or Group in
Off NOEXEC status
– URL: https://webserver:port/AEWS/event/off-no-exec-job?parameters
§ POST AEWS/event/release-resources-job method—Release Resources held by a Job,
Application or Group
– URL: https://webserver:port/AEWS/event/release-resources-job?parameters
§ POST AEWS/event/reply-job method—Reply to a Job, Application or Group
– URL: https://webserver:port/AEWS/event/reply-job?parameters

Job Control
Supported requests
§ POST AEWS/event/restart-job method—Restart a Job
– URL: https://webserver:port/AEWS/event/restart-job?parameters
– Note: Applies to z/OS or MicroFocus Job only
§ POST AEWS/event/start-job method—Start a Job, Application or Group
– URL: https://webserver:port/AEWS/event/start-job?parameters

Global Variables Retrieval
Supported requests
§ GET AEWS/gvar/variableName method—Retrieve Information of a Specific Global Variable
– URL: https://webserver:port/gvar/variableName?parameters
– Example: https://WSServer:8443/AEWS/gvar/TestVar
§ GET AEWS/gvar method—Retrieve Information of a Single or Multiple Global Variables
– URL: https://webserver:port/gvar?parameters
– Example: https://WSServer:8443/AEWS/gvar?filter==name=@gvar*

Global Variables Control
Supported requests
§ POST AEWS/event/delete-gvar/name method—Delete a Global Variable
– URL: https://webserver:port/AEWS/event/delete-gvar/name?parameters
§ POST AEWS/event/set-gvar/name method—Create or Update a Global Variable
– URL: https://webserver:port/AEWS/event/set-gvar/name?parameters

§ Continue to enhance and expand capabilities
§ Object Administration (create, update, delete objects (jobs,
etc.))
44
CA WA AE Web Services – Looking ahead

CA Workload Automation REST Client
§ wlarestclient.jar
§ Java based RESTful web services client utility
§ Allows you to execute web services implemented using the
REST protocol
§ Can be used with any CA Workload engine using standard
command job(CMD, Unix, NT)

CA Workload Automation REST Client - Requirements
§ Java Runtime Environment 1.8

CA Workload Automation REST Client - Configuration
§ Data used to do a call can come from three sources:
– the command line arguments
– global config
– a file (also yml format) that is passed as parameter to the command
§ Notes:
– command line arguments will override the file parameters and the file
parameters will override the global one
– The override will happen just for parameters with the same name from
configurations with the same name
47

CA Workload Automation REST Client - Configuration
§ Global Properties File (config.yml) (Optional)
– has to be created in the same directory as "wlarestclient.jar" file if it is
to be used
– file used to define parameters for every API call made by the REST
client
48

CA WA REST Client – Command Examples
§ 1) java -jar wlarestclient.jar URL=http://apiserver/testing
name=TEST
– This will call the following URL: http://apiserver/testing?name=TEST
§ 2) java -jar wlarestclient.jar PATH=input.parms TYPE=POST
INPUT=/usr/share/inputs/payload.txt
– This will read the "input.parms" file for all supported parameters,
including URL, and use the file in inputPath for payload
49

Recommended Sessions
SESSION # TITLE DATE/TIME
MFX122S
Vision and Roadmap: CA Workload Automation AE
(AutoSys)
11/16/2016 @ 12:45 pm
Banyan A/B
MFX133S
Critical Path Forecasting with CA Workload Automation
(AE) iDash
11/16/2016 @ 4:30 pm
Banyan A/B
MFX132S
Real World Best Practices with CA Workload Automation
AE 11.3.6
11/17/2016 at 3:45 pm
Banyan A/B

Must See Demos
Advanced
Workload
Analytics
CA WLA iDash
MF and Workload
Automation
Seamless
Application
Automation
Agents & Advanced
Integrations
MF and Workload
Automation
CA Conversion
as a Service
CA Workload
Automation
MF and Workload
Automation
Innovations:
Cross Enterprise
Workload
Automation
CA WLA AE & DE
MF and Workload
Automation

Questions?
Informatica

Pre-Con Ed: Beyond the AE CLI - Leveraging CA Workload Automation AE Web Services

Recommandé

Recommandé

Contenu connexe

Tendances

Tendances (20)

Similaire à Pre-Con Ed: Beyond the AE CLI - Leveraging CA Workload Automation AE Web Services

Similaire à Pre-Con Ed: Beyond the AE CLI - Leveraging CA Workload Automation AE Web Services (20)

Plus de CA Technologies

Plus de CA Technologies (20)

Dernier

Dernier (20)

Pre-Con Ed: Beyond the AE CLI - Leveraging CA Workload Automation AE Web Services