Cisco TEO Adapter Guide for SAP Java

Transcription

1 Release 2.3 April 2012 Americas Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA USA Tel: NETS (6387) Fax: Text Part Number:

2 THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS. THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB s public domain version of the UNIX operating system. All rights reserved. Copyright 1981, Regents of the University of California. NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED AS IS WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE. IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R) Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental Cisco Systems, Inc. All rights reserved.

3 CONTENTS New and Changed Information Latest Release v Previous Releases vi v Preface vii Organization vii Conventions viii Product Documentation ix Documentation Formats ix Guides and Release Notes ix Online Help ix Open Source License Acknowledgements ix Obtaining Documentation and Submitting a Service Request ix CHAPTER 1 Understanding the SAP Java Adapter Objects 1-1 Accessing SAP Java Adapter Properties 1-1 Viewing SAP Java Adapter Properties 1-2 Viewing General Information 1-2 Viewing Adapter Prerequisites 1-3 Viewing Adapter-Supported Objects 1-6 Viewing Adapter History 1-7 CHAPTER 2 Managing SAP Java Targets 2-1 Accessing Targets View 2-1 Creating SAP System Targets 2-2 Creating SAP System Target Java Connection 2-2 Creating an SAP System Target ABAP+Java Connection 2-8 Managing SAP Targets 2-19 Enabling an SAP Target 2-19 Disabling an SAP Target 2-19 Deleting an SAP Target 2-20 Modifying SAP System Targets 2-20 Modifying an SAP Java Application Server Target 2-29 iii

4 Contents CHAPTER 3 Using SAP Java Activities 3-1 SAP Java Activities 3-2 Defining an SAP Java Activity 3-3 Defining iview Portal Metrics Activity 3-6 Viewing iview Portal Metrics Results 3-7 Defining Read Generic Java File Activity 3-9 Viewing Read Generic Java File Results 3-10 Defining Read Java Log Activity 3-12 Viewing Read Java Log Results 3-14 Defining SAP Java Shell Command Activity 3-15 Selecting a Shell Command 3-17 Viewing SAP Java Shell Command Results 3-18 Defining Start Java Application Activity 3-19 Viewing Start Java Application Results 3-20 Defining Start Java Service Activity 3-21 Viewing Start Java Service Results 3-23 Defining Stop Java Application Activity 3-24 Viewing Stop Java Application Results 3-25 Defining Stop Java Service Activity 3-26 Viewing Stop Java Service Results 3-28 I NDEX iv

5 New and Changed Information New and changed information for the most recent releases of the Cisco TEO Adapter for SAP Java is as follows: Latest Release Previous Releases Latest Release Table 1 April Changes Feature Location Revised Text Part Number (-01 to -02). Front cover, footers Updated Trademark and Copyright date Inside cover page Added Organization field on System Setup Panel Chapter 2, Managing SAP Java Targets in New SAP System Wizard Updated Defining an SAP Java Activity section. Chapter 3, Using Java Activities Updated field descriptions for Figure 3-8 Read Page 3-12 Java Log Properties Read Java Log Tab v

6 New and Changed Information Previous Releases Table 2 September 2011 Cisco TEO Adapter for SAP Java 2.2 Changes Feature Updated guide name, adapter name, and added Text Part Number to document. New features added to SAP Java Application Server targets: New SAP Java Application Server wizard Target Extended Properties Updated to SAP Java activities: Removed references to JMX New option on target properties for using target reference. Removed SAP Java Attribute activity Updated property pages for the following activities: SAP Java Shell Command Start Java Application Start Java Service Stop Java Application Stop Java Service Location All Chapter 2, Managing SAP Java Targets Chapter 3, Using SAP Java Activities vi

7 Preface The Cisco TEO Adapter for SAP Java provides the functionality in Tidal Enterprise Orchestrator (TEO) to support task automation and problem resolution in SAP Java environments, and to simplify user administration in SAP. This guide provides information on the objects supported by the SAP Java Adapter. Organization This guide includes the following sections: Chapter 1 Understanding the SAP Java Adapter Objects Provides information on accessing and viewing the objects provided by the adapter. Chapter 2 Managing SAP Java Targets Provides information on accessing, creating and managing SAP Java targets. Chapter 3 Using SAP Java Activities Provides information on defining the SAP Java activities that are used in processes that run against the SAP Java application servers and SAP systems in your environment. vii

8 Preface Conventions This guide uses the following conventions: Convention bold font italic font Indication Commands and keywords and user-entered text appear in bold font. Document titles, new or emphasized terms, and arguments for which you supply values are in italic font. [ ] Elements in square brackets are optional. {x y z } Required alternative keywords are grouped in braces and separated by vertical bars. [ x y z ] Optional alternative keywords are grouped in brackets and separated by vertical bars. string A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks. courier font Terminal sessions and information the system displays appear in courier font. < > Nonprinting characters such as passwords are in angle brackets. [ ] Default responses to system prompts are in square brackets.!, # An exclamation point (!) or a pound sign (#) at the beginning of a line of code indicates a comment line. Note Means reader take note. Tip Means the following information will help you solve a problem. Caution Means reader be careful. In this situation, you might perform an action that could result in equipment damage or loss of data. Timesaver Means the described action saves time. You can save time by performing the action described in the paragraph. Warning Means reader be warned. In this situation, you might perform an action that could result in bodily injury. viii

9 Preface Product Documentation Documentation Formats Documentation is provided in the following electronic formats: Adobe Acrobat PDF files Online help You must have Adobe Reader installed to read the PDF files. Adobe Reader installation programs for common operating systems are available for free download from the Adobe Web site at Guides and Release Notes You can download the TEO product documentation from Cisco.com. Release Notes can be found on Cisco.com and the product CD. Online Help Online help is available and can be accessed using the following methods: Click the Help button on any dialog in the application to open the help topic in a pane to the right of the dialog. In the Tidal Enterprise Orchestrator console: Click the Help Pane tool on the toolbar to open the help topic in a pane to the right of the console results pane. Click Help on the menu bar. Open Source License Acknowledgements Licenses and notices for open source software used in Cisco Tidal Enterprise Orchestrator can be found in the Open Source License Acknowledgements found on Cisco.com. If you have any questions about the open source contained in this product, please external-opensource-requests@cisco.com. Obtaining Documentation and Submitting a Service Request For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What s New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at: Subscribe to the What s New in Cisco Product Documentation as a RSS feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS Version 2.0. ix

10 Preface x

11 CHAPTER 1 Understanding the SAP Java Adapter Objects The SAP Java Adapter provides the functionality in Tidal Enterprise Orchestrator (TEO) to support task automation and problem resolution in SAP Java environments, and simplifies user administration in SAP. This chapter provides information on accessing and viewing the objects provided by the SAP Java Adapter. It contains the following sections: Accessing SAP Java Adapter Properties, page 1-1 Viewing SAP Java Adapter Properties, page 1-2 Accessing SAP Java Adapter Properties You can view the SAP Java Adapter properties from the Administration Adapters view in the Console. This view displays general information about the functionality provided by the adapter, version number, release date and install date. Step 1 On the Administration workspace, click Adapters to display the adapters in the Adapters pane. Figure 1-1 Administration Adapters View 1-1

12 Viewing SAP Java Adapter Properties Chapter 1 Understanding the SAP Java Adapter Objects Step 2 Select the SAP Java Adapter and use one of the following methods to open the SAP Java Properties dialog box: Right-click and choose Properties. On the Details pane, click any of the hyperlinks on the General tab. Viewing SAP Java Adapter Properties You use the SAP Java Adapter properties dialog box to view the functionality provided by the adapter. Viewing General Information Use the General tab on the SAP Java Adapter Properties dialog box to view general information about the adapter. Figure 1-2 SAP Java Adapter Properties General Tab The fields on the General tab are display only and provide the following information about the adapter: Display name Type Company Version Name of the adapter that displays in the Adapters view. Object type. Text description of the adapter. Name of company that created or supplied the adapter (Cisco). Version number of the adapter. 1-2

13 Chapter 1 Understanding the SAP Java Adapter Objects Viewing SAP Java Adapter Properties Release date Install date Date and time the adapter was available in the product. Date and time the adapter was installed. Viewing Adapter Prerequisites Use the Prerequisites tab to view the objects that are required by the adapter on the automation server. Step 1 On the SAP Java Adapter Properties dialog box, click the Prerequisites tab. Figure 1-3 SAP Java Adapter Properties Prerequisites Tab Step 2 Review the following information about the adapter prerequisites: Column Name Importance State Minimum Value Detected Value Explanation Name of the required hardware or software for the supported adapter. Indicates whether the item is Required or Optional for the adapter. Indicates whether the system has the required hardware or software installed (Satisfied or Not satisfied). Indicates the minimum value required for the item. Displays the software or hardware version on the system. Display only. Information related to the selected adapter requirement. 1-3

14 Viewing SAP Java Adapter Properties Chapter 1 Understanding the SAP Java Adapter Objects Note The SAP Java Adapter requires certain SAP Java libraries, which are available on the SAP Installation CD. You must have access to one of the following CDs to install the jar files: SAP NetWeaver 7.0 SR3 Java based Software Components Number SAP NetWeaver CE 7.1 SR5 Java Components Documentation Developer Workplace Number Before you can configure an SAP Java application server target, these files must be installed on the TEO server. See Installing SAP Java Library Files for instructions. Installing SAP Java Library Files The SAP Java Adapter requires certain SAP Java library files, which are available on the SAP Installation CD. Before you can configure an SAP Java application server target, these files must be installed on the TEO server. Step 1 Step 2 Step 3 Stop the Tidal Enterprise Orchestrator Server service. Navigate to the directory where the TEO files are installed (C:\Program Files\Cisco\Tidal Enterprise Orchestrator). Double-click Tidal.Automation.SapJarInstaller.exe to open the SAP Libraries Install Wizard. Figure 1-4 Welcome to the SAP Dependency Libraries Installer Step 4 Click Next to check for the adapter dependency libraries. 1-4

15 Chapter 1 Understanding the SAP Java Adapter Objects Viewing SAP Java Adapter Properties Figure 1-5 SAP Dependency Libraries Checker Step 5 Click Next to continue. If the required files cannot be found, the SAP JMX Adapter Dependency Libraries Installer panel displays. Figure 1-6 SAP JMX Adapter Dependency Libraries Installer Step 6 Check the check box next to the version of SAP that you are using. Step 7 Enter the path or click the Browse tool to navigate to the location where the SAP installation files are located and then click Next. 1-5

16 Viewing SAP Java Adapter Properties Chapter 1 Understanding the SAP Java Adapter Objects Figure 1-7 Finishing the SAP Libraries Install Wizard Step 8 Step 9 Verify that the files were successfully installed and then click Close to close the installer. Restart the Tidal Enterprise Orchestrator Server service to complete the procedure. Viewing Adapter-Supported Objects Use the Provides tab to view the name and type of object provided by the adapter. Step 1 On the SAP Java Adapter Properties dialog box, click the Provides tab. Figure 1-8 SAP Java Adapter Properties Provides Tab 1-6

17 Chapter 1 Understanding the SAP Java Adapter Objects Viewing SAP Java Adapter Properties Step 2 Review the following information about the objects provided by the adapter: Column Name Type Name of the activities, processes, and objects for which the adapter provides support. Object type (Target, Runtime User, Activity, Event). Viewing Adapter History Use the History tab to view a history of changes that have been made to the adapter. Step 1 On the SAP Java Adapter Properties dialog box, click the History tab. Figure 1-9 SAP Java Adapter Properties History Tab Step 2 View the following information: Created by Created time Time Change Type User Display only. User name of the person who created the object. Display only. Date and time the object was created. Date and time the action occurred. Action that occurred. User name of the person that performed the action. Information about the action that was performed. 1-7

18 Viewing SAP Java Adapter Properties Chapter 1 Understanding the SAP Java Adapter Objects Step 3 Step 4 To view the audit history for a specific action, select the appropriate time, right-click and choose Properties. Click OK to close the dialog box. 1-8

19 CHAPTER 2 Managing SAP Java Targets The SAP targets enable you to run a process on a specific SAP application server or SAP system. The targets can be defined once and reused in several processes. This chapter guides your through accessing, creating and managing SAP targets. It includes the following sections: Accessing Targets View, page 2-1 Creating SAP System Targets, page 2-2 Managing SAP Targets, page 2-19 Accessing Targets View You use the Definitions Targets view to create, manage and delete targets. Information about the configured targets display in the Targets pane, including the type of target, its status, the automation pack it is associated with, and the date and time modifications were made to it. Figure 2-1 Definitions Targets View 2-1

20 Creating SAP System Targets Chapter 2 Managing SAP Java Targets Creating SAP System Targets Before you can create or run processes in your SAP environment, you must create the targets on which the processes will run. You use the New SAP System Wizard to create SAP System targets and SAP Java application server targets. This section guides you through creating an SAP System target and an SAP Java Application Server target. Creating SAP System Target Java Connection You use the New SAP System wizard to create a target for an SAP system that uses a Java connection to the application server. Note The SAP Java Adapter requires certain SAP Java libraries, which are available on the SAP Installation CD. Before you can configure an SAP Java application server target, these files must be installed on the TEO server. For instructions on installing the SAP Java libraries, see Installing SAP Java Library Files, page 1-4. Step 1 On the Definitions workspace, right-click Targets and choose New > SAP System to open the New SAP System wizard. Figure 2-2 Welcome to the New SAP System Wizard Step 2 Click Next. 2-2

21 Chapter 2 Managing SAP Java Targets Creating SAP System Targets Figure 2-3 System Setup Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. Step 3 The System Setup panel is used to specify the SAP system name, the type of system components to be configured, and the monitoring level for the SAP system. Specify the following information about the SAP system: s Display name System Components ABAP application servers Java application servers SAP database Monitor as production system Organization Enter a name for the SAP system. This is the name that will be displayed in the Targets pane. Check this check box if the SAP system uses an ABAP connection to the application server. Note Uncheck this check box if the SAP system only uses a Java connection to the application server. Check this check box if the SAP system uses a Java connection to the application server. Check this check box if you want to configure the SAP database that is associated with the SAP system. Note Uncheck this check box if the SAP system only uses a Java connection to the application server. This check box is checked by default. Certain processes will run only on production systems. If you want to monitor the system as a non-production system (development or sandbox), uncheck the check box. Enter the group or organization within the company that owns the target. 2-3

22 Creating SAP System Targets Chapter 2 Managing SAP Java Targets Step 4 Click Next. Figure 2-4 Java Connection Step 5 The Java Connection panel is used to specify the Java application servers that are used to connect to the SAP system. If the application servers are already configured, they display in the list box. If the server is in the list box, click Next. Otherwise, click New to add the servers. Figure 2-5 General Information Step 6 On the General Information panel, specify the following information: Display name Enter a name for the SAP Java server. This is the name that will be displayed in the Targets pane. Optional. Enter a text description for the server. 2-4

23 Chapter 2 Managing SAP Java Targets Creating SAP System Targets Step 7 Click Next. Figure 2-6 JMX Connection Step 8 Use the JMX Connection panel to specify the connection information to connect to the Java application server. You connect to the Java application server using a JMX connection. You can also configure to connect to the application server using a Telnet connection. Specify the information for connecting to the SAP Java application server: Application server JMX Connection JMX port Use credentials of the following runtime user Monitor as Portal Central Instance Enable Telnet connection Enter the IP address or name of the SAP Java application server. Enter the JMX port number used to connect to the Java application server. Choose the default runtime user that contains the credentials to connect to the target from the drop-down list. Note The runtime user must be a J2EE Admin account. To view the properties for the selected runtime user, click the Properties tool. To create a new runtime user, click New > Runtime User. Check the check box to run processes designed for portals on this Java server. Check the check box to run processes designed for central instances on this Java server. Check this check box if you want to specify the Telnet connection information to connect to the Java application server. 2-5

24 Creating SAP System Targets Chapter 2 Managing SAP Java Targets Step 9 Click Next. If you enabled the Telnet Connection, the Telnet Connection panel displays. Figure 2-7 Telnet Connection Step 10 Specify the Telnet connection information for connecting to the Java application server: Telnet port Enter the Telnet port number used to connect to the Java application server. Use credentials of the following runtime user Choose the default runtime user that contains the credentials to connect to the target from the drop-down list. Note The runtime user must be a J2EE Admin account. To view the properties for the selected runtime user, click the Properties tool. To create a new runtime user, click New > Runtime User. Step 11 Click Next. 2-6

25 Chapter 2 Managing SAP Java Targets Creating SAP System Targets Figure 2-8 Completing the New SAP Java Application Server Wizard Step 12 Step 13 Verify that the information is correct and click Finish to add the SAP Java application server. After adding the Java application server, click Next on the Java Connection panel. Figure 2-9 Completing the New SAP System Wizard Step 14 Verify that the information is correct and click Finish to complete the procedure. The SAP Java Connection target displays in the Targets pane. 2-7

26 Creating SAP System Targets Chapter 2 Managing SAP Java Targets Creating an SAP System Target ABAP+Java Connection You can create a target for an SAP system that uses both an ABAP and Java connection to the SAP application servers. This section guides you through creating this type of target and configuring the SAP database that is associated with the SAP system. Note The SAP Java Adapter requires certain SAP Java libraries, which are available on the SAP Installation CD. Before you can configure an SAP Java application server target, these files must be installed on the TEO server. For instructions on installing the SAP Java libraries, see Installing SAP Java Library Files, page 1-4. Step 1 On the Definitions workspace, right-click Targets and choose New > SAP System to launch the New SAP System wizard. Figure 2-10 Welcome to the New SAP System Wizard Step 2 Click Next. 2-8

27 Chapter 2 Managing SAP Java Targets Creating SAP System Targets Figure 2-11 System Setup Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. Step 3 The System Setup panel is used to specify the SAP system name, the type of system components to be configured, and the monitoring level for the SAP system. Specify the following information about the SAP system: Display name System Components ABAP application servers Java application servers SAP database Monitor as production system Organization Enter a name for the SAP system. This is the name that will display in the Targets pane. Check this check box if the SAP system uses an ABAP connection to the application server. To monitor both the ABAP and Java stack, this check box must be checked. Check this check box if the SAP system uses a Java connection to the application server. To monitor both the ABAP and Java stack, this check box must be checked. Check this check box if you want to configure the SAP database that is associated with the SAP system. This check box is checked by default. Certain processes will run only on production systems. If you want to monitor the system as a non-production system (development or sandbox), uncheck the check box. Enter the group or organization within the company that owns the target. Step 4 Click Next. 2-9

28 Creating SAP System Targets Chapter 2 Managing SAP Java Targets Figure 2-12 ABAP Connection Use this panel to enter the connection information for the SAP ABAP system. Note The system information entered on this panel must be unique. Otherwise, an error message displays informing you that the wizard detected another system already registered with the same information. Step 5 Specify the connection information for connecting to the SAP application server: Connect using Application server Choose the connection method from the drop-down list. The fields that display on the panel depend on the connection method selected. Choose this option to connect to the SAP system using the SAP application server connection information. Specify the information in the following fields: Server name Enter the name of the SAP application server. System number Enter the SAP system number. 2-10

29 Chapter 2 Managing SAP Java Targets Creating SAP System Targets Logon group Router string (optional) Default runtime user Choose this option to establish a connection using a logon group, which contains a group of SAP system instances. When a user logs on to a logon group, the message server directs the users to the server of this group that currently has the lightest load. Specify the information in the following fields: System ID Enter the SAP system ID (SID). Message server Enter the name of the server a user logs on to and that handles the communication between the application servers. For example, transport of update requests and lock requests. Group name Enter the name of the Logon Group to be accessed. The name entered in this field is case-sensitive. Enter the router string for accessing the SAP systems via SAPRouter. If you do not specify a router string, TEO accesses the SAP system directly. The router string must be formatted as: /H/host01/H/host02/H/ where host01 and host02 are the SAP systems that you want to access through the SAPRouter. Choose the user account that contains the credentials to connect to the target from the drop-down list. To view the properties for the selected runtime user, click the Properties tool. To create a new SAP User, click New > SAP User. See Cisco TEO Getting Started Guide for SAP. Step 6 Click Next. 2-11

30 Creating SAP System Targets Chapter 2 Managing SAP Java Targets Figure 2-13 Server Availability Step 7 The Server Availability panel is used to specify the SAP application servers that you want to monitor for availability and the ability to log in a user. Specify the following information: Servers available for monitoring Add Remove Select All Deselect All All detected servers are checked by default. Verify that the check box next to each server that you want to monitor is checked. If a server is offline during configuration, it will not be displayed in the list of available servers. To manually add the server, click Add and enter the name of the server. If you want to remove a server from the list, select the server and click Remove. If the check boxes have been unchecked and you want all servers to be monitored, click Select All. If all the check boxes are checked and you want to uncheck all of them, click Deselect All. Step 8 Click Next. If you are configuring the SAP database, the Database Connection panel displays. Otherwise, proceed to Step

31 Chapter 2 Managing SAP Java Targets Creating SAP System Targets Figure 2-14 Database Connection Step 9 Step 10 Choose the Database type from the drop-down list to display the fields for the specific type of database. Specify the information for the type of database that is being configured. The fields that display depend on the database type. Server Hostname or data source SID Database name Database owner Database source Port Number Default timeout for activities (seconds) Enter the name of the SAP application server where the database resides. Name of the host server or data source for the Oracle or Generic database. System ID for the server where the Oracle database resides. Enter the name of the SAP database that is associated with the SAP system. Enter the name of the user that owns the rights to the database. Enter the Data source to connect to the database. Enter the Port number used to connect to the database. Enter the number of seconds before the activity times out. The default timeout period is 120 seconds. 2-13

32 Creating SAP System Targets Chapter 2 Managing SAP Java Targets Default runtime user Connection string Choose the user account that contains the credentials to connect to the database from the drop-down list. To view the properties for the selected runtime user, click the Properties tool. To create a new runtime user, click New > Runtime User. If the database has a custom connection string label appended to the name, check the check box and modify the string in the text field. Step 11 Click Next. Figure 2-15 Java Connection Step 12 The Java Connection panel is used to specify the Java application servers that are used to connect to the SAP system. If the application servers are already configured, they display in the list box. If the server is in the list box, click Next. Otherwise, click New to open the New SAP Java Application Server Wizard and add the servers. 2-14

33 Chapter 2 Managing SAP Java Targets Creating SAP System Targets Figure 2-16 New SAP Java Application Server Wizard General Information Panel Step 13 Specify a name and description for the Java server in the following text fields: Display name Enter the name of the server that will be displayed in the Targets pane. Enter a text description for the server. Step 14 Click Next. Figure 2-17 New SAP Java Application Server Wizard JMX Connection 2-15

34 Creating SAP System Targets Chapter 2 Managing SAP Java Targets Step 15 Use the JMX Connection panel to specify the connection information to connect to the Java application server. You connect to the Java application server using a JMX connection. You can also configure to connect to the application server using a Telnet connection. Specify the information for connecting to the SAP Java application server: Application server JMX Connection JMX port Use credentials of the following runtime user Monitor as Portal Central Instance Enable Telnet connection Enter the IP address or name of the SAP Java application server. Enter the JMX port number used to connect to the Java application server. Choose the default runtime user that contains the credentials to connect to the target from the drop-down list. Note The runtime user must be a J2EE Admin account. To view the properties for the selected runtime user, click the Properties tool. To create a new runtime user, click New > Runtime User. Check the check box to run processes designed for portals on this Java server. Check the check box to run processes designed for central instances on this Java server. Check this check box if you want to specify the Telnet connection information to connect to the Java application server. Step 16 Click Next. If you enabled the Telnet Connection, the Telnet Connection panel displays. 2-16

35 Chapter 2 Managing SAP Java Targets Creating SAP System Targets Figure 2-18 New SAP Java Application Server Wizard Telnet Connection Step 17 Specify the Telnet connection information for connecting to the Java application server: Telnet port Enter the Telnet port number used to connect to the Java application server. Use credentials of the following runtime user Choose the default runtime user that contains the credentials to connect to the target from the drop-down list. Note The runtime user must be a J2EE Admin account. To view the properties for the selected runtime user, click the Properties tool. To create a new runtime user, click New > Runtime User. Step 18 Click Next. 2-17

36 Creating SAP System Targets Chapter 2 Managing SAP Java Targets Figure 2-19 Completing the New SAP Java Application Server Wizard Step 19 Step 20 Verify that the information is correct and click Finish to add the SAP Java application server. After adding the Java application server, click Next on the Java Connection panel. Figure 2-20 Completing the New SAP System Wizard Step 21 Verify that the information is correct and click Finish to complete the procedure. The SAP system, SAP ABAP Connection, SAP Java Connection and SAP Database Connection display in the Targets pane. 2-18

37 Chapter 2 Managing SAP Java Targets Managing SAP Targets Managing SAP Targets Use the Definitions Targets view to manage the SAP targets (such as SAP Systems, SAP ABAP Connections, SAP Java Application Servers, SAP Databases). From this view, you can enable and disable the SAP targets, delete the SAP targets, and view and modify the SAP target properties. Enabling an SAP Target A target is enabled by default after it is created. If a target is manually disabled, it must be enabled before it is available for execution. Step 1 Step 2 On the Definitions Targets view, use one of the following methods to enable the target: In the Targets pane, right-click the SAP System target and choose Enable. In the Targets pane, select the SAP System target and then click the Click here link in the Details pane. Verify that the status in the Enabled column in the Targets pane is True. If necessary, click the Refresh tool to update the view. Disabling an SAP Target Disabling a target prevents it from being available for execution. However, a disabled target is not removed from the list of targets in the Targets pane. Step 1 Step 2 On the Definitions Targets view, use one of the following methods to disable the target: In the Targets pane, right-click the SAP System target and choose Disable. In the Targets pane, select the SAP System target and then click the Click here link in the Details pane. Verify the status in the Enabled column in the Targets pane changes to False. If necessary, click the Refresh tool to update the view. 2-19

38 Managing SAP Targets Chapter 2 Managing SAP Java Targets Deleting an SAP Target Before deleting a target, open the SAP Target Properties dialog box and click the Used By tab to view where objects are being used by the target. This ensures that deleting the target does not affect any processes or activities. Step 1 In the Definitions Targets view, right-click the SAP System target and choose Delete. Figure 2-21 Confirm Delete Step 2 Click Yes to confirm the deletion. The target will be removed from the product. Modifying SAP System Targets Use the Definitions Targets view to display and modify the SAP System target properties. Modifying Display Name and Step 1 Step 2 In the Definitions view, click Targets to display the defined targets in the Targets pane. Double-click the SAP System target, or right-click and choose Properties. 2-20

39 Chapter 2 Managing SAP Java Targets Managing SAP Targets Figure 2-22 SAP System Properties General Tab Step 3 Use the General tab to view or modify the following information: Display name Type Owner Enabled Monitor as production system Name of the SAP system that displays in the Targets pane. Display only. Type of target. User name of the owner of the target. This is typically the person who created the target. Click the Browse tool to change the owner. Text field for entering a description of the target. Check or uncheck the check box to enable or disable the target. The check box is checked by default to indicate the target is enabled. Check or uncheck the check box to indicate whether the system is to be monitored as a production system. Certain processes only run on production systems. Therefore, if you uncheck the check box, the system will be monitored as a non-production system (sandbox or development) and some processes will not run on it. Step 4 Click OK to save your changes and close the dialog box. 2-21

40 Managing SAP Targets Chapter 2 Managing SAP Java Targets Modifying ABAP Application Server Connection Information If the system is configured for both an ABAP application server and Java server, you can modify the ABAP application server or change the default runtime user record that connects to the application server. You use the ABAP tab on the SAP System Properties dialog box to modify the ABAP application server connection information. Note See the Cisco TEO Adapter Guide for SAP ABAP for information on modifying the ABAP application server connection information. Modifying SAP Database If the system is configured for both an ABAP application server and Java server, you can modify the connection information for the database that is associated with the SAP system. You use the Database tab on the SAP System Properties dialog box to modify the SAP database connection information. Note See the Cisco TEO Adapter Guide for SAP ABAP for information on modifying the SAP database connection information. Modifying Java Application Server Connection Information You can modify the Java application server or change the default runtime user record that connects to the application server. Step 1 Step 2 Step 3 In the Definitions view, click Targets to display the defined targets in the Targets pane. Double-click the SAP System target, or right-click and choose Properties. On the SAP System Properties dialog box, click the Java Connection tab. Figure 2-23 SAP System Properties Java Connection Tab 2-22

41 Chapter 2 Managing SAP Java Targets Managing SAP Targets Step 4 Step 5 To view or modify the properties of the current SAP Java application server, select it in the list and click Properties. On the SAP Java Application Server Properties dialog box, click the Connection tab. Figure 2-24 SAP Java Application Server Properties Connection Tab Step 6 Use the Connection tab to modify the following connection information: Application server JMX Connection JMX port Use credentials of the following runtime user Monitor as Portal Central Instance IP address or name of the SAP Java application server. JMX port number used to connect to the Java application server. From the drop-down list, choose the default runtime user that contains the credentials to connect to the Java application server. Note The runtime user must be a J2EE Admin account. To view or modify the properties for the selected runtime user, click the Properties tool. To create a new runtime user, click New > Runtime User. Check the check box to run processes designed for portals on this Java server. Enter the number of minutes to indicate how often to collect SAP IView data. Check the check box to run processes designed for central instances on this Java server. 2-23

42 Managing SAP Targets Chapter 2 Managing SAP Java Targets Step 7 If you are using Telnet to connect to the Java application server, click the Telnet tab to view or modify the connection properties. Figure 2-25 SAP Java Application Server Properties Telnet Tab Step 8 Use the Telnet tab to modify the following connection information: Enable Telnet connection Telnet port Use credentials of the following runtime user Check or uncheck the check box to enable or disable the Telnet connection to the Java application server. Telnet port number used to connect to the Java application server. From the drop-down list, choose the default runtime user that contains the credentials to connect to the Java application server. Note The runtime user must be a J2EE Admin account. To view or modify the properties for the selected runtime user, click the Properties tool. To create a new runtime user, click New > Runtime User. Step 9 Click OK to save your changes and close the dialog box. 2-24

43 Chapter 2 Managing SAP Java Targets Managing SAP Targets Viewing Member Of Properties You can view the target groups to which a target belongs using the Member Of tab on the SAP System Properties dialog box. Step 1 Step 2 Step 3 In the Definitions view, click Targets to display defined targets in the Targets pane. Double-click the SAP System target, or right-click and choose Properties. On the SAP System Properties dialog box, click the Member Of tab. Figure 2-26 SAP System Properties Member Of Tab Step 4 Step 5 Step 6 In the list box, view the target groups that the target is a member. To view the properties of a specific target group, right-click and choose Properties. Click OK to close the dialog box. 2-25

44 Managing SAP Targets Chapter 2 Managing SAP Java Targets Viewing Extended Properties You can view the list of extended target properties defined for a specific target type using the Extended Properties tab on the SAP System Properties dialog box. Step 1 Step 2 Step 3 In the Definitions view, click Targets to display the defined targets in the Targets pane. Double-click the SAP System target, or right-click and choose Properties. On the SAP System Properties dialog box, click the Extended Properties tab. Figure 2-27 SAP System Properties Extended Properties Tab Step 4 Step 5 In the list box, view the extended target properties that are assigned to the target. To modify a target property, right-click and choose Edit. Note For additional information on Extended Target Properties, see the Tidal Enterprise Orchestrator Reference Guide. Step 6 Click OK to close the dialog box. 2-26

45 Chapter 2 Managing SAP Java Targets Managing SAP Targets Viewing Used By Properties You can view the objects that are directly associated with the selected target (for example, an SAP system or process) using the Used By tab on the SAP System Properties dialog box. Step 1 Step 2 Step 3 In the Definitions view, click Targets to display the defined targets in the Targets pane. Double-click the SAP System target, or right-click and choose Properties. On the SAP System Properties dialog box, click the Used By tab. Figure 2-28 SAP System Properties Used By Tab Step 4 Step 5 Step 6 View the objects that are used the target in the list box. To view the properties of a specific target group, right-click and choose Properties. Click OK to close the dialog box. 2-27

46 Managing SAP Targets Chapter 2 Managing SAP Java Targets Viewing Target History You can view the history of changes that have been made to the target using the History tab on the SAP System Properties dialog box. Step 1 Step 2 Step 3 In the Definitions view, click Targets to display the defined targets in the Targets pane. Double-click the SAP System target, or right-click and choose Properties. On the SAP System Properties dialog box, click the History tab. Figure 2-29 SAP System Properties History Tab Step 4 Step 5 Step 6 View the changes that have been made to the target. To view the audit history for a specific action in the list box, right-click the item and choose Properties. Click OK to close the dialog box. 2-28

47 Chapter 2 Managing SAP Java Targets Managing SAP Targets Modifying an SAP Java Application Server Target Use the Definitions Targets view to display and modify the SAP Java Application Server target. Modifying Display Name and Step 1 Step 2 In the Definitions view, click Targets to display the defined targets in the Targets pane. Double-click the SAP Java Application Server target, or right-click and choose Properties. Figure 2-30 SAP Java Application Server Properties General Tab Step 3 Use the General tab to view or modify the following information: Display name Type Owner Status Status information Organization Name of the SAP server that displays in the Targets pane. Display only. Type of target. User name of the owner of the target. This is typically the person who created the target. Click the Browse tool to change the owner. Display only. The current status of the target. Display only. Information about the target status. Name of the company that supports the target. 2-29

48 Managing SAP Targets Chapter 2 Managing SAP Java Targets Enabled Text field for entering information that describes the target. Check or uncheck the check box to enable or disable the target. The check box is checked by default to indicate the target is enabled. Step 4 Click OK to save your changes and close the dialog box. Modifying JMX Connection Information You can modify the JMX connection information for the application server, change the default runtime user, and modify the monitoring options. Step 1 Step 2 Step 3 In the Definitions view, click Targets to display the defined targets in the Targets pane. Double-click the SAP Java Application Server target, or right-click and choose Properties. On the SAP Java Application Server Properties dialog box, click the Connection tab. Figure 2-31 SAP Java Application Server Properties Connection Tab 2-30

49 Chapter 2 Managing SAP Java Targets Managing SAP Targets Step 4 Use the Connection tab to view or modify the following connection information: Application server JMX Connection JMX port Use credentials of the following runtime user Monitor as Portal Central Instance IP address or name of the SAP Java application server. JMX port number used to connect to the Java application server. From the drop-down list, choose the default runtime user that contains the credentials to connect to the Java application server. Note The runtime user must be a J2EE Admin account. To view or modify the properties for the selected runtime user, click the Properties tool. To create a new runtime user, click New > Runtime User. Check or uncheck the check box to indicate whether to run processes designed for portals on this Java server. Enter the number of minutes to indicate how often to collect SAP iview data. Check or uncheck the check box to indicate whether to run processes designed for central instances on this Java server. Step 5 Click OK to save your changes and close the dialog box. 2-31

50 Managing SAP Targets Chapter 2 Managing SAP Java Targets Modifying Telnet Connection Information You can enable or disable the Telnet connection to the application server and change the default runtime user. Step 1 Step 2 Step 3 In the Definitions view, click Targets to display the defined targets in the Targets pane. Double-click the SAP Java Application Server target, or right-click and choose Properties. On the SAP Java Application Server Properties dialog box, click the Telnet tab. Figure 2-32 SAP Java Application Server Properties Telnet Tab Step 4 Use the Telnet tab to modify the following connection information: Enable Telnet connection Telnet port Use credentials of the following runtime user Check or uncheck the check box to enable or disable the Telnet connection to the Java application server. Telnet port number used to connect to the Java application server. From the drop-down list, choose the default runtime user that contains the credentials to connect to the Java application server. Note The runtime user must be a J2EE Admin account. To view or modify the properties for the selected runtime user, click the Properties tool. To create a new runtime user, click New > Runtime User. 2-32

51 Chapter 2 Managing SAP Java Targets Managing SAP Targets Step 5 Click OK to save your changes and close the dialog box. Viewing Member Of Properties You can view the target groups to which a target belongs using the Member Of tab on the SAP Java Application Server Properties dialog box. Step 1 Step 2 Step 3 In the Definitions view, click Targets to display the defined targets in the Targets pane. Double-click the SAP Java Application Server target, or right-click and choose Properties. On the SAP Java Application Server Properties dialog box, click the Member Of tab. Figure 2-33 SAP Java Application Server Properties Member Of Tab Step 4 Step 5 Step 6 In the list box, view the target groups that the target is a member. To view the properties of a specific target group, right-click and choose Properties. Click OK to close the dialog box. 2-33

52 Managing SAP Targets Chapter 2 Managing SAP Java Targets Viewing Extended Properties You can view the list of extended target properties defined for a specific target type using the Extended Properties tab on the SAP System Properties dialog box. Step 1 Step 2 Step 3 In the Definitions view, click Targets to display the defined targets in the Targets pane. Double-click the SAP System target, or right-click and choose Properties. On the SAP System Properties dialog box, click the Extended Properties tab. Figure 2-34 SAP Java Application Server Properties Extended Properties Tab Step 4 Step 5 In the list box, view the extended target properties that are assigned to the target. To modify a target property, right-click and choose Edit. Note For additional information on Extended Target Properties, see the Tidal Enterprise Orchestrator Reference Guide. Step 6 Click OK to close the dialog box. 2-34

53 Chapter 2 Managing SAP Java Targets Managing SAP Targets Viewing Used By Properties You can view the objects that are directly associated with the selected target (for example, an SAP system or process) using the Used By tab on the SAP Java Application Server Properties dialog box. Step 1 Step 2 Step 3 In the Definitions view, click Targets to display the defined targets in the Targets pane. Double-click the SAP Java Application Server target, or right-click and choose Properties. On the SAP Java Application Server Properties dialog box, click the Used By tab. Figure 2-35 SAP Java Application Server Properties Used By Tab Step 4 Step 5 Step 6 View the objects that are used by the target in the list box. To view the properties of a specific target group, right-click the item and choose Properties. Click OK to close the dialog box. 2-35

54 Managing SAP Targets Chapter 2 Managing SAP Java Targets Viewing Target History You can view the history of changes that have been made to the target using the History tab on the SAP Java Application Server Properties dialog box. Step 1 Step 2 Step 3 In the Definitions view, click Targets to display the defined targets in the Targets pane. Double-click the SAP Java Application Server target, or right-click and choose Properties. On the SAP Java Application Server Properties dialog box, click the History tab. Figure 2-36 SAP Java Application Server Properties History Tab Step 4 Step 5 Step 6 View the changes that have been made to the target. To view the audit history for a specific action, right-click the item and choose Properties. Click OK to close the dialog box. 2-36

55 CHAPTER 3 Using SAP Java Activities The SAP Java activities enable you to create processes specific to your SAP Java environment. When defining an activity in the process workflow, the properties pane contains property pages that are specific to the selected activity. This chapter provides instructions for defining SAP Java activities, instructions for completing the property pages for each specific SAP Java activity, and instructions on viewing the activity results. It includes the following sections: SAP Java Activities, page 3-2 Defining an SAP Java Activity, page 3-3 Defining iview Portal Metrics Activity, page 3-6 Defining Read Generic Java File Activity, page 3-9 Defining SAP Java Shell Command Activity, page 3-15 Defining Start Java Application Activity, page 3-19 Defining Start Java Service Activity, page 3-21 Defining Stop Java Application Activity, page 3-24 Defining Stop Java Service Activity, page

56 SAP Java Activities Chapter 3 Using SAP Java Activities SAP Java Activities The SAP Java Adapter provides activities for managing and monitoring your SAP Java environment. The following table displays the activities that are available in the product. Activity Name iview Portal Metrics Read Generic File Read Java Log SAP Java Shell Command Start Java Application Start Java Service Stop Java Application Stop Java Service Collects various metrics related to iviews from the SAP Java server. See Defining iview Portal Metrics Activity, page 3-6. Retrieves and parses all files on an SAP Java server. See Defining Read Generic Java File Activity, page 3-9. Retrieves and parses one or more Java logs on an SAP Java server. See Defining Read Java Log Activity, page Executes a shell command on an SAP Java server. See Defining SAP Java Shell Command Activity, page Starts one or all Java applications on J2EE Engine servers. See Defining Start Java Application Activity, page Starts a service on J2EE Engine servers. See Defining Start Java Service Activity, page Stops one or all Java applications on J2EE Engine servers. See Defining Stop Java Application Activity, page Stops a service on J2EE Engine servers. See Defining Stop Java Service Activity, page

57 Chapter 3 Using SAP Java Activities Defining an SAP Java Activity Defining an SAP Java Activity Use the following steps to define an SAP Java Adapter activity in the Process Editor. The property pages that display depend on the activity. Refer to the appropriate section for instructions on completing the activity property pages. Step 1 On the Toolbox pane, navigate to the SAP Java section, click the activity and drag it onto the Workflow pane. The Activity Properties dialog box displays. Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. The Insert Wildcard tool displayed next to a text field indicates that you can select a wildcard to include in the field. The Reference tool displayed next to a text field indicates that you can select a defined variable or reference an object within the process. For additional information, see the Tidal Enterprise Orchestrator Reference Guide. Step 2 On the General tab, enter the following information: Display name Type Name of the activity. Display only. Displays the type of activity. Text description of the activity. Step 3 Step 4 Click the Activity-specific tab and enter the required information. See the appropriate section in this chapter for instructions on completing the fields on the activity-specific tab. Click the Target tab to specify the process target. You can use the process target or override it and specify a different target for the specific activity. Execute on the process target Click this radio button to use the same target that was specified for the process. Execute on activity target Click this radio button to indicate that the activity should execute against a target selected in an activity within the process. Choose the activity from the drop-down list. Execute on this target Click this radio button and then click the Browse tool to launch the Select Target dialog box and choose a specific target on which to execute the activity. The targets that display in the Select Target dialog box are targets already defined in TEO. To view the properties for the selected target, click the Properties tool. 3-3

58 Defining an SAP Java Activity Chapter 3 Using SAP Java Activities Execute on this target reference Execute on the target selected by this algorithm Click this radio button and then click the Reference tool to select the target reference property on which to execute the activity. You can also click the click the Browse tool to launch the Select Target dialog box and choose a specific target on which to execute the activity. Click this radio button to execute the target selected by one of the target algorithms displayed in the drop-down menu. Note The available algorithms that display depend on the selected activity. Execute on this target group Click this radio button and then click the Browse tool to launch the Select Target Group dialog box and choose a specific target on which to execute the activity. The target groups that display in the Select Target Group dialog box are target groups already defined in TEO. To view the properties for the selected target group, click the Properties tool. From the Choose a target using this algorithm drop-down list, select the algorithm which will determine the target to execute from the eligible target group. Note The available algorithms that display depend on the selected activity. Step 5 Click the Credentials tab to specify the runtime user whose credentials should be used for process execution: Use target's default runtime user Use process runtime user Override process runtime user Click this radio button to use the default runtime user for the target that is specified in the activity. Click this radio button to use the credentials for the runtime user that was specified for the process. Click this radio button to specify different credentials than what are used for the process. The selected runtime user overrides the runtime user that was specified for the process. To view the properties for the selected runtime user, click the Properties tool. To create a runtime user record for the process, click New. For additional information on creating a runtime users, see the Tidal Enterprise Orchestrator Reference Guide. 3-4

59 Chapter 3 Using SAP Java Activities Defining an SAP Java Activity Step 6 Click the Knowledge Base tab to specify a knowledge base article for the activity. The following information displays: Knowledge base Summary Possible Cause Possible resolution Related information Knowledge base article associated with the activity. Brief description of the issue. Explanation of the condition that may be causing the issue. List of actions that can be performed to attempt to resolve the issue. Additional information related to the issue. a. If the knowledge base article is not displayed by default, click the Browse tool in the Knowledge Base field. b. On the Select Knowledge Base dialog box, select the appropriate knowledge base article in the list and click OK. Note Click New to create a new knowledge base article. For additional information on knowledge base articles, see the Tidal Enterprise Orchestrator Reference Guide. Step 7 Click the Result Handlers tab to specify condition branches for the activity. Button Add Remove Move Up Move Down Adds a condition branch. Removes the condition branch from the activity. Moves the condition up one position in the list of conditions. Moves the condition down one position in the list of conditions. Step 8 Click the Save tool to save the activity definition. 3-5

60 Defining iview Portal Metrics Activity Chapter 3 Using SAP Java Activities Defining iview Portal Metrics Activity Use the iview Portal Metrics activity to collect various metrics related to iviews from an SAP Java server. Step 1 On the Toolbox, click the iview Portal Metrics activity and drag it onto the Workflow pane. Figure 3-1 iview Portal Metrics Properties General Tab Step 2 On the General tab, enter the following information: Display name Type Name of the activity. Display only. Type of activity generated. Text description of the activity. Step 3 Click the IView Portal Metrics tab. Figure 3-2 iview Portal Metrics Properties iview Portal Metrics Tab 3-6

61 Chapter 3 Using SAP Java Activities Defining iview Portal Metrics Activity Step 4 On the iview Portal Metrics tab, specify the following information: iview component name Sort column Sort order Limit number of rows returned Name of the iview component for which the metrics should be collected. Enter a wildcard (*) to collect metrics for all iview components. Choose the column name by which to sort the results. Choose the order in which the results are sorted (Ascending or Descending). Check the check box and enter the number of rows to include in the output. Step 5 Complete the appropriate information in the following tabs: Target Specify whether the defined process target should be used or overridden. Knowledge Base Select the appropriate knowledge base article to associate with the process. Result Handlers Click the appropriate buttons to manage the condition branches on the workflow. Step 6 Click the Save tool to complete the activity definition. Viewing iview Portal Metrics Results When the iview Portal Metrics activity is executed, results are displayed in the Operations workspace activity instance view. Step 1 Step 2 Step 3 Step 4 In the Operations workspace, expand the Activity Views folder and then click the view that represents how the process was executed (for example, View Adhoc if the process was manually executed). In the results pane, expand the process, and double-click the activity instance or right-click and choose Properties. On the iview Portal Metrics Properties dialog box, click the iview Portal Metrics tab to view the activity properties. Click the Result tab to view the results. 3-7

62 Defining iview Portal Metrics Activity Chapter 3 Using SAP Java Activities Figure 3-3 iview Portal Metrics Properties Result Tab The following information displays: Column Component Name Number of calls Average CPU Time (ms) Average Response Time (ms) Average Net Time (ms) Average Outbound Data (bytes) Name of the iview component for which metrics were collected. Number of calls made for the specified component. Average CPU time, in milliseconds, that was utilized by calls for the specified iview component. Average response time, in milliseconds, for calls made for the specified iview component. Average net time, in milliseconds, for calls made for the specified iview component. Average outbound data rate, in bytes, for the specified iview component. Step 5 Click Close to close the dialog box. 3-8

63 Chapter 3 Using SAP Java Activities Defining Read Generic Java File Activity Defining Read Generic Java File Activity Use the Read Generic Java File activity to retrieve and parse any Java file on an SAP Java server. Step 1 On the Toolbox, click the Read Generic Java File activity and drag it onto the Workflow pane. Figure 3-4 Read Generic Java File Properties General Tab Step 2 On the General tab, enter the following information: Display name Type Name of the activity. Display only. Type of activity generated. Text description of the activity. Step 3 Click the Read Generic File tab. Figure 3-5 Read Generic Java File Properties Read Generic File Tab 3-9

64 Defining Read Generic Java File Activity Chapter 3 Using SAP Java Activities Step 4 On the Read Generic File tab, specify the following information: Java file Match pattern Exclude patterns Maximum number of entries Time out if not completed within Name of the Java file or a variable that contains the name of the file to be retrieved. A grep pattern to match log entries within log files. A comma-delimited list of filter patterns to be excluded from log entries. Wildcards are allowed. Number of log files to be read. Check the check box to specify a time out interval (seconds, minutes) within which the activity must complete. The default is 60 seconds. If the activity does not complete within the specified time out interval, the activity will fail with Failed (Not Completed) status. Step 5 Complete the appropriate information in the following tabs: Target Specify whether the defined process target should be used or overridden. Knowledge Base Select the appropriate knowledge base article to associate with the process. Result Handlers Click the appropriate buttons to manage the condition branches on the workflow. Step 6 Click the Save tool to complete the activity definition. Viewing Read Generic Java File Results When the Read Generic Java File activity is executed, results are displayed in the Operations workspace activity instance view. Step 1 Step 2 Step 3 Step 4 In the Operations workspace, expand the Activity Views folder and then click the view that represents how the process was executed (for example, View Adhoc if the process was manually executed). In the results pane, expand the process, and double-click the activity instance or right-click and choose Properties. On the Read Generic Java File Properties dialog box, click the Read Generic File tab to view the activity properties. Click the Result tab to view the results. 3-10

65 Chapter 3 Using SAP Java Activities Defining Read Generic Java File Activity Figure 3-6 Read Generic Java File Properties Result Tab The following information displays: Column Cluster ID File Lines Java cluster ID. Name of the file retrieved. Number of lines retrieved. Step 5 Click Close to close the dialog box. 3-11

66 Defining Read Java Log Activity Chapter 3 Using SAP Java Activities Defining Read Java Log Activity Use the Read Java Log activity to retrieve and parse one or more Java logs on an SAP Java server. Step 1 On the Toolbox, click the Read Java Log activity and drag it onto the Workflow pane. Figure 3-7 Read Java Log Properties General Tab Step 2 On the General tab, enter the following information: Display name Type Name of the activity. Display only. Type of activity generated. Text description of the activity. Step 3 Click the Read Java Log tab. 3-12

67 Chapter 3 Using SAP Java Activities Defining Read Java Log Activity Figure 3-8 Read Java Log Properties Read Java Log Tab Step 4 On the Read Java Log tab, specify the following information: Log File Log Count Match Pattern Exclude Patterns Cluster ID Maximum time frame for specified log entries Maximum number of entries Time out if not completed within Log file name (for example, server or database). Number of logs to parse (log number is a suffix of a log file name). A grep pattern to match log entries within log files. A list of filter patterns to exclude log entries. Java Cluster ID. Displays log entries within a specified time window. Check the check box and enter the appropriate time window. The default window is the last 60 seconds. Uncheck the check box to disable the Time Window field. Read only log entries up to the specified number. Check the check box to specify a time out interval (seconds, minutes) with which the activity must complete. The default is 60 seconds. If the activity does not complete within the specified time out interval, the activity will fail with Failed (Not Completed) status. 3-13

68 Defining Read Java Log Activity Chapter 3 Using SAP Java Activities Step 5 Complete the appropriate information in the following tabs: Target Specify whether the defined process target should be used or overridden. Knowledge Base Select the appropriate knowledge base article to associate with the process. Result Handlers Click the appropriate buttons to manage the condition branches on the workflow. Step 6 Click the Save tool to complete the activity definition. Viewing Read Java Log Results When the Read Java Log activity is executed, results are displayed in the Operations workspace activity instance view. Step 1 Step 2 Step 3 Step 4 In the Operations workspace, expand the Activity Views folder and then click the view that represents how the process was executed (for example, View Adhoc if the process was manually executed). In the results pane, expand the process, and double-click the activity instance or right-click and choose Properties. On the Read Java Log Properties dialog box, click the Read Java Log tab to view the activity properties. Click the Result tab to view the results. Figure 3-9 Read Java Log Properties Result Tab 3-14

69 Chapter 3 Using SAP Java Activities Defining SAP Java Shell Command Activity The following information displays: Column Component ID Log File Name Date Time Severity Category Location User Message Application Full Message Java component ID. Java log file name. Date and Time of a log entry. Log severity, Error, Info, etc. Category of log entries (for example, /System/Server). Time when the value was retrieved. User of a portal action. Message description of a log entry. Portal application (for example, sap.com/irj). A complete log line. Step 5 Click Close to close the dialog box. Defining SAP Java Shell Command Activity Use the SAP Java Shell Command activity to execute a shell command on an SAP Java server. The activity supports only SAP targets that use a Telnet connection. Step 1 On the Toolbox, click the SAP Java Shell Command activity and drag it onto the Workflow pane. Figure 3-10 SAP Java Shell Command Properties General Tab 3-15

70 Defining SAP Java Shell Command Activity Chapter 3 Using SAP Java Activities Step 2 On the General tab, enter the following information: Display name Type Name of the activity. Display only. Type of activity generated. Text description of the activity. Step 3 Click the SAP Java Shell Command tab. Figure 3-11 SAP Java Shell Command Properties SAP Java Shell Command Tab Step 4 Click Browse to open the Select Shell Command dialog box and auto-populate the Command and Command Group fields on the page (see Selecting a Shell Command, page 3-17), or manually enter the information in the following fields: Command Command Group Parameter SAP Java Component Time out if not completed within Shell command name. Name of command group. Command parameters. Java Component ID. Time out interval (seconds, minutes) within which the Shell command must complete. The default is 60 seconds. If the command does not complete within the specified time out interval, the activity will fail with Failed (Not Completed) status. Click the time unit link to change the timed out interval from seconds to minutes. Uncheck the check box to disable the field. 3-16

71 Chapter 3 Using SAP Java Activities Defining SAP Java Shell Command Activity Step 5 Complete the appropriate information in the following tabs: Target Specify whether the defined process target should be used or overridden. Knowledge Base Select the appropriate knowledge base article to associate with the process. Result Handlers Click the appropriate buttons to manage the condition branches on the workflow. Step 6 Click the Save tool to complete the activity definition. Selecting a Shell Command Use the Select Shell Command dialog box to select the appropriate shell command for the shell command activity. After selecting the command from the list, the information automatically populates the Command and Command Group fields on the Shell Command tab. Step 1 On the Shell Command tab, click Browse to open the Select Shell Command dialog box. Figure 3-12 Select Shell Command Step 2 Select the appropriate item from the Shell Command List and then click OK. The selected items auto-populate the fields on the Shell Command tab. 3-17

72 Defining SAP Java Shell Command Activity Chapter 3 Using SAP Java Activities Viewing SAP Java Shell Command Results When the SAP Java Shell Command activity is executed, results are displayed in the Operations workspace activity instance view. Step 1 Step 2 Step 3 Step 4 In the Operations workspace, expand the Activity Views folder and then click the view that represents how the process was executed (for example, View Adhoc if the process was manually executed). In the results pane, expand the process, and double-click the activity instance or right-click and choose Properties. On the SAP Java Shell Command Properties dialog box, click the SAP Java Shell Command tab to view the activity properties. Click the Result tab to view the results. Figure 3-13 SAP Java Shell Command Properties Result Tab The following information displays: Result A description of the command. Displays output of the J2EE telnet administration console command. The J2EE application server has a predefined set of shell commands which you can execute on the different J2EE Engine cluster elements. Step 5 Click Close to close the dialog box. 3-18

73 Chapter 3 Using SAP Java Activities Defining Start Java Application Activity Defining Start Java Application Activity Use the Start Java Application activity to start applications on J2EE servers. Step 1 On the Toolbox, click the Start Java Application activity and drag it onto the Workflow pane. Figure 3-14 Start Java Application Properties General Tab Step 2 On the General tab, enter the following information: Display name Type Name of the activity. Display only. Type of activity generated. Text description of the activity. Step 3 Click the Start Java Application tab. Figure 3-15 Start Java Application Properties Start Application Tab 3-19

74 Defining Start Java Application Activity Chapter 3 Using SAP Java Activities Step 4 On the Start Application tab, specify the following information: Application Name Cluster IDs Time out if not completed within Synchronous Name of the application. Enter the wildcard (*) to start all applications. Java Cluster IDs. IDs may be separated by space or commas. Time out interval (seconds, minutes) within which the activity must complete. The default is 60 seconds. If the activity does not complete within the specified time out interval, the activity will fail with Failed (Not Completed) status. Click the time unit link to change the timed out interval from seconds to minutes. Uncheck the check box to disable the field. Check the check box to indicate whether the command output is synchronous (true) or asynchronous (false). Step 5 Complete the appropriate information in the following tabs: Target Specify whether the defined process target should be used or overridden. Knowledge Base Select the appropriate knowledge base article to associate with the process. Result Handlers Click the appropriate buttons to manage the condition branches on the workflow. Step 6 Click the Save tool to complete the activity definition. Viewing Start Java Application Results When the Start Java Application activity is executed, results are displayed in the Operations workspace activity instance view. Step 1 Step 2 Step 3 Step 4 In the Operations workspace, expand the Activity Views folder and then click the view that represents how the process was executed (for example, View Adhoc if the process was manually executed). In the results pane, expand the process, and double-click the activity instance or right-click and choose Properties. On the Start Java Application Properties dialog box, click the Start Java Application tab to view the activity properties. Click the Result tab to view the results. 3-20

75 Chapter 3 Using SAP Java Activities Defining Start Java Service Activity Figure 3-16 Start Java Application Properties Result Tab Step 5 When the synchron switch is specified, the following message displays: Application <app_name> has been started. There is no message detail when the synchron switch is not specified. Click Close to close the dialog box. Defining Start Java Service Activity Use the Start Java Service activity to start a service on J2EE servers. Step 1 On the Toolbox, click the Start Java Service activity and drag it onto the Workflow pane. Figure 3-17 Start Java Service Properties General Tab 3-21

76 Defining Start Java Service Activity Chapter 3 Using SAP Java Activities Step 2 On the General tab, enter the following information: Display name Type Name of the activity. Display only. Type of activity generated. Text description of the activity. Step 3 Click the Start Java Service tab. Figure 3-18 Start Java Service Properties Start Java Service Tab Step 4 Specify the information in the following fields: Service Name Cluster ID Time out if not completed within Name of the service. Use the wildcard (*) to start all services. Java Cluster ID. Time out interval (seconds, minutes) within which the activity must complete. The default is 60 seconds. If the activity does not complete within the specified time out interval, the activity will fail with Failed (Not Completed) status. Click the time unit link to change the timed out interval from seconds to minutes. Uncheck the check box to disable the field. Step 5 Complete the appropriate information in the following tabs: Target Specify whether the defined process target should be used or overridden. Knowledge Base Select the appropriate knowledge base article to associate with the process. Result Handlers Click the appropriate buttons to manage the condition branches on the workflow. 3-22

77 Chapter 3 Using SAP Java Activities Defining Start Java Service Activity Step 6 Click the Save tool to complete the activity definition. Viewing Start Java Service Results When the Start Java Service activity is executed, results are displayed in the Operations workspace activity instance view. Step 1 Step 2 Step 3 Step 4 Step 5 In the Operations workspace, expand the Activity Views folder and then click the view that represents how the process was executed (for example, View Adhoc if the process was manually executed). In the results pane, expand the process, and double-click the activity instance or right-click and choose Properties. On the Start Java Service Properties dialog box, review the activity results in the State field on the General tab. Click the Start Java Service tab to view the activity properties. Click the Result tab to view error messages if the activity failed. Figure 3-19 Start Java Service Properties Result Tab Step 6 When the Start Service activity instance is executed properly, no result message is returned. If there is any error, it will return an error message. For example, if the service name is not correct, then an error message similar to the following displays: >startservice test [Shell -> STARTSERVICE] Could not start the service 'test'! [Shell -> STARTSERVICE] Reason : com.sap.default:name=test,j2eetype=sap_j2eeservicepernode,sap_j2eeclusternode= ,sa P_J2EECluster=NW1 not in repository Click Close to close the dialog box. 3-23

78 Defining Stop Java Application Activity Chapter 3 Using SAP Java Activities Defining Stop Java Application Activity Use the Stop Java Application activity to stop an application on J2EE servers. Step 1 On the Toolbox, click the Stop Java Application activity and drag it onto the Workflow pane. Figure 3-20 Stop Java Application Properties General Tab Step 2 On the General tab, enter the following information: Display name Type Name of the activity. Display only. Type of activity generated. Text description of the activity. Step 3 Click the Stop Java Application tab. Figure 3-21 Stop Java Application Properties Stop Java Application Tab 3-24

79 Chapter 3 Using SAP Java Activities Defining Stop Java Application Activity Step 4 Specify the information in the following fields: Application Name Cluster ID Time out if not completed within Name of the application. Use the wildcard (*) to stop all applications. Java Cluster ID. Time out interval (seconds, minutes) within which the activity must complete. The default is 60 seconds. If the activity does not complete within the specified time out interval, the activity will fail with Failed (Not Completed) status. Click the time unit link to change the timed out interval from seconds to minutes. Uncheck the check box to disable the field. Step 5 Complete the appropriate information in the following tabs: Target Specify whether the defined process target should be used or overridden. Knowledge Base Select the appropriate knowledge base article to associate with the process. Result Handlers Click the appropriate buttons to manage the condition branches on the workflow. Step 6 Click the Save tool to complete the activity definition. Viewing Stop Java Application Results When the Stop Java Application activity is executed, results are displayed in the Operations Workspace activity instance view. Step 1 Step 2 Step 3 Step 4 In the Operations workspace, expand the Activity Views folder and then click the view that represents how the process was executed (for example, View Adhoc if the process was manually executed). In the results pane, expand the process, and double-click the activity instance or right-click and choose Properties. On the Stop Java Application Properties dialog box, click the Stop Java Application tab to view the activity properties. Click the Result tab to view the results. 3-25

80 Defining Stop Java Service Activity Chapter 3 Using SAP Java Activities Figure 3-22 Stop Java Application Properties Result Tab Step 5 When the synchron switch is specified, the following message displays: Application <app_name> has been stopped. There is no message detail when the synchron switch is not specified. Click Close to close the dialog box. Defining Stop Java Service Activity Use the Stop Java Service activity to stop a service on J2EE servers. Step 1 On the Toolbox, click the Stop Java Service activity and drag it onto the Workflow pane. Figure 3-23 Stop Java Service Properties General Tab 3-26

81 Chapter 3 Using SAP Java Activities Defining Stop Java Service Activity Step 2 On the General tab, enter the following information: Display name Type Name of the activity. Display only. Type of activity generated. Text description of the activity. Step 3 Click the Stop Java Service tab. Figure 3-24 Stop Java Service Properties Stop Service Tab Step 4 Specify the information in the following fields: Service Name Cluster ID Time out if not completed within Name of the service. Use the wildcard (*) to start all services. Java Cluster ID. Time out interval (seconds, minutes) within which the activity must complete. The default is 60 seconds. If the activity does not complete within the specified time out interval, the activity will fail with Failed (Not Completed) status. Click the time unit link to change the timed out interval from seconds to minutes. Uncheck the check box to disable the field. Step 5 Complete the appropriate information in the following tabs: Target Specify whether the defined process target should be used or overridden. Knowledge Base Select the appropriate knowledge base article to associate with the process. Result Handlers Click the appropriate buttons to manage the condition branches on the workflow. 3-27