CA Workload Automation Agent for Web Services

Transcription

1 CA Workload Automation Agent for Web Services Implementation Guide r11.3.1, Second Edition

2 This Documentation, which includes embedded help systems and electronically distributed materials, (hereinafter referred to as the Documentation ) is for your informational purposes only and is subject to change or withdrawal by CA at any time. This Documentation is proprietary information of CA and may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. If you are a licensed user of the software product(s) addressed in the Documentation, you may print or otherwise make available a reasonable number of copies of the Documentation for internal use by you and your employees in connection with that software, provided that all CA copyright notices and legends are affixed to each reproduced copy. The right to print or otherwise make available copies of the Documentation is limited to the period during which the applicable license for such software remains in full force and effect. Should the license terminate for any reason, it is your responsibility to certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed. TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION AS IS WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE. The use of any software product referenced in the Documentation is governed by the applicable license agreement and such license agreement is not modified in any way by the terms of this notice. The manufacturer of this Documentation is CA. Provided with Restricted Rights. Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections , , and (c)(1) - (2) and DFARS Section (b)(3), as applicable, or their successors. Copyright 2014 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.

3 CA Technologies Product References This document references the following CA Technologies products: CA Process Automation CA Workload Automation AE CA Workload Automation Agent for Application Services (CA WA Agent for Application Services) CA Workload Automation Agent for Databases (CA WA Agent for Databases) CA Workload Automation Agent for i5/os (CA WA Agent for i5/os) CA Workload Automation Agent for Informatica (CA WA Agent for Informatica) CA Workload Automation Agent for Linux (CA WA Agent for Linux) CA Workload Automation Agent for Micro Focus (CA WA Agent for Micro Focus) CA Workload Automation Agent for Microsoft SQL Server (CA WA Agent for Microsoft SQL Server) CA Workload Automation Agent for Oracle E-Business Suite (CA WA Agent for Oracle E-Business Suite) CA Workload Automation Agent for PeopleSoft (CA WA Agent for PeopleSoft) CA Workload Automation Agent for Remote Execution (CA WA Agent for Remote Execution) CA Workload Automation Agent for SAP (CA WA Agent for SAP) CA Workload Automation Agent for UNIX (CA WA Agent for UNIX) CA Workload Automation Agent for Web Services (CA WA Agent for Web Services) CA Workload Automation Agent for Windows (CA WA Agent for Windows) CA Workload Automation CA 7 Edition CA Workload Automation DE CA Workload Automation Desktop Client (CA WA Desktop Client) CA Workload Automation ESP Edition CA Workload Control Center

4 Contact CA Technologies Contact CA Support For your convenience, CA Technologies provides one site where you can access the information that you need for your Home Office, Small Business, and Enterprise CA Technologies products. At you can access the following resources: Online and telephone contact information for technical assistance and customer services Information about user communities and forums Product and documentation downloads CA Support policies and guidelines Other helpful resources appropriate for your product Providing Feedback About Product Documentation If you have comments or questions about CA Technologies product documentation, you can send a message to techpubs@ca.com. To provide feedback about CA Technologies product documentation, complete our short customer survey which is available on the CA Support website at

5 Contents Chapter 1: Introduction 7 Intended Audience... 7 Agents and Agent Plug-ins... 7 CA WA Agent for Web Services... 8 Job Types Supported by CA WA Agent for Web Services... 9 Chapter 2: Implementation Checklist 11 How to Install and Configure CA WA Agent for Web Services Deciding Whether to Create an Alias Chapter 3: Installing the Agent Plug-in 13 Controlling the Agent Plug-in Install the Agent Plug-in Configure the Agent Plug-in to Run POJO Jobs How to Remove the Agent Plug-in Disable CA WA Agent for Web Services Remove the Agent Plug-in from the Scheduling Manager Chapter 4: Your Scheduling Manager and the Agent Plug-in 19 Configuring the Scheduling Manager to Work with the Agent Plug-in Running a Verification Test Chapter 5: Configuring the Agent Plug-in 21 How to Configure Agent Parameters Configure Agent Parameters on the Agent Configure Agent Parameters on the Scheduling Manager CA WA Agent for Web Services Parameters in the agentparm.txt File How to Set Up an Alias for the Agent Plug-in Create an Alias for the Agent Plug-in Configuring an Alias on the Scheduling Manager Configure the Agent Plug-in for a Proxy Configure the Agent for Web Services Message-Level Security Contents 5

6 Chapter 6: Troubleshooting the Agent Plug-in 29 Web Service Invocation Error Messages Status-Related Error Messages Chapter 7: Related Documentation 37 CA Workload Automation AE Documentation CA Workload Automation DE Documentation CA Workload Automation ESP Edition Documentation CA Workload Automation CA 7 Edition Documentation Index 41 6 Implementation Guide

7 Chapter 1: Introduction This section contains the following topics: Intended Audience (see page 7) Agents and Agent Plug-ins (see page 7) CA WA Agent for Web Services (see page 8) Job Types Supported by CA WA Agent for Web Services (see page 9) Intended Audience This document is for system administrators who are responsible for upgrading, installing, and configuring agents. You require knowledge of the operating system where the agent is installed and any third-party products or software technology that the agent uses. Notes: The term Windows refers to any Microsoft Windows operating system supported by the agent. The UNIX instructions in this document also apply to Linux systems unless otherwise noted. Agents and Agent Plug-ins Agents are the key integration components of CA Technologies workload automation products. Agents let you automate, monitor, and manage workload on all major platforms, applications, and databases. To run workload on a particular system, you install an agent on that system. If your workload must run on a UNIX computer, for example, you can install and configure the CA WA Agent for UNIX. The agent can run UNIX scripts, execute UNIX commands, transfer files using FTP, monitor file activity on the agent computer, and perform many other tasks. You can extend the functionality of the agent by installing one or more agent plug-ins in the agent installation directory. If you have a relational database such as Oracle, you can install a database agent plug-in to query and monitor the database. Other agent plug-ins are also available. For more information about agent plug-ins, see the Implementation Guide for the appropriate agent plug-in. Note: The agent plug-ins are only available for UNIX, Linux, and Windows operating environments. Chapter 1: Introduction 7

8 CA WA Agent for Web Services Example: Workload with Different Types of Jobs The following workload contains z/os jobs, a UNIX job, an SAP job, and a Windows job, running on different computers, in different locations, and at different times: CA WA Agent for Web Services The CA WA Agent for Web Services lets a user perform the following tasks: Call an operation within a web service and pass parameters to the operation using RPC/encoded or document/literal style binding Directly invoke Java methods on Java classes in the agent plug-in Directly execute a CA Process Automation process Submit a Start Request Form to execute a CA Process Automation process Abort, suspend, or resume a CA Process Automation process instance Retrieve a CA Process Automation process log Retrieve the state of a CA Process Automation process Retrieve the status of a Start Request Form object Retrieve CA Process Automation Start Request Forms Retrieve the status of the CA Process Automation server 8 Implementation Guide

9 Job Types Supported by CA WA Agent for Web Services Job Types Supported by CA WA Agent for Web Services With the CA WA Agent for Web Services, you can define and run the following types of jobs: Web Service RPC/Encoded Lets you call an operation within a web service and pass parameters to the operation using RPC/encoded style binding. The parameters can be actual values or a serialized Java object that another job passes. Web Service Document/Literal POJO Lets you call an operation within a web service and pass parameters to the operation using document/literal style binding. The parameters represent a flattened view of the XML document the agent constructs. The values that are passed into the XML document can be literal values or a serialized Java object that another job passes. Lets you instantiate a class to create a Java object and invoke a method on it. The job is restricted to classes that take constructors with no arguments (default constructors). You can use the POJO job to invoke custom Java code within the agent. Process Automation Process Execution Lets you directly execute a CA Process Automation process. Process Automation Start Request Form Lets you submit a Start Request Form to execute a CA Process Automation process. The Start Request Form sets the values for the current execution of the process. Chapter 1: Introduction 9

10

11 Chapter 2: Implementation Checklist This section contains the following topics: How to Install and Configure CA WA Agent for Web Services (see page 11) Deciding Whether to Create an Alias (see page 12) How to Install and Configure CA WA Agent for Web Services The CA WA Agent for Web Services is an agent plug-in that installs into the CA WA Agent for UNIX, Linux, or Windows installation directory. Note: Before you install the agent plug-in, install and configure the agent. To install and configure the agent plug-in, follow these steps: 1. Review the system requirements in the CA Workload Automation Agent for Web Services Release Notes. 2. Decide whether to create an alias (see page 12). 3. Apply the latest agent patch on the platform where you are installing the agent plug-in. For example, if you are installing on Windows, install the latest patch for CA Workload Automation Agent for Windows. 4. Install the agent plug-in (see page 13). 5. Configure the agent plug-in to run POJO jobs (see page 15). 6. Configure the scheduling manager to work with the agent plug-in (see page 19). 7. (Optional) Run a verification test (see page 19). 8. (Optional) Configure the agent plug-in for a proxy (see page 25). Chapter 2: Implementation Checklist 11

12 Deciding Whether to Create an Alias Deciding Whether to Create an Alias You install an agent plug-in into the agent installation directory to extend the core functionality of the agent. By default, the agent plug-in operates under the same agent name that is assigned to the agent. An alias lets you create a unique agent name for an agent plug-in, which is useful for controlling agent security or for setting up clustered environments. The installation program for the agent plug-in generates the alias by adding a suffix to the agent name. Note: If you are installing the agent plug-in to work with CA Workload Automation DE, an alias is required. Setting up an alias for use with other scheduling managers is optional. Suppose that you have installed an agent that is named AGT10 on a UNIX computer. Users who have access to that agent through their security permissions specify AGT10 as the agent name in their job definitions. Now suppose that you install an agent plug-in into the installation directory for AGT10. You can create an alias for the agent plug-in, for example, AGT10_WS. You can then restrict access to that alias to only those users that run Web Services workload. Those specific users then must specify AGT10_WS as the agent name in their job definitions. Each agent plug-in has a default alias that you can enable during installation. For example, the agent plug-in for CA WA Agent for Web Services has the default alias agentname_ws. You can enable or change the default alias name after installation. To work, also configure the alias on the scheduling manager. Note: To configure agent aliasing for clustered environments, see the CA Workload Automation Agent for UNIX, Linux, or Windows Implementation Guide. 12 Implementation Guide

13 Chapter 3: Installing the Agent Plug-in This section contains the following topics: Controlling the Agent Plug-in (see page 13) Install the Agent Plug-in (see page 13) Configure the Agent Plug-in to Run POJO Jobs (see page 15) How to Remove the Agent Plug-in (see page 15) Controlling the Agent Plug-in You control the agent plug-in using the agent where the plug-in is installed. Depending on your operating system, you have several options for starting or stopping the agent. On UNIX, issue a command to run a start or stop script. On Windows, start or stop the agent as a Windows service. Note: For more information about starting and stopping the agent, see the CA Workload Automation Agent for UNIX, Linux, or Windows Implementation Guide. Install the Agent Plug-in You install the agent plug-in using an interactive program that prompts you for the required information. Follow these steps: 1. Copy the webservice.pak file into the agent installation directory. You can copy this file from the product DVD or can download a zip file that contains the file from the CA Support Online website ( 2. Change to the agent installation directory. For example, type the following command: On UNIX: cd opt/ca/wa_agent_r11_3 On Windows: cd C:\Program Files\CA\WA Agent R11.3 Chapter 3: Installing the Agent Plug-in 13

14 Install the Agent Plug-in 3. Stop the agent using one of the following commands: On UNIX:./cybAgent -s On Windows: cybagent -s 4. Start the installation program using one of the following commands: On UNIX:./PluginInstaller webservice.pak install_dir On Windows: PluginInstaller webservice.pak install_dir install_dir Specifies the agent installation directory. 5. Enter the information the installation program prompts you for. The installation program displays a message and closes automatically upon a successful installation. 6. Start the agent using one of the following commands: On UNIX:./cybAgent & On Windows: cybagent -a The agent starts. Note: The installation program backs up all modified and replaced files. The backup files are compressed into a file that is named backup_timestamp.zip, located in the backups subdirectory of the agent installation directory. You can use Winzip or other similar utilities to open the backup file. A backup copy of the agentparm.txt file is stored in the zip file. 14 Implementation Guide

15 Configure the Agent Plug-in to Run POJO Jobs Configure the Agent Plug-in to Run POJO Jobs To run a POJO job, add the JAR or class files the job invokes to the agent installation directory using this procedure. Follow these steps: 1. Stop the agent. 2. Locate the JAR or class files your POJO jobs invoke. 3. Do the following steps as required: If you use JAR files, place the JAR files in the jars/ext directory (UNIX) or jars\ext (Windows) in the agent installation directory. If you use class files, create a jars/ext/classes (UNIX) or jars\ext\classes (Windows) directory in the agent installation directory. Copy the package of POJO classes to the new directory. 4. Start the agent. The agent plug-in is configured to run POJO jobs. How to Remove the Agent Plug-in You can remove an agent plug-in when you no longer require it. To remove the agent plug-in, follow these steps: 1. Disable the agent plug-in (see page 15). 2. (Optional) Remove the agent plug-in from the scheduling manager (see page 17). Disable CA WA Agent for Web Services Use this procedure when you want to remove CA WA Agent for Web Services from your system. Follow these steps: 1. Verify that all workload is complete. 2. Stop the agent. 3. Open the agentparm.txt file that is located in the agent installation directory. 4. Comment out the plugins.start_internal_n parameter, and renumber any subsequent plugins.start_internal_n parameters. Note: Renumber all other agent plug-ins that are assigned a greater number than the agent plug-in you are uninstalling. Chapter 3: Installing the Agent Plug-in 15

16 How to Remove the Agent Plug-in 5. Comment out the communication.alias parameter if you created an alias during the agent plug-in installation. Note: Renumber any subsequent communication.alias_n parameters. 6. Save and close the agentparm.txt file. 7. Remove the following files from the JARs subdirectory of the agent installation directory: dataservices.jar itpam.jar webservice.jar 8. Start the agent. Example: Renumber the plugins.start_internal_n Parameter Suppose that you have the following agent plug-ins set in the agentparm.txt file: plugins.start_internal_1=runner plugins.start_internal_2=itpam plugins.start_internal_3=webservice plugins.start_internal_4=dataservices plugins.start_internal_5=ftp plugins.start_internal_6=microfocus To disable the agent plug-in for CA WA Agent for Web Services, you would modify the agentparm.txt file as follows: plugins.start_internal_1=runner #plugins.start_internal_2=itpam #plugins.start_internal_3=webservice #plugins.start_internal_4=dataservices plugins.start_internal_2=ftp plugins.start_internal_3=microfocus Example: Renumber the communication.alias_n Parameter Suppose that you have two alias agent plug-ins. The agentparm.txt file has the following parameters: communication.alias_1=agentname_ws communication.alias_2=agentname_mf To disable the agent plug-in for CA WA Agent for Web Services, modify the agentparm.txt file as follows: #communication.alias_1=agentname_ws communication.alias_1=agentname_mf 16 Implementation Guide

17 How to Remove the Agent Plug-in Remove the Agent Plug-in from the Scheduling Manager In addition to disabling the agent plug-in, you can remove it from the configuration on the scheduling manager. Note: For detailed instructions to remove the agent from the scheduling manager, see the documentation for your scheduling manager. Chapter 3: Installing the Agent Plug-in 17

18

19 Chapter 4: Your Scheduling Manager and the Agent Plug-in This section contains the following topics: Configuring the Scheduling Manager to Work with the Agent Plug-in (see page 19) Running a Verification Test (see page 19) Configuring the Scheduling Manager to Work with the Agent Plug-in If you have defined the following items for the agent plug-in, configure the items on the scheduling manager: An alias A user For detailed configuration instructions, see the documentation for your scheduling manager. Running a Verification Test For your verification test, you define and run a Web Service RPC/Encoded or Web Service Document/Literal job. To define a Web Service RPC/Encoded job, you require the following information: Agent name Specifies the name of your agent or the alias for the agent plug-in if you created an alias. Target namespace Specifies the target namespace that is used for the names of messages, port type, binding, and service that is defined in the web service WSDL. Complex data types such as arrays require the target namespace. Example: Chapter 4: Your Scheduling Manager and the Agent Plug-in 19

20 Running a Verification Test Operation Specifies the web service operation the job invokes. Example: GetQuote Note: For more information about running Web Service RPC/Encoded jobs, see the documentation for your scheduling manager. To define a Web Service Document/Literal job, you require the following information: Agent name Specifies the name of your agent or the alias for the agent plug-in if you created an alias. Target endpoint address URL Specifies the target endpoint address URL. Operation Specifies the web service operation the job invokes. Port name Specifies the WSDL port name. Web service name Specifies the web service name. WSDL URL Specifies the URL to the Web Service Description Language (WSDL) of the web service to invoke. Note: For more information about running Web Service Document/Literal jobs, see the documentation for your scheduling manager or the CLI User Guide. 20 Implementation Guide

21 Chapter 5: Configuring the Agent Plug-in This section contains the following topics: How to Configure Agent Parameters (see page 21) CA WA Agent for Web Services Parameters in the agentparm.txt File (see page 22) How to Set Up an Alias for the Agent Plug-in (see page 24) Configure the Agent Plug-in for a Proxy (see page 25) Configure the Agent for Web Services Message-Level Security (see page 27) How to Configure Agent Parameters You configure agent parameters by editing the agentparm.txt file, which is located in the agent installation directory. When you install the agent, the installation program adds frequently configured agent parameters to the file. Other agent parameters exist, which you must manually add to the agentparm.txt file to configure the agent. For any configuration changes to take effect, always stop and restart the agent. For some agent parameters, such as the agent name and communication parameters, also configure the parameters on the scheduling manager. To configure agent parameters, do the following steps: 1. Configure agent parameters on the agent (see page 21). 2. Configure agent parameters on the scheduling manager (see page 22). Configure Agent Parameters on the Agent Configure agent parameters on CA WA Agent for UNIX, Linux, or Windows using the following procedure. Follow these steps: 1. Change to the agent installation directory. 2. Stop the agent using one of the following commands: On UNIX:./cybAgent -s On Windows: cybagent -s Chapter 5: Configuring the Agent Plug-in 21

22 CA WA Agent for Web Services Parameters in the agentparm.txt File 3. Open the agentparm.txt file that is located in the agent installation directory. 4. Make the required changes to the agent parameters. 5. Save and close the agentparm.txt file. 6. Start the agent using one of the following commands: On UNIX:./cybAgent & On Windows: cybagent -a Configure Agent Parameters on the Scheduling Manager When you change an agent parameter in the agentparm.txt file that is also defined on the scheduling manager, such as the agent name, configure the agent parameter on the scheduling manager. Note: For detailed instructions to configure agent parameters on the scheduling manager, see the documentation for your scheduling manager. CA WA Agent for Web Services Parameters in the agentparm.txt File You can configure the following parameters in the agentparm.txt file. The file is located in the agent installation directory. You can open the agentparm.txt file in any standard text editor. communication.alias_n Defines the alias name for the agent. The n suffix increments sequentially for each alias agent. Note: To enable an alias on the agent, verify that the comment character (#) is removed from the parameter line. Default: agentname_ws http.proxydomain Specifies the domain for proxy authentication. Example: http.proxyhost Specifies the host name of the proxy server. Example: caproxy 22 Implementation Guide

23 CA WA Agent for Web Services Parameters in the agentparm.txt File http.proxyorigin Specifies the origin host name for proxy authentication. Example: http.proxypassword.encr Specifies the encrypted proxy server password. Example: 9DD43DA16CBFAE06 Notes: http.proxyport The password must be encrypted. To encrypt a password, use the Password utility that is provided with the agent. For more information about the Password utility, see the CA Workload Automation Agent for UNIX, Linux, or Windows Implementation Guide. Although not recommended, you can specify the password in plain text using the http.proxypassword parameter. If you specify both the http.proxypassword and http.proxypassword.encr parameters, the encrypted value is used. Specifies the port on the server of the proxy. Example: 80 http.proxyuser Specifies the user name for proxy authentication. To specify a domain, use the following format: domain\user. Examples: pmf01, mydomain\causer plugins.start_internal_n Specifies the agent plug-in to start by the core Java agent. n Denotes an integer that is assigned to the agent plug-in, starting at 1. The n suffix must increase sequentially for each agent plug-in. Example: webservice webservice.pool.size Specifies the size of the thread pool for the document/literal connection handler. This parameter specifies the maximum number of threads that are available in the pool. When all of the threads in the pool are active, new tasks wait in the queue until a thread is available. Default: 2 Limits: 1 and higher Chapter 5: Configuring the Agent Plug-in 23

24 How to Set Up an Alias for the Agent Plug-in webservice.skipwsdl Specifies whether to skip processing the WSDL document. Applies to Web Service RPC/Encoded jobs only. true false Skips processing the WSDL document. Data comes from the job definition rather than the WSDL. Processes the WSDL document. Default: false ws.wss.keystore Specifies the full path to your keystore file that contains the X509 certificate. You can generate your own keystore using the keytool utility that is provided with the JRE. Default: serverkeystore ws.wss.keystore.alias Specifies the client keystore alias. The alias is for the public or private keys of the agent. Default: agent ws.wss.keystore.password Specifies the keystore password. The password is encrypted in hexadecimal form. Default: cyberuser (encrypted) Note: The password must be encrypted. To encrypt a password, use the Password utility that is provided with the agent. For more information about the Password utility, see the CA Workload Automation Agent for UNIX, Linux, or Windows Implementation Guide. How to Set Up an Alias for the Agent Plug-in During the agent plug-in installation, you are prompted to create a default alias, which you can change after installation. If you enable an alias on the agent plug-in, also configure the alias on the scheduling manager. To set up an alias for the agent plug-in, follow these steps: 1. Create an alias for the agent plug-in (see page 25). 2. Configure the alias on the scheduling manager (see page 25). 24 Implementation Guide

25 Configure the Agent Plug-in for a Proxy Create an Alias for the Agent Plug-in An alias lets you create a unique agent name for an agent plug-in. Each agent plug-in has a default alias, which you can enable or change. To create an alias for the agent, configure the following parameter on the agent: communication.alias_n Defines the alias name for the agent. The n suffix increments sequentially for each alias agent. Note: To enable an alias on the agent, verify that the comment character (#) is removed from the parameter line. Configuring an Alias on the Scheduling Manager When you create an alias for an agent plug-in, also configure the alias on the scheduling manager. Define the alias on the scheduling manager with the same address, port number, and encryption key as the agent where the agent plug-in is installed. Note: For detailed instructions to configure an alias on the scheduling manager, see the documentation for your scheduling manager. Configure the Agent Plug-in for a Proxy To access a computer outside the firewall of your company, configure the agent-plug to communicate through a proxy server. You require the proxy host, port, user name, and encrypted password for the configuration. You require this configuration if schedulers are running workload that includes HTTP and Web Service jobs. To configure the agent plug-in for a proxy, manually add the following parameters to the agentparm.txt file and restart the agent: http.proxydomain Specifies the domain for proxy authentication. Example: http.proxyhost Specifies the host name of the proxy server. Example: caproxy http.proxyport Specifies the port on the server of the proxy. Example: 80 Chapter 5: Configuring the Agent Plug-in 25

26 Configure the Agent Plug-in for a Proxy Add the following parameters set to values for your proxy if the proxy requires authentication: http.proxyorigin Specifies the origin host name for proxy authentication. Example: http.proxyuser Specifies the user name for proxy authentication. To specify a domain, use the following format: domain\user. Examples: pmf01, mydomain\causer http.proxypassword.encr Specifies the encrypted proxy server password. Example: 9DD43DA16CBFAE06 Notes: The password must be encrypted. To encrypt a password, use the Password utility that is provided with the agent. For more information about the Password utility, see the CA Workload Automation Agent for UNIX, Linux, or Windows Implementation Guide. Although not recommended, you can specify the password in plain text using the http.proxypassword parameter. If you specify both the http.proxypassword and http.proxypassword.encr parameters, the encrypted value is used. Note: Run the agent plug-in under a user account or in Windows console mode when NTLM proxy authentication is required. 26 Implementation Guide

27 Configure the Agent for Web Services Message-Level Security Configure the Agent for Web Services Message-Level Security To provide end-to-end security of web services messages, you can configure the agent for message-level security. You require the path to your keystore file, client keystore alias, and keystore password for the configuration. After you configure the agent for message-level security, schedulers can specify the following SOAP-level WS-Security options in Web Service Document/Literal jobs: SIGNATURE messages are signed with a certificate. ENCRYPTION messages are encrypted at the message level, increasing security when going through proxies that require decrypting or re-encrypting of the transport stream. To configure the agent for web services message-level security, manually add the following keystore parameters to the agentparm.txt file and restart the agent: ws.wss.keystore Specifies the full path to your keystore file that contains the X509 certificate. You can generate your own keystore using the keytool utility that is provided with the JRE. Default: serverkeystore ws.wss.keystore.alias Specifies the client keystore alias. The alias is for the public or private keys of the agent. Default: agent ws.wss.keystore.password Specifies the keystore password. The password is encrypted in hexadecimal form. Default: cyberuser (encrypted) Note: The password must be encrypted. To encrypt a password, use the Password utility that is provided with the agent. For more information about the Password utility, see the CA Workload Automation Agent for UNIX, Linux, or Windows Implementation Guide. Chapter 5: Configuring the Agent Plug-in 27

28

29 Chapter 6: Troubleshooting the Agent Plug-in This section contains the following topics: Web Service Invocation Error Messages (see page 29) Status-Related Error Messages (see page 35) Web Service Invocation Error Messages The section provides LStatus error messages that are related to invocation errors that appear in the Status. nested exception is:..org.xml.sax.saxexception: Deserializing parameter 'holdreturn': could not find deserializer for type { Could not deserialize XML WebResponse response object that the invoked operation returned. Specify the corresponding java class, for example, WebResponse, as a value for ReturnClassName. Ensure that the agent loaded corresponding class. If the class is a custom class, such as WebResponse, place it in the <agent_home>/jars/ext directory. nested exception is:..org.xml.sax.saxexception: Invalid element in java.lang.string - messages Could not deserialize XML response object that the invoked operation to java.lang.string returned. Specify the correct java class, for example, WebResponse, as a value for ReturnClassName. Ensure that the agent loaded the corresponding class. If the class is a custom class, such as WebResponse, place it in the <agent_home>/jars/ext directory. Chapter 6: Troubleshooting the Agent Plug-in 29

30 Web Service Invocation Error Messages java.lang.nullpointerexception Problem invoking a method. Axis library returned NullPointerException. 1. Check whether the operation returns a complex structure. If it does, specify the correct java class, for example, WebResponse, as a value for ReturnClassName. Ensure that the agent loaded the corresponding class. If the class is a custom class, such as WebResponse, place it in the <agent_home>/jars/ext directory. 2. Verify all your parameter types and values. Error processing WSDL document:.java.net.connectexception: Connection timed out: connect Problem connecting to the web service. 1. Verify your network connectivity. 2. Verify whether you need to connect through a proxy, and verify your proxy parameters in the agentparm.txt file. Error processing WSDL document:.java.io.ioexc eption: Server returned HTTP response code: 407 for URL: Problem connecting through a proxy. Proxy authentication is required. 1. Verify whether you need to connect through a proxy, and verify your proxy parameters in the agentparm.txt file. 2. If the proxy is using NTLM authentication, ensure that the agent is logged to a domain. 30 Implementation Guide

31 Web Service Invocation Error Messages Connection refused The host exists but is not listening for connections on that port. Alternatively, a firewall is blocking that port. When a connectivity problem is suspected, Verify the faulty URL in your Web browser. Also verify your proxy settings for the agent. Unknown host The hostname component of the URL is invalid or the client is off-line. When a connectivity problem is suspected, Verify the faulty URL in your Web browser. Also verify your proxy settings for the agent. 404: Not Found A Web server exists but the URL is inactive or incorrect. Proxy servers can also generate 404 pages for unknown hosts. When a connectivity problem is suspected, Verify the faulty URL in your Web browser. Also verify your proxy settings for the agent. 302: Moved The content at the end of the URL has moved, and the client application does not follow the links. The.com or.net address is invalid, or the port is explicitly -or defaulting toport 80. When a connectivity problem is suspected, Verify the faulty URL in your Web browser. Also verify your proxy settings for the agent. Chapter 6: Troubleshooting the Agent Plug-in 31

32 Web Service Invocation Error Messages Other 3xx response The content at the end of the URL has moved, and the client application does not follow the links. When a connectivity problem is suspected, Verify the faulty URL in your Web browser. Also verify your proxy settings for the agent. Wrong content type/mime type The URL is incorrect, or the server application is not returning XML. When a connectivity problem is suspected, Verify the faulty URL in your Web browser. Also verify your proxy settings for the agent. XML parser error The content is not XML, but the client application assumes that it is. When a connectivity problem is suspected, Verify the faulty URL in your Web browser. Also verify your proxy settings for the agent. 500: Internal Error SOAP uses this error as a cue that a SOAPFault has been returned, but it can also mean that the server is not working through some internal fault. When a connectivity problem is suspected, Verify the faulty URL in your Web browser. Also verify your proxy settings for the agent. 32 Implementation Guide

33 Web Service Invocation Error Messages Connection Timed out/ NoRouteToHost The hostname can be resolved but not reached. Either the host is missing (potentially a transient fault), or network/firewall issues are preventing access. You may need to configure the client for its proxy server. This message can also appear if you are off line. When a connectivity problem is suspected, Verify the faulty URL in your Web browser. Also verify your proxy settings for the agent. STATE FAILED Status(Invocation error) LStatus("(500)Server Error") Server error. A proxy is not required. Verify the agentparm.txt file for proxy settings and comment the related proxy parameter lines. STATE FAILED Status(Invocation error) LStatus("Error processing WSDL document:.java.net.connectexception: Connection timed out: connect") The agent cannot connect to the web service. Verify the agentparm.txt file for proxy settings and ensure that the agent is configured for the proxy server. Invalid format, WS102: Unknown parameter type Problem instantiating a parameter or a response. Check if your parameter types and your return class name are correct. Chapter 6: Troubleshooting the Agent Plug-in 33

34 Web Service Invocation Error Messages STATE FAILED Status(Invocation error) LStatus("System.Web.Services.Protocols.SoapException: Server did not recognize the value of HTTP Header SOAP [ ]) Problem invoking the web service. Remove the value in the Endpoint URL field of the job, and resubmit the job. LStatus "System.Web.Services.Protocols.SoapException: Server was unable to process request." The WSDL URL is required in the Web Service job for Axis to construct the SOAP message properly. For example, this requirement can occur when a complex parameter is specified in the job definition. Specify the WSDL URL in the Web Service job definition. STATE FAILED Status(Invocation error) LStatus("No such operation 'triggeradd'") Problem invoking the web service. Remove the value in the WSDL URL field of the job. 34 Implementation Guide

35 Status-Related Error Messages Status-Related Error Messages This section provides common error messages that the agent returns due to status problems. Status(Invocation error) LStatus("; nested exception is:..org.xml.sax.saxexception: Deserializing parameter 'holdreturn': could not find deserializer for type { Could not deserialize XML WebResponse response object that the invoked operation returned. Specify the corresponding java class, for example, WebResponse, as a value for ReturnClassName. Ensure that the agents loaded the corresponding class. If the class is a custom class, such as WebResponse, place it in the <agent_home>/jars/ext directory. Status(Invocation error) LStatus("; nested exception is:..org.xml.sax.saxexception: Invalid element in java.lang.string - messages") Could not deserialize XML response object that the invoked operation to java.lang.string returned. Specify the correct java class, for example, WebResponse, as a value for ReturnClassName. Ensure that the agent loaded the corresponding class. If the class is a custom class, such as WebResponse, place it in the <agent_home>/jars/ext directory. Status(Invocation error) LStatus("java.lang.NullPointerException") Problem invoking a method. Axis library returned NullPointerException. 1. Check whether the operation returns a complex structure. If it does, specify the correct java class, for example, WebResponse, as a value for ReturnClassName. Ensure that the agent loaded the corresponding class. If the class is a custom class, such as WebResponse, place it in the <agent_home>/jars/ext directory. 2. Verify all your parameter types and values. Chapter 6: Troubleshooting the Agent Plug-in 35

36 Status-Related Error Messages Status(Invalid format, WS102: Unknown parameter type) Problem instantiating a parameter or a response. Check if your parameter types and your return class name are correct. Status(Invocation error) LStatus("Error processing WSDL document:.java.net.connectexception: Connection timed out: connect") Problem connecting to the web service. 1. Verify your network connectivity. 2. Verify whether you need to connect through a proxy, and verify your proxy parameters in the agentparm.txt file. Status(Invocation error) LStatus("Error processing WSDL document:.java.io.ioexc eption: Server returned HTTP response code: 407 for URL: Problem connecting through a proxy. Proxy authentication required. 1. Verify whether you need to connect through a proxy, and verify your proxy parameters in the agentparm.txt file. 2. If the proxy is using NTLM authentication, ensure that the agent is logged to a domain. 36 Implementation Guide

37 Chapter 7: Related Documentation Documentation for the agent and scheduling managers is available in HTML and PDF format at Note: To view PDF files, download and install the Adobe Reader from the Adobe website if it is not already installed on your computer. This section contains the following topics: CA Workload Automation AE Documentation (see page 37) CA Workload Automation DE Documentation (see page 38) CA Workload Automation ESP Edition Documentation (see page 38) CA Workload Automation CA 7 Edition Documentation (see page 39) CA Workload Automation AE Documentation To work with the agent and CA Workload Automation AE, see the following documentation: Task Configure the scheduling manager to work with the agent Define, monitor, and control jobs Documentation CA Workload Automation AE UNIX Implementation Guide CA Workload Automation AE Windows Implementation Guide CA Workload Automation AE Reference Guide CA Workload Automation AE User Guide CA Workload Control Center Workload Scheduling Guide Chapter 7: Related Documentation 37

38 CA Workload Automation DE Documentation CA Workload Automation DE Documentation To work with the agent and CA Workload Automation DE, see the following documentation: Task Configure the scheduling manager to work with the agent Define jobs Monitor and control jobs Documentation CA Workload Automation DE Admin Perspective Help CA Workload Automation DE Define Perspective Help CA Workload Automation DE Monitor Perspective Help Note: The online help is available in HTML and PDF formats. CA Workload Automation ESP Edition Documentation To work with the agent and CA Workload Automation ESP Edition, see the following documentation: Task Documentation Configure the agent to work with the scheduling manager Define jobs Monitor and control jobs CA Workload Automation ESP Edition Installation and Configuration Guide CA Workload Automation Agent for Web Services User Guide CA Workload Automation Agent for UNIX, Linux, or Windows User Guide CA Workload Automation ESP Edition Operator's Guide 38 Implementation Guide

39 CA Workload Automation CA 7 Edition Documentation CA Workload Automation CA 7 Edition Documentation To work with the agent and CA Workload Automation CA 7 Edition, see the following documentation: Task Configure the scheduling manager to work with the agent Define, monitor, and control jobs Documentation CA Integrated Agent Services Implementation Guide CA Workload Automation CA 7 Edition Interface Reference Guide CA Workload Automation CA 7 Edition Systems Programming Guide CA Integrated Agent Services User Guide CA Workload Automation CA 7 Edition Interface Reference Guide CA Workload Automation CA 7 Edition Database Maintenance Guide CA Workload Automation CA 7 Edition Command Reference Guide Chapter 7: Related Documentation 39

40

41 Index A agent plug-in configuring 21 controlling 13 description 7 installation and configuration process 11 uninstall process 15 agentparm.txt file, parameters 22 alias setup process 24 C configuration parameters, descriptions 22 configuration process, agent plug-in 21 D documentation, scheduling manager 37 E error messages status-related 35 web service invocation 29 F firewall, agent plug-in configuration 25 I installation process 11 removing the plug-in 15 N name, agent plug-in 25 P POJO jobs, agent plug-in configuration 15 proxy server, agent plug-in configuration 25 S scheduling manager configuration for the agent plug-in 19 configuring agent parameters 22 configuring an alias 25 documentation 37 starting and stopping, agent plug-in 13 T troubleshooting, agent plug-in 29 W workload example, different jobs 7 Index 41