CA Workload Automation iDash Administration Guide Edit User ... AE calendar WORKDAYS, excluding days in calendar NOFILES. If a job has multiple times that it must start or finish successfully

CA Workload Automation iDash

Administration Guide Release 2.6 SP1

This Documentation, which includes embedded help systems and electronically distributed materials, (hereinafter referred to as the “Documentation”) is for your informational purposes only and is subject to change or withdrawal by CA at any time.

This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This Documentation is confidential and proprietary information of CA and may not be disclosed by you or used for any purpose other than as may be permitted in (i) a separate agreement between you and CA governing your use of the CA software to which the Documentation relates; or (ii) a separate confidentiality agreement between you and CA.

Notwithstanding the foregoing, if you are a licensed user of the software product(s) addressed in the Documentation, you may print or otherwise make available a reasonable number of copies of the Documentation for internal use by you and your employees in connection with that software, provided that all CA copyright notices and legends are affixed to each reproduced copy.

The right to print or otherwise make available copies of the Documentation is limited to the period during which the applicable license for such software remains in full force and effect. Should the license terminate for any reason, it is your responsibility to certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed.

TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION “AS IS” WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.

The use of any software product referenced in the Documentation is governed by the applicable license agreement and such license agreement is not modified in any way by the terms of this notice.

The manufacturer of this Documentation is CA.

Provided with “Restricted Rights.” Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections 12.212, 52.227‐14, and 52.227‐19(c)(1) ‐ (2) and DFARS Section 252.227‐7014(b)(3), as applicable, or their successors.

Copyright © 2012 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.

TABLE OF CONTENTS 1. INTRODUCTION .......................................................................................................... 5

1.1. SLA Definitions ................................................................................................... 6 1.1.1. SLA Overview .............................................................................................. 6 1.1.2. SLA Status .................................................................................................... 7

1.2. Critical Path Monitoring ...................................................................................... 8 1.2.1. Critical JobList .............................................................................................. 8 1.2.2. Critical Path ................................................................................................ 11

2. ARCHITECTURE ........................................................................................................ 15 2.1. Component Functions ............................................................................................. 16

2.1.1. iDash Daemon ............................................................................................. 16 2.1.2. iDash Database ............................................................................................ 17 2.1.3. iDash Client ................................................................................................ 17

2.2. High Availability ............................................................................................... 17 3. INSTALLATION ......................................................................................................... 19

3.1 Overview ........................................................................................................... 19 3.2 Basic System Requirements .............................................................................. 19

3.2.1 iDash Daemon ................................................................................................... 19 3.2.2. iDash Database ............................................................................................ 20 3.2.3. iDash Client ................................................................................................ 20

3.3. Server Pre-Installation Checklist ....................................................................... 21 3.3.1. Example Server Pre-Install Checklist Form ..................................................... 22

3.4. Installing iDash .................................................................................................. 23 3.4.1. Configuring/Installing JRE v1.5 ................................................................. 23 3.4.2. Creating the iDash Database ....................................................................... 24 3.4.3. Installing iDash on UNIX/LINUX .............................................................. 25 3.4.4. Installing iDash on Windows ...................................................................... 31 3.4.5. Installing the iDash Client CLI ................................................................... 37

3.5. Configuring iDash ............................................................................................. 40 3.5.1. Starting the iDash AdminTool .................................................................... 40 3.5.2. Adding CA Workload Automation AE Instances ....................................... 42

3.6. Post-Installation Checklist ................................................................................. 48 3.7. Installation Trouble Shooting ............................................................................ 49

3.7.1. Common Installation Problems ................................................................... 49 3.7.2. Pathology: Symptoms and Solutions .......................................................... 49

4. THE ADMIN TOOL ............................................................................................. 50 4.1. iDash Server Settings ......................................................................................... 50

4.1.1. General ........................................................................................................ 51 4.1.2. Instance ....................................................................................................... 52 4.1.3. Message of the Day ..................................................................................... 57 4.1.4. License ........................................................................................................ 58 4.1.5. User Command ........................................................................................... 59

4.1.5.1. Interactive User Commands .................................................................. 61 4.2. iDash DB configuration ..................................................................................... 64

TABLE OF CONTENTS 3

TABLE OF CONTENTS 4

4.2.1. CA Workload Automation AE Archive Data ............................................. 64 4.3. Creating SLA Definitions .................................................................................. 67

4.3.1. What is an SLA definition? ......................................................................... 67 4.3.2. Creating an SLA definition ......................................................................... 69 4.3.3. Forecast Parameters .................................................................................... 77 4.3.4. Alarm Policy ............................................................................................... 78 4.3.5. Forecast Overrides ...................................................................................... 81 4.3.6. Job Link ...................................................................................................... 82

4.4. Security Model .................................................................................................. 85 4.4.1. iDash User/Password .................................................................................. 86 4.4.2. Single Sign-On ............................................................................................ 88

4.4.2.1. IP Address ............................................................................................. 88 4.4.2.2. Domain .................................................................................................. 89 4.4.2.3. Host Names ........................................................................................... 90

4.4.3. iDash CLI Authentication ........................................................................... 91 4.4.4. Audit Trails ................................................................................................. 92

4.5. Users and Permissions ....................................................................................... 95 4.5.1. Authentication ............................................................................................. 96 4.5.2. Authorization .............................................................................................. 96 4.5.3. Using Filters for Security ............................................................................ 97 4.5.4. User Fields ................................................................................................ 100 4.5.5 Create New User ....................................................................................... 101 4.5.6. Copy User ................................................................................................. 103 4.5.7 Edit User ................................................................................................... 103 4.5.8. Remove User ............................................................................................. 104 4.5.9. Undo Changes ........................................................................................... 104 4.5.10. Reload Filters ............................................................................................ 104 4.5.11. idashAdm User .......................................................................................... 104 4.5.12. iDash Passwords ....................................................................................... 104

5. GLOSSARY ....................................................................................................... 106 5.1. CA Workload Automation AE Terms ............................................................. 106 5.2. Symbols in this Guide ...................................................................................... 107

Alternate color ................................................................................................ 107 Italic ............................................................................................................ 107

5.3. Related Documents .......................................................................................... 108

1. INTRODUCTION CA Workload Automation AE job streams are created to automate certain business processes. Most of these processes have an internal Service Level Agreement (SLA) with other business units or processes. Hence, it is desired that the CA Workload Automation AE job streams that fulfill these business processes also meet or exceed the corresponding service level agreements. Normally, the service level agreements are summarized as status or time based thresholds for job streams. For example, − Every job within a job stream must end in a SUCCESS status. − The entire job stream must complete successfully by a particular time. − A job within the job stream must start by a particular time. − A job or a set of jobs within a job stream must start and finish by a

particular date and time. iDash monitors the entire CA Workload Automation AE environment, performs real-time forecasts based on previous execution times and the current status of the system, generates alerts when the thresholds are at risk or are missed, and executes automated recovery actions. This guide assumes familiarity with CA Workload Automation AE, and it assumes you have CA Workload Automation AE running, and you install iDash using the procedures described in the Installation section. This iDash Administration Guide is intended to be used with the companion iDash User Guide. Java, CA Workload Automation AE, Oracle, Sybase are trademarks of their respective companies.

1. INTRODUCTION 5

SLA Definitions

1.1. SLA Definitions

1.1.1. SLA Overview

iDash provides the capability to assign one or more service level agreements to any CA Workload Automation AE Box, Command, or File watcher job. Once you define the SLA for any job, iDash constantly performs an impact analysis of the current state of job processing across the CA Workload Automation AE environment on the fulfillment of the SLA. If it calculates that the SLA is at risk or in jeopardy of being missed, it generates the appropriate CA Workload Automation AE Alarms, and executes any automated recovery scripts. For any CA Workload Automation AE job, you can create the following SLA definitions. − The schedule and time(s) by which the job must start − The schedule and time(s) by which the job must finish successfully − The schedule and time(s) by which the job must start and finish

successfully For example, − Box job EuropeDailyBox must finish successfully by 7:15 AM every

Monday, Tuesday, Wednesday. − Command job SectorDaily_Chips_upload must start by 8:00 PM

every day in CA Workload Automation AE calendar WORKDAYS, and finish successfully by 02:00 AM the next day.

− File watcher job WebMD_daily_report_fw must finish successfully by 7:00 PM, 12:00 PM, and 5:15 PM every day in CA Workload Automation AE calendar WORKDAYS, excluding days in calendar NOFILES.

If a job has multiple times that it must start or finish successfully by, iDash internally creates multiple SLA deadlines for that job. Each SLA deadline is monitored as a separate entity, thus eliminating confusion about the status of any particular deadline. For each SLA definition, you can optionally assign a Risk Window that enables iDash to send alerts if it forecasts that the SLA deadline will be met, but within the risk window. The purpose of the risk window is to provide alerts if it is predicted that the SLA deadline will be met, but the time when it will be met is close to the deadline. By receiving such pro-active alerts, iDash enables users to take appropriate actions to prevent SLA violations.

Administration Guide 6

SLA Definitions

For example, − Box job EuropeDailyBox must finish successfully by 7:15 AM every

Monday, Tuesday, Wednesday. This SLA definition is assigned a risk window of 30 minutes, which means the risk window is from 6:45 AM to 7:15 AM. If iDash forecasts that EuropeDailyBox will finish at, say 7:00 AM, it will send an alert indicating that the SLA deadline will be met, but it will be within the risk window.

By default, the iDash engine is forecasting and analyzing all SLAs that have a deadline within the specified forecasting window. If you like, you can optionally assign a “Start Tracking” value that will be calculated as an offset from the deadline. When an SLA has been assigned a “Start Tracking” value, iDash will not perform a forecast on the SLA till the Start Tracking window has begun. For example, − For the SLA defined above, if the Start Tracking value is set to 120

minutes, then iDash will commence forecasting and analyzing the SLA on EuropeDailyBox at 5:15 AM (2 hours prior to its deadline). Till then, the SLA will show its status as “FUTURE”.

1.1.2. SLA Status Once iDash starts forecasting and monitoring the job processing, at any moment in time each SLA occurrence can have only one of the following statuses.

SLA Status Description

ON_TIME iDash forecasts that the job will do better than or meet the defined SLA deadline.

MET The SLA deadline has been met successfully.

AT_RISK iDash forecasts that the job will do better than or meet the defined SLA deadline, but it will be within the risk window.

PREDICTED_MISS iDash forecasts that the job will miss its SLA deadline.

1. INTRODUCTION 7

Critical Path Monitoring

SLA Status Description

MISSED The SLA deadline was missed. ERROR The SLA definition is not correct and has an error.

UNKNOWN The iDash forecasting function is unable to predict

the status of the SLA deadline.

iDash determines the status of each SLA deadline by monitoring the current state of job processing, forecasting the future job processing, and applying that information to the critical path of the job with the SLA deadline. Once an SLA misses its deadline, it gets marked as “MISSED”. By default, iDash stops monitoring and forecasting the SLA and its Critical Jobs. You can optionally assign an “End Tracking” value to the SLA so that iDash will keep on monitoring and forecasting the SLA and its Critical Jobs till the End Tracking window expires, or the SLA job gets a status of SUCCESS, whichever occurs first. This parameter enables iDash to track how badly did the SLA job miss its deadline. The End Tracking window is calculated as an offset from the deadline. For example, - For the SLA defined above, if the End Tracking value is set to 300 minutes, then if EuropeDailyBox does not finish successfully by 7:15 AM, then iDash will mark the SLA as MISSED and keep on updating the job run data for the SLA and its Critical jobs till 12:15 PM (5 hours past the deadline), or till the job ends in SUCCESS.

1.2. Critical Path Monitoring iDash provides the capability to monitor the Critical Path of the CA Workload Automation AE job that has a SLA defined. iDash dynamically calculates the Critical Path of a job by first calculating the Critical JobList and then performing a time analysis to find out the longest path to the SLA job.

1.2.1. Critical JobList iDash's definition of Critical JobList is as follows : Critical JobList is the set of jobs that have to run successfully in order for the desired CA Workload Automation AE job to start or end successfully.



The following figure shows a sample job stream made up of five (5) jobs. The arrows indicate dependencies between the jobs.

Figure 2.1 : A Sample Job Stream The following two diagrams highlight the Critical JobList for the selected job(s).

1. INTRODUCTION 9


Figure 2.2 : Critical JobList for job JOB-E Figure 2.3 : Critical JobList for job JOB-C As shown above, the Critical JobList of each job is the set of jobs that need to run successfully in order for that job to start or end. iDash builds the Critical JobList for each SLA job by analyzing the CA Workload Automation AE job definition and dependency structure. The Critical JobList for a Box job includes the following : − Critical JobList for the Box job to start − The set of jobs inside the Box that need to run successfully in order for the

Box job to finish



Figure 2.4 : Critical JobList for job BOXJOB-1

As the above figure shows, the Critical JobList for the job BOXJOB-1 includes the jobs that are needed for a successful start and the jobs that are needed for a successful completion.

1.2.2. Critical Path iDash dynamically generates the Critical Path of each SLA job by evaluating the following for each job in the Critical JobList. − The current status − The average duration − Date and Time conditions − Date and Time parameters (e.g. Exclude Calendar, Run Window) The iDash Critical Path can be defined as follows:

1. INTRODUCTION 11


Critical Path of a SLA job is a sub-set of the Critical JobList. The jobs listed in the Critical Path represent the longest path to a successful execution of the SLA job. The longest path to the SLA job depends upon the current condition of the job processing environment. iDash automatically adjusts the set of jobs inside the Critical Path and the time to finish them. The following figure shows a sample job stream made up of five (5) jobs. The arrows indicate dependencies between the jobs. The average run times for each job are also listed.

Figure 2.5 : Sample Job Stream

As you can see, jobs JOB-A, JOB-B, JOB-C, and JOB-D are in the Critical JobList for job JOB-E. From the average run times shown, the Critical Path for JOB-E is highlighted in the next figure.

JOB-A

10 minutes

JOB-D

5 minutes

JOB-B

20 minutes

JOB-E

10 minutes

JOB-C

10 minutes



Figure 2.6 : Critical Path for JOB-E If iDash notices that conditions in the CA Workload Automation AE environment have changed, then it adjusts the Critical Path. For example, if JOB-C is put ON_HOLD, then 16 minutes after the starting of JOB-A, the Critical Path for JOB-E will be changed as follows.

Figure 2.6 : Adjusted Critical Path for JOB-E

The reason behind the automatic adjustment of the Critical Path is that the new Critical Path has at least 15 minutes of job processing time left, whereas the original Critical Path has only 14 minutes of job processing time left.

JOB-A

10 minutes

JOB-C

10 minutes

JOB-D

5 minutes

JOB-B

20 minutes

JOB-E

10 minutes

Processing Time Left:

30 mins.


15 mins.

JOB-A

Finished


14 mins.


15 mins.

JOB-C

10 minutes

JOB-D

5 minutes

JOB-B

14 minutes left

JOB-E

10 minutes

1. INTRODUCTION 13


iDash updates the Critical Path for all SLA jobs in real-time. Any of the following conditions can result in a change in the set of jobs that make up the Critical Path for an SLA job. − Jobs achieving FAILURE, TERMINATED, ON_HOLD status. iDash

assumes that such jobs will started soon. − Jobs running shorter or longer than their average runtime. Such jobs

decrease or increase the processing time left respectively. iDash will then adjust the Critical Path to the jobs with higher processing time left.

− Jobs achieving ON_ICE status. This will decrease the processing time left. − Delays or inability to run due to date and time restrictions (e.g. Run

Window, Exclude calendar). The iDash interface provides indicators about the above conditions, enabling users to troubleshoot Critical Path issues.



2. ARCHITECTURE

ARCHITECTURE ELEMENT

DESCRIPTION

iDash Daemon This process runs on the iDash Server machine and is the only process that runs constantly. It is a multi-threaded Java process that collects all the relevant job data from the CA Workload Automation AE instance(s), maintains the iDash database and supplies the data to all the iDash clients. It is started as a servlet by the Web Application Server (e.g. Tomcat).

iDash Database This database is the central repository for iDash. All the internal information and object definitions are stored in this database. This database is also used to store all the archived CA Workload Automation AE information used

ACE

PRD

DEV

iDash Daemon

iDash DB/Cache

CA Workload Automation AE

Instances

iDash Server Machine

iDash Clients

ARCHITECTURE 15

2.1. Component Functions

for analysis and reporting.

iDash Client The iDash Client is the JavaTM-based GUI that can be launched on any Java supported system, and the CLI that can be launched on any supported system. The GUI provides the capability to monitor, report, forecast, control the SLA thresholds and the Critical Path jobs across the CA Workload Automation AE instances. Because the client is a Java applet, there is no software installation required on the machine that will launch the client. The CLI provides the capability to perform certain Administration functions, and to generate iDash reports from the command line.

2.1. Component Functions

2.1.1. iDash Daemon The iDash Daemon is the only persistent process in the iDash system. This process is installed on a Web Application Server that can provide access to the CA Workload Automation AE instance repositories. The iDash Daemon is a multi-threaded Java process that performs the following functions: − Reads and loads relevant job definition information from all configured CA

Workload Automation AE instances. − Monitors relevant job runs, their statuses, and CA Workload Automation

AE events. − Generates real-time forecasts of the entire CA Workload Automation AE

environment. − Calculates the upstream Critical Path for all jobs that have an SLA

definition. − Performs the impact analysis of real-time and forecasted job statuses on

the Critical Path of every SLA. − Maintains the iDash Cache with all relevant information about CA

Workload Automation AE jobs, SLA statuses, forecasts, etc. − Generates CA Workload Automation AE Alarms for any SLA that may be

at risk or predicted to be missed, or if an SLA is actually missed. − Executes any configured automated actions, as needed.


High Availability

− Generates customized reports for historical and forecasted behavior of SLA jobs and their Critical Path. (in a future release)

− Runs the SOAP-based Web Service that accepts certain queries and provides responses in XML. (in a future release)

2.1.2. iDash Database The iDash database is needed by the iDash Daemon to store certain information. An existing database must be used for this component, as iDash does not provide a bundled database. All current versions of Oracle, Sybase, SQL Server are supported. The information inside the database is maintained by the iDash Daemon. The following data is stored in this database. 1) All iDash data including configuration, security, SLA definitions, audit.

2) CA Workload Automation AE historical data including job runs, events,

audit information, and performance statistics.

2.1.3. iDash Client The iDash Client GUI is the JavaTM-based graphical interface that can be launched on any Java supported system, and the . The client provides the capability to monitor, report, forecast, control the SLA thresholds and the Critical Path jobs across the CA Workload Automation AE instances. Because the client is a Java applet, there is no software installation required on the machine that will launch the client. The iDash Client CLI is a set a commands that can be deployed to any supported system. These commands enable users to perform certain Administration functions (e.g. Manage SLA definitions, Load CA Workload Automation AE archive files), generate iDash reports in PDF, HTML, CSV formats.

2.2. High Availability

iDash can be configured to run in an Active/Active HA mode. You can setup iDash with two servers running the daemon process on each, or with two separate iDash databases, or both. The iDash servers and database support automated rollover and rollback. The data between the two databases is kept in sync by the iDash server process. To configure iDash in full HA mode, you will need the following:

ARCHITECTURE 17

High Availability

1. Two (2) machines that will be setup as Primary and Secondary iDash

Daemons respectively. 2. Two (2) databases that will be setup as Primary and Secondary iDash

databases respectively. When you setup iDash in an Active/Active HA mode, both the servers are running the iDash Daemon. Each server is fully functional, and is connected to both the iDash databases. Each data change is recorded in to both the databases. In case of a database failure, the Primary Server will copy the missing data from the active database to the other database when it recovers. Users can connect to any active server, and the same information will be seen.


Overview

3. INSTALLATION

This section contains steps to install the iDash Server components on UNIX/LINUX and Windows Web Servers.

3.1 Overview As seen in the Architecture diagram, the product has three components:

The iDash Daemon (installed on the server) The iDash Database (a new or existing DB instance) The iDash Client (no installation required for the GUI)

The main tasks of installation are:

1) Satisfying software prerequisites 2) Installing iDash files 3) Configuring iDash so it can communicate with all the CA Workload

Automation AE instances to be managed 4) Configuring user security

3.2 Basic System Requirements Following is a list of the system requirements for installation and running of the iDash components. Some of the pre-requisite software is already present on the machines when the operating system is loaded.

3.2.1 iDash Daemon 1) Tomcat v6.x

2) JRE v1.6 (64-bit only)

3) 100Mb of disk space

4) 3Gb of available RAM

5) CA Workload Automation AE Remote Agent with configuration files for

each CA Workload Automation AE instance

3. INSTALLATION 19

Basic System Requirements

3.2.2. iDash Database 1) All current releases of Oracle, Sybase, MS SQL Server are supported.

2) Sufficient data storage for anticipated usage.

3.2.3. iDash Client

3) Java 1.5.x and 1.6.x.

4) 512Mb of available RAM.


Server Pre-Installation Checklist

3.3. Server Pre-Installation Checklist

Following is a checklist of information required for installation. Please fill it in with the values that you will use during the installation process. Beneath is a checklist with filled-in sample values.

Hostname of the Web Server IP Address of the Web Server Port number of the Web Server process Web Server protocol (http or https) Number of CA Workload Automation AE Instances to be configured

Web Server Type and Version Location of Web Server Base directory

Base directory for JRE iDash Database Vendor Machine where iDash database is running. iDash Database connection Port Number iDash Dataserver Name (Sybase) iDash Database Name iDash Database User/Password CA Workload Automation AE Database Vendor Machine where the CA Workload Automation AE Database is running

CA Workload Automation AE Database connection Port number

CA Workload Automation AE Dataserver Name (Sybase)

CA Workload Automation AE Database Name CA Workload Automation AE Database User/Password

CA Workload Automation AE Root Directory (AUTOSYS) on the Web Server

Directory for CA Workload Automation AE Configuration Files (AUTOUSER) on the Web Server

Directory for Sybase interfaces file (SYBASE) on the Web Server

Directory for Oracle tnsnames file (TNS_ADMIN) on the Web Server

Oracle Home Directory (ORACLE_HOME) on the Web Server

Root Directory for iDash files (IDASH_HOME)

3. INSTALLATION 21

Server Pre-Installation Checklist

Root Directory for iDash files (IDASH_HOME) on the iDash Clients (for CLI)

3.3.1. Example Server Pre-Install Checklist Form

Following is a checklist with sample values filled in.

Hostname of the Web Server venus IP Address of the Web Server 192.168.200.19 Port number of the Web Server process 8081 Web Server protocol (http or https) Standard (http) Number of CA Workload Automation AE Instances to be configured

3 (PRD, DEV, TST)

Web Server Type and Version Tomcat v6.0.35 Location of Web Server Base directory /opt/tomcat6

Base directory for JRE /opt/jre1.6 iDash Database Vendor MS SQL Machine where iDash database is running. neptune iDash Database connection Port Number 1433 iDash Dataserver Name (Sybase) N/A iDash Database Name idashdb iDash Database User/Password idash/******** CA Workload Automation AE Database Vendor Sybase CA Workload Automation AE Version r11.3 Name of machine where the CA Workload Automation AE Database is running

sjcsyb1

CA Workload Automation AE Database connection Port number

5100

CA Workload Automation AE Dataserver Name (Sybase)

SJSYB1

CA Workload Automation AE Database Name autodb CA Workload Automation AE Database User/Password

autosys/********

CA Workload Automation AE Root Directory (AUTOSYS) on the Web Server

/opt/autotree/autosys

Directory for CA Workload Automation AE Configuration Files (AUTOUSER) on the Web Server

/opt/autotree/autouser

Directory for Sybase interfaces file (SYBASE) on the Web Server

N/A

Directory for Oracle tnsnames file (TNS_ADMIN) on the Web Server

N/A

Oracle Home Directory on the Web Server (ORACLE_HOME)

N/A


Installing iDash

Root Directory where iDash files will be installed (IDASH_HOME)

/opt/CA/idash

Root Directory for iDash files (IDASH_HOME) on the iDash Clients (for CLI)

C:\ca\idash

3.4. Installing iDash 3.4.1. Configuring/Installing JRE v1.5

Before installing the iDash Server, the Java environment on the machine must be present. The iDash Server requires the Java Runtime Environment (JRE) v1.5.x. 1. To check the version of Java on the server machine, run the following

command from a command prompt.

% java –version java version "1.6.0_34" Java(TM) SE Runtime Environment (build 1.6.0_34-b04) Java HotSpot(TM) 64-Bit Server VM (build 20.9-b04, mixed mode) If the output of the command looks like the sample above, then the Java environment installed is set up correctly, and is of the required version.

2. If the version of java is not 1.6, or if the Java environment is not present,

then it will be necessary to install the appropriate version. Typically, the java executable that was run above is in the /usr/bin directory on UNIX/LINUX systems and C:\Windows\System32 on Windows systems. On UNIX/LINUX, it is a soft link to the real java executable in the directory where the Java environment resides. There is a possibility that the required version of Java is present on the server machine, but it is not present in the PATH of the user. Before installing the new version of Java, it may be helpful to search the server machine for any other versions of Java.

If the JRE must be downloaded, the java.sun.com web site has download instructions for most platforms. If your platform is not listed, please contact CA Technologies, Inc. for appropriate download directions.

3. INSTALLATION 23

Installing iDash

3.4.2. Creating the iDash Database

The iDash application stores information in a database. All versions of Oracle, Sybase, or MS SQL Server are supported. The following steps provide a guideline on how to create the database. If you already have a database for iDash, then please skip this part.

For Oracle

1. Create a tablespaces for data, indexes and temp.

Example (for Oracle 10g): CREATE TABLESPACE "IDASHINDEX" LOGGING DATAFILE '/install/oracle/oradata/idashindex.dbf' SIZE 1000M; CREATE TEMPORARY TABLESPACE "IDASHTEMP" TEMPFILE '/install/oracle/oradata/idashtemp.dbf' SIZE 100M; CREATE TABLESPACE "IDASHDATA" LOGGING DATAFILE '/install/oracle/oradata/idashdata.dbf' SIZE 1000M;

2. Create the iDash database user.

Example: CREATE USER "IDASH" PROFILE "DEFAULT" IDENTIFIED BY "idash" DEFAULT TABLESPACE "IDASHDATA" TEMPORARY TABLESPACE "IDASHTEMP" ACCOUNT UNLOCK; GRANT "CONNECT" TO "IDASH"; GRANT "RESOURCE" TO "IDASH";

For Sybase or MS SQL Server

1. Create a database for iDash.

Example: create database IDASH on /install/sybase/data/idashdata=1000 log on /install/sybase/data/idashlog=50 go

2. Create the iDash database user.


Installing iDash

Example: sp_addlogin idash,idash,IDASH go use IDASH; sp_changedbowner idash go sp_dboption IDASH,trun,true go sp_dboption IDASH,sele,true go

3.4.3. Installing iDash on UNIX/LINUX

To install iDash, please download the following ISO images from the CA Software download site. CA Workload Automation iDash 2.6 SP1 CA Workload Automation iDash CA Third Party Requirements Before proceeding with the installation, please contact CA Customer Care (http://www.ca.com/us/customer-care.aspx) and provide the hostname, fully qualified hostname, and IP address of the webserver for creation of your license file. 1) Log on to the Web Server machine as the user that runs the Web

application server (Tomcat). This user must have the following privileges: a. Full privileges on the iDash software directory and its sub-

directories. b. Read capability on all job definitions across all CA Workload

Automation AE instances.

2) Create the directory where all the iDash files will be stored (the iDash Base Directory), as defined in the Pre-Installation Checklist. Make sure the directory can store up to 100Mb of data.

3) Set an environment variable that provides the location of the JAVA Base

directory. If you are using Tomcat, then please set the CATALINA_HOME environment variable to provide the location to the Tomcat Base Directory. Add the Java binaries to your PATH variable.

JAVA_HOME=<Base Directory of JRE>; export JAVA_HOME CATALINA_HOME=<Tomcat Base Directory>; export CATALINA_HOME PATH=$JAVA_HOME/bin:$PATH; export PATH For example,

3. INSTALLATION 25

http://www.ca.com/us/customer-care.aspx

Installing iDash

JAVA_HOME=/opt/jre1.6; export JAVA_HOME CATALINA_HOME=/opt/tomcat6; export CATALINA_HOME PATH=$JAVA_HOME/bin:$PATH; export PATH

4) Set the IDASH_HOME environment variable that provides the location of

the iDash Base directory created in the above step #2.

IDASH_HOME=<iDash Base Directory>; export IDASH_HOME For example, IDASH_HOME=/opt/CA/idash; export IDASH_HOME

5) Stop the Tomcat server.

% $CATALINA_HOME/bin/shutdown.sh 6) Mount the CA Workload Automation iDash CA Third Party

Requirements ISO file. Go to the directory where the ISO image has been mounted. Alternatively, you can extract the files included in this ISO image and go to the directory where those files are located.

7) Run the “installer.sh” script that is included as a part of this ISO

image.

% sh installer.sh

The script will prompt you to accept the terms of the license agreements for the third-party libraries used by iDash. Enter “yes” to accept or “no” to decline and quit the installation.

8) If you have accepted the license agreement for the third-party libraries,

extract the contents of the “idash-thirdPartyLib-2.6.1.1.tar” file to $IDASH_HOME/thirdPartyLib directory, where $IDASH_HOME is the environment variable defined in step#4.

% mkdir $IDASH_HOME/thirdPartyLib % tar xvf idash-thirdPartyLib-2.6.1.1.tar –C $IDASH_HOME/thirdPartyLib itext-2.0.3.jar jcommon-1.0.9.jar jfreechart-1.0.5.jar jtds-1.2.jar

9) Un-mount the CA Workload Automation iDash Third Party Requirements

ISO file. Mount the CA Workload Automation iDash ISO file. Go to the


Installing iDash

directory where the ISO image has been mounted. Alternatively, you can extract the files included in this ISO image and go to the directory where those files are located.

10) Run the “installer.sh” script that is included as a part of this ISO

image.

% sh installer.sh

The script will prompt you to accept the terms of the CA EULA. Enter “yes” to accept or “no” to decline and quit the installation.

11) If you have accepted the CA EULA, copy the iDash software installer program to the $IDASH_HOME directory cp idash-install-2.6.1.1.sh $IDASH_HOME

12) Go to the $IDASH_HOME directory and run the iDash installation

program. If you are not logged on to the console, you have to launch the command line version of the installation program by providing a “-c” parameter to the program.

% sh idash-install-2.6.1.1.sh -c

13) Enter the appropriate information at the prompts. The following shows

the prompts and values based on the checklist. Starting Installer ... This will install iDash on your computer. It is recommended that you close all other applications before continuing. OK [o, Enter], Cancel [c] Hit Enter to continue.

Where should iDash be installed? [] Enter the location of the directory where the product will be installed. This is the $IDASH_HOME directory. Based on the sample checklist provided above, type in “/opt/CA/idash” and hit the Enter key. It will prompt you with a message that the directory already exists and would you like to install to that directory anyway. Type in “1” and hit Enter.

3. INSTALLATION 27

Installing iDash

Please select the Web Application Server Tomcat [1, Enter], Sun One [2] Hit Enter to use Tomcat as the Web Application Server, or type in “2” and hit Enter to use the Sun One Web Application Server. Please enter Tomcat location Specify Tomcat location [/opt/tomcat6] Hit Enter to accept the location shown, or type in the directory name where Tomcat is installed. Please enter Java location Specify Java base directory [/opt/jre1.6] Hit Enter to accept the location shown, or type in the directory name where JRE v1.6 is installed. Please wait while the installer scans your system Reading from files… Please check the information below JAVA_HOME [/opt/jre1.6] IDASH_HOME [/opt/CA/idash] JAVA_OPTS [-Didash.home=/opt/CA/idash –Xms200m –Xmx200m] Hostname of the Web Server [venus] IP Address of the Web Server [192.168.200.19] Port Number of the Web Server [8081] Web Server Type and Version [Apache Tomcat – 6.x] Location of Web Server webapps directory [/opt/tomcat6/webapps] The above prompts constitute the final checklist. The install program shows one prompt at a time and provides the capability to change the values, if desired. The values are shown based on the information provided earlier, and based on some system checks performed by the install program. Hit Enter to accept the information shown.


Installing iDash

Is it okay to proceed? Yes [1, Enter], No [2] Hit Enter to proceed with the installation. At this point, the installer will extract the software files, and copy the necessary files to the Web Application Server location. The next step is to provide information about the database that will be used by iDash. Please select Database Type for iDash Database iDash Database Vendor MS-SQL [1, Enter] Oracle [2] Sybase [3] Type in the number corresponding to the database type, and hit Enter. From our checklist, we will enter “1”. Please enter information for iDash Database iDash Database Host name [ ] Enter the name of the machine where the database is running. From our checklist, we will enter “neptune”. iDash Database Connection Port [ ] Enter the database connection port number. From our checklist, we will enter “1433”. iDash Database User [ ] Enter the name of the database login id that will be used to connect to this database. From our checklist, we will enter “idash”. iDash Database Password [ ] Enter the password for the database login id. iDash Database Name (optional) [ ] This is the name of the MS SQL database. If the database login user does not have default database set to the iDash database, please provide the name of the database here. From our checklist, we will enter “idashdb”.

3. INSTALLATION 29

Installing iDash

Please wait while the installer configures iDash Database Validating Database connection... Please wait while the installer configures iDash Database Creating iDash Database objects... Loading data into iDash Database... Please select your choice for AutoSys Instance Would you like to configure AutoSys instance? Yes [1], No [2, Enter] At this point, the installation is complete. If you like, you can enter “2” to exit the installation, or enter “1” to add information about the AutoSys instances. You can always add information about the AutoSys instances from the iDash Admin Tool GUI. To illustrate the Admin Tool in the next chapter, we will enter “2” to exit the installation. Please wait while the installer writes into conf files Loading configuration data into conf files... Creating idash_server file... Please wait while the installer writes into log file Writing into log file... Restart Tomcat? Do you want to restart Tomcat ? Yes [1, Enter], No [2] Enter 2 to exit the installation. Finishing installation...

14) The installation creates a file called “idash_server” in the $IDASH_HOME/bin directory. This file can be used to start and stop the iDash server. This file can also be modified to change the values of certain environment variables. The script accepts “start” and “stop” as parameters to Start and Stop the iDash server respectively.

15) Restart the Web Application Server and monitor the log files

($IDASH_HOME/log/info.log or $CATALINA_HOME/logs/stdout.log) to make sure that iDash comes up fine.

% sh $IDASH_HOME/bin/idash_server start At this point, you can start working with the iDash Admin Tool. Chapter 4.5 Configuring iDash covers that part.


Installing iDash

3.4.4. Installing iDash on Windows

To install iDash, please download the following ISO images from the CA Software download site. CA Workload Automation iDash 2.6 SP1 CA Workload Automation iDash CA Third Party Requirements

Before proceeding with the installation, please make sure you have provided the information to CA for the license file. 1) Log on to the Web Server machine as an user that has local

administrator privileges. 2) Create the directory where all the iDash files will be stored (the iDash

Base Directory), as defined in your Pre-Installation Checklist. Make sure the directory can store up to 100Mb of data.

3) Stop the Tomcat server service.

4) Mount the CA Workload Automation iDash CA Third Party Requirements ISO file. Alternatively, you can extract the files included in this ISO image to a temporary directory.

5) From a Windows Command prompt, go to the directory where the ISO is mounted or where its files are extracted.

6) Run the “installer.bat” program that is included as a part of this

ISO file. The script will prompt you to accept the terms of the license agreements for the third-party libraries used by iDash. Enter “yes” to accept or “no” to decline and quit the installation.

7) If you have accepted the license agreement for the third-party libraries,

extract the contents of “idash-thirdPartyLib-2.6.1.1.zip” to a directory named “thirdPartyLib” under the iDash Base Directory that was created in step#2.

8) Un-mount the ISO file. Mount the CA Workload Automation iDash 2.6

SP1 ISO file. You can extract the files included in this ISO image to a temporary directory.

9) From a Windows Command prompt, go to the directory where the ISO is

mounted or where its files are extracted.

3. INSTALLATION 31

Installing iDash

10) Run the “installer.bat” program that is included as a part of this ISO file. The script will prompt you to accept the terms of the CA EULA. Enter “yes” to accept or “no” to decline and quit the installation.

11) If you have accepted the CA EULA, start the iDash installation by

running the “idash-install-2.6.1.1.exe” program.

12) Enter the appropriate information at the prompts. The following screens show the prompts and values based on the checklist.

After the initial screen, next one prompts for the location where the iDash software will be installed. This will be the same directory that was created in step#2.

The next screen asks for the Start Menu folder. The default is iDash. After that, the next screen asks for Tomcat or Sun One as the Web Server.


Installing iDash

Choose the appropriate server and click on Next.

The installer prompts for the location of Tomcat. Browse to the directory where Tomcat is installed and select it.

3. INSTALLATION 33

Installing iDash

The next screen shows the current location of JRE.

You can choose the JRE location found by the installer, or specify a different one. The next screen shows the summary of the installation configuration. Click on Yes to proceed. At that point, the software will be extracted and the registry entries updated. The next part is to configure the iDash database.


Installing iDash

Select the database type for iDash and go to the Next screen.

3. INSTALLATION 35

Installing iDash

Provide the information about the machine where the iDash database is running, the database port number and the user id and password. When you click on Next, the installer will connect to the database and install the iDash database objects. At this point, the installation is complete. If you like, you can Exit the installation, or click on Yes to add information about the CA Workload Automation AE instances. You can always add information about the CA Workload Automation AE instances from the iDash Admin Tool GUI. You can learn more about the Admin Tool in the next chapter. The following illustrates the steps needed to add an AutoSys Instance from the installer. Select “Yes” and click on Next.


Installing iDash

Type in the 3-letter Instance name and select the version and type of database for the instance. Click on Next and enter the database connectivity information for the instance.

The Next screen allows you to enter values for optional environment variables associated with the AutoSys instance. Clicking on Next will add entries about the instance into the iDash database. Select No to exit the installation.

13) Start the Tomcat Service. At this point, you can start working with the iDash Admin Tool. Chapter 4.5 Configuring iDash covers that part.

3.4.5. Installing the iDash Client CLI

The iDash Client GUI is a Java applet, and does not require any installation. The client machine needs to have JRE v1.5.x or JRE v1.6.x installed. The iDash Client CLI is a set of commands that can be installed on any machine, including the iDash GUI clients. These commands enable authorized users to perform certain iDash Administration activities, generate iDash reports from the command line.

3. INSTALLATION 37

Installing iDash

Administrators need to setup authorizations for users running these commands. This can be done from the Admin Tool. The iDash Client CLI software is in a file named idash-client-2.6.1-<platform>.tar (for UNIX/LINUX) or idash-client-2.6.1-win.zip (On Windows), where <platform> is the operating system of the client machine. These files are present on the iDash server, in the “install” sub-directory under the iDash software base directory. Additionally, the third-party library files present in the “thirdPartyLib” sub-directory under the iDash software base directory on the iDash server have to be copied to each CLI client machine. These files should be copied to the “lib” sub-directory under the iDash software base directory on each CLI client machine. Alternatively, you can modify the iDash client CLI software tar/zip file and add these third-party libraries to the “lib” directory. That way, you do not have to copy over these files every time you install the CLI on a remote machine. Create the directory where the iDash files will be stored (the iDash Root Directory on iDash Client), as defined in the Pre-Installation checklist. Make sure the directory can store up to 5Mb of data.

1) Log on to the Client machine and extract the files from the software image

to the iDash Root Directory. For example, as per the sample checklist, this would be the C:\ca\idash directory.

2) Have the user set one environment variable: IDASH_HOME. IDASH_HOME gets set to the iDash Base Directory on the Client machine. For example, as per the sample checklist, set IDASH_HOME=C:\ca\idash

3) Edit the %IDASH_HOME%\etc\idash.conf file and add a line that provides the connection information for the iDash Server. The line to add is as follows: idash.server.url=http://IDASH_SERVER:PORT where, IDASH_SERVER = Name or IP address of iDash Server machine


Installing iDash

PORT = The HTTP port for the iDash Web Server For example, as per the sample checklist, idash.server.url=http://venus:8081

4) If you have not modified the tar/zip files to include the third-party libraries, copy the files in “thirdPartyLib” sub-directory from the iDash server machine to the “lib” sub-directory on the iDash client machine.

5) Now, to run the commands, the users can go to %IDASH_HOME%/bin directory. More information about the commands is provided in the CA Workload Automation iDash User Guide.

3. INSTALLATION 39

Configuring iDash

3.5. Configuring iDash

3.5.1. Starting the iDash AdminTool You can launch the iDash Admin Tool using Java Web Start on your iDash Client machine. Pass in the appropriate URL as specified by your Pre-Install Checklist as an argument to Java Web Start. Using the working example, run the following command on your Client machine: javaws http://venus:8081/idash/AdminTool.jnlp You will be prompted with a Security Warning. Click on Always to continue launching the Admin Tool. The first time you launch the application, Java Web Start must upload the application image, so you may experience some delay if you have a busy network. This initial upload only occurs the first time you launch an application through Java Web Start or when software upgrades occur. Once loaded you should see the login prompt. We recommend creating a shortcut on your desktop to launch Java Web Start. After doing so, subsequent launches of iDash can be done by using the desktop shortcut. You can create the shortcut by launching the Java Application Cache Viewer and right-clicking on the icon and selecting Install Shortcuts. To launch the viewer, just run the command “javaws-viewer”. An example is shown below:


Configuring iDash

The following shows the Admin Tool log-on screen. If you see this, then iDash has been successfully installed.

The initial password for the idashAdm user is “idashAdm”. After the first logon, you will be prompted to change the password for this user. The password for any user must be at least 8 characters and must include at least one alpha character, a numeric character and a non alpha-numeric character. Once your password has been validated, you will see the iDash Admin Tool as shown below.

3. INSTALLATION 41

Configuring iDash

3.5.2. Adding CA Workload Automation AE Instances Click on the Instance Tab in the iDash Server section to configure iDash with the CA Workload Automation AE Instance information, and click on New Instance to provide information for a CA Workload Automation AE Instance not defined yet in iDash. Here is what the configuration would look like based on the sample values listed in the checklist.


Configuring iDash

First the Basic Instance information:

3. INSTALLATION 43

Configuring iDash

Next, the Environment detail:


Configuring iDash

And then, the CA Workload Automation AE database Connection detail:

URL:

jdbc:oracle:thin:@HOST:PORT:SID (Oracle) jdbc:jtds:sybase://HOST:PORT/DATABASE (Sybase) jdbc.jtds.sqlserver://HOST:PORT/DATABASE (MS SQL Server)

User/Password:

DBUSER (All databases) DBPASS (All databases)

Where...

HOST Hostname or IP Address of the machine where the autosys RDBMS resides

PORT Port number for the database

SID The Oracle SID or Global Service Name for the Oracle instance that the database is on

DATABASE The name of the Sybase or MS SQL database where the CA Workload Automation AE data resides. If the DBUSER has this database already setup as its default, then this attribute is not needed.

3. INSTALLATION 45

Configuring iDash

DBUSER The database user that has read permissions on all CA

Workload Automation AE tables and update permissions on the alarm table and execute access to the sendevent stored procedure. Typically, this is the database user “autosys”.

DBPASS The password of the database user DBUSER

And finally, the details about the Instance Timezone and date/time view format:

1) After providing all information about the CA Workload Automation AE

instances, click on the Test icon to verify that the iDash Server can reach the configured CA Workload Automation AE database(s).

2) If there are any errors reported, refer to the Installation Troubleshooting

section for solutions.

If no errors are reported, click on the Save icon .

3) Launch the iDash Application using Java Web Start. Since this is the first time you are launching the application, on the iDash Client machine run a command similar to the one for the Admin Tool.

javaws http://venus:8081/idash/iDash.jnlp

4) Provide the login information and, once you are authenticated, the iDash

monitoring and control application will be launched.


Configuring iDash

Since you have not yet defined and SLAs, the dials should all be green (except the CA Workload Automation AE gauge, with will be red if any of the CA Workload Automation AE instances have a high latency).

The SLA Console will not have any statuses to show, since no SLAs have been defined yet. If you can see this interface, then iDash has been installed successfully.

3. INSTALLATION 47

Post-Installation Checklist

3.6. Post-Installation Checklist

After installation according to the above steps, the following items must be done or verified to assure full functionality of iDash clients.

A Web browser must be in the PATH variable on the client or the location of the browser must be provided in the IDASH_HOME/dat/user/<username>/props file

√


Installation Trouble Shooting

3.7. Installation Trouble Shooting 3.7.1. Common Installation Problems

1) IDASH_HOME environment variable is incorrect or not set 2) Database URLs are incorrect

3) JAVA_OPTS environment variable is not set correctly 4) Database user password is incorrect 5) Database user permissions are incorrect

6) The Tomcat options for Java are not set correctly

3.7.2. Pathology: Symptoms and Solutions

SYMPTOM/PROBLEM

CAUSE/SOLUTION

“Invalid User” error message

Possible typo in login screen. Retype user name.

“Invalid Password” error message

Possible typo in login screen. Retype password.

Web Application Server does not start iDash Daemon

JAVA_OPTS variable may be incorrect. Re-set the JAVA_OPTS variable and restart the web server.

“unauthorized access” errors in IDASH_HOME/log/error.log file

Database user password is incorrect. Solution: correct it.

3. INSTALLATION 49

iDash Server Settings

4. THE ADMIN TOOL The iDash Administration Tool (“Admin Tool”) is the configuration interface to iDash. You use the Admin Tool to create or update CA Workload Automation AE Job SLA definitions, define CA Workload Automation AE instance connection parameters, manage iDash user authentication and authorization policies, view/create user Audit reports, etc. The Admin Tool is for use only by designated iDash Administrators.

4.1. iDash Server Settings

The Installation Chapter should get you to the point where you can see the Administration Tool interface, looking something like this.



The tabs on the left side in the Admin Tool provide access to the main configuration sections. Each configuration section has tabs at the top of the Admin Tool, which enables administrators to view, enter or modify information pertaining to a particular area. The data within each tab is saved individually.

For example, clicking on the Save icon in this screen will save only the iDash Server information.

4.1.1. General This area allows you to provide some description for the iDash installation. This information is shown in the main iDash GUI. iDash Server Fields

Description

Site Name Name of the site running CA Technologies, Inc. software (and iDash Daemon).

Site Description Description of the iDash Server site.

Primary Server URL Secondary Server URL

The name of the primary and secondary iDash Server machine and the HTTP port number of the Web server respectively.

Audit Expiration iDash will maintain an online audit for the number of days specified here. After that, the audit files will be archived. The default value is 30 days.

Maximum Rows for Reports

When iDash reports are generated, only those reports that have total number of rows less than this value will be processed.

Hold DB Connections

If this option has been selected, each of the daemon threads that reads data from its CA Workload Automation AE instance will keep the database connection open. This reduces the processing overhead on the server and the database. By default, this option is turned on.

Parallel Refresh If this option has been selected, the daemon will retrieve data from multiple CA Workload Automation AE instances concurrently (in parallel). This speeds up the data refresh cycle on the server. By default, this option is selected.

THE ADMIN TOOL 51


4.1.2. Instance This is the area where you provide the information for each CA Workload Automation AE instance that will be accessed by this iDash server.

The sub-tabs and fields on this screen provide the information about each CA Workload Automation AE instance that the iDash Daemon will access. The information must be entered for each CA Workload Automation AE instance. The Copy Instance button can be used to create an identical AUTOSERV instance connection with a new instance name. Once copied, just the unique information for the new instance will be entered. The Primary Connection and Secondary Connection values mirror the CA Workload Automation AE convention for Primary and Secondary Event Server. The following table explains the fields listed in this area. Field Description

AUTOSERV (pulldown)

The CA Workload Automation AE instance name, as denoted by the AUTOSERV environment variable. This is the unique identifier for each CA Workload Automation AE instance added to iDash.



Version The version of CA Workload Automation AE for this Instance (e.g. 4.x, r11, r11.3).

Description A text description of the instance.

JDBC Driver JavaTM DataBase Connection driver. The pull-down lists the options for Sybase, Oracle, and SQL Server drivers.

JIL Reload Timeout

Number of seconds to wait before reloading all job definitions based on job time stamp changes. The default is 300 seconds.

Stats Refresh The frequency (in minutes) of Instance statistics retrieval from the CA Workload Automation AE database.

Alarm Hours The iDash Daemon will retrieve all CA Workload Automation AE alarms that occurred within the number of hours specified here.

Run Past Hours The amount of historical run data that will be stored in memory on the iDash server. We recommend setting this value to the run duration of your longest job stream.

Archive Events Date Format

The date format, as shown in the name of the archive files generated by CA Workload Automation AE.

Archive Events Delimiter

The delimiter for the data inside the files generated by the DBMaint process. The default value is a comma (“,”) for r11.3 instances.

Refresh from Secondary Connection

If the CA Workload Automation AE instance has Dual Servers, the iDash Daemon would retrieve the data from the Primary Server. If this option is selected, the iDash Daemon will retrieve data from the Secondary database. This may be desired in case of network problems or database issues.

Hold DB Connections

Specifies whether the iDash Daemon process should maintain its connection to the CA Workload Automation AE database. If the connection is not maintained, the Daemon will create a new connection to the database every time. It is recommended to turn this setting off.

SLA Processing Enabled

Use this parameter to turn on or off the SLA processing for any CA Workload Automation AE instance. If the processing is not Enabled, iDash will ignore all SLA definitions associated with this CA Workload Automation AE instance, and users will not see any SLAs in the iDash GUI application.

Refresh Enabled Used to enable or disable the iDash Daemon data

THE ADMIN TOOL 53


retrieval process from the instance. If disabled, the iDash Daemon will not read any data from the instance until it has been enabled.

The Environment tab is where you specify information about the CA Workload Automation AE installation on the iDash server.

Field

Description

AUTOSYS Path to AUTOSYS directory on the iDash Server. If the CA Workload Automation AE Remote Agent has not been installed on the iDash Server, leave this field blank.

AUTOUSER Path to AUTOUSER directory on the iDash Server, if the CA Workload Automation AE Remote Agent has been installed on the machine.

ORACLE_HOME Value of the ORACLE_HOME environment variable on the iDash Server.

TNS_ADMIN Value of the TNS_ADMIN environment variable on the iDash Server. This is needed by the CA Workload Automation AE Remote Agent to locate the database connection information.

SYBASE Value of the SYBASE environment variable on the iDash Server. This is used by the CA Workload Automation AE



Field

Description

Remote Agent to locate the database connection information.

You specify the CA Workload Automation AE Database connection parameters for the Primary and Secondary CA Workload Automation AE database in the Primary Connection and Secondary Connection areas.

Field

Description

URL The database connection parameters used by the JDBC driver.

Schema Owner The database user that owns the CA Workload Automation AE tables. This is needed for Oracle databases only.

User The database user for the connection.

Password The password for the database user.

Re-enter Re-enter the password for verification.

DSQUERY The name of the Sybase Dataserver or the ORACLE TNS alias.

THE ADMIN TOOL 55


You specify the Instance Timezone and date/time view format for this Instance in the GUI tab.

Field

Description

Timezone The timezone setting for the instance, as specified to the CA Workload Automation AE Event Processor.

Time Format The dates and times for the jobs and SLAs in this instance will be shown using the format specified here.

Current Time An example of how the dates and times will be shown, as per the format selected above.

For more information about this area, refer to the section Adding CA Workload Automation AE Instances in the previous chapter.



4.1.3. Message of the Day Select the Message of the Day tab to view or change the Message of the Day.

Click the Save icon to save the message.The Message of the Day appears in the login screen when the iDash Client is launched. If the Message of the Day is changed, then all active iDash Clients will display the new message. Users are required to acknowledge the message before they can continue working with the client.

THE ADMIN TOOL 57


4.1.4. License Enter the CA Technologies, Inc. provided license key in this area.

Use the Check icon to be sure the license information is correct. Click

the Save icon after you have entered the key.



If the iDash Server is a part of a hardware cluster, or if it has the capability to rollover to another system in case of a system crash, then the license for the second system should be entered on the License 2 tab. iDash Server License Attributes

Description

License Key The unique iDash license code generated for the following fields.

Host Name iDash Server machine name.

IP Address Internet Protocol address for the iDash Server.

Expiration License expiration date.

Instances The number of CA Workload Automation AE instances that the iDash Server will access.

4.1.5. User Command

User Commands are a way for iDash to pass job data to an existing UNIX, LINUX or NT script, command, or program. If a user selects one job and executes a User Command, it is processed as follows: 1) The command is authorized for the user. 2) The proper environment variables are set. 3) The command is executed. 4) The results are returned. User commands can be executed for a single job only. If the command fails, or is unauthorized, the server captures the resulting text, and returns the results to the client. Example: A command may be setup to return Operator Instructions for any job selected by the user on the client. To Create a new User Command:

1) Click on the New User Command icon and assign a name.

2) Type or edit the command in the Command text box. Enter the full path to any command or executable that is not included in the PATH set on the iDash Server for the user running the iDash Daemon.

THE ADMIN TOOL 59


3) Enter the Input Prompt text if applicable. (See the email address example

in the Interactive User Commands section of this document.)

4) Click on Save to save the new User Command to the iDash Daemon. This will make the User Command available to iDash users with the proper permissions. After defining a new User command, users with active sessions will have to exit and log back in to the GUI to access the new commands.

5) By default, when users execute any user command, they need to confirm

the execution. If desired, the additional step of confirmation can be eliminated for certain user commands by un-checking the Confirmation Dialog checkbox.

6) Click on the Remove icon to delete the User Command from the iDash Daemon.



The following environment variables are set in the environment on the iDash Server before the command is executed. User Command Variable Description

IDASH_USERCOMMAND_JOB_NAME The selected job's

name.

IDASH_USERCOMMAND_LAST_START

The selected job's last start time.

IDASH_USERCOMMAND_LAST_END The selected job's last end time.

IDASH_USERCOMMAND_LAST_RUN_MACHINE The selected job's last run machine.

IDASH_USERCOMMAND_LAST_JOB_JOID The selected job's status, e.g. "SUCCESS".

IDASH_USERCOMMAND_USER_NAME The name of the iDash user executing the command.

IDASH_USERCOMMAND_INPUT The text input by a user during execution of an Interactive User Command.

The following CA Workload Automation AE environment variables are set for User Commands:

•AUTOSERV •AUTOUSER •AUTOSYS •DSQUERY •PATH, with the $AUTOSYS\bin directories pre-pended.

4.1.5.1. Interactive User Commands

A User Command may prompt for input during user execution. The following example User Command prompts for an email address to send job run data.

THE ADMIN TOOL 61


The following defines the Email command with the prompt “Enter email address”.

To execute the User Commands, right click on any job in the main iDash GUI and go to the User Command sub-menu.



Enter the input at the prompt.

iDash shows any output generated by the User Command in a web browser window. Since iDash sets the above listed environment variables before executing the script associated with the User Command, the script can leverage the same variables and perform the required action.

THE ADMIN TOOL 63

iDash DB configuration

4.2. iDash DB configuration Select the iDash DB section in the Admin Tool to enter the iDash Database configuration area.

This screen should already be completed, since you will not be able to login to the Admin Tool the first time without a database connection. If this is a High Availability installation, enter the information for the second database on the Secondary Connection tab.

4.2.1. CA Workload Automation AE Archive Data You can load the CA Workload Automation AE archive data files in to the iDash database from this area. You can load the CA Workload Automation AE Job Runs, Events, and Autotrack archived files. To load the Archive files, you can install the iDash CLI client on the machine where the “DBMaint” command is run periodically to archive the data from the CA Workload Automation AE database. Then you can run the “idarchive” command with the appropriate parameters to upload the archive data files into the iDash database.



The Archive area has three tabs : Run, Event, and Autotrack. You can load the archive files for Job Runs, Events, and Autotrack information by using these tabs. Each tab will provide a list of files that have been copied to the above mentioned directories. If the file has already been loaded in to the iDash database, the Archived Column will have a checkmark next to the file name. To load an Archive file, just click on the file and click on the Archive icon in the toolbar. The file will be loaded in to both the iDash databases, if configured with dual databases. To delete the archived data from the iDash database, click on the file whose data you would like to delete, and click on the “Remove Archive” button.

THE ADMIN TOOL 65



Creating SLA Definitions

4.3. Creating SLA Definitions

Select the SLA tab in the Admin Tool to enter the SLA definition area.

4.3.1. What is an SLA definition?

CA Workload Automation AE job streams are created to automate certain business processes. Most of these processes have an internal service level agreement (SLA) with other business processes. Hence, it is desired that the CA Workload Automation AE job streams that fulfill these business processes also meet or exceed the corresponding service level agreements. Normally, the service level agreements are summarized as status or time based thresholds for job streams. For example, − Every job within a job stream must end in a SUCCESS status. − The entire job stream must complete successfully by a particular time. − A job within the job stream must start by a particular time. − A job or a set of jobs within a job stream must start and finish by a

particular date and time.

THE ADMIN TOOL 67


iDash monitors the entire CA Workload Automation AE environment, performs real-time forecast based on the current status of the system, generates alerts when the thresholds are at risk or are missed, and executes utomated recovery actions.

le- box jobs that make up a job stream. Here, you can do the

llowing :

The schedule and time(s) by which the job is required finish successfully.

or e job – one is a start-by deadline and the other is a finish-by deadline..

n for iDash. In addition, you can efine some parameters for each definition.

t Risk Warning

a This tab enables you to define the SLA thresholds for any command, fiwatcher, orfo − The schedule and time(s) by which the job is required start. − If you want to assign a schedule and time(s) by which the job must start and finish successfully, then you need to create two separate SLA deadlines fth Each of the above makes up an SLA definitiod A

e

are

tc. will dversely affect the ability of your job to meet its SLA deadline.

ash predicts at the box job will complete before 8:00am but after

Typically, if a job meets its defined SLA deadline, then it is considered to havperformed fine. However, you may want to be notified if a job is predicted to meet its SLA, but just by X minutes to the deadline. This way, you are awthat the Critical Path and the SLA job are operating under a “tight” time window and any delays due to job failures, longer running jobs ea For example, you have an SLA deadline of 8:00am for the successful completion of a box job. You can assign a At Risk Warning value of 10 minutes to this SLA definition, if you wish to be notified when iDth 7:50am.

t to 0 (zero), iDash ill not

The default value for this field is 0 minutes. If this field is sew generate AT RISK warnings for this SLA deadline.



Run Validity

d e fulfilled the SLA deadline. This time is relative to the SLA deadline

me.

b run fter 5:00 PM will be considered to have fulfilled the 7:00 PM deadline.

he default value for this field is 120 minutes.

4.3.2. Creating an SLA definition

lick the Add icon

This field specifies to iDash the earliest time that a job run can be considereto havti For example, a job has a start-by SLA deadline of 8:00 AM, and 7:00 PM. If the run validity is set to 120 minutes, then the first job run after 6:00 AM will be considered to have fulfilled the 8:00 AM SLA deadline, and the first joa T

C to create a new SLA definition.

b Enter and the list of jobs matching

e string you have entered will appear.

as enable you to narrow down the list of jobs based on the categories listed.

The Job Search popup will appear. Enter any information known about the joname, using * for a wildcard. Then pressth

The Job Search will also highlight the classification areas that are applicable to the job name string entered. The classification are

THE ADMIN TOOL 69


When you click on any highlighted category,the selected category will be shown. For example, the following shows those jobs that have no successors (i.e. they could be the last jobs in their respective job streams).

from the entire job list that match



Category Jobs Shown

All All that match the job name string. Level Zero Jobs that are not within a box job. Boxes Box jobs only. Time Settings Jobs that have Date/Time conditions only. Time Settings and Conditions Jobs that have Date/Time conditions and

Starting Conditions. 3 or More Predecessors. Jobs that have 3 or more direct predecessors. No Predecessors Jobs that have no Starting Conditions. 3 or More Successors Jobs that have 3 or more direct successors. No Successors Jobs that have no direct successors. Runtime More Than One Hour Jobs that have an average runtime greater than

sixty (60) minutes. Choose the job for which you want to create an SLA and click on OK. The Job name and Instance name are entered automatically and cannot be changed. If desired, a Description can be entered. If you need to disable this SLA at any time, uncheck the SLA Enabled box. If you want to view the historical job runs of the selected job, click on the Job Runs button in the toolbar. To view the job definition, click on the Job Definition button. When you click on the Job Runs button, you will be able to see all the historical job runs for the selected job, including the archived data. When you click on OK, the SLA Definition Helper will assist you in defining the parameters for the SLA.

THE ADMIN TOOL 71


You can look at the Run History and Job Definition of the selected job by

al

ition, nt

clicking on those options. You can also view the Flow diagram of the CriticJobs for this SLA job by clicking on the Job Diagram option. The next screen shows the suggested date parameters for the SLA definbased on the CA Workload Automation AE definition of the job or its parebox.



THE ADMIN TOOL 73

If using a Run Calendar or Exclude Calendar, the magnifying glass icon will show the days that are defined in that calendar. If you would like to create SLAs for a different set of days than the ones shown, then click on the “Run Calendar” or “Days Of Week” button and specify the calendar/days.

Creating SLA Definitions Creating SLA Definitions


The Next screen asks whether the SLA will be used to specify a “Start By” deadline, or an “End By” deadline.



The Next screen shows the suggested Time parameters for the SLA deadline criteria chosen in the previous screen.

The Time tab defines the start or end time required for the job by this SLA. You can defined as many start/end times as needed. Click the Add icon to define a new starting or ending time, along with At Risk, Run Validity, Start Tracking, End Tracking times, and Run Past Hours (as described in What is an SLA definition?).The Past Hours setting enables users to view all runs between the current time and this value, for every job in the SLA's Critical JobList. The job runs are shown in the Job Console for the selected SLA. Note the icon in front of each Time deadline. The icon shows whether it is “Start” deadline or an “End” deadline.

he example below shows Start SLAs at 22:30, and End SLAs at 17:00 and T23:00.

THE ADMIN TOOL 75


The Next screen shows the Alarm tab that enables you to define which CA

xisting SLA.

Next screen shows the Alarm tab that enables you to define which CA

xisting SLA.

Workload Automation AE Alarms you want triggered when specific situations occur. The default alarm selection is based on the ones chosen for Workload Automation AE Alarms you want triggered when specific situations occur. The default alarm selection is based on the ones chosen for an an ee

The Last screen shows the Script tab whicany, when an SLA alarm is triggered. The script is passed environment

the job, t

h defines what actions to take, if

variables defining he SLA, etc.



Un-check the “Enabled” box to disable the execution of the script. Click on Finish and then on the Save button Now the next SLA deadline for this job should show up in the GUI.

4.3.3. Forecast Parameters

This area enables you to define the iDash Daemon settings used for forecasting, refreshing data from the CA Workload Automation AE databases etc. Forecast Property Description

to save your new SLA definition.

Forecast Duration Hours How far in advance iDash will compute the predicted execution of job streams. Any SLA deadline that falls outside the current forecast duration will not be predicted till it falls within the window. Typically, this value is set between 12 and 24 hours.

re Hours The same thing for alarms. A predicted miss farther in the future than this will not be generated. If Alarm Future Hours is set to 5, an 8 PM SLA that is predicted to miss will not generate an alarm until 3 PM.

Alarm Futu

DB Refresh Interval The number of seconds between reads of the CA

Workload Automation AE database to update real-time information.

Forecast Interval The number of seconds between real-time forecasts performed by the iDash Daemon.

Online SLA Count The number of SLAs shown in the GUI for each job with SLAs defined.

Forecast Enabled Turning off the Forecast limi ats iD sh to displaying real-time status of SLAs.

THE ADMIN TOOL 77


Alarm Enabled Unchecking this option turns off all alarms in iDash.

Ignore On Hold The predictive analysis engine assumes that ON HOLD w

ica ic d miss. Check this box to ignore ON HOLD

jobs when calculating SLAs.

jobs ill stay on hold. That means the moment a aCrit

predl Path job is put on hold, the SLA will havete

4.3.4. Alarm Policy

When SLA alarms are triggered, there are two actions that can happen:

Notification—generates a CA Workload Automation AE Alarm and executes a script (if so con

Reporting—appears in the iDash GUI

ritical Path and CA Workload Automation AE alarms display icons on the UI only.

After changes have been made, click the Save icon

figured)

CG

.



SLA alarms occur when the iDash predicts the following conditions:

Alarm icon Description CA Workload Automation AE job status

SLA Predicted

Miss

An SLA is predicted to miss its SLA deadline

SLA At Risk An SLA is At Risk to miss its SLA deadline

SLA downtrend An SLA has a down-trending Critical Ratio

Job alarm Any open SLA alarm

Critical Path alarms occur when any job in a Critical Path has a status as shown:

s

Alarm icon Description CA Workload Automation AE job statu

Job On Hold

ON_HOLD

Long running job running at more than 120% of its

average runtime plus 2 minutes Job currently

Job error FAILURE or TERMINATED

Job alarm Any other open job alarm

CA W Autodescribed in the fol

D

orkload mation AE alarms that are displayed in the GUI are lowing table:

Alarm icon escription Open CA Workload Automation AE alarm types

DB Error DB_PROBLEM, DATABASE_COMM, DB_R OLLOVER

EP Error EP_SHUTDOWN, EP_ROLLOVER, MULTIPLE_EP_SHUTDOWN

HA Alert EP_HIGH_AVAIL

THE ADMIN TOOL 79


The other choices on the Alarm screen are shown in the table below:

Property Description Always Alarms are always triggered.

Never Alarms are never triggered.

Once per SLA

run Alarms are triggered only once per SLA deadline.

Once every n minutes

Alarms trigger when an error condition is detected. If the condition still exists after n minutes, another alarm is triggered

Close Alarm on Recovery

All the CA Workload Automation AE alarms that were created when the Alarm condition occurred are closed when the Alarm condition is remedied

More Recent than n minutes

In Reporting, the Alarm condition must have happened less thaminutes ago. When the required number of minutes have passed,the alarm icon goes away or the gauge goes back to green even if the alarm is still open.

n n



4.3.5. Forecast Overrides

Overrides provide the capability of doing “what if” analysis of your job stream SLAs.

le to simulate putting a job on hold, and taking it ff again, to predict the effect on an SLA.

. If the real time tatus of the job is ON_HOLD when the override is being created, then iDash ill assume that the job will be taken OFF_HOLD at the expiration date and

time. This enables you to find out the impact on SLAs if the job is kept ON_HOLD until the expiration date and time. On the Runtime tab, it is possible to change the predicted future run time of a job to evaluate the effect on an SLA. Every time the job is predicted to run until the expiration date and time, iDash will apply the specified run time as it's forecasted duration.

On the Hold tab, it is possibo The HOLD will go in to effect until the Expiration Date and Time. At the expiration date and time, the job will be taken OFF_HOLDsw

THE ADMIN TOOL 81



4.3.6

n modification within CA orkload Automation AE.

his functionality enables users to create a dependency between two jobs or thin

. Job Link

iDash provides the capability to link two non-related CA Workload AutomationAE jobs for the purpose of forecasting and SLA prediction. These job links arespecific to iDash and do not result in any job definitioW Tjob streams, that are related from a business perspective, but not setup wiCA Workload Automation AE with explicit dependencies.


THE ADMIN TOOL 83

Click the New icon to create a new Job Link. The Job Search dialog (similar to the SLA Creation panel) will appear. Enter any information known about the downstream job name, using * for a wildcard. Then press Enter and the list of jobs matching the string you have entered will appear. The Job Search will also highlight the classification areato the job name string entered. The classification areas enable youdown the list of jobs based on the categories listed. Select the job on which you wish to add an iDash predecessor Job Link. Click on the icon in the Predecessor field to launcdialog again. This time, select the upstreamjob. By default, the target job is setup to be dependent upon the success of the Predecessor job. You can change that by editing the word “success” in

s that are applicable to narrow

h the Job Search job for the already selected target

the Condition field to any other condition type supported by CA Workload Automation AE. Even though iDash does not create any explicit dependency within CA Workload Automation AE, it supports the CA Workload Automation AE syntax and method. Once you create a job link, the Predecessor job and its Critical Job List will be included in the Critical Job List for the target job. The iDash forecasting


engine will treat the job link as a reguiDash forecasting logic will be applie

lar starting condition, and all of the d to this new Critical Job List.

onditions, then iDash will predict that the job will start immediately after the successful completion of the job link condition.

If the target job does not have any explicit starting conditions or date/timec


Security Model

4.4. Security Model

You have to specify the user authentication model for users launching the Client GUI. By default, iDash is configured to authenticate users based on

ternal iDash user and password storage. The other option is to use Single Sign-On based authentication. From this tab, you can also enable the iDash Client CLI and specify the authentication model for users executing the commands.

Select the Security section to access the Authentication and Audit area.

in

THE ADMIN TOOL 85

Security Model

4.4.1

This is the default configuration for users launching the iDash GUI. Each user has to be setup with a password within iDash. The user name is of your

rec within ain. You can

settings here if you se

. iDash User/Password

choice, though we your dom

ommend using names that already exist for users specify the password policies and other account lect this option.


Security Model

In this section, you specify the Password settings.

Field Value

Maximum Incorrect The maximum number of incorrect passwordEntries

entries allowed before the account is automatically Suspended. The default value is 1000 tries.

Maximum Days The number of days after which the password for any user has to be re-set.

Minimum Days After setting a password, users cannot change that password for the number of days specified here. Admins can still change the password from the Admin Tool. The default value is 0 days.

Unique Entries A new password cannot match the last X number of passwords. The default value is 3.

Maximum Account Idle Days

If an iDash User account does not have any user or Admin activity for the number of days specified here, the account will be automatically Suspended by the iDash Daemon. The default value is 365 days.

NOTE: When you choose this authentication model, users have to enter username and password every time they launch the GUI.

THE ADMIN TOOL 87

Security Model

4.4.2. Single Sign-On If you choose this method of authentication, users do not have to enter a username and password when launch the GUI. The iDash Client GUI will recognize users based on their Domain or OS authentication.

Un , and Do machines are not within the list of valid IP Addresses or

der this method, you can provide a list of valid IP Addresses, Host names Windows Domain names. Users that are not authenticated to the valid

main, or whose iDash Client host names, will be unable to launch the GUI.

4.4.2.1.

machines.

You can provide multiple lists of valid IP Addresses, and you can use wildcards or ranges for certain values. For example, 192.1.1.* 19.68.5.10-200

10.1.86.7 *

IP Address

You have to provide a list of IP Address strings that will cover all valid iDash Client


Security Model

THE ADMIN TOOL 89

ess

ation of a user. r all

tive Directory, NT Domain, or local he names of valid Domains and local

Domain not listed, or logs on to the t be authorized to launch the

only it will pass the IP Address check.

4.4.2.2. Domain

This field is used to validate the Domain or OS authenticYou have to provide a list of Domains or host names that will covevalid user authentications. If a user is logging on to a Windows AcWindows machine, you can provide tmachine names. If a user logs on to a local machine not listed, then the user will noiDash GUI.

If an iDash Client machine matches any one of the specified IP Addrlists, then

Security Model


4.4.2.3. Host Names

You have to provide a list of host name strings that will cover all valid iDash Client machines. The list of host names is needed along with the list of IP Addresses. A valid iDash Client machine has to pass both the checks.

Security Model

THE ADMIN TOOL 91

4.4.3. iDash CLI Authentication

it has been enabled here.

You can provide multiple lists of valid host names and you can use wildcards for any values. For example, ukp* usp* usfinm1 If the host name of an iXp Client machine matches any of the specified host name lists, it will pass the host name check.

By default, the iDash Client CLI is not enabled. Users can install the CLI, but will not be able to use the commands until

Security Model

When you enableas you did for the

t ave to specify the same authentication fields G I, if you chose the Single Sign-On option for the GUI.

For the CLI, there authentication. If you chose the Sielect to follow the values specified for the GUI authentication. In that case, the CLI has to be laun to be launched by us ified for the GUI. If you do not want to follow the same settings as the GUI, then you have to specify the list of valid IP Addresses, Host names, and Domains. The same options exist here I. Please refer to Sec tion. Once the user authentication has been setup, you now have to setup uthorizations for e ch valid user. Without valid authorization policies,

4.4.4.

s the audited information for

GUI or the

be seen in this tab of

he CLI, you hU

is no option to choose iDash User/Password based

ngle Sign-On authentication option for the GUI, you can

ched from machines that are valid for the GUI and has ers authenticated to the same Domains and hosts spec

as they do for the GU

tion 5.4 Security Model for more informa

a ausers will not be able to launch the GUI or CLI, even after successful authentication.

Audit Trails

Select the Audit tab in the Admin Tool to acceseach user.

iDash keeps track of certain activities performed within the iDash iDash Admin Tool. The audit trail of such activities can the Admin Tool.


Security Model

Audit Functions Description

Choose to display all the audited activities for the last N days.

Refresh the displayed audit trail to show the latest information.

Click on this button to create a file with comma separated values of the displayed audit trail.

Click on this button to create an HTML file of the displayed audit trail.

Print the Audit report.

Display Audit information for a specific user.

If a user performs any of the following activities in the Admin Tool, the audit trail will include them.

Logs on to the Admin Tool Creates, Updates, or Deletes an iDash user definition Updates the iDash Server information Creates, Updates, or Deletes information for a CA Workload

Automation AE Instance Creates, Updates, or Deletes an iDash User Command Creates, or Updates the Message of the Day Creates, Updates, or Deletes a Filter definition

THE ADMIN TOOL 93

Security Model

If a user performs any of the following activities in the iDtrail will include them.

ash GUI, the audit

Creates, Updates, or Deletes a Filter definition

gs Executes a User command successfully Acknowledges or Closes an Alarm successfully Changes the Password

Audit Attribute Description

Logs on to the iDash GUI

Issues any sendevent successfully Updates the user preferences Saves the Session settin

Time The time of the activity.

User The User that performed the activity.

Type The Type of activity performed. This is an internal iDash classification mechanism.

Action The performed activity.

Detail The details of the actual activity performed.

You can sort by any of the above columns by clicking on the column header.


Users and Permissions

4.

and Permissions areas.

tion,

5. Users and Permissions Select the User section to access the Users Once users pass the Authentication tests, as defined in the previous secthey can launch the iDash Client GUI only if they have been setup here with at least one authorization policy.

If you have chosen the iDash Use entication model, you have to create us and create author s

r and Password Auther names and pization policie

asswords in this tab, define the user type,for them.

THE ADMIN TOOL 95


If you chosen t Sig el, you just have to define the user type, and create authorization policies for valid users. If a user does not have an authorization policy created here, he/she will be unable to launch the iDash GUI r the i There are three types of us“ s iv s

have he Single n-On Authentication mod

and/o Dash CLI.

ers in iDash: Users with “ without that pr

Admin” privileges, ilege, and “Temporary” users. Regular” user Only user

with “Admin” privilege can access the Admin Tool and perform security functions.

4.5

UI. The upplied user credentials are passed to the iDash Daemon for authentication.

ntication model chosen.

4.5

g on

etting value of global variables, issuing non-job related Alarms). In iDash, the authorizations are based upon the privileges in three categories: Jobs, Alarms, and User Commands.

Category Privileges

Authorizations

.1. Authentication

The iDash Client requires a user logon before it retrieves CA Workload Automation AE data from the iDash Server and displays it on the GsThe credentials required depend upon the Authe .2. Authorization

Each user can be assigned a different level of authorization, dependintheir roles and responsibilities. By default, each iDash user gets created as a“read-only” user and is allowed to issue non-job related sendevents (e.g. s

Jobs

Job Read - View job definitions, job run details and history, job alarms, job-related global variables - Generate reports on jobs - View job definition, one-time overrides - Access SLAs for these jobs.

Job Control Issue sendevents for jobs.

Alarms

Job Alarm Close

Close CA Workload Automation AE Alarms associated with jobs

Job Alarm Acknowledge

Acknowledge CA Workload Automation AE Alarms associated with jobs

Instance Alarm Close

Close CA Workload Automation AE Alarms associated with CA Workload Automation AE software components

Instance Alarm Acknowledge

Acknowledge CA Workload Automation AE Alarms associated with CA Workload Automation AE software components.



User Execute Execute User Commands Command

Dashboard View View any or all of the available dashboard

areas.

Manage SLAs Create/Modify Create, modify, or delete SLA definitions for

Jobs that match Job Read privilege.

For each privilege in the Jobs and Alarms category, the user will be allocated a list of jobs. These lists are called “Filters” in iDash. The iDash Administrator can assign any of the out-of-the-box filters provided with iDash or create new filters and assign them. For each privilege, users will be able to act on only those jobs that pass through the filters assigned for that privilege.

4.5.3. Using Filters for Security

Filters are used to create authorizations for users. Only the filters created by users with “Admin” privileges and the filters provided standard with iDash can be used for this purpose. Each of the user created filters can include wildcards for any of the fields. The iDash Daemon dynamically generates a list of jobs based upon the values assigned to each field in the filter definition.

THE ADMIN TOOL 97


s, go to Edit►Edit Filters to launch the Filter Editor. To create new filter

To create a new Filter, go to File►New and enter the name of the new filter. You can also copy an existing filter; change some of its properties, and save it nder a new name.

he following table describes all the fields, each on its own sub-tab, that can

filter d

Fi e

u

Tbe used for a efinition.

lter Attribut Description

Description A text description for the filter being created. E

Job Name for delimiting instances. “Job_A” is equivalent to “Job_A^*”.

ach list entry can be a job_name like “Job_A” or a wildcard expression like “Job_A*”. Note that "^" is a special character

Box Name rn all Box

Jobs that match the name expressions AND

Each list entry can be the name of a Box Job. The name supports wildcard expressions. The filter will retu

all the jobs within them, including other box jobs.



Owner the filter. Entries may be a string like “root@pluto” or wildcard expression like “root@*”.

Only jobs with owner that match these expressions will pass a

Instance ACE”, or

wildcard expressions like “A*”.

CA Workload Automation AE instance names, like “

Box Level nested) will “child

Box Level is the maximum number of box levels that will satisfy the filter. All jobs ox level (more deeply

re

at a higher bbe excluded. E.g. At level 1, the box and its

n” will be included, but not “grandchild” boxes.

Defined Machine

Each lisexpress st one maof the fi

t entry can be a string like “pluto” or a wildcard ion like “jup. A job satisfies the filter if it has at leachine in its JIL "machine:" definition that matches any lter's wildcard expressions.

Exclusion

Each list entry can be a job_name like “Job_A” or a wildcard express d here orthe filte

ion like “Job_A*”. Jobs that match the names liste are within a Box job listed here will not pass through r.

If any o the fil s will be ignored when passing jobs thrfield is bla

Each filter also has some “ at the bottom of the Filter Editor dialog. These are for information only and cannot be changed

f the fields in ter definition are left blank, those fieldough the filter. So, for example, if the Job Name

nk, all job names will pass through the filter.

informational” check boxes shown

by the user creating the filter.

tion Check Box Descrip

Read Only dicate

cannot

In s this filter is not owned by the current user and/or be modified.

Needs Post Indicatesaved t

s that filter configuration changes have not yet been o the iDash Daemon. Use File/Save to save the filter.

Aft er athe the er in the list of filters available fo

er creating a new filt bottom right part of

nd saving it, click on the “Reload Filters” button at User tab. This will import the newly created filtr assignment to privileges.

THE ADMIN TOOL 99


4.5sts all the fields available for an iDash username.

.4. User Fields The following table li

User ID Field Description

The iDash username. Th be entered at the iDash Client logon prom

is is what will pt.

User Name

Pas The psword / Re-enter assword for the iDash username. This is requred only if the GUI authentication is set to iDash User/Password.Passwords must be at-least 8

cters in length and must contain at-least one charanumerical character and one special character. A password supplied here is temporary, and users will be force .

d to change the password at the next login

Auto PWD Use t if you would like iDash to create a temporary password. The temporary password will be showand c

his button

n in a pop-up dialog. You can highlight the text opy it using standard copy-and-paste operation.

Description The text description f

or the username.

Email Address Youuse

can use this to store any characteristics of the r, for example the email address.

Account Type An iDash user can be of the following types: Regular, Admin, or Temporary. Click on the Edit button to set the

to access the available here.

Account type. An Admin user will be ableAdmin Tool and perform all the functionsA Temporary user will be like a Regular user, except that the userid will no longer be useable after the account expiration date has been reached.

Account Status Indicates whether the account is Active or Suspended. If an account is Suspended, it cannot be used for launching the iDash Client or the Admin Tool. To Suspend an account, click on Edit and set the status to Suspended. To re-activate a Suspended account, click

tus to Active. on Edit and set the sta

Account Expiration The number of days after whuserid will not be useable. Admins can re-activate

ich the selected Temporary

is Expired accounts by changing the Expiration Date. Thfield is available only for Temporary accounts.



To set the above fields, click on the “Save” button after creating/modifying each user account. The following table lists the informational fields shown for the selected userthe Recent Activity tab.

Informational Field

in

Description

Account Created The Date and time when an account was created

.

Account Modified The Date and time when an account was modified, either by an Admin or by the iDash Daemon.

Account Suspended The Date and time when an account was Suspended, either by an Admin or by the iDash Daemon.

Password Modified The Date and time when the password was last modified, either by an Admin or by the user.

Last Login The Date and time of the last login by the user.

4.5.5 Create New User

1) Click the New User icon . 2) Type in the new User Name in the input box, and click OK.

) d

e

indows). 4) Enter a Description of the user, if desired. 5) Enter an Email Address for the user, if desired. 6) By default, the user type is set to “Regular”. If you wish to assign iDash

Administrator privileges to this user, click on the Edit button and select

3 Enter the new user Password, and re-enter for verification. This passworwill be temporary only. The user will be forced to change the password atthe time of initial login. If you would like iDash to create a temporary

assword, click on “Auto PWD” button next to the password field. Thptemporary password will be shown in a pop-up dialog. You can select the text of the password and copy it using standard OS text copy-and-paste buttons (e.g. Ctrl-C on W

THE ADMIN TOOL 101


“Admin” as account type. If the user id is a temporary id, click on the Edit

button and select “Temporary” as account type.

7) If the User is of the type “Temporary”, then click on the Edit button for Account Expiration and assign the number of days for which the user login will be valid. The default is one week.

8) Assign the Security Lists for this user. For the Jobs and Alarm category,

you can assign more than one filter for each privilege. Select the desired filters in the “Filters NOT Included” area and add them to the “Filters Included” area. If you do not have a filter that allows the desired jobs, go to Edit►Edit Filters to launch the Filter Editor, and create and save the desired filter.

Click on the “Reload Filters” icon after you have saved the new filter. The new filter can now be seen in the “Filters NOT Included” area. Select the filter and add it to the “Filters Included” area.

When multiple filters arecategory, the user shall

assigned to any privilege in the Jobs or Alarms be authorized with that privilege on the resulting

ard areas that should be visible for the user.

aggregated set of jobs from the combination of the assigned filters.

9) Click on the Dashboard tab and select the dashbo



0) Click on the SLAs tab to specify if the user is authorized to manage Click on the SLAs tab to specify if the user is authorized to manage

1the SLAs (create, modify, or delete) pertaining to the jobs that match the Job Read privilege. the SLAs (create, modify, or delete) pertaining to the jobs that match the Job Read privilege.

11) Click on the Save icon 11) Click on the Save icon to save the new user definition. Now the iDash GUI.

ou can use the Copy User icon

saved user can logon to the

4. .6. 5 Copy User Y to create a clone of the selected user’s Security Lists and the properties defined in the ID box. Adjust the password and other identity and security properties as needed.

4.5.7 Edit User

1) Select the user from the User Name drill-down list.

2) Follow steps 3-9 of Create a New User.

THE ADMIN TOOL 103


4.5

er from the User Name drill-down list and click

n the Remove icon

.8. Remove User To remove a user, select the us

o .

4.5.9. Undo Changes While working with a user information, you can undo any changes you have

made prior to a Save or Delete by clicking on this icon .

4.5.10. Reload Filters The “Reload Filters” icon reloads the list of filters available for assigning user privileges. This can be used to re et the list of security access filters.

his is helpful when another iDash Administrator is creating filters while your dmin Tool session is active.

4.5.11. idashAdm User

he security settings for the idashAdm user cannot be changed. This user id represents the iDash “Administrator.” The password for this user can be changed from this screen.

4.5.12. iDash Passwords iDash passwords must be at least 8 characters long and must have:

One or more characters One or more number One or more special characters

sTA

T



Acceptable special characters are: ~!@#$%^&*()_-+={}|[]:;”'<>?/\,.

THE ADMIN TOOL 105

CA Workload Automation AE Terms

5. GLOSSARY

5. W d Automa

rm See also CA Wo ui

1. CA orkloa tion AETe s

rkload Automation AE User G de Alarm: Alarms opesituations requir B AE job th at are “contained” in th Global Variable lobal Variables are us latio hips. J a r to the CA

are special events that notifying attention.

rations personnel of

ox Job: A CA Workload Automation at spawns other jobs the Box Job.

: Set by the sendevent SET_ed to create dependency re

GLOBAL commands, Gns

IL: Job Inform tion Language. Refe Workload Automation AE User Guide. J A job is th whic ycle is built. A CA Workload AE job is any single command or executable, U shell scrip or job definition contains qualifying attributes, including conditions for when and where a job should be run. Command Jobs execute commands, Box Jobs are containers, which hold other jobs, and File Watcher Jobs watch for the arrival of a specified file. Job Name: The job name is used to identify the job to CA Workload Automation AE, and must be unique within CA Workload Automation AE. It can be from 1 to 30 alphanumeric characters, and is terminated with white space. Embedded blanks and tabs are illegal. JOID: Job ID (see CA Workload Automation AE Reference Guide

ob: e basic building block upon h an operations cAutomation

NIX t, or NT batch file. Each CA W kload Automation AE

). sendevent: A CA Workload Automation AE command to activate the Event Processor.


Symbols in this Guide

5.2. Symbols in this Guide

Symbol or type style

Represents Example

Bold A new term. The console is the upper right window in iDash.

Alternate color or to the internet.

e http://java.sun.com for further information.

Hyperlinks to other sections, Se

Italic Words that are emphasized, Dismiss the wand blue italic for hyperlinks.

indow after finalizing your changes.

Underlined Italic for titles of other documents.

CA Workload Automation AE User Guide

Syntax variables. COPY filename Monospace Directories, file names,

command names, computer code.

&HIGHLVL.SRCLIB

Computer screen text, system responses, command line commands.

Copy file? Y/N

Monospace bold

What a user types. ...enter RUN APP.EXE in the Application field.

< > The name of a key on the Keyboard.

Press <Enter>.

► Choosing a command from a menu.

Edit ► Preferences.

GLOSSARY 107

Related Documents


5.3. Related Documents

UCA Workload Automation AE User Guide UCA Workload Automation AE Windows Implementation Guide UCA Workload Automation AE Reference Guide UCA Workload Automation AE UNIX Implementation Guide UiDash Release Notes UiDash User Guide