Dell · EMC IONIX IT AUTOMATOR SERVER AND MANAGEMENT CONSOLE USER GUIDE iii Table of Contents 1 Preface ix Part I: EMC Ionix IT Automator Server Server Concepts 11 Overview .

EMC® Ionix™ IT Automator

Server and Management ConsoleUser Guide

Release: 6.0REV: A02

March 2010300-010-272

EMC CorporationCorporate Headquarters:

Hopkinton, MA 01748-9103

1-508-435-1000www.EMC.com

EMC®

test

EMC Ionix IT Automator

Server and Management ConsoleUser Guide

Date: March 2010Release: 6.0

Rev: A02 Document Number: 300-010-272

EMC CorporationCorporate Headquarters,

Hopkin, MA 01748-9103U.S.A.

Tel. 1-508-435-1000

http://www.EMC.com

iii RELEASE: 6.0 REV: A02 300-010-272

Copyright © 2010 EMC Corporation. All rights reserved.Published March, 2010

EMC believes the information in this publication is accurate as of its publication date. The information issubject to change without notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATION MAKES NOREPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION INTHIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABIL-ITY OR FITNESS FOR A PARTICULAR PURPOSE.

Use, copying, and distribution of any EMC software described in this publication requires an applicablesoftware license.

For the most up-to-date regulatory document for your product line, go to the Technical Documentationand Advisories section on EMC Powerlink.

For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.All other trademarks used herein are the property of their respective owners.

v RELEASE 6.0 REV: A02 300-010-272

Table of Contents 1Preface ix

Part I: EMC Ionix IT Automator Server

Server Concepts 11Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1Automator Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2Server Management Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2Integrated Development Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2

Metalinks, Metascripts, and Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-2Executing a Process vs. Starting a Metalink . . . . . . . . . . . . . . . . . . . . . . . . . .1-3Configuring a Metalink vs. Starting a Metalink . . . . . . . . . . . . . . . . . . . . . . .1-3

Primary Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4Processing Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4Virtual Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4Clients and Client Machines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5User Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

Server Services 21Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1Controlling the Automator Server with Windows Services . . . . . . . . . . . . . . 2-2

Starting the Automator using Windows Services . . . . . . . . . . . . . . . . . . . .2-2Stopping the Automator using Windows Services . . . . . . . . . . . . . . . . . . .2-3

Controlling the Automator with the Server Console . . . . . . . . . . . . . . . . . . . . 2-3Starting the Automator using the Server Console . . . . . . . . . . . . . . . . . . . .2-3Stopping the Automator Server using the Server Console . . . . . . . . . . . .2-4Server Console Java Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-4Starting and Stopping Java Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-6Configuring Java Services to Start Automatically . . . . . . . . . . . . . . . . . . . .2-7

engine-console.properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7How to Change the JVM Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10

Changing the JVM Size for a Primary Service . . . . . . . . . . . . . . . . . . . . . . 2-10Changing the JVM Size for the Service Manager . . . . . . . . . . . . . . . . . . . 2-10

Server Log Files 31Log Files Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Client Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-1Server Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-2Management Console Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-2Web Service Gateway Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-3

Logging Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3Service Manager and Client Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4Changing the Log Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4

EMC IONIX IT AUTOMATOR SERVER AND MANAGEMENT CONSOLE USER GUIDE iii

Log Properties File Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-5Logging Level Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-5

Setting Debug Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5Rolling and Purging Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6Capturing Additional Metalink Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7Viewing Process Execution Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8

Server API 41API Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1Login and Connection Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2

Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-2Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-3Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-3ICredential . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-4UserContext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-4

Server Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6global.xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-6server.xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-7engine-config.xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-9User Context and Data Signer Properties . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12Other Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13

Performance Tuning 51Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1Performance Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Load Distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-2Metalink and Metascript Granularity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-2Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-2Network Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-3Java Virtual Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-3Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-3Process Verification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-4High Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-4Session Persistence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-5Virtual Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-5Subprocesses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-5Database Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-5Access Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-6

Using Caching to Improve Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6Before You Enable Caching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-7When to Change the JVM Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-7

Part II: Server Management Console

Server Management Console Overview 61Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1Starting the Management Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

iv RELEASE 6.0 REV: A02 300-010-272

Getting a User Name and Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2Logging In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-3

Management Console Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4Management Console Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5Server Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7Server Tree Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7Virtual Server Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10

Virtual Server Option Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12Understanding Automator Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14Server Administrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14

Virtual Server Administrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15Automator Developers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15Business Process Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15

Adding and Removing Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-16

Server Security 71Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Logging In as an Server Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-1Security Providers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2Session Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3Administrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4

Defining Server Administrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-5Defining Virtual Server Administrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-6

Virtual Server Security 81Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1Logging In as a Virtual Server Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2

Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-3Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-4

Access Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5Global Access Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-6Process Access Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-9

Defining Security Providers 91Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

Choosing a Security Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-2Changing the Security Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-3Updating Users and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-3

Defining File Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3Adding Users and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-5Replacing the Security File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-8

Defining LDAP Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-8LDAP Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10

Defining NT Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-12

EMC IONIX IT AUTOMATOR SERVER AND MANAGEMENT CONSOLE USER GUIDE v

Managing Virtual Servers 101Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1Creating a Virtual Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3

Creating a New Virtual Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3Creating a Virtual Server from an Archive . . . . . . . . . . . . . . . . . . . . . . . . . . 10-4Creating a Virtual Server Programatically . . . . . . . . . . . . . . . . . . . . . . . . . . 10-5

Starting a Virtual Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6Stopping a Virtual Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6Removing a Virtual Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7

Enabling a Virtual Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7Disabling a Virtual Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7

Archiving a Virtual Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8

Using Service Managers 111Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1

Primary Service Managers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1Processing Server Service Managers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2Choosing a Class Loader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2

Creating a Service Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-3Starting a Service Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-3

Stopping a Service Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-4Removing a Service Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-4

Viewing the Service Distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-4Changing Configured Metalinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-5

Modifying a Metalink Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6Removing a Metalink Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-7Deploying Changed or Re-Configured Metalinks . . . . . . . . . . . . . . . . . . 11-7

Using the Repository 121Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1Using the Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-3

Adding and Removing Repository Items . . . . . . . . . . . . . . . . . . . . . . . . . . 12-3Deploying Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-4Managing Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-5

Managing Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-5Managing Metalinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-7Managing Metascripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-10Managing Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-12Managing Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-12Managing Listeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-13

Starting and Stopping Metalinks 131Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1Service Distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1Starting Metalink Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3

Stopping Metalink Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3

vi RELEASE 6.0 REV: A02 300-010-272

Using Listeners 141Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1Creating Listeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-2

File Listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-3FTP Listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7Email Listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-12Message Queue (JMS) Listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-18

Configuring Listeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-23Starting Listeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-24

Scheduler 151About the Scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1Accessing the Scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-2Adding a New Scheduler Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-3

Adding a new Trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-4Modifying a Trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-6

Viewing Scheduled Job Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-7Currently Executing Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-7Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-7Scheduler Calendar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-9Job Execution History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-10

Monitoring and Reporting 161Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1Installing the Monitoring Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-2Starting and Stopping Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-2System Events and User Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-5

System Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-6User Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-12Limiting Report Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-18Process Execution Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-19Process Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-20Event Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-21Metalink Execution Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-24Listener Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-26Web Services Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-28Clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-29Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-29Restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-30

Index I1

EMC IONIX IT AUTOMATOR SERVER AND MANAGEMENT CONSOLE USER GUIDE vii

viii RELEASE 6.0 REV: A02 300-010-272

Preface 2The EMC Ionix IT AutomatorServer and Management Console User Guide provides descriptions of the EMC Ionix IT Automator Server and Management Console user interface. It also provides instructions on configuring and managing your integration environment using the Server and Management Console.

Intended Audience 2

The intended audience for this manual is personnel responsible for using the EMC Ionix IT Automator Server and Management Console. This includes developers, business analysts and technical managers. It assumes you are familiar with the Java development environment, object-oriented programming, and have a solid understanding of EMC Ionix IT Automator concepts and terminology.

Organization 2

This user guide is divided into two parts:. The first part describes the EMC Ionix IT Automator Server. The second part describes the Management Console.• Part I – EMC Ionix IT Automator Server

— Server ConceptsExplains the terms and concepts used throughout this document. You must have a good grasp of these critical concepts in order to understand and use the software.

— Server ServicesExplains how to use the Server Console to start and stop Server services. It also explains how to run the Server as an NT Service and how to use the HTTP Service which provides an easy way for the Server to handle HTTP requests and execute servlets

— Server Log FilesExplains how to enable and use system logging functions to monitor system activity and troubleshoot unexpected behavior.

— Server APIExplains how to programatically control Server administration functions using a Java program or an Ant task. It explains how to use

EMC IONIX IT AUTOMATOR SERVER AND MANAGEMENT CONSOLE USER GUIDE ix

the API to create and manage virtual servers and service managers, and to configure and run metalinks.

— Performance TuningExplains how to identify the factors that affect performance. These include load distribution, memory and network configuration, logging, access control, and other issues.

• Part II – EMC Ionix IT Automator Server Management Console— Server Management Console Overview

Provides an overview of the Management Console. It explains how to log in, create a password, and navigate on both the Server and Virtual Server Home pages.

— Server SecurityExplains the concept of Server security and role-based permissions. It explains how to select a security provider, define Server session settings, and how to create Server and virtual server administrators.

— Virtual Server SecurityExplains the concept of virtual server security. It explains how to select a security provider, define client session settings, and how to apply access control to each user, group, and resource in the virtual server.

— Defining Security ProvidersExplains how to define a security provider for the Server and for virtual servers. Explains how to implement LDAP security, file security, or NT domain security.

— Managing Virtual ServersProvides a detailed explanation of the concepts and functionality relating to virtual servers. It explains how to create, start, stop, and enable virtual servers. It also explains how to archive them so they can be deployed elsewhere.

— Using Service ManagersExplains how to create service managers on processing servers to optimize load balancing and performance. It explains how to create, view, start, stop, and remove service managers.

— Using the RepositoryExplains how to view or remove metalinks, metascripts, and processes in the virtual server repository. It also explains how to upload process components from a deployment file created in the Management Console.

— Starting and Stopping MetalinksExplains how to start and stop metalinks on specific service managers after initial configuration. It describes the Service Distribution page and explains how to start and stop instances of a metalink.

— Using ListenersExplains how to create and configure listeners that wait for data of files to appear in a file system directory or FTP server and then launch business processes associated with the listener.

— SchedulerExplains how to create and work with scheduled jobs for execution.

x RELEASE 6.0 REV: A02 300-010-272

The chapter explains how to create triggers for the scheduled jobs, and also how to view upcoming jobs and past jobs.

— Monitoring and ReportingExplains how to use the monitoring repository to record Server events related to process model, metalink, metascript, and listener execution and generate pre-built reports based on the repository data to analyze Server and process performance.

Font Conventions 2

• Arial bold is used to describe dialog boxes and menu choices, for example: Start > Programs > install_root > Tools

• Courier fixed-width font is used for code elements (Java, HTML) as well as filenames and directories.

• install_root refers to the directory where the EMC Ionix IT Automator software is installed, for example c:/program files/install_root/Services

• Web addresses are displayed as hyperlinks in the format: http://www.EMC.com

Related Documents 2

For more information on the EMC Ionix IT Automator, refer to the following documents. • EMC Ionix IT Automator Installation and Configuration Guide - Provides

installation instructions for the EMC Ionix IT Automator Server and Integrated Development Environment (IDE).

• EMC Ionix IT Automator Getting Started with the IDE - Provides a hands-on tutorial for novice users of the IDE. It provides step-by-step instructions for creating an EMC Ionix IT Automator application and deploying it to the Server.

• EMC Ionix IT Automator IDE User Guide - Explains how to use the IDE to create effective e-business applications. It includes sections on working with EMC Ionix IT Automator projects, using metalinks, metascripts, processes, and deploying elements.

EMC IONIX IT AUTOMATOR SERVER AND MANAGEMENT CONSOLE USER GUIDE xi

xii RELEASE 6.0 REV: A02 300-010-272

IPart

EMC Ionix IT Automator Server 1Topics in this section:• Server Concepts• Server Services• Server Log Files• Server API• Performance Tuning

EMC IONIX IT AUTOMATOR SERVER AND MANAGEMENT CONSOLE USER GUIDE

RELEASE 6.0 REV: A02 300-010-272

1Chapter
Server Concepts 1
Topics in this section:• Overview• Automator Server• Server Management Console• Integrated Development Environment• Metalinks, Metascripts, and Processes• Primary Server• Processing Servers• Virtual Servers• Clients and Client Machines• User Context

Overview 1

The EMC Ionix IT Automator Server provides real-time execution of business processes in a server environment that automates critical availability features such as fault tolerance, load balancing and error handling. The system provides mechanisms for executing business processes, maintaining their state, and monitoring their execution.

Business processes created in the EMC Ionix IT Automator Integrated Development Environment (IDE) are deployed to the Server. Once deployed, processes can be invoked by name, and the Server executes the process according to business rules defined in the model. Connections with information systems are managed, data is accessed and transformed, and business rules are applied. The Server does this quickly and efficiently enabling straight-through processing (STP).

EMC Ionix IT Automator integrates with existing security models by conforming to Java security standards including the Java Authentication and Access Control Service and the Java Cryptography Extensions. Using pluggable authentication modules, EMC Ionix IT Automator can integrate with LDAP directories, Windows NT, and other security frameworks to authenticate

EMC IONIX IT AUTOMATOR SERVER AND MANAGEMENT CONSOLE USER GUIDE 1-1

AUTOMATOR SERVER

users and apply access control rules to business processes and other resources in the Server repository.

Automator Server 1

The EMC Ionix IT Automator Server refers to your server environment, regardless of how many physical machines you have. You can configure your server environment in many different ways, for example with or without additional servers, and with or without processing servers. The Server environment always includes one Automater server, one or more service managers, and if High Availability is configured, additional servers for Load Balancing and Clustered Job Schedulers.

Server Management Console 1

The Server Management Console is the Web interface that allows you to manage the entire Server, regardless of whether your environment consists of one machine (developer environment) or multiple machines (production environment). The Server Management Console allows you to start and stop the EMC Ionix IT Automator Server and related Server services.

Integrated Development Environment 1

The EMC Ionix IT Automator Integrated Development Environment (IDE) is the visual development environment where you create the processes and metalinks used in your distributed applications. After you create the processes and metalinks in the IDE, you deploy them to the EMC Ionix IT Automator Server. For more information on the IDE, refer to the IDE User Guide.

Metalinks, Metascripts, and Processes

Metalinks, metascripts, and processes are discussed extensively in the IDE User Guide. Brief definitions are provided here for your convenience. Metalinks are thin wrappers that connect your existing business data sources, processes, and applications to the EMC Ionix IT Automator Server. They typically provide access to the resources and data that support your business. Metalinks can access data in databases (using JDBC and ODBC) or handle messaging (WebSphere MQ). Metalinks can also access proprietary data and resources, and applications that utilize EJB or COM objects. Metalinks are wired together to create process models.

Metascripts are lightweight, reusable scripting components that are created in the IDE and may contain complex, custom logic that can be reused in a process or in a mapping definition. They let you model and reuse fine-grained logic that is neither a process nor a metalink. They are deployed once to a virtual server repository and then executed on demand in a service manager

1-2 RELEASE 6.0 REV: A02 300-010-272

INTEGRATED DEVELOPMENT ENVIRONMENT

when needed by a process or mapping definition. Metascripts run on the Server with no configuration and little overhead. They can be dragged into a process, deployed to the Server, and managed from the Management Console. Once defined, they are available in the Mapping Designer as user-defined palette functions.

Processes contain instructions that control the flow of execution between the various steps that make up a business process. Processes are created by dragging one or more metalinks (which generally represent one step in a business process) into a visual modeling tool that is provided as part of the IDE. A process specifies the order in which the metalinks need to be executed and defines the inputs and outputs needed for each metalink. Between each step in the process, the developer also maps and transforms the data as it moves between the activities.

Executing a Process vs. Starting a Metalink

You start a metalink via the Management Console; you execute a process from a client. Most processes consist of one or more metalinks; these metalinks generally handle connectivity to back-end systems and perform specific steps, such as running a query and retrieving a ResultSet from a database, for example. For a process to execute successfully, at least one instance of every metalink used by that process must be started on a service manager that is connected to the virtual server where your process will execute.

Processes, on the other hand, are not started by or run on the Management Console. Processes are invoked from your applications – for example, from an application on your company's Website, from a schedule, etc. Processes are displayed on the Management Console so you can ensure that they have been deployed and are available to run on a virtual server, and also so you can define access control lists. When a process is invoked, each metalink method in the process will perform a particular step. If one of these metalinks has not been configured to run on a service manager, the process will fail because the Server will be unable to connect to the back-end system and perform the desired action.

Configuring a Metalink vs. Starting a Metalink

When you configure a metalink on a service manager, you are essentially telling the service manager that it is capable of executing instances of the specified metalink. Configuring the metalink on a service manager does not necessarily involve starting any instances of the metalink. Starting the metalink means you have actually configured and started one or more instances of the metalink on a specific service manager.


PRIMARY SERVER

Primary Server 1

The primary server refers to a physical machine running required components of the EMC Ionix IT Automator Server. This machine runs the primary service managers for all virtual servers on the Server. Service managers and virtual servers are explained later in this chapter.

You must have a primary server, regardless of whether you are working in a single-server (one-machine) or a multi-server (multiple machines) environment. The primary server executes system services that are required for the Server to start and function.

Processing Servers 1

A processing server is any machine, other than the Primary, on which you have installed the Automator Server. A processing server participates in process execution, hosts metalinks, and other solution components. Effective use of processing servers is key to harnessing the distributed processing capabilities of the Automator Server.

If you are working in a distributed environment, the term, Processing Server, refers to any other physical machine, aside from the Primary, upon which you installed the Server. If you are working in a development (single-server) environment, your computer has a dual role – it functions as the primary server as well as a processing server. Obviously, in a single-machine environment, your ability to take advantage of the distributed processing capabilities of the EMC Ionix IT Automator Server is lessened because you do not have additional machines to share the processing load.

Virtual Servers 1

A virtual server provides a mechanism for grouping a set of related units (processes and metalinks) into an entity with common properties. At runtime, units in one virtual server are kept completely independent of units in another virtual server. The virtual server also serves to group things such as service managers, users, groups, access control lists, etc. into the same entity.

From the perspective of a developer, a virtual server is intended to map to a EMC Ionix IT Automator application. Virtual servers enable multiple applications to share a single EMC Ionix IT Automator Server. Each application should run in its own virtual server. This allows the administrator to run multiple applications and share the resources (memory, disk, network, etc.) on one physical machine, while ensuring that the applications do not conflict in any way. Further, each virtual server has its own security provider that is defined independently of all other virtual servers.

1-4 RELEASE 6.0 REV: A02 300-010-272

CLIENTS AND CLIENT MACHINES

Virtual servers are created on the Server using the Management Console; you may create as many virtual servers as you like. The memory and disk space requirements may increase depending on the number and type of metalinks that are deployed and executed on the service manager.

You can create as many virtual servers as you need via the Management Console. You can think of the virtual servers as a way to "slice" or segment the resources on your Server and create unique runtime environments. By creating service managers, you can connect as many processing servers as you like to your virtual servers. This gives you many options for balancing the processing load of your applications. Every time you create a virtual server, the Server automatically creates a primary service manager for your new virtual server.

Clients and Client Machines 1

A client machine is the physical computer from which a process is invoked. The client is the actual software (servlet, JSP, Java program, etc.) that invokes the process.

User Context 1

Any user accessing the Server and executing a process is assigned a user context. This user context stores a collection of information that uniquely identifies the user and keeps track of global data (e.g. shopping cart items) generated during the execution of processes. Among other benefits, this means the same user can access the Server on two different occasions or from two different machines but still have access to the same global process data if the Server session has not expired. The expiration and flush times of an Server session are configurable via the Management Console. Different virtual servers can have different expiration times; see “Settings” on page 1-4 for more information.


USER CONTEXT

1-6 RELEASE 6.0 REV: A02 300-010-272

2Chapter
Server Services 1
Topics in this section:• Overview• Controlling the Automator Server with Windows Services• Controlling the Automator with the Server Console• engine-console.properties• How to Change the JVM Size

Overview 1

During installation, the Automator Server (with the associated Tomcat Server) is installed. You can also install the Automator Server and Tomcat Server as Windows Services. The Windows Services allows the Automator and Tomcat servers to autostart in the event that the physical machine crashes or needs to be rebooted. This is the preferred installation method because it does not require manual intervention from the system administrator if the machine were to crash.

The Server Console is installed on every machine on which you install Automator Server components and allows you to control Automator Java services.

When using the Windows Services or Server Console, be aware of the following:• If the Automator Server and Tomcat Server are installed as a Windows Service,

the Server Console should not be used.• If the Automator Server and Tomcat Server have not been installed as

Windows Services, the Server Console should be used to stop and start the Java services (Primary, Admin, Scheduler) and any service managers.


CONTROLLING THE AUTOMATOR SERVER WITH WINDOWS SERVICES

Controlling the Automator Server with Windows Services 1

When you install Automator on a Windows machine, the Automator Server and Automator Tomcat Server can be installed on the machine as a Windows Service. By default, the startup type of the Automator Server and Tomcat Server is set to "Automatic". You also can choose to have the service start automatically whenever the machine is rebooted.

Figure 2-1 Windows Services

The Automator Tomcat Server service is configured to be dependent on the Automator Server service. Therefore, if both services are stopped, starting the Automator Tomcat service will first start the Automator Server service. Likewise, stopping the Automator Server service will also stop the Automator Tomcat service.

Note: If you run the Automator Server and Tomcat Server as Windowsservices, you can view informational messages in the Event Viewer if anerror occurs.

To view messages in the Event Viewer:1. From the Windows Start menu, choose Settings > Control Panel, then

double-click Administrative Tools and double-click Event Viewer.2. Once you have launched the Event Viewer, click Application Logs. Doubleclick

any entry to view the details.

Starting the Automator using Windows Services

To start the service manually on Windows:1. From the Start menu, choose Settings > Control Panel.

2-2 RELEASE 6.0 REV: A02 300-010-272

CONTROLLING THE AUTOMATOR WITH THE SERVER CONSOLE

2. Double-click Administrative Tools, then double-click Services.3. Right-click the Automator Tomcat service and choose Start.

Stopping the Automator using Windows Services

To stop the service manually on Windows:1. From the Start menu, choose Settings > Control Panel.2. Double-click Administrative Tools, then double-click Services.3. Right-click the Automator Server service and choose Stop.When prompted to also stop the dependent service Automator Tomcat, select Yes.

Controlling the Automator with the Server Console 2

If you have not installed the Automator Server as a Windows service, the Server Console is used to start and stop the Java services associated with the Automator Server. The Server Console is accessed from the Windows Start menu.

Starting the Automator using the Server Console

To start the Automator using the Server Console:1. On Windows, choose Start > All Programs > install_root > Tools > Server

Console. The Server Console displays.Figure 2-2 Automator Server Console

2. The Server Console shows all Java services or service managers available on the local machine. — Services that are currently running are shown in bold with a green

button. The Primary Service and Schedule Service start automatically.



— Services that are not running are shown in normal text with a red button.

The example shows how the Server Console might look in a single-machine development environment, in which you installed the Primary Service, two service managers (one using the System class loader and the other using the Built-in class loader). In a fully distributed environment, you would normally see a service manager or Primary Service, but not both on the same machine.

Note: If a service manager uses the System class loader, the Server Consoledisplays (System Class Loader) after the service manager name. If aservice manager uses the Built-in class loader, the Server Consoledisplays only the service manager name. In the example above, theSystem class loader service manager is not currently running; the Built-in class loader service manager is running.

Stopping the Automator Server using the Server Console

To stop the Automator Server using the Server Console:1. Choose File > Exit from the Server Console menu.2. You will be prompted to stop all running services. You cannot exit the Server

Console with any Server services running.

Server Console Java Services

The Server Console is the utility that allows you to start and stop the Automator Server and related Java services. Available services are explained below.

Table 2-1Server Services

Service Description

Admin Service This service allows you to run the Server Management Console. It is configured to use port 8088. If the service is stopped, you cannot access the Server Management Console or WS gateway. Logging for the Admin Service is turned off by default.

Scheduler Service This service starts the built-in Job Scheduler and allows you to configure a process to run as a scheduled job.

2-4 RELEASE 6.0 REV: A02 300-010-272


Service Manager (System Classloader)

This service starts and stops service managers that do not use Automator’s built-in class loader. For example, you need the system class loader service manager if you are running Enterprise JavaBeans (EJB) metalinks.

This service forces the service manager to use the system class loader. The service managers running under this service will write all metalink implementation files to the service manager implementation directory, where they can be loaded by the system class loader.

Note: If you re-deploy a changed metalink to a service manager that uses a system class loader, you must stop and restart the service manager itself, before the changes take effect

Service Manager This service starts all service managers on the processing server, including any service managers created via the Management Console. The service uses the Automator’s built-in class loader, which is the default class loader option at installation time. In most cases you should not need to stop this service, because you can deploy and configure updated versions of metalinks without the need to stop the service managers.

Note: If you re-deploy a changed metalink to a service manager that uses the built-in class loader, you must stop and restart only the metalink before the changes take effect.

Primary Service This starts the Automator Server on the your machine. The Primary Service can also be configured to use a system class loader. This service starts and stops an Automator Server that does not use Automator’s built-in class loader. It forces the Automator Server to use the system class loader.

In a single-machine mode, stopping the Primary Service disables all functionality of the affected machine. In a High Availability configuration, stopping the Primary Service disables all functionality on the affected Automator Server. However, job scheduling and web service gateway requests are rerouted to additional servers.

Table 2-1Server Services (continued) (continued)

Service Description



Starting and Stopping Java Services

When you start the Server, the Server Console is displayed automatically.

To start and stop Java services:1. On Windows, choose Start > All Programs > install_root > Tools > Server

Console. The Server Console displays all running services that are configured to start automatically. Regardless of which services are started and stopped, only those services available on the local machine will be listed. The example shows how the Server Console would look in a development environment, where one physical machine is acting as the primary server and a service manager. In a fully distributed environment, you would see the service manager or primary service, but not both.

Note: If you use the Server Console to stop all running services, you canrestart the services from the Server Console, but you cannot restart theservices from the Windows Start menu unless you first close the ServerConsole.

Figure 2-3 Automator Server Console

Started services are shown in bold font with a green icon. Stopped services are shown in plain font with a red icon.• To start or stop an individual service, right-click the service and choose Start

or Stop.• To start or stop all services, choose File > Start All or Stop All.

Note: If you are accessing the Management Console immediately afterstarting the Server, you may need to refresh the Server Home page toenable the hyperlinks for the virtual servers.

2-6 RELEASE 6.0 REV: A02 300-010-272

ENGINE-CONSOLE.PROPERTIES

Configuring Java Services to Start Automatically

You can control which individual Server services are started whenever the Server is launched. The table below shows which services are configured to start automatically whenever the Server is started.

Note: If you install anything in addition to a primary server on a primarymachine, the additional service managers (processing servers) youinstall are automatically set to autostart=false.

To change the autostart setting for a service:1. From the Server Console, highlight the appropriate service.2. Right-click the service and choose Stop, if the service is not already stopped.

(You cannot change the configuration if the service is running.)3. Click Configure. The Configure Service screen will be displayed.Figure 2-4 Configure Service screen

4. In the autostart row, change the value from false to true or vice versa and click OK. (Do not change anything else in this panel manually. Refer to engine-console.properties for more information.)

engineconsole.properties 2

One engineConsoleContext.xml file is created for each physical machine in your Automator Server environment. The Server reads this file to determine which services to display on the Server Console GUI, whether the services should be brought up in a started or stopped state, and what property values should be used some services. The file is located in each machine’s

Table 2-2Services Configured to Start Automatically

Machine Services

Automator Server Primary ServiceScheduler Service



<installroot>/engine/config directory. It is modified when you install an Server component such as the Primary or processing server. You must restart the Server for any changes in this file to take effect.

The serviceManager bean defines the services that will appear in the Server Console GUI.

<bean id=”serviceManager” class=”com.metaserver.engine.console.ServiceManager”>

<property name=”services”><list><ref bean=”primaryService”/><ref bean=”adminService”/><ref bean=”mmService”/><ref bean=”mmNoClassLoaderService”/><ref bean=”schedulerService”/></list>

</property></bean>

The beans following serviceManager define the individual services (Primary, Admin, Scheduler).

<bean id=”mmService” class=”com.metaserver.engine.console.MMService”><property name=”id” value=”mmService”/>

<property name=”autoStart” value=”false”/><property name=”processingServerName” value=”local”/><property name=”useSystemClassLoader” value=”false”/>

</bean>

Table 2-3Individual Services Bean Descriptions

Item Description

Class The java class that is instantiated for the particular service.

Id The identifier for this service. Do not edit this property!

autoStart defines if the service should be started automatically when the Server Console starts. The valid values are (true/false).

processingServerName The name of the Service Manager. This will be Primary on the Primary machine. By default it will be the hostname of the machine if this is a processing server. Do not edit this property!

useSystemClassLoader Defines whether the service manager uses the system class loader (true) or the built-in class loader (false).

2-8 RELEASE 6.0 REV: A02 300-010-272


The bean entries at the end of the file are used for the Scheduler service. The dataSource bean defines the database connection to be used by the Scheduler as its job store. By default, Automator uses the java Derby database as the job store, however, another relational database can be used such as Oracle or MS SQL Server. Below are a table of properties.

The last bean of importance in the engineConsoleContext.xml file is the scheduler bean. This bean contains properties that control and affect the Scheduler behavior and performance. The properties in the table below represent the configurable (editable) properties.

Note: Do not edit any of the other properties not listed in the table.

Table 2-4dataSource Bean Properties

Item Description

Class The data source class

driverClassName The name of the JDBC driver used to connect to the database.

maxActive The maximum number of active connections to the database. This value should be 2 higher than the quartz property value “org.quartz.threadPool.threadCount”.

maxIdle The maximum number of idle connections to the database.

url The database connection URL used to connect to the database.

username The username used to connect to the database.

password The password used to connect to the database.

Table 2-5scheduler Bean Properties

Item Description

org.quartz.threadPool.threadCount

Defines the number of worker threads available by the scheduler. If you have a large number of jobs executing simultaneously then you should consider increasing this number.

org.quartz.threadPool.threadPriority

The priority of the worker threads. “1” is consider lowest priority and “10” is consider highest priority. It is recommended that you leave this value set to “5” ? normal priority.

org.quartz.jobStore.misfireThreshold

The length of time, in milliseconds, after a Trigger’s fire time when the trigger is considered “misfired”.


HOW TO CHANGE THE JVM SIZE

How to Change the JVM Size 2

Depending on the source of the message, you may need to increase the JVM size on the Automator Server or on a processing server where a service manager is installed. Automator defines a maximum heap size of 512 Mb by default. You can adjust the JVM size by using the -Xms and Xms options in the engine.l4j.ini file. As shown in the examples below, Xms is the initial heap size; Xmx is the maximum heap size. You may need to experiment by increasing the minimum and maximum values. (See the Java documentation for detailed options and default values.)

Changing the JVM Size for a Primary Service

If your repository has a large number of items, you may need to increase the JVM size for the Primary Service on the machine where the Automator Server is installed. For example you may need more memory to handle requests from the Management Console to view the repository, to archive a virtual server or to populate the Server Explorer view in the Management Console.

To change the size, open the engine.l4j.ini file. Add -Xms to specify the minimum heap size and -Xmx to specify the maximum heap size. Figure 2-5 provides an example of an engine.l4j.ini file. The minimum and maximum values shown are simply examples and may not work with your configuration.

Figure 2-5 Example engine.14j.ini file

Changing the JVM Size for the Service Manager

The following events may trigger an out of memory condition on a processing server where a service manager is installed: • an unusually large repository• frequent access to a large number of complex processes (especially those

passing XML data with large schemas)

If an out-of-memory condition occurs, you will need to increase the JVM size for the service manager.

-Xms128M min java heap size-Xmx512M max java heap size-Xrs-Djavax.xml.parsers.SAXParserFactory=org.apache.xerces.jaxp.SAXParserFactoryImpl-Djavax.xml.parsers.DocumentBuilderFactory=org.apache.xerces.jaxp.DocumentBuilderFactoryImpl-Djavax.xml.transform.TransformerFactory=org.apache.xalan.processor.TransformerFactoryImpl

2-10 RELEASE 6.0 REV: A02 300-010-272

3Chapter
Server Log Files 1
Topics in this section:• Log Files Types• Logging Terms• Service Manager and Client Logging• Changing the Log Level• Changing the Log Level• Setting Debug Properties• Rolling and Purging Log Files• Capturing Additional Metalink Data• Viewing Process Execution Logging

Log Files Types 1

The Server includes the following log files to help you monitor system activity and troubleshoot unexpected behavior:• Client Logs• Server Logs• Management Console Logs• Web Service Gateway Logs

Client Logs

The client log captures all activity prior to the execution of the first metalink method in a process. Client logging is written to the client.log file.

A specific subdirectory will be created for each client type. If you are invoking a process using the Java Bean client, for example, the client.log file will be located in the <installroot>/engine/logs/bean directory.


LOG FILES TYPES

Server Logs

The Server log captures all activity after the execution of the first metalink method in a process.

Each server (Primary or Processing Server) logs output to two log files located in the <installroot>/engine/logs directory. The engine.log file captures all Server logging events for that particular machine. If your process includes metalinks that run on a processing server, then any logging events for that metalink will be output to the engine.log file on the processing server.

The engine.error.log file only captures errors that occur in Server and during process execution.

Management Console Logs

The Management Console log contains informational, warning, and error messages related to the Management Console application. The Management Console logs are captured in the mgmt-console.log file. This file is located in the <installroot>/engine/logs directory.

3-2 RELEASE 6.0 REV: A02 300-010-272

LOGGING TERMS

Figure 3-1 Management Console log

Web Service Gateway Logs

The Web Service Gateway log contains informational, warning, and error messages related to the Web Service Gateway application. The Web Service Gateway logs are captured in the wsgateway.log file. This file is located in the <installroot>/engine/logs directory.

Logging Terms3

You must be familiar with the following terms in order to read and understand log messages. Each of these terms has a specific meaning when used in a log message.

Table 3-1 Logging Terms

Item Description

upstream data All data sources preceding the currently selected activity that you can map from. These include the outputs of all previous activities, the output parameters from the Begin activity, and all process data.

2009-08-28 14:59:02,411 [http-8088-Processor24] ERROR com.metaserver.common.LogUtil - **** Error Details **** (LogUtil.java:56)

2009-08-28 14:59:02,421 [http-8088-Processor24] ERROR com.metaserver.common.LogUtil - Error Name : Unable to Archive Virtual Server (LogUtil.java:75)

2009-08-28 14:59:02,421 [http-8088-Processor24] ERROR com.metaserver.common.LogUtil - Error Code : ADMIN155-E (LogUtil.java:76)

2009-08-28 14:59:02,421 [http-8088-Processor24] ERROR com.metaserver.common.LogUtil - Error Message : Error occurred when trying to archive virtual server automator. (LogUtil.java:77)

2009-08-28 14:59:02,421 [http-8088-Processor24] ERROR com.metaserver.common.LogUtil - Error Description : (LogUtil.java:80)

2009-08-28 14:59:02,421 [http-8088-Processor24] ERROR com.metaserver.common.LogUtil - Error Source : ENGINE CONFIGURATION MANAGEMENT (LogUtil.java:85)

2009-08-28 14:59:02,421 [http-8088-Processor24] ERROR com.metaserver.common.LogUtil - Error Content : Error: org.springframework.remoting.RemoteAccessException: Could not access remote service [rmi://localhost:24158/PrimaryDaemonAdminService]; nested exception is java.rmi.UnmarshalException: Error unmarshaling return header; nested exception is:


SERVICE MANAGER AND CLIENT LOGGING

Service Manager and Client Logging 3

The bulk of the Server logging is handled by the Server (primary/processing server), since these run the metalink methods that typically perform most of the work in a process. However, every time you run a process, the first portion of the process execution is logged by the particular client you are using: COM, JavaBean, Metaservlet or JSP. Specifically, the client logs all "pre-processing" activity.

Changing the Log Level 3

Because logging has a notable impact on Server performance, the service managers are set by default to log only FATAL and ERROR messages. In addition, all client logging is initially disabled. When troubleshooting, you will need to change the log level (to also capture INFO and WARN messages) and set debug properties. For more information, see Setting Debug Properties.

Note: Full logging has a substantial impact on Server runtime performance.The log level should only be set to DEBUG or INFO during developmentor in a production environment only when circumstances require thatfull logging be enabled for debugging purposes.

The log level determines how much of the available data is written to the log. The portion of the log4j.properties file that controls the logging level is indicated below. In this example, ERROR is the default setting.

log4j.rootLogger=ERROR,Console,File,ErrorAppender

source document The source document for an activity with all elements of a particular data type with default values provided in the activity method. Default values for an activity are specified in the IDE at design time. If no default is present, the element for that parameter will have no content.

result document The final document that is passed to the activity (i.e., metalink or metascript) method for execution. It contains the source document merged with the data from all upstream activities.

Table 3-1 Logging Terms (continued)

Item Description

3-4 RELEASE 6.0 REV: A02 300-010-272

SETTING DEBUG PROPERTIES

Log Properties File Locations

Based on the type of log, there are several log4j.properties files that are located in different directories. When changing the priority, be sure to edit the appropriate file in the correct location:• Server:

<installroot>/engine/config/log4j.properties

• Management Console: <installroot>/engine/tomcat/webapps/wmc/WEB-INF/classes/log4j.properties

• Web Service Gateway: <installroot>/engine/tomcat/webapps/wsgateway/WEB-INF/classes/log4j.properties

Logging Level Values

To adjust the logging level, change the ERROR parameter with one of the following valid values: 1. FATAL2. ERROR3. WARN4. INFO5. DEBUG

In this list, the FATAL value captures the minimal output and DEBUG captures the maximum output. Each logging level also captures the previous more suppressed log output. For example, a log level of ERROR captures ERROR and FATAL output while a log level of WARN captures WARN, ERROR, and FATAL output.

Setting Debug Properties 3

Messages are selectively written to the log files depending on which of the following debug properties are enabled. All properties are set to false by default.

These properties are located in the following directory:<installroot>/engine/config/engine-config.xml.


ROLLING AND PURGING LOG FILES

To capture all log data, set these properties to true and when done, revert all properties to false to avoid accumulating unnecessary log data. See “engine-config.xml” on page 9 for a description of other properties in this file.

Rolling and Purging Log Files 3

Both log files support rolling, which occurs when the log file exceeds a size threshold defined in the log4j.properties file. You can also define the number of rolled log files to preserve. The example below shows the properties in log4j.properties to control the size threshold and number of rolled fields to reserve.

log4j.appender.File.MaxFileSize=1MBlog4j.appender.File.MaxBackupIndex=5

Table 3-2 Debug Properties

Property Description

Metaserver.ProcessManager. isDebug.enabled

Allows you to trace the navigation of a process. For example, you can see which metalinks executed, and if the process fails, you can determine the exact point at which it failed. The information includes data about pre and post actions for activities, responses received for activities, and the completion of the process instance.

Metaserver.ProcessManager. spi.isDebug.enabled

Allows you to view XSLT logging. Specifically, the log files show the source and result XSLT documents from mappings and conditions. The information includes data from each upstream activity and the result document for the current activity.

Metaserver.ProcessManager. isInstanceDataLogging. enabled

Provides a comprehensive view of the process execution. The log files show the final state of the process and the results of process execution. The information includes the exact data that was returned, the time at which a process execution completed, and the instance data that was logged (including the input to the process, the output from the process, and the current state of each activity in the process)

Metaserver.ProcessManager. spi.xslt.isSourceGeneration. enabled

Enables the generation of source documents (which show the default values provided to the activity method) when the XSLT Server is invoked for a transformation. Do not change the default setting to true except when debugging.

3-6 RELEASE 6.0 REV: A02 300-010-272

CAPTURING ADDITIONAL METALINK DATA

In this example, the log file will be rolled after it reaches 1MB in size. A maximum of 5 rolled log files will be preserved.

Rolled log files will be appended with an integer beginning with "1". For example engine.log.1 is the most recent rolled log files. As rolling continues, the number increments with the highest number representing the oldest rolled log file.

Capturing Additional Metalink Data 3

The connectorfactory.properties file located in the Server's <installroot>/engine/config directory lets you turn debugging information on and off for specific types of metalinks. For example, if you are troubleshooting a process that includes an EJB metalink, you can turn the EJB debugging on and rerun your process to get additional information. Changes to this file are recognized immediately after you save the changes to the file; you do not have to restart any service managers. The first few entries of the connectorfactory.properties file are shown below.

[DEFAULT]name=DEFAULTelement_factory=com.metaserver.project.impl.ElementFactorydebug=true#uncomment the next line to specify the timeout duration (milliseconds) for the dispatcher timeout=120000retry=3

[JAVA]name=JAVAdispatcher=com.metaserver.dispatcher.java.impl.JavaDispatcherelement_factory=com.metaserver.project.java.impl.JavaElementFactory#debug=true#uncomment the next line to specify the timeout duration (milliseconds) for the dispatcher#timeout=60000#retry=3

[EJB]name=EJBdispatcher=com.metaserver.dispatcher.java.impl.EJBDispatcherelement_factory=com.metaserver.project.java.impl.JavaElementFactory#debug=true#uncomment the next line to specify the timeout duration (milliseconds) for the dispatcher#timeout=60000#retry=3


VIEWING PROCESS EXECUTION LOGGING

There are entries for each type of metalink. The EJB and Java connector entries are shown here, but similar entries exist for COM, Web Services (SOAP) and JMS. The Server reads the individual connector properties first. If the individual connector property and the default property both contain a value, the individual connector property is used.

If the individual connector property value is commented out, the default value is used. You can adjust the following settings:

Viewing Process Execution Logging 3

The client logs preprocessing information, which includes all activity that occurs prior to the execution of the first metalink method. This can include but is not limited to process input parameters, or conditions on control connectors prior to the first method in the process. This information is captured in a file called client.log. If you have multiple clients of the same type (COM, for example) executing processes, they will all write to the same log file, so some information will be overwritten. Thus, if you are debugging a particular client, make sure no other clients are running, so you do not lose any information in the logs. Every log message is preceded by a header (and a timestamp if enabled) that describes the elements to which the message applies. The format is roughly as follows; some items (e.g. a method name) depend on the context and may not be repeated in every message:

[timestamp] [process_name] [process_id] [activity_id] [activity_name] [method_name] [log_message]

Table 3-3 Property descriptions

Setting Description

debug Set to true if you are trying to debug a process that contains a specific type of metalink and you want to see all logging information written by the metalink dispatcher. This debugging information is written to the sm.log files in addition to the normal logging done by the service manager. Be sure to adjust the service manager log level to 15 to capture all debug information.

timeout Controls the number of milliseconds after which the connector times out if the method has not finished executing. This may result in an exception or a retry. When the Server is installed, the individual connector timeout values are commented out and the default is set to 120000, which means the connectors will wait two minutes for the execution to complete.

retry Controls the number of times the service manager will retry after a time-out. If the method throws an exception, the metalink dispatcher will not attempt to retry the method.

3-8 RELEASE 6.0 REV: A02 300-010-272

4Chapter
Server API 1
Topics in this chapter:• API Overview• Login and Connection Properties• Server Properties

API Overview 1

The Server API is the interface that lets you programatically control Server administration functions using a Java program or an Apache Ant task. For example, you can use the Server API to create and manage virtual servers and service managers, and to configure and run metalinks – without logging in to the Management Console. You can also encapsulate the API calls that perform Server functions into an Ant task that you run from the command line. The javadocs in the EMC Ionix IT Automator API (including the Server API) are included with the online help system and are summarized below. When viewing the javadocs, see the Method Summary for a brief description of each method; see the Method Detail for usage, variables, and parameters.

The Server API consists of the following classes:

Table 4-1 Server API Classes

Class Description

Administration Allows the caller to access administration functions on the EMC Ionix IT Automator Server. For example, you can configure, start, and stop metalinks; and you can create, stop, and start virtual servers and service managers.

Repository Allows the caller to access the repository functions on the EMC Ionix IT Automator Server. For example, you can deploy metalinks and processes; and you can view the contents of a virtual server repository.


LOGIN AND CONNECTION PROPERTIES

Login and Connection Properties 4

Before you can use the Server API, you must first log into the Server and set the connection properties. You log in using one of the methods in the com.metaserver.engine.api.security.Security class. Calling one of these login methods returns an instance of a com.metaserver.engine.api.security.ICredential. This object must then be set using the setCredential(ICredential c) method on this API.

You set connection properties to the Server using the setProperties(Properties props) method (see below). This method supplies a set of properties that will be used by each API to get a secure connection to the Server. Once the credentials and properties are set on an instance of this class, the instance can then be used to access Administration, Repository, and Security functions of the Server. The following table shows the properties used to connect to a running Server.

Administration

This class allows the caller to access administration functions on the EMC Ionix IT Automator Server. All methods on this class may be invoked by an Server administrator. All methods on this class may be invoked by a virtual server administrator with the exception of the createVirtualServer methods and the removeVirtualServer methods.

Security Allows the caller to access security functions on the EMC Ionix IT Automator Server. For example, you can log in or log out from the Server; and you can set access control on virtual servers and permissions for process execution.

Table 4-2 Connection Properties


Metaserver.Primary.Host Host name (machine name) of primary server. Default is localhost.

Metaserver.Primary.Port Port number of primary server. Default is 24158.

Metaserver.requestBackup.enabled

Indicates whether or not failover is enabled. Default is false.

Table 4-1 Server API Classes (continued)

Class Description

4-2 RELEASE 6.0 REV: A02 300-010-272


Repository

This class allows the caller to access the repository functions on the EMC Ionix IT Automator Server. In order to use this API, the caller must first log into the Server using one of the login APIs on the com.metaserver.engine.api.security.Security class. Calling one of these login methods returns an instance of a com.metaserver.engine.api.security.ICredential. This object must then be set using the setCredential(ICredential c) method on this API. The connection properties to the Server must also be set using the setProperties(Properties props) API. Once the credentials and properties have been set on an instance of this class, the instance can be used to access repository functions on the Server.

The following table shows the permissions required in order to execute the repository API methods. Users logged into the Server as Server administrators have implicit read/write access to all virtual server repositories. Users logged into the Server as virtual server administrators have implicit read/write access to the virtual server repositories for which they have admin access. Users logged in as developers (or business process users) must have explicit global read/write access to the virtual server repository in order to use the specific repository methods shown below.

† No permissions required.

Security

This class allows the caller to access security functions on the EMC Ionix IT Automator Server. For example, you can log in or log out from the Server; and you can set access control on virtual servers and permissions for process

Table 4-3 API Method Permissions

Method Read Write

getMetalinkImplementation

required

getRepositoryAsJar required

getRepositoryView required

getResource required

persistJar required

removePersistData required

setCredential †

setProperties †



execution. The Server can be configured to provide various levels of security, depending on your business requirements. At the most granular level, you can create ACLs (access control lists) for each process that will be executed on the Server, and through these ACLs, control who has access to each process that will be run.

You can also require a user name and password combination to access the Server, regardless of whether the user accessing the Server will invoke any processes. This user name and password is authenticated against the entries for your existing security provider. These include LDAP, Windows NT, and EMC Ionix IT Automator’s proprietary File security.

User Context IDs and User Context Data

A user context is an object used to uniquely identify each user who accesses the Server and keep track of process data that is unique to that user's Server session. Any user who is successfully authenticated is given a credential that includes a unique UserContextId (UCID); this is the unique key for associating users' Server sessions with a unique user context.

Among other benefits, this means the same user can access the Server on two different occasions or from two different machines, but still have access to the same global process data if the user's Server session has not expired. The expiration and flush times of an Server session are configurable via the Management Console. Different virtual servers can have different expiration times.

ICredential

A user login to the Server via security-login() returns a security credential object called ICredential. This credential is composed of the following:

UserContext

The UserContext stored on the Server is composed of the following items:

Table 4-4 ICredential Properties


UserContextId (UCID)

Unique ID (string) representing a virtual pointer to a specific UserContext object in the Server.

Table 4-5 UserContext Properties


UserContextId Unique ID (string) representing a pointer to a specific UserContext object in the Server.

4-4 RELEASE 6.0 REV: A02 300-010-272


Login Methods

ICredential login ()

This method performs login. A new UserContext object is created and an ICredential is returned with a unique UserContextId. The login succeeds only if virtual server security is disabled; otherwise a user name and password are required. By default, virtual server security is disabled. If you enable virtual server security, this method throws an MSSecurityException.

ICredential login (String UserContextId)

This method performs a guest login using the supplied UserContextId. It is intended for use with ColdFusion clients. The UserContextID passed in will be the Session ID assigned by ColdFusion. Upon login, the Server will look for a non-expired UserContext that contains the supplied UserContextID.

• If a non-expired UserContext is found with a user name of MS_GUEST, the UserContext is refreshed with a new LastAccessTime and the updated ICredential is returned to the caller.

• If no matching UserContextID is found or there is a match but the existing UserContext has expired, a new UserContext is created using the supplied UserContextID and an ICredential is returned to the caller.

• An MSSecurityException is returned to the caller if a matching UserContextID is found but the credentials don't match because a user name and password exist in the UserContext represented by the UserContextId. An MSSecurityException is also thrown if the Allow Guests flag is False in the Management Console for the target virtual server.

ICredential login (String username, String password)

This method performs a regular user login using the supplied user name and password. If the user name is null, this method behaves exactly as the login () method above. The Server first will look for a non-expired UserContext that contains a match to the supplied user name. If a non-expired UserContext contains the supplied user name, the password is verified.

Credential The full credential of the user associated with this UserContext. This contains a unique ID (string) representing a virtual pointer to a specific UserContext object in the Server.

Data The bucket of data used to store local and global process data.

Table 4-5 UserContext Properties



SERVER PROPERTIES

• If the password matches, the existing ICredential in the UserContext is updated and returned with a digested password and a new LastAccessTime.

• If the password does not match, an MSSecurityException is returned to the caller indicating that the user could not be authenticated due to an invalid password.

If no existing UserContext is found for the supplied user name or a match is found but the UserContext has expired, a new UserContext is created and an ICredential is returned to the caller. The ICredential will contain the supplied user name and a digested password.

ICredential login (String username, String password, String UserContextId)

This method is intended for use with ColdFusion clients. It performs a regular login with the supplied user name, password and UserContextId. The UserContextId passed in corresponds to the ColdFusion Session ID.

• If the UserContextId is not supplied, this method behaves the same way as the ICredential login (String username, String password) method.

• If the UserContextId is supplied but the username and password are not, this method behaves the same way as the ICredential login (string UserContextId) method.

• If none of the inputs are supplied, this method behaves the same way as the ICredential login () method for guest logins.

ICredential logout (String UserContextId)

This method performs an Server logout based on the supplied UserContextId. If the Server finds the existing UserContextId, the corresponding UserContext is removed from the virtual server. If the Server does not find the existing UserContextId, an MSSecurityException is thrown. This can happen if the logout request has previously been submitted; it can also happen if the UserContext has expired based on the virtual server's UserContext Expiration setting on the Management Console.

Server Properties 4

global.xml

The global.xml file contains parameters that are used by the Automator service manager services and by the Admin. The primary function of the properties in this file is to enable these Server services to locate Automator server. The file is located in the <installroot>/engine/config directory on each machine in your Server environment. The various properties from a

4-6 RELEASE 6.0 REV: A02 300-010-272

SERVER PROPERTIES

sample global.xml file are shown below, along with a description of each entry.

server.xml

The server.xml file (located in <installroot>/engine/tomcat/conf ) includes settings to run the Tomcat server in it's own JVM externally to the Automator JVM. This configuration provides full resources to both Tomcat and Automator. With this configuration, the Automator will run the Web Service Gateway and Management Console in an external instance of Tomcat.

Note: This is the default setup; the legacy embedded Tomcat server can also beconfigured for use by changing the engineConfig.xml file.

Running Tomcat externally allows Tomcat to have a dedicated JVM for it's use only. Automator controls the Tomcat instance using Tomcat’s JMX Connector API. The communication between Tomcat and the Automator Server runs across port 8686.

Note: When configuring server.xml, make sure no other application is using port8686.

The following is the configuration entry for the external Tomcat instance: <bean id="tomcatServer" class="com.metaserver.engine.console.ExternalTomcatServerBean" lazy-init="false">

<property name="jmxPort" value="8686"/><property name="host" value="localhost"/><property name="httpPorts">

<list>

Table 4-6 global.xml properties


Metaserver.Primary.Host IP address or host name of the machine where the primary server is installed.

Metaserver.Primary.Port Port on which the primary server is listening.

Metaserver.requestBackup. enabled

If true, the Server will use the secondary server in the event the primary server fails.

Metaserver.sca.license Internal license that should never be modified.

Metaserver.request.timeout Time (in seconds) after which the Server will timeout after a service request where no output is returned. Never change the default value of 0.


SERVER PROPERTIES

<value>8009</value> <value>8088</value></list>

</property></bean>

where:

— host = the hostname of the Tomcat Server. This should always be localhost.

— httpPorts = a list of http(s) ports that Tomcat is listening on. This should always be 8088 and 8009, unless it was changed in the server.xml file.

Tomcat Configuration

The server.xml file contains many setting and parameters but the key entries for configuring the Tomcat server are as follows:

<Connector port="8088" maxHttpHeaderSize="8192"maxThreads="150" minSpareThreads="25" maxSpareThreads="75"enableLookups="false" redirectPort="8443" acceptCount="100"connectionTimeout="20000" disableUploadTimeout="true" />

Load Balancer Support

The AJP Connector entry allows communication between the EMC Load Balancer and the Tomcat Server. This entry is always uncommented even if the EMC Load Balancer is not available.

Table 4-7 server.xml Properties


port The port number the Connector will use.

maxThreads The maximum number of request processing threads to be created by this connector, which therefore determines the maximum number of simultaneous requests that can be handled. If not specified, this attribute is set to 200.

minSpareThreads The number of request processing threads that will be created when this connector is first started. The connector will also make sure it has the specified number of idle processing threads available. This attribute should be set to a value smaller than that set for maxThreads. The default value is 4.

maxSpareThreads The maximum number of unused request processing threads that will be allowed to exist until the thread pool starts stopping the unnecessary threads. The default value is 50.

4-8 RELEASE 6.0 REV: A02 300-010-272

SERVER PROPERTIES

<Connector port="8009"

enableLookups="false" redirectPort="8443" protocol="AJP/1.3" />-->

Starting and Stopping¶

The external Tomcat server will start and stop with the Automator Server.

Logs¶

The external Tomcat server will log Tomcat-specific logs to <installroot>/engine/tomcat/logs.

WebApps Directory¶

The applications that are installed on the External Tomcat servill will be located in the <installroot>/engine/tomcat/webapps directory.

SSL Suppport

By default, the SSL connector entry is commented out. If SSL is required on the Tomcat server, the SSL configuration must be uncommented and the Tomcat server restarted.



To configure SSL withs the External Tomcat server, refer to the Tomcat website: http://tomcat.apache.org/tomcat-5.5-doc/ssl-howto.html.

engineconfig.xml

This file is auto-generated by the Server API (and by the Management Console which is built on top of this API). It is updated whenever you save changes. You can use this file to review the property settings described below but do not edit this file manually except as directed. The engine-config.xml property file is located in the <installroot>/engine/config directory on the primary server machine only. The file contains a section for each virtual server. Immediately after you install the Server, this file will have a section for the system virtual server only.

The same properties will appear for the other virtual servers you subsequently create. As you modify virtual-server-specific settings via the Management Console, the property values in this file will change. Some but not all properties are described below. The specific order of the properties is


http://tomcat.apache.org/tomcat-5.5-doc/ssl-howto.html

SERVER PROPERTIES

irrelevant and will not necessarily match the order in which they are described here or shown in the following example.

<virtual-server name="North"><property name="Metaserver.audit.enabled" value="false" /><property name="Metaserver.ProcessManager.isCaching.enabled" value="false" /><property name="Metaserver.ProcessManager.cacheSize" value="50" /><property name="Metaserver.Metascript.pool.minSize" value="1" /><property name="Metaserver.Metascript.pool.reductionRatio" value="0.5" /><property name="Metaserver.ProcessManager.Metascript.pool.flushInterval" value="300000" /><property name="Metaserver.ProcessManager.isInstanceDataLogging.enabled" value="false" /><property name="Metaserver.ProcessManager.isDebug.enabled" value="false" /><property name="Metaserver.ProcessManager.maxDoUntilIterations" value="20" /><property name="Metaserver.ProcessManager.maxInstanceStackDepth" value="20" /><property name="Metaserver.ProcessManager.spi.isDebug.enabled" value="false" /><property name="Metaserver.ProcessManager.spi.providers" value="xslt" /><property name="Metaserver.ProcessManager.spi.xslt.isSourceGeneration.enabled" value="false"/><property name="Metaserver.ProcessManager.spi.xslt.removeSourceNamespaces" value="true" /><property name="Metaserver.ProcessManager.spi.xslt.isEmptyStringNull.enabled" value="true" /><property name="Metaserver.Metascript.isCaching.enabled" value="false" />

File Provider Properties

LDAP Provider Properties

All LDAP provider properties are based directly on the LDAP and access control values entered on the Management Console if you defined an LDAP security provider. The property names correspond to the field names you see on the Management Console. The default settings for these properties are arbitrary, since at installation time the Server does not know the configuration settings for your LDAP server or the security requirements for your environment. Use your LDAP software to define these properties; never modify the properties manually. LDAP properties are explained in detail in “Defining LDAP Security” on page 9-8.

Table 4-8 File Provider Properties


location Location of File Provider security file that contains users and groups. Default location: <installroot>/engine/config/security-ug.xml

4-10 RELEASE 6.0 REV: A02 300-010-272

SERVER PROPERTIES

NT Provider Properties

Process Manager Properties

The process manager is the Server component responsible for executing and managing processes and their instances. The properties described here are directly related to the Server's process management function; the properties used for debugging are described separately. See “Setting Debug Properties” on page 1-5 for process manager properties that enable debug logging. See “Using Caching to Improve Performance” on page 1-6 for more about process and metascript caching.

Table 4-9 NT Provider Properties


authenticator NT security authenticator: local or domain. Domain authenticates against the network; local authenticates against the local machine.

Table 4-10 Process Manager Properties


Metaserver.ProcessManager. spi.xslt.isEmptyStringNull. enabled

Default false. Empty strings in mapping definitions for parameters with simple data types are passed as empty strings. If true, empty strings are converted to null values.

Metaserver.ProcessManager. spi.providers

The transformation provider used for mappings and conditions. The property exists to support the Server's open architecture. In EMC Ionix IT Automator, the value must be XSLT. The spi prefix stands for service provider interface. Do not change this value.

Metaserver.ProcessManager. spi.xslt.className

Used in conjunction with the above property and must never be modified in EMC Ionix IT Automator. The spi prefix stands for service provider interface.

Metaserver.ProcessManager.maxDoUntilIterations

Protects against an Until condition that never evaluates to True – for example, because of an incorrectly formed expression or invalid data. This property stipulates a maximum number of iterations; if not specified, the process will run forever. The default value is 10.


SERVER PROPERTIES

User Context and Data Signer Properties

These properties are based directly on the values you enter on the Management Console Session Settings page. The property names correspond

Metaserver.ProcessManager.maxInstanceStackDepth

Also is a safeguard. Processes may invoke other processes in a recursive or non-recursive fashion. In order to protect the Server from recursive processes that may execute forever, a recursion limit (the stack depth) is specified using this property. Every time this limit is reached, an error is returned to the client. You should adjust the default value of 10 only if you have a valid process that exceeds the recursion limit.

Metaserver.ProcessManager. isCaching.enabled

Default false. Enables process model caching. If true, the repository will not allow redeployment of processes and each service manager or client will cache the processes used when executing process instances. This property optimizes the runtime performance of processes and should always be used in a production environment.

Metaserver.ProcessManager. cacheSize

Default cache size 50. Improves runtime performance. Specifies the maximum cache size for processes. If the number of items in the cache exceeds this value, the least recently used items are discarded.

Metaserver.Metascript. isCaching.enabled

Default false. Enables metascript caching. If true, the repository will not allow redeployment of metascripts and each service manager or client will cache the metascripts used when executing metascript instances. This property optimizes the runtime performance of metascripts and should always be used in a production environment.

Metaserver.Metascript. cacheSize

Default cache size 50. Improves runtime performance. Specifies the maximum cache size for metascripts. If the number of items in the cache exceeds this value, the least-recently used items are discarded.

Metaserver.ProcessManager. spi.xslt.removeSourceName spaces

Controls whether or not the XSLT provider strips namespaces and prefixes from source documents. If true, prefixes and default namespaces are removed.

Table 4-10 Process Manager Properties (continued)


4-12 RELEASE 6.0 REV: A02 300-010-272

SERVER PROPERTIES

to the field names you see on the Management Console. Never modify these values by hand. Always use the Management Console to change the default values, if necessary. Session properties are explained in detail in “Session Settings” on page 1-3.

Other Properties

Other notable properties in engine-config.xml are described below.

Table 4-11 Other engine-config.xml properties


Metaserver.showSystemVS Show or hide the system virtual server. Requires an Server restart. Do not change this value.

login.configuration.provider This is the class that is used for obtaining Server login information. The default value is com.metaserver.engine.security.SecurityConfiguration.

security.enabled Enable/disable security at the virtual server level.


SERVER PROPERTIES

4-14 RELEASE 6.0 REV: A02 300-010-272

5Chapter
Performance Tuning 1
Topics in this section:• Overview• Performance Considerations• Using Caching to Improve Performance

Overview 1

The EMC Ionix IT Automator Server is flexible and scalable and can be configured in a variety of ways for maximum performance, fault tolerance, and throughput. There are a number of factors that impact performance. However, the final tuning of the system depends on the actual work being done by each of the metalinks and must ultimately rely on trial and error.

This chapter provides suggestions and techniques for maximizing system performance. Once again, you will need to invest time and effort in understanding the bottlenecks and performance parameters of your specific configuration. For example, you may want to put the primary server on the machine that has the fastest clock speed, or you may want to add memory to the processing servers if you are passing large amounts of data.

Performance Considerations 1

All of the following issues affect Server performance to one degree or another. Some are more important than others but any one of them can have a major impact on performance if not used properly. To optimize Server performance, be sure to keep all of these factors in mind when building and deploying your system. If you have questions or need help after reading these pages, contact EMC Ionix IT Automator Customer Support.

Use the following basic techniques to analyze performance:1. Estimate the average client load and examine throughput under those

conditions. Start with a small number of clients, metalinks, and service managers then increment the numbers as you analyze the throughput.

2. To find bottlenecks, analyze the network traffic as well as CPU activity on the Automator servers and on the service managers.


PERFORMANCE CONSIDERATIONS

Load Distribution

The Server is designed to be a distributed system. You should ensure that the processing load is as evenly distributed as possible. For example, your applications may use a graphing metalink that is particularly slow and CPU-intensive yet needs to be part of every process. In this case you will want to distribute the load by running multiple instances of this metalink on several physical machines. If there is a surge in demand for the services of this metalink, the load will automatically get distributed across the physical machines.

Metalink and Metascript Granularity

Typically, metalinks should be designed so that they are coarse-grained. For example, you should not create a metalink that adds one to its input and does nothing else. The metalink will function normally, but the overhead of sending the request over the network to the machine (executing the metalink, receiving the response, backing up the request in a fault tolerant configuration, etc.) will be very high relative to the actual processing being performed. In other words, most of the execution time will be spent in network traffic overhead. This quickly leads to network congestion and congestion on the primary and secondary servers.

Metalinks should perform functions that are much coarser in terms of granularity. For example, reasonable metalinks will run a database query or call a web service. In summary, the physical distribution of metalinks across processing servers is a function of their relative granularity. This ensures that the overhead of distributed processing (the network latency and data transfer time) is amortized over a significant amount of actual processing. If the network overhead time is and the processing time is you should strive to ensure that the ratio / is as small as is reasonably achievable.

Metascripts on the other hand are lightweight, reusable scripting components that you can use to model and reuse fine-grained logic. BeanShell metascripts can be reused in a process or in a mapping definition and may contain highly-complex BeanShell script with custom logic. However when the logic becomes too complex, the overhead required to execute the metascript within a process defeats the purpose of using a metascript in the first place. For best performance, keep the logic simple and limit metascripts to discrete, re-usable, self-contained functions. Both BeanShell and Transform metascripts are best used for simple, repetitive tasks like date format conversions, string concatenations, and the like. If a function requires complex processing, it may be preferable to use a Java or .NET metalink.

Memory

To obtain maximum performance, it is critical that you ensure availability of sufficient memory. Even though the Server is based on the concept of virtual

5-2 RELEASE 6.0 REV: A02 300-010-272


shared memory (an advanced technique for distributed and parallel programming), you do not want the Server to swap to disk repeatedly.

In general, EMC recommends at least 2 GB of memory on all servers. However, the amount of memory that is right for your Server depends on numerous factors including its configuration, the number of items in its repository, the number of concurrent users, the amount of data being transferred in processes, etc.

Network Configuration

In many cases, the network and its configuration are the limiting factors for performance. You need a reliable, high performance network. The vast majority of the overhead in a distributed system is related to network latency and traffic costs. However, the massive advantages provided by a distributed system totally outweigh these costs. You can reduce the overhead significantly by paying attention to the configuration of your network.

You should invest in the fastest possible network connections between the Automator servers, processing servers and client machines. Further, you should ensure that, on each machine, the DNS settings or host file information are accurate. Otherwise, you may experience a significant delay when starting the Server. This is because the primary and secondary servers will need to perform a reverse host name lookup based on the IP address of all the other machines. This reverse name lookup will rely on proper configuration of the network properties. In a fault tolerant environment, reliability of the network is especially important. Refer to “Performance Considerations” on page 2-6 for information on network considerations when you have enabled automatic failover.

Java Virtual Machine

A Java Virtual Machine (JVM) is required on the Automator Server(s) and all processing servers. The performance of the JVM has a substantial impact on Server performance. However, all other components of the Server, such as service managers, use Java. You should ensure that you have the latest and highest-performance production release for your chosen platform. All EMC Ionix IT Automator components are heavily multi-threaded and native multi-threading in the JVM is basically a requirement for performance.

EMC currently recommends using JDK 1.6 to build your applications. You may also need to adjust the JVM size if you are caching processes and metalinks; see “Using Caching to Improve Performance” on page 5-6 for more information.

Logging

The EMC Ionix IT Automator Server may be configured to generate log information at various levels. The logging system is very general. However, generating logs incurs performance overhead and EMC recommends setting



the log level to generate Fatal and Error messages only. Informational and Warning messages should be disabled in a production environment. This is the default configuration after you install the Server. For a complete description of Server logging, see “Server Log Files” on page 3-1.

Process Verification

The client can be configured to have the Server automatically start all metalinks required for a particular process to complete. For example, if a request comes in for a process that requires a particular metalink (which is part of the process), and no instance of the metalink is running, the Server will find a service manager that is configured to run the metalink and will attempt to start the metalink on that service manager. If it fails, it will return an error message to the client. However, even if it is successful, the service manager will be chosen at random. The Server does not attempt to make any intelligent decisions in order to optimize the mix of metalinks on the back end.

When subsequent requests arrive for the same process, the Server examines the process and determines that there is already at least one instance of the metalink (and all other metalinks in the process) running. It will take no further action. This process verification is useful but incurs significant overhead and is discouraged in a production environment. In a production environment, you should have your system carefully analyzed and set up to ensure that there are several instances of every metalink configured to automatically start on different physical machines. As long as you have done this, the facet of resource management described here is redundant.

High Availability

High Availability allows you to deploy a fault tolerant system that is resistant to failures on one or more machines. This mode also increases performance and offers load balancing. Configuring separate Server instances on different machines, with the same virtual server, and pointing each Server to a common highly available database allows you to cluster the Job Scheduler. A clustered scheduler enables jobs to be executed on either Server instance and also provides redundancy in the event an Server instance goes down.

The EMC Load Balancer can also be included to load balance incoming web service requests through the web service gateway. The load balancer will round robin requests to each Server instance configured in its farm. The load balancer also detects when an Server instance is unreachable and remove it from the farm in this situation. This provides you with a redundancy mechanism and a means to add more throughput by adding additional Server instances.

In general, EMC recommends using the high availability features to improve performance and add fault tolerance to your solutions.

5-4 RELEASE 6.0 REV: A02 300-010-272


Session Persistence

Process data is associated with a unique usercontextID. This is simply a lengthy, unique string that is generated by the server, which is digitally signed for security purposes. The usercontextID is used by the client as a tag that identifies process data unique to the particular client session on the Server. The Server usually saves process data in memory on both the primary and secondary servers to ensure availability after a failure of either server.

Paying close attention to the UserContext Flush Interval setting on the Management Console “Session Settings” on page 1-3 page can help performance tuning. If the interval is too large, the user context data can build up, which will utilize memory and may lead to swapping and degraded performance. If the interval is too small, performance can be decreased because the Server threads that remove the user context will wake up too often. EMC also recommends including an explicit logout in your clients. This removes user context information.

Virtual Servers

Virtual servers provide a very useful mechanism for separating two applications that use the same physical system. However, virtual servers do incur some overhead. On the Automator Server machines, every virtual server consumes some memory just by virtue of being created. This memory usage typically depends on the number of processes in the repository for that virtual server and is usually not significant.

EMC recommends using virtual servers to separate applications from one another. This ensures that there are no metalink or process collisions between applications, particularly with regard to naming. See “Virtual Servers” on page 1-4 for more information about virtual servers.

Subprocesses

Subprocesses are beneficial because they allow you to use modular programming techniques in your process models. However, subprocesses incur an execution overhead when compared to the execution time if the subprocesses are simply inlined.

Database Requests

EMC strongly recommends using the Database metalink for database requests, including SQL queries and stored procedures. Using COM metalinks for database requests will severely impact performance due to the conversion overhead.


USING CACHING TO IMPROVE PERFORMANCE

Access Control

Access Control Lists (ACLs) can be used to specify which users or groups can execute a process. ACLs may contain user names as well as group names. EMC recommends using both users and groups for access control just as you would for any other application. When users log in into a virtual server, the groups the user belongs to are determined by the specified security provider. These users and groups are populated directly from the LDAP, NT, or File security provider. See “Defining Security Providers” on page 9-1 for details.

The time taken for this login step is a factor of the time taken by the security provider to authenticate the user based on user name and password and to determine the groups the user belongs to. This small overhead is only incurred when virtual server security is enabled. (By default, virtual server security is disabled.) See “Access Control” on page 1-5 for more information about access control.

Using Caching to Improve Performance 1

You can substantially improve Server performance by caching processes and metascripts . Caching stores processes and metascripts directly in service manager and client memory the first time they are requested. As a result, subsequent invocations are substantially faster because the items are available directly from cache and do not need to be accessed over the network. Caching is especially helpful for processes that have nested subprocesses because it eliminates round-trips to the Server repository every time a process or metascript is invoked. Caching is disabled by default while in a single-server environment, but it is a good idea to enable caching when you move into a multi-server environment.

Process and metascript caching consumes memory. If you enable caching, you may need to adjust the Java VM size on the processing servers where the service managers are running (see When to Change the JVM Size) and also add physical memory to those machines before you see any improvement in performance. You enable caching (and cache size) for each virtual server by changing the properties in <installroot>/engine/config/engine.l4j.ini on the primary server machine only; you set the Java VM size on the processing servers that are running service managers in <installroot>/engine/config/engine-console.properties. See “Java Virtual Machine” on page 5-3 for more about performance considerations and the JVM.

Note: Use extreme caution when editing engine-config.xml orengine.console.properties. Use Notepad or a similar editor and be sureyou are changing the right properties. If you introduce errors or corruptthe file, the engine may fail or return invalid data.

5-6 RELEASE 6.0 REV: A02 300-010-272


Before You Enable Caching

Although it can significantly improve performance, and you can still deploy new processes and metascripts to a virtual server, there are also certain constraints to consider before you decide to enable caching.

If you enable caching, you cannot: • re-deploy (i.e., overwrite) processes and metascripts with the same name • remove any processes or metascripts currently in the repository • disable a virtual server from the Management Console even though it appears

you can do so. (When you disable a virtual server with caching disabled, all running processes are allowed to complete gracefully; if caching is enabled, you can only stop the virtual server – in which case all running processes terminate immediately.)

To perform any of these actions, you must disable caching and restart the Server.

To cache processes and metascripts:1. For each virtual server, set

Metaserver.ProcessManager.isCaching.enabled and Metaserver.Metascript.isCaching.enabled to true in engine-config.xml. Each virtual server has a separate section in this file and the default is false. See “engine-config.xml” on page 4-9 for more information.

2. For each virtual server, set Metaserver.ProcessManager.cacheSize and Metaserver.Metascript.cacheSize to the smallest appropriate value for the virtual server. The default cache size is 50. This means that 50 processes and 50 metascripts are cached by default. For optimum performance, estimate the number of processes and metascripts in the virtual server repository that will be used repetitively and set the cache size to that value. If you exceed the maximum, the next process or metascript invoked will simply replace the least recently used item in cache. See “engine-config.xml” on page 4-9 for more information.

When to Change the JVM Size

To a large extent, performance improvement is a result of trial and error. It depends on the specific configuration of your environment and you will need to experiment with different JVM sizes to get the best results. The size of the JVM becomes a factor when you cache a large number of processes and metascripts. If you keep the default cache size at 50 processes and metalinks, it is unlikely you will need to change the size of the JVM. However, if you increase the JVM size for a service manager, you may also need to add physical memory to the processing server to see an improvement in performance.

The JVM heap size determines how long and how often the virtual machine spends collecting garbage. (Garbage collection is the JVM process for freeing up unused Java objects – those that can no longer be reached from any pointer in a running program.) If you set a large heap size, garbage collection



is slower, because there is more heap to scan but occurs less frequently. If you set a smaller heap size, garbage collection is faster, but occurs more often. For details about changing the JVM size, see “How to Change the JVM Size” on page 1-10.

5-8 RELEASE 6.0 REV: A02 300-010-272

IIPart

Server Management Console 1Topics is this section• Server Management Console Overview• Server Security• Virtual Server Security• Defining Security Providers• Managing Virtual Servers• Using Service Managers• Using the Repository• Starting and Stopping Metalinks• Using Listeners• Scheduler• Monitoring and Reporting

EMC IONIX IT AUTOMATOR SERVER AND MANAGEMENT CONSOLE USER GUIDE

RELEASE 6.0 REV: A02 300-010-272

6Chapter
Server Management Console Overview 1
Topics in this section:• Overview• Starting the Management Console• Server Home Page• Virtual Server Home Page• Understanding Automator Users• Adding and Removing Users

Overview 1

The Server Management Console is a graphical interface to the EMC Ionix IT Automator Server that runs in a standard browser. The Management Console allows you to manage the EMC Ionix IT Automator Server regardless of whether you have a single machine server configuration or a fully distributed environment. For best results, use Microsoft Internet Explorer 6.0 or later at a screen resolution of 1024x768.

The Management Console is automatically installed with the Automator Server. Before you can access the Management Console, the EMC Ionix IT Automator Tomcat or Java Admin Service must be running on the Automator Server machine.

Starting the Management Console 1

To start the Management Console:1. Based on whether you installed Windows Services, perform the appropriate

task: — If you installed the Automator as a Windows Service, ensure that the

Automator Tomcat Service is started. For more information, see Controlling the Automator Server with Windows Services.

— If you did not install the Automator as a Windows Service, start the Server Console and start the Java Admin Service. For more information, see Controlling the Automator with the Server Console.


GETTING A USER NAME AND PASSWORD

2. Start the Management Console. — From the Start>All Programs menu, select installroot >

Tools>Management Console. — From a browser window, type the host name where the Automator

Server is running followed by the port number (typically 8088) where the Admin Service is configured to start (see Logging In). For example:

http://machinename:8088/wmc

3. Enter a valid User Name and Password (see Getting a User Name and Password). This displays the Server Home Page or the Virtual Server Home Page (depending on how you logged in). The user name you logged in with is displayed above the Help button on the menu bar.

Figure 6-1 Login Window

Getting a User Name and Password 6

The Server is initially installed with one default Server administrator. The default user name and password pair is admin and admin. All Server users (and groups of Server users) are defined through your chosen security provider. Once you have defined users, you can create additional Server and virtual server administrators. Most likely you will want to change the default

Table 6-1 Login Window fields

Field Description

User name The Management Console always requires at least one Server administrator and is installed with a default Server administrator. The default user name and password pair is admin/admin. This lets you add users, set permissions, etc. as soon as the installation is complete. To change the default Server administrator and password, see “Security Providers” on page 1-2.

Password Passwords are created when you add users via a security provider.

6-2 RELEASE 6.0 REV: A02 300-010-272

GETTING A USER NAME AND PASSWORD

Server administrator once the Server is initially installed. See “Defining Server Administrators” on page 1-5 and “Defining Virtual Server Administrators” on page 1-6 for more information.

As noted, users (and groups) are created using your selected security provider. Each user name is associated with a specific password. For example, if you are using LDAP as a security provider, you must use the user interface in your LDAP application to define user names and passwords; if you are using NT domain security, you must use the Windows NT interface. If using File security, you use the EMC Ionix IT Automator File security interface to create user names and passwords.

All users and passwords are created within the context of a security provider and you use the functionality in the specified provider to add or change users and passwords. User name and password changes take effect at the next login – there is no impact on users who are currently logged in. Protect your password carefully. If you forget your user name or password, contact an Server administrator for help.

Logging In

When the EMC Ionix IT Automator software is first installed, the user name and password pair of admin and admin will allow complete access to all functions. However, once you define users and groups within your selected security provider, access will be restricted based on login credentials (see “Defining Security Providers” on page 1-1 for more.) Multiple users can log in with the same user name and password, on the same machine, or on different machines. For this reason and to avoid conflicts, it is important to implement a structured system of access privileges, especially in a production environment. You can also use the “Session Settings” on page 1-3 settings on the Server to set time-out values for Server administrator sessions.

Any user who logs in as an Server administrator has complete control over the EMC Ionix IT Automator Server. However once you implement a security provider, access for most users will be limited to a subset of virtual servers. You also will want to coordinate Management Console user activity so that two different users do not perform conflicting operations. For example, you do not want one user stopping a service manager while another is trying to start it.

The Admin Service (which runs the Management Console) is configured to start on port 8088 on the primary server. Therefore, to access the Management Console, you type the host name or IP address of the machine where you installed the primary server followed by 8088.

Logging Out

Server administrators and virtual server administrators have different privileges. For this reason, it is often useful to log out and then log back in as a different user. The name of the user currently logged in is shown above the Help button on the menu bar. You can log out by clicking Logout on the menu


MANAGEMENT CONSOLE TERMS

bar. This toggles the label to Login and you can log back in as a different user. This is the recommended way to log in and log out. If you simply close the browser without logging out, the Server session remains active until it times out according to expiration time set for Server sessions.

Management Console Terms 6

Most of the following terms are specifically related to the Management Console.

Table 6-2 Management ConsoleTerms

Item Description

Deployment The result of copying any process model or metalink from the IDE (or from a deployment file) to one or more servers. Once items are deployed to a server, you can manage and run them.

Server Configuration tool

A utility that lets you change the configuration settings for the Server. For example, you use the Server Configuration tool to enable or disable failover.

Server Console An application that lets you start and stop Java services running on the Server.

Server Home page

Displayed when you log in as an Server administrator. It provides access to the entire Server and lets you drill down into any virtual server. It consists of a tree menu with security options and a content panel that shows virtual servers and options for managing them.

Fault tolerance A core feature comprised of load balancing and scalability. This means that the Server can be configured to withstand any single point of failure. The Server can be configured for full or partial fault tolerance.

Machine name A name you supply during the service manager installation process to uniquely identify the processing server (physical machine) on which the service manager is being installed.

Service manager

Lightweight containers that manage the life-cycle and execution of metalinks. A service manager runs on a processing server and tracks any configuration parameters needed to run metalinks.

Primary service manager

The service manager created automatically when any virtual server is created. A virtual server's primary service manager runs the system services required to keep the virtual server functioning properly.

6-4 RELEASE 6.0 REV: A02 300-010-272

MANAGEMENT CONSOLE NAVIGATION

Management Console Navigation 6

You must be a Server administrator or a virtual server administrator to log into the Management Console. • If you log in as an Server administrator, the Server Home page is displayed.• If you login as a virtual server administrator, the Virtual Server Home page is

displayed. Most Management Console windows have a tree menu on the left, a content panel on the right, and menu bar at the top. Most items in the tree menu have a corresponding item in the content panel. In many cases you can navigate to

Primary server The primary server refers to a physical machine running required components of the Server. This machine runs the primary virtual shared memory server (a core component of the Server) and the primary service managers for all virtual servers on the Server.

Processing server

Any machine where you have installed a service manager. Processing servers participate in process execution by hosting the execution of metalinks whereas the primary server runs internal system services required to keep the Server running and monitor its status.

Security Provider

Controls all administrative actions possible on the Server and its virtual servers. The Server security provider defines the users and groups who can administer the Server and each virtual servers. The virtual server security provider defines the users and groups who have read, write, and execute permissions within a specific a virtual server.

Virtual Server A mechanism for grouping a set of related items (metalinks and processes) into an entity with common properties. At runtime, the items in one virtual server are kept independent of items in another virtual server.

Virtual Server Home page

Displayed when you drill down into a specific virtual server. It provides access to all functions relating to the specified virtual server. It has a tree menu on the left and a content panel on the right with Security, Repository, and Metalink Managers options.

Virtual Server List page

Displayed when you log in as a virtual server administrator. This page shows all of the virtual servers you are allowed to access. You can drill down into any virtual server by clicking on the hyperlinked name.

Table 6-2 Management ConsoleTerms (continued)

Item Description


MANAGEMENT CONSOLE NAVIGATION

items from hyperlinks in the content panel but the instructions in this guide generally only explain how to navigate using the tree menu.

Figure 6-2 Virtual Server Home Page

The menu bar is located directly above the content panel. The items on the menu bar do not change: you can go home, log in or out, or get help. Click the Home label to navigate to the appropriate Server or virtual server "home" page.

Click Help on the Management Console toolbar to launch the help system. The online help has full-text search and provides quick access to the Management Console help topics.

Table 6-3 Menu Bar options

Menu Bar Item Description

Home Returns you to the appropriate home page from anywhere in the window system. If you are logged in as an Server administrator, it returns the Server Home page; if you are logged in as a virtual server administrator, it returns the Virtual Server Home page.

Login/Logout Toggles between Login and Logout. Typically, you log out and then log back in as a different user with different privileges. Login is displayed when you are logged out and vice versa. The name of the user currently logged in is shown above the Help button on the menu bar.

Help Displays the online help system for the Management Console.

6-6 RELEASE 6.0 REV: A02 300-010-272

SERVER HOME PAGE

Server Home Page 6

The Server Home page is displayed when you log in as an Server administrator. It gives you access to the entire Server and lets you drill down into any virtual server. It consists of a tree menu on the left and a content panel on the right. The tree menu shows configuration data and options you can use to implement Server security; the content panel shows all defined virtual servers and options to manage them. From the Server Home page you can drill down into any virtual server. All running virtual servers are hyperlinked; if you mouseover a running virtual server, you can drill down into the home page for that virtual server and perform any virtual server functions.

Figure 6-3 Server Home Page

This is the only page in the Management Console from which you can view all the virtual servers in the system. This is also the only page from which you can create virtual servers. Unless you are on the Server Home page (or the Virtual Server List page), you are generally working in the context of a specific virtual server. The functions in the content panel are fully described in “Managing Virtual Servers” on page 1-1.

Server Tree Menu 6

The Server tree menu has items that show Server Configuration properties and Server Security options. The Security options in the tree menu are all related to Server security. They let you define a security provider, set Server admin session settings, and define administrators for both the Server and all virtual servers. See “Server Security” on page 1-1 for a complete description of these features.


SERVER TREE MENU

Note: You can navigate to most items on the Server Home page from the treemenu or the content panel. However, this document only describeshow to navigate from the tree menu.

Figure 6-4 Server Tree Menu

Configuration

The Configuration sections at the bottom of the Server tree include Server Properties and Processing Servers.

• The Server Properties section shows the version of the Server, machine name on which the Automator Server is installed and the port number on which it is configured to run.

Figure 6-5 Server Properties

• The Processing Servers section shows the machine names and current state of each processing server configured to connect to the Server. The appropriate icons indicate if the server is running ( green triangle icon) or stopped (red box icon). You can also click to view logs.

6-8 RELEASE 6.0 REV: A02 300-010-272

SERVER TREE MENU

Figure 6-6 Processing Server Status


VIRTUAL SERVER HOME PAGE

Virtual Server Home Page 6

When you log in as a virtual server administrator, the first thing you see is the Virtual Server List page. This page shows all virtual servers you are allowed to access and a tree menu with Server Configuration properties.

Figure 6-7 Virtual Server List Page

You can drill down into any virtual server by clicking on the hyperlinked name of any running virtual server (with a green Start/Stop icon). This displays the Virtual Server Home page (Figure 6-8).The Virtual Server Home page is displayed when you drill down into a specific virtual server. It provides access to all functions relating to the specified virtual server. It has a tree menu on the left and a content panel directly below the name of the virtual server. The tree menu basically has the same functionality as the content panel. You can navigate to most items using either the tree menu or the content panel.

6-10 RELEASE 6.0 REV: A02 300-010-272


Figure 6-8 Virtual Server Home Page

Table 6-4 Virtual Server Home Page

Item Description

ServiceManagers

Service Managers allow you to create, start, and stop individual service managers and view the entire service distribution. You can also view and configure individual metalinks. Each service manager has its own Configuration page, from which you can modify or remove existing metalink configurations for that particular service manager.

Repository • Deploy – lets you deploy .jar files previously created in the IDE.

• Metalinks – lets you view, configure, or remove metalinks in the repository.

• Metascripts – lets you view or remove metascripts in the repository.

• Processes – lets you view or remove processes in the repository.



Virtual Server Option Menus

The virtual server option menus show all of the functionality available within a virtual server. The option menus are always present. You can navigate to any item on the Virtual Server Home page using the option menus. The virtual server name is always displayed directly above the option menus. The following screens show the functions available with the various option menus.

Scheduler • Current Jobs - This view will show you a list of scheduled jobs that are currently executing.

• Jobs - This view will show you a list of all scheduled jobs that have been configured to execute.

• Scheduler Calendar - This shows a graphical calendar view, with jobs appearing on the days they are scheduled to execute.

• History - This view enables you to see a list of all scheduled jobs that have executed. Results depend on the filter criteria you set.

Monitoring Monitoring allows you to turn on or turn off historical monitoring for the virtual server, choose settings for the monitoring repository, select which Server events you want to record, and generate pre-built Server activity reports.

Security • Providers – allows you to select a security provider for this virtual server.

• Settings – enable/disable virtual server security and define expiration and encryption settings for client sessions with the Server.

• Access Control – allows you to define read, write, and execute permissions for user and groups, and set execute permissions for processes.

Table 6-4 Virtual Server Home Page (continued)

Item Description

6-12 RELEASE 6.0 REV: A02 300-010-272


Figure 6-9 Service Manager Menu

Figure 6-10 Repository Menu

Figure 6-11 Scheduler menu

Figure 6-12 Monitoring Menus

Figure 6-13 Security Menu

The menus will be similar for any other virtual server you have created on the Management Console. The only differences will be the name of the virtual server, and the specific service managers that are connected to it. To navigate to a page, click on any link in the tree. Keep in mind that any page you access represents functionality for the displayed virtual server only. To navigate to a page for a different virtual server, click Home on the menu bar to return to the Virtual Server Home page and then select a different virtual server. As noted, the hyperlinks on the content page provide the same functionality as the tree menu. See the appropriate sections of this document for complete details.


UNDERSTANDING AUTOMATOR USERS

Understanding Automator Users 6

Server users and virtual server users typically perform specific functions based on their roles within the organization. At the most basic level, there is an important distinction to be made between administrators and other users: Server and virtual server administrators log into the Server; developers and business process users log into a virtual server. There are four types of EMC Ionix IT Automator users.

Server Administrators 6

Server administrators can administer the Server and all virtual servers. They can perform all of the actions allowed to Server administrators and all of the actions allowed to virtual server administrators. Only Server administrators can create virtual servers. Server administrators can:

• Create, remove, or archive virtual servers.• Change the Server security provider.• Change the session settings.• Define Server administrators.• Define virtual server administrators.• Perform all virtual server functions.

The EMC Ionix IT Automator Server is installed with one default Server administrator. Once a Server administrator logs into the Server, they can change the security provider in the Server from the default of File security. The security provider gives access to the user and group information that protects

Table 6-5 User Roles

Role Description

Server administrator Administer the entire Server and can archive and create virtual servers. All Server administrators have the same privileges.

Virtual server administrator

Administer one or more virtual servers. They can also start and stop virtual servers and configure repository items and service managers.

EMC Ionix IT Automator developer

IDE developer who typically works within a single virtual server and may need to read or write (i.e. deploy) to that virtual server from the IDE.

Business process user

The end user of a business process. An authenticated end user who can execute a business process on a virtual server.

6-14 RELEASE 6.0 REV: A02 300-010-272

SERVER ADMINISTRATORS

the Server from unauthorized access. Subsequently, all administrative login requests will be authenticated against the chosen security provider.

Virtual Server Administrators

Virtual server administrators have unlimited privileges within the specific virtual server(s) they are authorized to access. Virtual server administrators can perform all virtual server administrative actions except creating a new virtual server. Virtual server administrators can:

• Start, stop, and archive virtual servers.• Enable and disable virtual servers.• Modify the security provider, session settings, and access control for virtual

servers.• Deploy and remove resources from the virtual server repository.• Configure resources in the virtual server repository.• Configure and manage service managers.

Automator Developers

EMC Ionix IT Automator developers are business process developers who typically deploy metalinks and processes and view the contents of a single virtual server. They generally require read and write permissions on a specific virtual server from the IDE modeling environment. EMC Ionix IT Automator developers cannot administer the Server or the virtual servers. See Virtual Server Security in the IDE User Guide for more information.

Business Process Users

Business process users are end users, for example bank customers, who execute a process in a virtual server. If necessary, they are validated by the bank's authentication system (e.g. an LDAP server) before they can execute a business process from their home banking application. Business process users may be allowed to execute some processes on a virtual server but not others. For example, all bank customers may be allowed to run a process that displays a mortgage calculator. However, only bank managers are allowed to run a process that creates a new account. In this case the bank manager must be defined as a valid user (and have "execute" rights) in the virtual server where the "create new account" process is running.

In addition, user permissions may also be associated with a specific process. In this example, a user would need to be defined as a virtual server user, and have execute permissions for the "create new account" process, in order to run that process.


../MME/ServerExplorer.html


ADDING AND REMOVING USERS

Adding and Removing Users 6

The concept of users and groups is fundamental to understanding how security is implemented in the Management Console. EMC Ionix IT Automator users include Server and virtual server administrators, developers, and business process users (see Understanding Automator Users). However, only Server administrators or virtual server administrators can use the Management Console. EMC Ionix IT Automator developers and business process users can read and write to a virtual server repository or execute business processes. They log into a virtual server but they do not log into the Management Console. User names for developers and business process users apply to access control where they are assigned certain read, write, and execute permissions within a virtual server.

Note: User names are not case sensitive, although the Management Consolepreserves the manner in which they are defined in the security provider.For example, if you create a user John Hancock, it is displayed as JohnHancock, but you can log in as John Hancock or john hancock.Passwords, however, are always case sensitive. If you define a passwordas Philadelphia, you cannot use philadelphia.

Anyone who will be granted administration or other user privileges in the Management Console must first be defined with the user interface for the security provider you are using. For example, if you are using an LDAP server, you define users and groups with the LDAP interface supplied with that LDAP server. These users go into a pool of available users and can then be assigned as administrators, developers, or business process users. Users can also be combined into groups; groups also have privileges, and the members of each group inherit all of the privileges assigned to the group.

You can define users and groups using LDAP, Windows NT, or EMC Ionix IT Automator's proprietary File security feature. All users and groups available in the Management Console must first be defined within the context of a selected security provider. Once defined, the various Management Console windows that show available users and groups are populated with the users and groups defined in this security provider. These are shown as Available Users but they do not receive any permissions or privileges in the Server until an administrator makes them Assigned Users.

The process of adding users is straightforward; see “Defining Security Providers” on page 1-1 for details. Once the Available Users panel on the left is populated by the security provider, you simply highlight the users and click Add or Remove as appropriate.

6-16 RELEASE 6.0 REV: A02 300-010-272


Figure 6-14 Adding Users

The right panel containing the list of Assigned Users is created and persisted in the Server. This means that if you change the security provider and define new users (or manually remove existing users such as former employees), the list of Assigned Users may not match the list of Available Users. There may be users in the "assigned" list that are no longer present in the "available" list. Although these users remain in the "assigned" list, they no longer have permission to log into the Server as administrators, developers, or business process users. They cannot be given new permissions; they can only be removed from the "assigned" list.

The following window shows the Access Control window for a process with mis-matched assigned and available users. The security provider was changed and consequently "bill" is shown as an assigned user (in red) even though he is no longer available.

Figure 6-15 Administrators Screen

Similarly, if you display the User Permissions on the Access Control pages on this virtual server, the user "bill" is shown in red. Again, this means that



although he is an assigned user for a process, "bill" is not a valid user within the context of the current security provider.

Figure 6-16 User Access Control

6-18 RELEASE 6.0 REV: A02 300-010-272

7Chapter
Server Security 1
Topics in this section:• Overview• Security Providers• Session Settings• Administrators

Overview 1

The Server refers to your runtime Server environment, regardless of how many physical machines you have. It always includes a primary server and one or more service managers. Server security controls all administrative actions that are possible on the EMC Ionix IT Automator Server and its virtual servers. Any user logging into the Server from the Management Console (or through the Server API) either as an Server administrator or a virtual server administrator is authenticated and authorized to perform specific functions. In terms of Server security, authentication establishes who you are and authorization determines what functions you can perform.

The information used to authenticate and authorize administrators is defined within a security provider. All other users logging into the Management Console, either as developers or business process users are also authenticated and authorized; this information also comes from the security provider.

Logging In as an Server Administrator

The login window is displayed when you access the Server from a browser. The same window is displayed for Server administrators or virtual server administrators. Only those users who are defined as Server administrators or virtual server administrators can log into the management console. (Other users such as EMC Ionix IT Automator developers, may be allowed to read or write to a virtual server repository, but they cannot perform administrative functions.) Server administrators can administer the entire Server; virtual server administrators can administer one or more virtual servers. The default user name and password pair is admin and admin for the Management Consoel.


SECURITY PROVIDERS

The login window is the same for all users, but the subsequent workflow differs depending on whether you log in as an Server administrator or a virtual server administrator.

To log in as an Server administrator:1. Launch the Server. See Controlling the Automator with the Server Console

if you need help.2. Launch the Management Console from a browser. See Starting the

Management Console if you need help. When the login window is displayed, enter a user name and password if required.

3. After you log in successfully as an Server administrator, the Server Home Page is displayed.

Figure 7-1 Server Home Page

The Server Home page is displayed when you successfully log into the Management Console as an Server administrator. This is the home page for Server administrators. The tree menu on the left under Server Security has links to Provider, Settings and Administrators pages. The Administrator section shows links to the Server Administrator pages, as well as links to pages in which you define user privileges for each virtual server.

Note that there is no repository information shown in the tree menu. The tree on the Server Home page is only used to administer the Server; to see repository items, you must click on a virtual server and drill down into the repository for that specific server. The menu items in the tree are summarized here and described on the following pages. The options on the Virtual Servers panel are described in “Managing Virtual Servers” on page 1-1.

Security Providers 7

This page is used to select a security provider for the Server. In the context of the Server, the security provider determines who can administer the Server and the virtual servers. The Server and the virtual servers each have their own security providers and they may be of different types. For example, the Server

7-2 RELEASE 6.0 REV: A02 300-010-272

SESSION SETTINGS

may use an LDAP provider while the virtual servers use NT. (The security provider for a virtual server is used to define the users and groups who have read, write, and execute permissions within that virtual server.)

The mechanism by which you define a security provider, however, is the same for the Server or a virtual server (see “Defining Security Providers” on page 1-1 for an explanation). Note that if you change the security provider for the Server, you must stop and start the Server before the changes take effect. To do this, you use the Server Console to stop and start all services running on the Automator Server and all processing servers (see “Starting and Stopping Java Services” on page 1-6 for details).

Session Settings 7

This page is displayed when you select Server Security > Settings from the tree menu. Session settings on the Server have a slightly different meaning from session settings on a virtual server. On the Server, these settings refer to the expiration and encryption settings for administrator sessions with the Server. Expiration settings refer to the duration of an Server admin session before it times out from no activity; encryption settings specify the encryption algorithm used to encode the data. Use Restore Defaults to reset all fields to system defaults.

Expiration settings let you specify the duration of an Server admin session before it times out from no activity. When the session expires, the UserContext that represents the Server administrator session is destroyed and any actions you try to perform from the Management Console will return an error message. If you log in again after the session expires, the Server will establish a new session.

Encryption settings support digitally signing passwords so they cannot be compromised. A MessageDigest provider is used to ensure that the password signature cannot be converted back to the original data. User passwords are digested and stored as part of the credential stored in the user context associated with an authenticated user. If the user attempts to re-login supplying a user name and password, the supplied password is digested and matched against the stored digested password, before re-associating this user with a previously established user context.


ADMINISTRATORS

Figure 7-2 Server Security Settings

Administrators 7

The tree menu lets you define Server administrators and virtual server administrators. An Server administrator can administer the Server and all virtual servers; a virtual server administrator is typically limited to one or more virtual servers. To guarantee access to the Management Console, there must

Table 7-1 Server Security Settings Field Descriptions

Field Description

User Context Expiration Time

Controls the number of seconds after which the Server administrator session will expire if there is no activity. The default is 24 hours (86400 seconds).

User Context Flush Interval

Controls how often the Server will destroy expired user context information. The default is two hours (7200 seconds). Keep in mind that this clean-up process uses CPU cycles and may impact Server response time. You may wish to experiment to find the ideal setting for your production environment.

Data Signer Class Name

The default EMC Ionix IT Automator security class generates digital signatures with the MD5 algorithm. If you do not wish to use this data signer, you may enhance security by providing your own data signer classes. You will need to add these classes to the CLASSPATH of the Automator Server machine and additional server machines (if High Availability is configured).

Data Signer Provider

If using a third-party data signer, enter the provider's name here. Otherwise, leave the default of SUN.

Data Signer Algorithm

Leave the default of MD5, unless you are using a third-party data signer that uses an algorithm other than the MD5 algorithm. Refer to the Sun Java Cryptography Extensions and Provider Framework for information on how to use different Data Signer Provider and Data Signer Algorithm values.

7-4 RELEASE 6.0 REV: A02 300-010-272

ADMINISTRATORS

always be at least one available user (or a group with an available user) assigned as an Server administrator. An error message will display if you try to remove the last assigned user.

Defining Server Administrators

This page lets you manage the list of users assigned as Server administrators. Anyone designated as an Server administrator can perform all tasks related to Server or virtual server administration. You also use this window to edit the list of groups with users who are assigned as Server administrators. The users and groups shown in this window are defined when you select a security provider. See “Adding and Removing Users” on page 6-16 for more information.

To define Server administrators:1. Go to Server > Administrators > Server Administrators.2. Add or remove users and groups as explained below.Figure 7-3 Server Administrators

This window shows all existing users and groups and is populated by the security provider. (If you are not sure which users are in a particular group, you need to check the information in the security provider.) The boxes on the left show all users and groups. You define which of these can administer the Server by adding the user or groups to the boxes on the right.

The procedure is the same for groups. You can add multiple users or groups at once by selecting the ones you want. Reverse this process to remove users or groups and click Save when done.

If you need to add a new user or group to the list, you must first do this on the security providers; otherwise, the user or group name will not appear in the boxes on the left. As soon as you define your new user or group in your security provider, the Management Console will immediately recognize the new entry. You do not have to restart the Server or edit any files. The same is true if you need to remove a user from the list. Simply remove the user or


ADMINISTRATORS

group from your security provider and the user or group will be automatically removed from the list of available users.

Defining Virtual Server Administrators

This page lets you define the administrators for each virtual server. These users and groups are defined when you specify and implement a security provider. A virtual server administrator can perform all tasks related to virtual server administration. You can also use this window to edit the list of groups assigned as administrators for the specified virtual server. The users and groups shown in this window are defined when you select a security provider. See “Adding and Removing Users” on page 6-16 for more information.

To define virtual server administrators:1. Go to Server > Administrators.2. Click a defined virtual server.3. Add or remove users and groups as explained above.Figure 7-4 Virtual Server Administrators

7-6 RELEASE 6.0 REV: A02 300-010-272

8Chapter
Virtual Server Security 1
Topics in this section:• Overview• Logging In as a Virtual Server Administrator• Security• Access Control

Overview 1

A virtual server groups a set of related items (metalinks and processes) into an entity with common properties. At runtime, the items in one virtual server are kept independent of items in another virtual server. A virtual server also groups service managers, users, groups, access control lists, etc. into the same entity. In a typical EMC Automator installation with one server and multiple virtual servers, a virtual server is simply a logical vertical slice of the Server with its own security controls. When you log into the Management Console as a virtual server administrator, you see only those virtual servers for which you have access. Only Server administrators can allow access to virtual servers; only Server administrators can create virtual servers.

Logging In as a Virtual Server Administrator 1

The login window is displayed when you access the Server from a browser. The same window is displayed for Server administrators or virtual server administrators. Only those users who are defined as Server administrators or virtual server administrators can log into the management console. Server administrators can administer the entire Server; virtual server administrators can administer one or more virtual servers. The login window is the same for all users, but the subsequent workflow differs depending on whether you log in as an Server administrator or a virtual server administrator.

To log in as a virtual server administrator:1. Launch the Server. See Controlling the Automator with the Server Console

if you need help.


SECURITY

2. Launch the Management Console from a browser. See the Starting the Management Console if you need help. When the login window is displayed, enter a user name and password if necessary.

3. After you login as a virtual server administrator, the Virtual Servers List page is displayed. It shows all virtual servers that the virtual server administrator who logged in can access. See “Managing Virtual Servers” on page 1-1 for a complete description of the functions on this page.

Figure 8-1 Virtual Servers List page

4. Click on any virtual server to drill down into the Virtual Server Home page. The Virtual Server Home page is displayed when you successfully log in as a virtual server administrator. This is the home page for virtual server administrators. Remember that the virtual server information on all subsequent screens is only relevant in the context of the specific virtual server you drilled into after login, the name of which appears on the top of the page. Note that there is no way to create a virtual server on the Virtual Server Home page. You must be logged on as an Server administrator to create a virtual server.

Security 8

You can access the following virtual server security page by clicking Security on the Virtual Server Options menu bar. Alternatively, you can jump to a specific topic by selecting it from the Security drop-down menu.

8-2 RELEASE 5.8 REV: A02 300-010-272

SECURITY

Figure 8-2 Service Manager Distribution

Figure 8-3 Security

Provider

This page is used to select a security provider for the virtual server. In the context of a virtual server, the security provider determines who can access the virtual server. The Server and the virtual servers have separate security providers and they may be different. For example, the Server may have an LDAP provider and a virtual server may have a File provider. The mechanism by which you define a security provider, however, is the same for the Server or a virtual server. For a complete explanation of how to implement a security provider, see “Defining Security Providers” on page 1-1. If you change the

Table 8-1Security Options

Option Description

Providers Lets you select a security provider for the virtual server. If you select File as a security provider, you can also use these pages to define users and groups. See “Provider” on page 1-3.

Settings Enable/disable virtual server security and define expiration and encryption settings for client sessions with the Server. “Settings” on page 1-4.

Access Control Determines who can read, write, or execute in each virtual server. See Access Control.


SECURITY

security provider for a virtual server, you must stop and start the virtual server before the changes take effect.

Note: The security provider for the Server has a different function. The Serversecurity provider is used to define users and groups of users who canadminister the Server and the virtual servers.

Settings

This page lets you define virtual server settings for access control, and session expiration and encryption. Access control enables read, write, and execute permissions for developers and business process users. (It is not related to who can administer the Server or a virtual server; Server and virtual server administrators are defined by Server administrators.)

The Access Control Setting determines whether or not access control is enabled on the virtual server. If access control is Enabled, you can define read, write, and execute privileges for developers and business process users as explained in “Access Control” on page 1-5. If access control is not enabled in this window, any access control permissions you set for developers and business process users are ignored. This means that anyone will be able to log into a virtual server and read, write, and execute business processes.

Session settings on the Server have a slightly different meaning from session settings on a virtual server. On a virtual server, these settings refer to the expiration and encryption settings for developer and business process user sessions with the Server. Expiration settings refer to the duration of an end-user session with the virtual server (i.e. a business process session) before it times out from no activity; encryption settings specify the encryption algorithm used to encode the data. The Session Expiration and Session Encryption settings are identical to those used by the Server. See “Settings” on page 1-4 for a description of the settings.

8-4 RELEASE 5.8 REV: A02 300-010-272

ACCESS CONTROL

Figure 8-4 Banking Server Security Settings

Access Control 8

In the context of a virtual server, access control determines who can read, write, or execute in each virtual server. Access control is applied to each user, each group, and each resource (i.e. each business process). Access control defines what actions an authenticated user is allowed to perform. See “Understanding Automator Users” on page 1-14 and “Adding and Removing Users” on page 1-16 for more information about EMC Ionix IT Automator users and how they are defined.

Note: You must explicitly enable access control by clicking Settings on thetree menu (see “Settings” on page 4). If you do not enable accesscontrol on this page, all access control for this virtual server, asdescribed below, is ignored.

Table 8-2Security Setting Fields

Field Description

Access Control Settings Enable/Disable access control for a virtual server. If you do not enable access control in this window, any other access control settings for this virtual server are ignored. If not enabled, any user can log into a virtual server and execute a business process. If you change this setting, you must restart the virtual server from the Virtual Server Home page before the changes will take effect.

Session Expiration Lets you specify the duration of a developer or business process user session before it times out from no activity. See “Session Settings” on page 1-3.

Session Encryption Lets you specify the encryption settings for digitally-signed passwords. See “Session Settings” on page 1-3.


ACCESS CONTROL

The list of potential users that can be granted access permissions comes from your security provider. These users include not only Server and virtual server administrators, but EMC Automator developers and business process users as well. Developers are Server users if they will be interacting with a virtual server on the Server from the IDE. For example, a developer must have "read" privileges to drag items from a virtual server (shown in the IDE Server Explorer) into the Process Designer. A developer must also have "write" privileges to deploy metalinks and processes to a virtual server. Access control can also be applied to resources.

Figure 8-5 Access Control

For example, you may want to use access control at the resource level in order to apply finer-grained control over who can execute a specific process.

Global Access Control

These pages let you define "global" user and group permissions in the selected virtual server. These permissions define the read, write, and execute privileges for each available user and group. In this context, "global" refers to all permissions that can be assigned to a user (as opposed to "process" permissions that specify who can execute a process). It is important to note that if you have global Execute permissions (or Full Access), you can execute all processes deployed to a virtual server even if you have not been added to the access list for a specific process.

Table 8-3Access Control Field Descriptions

Field Description

Global Access Control Lets you define individual read, write, and execute permissions in the selected virtual server.

Process Access Control Lets you define execute permissions for each individual process in the selected virtual server.

8-6 RELEASE 5.8 REV: A02 300-010-272

ACCESS CONTROL

Figure 8-6 Global Access Control - Users and Groups

Users

User permissions apply to developers and business process users. An EMC Automator developer builds business processes using the IDE modeling environment. A business process user is typically an end-user running a EMC Automator business process from their desktop at home or at work. This page lets you define the access permissions for each of these users in a specific virtual server. These permissions enable users to read or write, or execute in the virtual server repository. The users shown in this window are populated dynamically from the users defined in your security provider. Use the checkboxes to enable or disable permissions. Alternatively, you can click All or None to enable/disable the entire column. Click Apply changes when done.


ACCESS CONTROL

Figure 8-7 User Access Control - Read, Write, Execut Access

Groups

This page lets you define the same access privileges described above for groups of users. These permissions enable groups to read or write, or execute in the virtual server repository. The groups shown in this window are populated dynamically from the groups defined in your security provider. Click All or None as appropriate.

Table 8-4User Access Control Options

Option Description

Read Applies to developers – gives a developer permission to read from the virtual server repository. This means, for example, that an IDE user can drag an object from the virtual server repository into a business process.

Write Applies to developers – gives a developer permission to write (i.e. deploy) objects to the virtual server repository. This means, for example, that an IDE user can deploy a process to the specified virtual server.

Execute Applies to business process users – gives a business process user permission to execute a process in the virtual server.

Full Access Applies to all users – gives the user full access. They can perform read, write, and execute actions on any appropriate objects in the virtual server repository.

8-8 RELEASE 5.8 REV: A02 300-010-272

ACCESS CONTROL

Figure 8-8 Group Access Control

Process Access Control

This page lets you modify the access control lists for individual resources in the specified virtual server. Processes are the only current "resource" for which you can define access control. You may want to use access control at the resource level in order to apply finer-grained control over who can execute a specific process.

Processes

This page lets you modify the access control lists that specify the named users who can execute processes on the virtual server. It enables access control at the process-specific level and lets the virtual server administrator apply finer-grained access control over who can execute a process. Access control is a function of virtual server security. You enable or disable virtual server security using the Access Control Settings page (see ““Settings” on page 1-4 for more information). By default, virtual server security is disabled.

Note: If virtual server security is disabled, anyone can execute a process afterlogging into a virtual server. If virtual server security is enabled, onlyAssigned Users can execute a process after logging into a virtual server.

You can create user and group access control lists (ACLs) for any EMC Automator business process. Consequently, each process can have a unique list of authorized users and groups. In order to enforce an ACL for a process, you must (1) select a security provider and define available users and groups, (2) enable virtual server security on the Settings page, and (3) assign users who have "execute" permissions.

To specify access control for a specific process:1. Go to Access Control > Process Access Control.2. Click the Processes icon and use the following window to define the users and

groups who can execute a process to the Assigned Users panel.


ACCESS CONTROL

Figure 8-9 Process Access Control - Assigned Users

3. Click on Edit Access Control beside the process for which you want to define user access. The following page appears.

Figure 8-10 Process Access Control

This window shows all existing users and groups and is populated by the security provider. (If you are not sure which users are in a particular group, you need to check the information in the security provider.) The boxes on the left show all users and groups. You define which of these can access a process by adding the user or groups to the boxes on the right. The procedure is the same for groups. You can add multiple users or groups at once by selecting the ones you want. Reverse this process to remove users or groups and click Save when done.

If you need to add a new user or groups to the list of Available Users, you must first do this on the security providers; otherwise, the user or group name will not appear in the panel when you try to modify the process ACL. As soon as you define your new user or group in your security provider, the Management Console will immediately recognize the new entry. You do not have to restart the Server or edit any files. The same is true if you need to remove a user from the list. Simply remove the user or group from your security provider and the user or group will be automatically removed from the list of available users. See “Adding and Removing Users” on page 1-16 for more information.

8-10 RELEASE 5.8 REV: A02 300-010-272

9Chapter
Defining Security Providers 1
Topics in this chapter• Overview• Defining File Security• Defining LDAP Security• Defining NT Security

Overview 1

The Server and the virtual servers have separate security providers and are defined independently. Similarly, each virtual server has its own security provider that is defined independently of all other virtual servers. For example, the Server can have an LDAP provider; one virtual server can be using NT domain security; another virtual server may have File security. Although the security provider has one function on the Server and an entirely different function on a virtual server, the mechanism by which you define the security provider is exactly the same.

This section describes how to define a security provider on the Server or on a virtual server.• The Server security provider defines users and groups who can administer

the Server and all of the virtual servers. If you change the Server security provider, you must stop and start the Server.

• The virtual server security provider defines the users and groups who have read, write, and execute permissions within a specific a virtual server. If you change the virtual server security provider, you must stop and start the virtual server. (See Changing the Security Provider for more about starting and stopping the Server or a virtual server.)


OVERVIEW

Supported security providers are listed below. Note, depending on your environment, not all security providers may be available.

Choosing a Security Provider

There are several things you need to consider before choosing a security provider. First, if you have a UNIX operating system, NT security is not a functional option even though it's shown on the drop-down menu. Second, and more importantly, File security is provided simply as a convenience for EMC Ionix IT Automator developers. It is extremely useful when testing applications but does not provide the enterprise-level security required in a production environment. The bottom line is that NT and LDAP provide a solid framework for enterprise-level security. Once you are ready to move into a production environment, it is strongly recommended that you implement LDAP or NT security.

To select a security provider:1. Select Server Security > Providers from the Server tree menu.2. When you select a security provider from the dropdown list, a corresponding

dialog window is displayed.3. Restart the Server or the virtual server. When you change the security

provider, either for the Server or for a virtual server, you must restart the Server and the virtual server respectively. See Changing the Security Provider for more information.

What is File Security?

File security is built around a proprietary EMC Ionix IT Automator .xml file that provides user authentication. (See “Defining File Security” on page 9-3 for a complete description of how it works.) If you use File security, all users and groups are defined within the Management Console and saved in <installroot>/engine/config/security-ug.xml. This file is basically unprotected although you can use the file- or directory-based security options in your operating system to gain a small measure of protection. File security is not supported in Server configurations that include failover.

Table 9-1 Supported Security Providers

Provider Description

File Selects a proprietary EMC Ionix IT Automator authentication file. All users and groups are defined in a proprietary .xml file. See Defining File Security.

LDAP Selects a local or Web-based LDAP server that queries a user-defined LDAP-compliant directory for authentication. See Defining LDAP Security.

NT Implements Windows NT security. The NT Users and Passwords utility lets you configure accounts and assign permissions to users and groups. See Defining NT Security.

9-2 RELEASE 6.0 REV: A02 300-010-272

DEFINING FILE SECURITY

If you choose File security, the interface that manages users, groups, and passwords is built into the Management Console (whereas LDAP and NT have their own interface). Therefore, if you choose File security, you must be able to log into the Management Console as a Server or virtual server administrator in order to use the interface. If you can’t log in, you can't use the interface to modify those users and groups who can log in.

You should also understand that all Server and virtual server administrators can modify the security file. This means that one virtual server administrator can potentially remove all other Server and virtual server administrators or change their passwords. This will prevent anyone from logging in. (See Replacing the Security File if you need to recover from an altered or damaged security file.)

Changing the Security Provider

When you change the security provider for the Server, you must restart the Automator Server and all processing servers. When you change the security provider for a virtual server, you only need to restart the virtual server. After you are finished changing the security provider, typically after you apply changes and get a "success" message, restart the Server and/or virtual servers as follows:

• To restart the Server, refer to “Controlling the Automator Server with Windows Services” on page 2-2 or “Controlling the Automator with the Server Console” on page 2-3.

• To restart a virtual server, refer to “Starting a Virtual Server” on page 10-6.

Updating Users and Groups

Be aware that if you change security providers it is always possible that users and groups may be defined in one security provider and not in another. For example, some users may be assigned as administrators, but they are not available Management Console users (as defined using the interface of the selected provider). See “Adding and Removing Users” on page 6-16 for more information about how to resolve these potential issues when changing providers.

It is also possible that you might inadvertently remove all users and groups from the security provider for the Server. If this happens, no one will be able to log into the Management Console. If you are using File security, follow the steps in “Replacing the Security File” on page 9-8; if you are using NT or LDAP, refer to the software documentation or contact your network administrator.

Defining File Security 9

File security provides minimal protection and is intended for a development environment only. It has fundamental limitations that make it unsuitable for a



production environment and is not supported in Server configurations that include failover (see Choosing a Security Provider for a discussion of the issues). The File Security provider lets you use a proprietary .xml file to define users and groups. This file (security-ug.xml) however is only as secure as your file system. For this reason, don't put it in a shared network folder or in any location that can be accessed by all users in the domain.

You can also take additional steps to make the file (or the file system) more secure. For example, you can change the way passwords are encrypted. All passwords are initially encrypted with the same MD5 algorithm used for encrypting Server administration sessions. If you change the algorithm, you implicitly change the way passwords are encrypted as well. See “Session Settings” on page 7-3 for more about how to change the encryption method.

Note: File security provides a minimal level of authentication protection andis not intended for a production environment. However, one notableadvantage is that you do not have to be connected to an LDAP (orother) server to run the Management Console.

To quickly implement file-based security:1. Select Security > Provider from the drop-down list.2. In Users, click Edit for an item. (Or select Add User to add new.)3. Enter a new password, click Save and then close the window.4. Click Add Group in the Groups area.5. Enter a new group name and then add the user you just created to the group.6. Click Save.

9-4 RELEASE 6.0 REV: A02 300-010-272


Figure 9-1 Security Provider screen

Adding Users and Groups

You must use the windows shown below to define users and groups who can access the system; you cannot edit the file manually. The users and groups

Table 9-2 Security Provider screen functions

Item Description

User/Group File Location

Required. Enter the path to the .xml security file which contains user and group definitions. The default path is shown above. If you specify a non-existent file name in a valid folder, the file will be created with the default credentials admin/admin. If the folder does not exist, an error message is displayed.

By default, there is one security file for all users and groups including administrators, developers, and business process users. If you want to segregate users into different .xml files, you can rename the file and/or save it in a different location. For example, you may want to segregate users by virtual server or you may want to have a separate file that only includes Server administrators.

Edit Users Launches a window so you can add users and define passwords. See the Edit Users window.

Add Groups Launches a window so you can add groups and add or remove users. See the Add Users to Groups window.



displayed in these windows are defined when you implement a File security provider.

Edit Users

Use this window to add or remove users and to set passwords. Any removed user is automatically removed from all groups in which they were included.

Figure 9-2 File Provider User Form

Add Users to Groups

Use this window to define groups and to add users to those groups. To add users to groups, enter a Group Name and select an available user to move to the Current Users list. Note that since users and groups are defined separately, removing a group does not change the list of defined users.

Table 9-3 File Provider User Form Field Descriptions

Field Description

Username Shows the name of the user being modified.

Password Enter the new password.

Confirm Password

Re-enter the new password to confirm the change.

9-6 RELEASE 6.0 REV: A02 300-010-272


Figure 9-3 File Provider Group Form

Edit Group Members

Use this window to add members to the groups you created above. To add or remove members, move the users back and forth using the appropriate buttons.

Table 9-4 File Provide Group Form Fields

Field Description

Group Maximum 32 alphanumeric characters; no special characters except underscore, hyphen, period, space.

Available Users Select a user and then click on the arrow to add or remove users in the highlighted Group Name.

Current Users Shows the current user in the defined group.


DEFINING LDAP SECURITY

Figure 9-4 File Provider Group Form

Replacing the Security File

With File security, all administrators are defined in security-ug.xml. This means that one virtual server administrator can potentially remove all other Server and virtual server administrators or change the passwords. This will prevent anyone from logging in. Use the following procedure to log in if the security file has been altered or damaged. Once logged in, you can create valid Server and virtual server administrators.

To log in if the security file has been altered or damaged:1. Rename or remove the current users/groups file used by the Server security

provider in: <installroot>/engine/config/security-ug.xml.2. Replace the existing Server policy file in the folder shown below with a copy

of the file by the same name included in <installroot>/engine/config/ps_root.jar. Use WinZip or a similar tool to extract the file.

<installroot>/engine/servers/default/ps_root/_security/engine/_resources/SecurityPolicy/SecurityPolicy.res

3. Restart the Server and log in using admin/admin.

Defining LDAP Security 9

LDAP security is intended for use in a multi-server environment. This window shows the fields you will need to complete if you choose LDAP as a security provider. You must create an LDAP directory that defines users and groups using a third-party LDAP tool. For a complete description of the fields, see “LDAP Settings” on page 9-10. Note that if you subsequently change to a different security provider your original settings are not retained.

Table 9-5 File Provider Group Form field descriptions

Field Description

Available Users Select a user and then click on the arrow to add or remove users in the highlighted Group Name.

Current Users Shows the current user in the defined group.

9-8 RELEASE 6.0 REV: A02 300-010-272

http://www.winzip.com/


Before you implement an LDAP security provider, it is important to remember that if you do not have an LDAP connection to authenticate users, you won’t be able to log into the Server. For this reason, it is strongly recommended that you choose File security if you are working in a development environment.

Click on Change Security Provider at the bottom right of the Provider page. The following page appears.

Figure 9-5 Security Provider

Select LDAP from the drop-down menu and click on Next. The following page appears.

Figure 9-6 Security Provider screen

Once you have entered all the information in these fields, click on Next. The following page appears.

Table 9-6 Security Provider Field Descriptions

Field Description

Cancel Cancels the change of security providers.

Restore Defaults

Resets all the fields to the defaults. If you change the security provider, the window will refresh with empty fields for the selected provider.

Test Tests the connection to the specified LDAP Host Name and the settings on this page. This will perform a connection test to the LDAP server and verify that the user and groups are returned successfully. (There will be no users displayed if the list is empty.)



Figure 9-7 Security Provider screen - Regular and Admin Users

Define the user and group privileges and click on Finish to save your changes.

To use LDAP, you must configure an LDAP server and define the LDAP server settings on the Management Console. EMC has tested against Netscape Directory Server 3.1 and 4.52, but supports any directory server meeting the LDAP v.2 specification. This documentation assumes your LDAP server is properly configured prior to using the EMC Ionix IT Automator application. Your LDAP server must be running whenever the Server is running. Otherwise, you will not be able to authenticate users or groups.

LDAP Settings

The first time you select LDAP as a security provider, the page will be pre-filled with default settings, some of which you will need to change. Once you have connected to your LDAP server, you will rarely need to modify these settings. However, if you do need to modify these settings (for example, because you want to use a different LDAP server), you should disable your virtual server and allow any currently running processes to complete. Once you have done this, change the LDAP settings and restart and enable the virtual server so your changes will take effect. In addition, you may need to reconfigure processes with existing ACLs to ensure that any resulting changes in user and group information are reflected.

Table 9-7 LDAP Field Descriptions

Item Description

LDAP Host Name DNS name or the IP address of the machine where your LDAP server has been configured.

LDAP Port Port used by your LDAP server.

9-10 RELEASE 6.0 REV: A02 300-010-272


LDAP Base Distinguished Name (DN)

Base DN corresponds to the top level organization that is defined in your LDAP Server. In this field, type o= followed by the Base DN. For example, if your top-level organization is mycompany.com, type o=mycompany.com.

LDAP User ID Attribute

The LDAP directory will contain an entry for each user. The entry may have several attributes such as first name, fax number, uid, etc. The value in this field determines which LDAP attribute should be used to uniquely identify each user. Typically this value will be uid.

LDAP User ID Filter Lets you use a subset of your defined users as opposed to importing every user name from your directory. For example, user entries may have a DN of the form uid=smith, ou=people, and o=mycompany.com. Typically, you will want to set the value of the filter to (uid=*), assuming you do not wish to filter your list of available users, and uid is the value you entered in the LDAP User ID Attribute field.

This field supports wild card expressions, which you can use to specify a subset of users. For example, perhaps all members of a particular department have user IDs that begin with hr. If you type uid = hr* in this field, only those users whose IDs start with hr would be included in the Management Console's list of available users.

LDAP User Base DN

Specifies the value of the base DN for user entries. The DN for a specific user is created by concatenating the values you enter in the LDAP Base Distinguished Name (DN) field, this field, and the LDAP User ID Attribute field. For example, using the example in the LDAP User Id Filter description, the DN for a specific user would be uid=smith, ou=people, o=mycompany.com.

LDAP Group ID Attribute

The LDAP directory will contain an entry for each group. The entry may have several attributes such as group name, group ID, etc. The value in this field determines which LDAP attribute should be used to uniquely identify each group.

Table 9-7 LDAP Field Descriptions (continued)

Item Description


DEFINING NT SECURITY

Defining NT Security 9

EMC Ionix IT Automator runs on Windows 2000 and Windows 2003. When you select NT as a security provider, you are using the authentication mechanism built-into Windows NT. (If you are running on Solaris or Linux, any attempt to apply changes will fail.) If you select NT as a security provider, you define users and groups using the Windows NT interface.

In Windows NT, you can define users and groups at the local level or at the domain level. At the local level, you define the users and groups who can access your local machine. Local security is basically a mechanism used to test users and groups on your local machine before moving to a production environment. At the domain level, your NT system administrator defines users and groups using the Windows NT Server interface. Domain security requires that the Server be running on a Windows NT Server.

LDAP Group ID Filter

Lets you use a subset of defined groups. For example, group entries may have a DN of the form cn=QA Department, ou=groups, o=mycompany.com. When searching the directory, the Server will retrieve the records that satisfy the specified filter. The filter is specific to the LDAP server implementation. As with the User ID Filter field, you can use wild card expressions to filter the groups.

LDAP Group Base DN

Value of the base DN for group entries. The DN for a specific group is created by concatenating the values you entered in this field, the LDAP Group Id Attribute field, and the LDAP Base Distinguished Name (DN) field. Using the example in the LDAP Group ID Filter description, the DN for a specific group would be cn=QA Department, ou=groups, o=mycompany.com.

LDAP Uids in Group Attribute

The directory has an entry for each group with several attributes, such as group ID, group name, etc. This property determines the name of the attribute used to list members of the group. The value is specific to the LDAP server implementation.

LDAP Connection Timeout

Amount of time in milliseconds that the Server security service waits for a response from the LDAP server; default is 15000.

Table 9-7 LDAP Field Descriptions (continued)

Item Description

9-12 RELEASE 6.0 REV: A02 300-010-272


Figure 9-8 Security Provider Authentication screen

After selecting an authenticator, click on Next. The following page appears in both instances.

Figure 9-9 Security Provider Regular Group - Admin Group

To define users and groups locally using Windows NT:1. Log in with an account that is part of the local Administrators group.2. Go to Start > Settings > Control Panel > Users and Passwords.3. Then navigate to Advanced > Advanced User Management to create users,

groups, and passwords. These are the users and groups that will populate your EMC Ionix IT Automator panels.

If you type "local" in the text box, the users you created in Step 3. above will be shown as Available Users in the various Management Console panels where you define administrators and assign permissions. If you type "domain" in the text box, the Available Users panels will be populated with the users defined in

Table 9-8 Security Provider Authentication screen field descriptions

Field Description

Authenticator Select Domain or Local from the drop-down menu.

Type the name of the Windows NT provider that will be authenticating users: "local" authenticates against the list of users defined on your local machine; "domain" authenticates against the list of users defined in the domain you are currently logged into.



the Windows NT domain you logged into. These domain users are created and maintained by the Windows NT administrator.

9-14 RELEASE 6.0 REV: A02 300-010-272

10Chapter
Managing Virtual Servers 1
Topics in this chapter:• Creating a Virtual Server• Starting a Virtual Server• Enabling a Virtual Server• Archiving a Virtual Server

Overview 1

Depending on whether you log in as an Server administrator or a virtual server administrator, you will see either a list of all virtual servers or only those virtual servers you are allowed to access. The page is the same except that an Server administrator can also Remove and Create virtual servers. The Server Home page is the only page in the Management Console where you can see all virtual servers. It shows a complete list of virtual servers from which you can select by clicking the hyperlink. This drills down into the contents of that specific virtual server. This is also the page where you create new virtual servers. You can always return to the Server Home page or the Virtual Server Home page, depending on how you are logged in, by clicking Home on the menu bar.

The Server Home page or the Virtual Server Home page will initially have no virtual servers created. The following screenshot shows the content panel for the Server Home page. You can tell it’s the Server Home page because it has Create and Remove buttons. Only Server administrators can create or remove virtual servers. Also, Server administrators will see all virtual servers while virtual server administrators will only see the servers they are allowed to access.


OVERVIEW

Figure 10-1 Virtual Server List

Table 10-1 Virtual Server Options

Option Description

Virtual Servers The name of each virtual server is displayed. If the virtual server has been started, the name is displayed as a hyperlink when you mouseover it. The hyperlink jumps to the home page for that virtual server.

Restart Restarts any virtual server that is currently running. Associated scheduled jobs are paused and resumed.

Start/Stop The icon is green or red depending on whether the virtual server is running or not running. See Starting a Virtual Server.

Enable/Disable Nothing is displayed in this column when you initially create a virtual server. After you start the virtual server, a checkmark will appear to indicate that user access is enabled. A red exclamation point ! means user access has been disabled. Disabling a virtual server does not abort a running process, but it prevents subsequent clients from launching a process. See Enabling a Virtual Server.

Remove Server administrators only. This button appears in this column in case you want to remove the virtual server entirely. The Remove button only appears when the virtual server is stopped. You must stop a virtual server before you remove it. See Removing a Virtual Server.

Archive Archives an existing virtual server as a .jar file. It can then be re-created in the existing Server installation or in a different Server installation. See Archiving a Virtual Server.

Create Virtual Server From Archive

Server administrators only. Creates a new virtual server from an archived .jar file.

Create Virtual Server

Server administrators only. Creates a new virtual server from scratch.

Refresh This refreshes the page with the latest data from the Server. Do not use the Refresh button on your browser. Depending on your settings, a browser refresh may simply reload the page from cache.

10-2 RELEASE 6.0 REV: A02 300-010-272

CREATING A VIRTUAL SERVER

Note: If you are accessing the Server Home page immediately after starting theServer, you may need to click Refresh because your virtual servers have notyet started.

Creating a Virtual Server 10

To create a new virtual server, you must be logged in as a Server administrator. Only Server administrators can create new virtual servers from the Server Home page. There are several ways to create a virtual server and each is discussed separately. You can:

• Create a new virtual server – use this method to create a new virtual server from scratch.

• Create a virtual server from an archive – use this method to create a virtual server from a .jar file created in either the Management Console or with the Virtual Server Migration tool.

• Create a virtual server programatically – use this method to create a virtual server using the EMC Ionix IT Automator Server API.

After you create a virtual server using any of these methods, the named virtual server is displayed on the Server Home page. The virtual server will be in a stopped state and there will be no hyperlink if you mouseover the name. The name will be hyperlinked after you start the new virtual server and refresh the page. After the virtual server has been started, you can drill down and use the Security, Repository, Service Managers, and Monitoring functions.

Note: You must be logged in as an Server administrator to create or removevirtual servers. Unless specifically noted, these pages generallydescribe Management Console functions that are available to virtualserver administrators.

Creating a New Virtual Server

Use this method to create a new virtual server from scratch. You may want to define a security provider and you will also need to populate the repository (either directly from the IDE or from a deployment file created in the IDE) and create service managers.

To create a new virtual server:1. Log in as the Server administrator.2. From the Server Home page, click Create Virtual Server to display the Create

Virtual Server page.



Figure 10-2 Create Virtual Server

3. Enter the new virtual server name and click Create Virtual Server.— New Virtual Server Name - Unique, alphanumeric string that starts

with a letter and does not exceed 32 characters. Not case-sensitive, no underscores or hyphens.

4. Be aware that it may take 30 seconds or more to create a new virtual server. The Server Home page will subsequently re-display showing the new virtual server in a stopped state. Before you can do anything else, you need to start the new virtual server (See Starting a Virtual Server). By default, the new virtual server is defined with a File security provider. You can now populate the repository, create service managers, etc., as explained in other sections of this guide.

Creating a Virtual Server from an Archive

Use this method to create a virtual server from an existing virtual server that was saved as an archived (.jar) file. Virtual servers can be archived and re-created on the same Server installation or on a different Server installation. This is how you "clone" a virtual server on the same machine. You can archive a virtual server using the Management Console (see Archiving a Virtual Server).

When creating a virtual server from an archive, the Server configuration where you are installing the archive must match the Server configuration where the archive was originally created. For example, if you archived a virtual server on a machine with a primary server and a processing server, the machine on which you are installing the archive must also have a primary server and a processing server – and they should both be started. Use the following steps to create a virtual server from an archive regardless of how the archive was created.

To create a virtual server from an archive:1. Log in as an Server administrator.2. From the Server Home page, click Create From Archive.Figure 10-3 Create Virtual Server From Archive

3. Enter or browse to the Virtual Server Archive File name and click Next. This displays the following page.

10-4 RELEASE 6.0 REV: A02 300-010-272


Figure 10-4 New Virtual Server Name

4. Enter a new name for the archived server and click on Finish to save your changes.

5. The Management Console returns to the Home page with an confirmation message that the server has been created.

Creating a Virtual Server Programatically

You can use this method to create virtual servers programatically (from archived files) instead of using the Management Console. If you are an experienced application developer, it may be faster to use the EMC Ionix IT Automator Server API to create and administer virtual servers. See the “Server API” on page 1-1 for more information about the classes in this API.

Table 10-2 Create Virtual Server From Archive Field Descriptions

Field Description

New Virtual Server Name

Unique, alphanumeric string that starts with a letter and does not exceed 32 characters. Not case-sensitive, no underscores or hyphens.


STARTING A VIRTUAL SERVER

Starting a Virtual Server 10

After you create (or stop) a virtual server, it is in a stopped state and there is no hyperlink if you mouseover the name. The name will be hyperlinked only after you start the virtual server and refresh the page. Then you can drill down and use the functionality on the tree menu.

To start a virtual server:1. From the Virtual Server Home page, click the red Start/Stop icon next to any

virtual server that is not running. It may take a few moments until the page is refreshed.

Figure 10-5 Virtual Servers

2. After you start a virtual server, the Start/Stop icon will be green and the virtual server name will be hyperlinked. Also, the Enable/Disable column will be checked to indicate that the virtual server is enabled (and available to users).

Stopping a Virtual Server

You can stop any virtual server at any time. A stopped virtual server is basically eliminated from the Server configuration of available virtual servers. When you stop a virtual server, you are stopping all service managers running under that virtual server, and stopping any metalinks running on those service managers.

To stop a virtual server:1. From the Virtual Server Home page. Click the green Start/Stop icon next to the

appropriate server. Note that this will immediately disconnect and logout all clients.

2. Click OK when the warning message is displayed. It may take a few moments before the Virtual Server Home page will be re-displayed.

3. Click Refresh if necessary.Once you stop a virtual server, the Start/Stop icon will be red and the virtual server name will not be hyperlinked. Also, the Enable/Disable column will have a red exclamation point ! to indicate that it is disabled and not available to users. This indicates the virtual server cannot be enabled because it is stopped. Also a Remove button is displayed so you can remove the virtual server entirely.

10-6 RELEASE 6.0 REV: A02 300-010-272

ENABLING A VIRTUAL SERVER

Note: When you stop a virtual server, you are stopping all service managersrunning under that virtual server, as well as any metalinks that arerunning on those service managers. All jobs on a virtual server arepaused.

Removing a Virtual Server

You can remove any virtual server at any time as long as it is stopped. To remove a virtual server, click Remove and then click OK to confirm. If the Remove button is not displayed, it means the virtual server is still running.

Be aware that by removing a virtual server, you also delete:• every process and metalink that has been deployed to the virtual server's

repository • all service managers created under the virtual server• all associated jobs and triggers

Enabling a Virtual Server 10

When you create a new virtual server, it is initially in a stopped state and no icon is displayed in the Enable/Disable column. When you start the virtual server, it will be enabled as shown by a checkmark in the Enable/Disable column. You do not have to explicitly enable new virtual servers. When a virtual server is enabled, it means that clients can execute new processes that are deployed to that virtual server. When disabled, running processes will complete but no new processes can execute. You can disable any other virtual server at any time by clicking the checkmark in the Enable/Disable column. The page will re-display with a red ! in the column. To enable a disabled virtual server, click the red ! and the page will re-display with a checkmark in the column.

Disabling a Virtual Server

Disabling a virtual server is equivalent to initiating a graceful shutdown: running processes will continue until complete, but clients will not be able to execute new processes. When a virtual server is disabled, the only processes allowed to run are system processes that the Management Console uses to control the state of the Server.


ARCHIVING A VIRTUAL SERVER

Archiving a Virtual Server 10

Archiving a virtual server means that an existing virtual server (with all of its repository, configuration information, jobs/triggers) can be saved in an archive (.jar) file and deployed elsewhere.

The archive can be deployed to the same Server installation or to a different Server installation. It can be deployed immediately or it can be saved and deployed later. (See also Creating a Virtual Server from an Archive.)

Archiving a virtual server is a good way to move a virtual server that has been created and tested in a development or staging environment into a production environment. The archived virtual server is a mirror image of the original virtual server. It has the same service managers started, the same metalinks running, as well as all the other configured items such as access control lists, virtual server status, etc. When you deploy the archived virtual server, you can change the Server name and machine name as appropriate.

The following information is a subset of the complete data that is saved in the virtual server archive:• The list of named service managers, the machine name of the processing

server, and the service managers startup state• The list of configurable properties for the virtual server and each service

manager• The list of metalinks configured to run on each service manager, including

whether or not the metalinks should start when the service manager starts, and the number of metalink instances to start

• The virtual server security provider and configuration (if any)• The virtual server jobs and triggers.

Archiving a virtual server is a two-step process. First you create an archive file and then you create a new virtual server from that archive (this second step can only be performed by an Server administrator). As noted, the archive is a mirror image of the virtual server and can be used to create a new virtual server on the same Server installation (with a different name) or to a completely different Server installation. These steps explain how to archive a virtual server.

To archive a virtual server:1. Log in as an Server administrator.2. Click the Archive icon next to any running virtual server (it must be started).

10-8 RELEASE 6.0 REV: A02 300-010-272


Figure 10-6 Virtual Servers

3. When prompted, ignore any security messages and navigate to the folder where you want to save the archive.

4. Click Save. This archives the specified virtual server as a .jar. You can now use the archive to create a new virtual server on the same Server installation or on a different Server installation. See Creating a Virtual Server from an Archive for details.



10-10 RELEASE 6.0 REV: A02 300-010-272

11Chapter
Using Service Managers 1
Topics in this section:• Overview• Creating a Service Manager• Starting a Service Manager• Viewing the Service Distribution• Changing Configured Metalinks

Overview 1

Service managers are lightweight containers that manage the life-cycle and execution of metalinks and listeners. Each service manager is associated with a specific virtual server. Service managers also keep track of configuration parameters required to run the metalinks that are deployed to that virtual server. Each service manager can run only those metalinks that have been deployed and configured on the virtual server to which it is connected. You can run identical instances of the same metalink or listener on multiple service managers, typically on different processing servers, in order to balance the load and maximize throughput. Before you can create a service manager on a processing server, you need to install the service manager software from the installation CD. See the Installation Guide for details.

To take full advantage of the distributed processing capabilities of the Server, you should create and populate a service manager on a processing server for each virtual server on the Server. See “Server Concepts” on page 1-1 for a high-level description of these and other Server concepts. As explained below, there are two types of service managers: primary and processing server service managers.

Primary Service Managers

A new primary service manager is automatically created whenever you create a new virtual server. The primary service manager provides core functionality. You cannot stop a primary service manager from the Management Console. It is automatically stopped when you stop the virtual server. Because the primary service manager runs core system services that must be available for


OVERVIEW

the virtual server to function, it is a good practice not to use the primary service manager to run your own metalinks.

Processing Server Service Managers

A processing server is any machine on which you have installed the service manager software. When you install the service manager software, you are prompted to name this processing server. The name defaults to the host name of the computer, but you can also choose a different name that is more descriptive. The name you choose is displayed in the Machine name drop-down list when you create a new service manager from the Managment Console.

You connect processing servers to the virtual servers running on the Server by creating new service managers on the processing server for each virtual server (see “Creating a Service Manager” on page 11-3). You need not create a service manager on a processing server for every virtual server, but if you don't create a service manager for a virtual server, that virtual server can't run any metalinks on the processing server. This prevents the computing load from being distributed to that processing server and defeats the concept of distributed processing.

Choosing a Class Loader

When installing the Automator Server software, you are prompted to select a System Class Loader or a Built-in Class Loader.

The System class loader is used if the service manager will be running EJB metalinks, or if you want to force the service manager to use the System class loader for some other reason. In all other cases, the Built-in EMC Ionix IT Automator class loader is used. The Built-in class loader is the default class loader option during the service manager software installation.

If you have a service manager with a Built-in class loader and need one with a System class loader (or vice versa), you must install a new service manager and choose the appropriate option during installation. (You cannot simply change the class loader using the Server Console.) See Installing the Server in the Installation Guide for more about installing the service manager software.

Note: If you re-deploy a changed metalink to a service manager that uses a

system class loader, you must stop and restart the service manager itself

before the changes take effect. If you re-deploy a changed metalink to a

service manager that uses a built-in class loader, you only need to stop and

restart the metalink.

11-2 RELEASE 6.0 REV: A02 300-010-272

../Installation/PIEInstall.html

CREATING A SERVICE MANAGER

Creating a Service Manager 1

You can create a new service manager via the Managment Console only if you have created at least one virtual server and have at least one other processing server where you have installed the service manager software and started the Service Manager service. (If you have installed the primary server and a service manager on a single machine, you can still create a new service manager because the Server considers each installation to be on a separate configured machine even though they are on the same physical machine.)

To create a new service manager:1. Drill down into any virtual server.2. Click Service Managers > Add New. Note: Add New appears in the Service

Managers Drop-down menu. You can also click on Add New Service Manager at the bottom of the Service Manager Distribution page.

Figure 11-1 Service Manager screen

3. In the Processing Server field, choose the machine name of the processing server on which you want to create a service manager. (The processing servers listed here are machines on which the service manager software was previously installed.)

4. In the Service Manager Name field, provide a unique name for the service manager. Your service manager name must start with a letter. It can have dashes and underscores but no other special characters.

5. Click Create . The page returns to the Service Manager Distribution page where a message is displayed in a box near the top of the page. The message confirms that the new Service Manager has been created successfully.

Starting a Service Manager 11

You can start or stop any service manager except the primary service manager. (This must always be running when the Server is running.) You start or stop a service manager by clicking the Start/Stop icon. A page will be displayed indicating that the service manager is being started or stopped. Then the page will refresh showing an appropriate red or green icon.


VIEWING THE SERVICE DISTRIBUTION

Stopping a Service Manager

When you stop a service manager, all metalinks and listeners running on the service manager are stopped automatically. When you restart the service manager, the number of metalink and listener instances that start is equal to the value you entered for Number to Auto-Start when you configured the metalink/listener.

Removing a Service Manager

You can remove service managers that you created explicitly via the Managment Console, but you cannot remove a service manager. In order to remove a service manager, it must be stopped. You remove a service manager by clicking Remove. A page will be displayed indicating that the service manager is being removed. Then the page will refresh showing a new list of service managers. If you remove a virtual server via the Managment Console, the virtual server's primary service manager is removed automatically.

Viewing the Service Distribution 11

The Service Distribution page displays a list of all service managers and their configured metalinks (see “Service Distribution” on page 1-1 for more information about this page.) This page shows which metalinks are on which service managers, how many are running, and how many are configured for auto-start. You can use this page to view the distribution of metalinks or to start and stop metalinks. Alternately, you can click the service manager name to display the Manage Configured Instances page for that service manager. The information on this page is similar to the Service Distribution, but is limited to one service manager.

To view the Service Distribution:1. Drill down into any virtual server.2. Go to Service Managers > Service Distribution.

11-4 RELEASE 6.0 REV: A02 300-010-272

CHANGING CONFIGURED METALINKS

Figure 11-2 Service Manager Distribution

Changing Configured Metalinks 11

Changing configured metalinks means changing or removing the configuration after it has been associated with a service manager during initial metalink configuration. This window is a quick way to view the configured services on one service manager. (Use the Service Distribution page to view configured services on all service managers.) Use this page to change the number of running metalink instances or to set the auto-start value. For example, you can set the Running value to zero to stop all running instances of a metalink.

Table 11-1 Configured Metalinks options

Option Description

Service Name of service or metalink.

Type The Type of metalink (for example, Java).

Modify If an icon is displayed, it launches the metalink configuration pages (see Modifying a Metalink Configuration). If Removed is displayed (as shown above), it means the metalink has been removed from the repository but not from the service managers where it is configured to run.

Remove This removes the configuration from this service manager only (see Removing a Metalink Configuration).

Auto-Start Number of instances to start when the service manager restarts.



Modifying a Metalink Configuration

Modifying a metalink configuration refers to changing the way a metalink was initially configured. This includes modifying the parameter values (if any), and changing the number of instances that auto-start.

Note: When you modify a configuration in this manner, you are changing theconfiguration for one service manager. To modify the metalinkconfiguration on all service managers, go to Repository > Metalinks.

To modify a metalink configuration on one service manager:1. Click the Modify icon for the metalink. If configuration values exist, they will be

displayed.Figure 11-3 Java Metalink

Status Green means at least one instance of the metalink is running; red means no instances are running.

Restart Restart the service.

Running Number of instances currently running.

Add New Service Manager

Adds a new Service Manager.

Restart All Restarts all Service Managers.

Refresh Refreshes the page.

Save Saves your configuration changes.

Table 11-1 Configured Metalinks options

Option Description

11-6 RELEASE 6.0 REV: A02 300-010-272


2. Change any or all values and click Finish. The Select Service Managers page is displayed.

3. The pages returns to the Service Manager Distribution page where a message confirms that the metalink configuration was saved successfully.

Removing a Metalink Configuration

Removing a metalink configuration means removing the metalink from a particular service manager. You can remove metalink configurations from one service manager at a time; or you can remove configurations from all service managers at once.

To remove the configuration from one service manager:1. Go to Service Managers > Service Distribution.2. When the Managed Configured Services page is displayed, click the Remove

Configuration icon for the metalink. 3. An informational message will be displayed. Click OK. (This message appears

in case the configuration you are trying to remove includes metalink instances that are currently running. When the service managers are started, they read the metalink configuration settings from a file, but do not re-read these settings until the next time the service manager is started. Thus, if a metalink instance is running, it will continue to do so until you stop the service manager or stop the metalink instance itself.)

To remove the metalink configuration from all service managers:1. Go to Repository > Metalinks.2. Check the metalinks you want to remove in the Remove from Service

Managers column.3. Click Remove checked items.

Deploying Changed or ReConfigured Metalinks

If you redeploy a new version of a metalink that is running, you need to stop all running instances (using the Service Distribution page) and restart them, before your changes will take effect. In some circumstances, you also will need to stop the running instances and remove the existing configuration, before restarting your metalinks. You need to do this when you have (1) added or removed an initialization or termination method from a metalink or (2) when you have changed metalink-level or method-level configuration values.

If you change configuration values when modifying the metalink configuration, these changes will not be incorporated in the metalinks that were running before you modified the configuration. For these changes to take effect, you must stop all instances of the metalink and restart them.

On the other hand, if you started additional instances of the metalink and changed the configuration values, the additional metalink instances will immediately recognize the new values. Consequently, you may have two different versions of the metalink running at once – one with the "old"



configuration values and one with the "new" configuration values. This may cause unpredictable results at runtime.

Note: If you are using a system class loader service manager, and youredeploy a metalink because of a change to the underlying Javaresources (in an EJB metalink, for example), you must stop the servicemanager and restart it. This is necessary because the system classloader does not reload classes that were previously loaded.

11-8 RELEASE 6.0 REV: A03 300-010-272

12Chapter
Using the Repository 1
Topics in this section:• Using the Repository• Deploying Components• Managing Components

Overview 1

Each virtual server has its own repository that you can access from the Virtual Server Home page. The Repository pages show all metalinks, metascripts, and processes that have been deployed to a virtual server, either directly from the IDE or from a .jar file previously created in the Management Console. This is important because, in order for a process to execute correctly, both the process and any metalinks, metascripts, and subprocesses used in the process must be deployed to the same virtual server. In addition to viewing the inventory of items in a virtual server's repository, you can also remove items that you will no longer use. You can only do this from the Management Console; you can't do it from the modeling environment.

The Repository pages show every item that has been deployed, including metalinks that have not yet been configured on any service managers. If a package name is supplied, the package name and item name are delimited with a period, for example packagename.itemname. Two items can have the same name, but only if they are in different packages.


OVERVIEW

Figure 12-1 Virtual Server Repository Toolbar and Drop-down Menu

Table 12-1 Repository Tabs

Tab Description

Processes Use to remove processes from the repository. See Managing Processes.

Metalinks Use to remove metalinks from the repository, remove metalinks from service managers, or configure metalinks. See Managing Metalinks.

Metascripts Use to remove metascripts from the repository. See Managing Metascripts.

Schemas This page lists any schemas that have been deployed to the virtual server. For more information on adding schemas to an EMC Ionix IT Automator project, see the "Using the Schema Wizard" topic in the IDE documentation’s "Project Explorer" section.

Web Services This page lists any Web Services that have been deployed to the virtual server. For more information on adding Web Services to a EMC Ionix IT Automator project, see the "Web Services" section in the IDE documentation.

Listeners Use to define listeners that wait for data to appear and then launch pre-defined business processes. See “Using Listeners” on page 14-1.

12-2 RELEASE 6.0 REV: A02 300-010-272

USING THE REPOSITORY

Using the Repository 12

The repository shows all metalinks, metascripts, and processes that were uploaded to a virtual server, either directly from the IDE or from a deployment file created in the IDE. Major repository functions described here include:

• Deploying Components• Managing Processes• Managing Metalinks• Managing Metascripts• Managing Schemas• Managing Web Services• Managing Listeners For additional information about defining and using file

and FTP Listeners, see the chapter, “Using Listeners” on page 14-1.

Adding and Removing Repository Items

You can add metalinks, metascripts, and processes to the virtual server repository directly from the IDE (see “Deploying to the Server” in the IDE User Guide) You can remove any of these hyperlinked items by deleting them from the virtual server repository as explained below. Hyperlinked items are blue; non-hyperlinked items are grey and cannot be removed under any circumstances. You also should never delete the FTP, File, Command, and Mail metalinks; these are system metalinks that provide useful functionality. In general, you only need to remove an item you no longer plan on using. Note that if you change an item in the IDE, for example a metalink, it overwrites the previous version with the same name when you deploy it to the virtual server.

To remove repository items:1. On the Virtual Server Home page, click Repository and select Metalinks,

Metascripts, Processes, or Listeners.2. Select the checkboxes next to the items you want to remove.3. Click Remove Checked Items and then OK to confirm. The page will refresh and

will not show the items you chose to remove.

Deploy Use to deploy .jar files created in the IDE. See Deploying Components. Note: The Deploy item does not appear on the repository toolbar; access it from the repository drop-down menu. It can also be accessed by clicking on Upload Deployment File at the bottom of each Repository page.

Table 12-1 Repository Tabs

Tab Description


DEPLOYING COMPONENTS

Note that removing metalinks from the repository will prevent the metalink from starting but it will not remove the configuration from any Service Manager on which it has been configured. To remove the metalink from Service Managers that are currently running, select the Remove from Service Managers checkbox. When removing metalinks, the Management Console does not check to see if any instances are running. If any instances are running when you remove the metalink, they will continue to run, but the next time you start a service manager that was running the metalink, an error message will display. To avoid this, select both Remove from Repository and Remove from Service Manager. See “Removing a Metalink Configuration” on page 1-7 for more information.

Always remove repository items with care. If you remove a metascript for example, any metalink or data transformation that uses the metascript will fail and return an error. As a best practice in a production environment, be sure to disable user access to a process before removing or replacing the process (or any metalinks or subprocesses used in the process). See “Access Control” on page 1-5 for details.

Deploying Components 12

This menu item is used to upload a file containing processes and/or metalinks to the current virtual server from a deployment file previously created in the IDE. For example, an IDE user who does not have permission to deploy to a specific virtual server can create a deployment file that will be deployed later by a virtual server administrator. (A deployment file created in the IDE contains process components and not an archived virtual server created in the Management Console.) See the Metalink Overview in the IDE User Guide for an explanation how to create a deployment file.

Note: Metalinks with the same name inherit the previously definedconfiguration values and do not need to be re-configured. Newmetalinks must be configured to run on a service manager before theycan be used in a process.

To upload items from a deployment file created in the IDE:1. From the Repository drop-down menu select Deploy.Figure 12-2 Repository Deploy

12-4 RELEASE 6.0 REV: A02 300-010-272

../MME/MetalinkOverview.html

MANAGING COMPONENTS

2. Browse to the file you want to deploy and click Open File.3. This immediately deploys everything in the specified file to the virtual server.

It overwrites items with the same name without warning.4. When done, a message indicates whether or not all items in the file were

successfully deployed.

Managing Components 12

Managing Processes

A process is the graphical representation of a business process that may use metalinks, metascripts, mapping definitions, and other elements. It's created in the Process Designer and deployed to a virtual server. To view processes that have been deployed to a virtual server repository, navigate to the Processes folder in the repository. The virtual server must be started; you cannot view repository items for a virtual server that is stopped. The samples.addTwoNumbers process in the following screenshot is automatically added to the repository of each virtual server you create. It's used to test if the Server is properly installed.

To view processes in a virtual server repository:1. Go to Repository > Processes to display a list of all processes in the virtual

server repository.2. Then click any hyperlinked process (displayed in blue) to display the Process

Detail page.


MANAGING COMPONENTS

Figure 12-3 Repository Processes tab

Table 12-2 Repository Processes options

Option Description

Remove From Repository

Removes the specified process from the repository and it can no longer be executed by a client. (This does not affect metalinks which can be used by multiple processes.)

Name Process name preceded by the package name, if any.

Deploy to Service Managers

Opens a page in which you select the service manager in which to run the selected metalink.

Deploy from File See Deploying Components.

Remove Checked Items

Removes the selected processes.

12-6 RELEASE 6.0 REV: A02 300-010-272

MANAGING COMPONENTS

Viewing Process Details

Click any hyperlinked process to display the Process Detail page. The information on this page was captured when the process was created in the IDE. It is read-only and cannot be edited; it can only be changed in the IDE. Click Close Window to return to the Processes page.

Figure 12-4 Process

Managing Metalinks

Metalinks are the connecting software components that link customer applications to the Server. To view the metalinks that have been deployed to a virtual server repository, click on the Metalinks folder in the virtual server repository (the virtual server must be started; you cannot view repository items if the virtual server is stopped). This displays the Repository Metalinks page which lets you view, remove, or configure metalinks. Deployed metalinks must be configured before they can run. The metalinks in the following screenshot are automatically added to the repository of each virtual server you create. See System Metalinks in the IDE User Guide for more information.

To view metalinks in a virtual server repository:1. Go to Repository > Metalinks to display a list of all metalinks in the virtual

server repository.2. Click any hyperlinked metalink (displayed in blue) to display the Metalink

Detail page (see below).


../MME/SystemMetalinks.html

MANAGING COMPONENTS

Figure 12-5 Repository Metalinks screen

Table 12-3 Repository Metalinks options

Option Description

Remove Removes a metalink from the repository but not from the service managers on which it is configured to run. Use this checkbox by itself if you plan to re-deploy a metalink and want to save the configuration data. If you do not plan to re-deploy the metalink, check both Remove from Repository and Remove from Service Managers. (If you check Remove from Repository and do not check Remove from Service Manager, a process may fail because it can’t get a metalink instance from the repository.)

Remove From Service Managers

Removes a metalink from all service managers on which it is configured to run but not from the repository.

Package.Metalink Name

Metalink name preceded by the package name, if any.

Type Service or metalink. A service provides core Server functionality and cannot be used in a process; metalinks do not provide core Server functionality and can be used in any process.

Deploy to Service Managers

Opens a page in which you select the service manager in which to run the selected metalink.


Add New Listener See the chapter, “Using Listeners” on page 14-1.

12-8 RELEASE 6.0 REV: A02 300-010-272

MANAGING COMPONENTS

Viewing Metalink Details

Click any hyperlinked metalink to display the Metalink Detail page. The information on this page was captured when the metalink was created in the IDE and can only be changed in the IDE. Click Close Window to return to the Repository Metalinks page.

Figure 12-6 Metalink

Deploying Metalinks to Service Manager(s)

Click on the Deploy to Service Manager(s) for the corresponding metalink. The following page appears.

Figure 12-7 Java Metalink - Select Service Managers

Select the service manager on which you want to deploy the metalink and click Save.


As noted, removing a metalink from the repository will prevent it from starting but will not remove the configuration from any service manager on which it has been configured. See above.

Table 12-3 Repository Metalinks options

Option Description


MANAGING COMPONENTS

Managing Metascripts

Metascripts are lightweight, reusable scripting components that are created in the IDE and may contain complex, custom logic that can be reused in a process or a mapping definition. To view metascripts that have been deployed to a virtual server repository, navigate to the Metascripts folder in the repository. The virtual server must be started; you cannot view repository items if the virtual server is stopped. There are no metascripts automatically added to the repository of a virtual server; they need to created and deployed from the IDE.

To view metascripts in a virtual server repository:1. Go to Repository > Metascripts to display a list of all metascripts on the virtual

server.2. Then click any hyperlinked metascript (displayed in blue) to display the

Metascript Detail page.

12-10 RELEASE 6.0 REV: A02 300-010-272

MANAGING COMPONENTS

Figure 12-8 Repository - Metascripts tab

Viewing Metascript Details

Click any hyperlinked metascript to display the Metascript Detail page. The information on this page was captured when the metascript was created in the IDE. It is read-only and cannot be edited; it can only be changed in the IDE. Click Close Window to return to the Metascripts page.

Table 12-4 Repository Metascripts option

Option Description

Remove Removes the specified metascript from the repository and it can no longer be executed by a client.

Name Metascript name preceded by the package name, if any.

Type Shows the type of metascript.




Removes the selected metascripts.


MANAGING COMPONENTS

Figure 12-9 Metascripts

Managing Schemas

This page lists any schemas that have been deployed to the virtual server. For more information on adding schemas to an EMC Ionix IT Automator project, see the "Using the Schema Wizard" topic in the IDE documentation’s "Project Explorer" section.

Figure 12-10Repository - Schemas

Managing Web Services

This page lists any Web Services that have been deployed to the virtual server. For more information on adding Web Services to an EMC Ionix IT Automator project, see the "Web Services" section in the IDE documentation.

Table 12-5 Repository Schemas options

Option Description

Remove Removes the specified schema from the repository.

Name Schema name preceded by the package name, if any.

12-12 RELEASE 6.0 REV: A02 300-010-272

MANAGING COMPONENTS

Figure 12-11 Repository Web Services tab

Managing Listeners

Listeners wait for an external trigger and then launch business processes that you have created in the IDE and associated with each listener. A File listener scans for files in a specified file directory and launches an action process when it detects the correct file. An FTP listener does the same for files found on a specified FTP server. You use the Management Console to create listeners for specific virtual servers.

After you create a File, FTP, Email, or Message Queue Listener, you can edit the information you entered in the listener tables or change the number of listener instances you chose to auto-start. You can also remove listeners you don't want or need anymore.

To edit, reconfigure, or remove a listener:1. Go to the home page of the virtual server where you created the listener you

want to edit, and select Repository > Listeners. The Management Console displays the Repository Listeners page, which shows any listeners that already exist on the virtual server.

Table 12-6 Repository Web Services options

Option Description

Remove Removes the specified Web Service from the repository.

Name Web Service name preceded by the package name, if any. Click on the Web Service name to see its properties (package, name, author, and description.)

View WSDL File Click to view the WSDL file associated with the Web Service.


MANAGING COMPONENTS

Figure 12-12Repository - Listeners tab

2. To remove a listener from the virtual server repository, select the Remove From Repository check box. To remove a listener only from the service managers running it, select the Remove From Service Managers check box. Click Remove Checked Items when you're done. The Management Console displays a warning prompt before it removes the listeners.

Table 12-7 Repository Listeners options

Option Description

Remove Removes the specified listener from the virtual server repository.

Remove from Service Managers

Removes the specified listener from the virtual server's service managers.

Name Listener name preceded by the package name, if any.

Type Shows the type of listener: File; FTP; Email; or Message Queue (JMS).

Edit If you click on Edit, the Management Console displays the Listener Configuration page that contains the tables you use to create a listener. See “Creating Listeners” on page 14-2 for information about using this page.




Removes the selected listeners.

12-14 RELEASE 6.0 REV: A02 300-010-272

13Chapter
Starting and Stopping Metalinks 1
Topics in this section:• Overview• Service Distribution• Starting Metalink Instances

Overview 1

After you initially configure metalinks, you can start any number of additional instances on as many service managers as necessary. Thereafter, you can start or stop additional instances, or all instances, at any time. There are two ways to start and stop metalinks. You can use the Manage Configured Instances page to start and stop metalinks on one service manager. Alternatively, you can use the Service Distribution page to start and stop metalinks on all service managers. If a metalink is not shown on either of these pages, it has not been configured on any service manager.

The Service Distribution page shows all metalinks configured to run on each service manager along with the number currently running and the number configured for auto-start. You can use this page to start additional instances of a metalink or stop current instances. To stop all running instances, set the value to zero.

Note: This chapter describes how to start and stop metalinks that are alreadyconfigured on one or more service managers.

Service Distribution 1

The Service Distribution page shows the running and auto-start status of all metalinks and services configured on all service managers in the specified virtual server. This is the only page in the Management Console from which you can see a list of all configured and/or running metalinks for a particular virtual server, regardless of which service manager is running them. (Remember that you are generally working in the context of one virtual server:


SERVICE DISTRIBUTION

you see only the service managers running under the virtual server you chose from the Virtual Server Home page.)

One row is displayed for every metalink that has been configured on a service manager. A green status icon indicates that one or more instances of the metalink is running; a red status icon indicates that the metalink has been configured, but no instances are currently running. If a metalink does not appear on this page, it has not yet been configured to run on any service manager.

To open the Service Distribution page:1. Go to Service Managers > Service Distribution.Figure 13-1 Service Manager Distribution

Table 13-1 Service Manager Distribution fields

Option Description

Service Name of service or metalink.

Type The type of metalink (for example, Java).

Modify If an icon is displayed, it launches the metalink configuration pages. If Remove is displayed (as shown above), it means the metalink has been removed from the repository, but not from the service managers where it is configured to run.

Remove This removes the configuration from this service manager only.

Auto-Start Number of instances to start when the service manager restarts.

Status Green means at least one instance of the metalink is running; red means no instances are running.

Restart Restart the service.

13-2 RELEASE 6.0 REV: A02 300-010-272

STARTING METALINK INSTANCES

Starting Metalink Instances 13

As long as the metalink has been configured, you can start one or more instances on a specific service manager at any time, regardless of whether any instances already are running. You can start and stop metalinks from the Manage Configured Services page or from the Service Distribution page. The functionality is the same with one notable difference. The Manage Configured Services page (see below) lets you start and stop metalinks on one service manager. The Service Distribution page lets you start and stop metalinks on all service managers.

To start metalink instances:1. Click Service Managers > Service Distribution.2. For each service manager, enter the number of metalink instances you want

to be Running after you apply the changes.3. For each service manager, enter the number of metalink instances you want

to auto-start the next time the service manager is restarted (either by stopping the service manager or restarting the Server).

4. Click Save when done.

5. The page will show you the refreshed number of instances.

Note: Metalinks may fail to start for various reasons, usually without beingreported to the Management Console. If you are having troublestarting a metalink, check the log files. See “Server Logs” on page 3-2.

Stopping Metalink Instances

To stop all metalink instances from running, reverse the steps outlined above and enter zero in the Running field. You may stop one or more running instances of a metalink at any time; you do not have to stop every instance. For example, you may have three running instances of a metalink and decide that one instance is enough to handle the processing requests. If you want to stop every instance of a metalink that has been configured on multiple service managers, enter zero in the Running field for each service manager.

What If You Forget to Start a Metalink?

If you forget to start a metalink, the process that uses the metalink will hang without reporting an error to the client. There are various ways to auto-start

Running Number of instances currently running.

Table 13-1 Service Manager Distribution fields (continued)

Option Description


STARTING METALINK INSTANCES

metalinks when a process executes in a development environment but they should never be used in a production environment because of the negative effect on performance. In a development environment, for example, you can set the metaserver.verify.process property in the client to True. This will automatically start required metalinks (you must have already configured the metalinks to run on at least one service manager on the virtual server). You can also request a metalink start in a development environment by using the Custom Client wizard. See “Generating a Client” in the IDE User Guide for more information.

13-4 RELEASE 6.0 REV: A02 300-010-272

14Chapter
Using Listeners 1
Topics in this section:• Overview• Creating Listeners• File Listener• FTP Listener• Email Listener• Message Queue (JMS) Listener• Configuring Listeners• Starting Listeners

Overview 1

This chapter explains how to create and configure File, FTP, Email and Message Queue listeners. A listener waits for an external trigger and then launches a business process that you have created in the IDE and associated with the listener. • A File listener scans for files in a specified file directory and launches an action

process when it detects the correct file. • An FTP listener does the same for files found on a specified FTP server. • A Message Queue listener does the same for Message Queues. You can also

configure an Email listener for a mailbox folder that you define on a specified Email server using either the IMAP or POP3 protocol.

You create and configure listeners in the Management Console for specific virtual servers; you define their action processes in the IDE. A listener action process is simply a process model linked to an instance of a listener, and it can contain the same types of metalinks or metascripts that you use in any other process model. In addition to launching an action process when it detects a file, a listener can also launch discrete processes when the listener starts and stops or when it encounters an error.

Note: You must deploy any action processes a listener uses to the samevirtual server on which you create the listener. The listener and its


CREATING LISTENERS

processes must all be running simultaneously for them to functioncorrectly.

Creating Listeners 1

To create a listener, you start the Server, launch the Management Console, and then navigate to the home page of the virtual server on which you want to create and run the listener. Like metalinks, metascripts, and processes, listeners are stored in the virtual server repository. After you create a listener, you configure it to choose how many instances of the listener you want to run and which service manager(s) will run them.

To create a listener:1. Go to the home page of the virtual server for which you want to create a

listener, and select Repository. From the bottom of any of the Repository pages, click on Add New Listener . The Management Console displays the Listener Type page.

Figure 14-1 Listener Type

2. Specify the Listener Type by selecting the specific radio button (File, FTP, EMail, Message Queue). Enter the appropriate information in the following fields:.

Table 14-1 Listender Type field descriptions

Field Description

Name The name of the listener. (Required)

Package Server package name.(Optional)

Description Text description. (Optional)

14-2 RELEASE 6.0 REV: A02 300-010-272

CREATING LISTENERS

File Listener

File Location and Name/Post File Processing

1. When you select File Listener and enter the Listener Type information, click on Next . The File Location and Name/Post File Processing page appears.

Figure 14-2 File Listener

Table 14-2 File Listener Field Descriptions

Field Description

File Location and Name

Path (Required) The full path name of the directory the listener is to monitor.

File Name (Required) The name of the file that the listener is to listen for.

Encoding Type The file encoding used. Must be a canonical name for the java.io API. If left empty, the machine’s default Server will be used.


CREATING LISTENERS

Action Process Information

1. After you enter the File Location and Name/Post File Processing information, click on Next . The Action Process Information page appears.

File Content Type

The type of content the file contains: binary or text. If unknown, set to binary.

Maximum Files to Acquire

The maximum number of files the listener acquires and processes from the source directory.

Listener Frequency

Amount of time (in seconds) between listener cycles; can be any whole number greater than 0.

Post File Processing

Action What action the listener performs with the file after the action process runs:• None – the e file remains in the directory.

• Delete – the listener deletes the file.

• Move/Rename – the listener moves and/or renames the file (use the fields below if you select this option).

Move File Move the file to this directory after processing; to rename the file, include the new name in the path.

Append Suffix Append the typed suffix to the file name.

Append Time Stamp

Append a time stamp to the file name.

Table 14-2 File Listener Field Descriptions (continued)

Field Description

14-4 RELEASE 6.0 REV: A02 300-010-272

CREATING LISTENERS

Figure 14-3 File Listener screen

Table 14-3 File Listener Field Descriptions

Field Description

Execute Action Process Information

Action Process (Required) The name of the action process to execute when the listener detects the specified file.

Username The user name for the process (if required by the process).

Password The password for the process (if required by the process).

Wait for Response

Determines whether the listener waits for a response from the execute action process, before it invokes a terminate action process or an error action process (if any are defined for the listener).


CREATING LISTENERS

Include File Content with Process Input

Use the contents of the file as input to the process (in addition to any separate input parameters you define for the process in the IDE). If you don't include the contents of the file as process input, only the file's metadata is passed to the process.

Initialize Action Process Information (optional)

Action Process The name of an initialize action process to execute when the listener first starts.

Username The user name for the initialize process (if required by the process).

Password The password for the initialize process (if required by the process).

Wait for Response


Terminate Action Process Information (optional)

Action Process The name of a terminate action process to execute when the listener stops.

Username The user name for the terminate process (if required by the process).

Password The password for the terminate process (if required by the process).

Wait for Response

Determines whether the listener waits for a response from the terminate action process before it stops.

Error Action Process Information (optional)

Action Process The name of an error action process to execute if the listener encounters an error.

Username The user name for the error process (if required by the process).

Password The password for the error process (if required by the process).

Wait for Response

Determines whether the listener waits for a response from the error process, before it invokes a terminate action process (if one is defined for the listener).

Table 14-3 File Listener Field Descriptions (continued)

Field Description

14-6 RELEASE 6.0 REV: A02 300-010-272

CREATING LISTENERS

Select Service Managers

2. After you select or type the necessary Action Process Information, click Next . The Management Console displays the Select Service Managers page. As with metalinks, you choose which service manager(s) on the virtual server you want to run the listener.

Figure 14-4 Select Service Managers

3. Click the check box of the service manager(s) that you want to run the listener. You can also type a value in the Auto-start field to have one or more instances of the listener start automatically whenever the selected service manager starts. Click Save when you're done.

4. The Management Console displays the Repository Listeners page, the top of which shows a confirmation message that the listener was saved successfully. Notice that the listener you created is now listed on the page.

5. To start instances of the listener now (rather than waiting for the service manager to restart or having to restart the Server), select Service Managers > Service Distribution in the virtual server's Options toolbar to display the Service Distribution page. You use this page to start instances of listeners and metalinks.

FTP Listener

File Location and Name/Post File Processing

1. When you select FTP Listener and enter the Listener Type information, click on Next . The File Location and Name/Post File Processing page appears.


CREATING LISTENERS

Figure 14-5 FTP Listener

Table 14-4 FTP Listener Field descriptions

Field Description

File Location and Name

FTP Host The name or IP address of the FTP host.

FTP Port FTP host port number.

Username The user name of the FTP site.

Password The password of the FTP site.

Path (Required) The full path name of the directory the listener is to monitor.

File Name (Required) The name of the file that the listener is to listen for.

File Content Type

The type of content the file contains: binary or text. If unknown, set to binary.

Listener Frequency


14-8 RELEASE 6.0 REV: A02 300-010-272

CREATING LISTENERS


1. After you enter the File Location and Name/Post File Processing information, click on Next . The Action Process Information page appears.

Post File Processing

Action The action the listener performs with the file after the action process runs:

• None – the file remains in the directory.

• Delete – the listener deletes the file.

• Rename – the listener moves and/or renames the file (use the fields below if you select this option).

Append Suffix Append the typed suffix to the file name.

Append Time Stamp

Append a time stamp to the file name.

Table 14-4 FTP Listener Field descriptions (continued)

Field Description


CREATING LISTENERS

Figure 14-6 FTP Listener Action Process screen

Table 14-5 FTP Listener Action Process field descriptions

Field Description





Wait for Response


14-10 RELEASE 6.0 REV: A02 300-010-272

CREATING LISTENERS







Wait for Response






Wait for Response






Wait for Response


Table 14-5 FTP Listener Action Process field descriptions (continued)

Field Description


CREATING LISTENERS



Figure 14-7 Select Service Managers

2. Click the check box of the service manager(s) that you want to run the listener. You can also type a value in the Auto-start field to have one or more instances of the listener start automatically whenever the selected service manager starts. Click Save when you're done.

3. The Management Console displays the Repository Listeners page, the top of which shows a confirmation message that the listener was saved successfully. Notice that the listener you created is now listed on the page.


Email Listener

The Email Listener listens for new messages arriving in a mailbox on a specified email server. When a message arrives, a process is given information about the message and subsequently executed.

The Email listener has the ability to listen for messages on mail servers running either the IMAP or the POP3 protocol. Users can designate which folder will be listened to (only for IMAP protocol), construct message filters to listen for a specific message, and configure actions to be performed after the action process has been executed.

Similar to other listener types, the Email listener can also be configured to execute a process during initialization, termination, or when an error occurs.

14-12 RELEASE 6.0 REV: A02 300-010-272

CREATING LISTENERS

Mail Server Configuration/Post Message Processing

1. When you select Email Listener and enter the listener information, click on Next . The Mail Server Configuration/Post Message Processing page appears.

Figure 14-8 Mail Server Configuration screen

Table 14-6 Mail Server Configuration field descriptions

Field Description

Mail Server Configuration

Protocol Type (Required) Select either IMAP or POP3. This defines which mail protocol the mail server is running.

Server Hostname

(Required) The hostname of the Email server to connect to.

Mailbox Folder (Required) The name of the Email folder that the listener checks. Defaults to INBOX. If the protocol type is "POP3", then "INBOX" is the only valid value.

User Name User name used to log into the server.


CREATING LISTENERS

Password The user’s password to log into the server. Asterisks will be shown.

To Address Target

An email address used to match against the incoming message's recipients. Unless the incoming message is addressed to the address value in this parameter, the message will be ignored. Wildcards or regular expressions can be used. If the value is left blank, no matching on the recipient addresses is performed.

From Address Target

An email address used to match against the incoming message's sender. Unless the incoming message's sender address matches the value in this parameter, the message will be ignored. Wildcards or regular expressions can be used. If the value is left blank, no matching on the sender address is performed.

Subject Target The incoming message's subject is matched against this value. The message is ignored unless it is a match. Wildcards or regular expressions can be used. If the value is left blank, no matching on the subject is performed.

Message Body Target

The text portion of the message body is matched against this value. The message is ignored unless it is a match. Wildcards or regular expressions can be used. If the value is left blank, no matching on the subject is performed.

Listener Frequency


Post Message Processing

Do Nothing No action is performed. The processed message is left as read in the Folder being listened to. This option is mutually exclusive with other options.

Delete Delete the processed message from the folder. This option is mutually exclusive with other options.

Move to Another Folder

This option is only available if the protocol is "IMAP". The processed message will be moved to a folder or subfolder designated by the user. The folder must exist and the user must have write access. To specify a subfolder provide the folder path (e.g. "INBOX/AutomatorProject")

Table 14-6 Mail Server Configuration field descriptions (continued)

Field Description

14-14 RELEASE 6.0 REV: A02 300-010-272

CREATING LISTENERS


1. After you enter the Mail Server Configuration/Post Message Processing information, click on Next . The Action Process Information page displays.

Figure 14-9 Email Listener

Table 14-7 Email Listener field descriptions

Field Description


Action Process (Required) The name of the action process to execute when the listener detects the specified Email.




CREATING LISTENERS

Wait for Response

Determines whether the listener waits for a response from the execute action process before it invokes a terminate action process or an error action process (if any are defined for the listener).

Include Message Content with Process Input

Use the contents of the message as input to the process (in addition to any separate input parameters you define for the process in the IDE). If you don't include the contents of the message as process input, only the message’s metadata is passed to the process.





Wait for Response






Wait for Response





Table 14-7 Email Listener field descriptions (continued)

Field Description

14-16 RELEASE 6.0 REV: A02 300-010-272

CREATING LISTENERS



Figure 14-10Select Service Managers

2. Click the check box of the service manager(s) that you want to run the listener. You can also type a value in the Auto-Start field to have one or more instances of the listener start automatically whenever the selected service manager starts. Click Save when finished.

3. The Management Console displays the Repository / Listeners page. On the top, there should be a confirmation message stating that the listener was saved successfully. Notice that the listener you created is now listed on the page.



Wait for Response


Table 14-7 Email Listener field descriptions (continued)

Field Description


CREATING LISTENERS

Message Queue (JMS) Listener

The JMS Listener listens for new messages arriving on a JMS Queue or Topic. When a message arrives, a process is given information about the message and subsequently executed.

The JMS Listener has the ability to listen for messages on any JMS server that adheres to the JMS API. Users can designate the destination (Queue/Topic) that will be listened to and also construct message selectors to listen for a specific message.

All JMS message types (text, object, etc.) are supported for listening. The JMS listener can pass the content of text, map, and bytes messages to the process.

Similar to other listener types, the JMS Listener can also be configured to execute a process during initialization, termination, or when an error occurs.

JNDI/JMS Configuration

1. When you select Message Queue (JMS) Listener and enter the Listener Type information, click on Next . The JNDI/JMS Configuration page appears.

14-18 RELEASE 6.0 REV: A02 300-010-272

CREATING LISTENERS

Figure 14-11 Message Queue

Table 14-8 Message Queue Listener field descriptions

Field Description

JNDI Configuration

JMS Provider URL

(Required) The host name and port of the JMS server. This must be a valid URL.

Initial Context Factory

The class name of the initial context factory for the JMS server. The name must be provided.

Username The user name to use to create the initial context. Optional.

Password The user's password to create the initial context. Asterisks will appear in place of the actual password value. Optional.

JMS Connection Details

Connection Factory

(Required) Name of the connection factory for the JMS server. A valid value must be provided to successfully connect to the server.

Connection Username

The username to use to connect to the JMS server. Optional.

Connection Password

The user's password to connect to the JMS server. Asterisks will appear in place of the actual password value. Optional.

Other JMS Configuration

JMS Destination (Required) Determine whether the listener will be triggered by queue or topic.


CREATING LISTENERS


1. After you enter the File Location and JNDI/JMS Configuration information, click on Next . The Action Process Information page appears.

Queue/Topic Name

(Required) The name of the queue or topic that will trigger the listener.

Client ID The client identifier to associate with the connection. Optional.

Message Selector

The message selector allows the user to specify, through header fields and properties, the specific messages they are interested in. Only messages that match the selector will fire the execute action process. Optional.

Table 14-8 Message Queue Listener field descriptions (continued)

Field Description

14-20 RELEASE 6.0 REV: A02 300-010-272

CREATING LISTENERS

Figure 14-12Message Queue JMS Listener

Table 14-9 Message Queue JMS Listener

Field Description





Wait for Response



CREATING LISTENERS







Wait for Response






Wait for Response






Wait for Response


Table 14-9 Message Queue JMS Listener (continued)

Field Description

14-22 RELEASE 6.0 REV: A02 300-010-272

CONFIGURING LISTENERS



Figure 14-13Select Service Managers

2. Click the check box of the service manager(s) that you want to run the listener. You can also type a value in the Auto-start field to have one or more instances of the listener start automatically whenever the selected service manager starts. Click Save when finished.

3. The Management Console displays the Repository Listeners page. At the top, there should be a confirmation message stating that the listener was saved successfully. Notice that the listener you created is now listed on the page.


Configuring Listeners 14

After you create a Listener, you can edit the information you entered in the listener tables or change the number of listener instances you chose to auto-start. You can also remove listeners you don't want or need anymore.

To edit, reconfigure, or remove a listener:1. Go to the home page of the virtual server where you created the listener you

want to edit, and select Repository > Listeners. The Management Console displays the Repository Listeners page, which shows any listeners that already exist on the virtual server.


STARTING LISTENERS

Figure 14-14Repository

2. To remove a listener from the virtual server repository, select the Remove check box. To remove a listener only from the service managers running it, select the Remove From Service Managers check box. Click Remove Checked Items when you're done. The Management Console displays a warning prompt before it removes the listeners.

3. To edit the information you entered to create a listener, select Edit. The Management Console displays the Listener Configuration page that contains the tables you use to create a listener. See “Creating Listeners” on page 14-2 for information about using this page.

4. Click Next at the bottom of the Listener Configuration page to display the Select Service Managers page. Click Save when you're done with this page to save the changes to the listener.

Starting Listeners 14

When you create or configure a listener, you choose which service managers you want to run the listener, and you can also choose to have one or more instances of the listener start automatically whenever the service manager starts. To start or stop listener instances immediately without having to restart a service manager or the Server, you use the virtual server's Service Distribution page. You can also use the page to stop running listeners or remove a listener's configuration (that is, remove a listener from a service manager).

To start listeners immediately:1. In the Management Console, navigate to a virtual server's home page.

14-24 RELEASE 6.0 REV: A02 300-010-272

STARTING LISTENERS

Figure 14-15Virtual Servers menu options

2. Click on the virtual server you want to view in the Service Distribution Manager. The Management Console displays the Service Distribution page. The page shows the metalinks, listeners, and processes configured on the service managers on the virtual server and how many instances of these items are configured to start automatically and how many instances are running now.

Figure 14-16Service Manager Distribution

3. To start a listener now, type a number in the listener's Running box. (To restart a listener that's already running, click its Restart icon.) Click Save when you're done. The Management Console displays a confirmation message on top of the Service Distribution page.

4. To start listeners on a different virtual server, go to that server’s home page and repeat these steps.


STARTING LISTENERS

14-26 RELEASE 6.0 REV: A02 300-010-272

15Chapter
Scheduler 1
Topics in this section:• About the Scheduler• Accessing the Scheduler• Adding a New Scheduler Job• Viewing Scheduled Job Information

About the Scheduler 1

The Scheduler (or scheduling service) allows you to schedule EMC Ionix IT Automator processes to be executed.

From the Scheduler, you can:• configure process start and end times• configure the number of times to execute a process• create triggers that will determine when the process will start • view all scheduled processes • view a history of all scheduled jobs that have already completed.• view a scheduler calendar


ACCESSING THE SCHEDULER

Accessing the Scheduler 1

To access the Scheduler, select the Scheduler option from the Main Menu.

Figure 15-1 Virtual Server Scheduler Toolbar and Drop-down Menu

The Scheduler Menu provides the following options:

Table 15-1 Scheduler Menu options

Option Description

Current Jobs Use this option to view a list of any scheduled jobs that are currently executing. The information displayed is read-only. See Viewing Scheduled Job Information for more information.

Jobs Use this option to view a complete list of jobs that have been scheduled. Click on the job’s name ("Job" column) to view complete job information, or click on any of the other options to configure. See Jobs for more information.

Scheduler Calendar

Use this option to see a graphical calendar view of scheduled jobs. Click on any listed job to open it for viewing or editing. See Scheduler Calendar for more information.

History Use this option to see a historical list of completed jobs, filtered by various criteria. See Job Execution History for more information.

15-2 RELEASE 6.0 REV: A02 300-010-272

ADDING A NEW SCHEDULER JOB

Adding a New Scheduler Job 15

To add a new scheduled job:

1. Click on the Add New Job option located on the bottom right of the Currently Executing Jobs and Jobs views. The Job screen displays..

Figure 15-2 New Job Screen

2. Complete the following fields and click the Save Job option .

3. The following message displays.

Note: This Job requires a Trigger to be executed in the scheduler. Please click on to schedule this Job.

4. Go to

Table 15-2 Job Field Descriptions

Field Description

Name Enter a descriptive name for the scheduled job.

Process Make a selection from the dropdown list, which will show you all processes that are associated with the Virtual Server.

Recovery Select Yes if you want the scheduler to execute jobs that miss the original scheduled time for any reason.

Username Enter the user name that is used for the Virtual Server.

Password Enter a password that is associated with the user name entered.

Parameters All parameters associated with the selected Process will be displayed here. Enter a value to be used for processing.



Adding a new Trigger

To add a new trigger to a scheduled Job:

1. Click the Add New Trigger link. The Trigger screen displays.Figure 15-3 Trigger screen

2. Complete the following fields on the Trigger screen and click Save Trigger option.

Table 15-3 Add a Trigger Field Names

Field Description

Name Enter a descriptive name for the trigger. (Required)

Start Time Using the format shown, enter a start time for the scheduled job. The default time is the current time. (Required)

End Time Using the format shown, enter an end time for the scheduled job. Any processes that are currently in progress at a set end time will complete.

Trigger Type Select Simple, Cron, or Advanced. Options change depending on your selection. See below for options.

Repeat Count (Simple)

If you want the scheduled process job to repeat, enter the number of repetitions here. If you enter 1, for example, the original process would execute, and then there would be one repetition of the process. If you enter a value here, you must also enter a value in the Repeat Interval box.

Repeat Interval (Simple)

If your scheduled job is repeating (you have entered a Repeat Count value), then you must also enter a value here. The value will represent the time interval, in seconds, between repetitions of the process.

15-4 RELEASE 6.0 REV: A02 300-010-272


Misfire Instruction (Simple)

From the dropdown list, select what happens when there is a process misfire.

Cron Options The Cron Type options enable you to specify the frequency of the scheduled job. Each possible type (Daily, Weekly, Monthly, or Yearly) displays options specific to the type.

Misfire Instruction (Cron)

A "misfire instruction" tells the scheduler what to do when a trigger misfires. The following list explains the various misfire instruction options:

• Smart Default (Simple) -

— If the Repeat Count is 0, then the instruction will be interpreted as Fire Now.

— If the Repeat Count is blank, then the instruction will be interpreted as Reschedule Next with Remaining Repeat Count. (WARNING: using Reschedule Next with Remaining Repeat Count with a trigger that has a non-null end-time may cause the trigger to never fire again if the end-time arrived during the misfire time span.)

— If the Repeat Count is > 0, then the instruction will be interpreted as Reschedule Now with Existing Repeat Count.

• Fire Now (Simple) - Execute the job immediately.

• Reschedule Now with Existing Repeat Count (Simple) - Reschedules the job with the original set repeat count.

• Reschedule Now with Remaining Repeat Count (Simple) - Reschedules the job, but only executes any repetitions that have not yet completed.

• Reschedule Next with Remaining Repeat Count (Simple) - Reschedules the job starting with the next firing time, but only executes any repetitions that have not yet completed.

Reschedule Next with Existing Repeat Count (Simple) - Reschedules the job starting with the next firing time, and uses the original set repeat count.

• Smart Default (Cron/Advanced) - The instruction will be interpreted as Fire Now.

• Fire Now (Cron/Advanced) - Execute the job immediately.

• Do Nothing (Cron/Advanced) - No action is taken.

Table 15-3 Add a Trigger Field Names (continued)

Field Description



Modifying a Trigger

To modify the trigger details:

1. From the Jobs List, click the appropriate job. The Job details page displays.2. From the Job details page, select the trigger name. The Trigger details page

displays. 3. Modify the appropriate fields and select the Save Trigger option. The changes

will take effect immediately.

Cron Expression (Advanced)

This option enables you to directly enter a Cron expression. These expressions comprise seven sub-expressions, separated by white space. The sub-expressions in order are:

• seconds

• minutes

• hours

• day-of-month

• month

• day-of-week

• year (optional)

Following are two examples:

• 0 45 15 * * ? (fire at 3:45 PM every day)

• 0 20,35 20 ? 6 FRI (fire at 8:20 PM and 8:35 PM every Friday in June)

For complete information on Cron expressions, see:http://quartz.sourceforge.net/javadoc/ and then see "Class CronTrigger"

Table 15-3 Add a Trigger Field Names (continued)

Field Description

15-6 RELEASE 6.0 REV: A02 300-010-272

VIEWING SCHEDULED JOB INFORMATION

Viewing Scheduled Job Information 15

Currently Executing Jobs

The Currently Executing Jobs view shows you any jobs that are currently processing. The Description (if any) and Job Type are also shown. The information shown is read-only.

Figure 15-4 Scheduler control

Jobs

The Jobs view lists all jobs that have been scheduled. For each job listed, there are several actions you can take:• Click on the Job name in order to open the job, for viewing or for edits.• Click on Pause to stop a scheduled job. Click on Resume in order to put the job

in the execution list again.• Click Execute Now in order to fire the job immediately. The job will remain as

an entry. (An Execute Now does not delete the job after execution.)• Click on Add New Trigger to add a trigger to the job. A single scheduled job

can have multiple triggers.• Click Delete in order to delete a job from the scheduler. You will be asked to

confirm the deletion.



Figure 15-5 Scheduler Control

Job Details

To view the details of the job and trigger information, click on the Job name from the Jobs tab. The Job and Trigger information displays. Click the Trigger name to display the Trigger details.

15-8 RELEASE 6.0 REV: A02 300-010-272


Figure 15-6 Job Details

Scheduler Calendar

The Scheduler Calendar is a monthly view of all scheduled jobs. Click on any entry in order to open the particular job for viewing or editing. The month and year boxes enable you to change the month and the year of the calendar.



Figure 15-7 Job Trigger Times

Job Execution History

The Job Execution History view contains a list of jobs already executed by the scheduler. In order to be able to view the history list, Monitoring must be configured for the virtual server.

In order to view scheduler history, you can enter some filters that will limit the results. The Show results between options let you filter by begin and end dates, while the Filter by the following criteria options let you filter by activity name, service manager, processing server, or owner.

Figure 15-8 Job Execution History

After entering any desired filters, click on Search and any results that meet the search criteria will be returned. Click Refresh in order to update the list with any executions since page entry.

15-10 RELEASE 6.0 REV: A02 300-010-272


Figure 15-9 Job Execution History



15-12 RELEASE 6.0 REV: A02 300-010-272

16Chapter
Monitoring and Reporting 1
Topics in this section:• Overview• Installing the Monitoring Service• Starting and Stopping Monitoring• System Events and User Events

Overview 1

The EMC Ionix IT Automator Server can monitor the execution of your process models and ''events'' associated with process execution and generate pre-built reports about Server activity. The Server stores the monitoring information it collects in a database that you optionally install as part of the Server installation (the database is not required to install and run the Server, but it is required for monitoring and reporting). You can enable or disable monitoring separately for each virtual server in your environment. The reports include text and graph output and provide a fast and flexible way to analyze your runtime Server environment.

Server monitoring records over 50 pre-defined system events, and you can also define user events that you want the Server to record. When you generate reports, you can choose which system or user events you want to include, and you can filter the reports by date, time, process name, machine name, etc. You can also print and save the reports.

Note: If you are using Oracle as your monitoring database, a sequence iscreated along with the table, and in order to drop and recreate thetable, you will need to also drop the sequence. The sequence is named<tablename>_eventld_SEQ and in order to drop the sequence,run the command: drop sequence <name>


INSTALLING THE MONITORING SERVICE

Installing the Monitoring Service 1

To use Server monitoring and reporting, you must have a supported RDBMS running on a machine in your environment. The supported databases are:• MySQL• MS SQL Server 2000, 2005• Oracle 9 and 10g• IBM DB2 8 and 9

Starting and Stopping Monitoring 1

Monitoring and reporting is available for each virtual server you create in your Server environment, and you start or stop monitoring separately for each virtual server. The commands you use to start or stop monitoring and generate reports are included in the Monitoring page you access from the virtual server's home page.

Figure 16-1 Monitoring

The monitoring and reporting capabilities can also be accessed from the Monitoring drop-down menu.

16-2 RELEASE 6.0 REV: A02 300-010-272

STARTING AND STOPPING MONITORING

Figure 16-2 Monitoring Menu Options

To turn on virtual server monitoring:1. Start the Management Console, navigate to a virtual server home page, and

then select Monitoring > Settings. The Management Console displays the Monitoring Settings page.


STARTING AND STOPPING MONITORING

Figure 16-3 Monitoring Settings

Table 16-1 Monitoring Settings

Field Description

Historical Monitoring Settings

Historical Monitoring Enabled or disabled for this specific virtual server.

Historical Monitoring Buffer Settings

Buffer Flush Interval Amount of time in seconds that system and/or user events are held in a storage buffer before they are written to the database.

Buffer Size Limit Maximum number of system and/or user events that the buffer holds before writing them to the database.

Historical Monitoring Database

Select Database Service Select the type of database from the drop-down menu.

JDBC URL The host name or IP address of the machine on which you installed the repository database. You can use <localhost> if you're working on the machine on which you installed the database.

User The required user name for the monitoring service database is monitoring. Do not change the user name.

16-4 RELEASE 6.0 REV: A02 300-010-272

SYSTEM EVENTS AND USER EVENTS

2. Select Enabled from the Process Monitoring drop-down list to turn monitoring on for the virtual server. Change the values in the Buffer Settings panel if you want, then click Save Settings.

3. The Management Console prompts you that the monitoring settings were updated, but you must restart the virtual server for the changes to take effect. Click Restart.The Management Console restarts the virtual server. The Server will now monitor the virtual server whenever it's running and record all system events and any user events you define. You do not need to open the Management Console for monitoring to function, only to change settings or to display the reports. The Management Console generates the reports from the event data in the repository database.

4. To test the connection to the repository service, click Test Settings. The Management Console displays a confirmation if it is able to connect to the monitoring service or an error message if it cannot make a connection.

5. To restore the default values on the Monitoring Settings page, click Restore Default Settings.

System Events and User Events 16

Server monitoring records two types of ''events'' associated with process model execution: system events and user events. System events are pre-defined; you cannot change the definition of system events, but you can choose which system event data you want the database to record. User events are events you define using a special metascript that you insert into your process models; the metascript generates the data for the user event when the process model executes the metascript.

The following screen shows the Event Filter page.

Password The required password for the monitoring service database is monitoring. Do not change the password.

Table 16-1 Monitoring Settings

Field Description



Figure 16-4 Event Filter page

System Events

Server monitoring can record over 50 system events related to process model execution. The events cover a wide range of process activity, including metalink and metascript execution, client execution, transition and until conditions, etc. By default, the monitoring repository records all system events (and their accompanying event data) as they occur, but you can choose what event data to record to save space in the repository or to focus on specific events of interest. For example, a Process Started event could include the input data for the process; if that input data was a schema file, the data for that event could be large. To save space in the repository, do not record that kind of event data.

The table below lists the defined system events.

Table 16-2 System Events

System Events

Activity Completed Activity Error

Activity Instance Completed Activity Instance Error

Activity Instance Started Activity Started

Client Execution Completed Client Execution Error

Client Execution Started Get Activity Data

Get Activity Instance Data Listener Action Process Completed

Listener Action Process Started Listener Error

Listener Process Error Listener Started

Listener Stopped Metalink Execution Completed

Metalink Execution Error Metalink Execution Started

Metalink Started Metalink Stopped

Metascript Execution Completed Metascript Execution Error

16-6 RELEASE 6.0 REV: A02 300-010-272


To display the system event list and filter system events:1. Start the Management Console, navigate to a virtual server home page, and

then select Monitoring > Event Filter > System. The Management Console displays the System Event Filter page with the Process tab selected.

Metascript Execution Started Metascript Started

Metascript Stopped Postaction Completed

Postaction Error Postaction Started

Preaction Completed Preaction Error

Preaction Started Process Completed

Process Error Process Started

Scheduled Job Completed Scheduled Job Error

Scheduled Job Started Transition Condition Completed

Transition Condition Error Transition Condition Started

Until Condition Completed Until Condition Error

Until Condition Started User Context Updated

Web Services Available Web Services Deployment Error

Web Services Process Completed Web Services Process Error

Web Services Process Started Web Services Remove Error

Web Services Removed

Table 16-2 System Events (continued)

System Events



Figure 16-5 System Events - Process tab

2. The Process tab shows all Process events, and their accompanying event data, as they occur. Click on one of the System Event filter Radio buttons to define the level of filtering you require. When you move from High to Medium to Low the Monitor Event checkmark beside the event will change to an “x” to indicate which events are being filtered out of the monitoring.

3. To prevent an event's data from being written to the repository, de-select the event's checkbox in the Include Data column. Click Save when you're done

4. The Management Console prompts you that the system event changes were saved, but you must restart the virtual server for the changes to take effect. Click Restart on the virtual server’s home page.

5. The Management Console displays a warning dialog box asking if you're sure you want to restart the virtual server. Click OK. After the virtual server restarts, you return to the virtual server home page. You can make additional changes to the system event list, but you must restart the virtual server each time you apply the changes.

The following screens show the additional pages that appear when you click on the other tabs on the System Event Filter page.

16-8 RELEASE 6.0 REV: A02 300-010-272


Figure 16-6 System Event Filter - Action tab

Figure 16-7 System Event Filter



Figure 16-8 System Event Filter - Metalink tab

Figure 16-9 System Event Filter - Metascript tab

16-10 RELEASE 6.0 REV: A02 300-010-272


Figure 16-10System Event Filter - Listener tab

Figure 16-11 System Event Filter - Web Service tab



Figure 16-12System Event Filter - Other tab

User Events

User events are Server events that you define using a special metascript that you add to your process models to generate an event that can be written to the monitoring database. The special metascript is named FireMonitoringEvent, and it is available automatically on every virtual server you create with the Management Console. The metascript contains two methods, fireEvent and fireEventWithValues, that each have two parameters, eventName and eventData, that you use to name the event and include any data you want with it. After you add one of the metascript methods to your process model and define its name and data parameters, you use the Monitoring pages in the Management Console to add the event to the list of user events you want recorded in the monitoring database.

Note: Once you add a FireMonitoringEvent metascript to a process model,the repository will record that event even if you do not explicitly addthe event to the list of user events you define in the ManagementConsole.

Creating a User Event in the IDE

The FireMonitoringEvent metascript is available on each virtual server you create with the Management Console. To add the metascript to a process model, you copy it from a virtual server into the Process Designer. Once you add the metascript to your process model, you can define its parameters, connect it to other activities, and map the event data, just as you would any other metascript.

16-12 RELEASE 6.0 REV: A02 300-010-272


To add the user event metascript to a process model:1. Start the IDE and the Server. If necessary, start the Management Console and

create a virtual server. See “Creating a Virtual Server” on page 10-3 for instructions.

2. In the IDE, open the project that contains the process model you want to add a user event to, and then open the process model in the Process Designer. See Using the Process Designer in the IDE User Guide for instructions.

3. Click the Server Explorer tab in the Project explorer, then click the Select a server icon in the Server Explorer toolbar and choose a virtual server to connect to. See Server Explorer in the IDE User Guide for instructions. The IDE connects to the virtual server and displays its contents in the Server Explorer.

Figure 16-13Server Explorer tab

4. Click the Metascripts folder, and then click the FireMonitoringEvent metascript to expand it. Notice that the metascript contains methods, fireEvent and fireEventWithValues, each with two input parameters, eventData and eventName.

The difference between the methods is the eventData parameter. In the fireEvent method, the parameter is defined as anyType; in the fireEventWithValues method, it's defined as a NameValuePairs complex type. In both methods, the eventName parameter is a string.


../MME/ProcessDesigner.html



Figure 16-14Edit Activity Parameters

5. Click on the fireEvent or the fireEventWithValues method, and drag and drop it onto the process model you opened in the Process Designer. The IDE adds the metascript to the process model.

Figure 16-15Process Model

6. Right-click on the metascript and select Edit Parameters from the context menu. The IDE displays the Edit Parameters dialog box, which shows the two method input parameters.

16-14 RELEASE 6.0 REV: A02 300-010-272


Figure 16-16Edit Activity Parameters

7. Click the eventName parameter's Redefined box to check it, click in the eventName parameter's Default field, and then click the ellipsis to display the Default Value Editor. Type a name for the user event. To help keep track of your user events and to filter out the event in reports, use this name when you create the user event in the Management Console. Click OK when you're done.You can also assign a value to the eventData parameter, or you can map data to or from the parameter from other activities in the process model. For instructions on assigning values to parameters, see ''Assigning Default Values to Parameters'' in the Metalink Overview chapter in the IDE User Guide.

8. Use control connectors to connect the FireMonitoringEvent metascript to other activities in the process model (the metascript must be executed to fire the user event), and then use the Mapping Designer to map data to or from the metascript. See the IDE User Guide for instructions. Be sure to save the process model and its project when you're done.

9. You can add multiple FireMonitoringEvent metascripts to a process model; you can also copy the FireMonitoringEvent metascripts from one process model to another. Note that multiple FireMonitoringEvent metascripts in a process can have the same name, although naming them uniquely can make it easier to understand their function.

Creating a User Event in the Management Console

After you add the FireMonitoringEvent metascript to your process model to create a user event, you then add it to the list of user events in the Management Console. As with system events, you can choose which user events you want the repository service to record.

Note: Once you add a FireMonitoringEvent metascript to a process model,the repository will record that event even if you do not explicitly addthe event to the list of user events you create in the ManagementConsole. You only have to create the event in the Management Console


../MME/MetalinkOverview.html


if you later decide you want to filter out the event in the reports yougenerate.

To display the user event list and define or filter events:1. Start the Management Console, navigate to a virtual server home page, and

then select Monitoring > Event Filter > User Defined. The Management Console displays the User Defined Events page, which shows any user events currently defined.

Figure 16-17User Defined Events

2. To add a new user event, click on Add New Event. The following screen appears.

Figure 16-18User Defined Event

3. Enter a name in the User Event Type to Filter field. Remember to use the name or value you chose for the eventName parameter default when you created the user event in the IDE. Click Save when you're done.

4. The Management Console returns to the User Defined Events page where a confirmation message appears. The user event you created is now listed on the page (note that the Management Console sorts the user events alphabetically).

5. To delete a user event, check the Remove box next to its name. If you don’t want the repository service to record an event, uncheck the Include Data box.

6. Click Save when you're done. The Management Console prompts you that the user event changes were saved, but you must restart the virtual server for the changes to take effect. Click Restart on the virtual server’s home page.

7. The Management Console displays a warning dialog box asking if you're sure you want to restart the virtual server. Click OK. After the virtual server restarts, you return to the virtual server home page. You can make additional changes to the user event list, but you must restart the virtual server each time you apply the changes.

The monitoring reports are listed under Monitoring > Reports on the virtual server’s home page. When you select a report, the Management Console displays a search criteria page that lets you narrow the focus of the report or select specific Server events or activities of interest. If you don't specify search

16-16 RELEASE 6.0 REV: A02 300-010-272


criteria to narrow the scope of a report, the report includes all the pertinent events stored in the repository.

Figure 16-19Reports

To generate a monitoring report:1. Click on the report name under Monitoring > Reports or under the Monitoring

drop-down menu. The Management Console displays a search criteria page for that report.

2. Select or type the information to specify your search criteria.

Note: You can type a list of comma-separated values in any of the text fieldsdisplayed on the search criteria pages, except for the Begin Date andEnd Date fields (dates must be in the format YYYY-MM-DD hh:mm:ss).

3. You can also select the date by clicking on the calendar icon beside the Begin Date or End Date fields. Click on the top right or left arrows to change the month and year; click on the day of the month to select that date. The Management Console populates the selection in the corresponding field. By default the calendar shows the current date with the word “Today” appearing at the bottom of the screen.

Figure 16-20Calendar



4. Click Search when you're done. The Management Console generates and displays the report. If you specified search criteria, the reports lists the criteria below the report title.

5. To change the search criteria for the report, click Refine this search at the upper left of the report; click Refresh to refresh the report data. Click Printable version in the upper right of the report for a printer-friendly version of the report.

6. When you're done, click the Back button in your browser to return to the report search criteria page.

Limiting Report Output

The monitoring repository can grow large if you have been recording events over a long period of time, or if you regularly have a large number of processes executing in your Server environment. Under these conditions, the Management Console can require a large amount of memory to generate and display the reports, and the reports themselves can grow quite large.

The simplest way to reduce the size of both the reports and the memory required to produce them is to narrow your search criteria when you generate reports. You can also filter out system or user events that are of no interest, so that their accompanying event data is not recorded in the repository.

Another way to limit report size is to edit two parameters in the file web.xml that control how many rows are returned when the Management Console generates reports and how many processes are included in the bar chart generated by the Process Execution Report. The web.xml file is located in the <installroot>\engine\adminservice\webapps\default\WEB-INF directory. Open the file in a text editor and change the two <param-value> parameters show in the code sample below to decrease the number of rows a report returns or limit the number of processes in the bar chart.

<context-param>

<param-name>Metaserver.monitoring.reports.maxRowsToReturn</param-name><param-value>5000</param-value></context-param><context-param>

<param-name>Metaserver.monitoring.reports.maxProcessExecution</param-name>

<param-value>18</param-value></context-param>

16-18 RELEASE 6.0 REV: A02 300-010-272


Process Execution Report

The Process Execution Report is a bar graph that shows the execution status of processes that ran or are running on the virtual server. Each bar in the graph represents one process; the vertical size of the bar represents the number of executions of that process. The bars are grouped by process status (Completed, Running, Error, etc.).

• To get more information about a specific process, click on its bar in the graph.Figure 16-21Process Execution Search Parameters

Table 16-3 Process Execution Search Parameters field descriptions

Field Description

Show results between

Begin Date Begin date for report.

End Date End date for the report.

Filter by the following criteria

Process Name The name of the process to include in the report.

Service Manager The name of the service manager whose processes you want to include in the report.

Machine Name The name of the machine whose processes you want to include in the report.

Owner The login ID of the client that executed the process.



Figure 16-22Process Execution Graph

Process Report

The Process Report is a list of processes that shows the process name, state, when the process started, and the execution time for completed processes.• The process that executed the most recent activity is listed first in the report.• Click on a process name to get more information about that process.

Figure 16-23Process List Search Parameters

’

Table 16-4 Process List Search Parameters

Field Description


Begin Date Begin date for report.


16-20 RELEASE 6.0 REV: A02 300-010-272


Figure 16-24Process List

Event Report

The Event Report lists system and user events chronologically and includes a generated event ID number, the event name, the time the event occurred, the activity the event is associated with, the machine name and service manager


Process Name The name of the process to include in the report.

Service Manager The names of the service manager whose processes you want to include in the report.

Machine Name The name of the machine whose processes you want to include in the report.

Owner The login ID of the client that executed the process.

Show results less than (maximum 5000)

Output number The number of results in the process report.

Table 16-4 Process List Search Parameters

Field Description



on which the event occurred, and the total amount of memory in use on the machine at the time the event was recorded.

• Press the Ctrl key to make multiple selections in the System Events and Source Types drop-down lists.

16-22 RELEASE 6.0 REV: A02 300-010-272


Figure 16-25Event Search Parameters

Table 16-5 Event Search Parameters field descriptions

Field Description


Begin Date Begin date for the report.



System Events Select the system events to include in the report.

User Events Type the names of user events to include in the report.

Event Types Select All, System, or User.

Source Types Select the source types for the events.

Activity Name Type the name of the activity whose events you want to include in the report.

Service Manager The name of the service manager on which the events occurred.



Figure 16-26Event List Report

Metalink Execution Report

The Metalink Execution Report is a combination of text and a pie chart that list the metalinks that have executed on the virtual server and the service managers on which they executed. The reports list each metalink that executed, the names of the service managers on which it executed, the number of executions, and the average execution time. The accompanying pie charts, compare the average execution time on each service manager.

• To get more information about a specific metalink, click on its name.

Machine Name The name of the machine on which the events occurred.

Owner The login ID of the client that executed the processes that generated the events.

Table 16-5 Event Search Parameters field descriptions

Field Description

16-24 RELEASE 6.0 REV: A02 300-010-272


Figure 16-27Metalink Execution Search Parameters

Table 16-6 Metalink Execution Search Parameters field descriptions

Field Description





Metalink Name The name of the metalink you want included in the report.



Figure 16-28Sample Metalink Report

If instances of a metalink have been started, but none of the instances have yet executed in a given time period (so there are no metalink execution events recorded in the database), the report contains its text portion, but does not contain the pie chart.

Figure 16-29Sample Metalink Access Report

Listener Report

The Listener Report displays a list of the listeners that have executed on the virtual server. The reports list the listener name, its status, when the listener started, and when it finished (if it has stopped).

• For more information about a listener, click its name.

16-26 RELEASE 6.0 REV: A02 300-010-272


Figure 16-30Listener Search Parameters

Table 16-7 Listener Search Parameter field descriptions

Field Description





Listener Name The name of the listener you want included in the report.

Service Manager The name of the service manager on which the listeners executed.

Machine Name The names of the machines on which the listeners executed.



Figure 16-31Sample Listerners Report

Web Services Report

The Web Services Report displays a list of the web services that have executed on the virtual server.

Figure 16-32Web Service Search Parameters

Perform monitoring maintenance to free up disk space on the database by accessing Monitoring > Maintenance. The following screen appears.

Table 16-8 Web Service Search Parameter field descriptions

Field Description





Web Service Name The name of the web service you want included in the report.

16-28 RELEASE 6.0 REV: A02 300-010-272


Note: This is only available when MySQL is the monitoring database.

Figure 16-33Maintenance

Clear

When you click on Clear the following screen appears.

Figure 16-34Clear Monitoring Data

Click on Yes to clear the monitoring data from the database. A confirmation message appears.

Archive

When you click on Archive the following screen appears.

Figure 16-35Archive Monitoring Data

Enter the file in which to archive the data and click on Start to begin archiving the data from the database. A confirmation message appears.



Restore

When you click on Restore the following screen appears.

Figure 16-36Restore Monitoring Data

Enter the file name from which to restore data to the database and click on Start to begin restoring the data. A confirmation message appears

16-30 RELEASE 6.0 REV: A02 300-010-272

Index 1

Aaccess control 56administrators 74

Ccaching

before you enable 57class loader

choosing 112client

logs 31, 34machines 15

componentsdeploying 124managing 125

Ddata signer

properties 412database requests 55debug properties

setting 35

Eemail

listener 1412engine-config.xml 49

other properties 413

Ffailover 54file

provider propertiesengine-config.xml 410

security 92defining 93

Gglobal.xml 46granularity 52group members

edit 97groups

adding 95updating 93

IICredential 44Integrated Development Environment 12

JJava virtual machine 53JMS listener 1418jobs 157JVM size 210

primary service 210service manager 210when to change 57

LLDAP

provider properties 410security

defining 98settings 910

listenersconfiguring 1423creating 142email 1412file location and name 143FTP 147JMS 1418managing 1213message queue 1418

EMC IONIX IT AUTOMATOR SERVER AND MANAGEMENT CONSOLE USER GUIDE I-1

reports 1626starting 1424using 141

load distribution 52log files

client 31levels

changing 34purging 36rolling 36server 31service manager 32terms 33

logging 53into the management console 63out of the management console 63

login methodsICredential 45

Mmanagement console 12

navigation 65overview 61starting 61terms 61

memory 52message queue

listener 1418metalink 52metalink configuration

removing 117metalink data

capturing 37metalink details

viewing 129metalink instances

starting 133stopping 133

metalinks 12changing 115changing the configuration 116configuring 13deploying a changed or re-configured 117hanging 133managing 127reports

execution 1624starting 13, 131stopping 131

metascript 12

detailsviewing 1211

granularity 52managing 1210

monitoring 161service

installing 162starting 162stopping 162

Nnetwork configuration 53NT provider properties 411NT security

defining 912

Oout of memory 210

Ppassword

getting 62performance

considerations 51tuning 51using cache to improve 56

processdetails

viewing 127execution logging

viewing 38manager

properties 411verification 54

processes 12executing 13managing 125

Rreporting 161reports

event 1621generating 1616limiting output 1618listenerl 1626melalink execution 1624process 1620process execution 1619web services 1628

I-2 RELEASE 6.0 REV: A02 300-010-272

repositoryitems

adding 123removing 123

using 121, 123

Sscheduler 151scheduler job

adding 153calendar 159information

viewing 157security file

replacing 98security provider

changing 93choosing 92

security providers 72defining 91

server 12administrator 42administrators 614

defining 75logging in 71

API 41examples 413

concepts 11configuration 68home page 67log files 31properties 46repository 43security 43, 71tree menu 67

server APIconnection properties 42login 42

server.xml 47servers

primary 14processing 14Tomcat

configuration 48virtual 14, 55

service distribution 131viewing 114

service managers 15creating 113logs 32, 34

primary 111processing server 112removing 114starting 113stopping 114using 111

sessionpersistence 55settings 73

subprocesses 55system events 165, 166

TTomcat

configuring 48trigger

adding 154modifying 156

Uuser context 15, 412

data 44IDs 44

user events 165, 1612creating 1612, 1615

user namegetting 62

UserContext 44users 614

adding 616, 95business process 615edit 96removing 616updating 93

Vvirtual server

administrators 615defining 76

archiving 108creating 103

from an archive 104new 103programatically 105

disabling 107enabling 107home page 610managing 101removing 107

EMC IONIX IT AUTOMATOR SERVER AND MANAGEMENT CONSOLE USER GUIDE I-3

starting 106stopping 106tree menu 612

Wweb services

reports 1628

I-4 RELEASE 6.0 REV: A02 300-010-272

B

EMC CorporationCorporate Headquarters, Hopkin, MA 01748-9103U.S.A.

Tel.:1-508-435-1000

http://www.EMC.com

EMC Ionix IT AutomatorServer and Management ConsoleUser Guide

Document number: 300-010-272Release: 6.0REV: A02Date: March 2010

Printed in the United States of America.Copyright © 2010, EMC Corporation All Rights Reserved

B