CA Workload Automation idash. User Guide Release

Transcription

1 CA Workload Automation idash User Guide Release

2 This Documentation, which includes embedded help systems and electronically distributed materials, (hereinafter referred to as the Documentation ) is for your informational purposes only and is subject to change or withdrawal by CA at any time. This Documentation 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 , , and (c)(1) - (2) and DFARS Section (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.

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

4 TABLE OF CONTENTS 1. INTRODUCTION SLA Definitions SLA Overview SLA Status Critical Path Monitoring Critical JobList Critical Path ARCHITECTURE Component Description idash Daemon idash Database idash Client High Availability CLIENT INTERFACE Opening the GUI Java Web Start Web Browser idash Passwords The GUI Views The Dashboard Health Gauges SLA Performance Gauge Critical Path Performance CA Workload Automation AE Performance Charts and Meters SLA Performance Charts Critical Path Meters CA Workload Automation AE Performance Charts Dashboard Controls Show/Hide Graphs and Charts Show/Hide Console and Tree Views View CA Workload Automation AE Performance Graphs View Dashboard Help The Tree View Tree Layout Tree Icon Indicators Create Custom Views Creating New Views The SLA Console SLA Console Details Critical Ratio SLA Console Columns Critical Path Monitor... 44

5 Table View Columns Time View Job Flow View VIEW TOOLS SLA Console Tools Refresh Print Sort View HTML Save CSV or XLS View PDF View PDF Summary Critical Path Monitor SLA Detail Summary Description Long Running Globals Machines SLA Definition Job Detail Last Run Dependencies Globals Machines Date - Time Latency Average Runtime Job Definition Run Data Help Icon Right-Click Critical Path Monitor Tools Save as SVG Rotate Layout View Real-time View Gantt Chart Distill Critical Path View Critical Path Job Definition Job Detail Run Data User Command Right-Click Alarm Manager idash REPORTS CA Workload Automation AE Archive Reports TABLE OF CONTENTS 5

6 Job Runs Reports Event Reports Autotrack Reports Saving Report Output CA Workload Automation AE Real-Time Reports Job Status Reports idash SLA Reports SLA Reports SLA Trend Report Critical JobList Report Single Job Report Other Reports Server Statistics Report idash CLIENT CLI Installation Commands idarchive idgenpdf, idgenhtm, idgencsv, idgenxls idjobid idlist idupdate iddelete idgantt idaverage GLOSSARY CA Workload Automation AE Terms Symbols in this Guide Alternate color Italic Related Documents

7 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 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 has to end in a SUCCESS status. The entire job stream has to complete successfully by a particular time. A job within the job stream has to start by a particular time. A job or a set of jobs within a job stream has to start and finish by a particular date and time. CA Workload Automation 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 automated recovery actions. This guide assumes familiarity with CA Workload Automation AE. Companion to this CA Workload Automation idash User Guide is the CA Workload Automation idash Administration Guide. INTRODUCTION 7

8 SLA Definitions 1.1. SLA Definitions 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 believes 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 has to start. The schedule and time(s) by which the job has to finish successfully. The schedule and time(s) by which the job has to start and finish successfully. For example, Box job EuropeDailyBox has to finish successfully by 7:15am every Monday, Tuesday, and Wednesday. Command job SectorDaily_Chips_upload has to start by 8:00pm every day in CA Workload Automation AE calendar WORKDAYS, and finish successfully by 02:00am the next day. File watcher job WebMD_daily_report_fw has to finish successfully by 7:00am, 12:00pm, and 5:15pm every day in CA Workload Automation AE calendar WORKDAYS, excluding days in calendar NOFILES. If a job has multiple times that it needs to start by 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 lets users take appropriate actions to prevent SLA violations. INTRODUCTION 8

9 For example, Box job EuropeDailyBox has to finish successfully by 7:15am every Monday, Tuesday, and Wednesday. This SLA definition is assigned a risk window of 30 minutes, which means the risk window is from 6:45am to 7:15am. If idash forecasts that EuropeDailyBox will finish at, say 7:00am, it will send an alert indicating that the SLA deadline will be met, but it will be within the risk window 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 ON_TIME MET AT_RISK Description idash forecasts that the job will do better than or meet the defined SLA deadline. This is the desired status for all upcoming SLAs. The SLA deadline has been met successfully. This is the desired status for all historical SLAs. idash forecasts that the job will do better than or meet the defined SLA deadline, but it will be within the risk window. This status just means that while the SLA is predicted to be MET, the time of SLA completion is too close to the SLA deadline. PREDICTED_MISS idash forecasts that the job will miss it's SLA deadline. SLAs in this status will end up missing their deadline unless the condition that is causing this status is remedied. MISSED FUTURE ERROR UNKNOWN The SLA deadline was missed. idash has not started the forecast for this SLA. The SLA definition is not correct and has an error. The idash forecasting function is unable to predict the status of the SLA deadline. INTRODUCTION 9

10 Critical Path Monitoring 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 Critical Path Monitoring idash provides the capability to monitor the Critical Path of the CA Workload Automation AE job that has an 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 Critical JobList The 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 jobs. The arrows indicate dependencies between the jobs. Figure 1.1: A Sample Job Stream INTRODUCTION 10

11 The following diagrams highlight the Critical JobList for the selected job(s): Figure 1.2: Critical JobList for job JOB-E Figure 1.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 is as follows: 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. INTRODUCTION 11

12 Critical Path Monitoring Figure 1.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 Critical Path idash dynamically generates the Critical Path of each SLA job by evaluating the following items 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) INTRODUCTION 12

13 The idash Critical Path can be defined as follows: Critical Path of an 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 on 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 jobs. The arrows indicate dependencies between the jobs. The average run times for each job are also listed. JOB-A 10 minutes JOB-C 10 minutes JOB-B 20 minutes JOB-D 5 minutes JOB-E 10 minutes Figure 1.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. INTRODUCTION 13

14 Critical Path Monitoring Processing Time Left: JOB-A 10 minutes JOB-C 10 minutes Processing Time Left: 30 mins. JOB-B JOB-D 15 mins. 20 minutes 5 minutes JOB-E 10 minutes Figure 1.6a: 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. Processing Time Left: JOB-A Finished JOB-C 10 minutes Processing Time Left: 14 mins. JOB-B JOB-D 15 mins. 14 minutes left 5 minutes JOB-E 10 minutes Figure 1.6b: 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. INTRODUCTION 14

15 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 or ON_NOEXEC 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. INTRODUCTION 15

16 Critical Path Monitoring 2. ARCHITECTURE ACE PRD DEV CA Workload Automation AE Instances idash DB/Cache idash Daemon idash Server Machine idash Clients ARCHITECTURE ELEMENT idash Daemon idash Database idash Client DESCRIPTION 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). 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 for analysis and reporting. The idash Client is the Java TM -based GUI that can be opened on any Java-supported system, and the CLI that can be opened on any supported system. The GUI provides the capability to monitor, report, forecast, ARCHITECTURE 16

17 ARCHITECTURE ELEMENT DESCRIPTION control the SLA thresholds and the Critical Path jobs across the CA Workload Automation AE instances. Because the client is a Java Web Start application, there is no software installation required on the machine that will open the client. The CLI provides the capability to perform certain Administration functions, and to generate idash reports from the command line Component Description idash Daemon This is the only persistent process in the idash system. This process is installed on a Web Application Server that can provide access to the different CA Workload Automation AE instance repositories. The idash Daemon is a multi-threaded Java process that is performs the following functions: Reads and loads relevant job definition information across all configured CA Workload Automation AE instances. Monitors relevant job runs, their statuses, and CA Workload Automation AE events. Generates real-time forecast 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 database with all relevant information about CA Workload Automation AE jobs, SLA statuses, forecasts, and so on. 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, if needed. Generates customized reports for historical and forecasted behavior of SLA jobs and their Critical Path. Runs the SOAP-based Web Service that accepts certain queries and provides responses in XML. ARCHITECTURE 17

18 Component Description idash Database The idash database is needed by the idash Daemon to store certain information. An existing database has to be used for this component, as idash does not provide a bundled database. All current versions of Oracle, Sybase, and 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, and audit. 2) CA Workload Automation AE historical data including job runs, and performance statistics idash Client The idash Client GUI is the Java TM -based graphical interface that can be opened on any Windows or Linux systems. 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 Web Start application, there is no software installation required on the machine that will open the client. The idash Client CLI is a set a commands that can be deployed to any supported system. These commands let users perform certain Administration functions (e.g. manage SLA definitions, load CA Workload Automation AE archive files, and generate idash reports in PDF, HTML, CSV, and XLS formats). ARCHITECTURE 18

19 2.2. High Availability idash can be configured to run in an Active/Active HA mode. You can set up idash with two servers running the daemon process on each, 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 must have the following hardware and software available: 1. Two machines, which will be set up as Primary and Secondary idash Daemons respectively. 2. Two databases, which will be set up as Primary and Secondary idash databases respectively. When you set up 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 both 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. ARCHITECTURE 19

20 Opening the GUI 3. CLIENT INTERFACE 3.1. Opening the GUI To open the idash client, you need Java Runtime Environment (JRE) v1.6 or JRE v1.7 installed on your local machine. You can use the Java-provided utility - Java Web Start to open the GUI or use a web browser to do the same Java Web Start If you start the GUI for the first time, run the following command in a command/shell window: javaws where MACHINE = The name of the idash Server machine PORT = The web server port number (e.g. 8080) For example: javaws You will be prompted with a Security Warning. Click Always to continue opening the client. The first time you open the application, Java Web Start has to 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 open an application through Java Web Start or when software upgrades occur. Once loaded you should see the login prompt. If the idash site is configured with Single Sign-On security, you will see your Windows Domain/OS authentication in the login screen. You just have to click the Login button. If the site is configured with idash user/password model, you have to enter a known idash login ID and password. CLIENT INTERFACE 20

21 We recommend that you create a shortcut on your desktop to open Java Web Start. When you use Java Web Start for the first time, it prompts you to do that. After doing so, subsequent opening of idash can be done by using the desktop shortcut. You can also create a shortcut by opening the Java Application Cache Viewer, right-clicking the CA Workload Automation idash application, and selecting Install Shortcuts. To open the viewer, just run the command javaws -viewer. CLIENT INTERFACE 21

22 Opening the GUI Web Browser Type the following URL in the browser address bar: Click the idash Application link to open the GUI idash Passwords If required to set a password, idash passwords must be at least 8 characters long and must have: One or more alpha characters One or more numeric characters One or more special (non-alphanumeric) characters The acceptable special characters are as follows: ~!@#$%^&*()_-+={} []:; '<>?/\,. CLIENT INTERFACE 22

23 3.2. The GUI Views The main interface is divided into three views: Dashboard, Tree View, and SLA Console. Dashboard Tree View SLA Console The Dashboard is divided into two sections: Health Gauges and Detailed Charts. The SLA Console shows the details for the selected list of SLAs. The Tree View shares context with the SLA Console. If you click an SLA in either view, the other will show the selected SLA. CLIENT INTERFACE 23

24 The Dashboard 3.3. The Dashboard The Dashboard provides at-a-glance information about the health of upcoming SLAs, the Critical Path jobs for all SLAs, and the health of the CA Workload Automation AE environment Health Gauges The Health Gauges in the Dashboard provide summarized information about upcoming SLAs, Critical Path Jobs, and CA Workload Automation AE server performance. Each gauge has three settings: Low, Medium, and High. The colors Green, Yellow, and Red are used for each setting. The current setting for each gauge depends on the health of the object being monitored SLA Performance Gauge This gauge shows the health of upcoming SLAs across all the configured CA Workload Automation AE instances. idash monitors all the CA Workload Automation AE instances in real-time, generates a forecast for the job processes, and projects the performance of upcoming SLAs based on the forecast. The forecast is performed for all SLAs that have a deadline in the next X hours, where X hours is a parameter setting in idash. The default value is 24 hours. This gauge has icon indicators that turn on when specific conditions occur to upcoming SLAs. These indicators automatically turn off when those conditions go away. CLIENT INTERFACE 24

25 The following table provides details on how the current value of the SLA Performance gauge is set and when does each indicator turn on and off: Gauge Value/Indicator Description The Gauge needle points to High when one or more upcoming SLAs are predicted to miss their deadlines. Such SLAs will have the status "PREDICTED_MISS" in the SLA Console. When there are no upcoming SLAs in "PREDICTED_MISS" status, the gauge needle will reset. The Gauge needle points to Medium when one or more upcoming SLAs are at risk of missing their SLA deadlines. Such SLAs will have the status "AT_RISK" in the SLA Console. This means the SLAs are predicted to meet their deadline, but within their defined risk window. No upcoming SLAs are predicted to miss their deadline. The Gauge needle will reset when there are no upcoming SLAs in "AT_RISK" status, or when the Gauge needle points to High due to SLAs in "PREDICTED_MISS" status. The Gauge needle points to Low when all of the upcoming SLAs are expected to meet their SLA deadlines, and none are at risk. All upcoming SLAs will have the status "ON_TIME" in the SLA Console. This indicator comes ON one or more upcoming SLAs are predicted to miss their SLA deadlines. Such SLAs will show the status "PREDICTED_MISS" in the SLA Console. This indicator turns OFF when there are no upcoming SLAs in "PREDICTED_MISS" status. This indicator comes ON to show that one or more upcoming SLAs are at risk of missing their SLA deadlines. Such SLAs will show the status "AT RISK" in the SLA Console. The indicator turns OFF when none of the upcoming SLAs have "AT_RISK" status. CLIENT INTERFACE 25

26 The Dashboard Gauge Value/Indicator Description This indicator comes ON when one or more upcoming SLAs have a down-trending Critical Ratio. The trend for any SLA is derived from the Critical Ratio sampled over 5 consecutive refreshes. If the last value sampled is lower than the first value, then the SLA is said to be trending down. The indicator turns OFF when none of the upcoming SLAs have a downtrending Critical Ratio. This indicator comes ON when one or more SLA related alarms are in "Open" status that meets the idash Alarm policy. The indicator turns OFF when there are no SLA-related alarms in "Open" state (i.e. all SLA-related Alarms are in "Acknowledged" or "Closed" state). You can view the above table in the GUI also, by clicking the Help icon on the Dashboard Critical Path Performance This gauge shows the health of the Critical Path jobs derived across all SLAs. idash automatically generates the list of Critical Path jobs for each defined SLA. The health of those jobs is determined by the current status of each job, CA Workload Automation AE Alarms on any job, and duration of running jobs. This gauge has icon indicators that turn on when specific conditions occur to Critical Path jobs. These indicators automatically turn off when those conditions go away. CLIENT INTERFACE 26

27 The following table provides details on how the current value of the Critical Path Performance gauge is set and when does each indicator turn on and off: Gauge Value/Indicator Description The Gauge needle points to High when either of the following cases has occurred: 1. Across all upcoming SLAs, at least one Critical Path job is in a FAILURE or TERMINATED status. 2. Across all upcoming SLAs, at least one Critical Path job has a CA Workload Automation AE Alarm in Open state and that Alarm meets the idash Alarm policy. The Gauge needle will reset when no Critical Path job satisfies any of the above criteria. The Gauge needle points to Medium when, across all upcoming SLAs, at least one Critical Path job is currently running at more than 120% of its average runtime and is 2 minutes over its average runtime. Once that job is finished and no other running Critical Path jobs meet this criteria, the Gauge needle will reset. The Gauge needle points to Low when Critical Path jobs across all upcoming SLAs are running within their average runtime, there are no jobs in FAILURE or TERMINATED status, and there are no "Open" CA Workload Automation AE alarms. This indicator comes ON when, across all upcoming SLAs, one or more Critical Path jobs are in ON_HOLD status. This indicator turns OFF when there none of the Critical Path jobs are in ON_HOLD status. CLIENT INTERFACE 27

28 The Dashboard Gauge Value/Indicator Description This indicator comes ON when, across all upcoming SLAs, at least one Critical Path job is currently running at more than 120% of its average runtime and is at least 2 minutes over its average runtime. This indicator turns OFF when no other running Critical Path jobs meet this criteria. This indicator comes ON when, across all upcoming SLAs, at least one Critical Path job is in a FAILURE or TERMINATED status. This indicator turns OFF when no Critical Path jobs meet this criteria. This indicator comes ON when, across all upcoming SLAs, at least one Critical Path job has an alarm in "Open" state that meets the idash Alarm policy. This indicator turns OFF when there are no Critical Path jobs related alarms in "Open" state (i.e. all Critical Path jobs related alarms are in "Acknowledged" or "Closed" state). You can view the above table in the GUI also, by clicking the Help icon on the Dashboard CA Workload Automation AE Performance This gauge shows the health of the Scheduler process across the entire CA Workload Automation AE environment. idash periodically calculates the scheduling latency for each CA Workload Automation AE instance. The value of this gauge is set depending on the highest latency value across all instances. This gauge has icon indicators that turn on when specific conditions occur to the CA Workload Automation AE components across all instances. These indicators automatically turn off when those conditions go away. CLIENT INTERFACE 28

29 The following table provides details on how the current value of the CA Workload Automation AE performance gauge is set and when does each indicator turn on and off: Gauge Value/Indicator Description The Gauge needle points to High when any of the configured CA Workload Automation AE instances is experiencing a high scheduling latency. The default setting for high latency is 60 seconds. The latency data is averaged across all events processed every 60 seconds. The Gauge needle will reset once there are no instances with high latency over the last 5 minutes. The Gauge needle points to Medium when any of the configured CA Workload Automation AE instances is experiencing a medium scheduling latency. The default setting for medium latency is 30 seconds. The latency data is averaged across all events processed every 60 seconds. The Gauge needle will reset once there are no instances with medium latency over the last 5 minutes. The Gauge needle points to Low when none of the CA Workload Automation AE instances are experiencing latency higher than the medium threshold. The default setting for medium threshold is 30 seconds. This indicator comes ON when there is at least one CA Workload Automation AE instance that has an "Open" alarm related to the Event Server. The list of alarms that turns this indicator ON is as follows: DB_PROBLEM, DATABASE_COMM, and DB_ROLLOVER. The indicator turns OFF when there are no "Open" alarms in any instance for the previously listed alarms. CLIENT INTERFACE 29

30 The Dashboard Gauge Value/Indicator Description This indicator comes ON when there is at least one CA Workload Automation AE instance that has an "Open" alarm related to the server components. The list of alarms that turn this indicator ON is as follows: APP_SERVER_SHUTDOWN, EP_SHUTDOWN, EP_ROLLOVER, and MULTIPLE_EP_SHUTDOWN. The indicator turns OFF when there are no "Open" alarms in any instance for the previously listed alarms. This indicator comes ON when there is at least one CA Workload Automation AE instance that has an "Open" EP_HIGH_AVAIL alarm. The indicator turns OFF when there are no "Open" alarms in any CA Workload Automation AE instance for the previously listed alarm. This indicator comes ON when there is at least one CA Workload Automation AE instance that has an "Open" alarm related to the CA Workload Automation AE components, with the exception of those alarms that turn ON the previously listed indicators. Any alarm that is not related to jobs, and not related to the alarms for the previously listed indicators will turn this indicator ON. The indicator turns OFF when there are no such "Open" alarms. You can view the above table in the GUI also, by clicking the Help icon on the Dashboard Charts and Meters The Dashboard provides some charts and meters that show real-time values for upcoming SLAs, Critical Path jobs, and CA Workload Automation AE instances. To see details of each chart and meter, move your mouse over it and a popup will show the values for each category. CLIENT INTERFACE 30

31 SLA Performance Charts There are two SLA Charts in the Dashboard. One shows the status distribution of all upcoming SLAs and the other shows the status distribution of all SLAs whose deadlines expired in the last 24 hours. The following table provides details about the values shown in the charts: Charts and Meters Description This chart shows the current status of all upcoming SLAs. The chart is divided into three sections: SLAs that are ON_TIME, AT_RISK, and PREDICTED_MISS. If you move your mouse over this chart, the flyover text shows the actual number of SLAs for each status. This chart shows the performance of all the SLAs that were completed in the last 24 hours. The chart is divided into two sections: SLAs that were MET, and SLAs that were MISSED. If you move your mouse over this chart, the flyover text shows the actual number of SLAs for each status Critical Path Meters There are two Critical Path Meters in the Dashboard. One shows the current percentage status distribution of the Critical Path jobs across all upcoming SLAs and the other shows a moving graph of Critical Path jobs in Waiting and Running status. Both the meters are based on the current status of the jobs across all instances. CLIENT INTERFACE 31

32 The Dashboard The following table provides details about the values shown in the meters: Charts and Meters Description This meter shows the percentage distribution of all Critical Path jobs, based on their current job status. The jobs are divided into four categories: SUCCESS, WAITING, ERROR, and RUNNING. Jobs in SUCCESS, ON_ICE, and INACTIVE status go under the SUCCESS category. Jobs in ACTIVATED, ON_HOLD, and QUE_WAIT status go under the WAITING category. Jobs in FAILURE and TERMINATED status go under the ERROR category. Jobs in STARTING, RUNNING, and RESTART go under the RUNNING category. This meter shows a moving graph of all Critical Path jobs that are in the RUNNING and WAITING categories. The bottom highlighted portion of the graph is for RUNNING jobs, and the upper shaded portion of the graph is for WAITING jobs CA Workload Automation AE Performance Charts There are two graphs that show real-time performance statistics of all CA Workload Automation AE instances (up to 3 instances). One shows a bar chart of real-time scheduling latency for each instance. The other shows a bar chart of real-time event throughput for each instance. CLIENT INTERFACE 32

33 The following table provides details about the values shown in the charts: Charts and Meters What does it show? This chart shows the per minute scheduling latency values for each configured CA Workload Automation AE instance. For each instance, two values are shown: The highest per minute latency experienced by the instance in the last 6 hours (High value), and the highest per minute latency experienced by the instance in the last 5 minutes (Current Value). The High Value is shown as the shaded bar, and the Current Value is shown by the highlighted bar. This chart shows the number of events processed per minute for each configured CA Workload Automation AE instance. For each instance, two values are shown: The highest number of events processed per minute in the last 6 hours (High Value), and the highest number of events processed per minute in the last 5 minutes (Current Value). The High Value is shown as the shaded bar, and the Current Value is shown by the highlighted bar. CLIENT INTERFACE 33

34 The Dashboard Dashboard Controls The left hand side of the Dashboard provides some icons that provide control over the layout of the client interface and let users open additional graphs and charts Show/Hide Graphs and Charts If you want to collapse the Dashboard so that only the Health Gauges are shown, then click the icon. That will collapse the graphs and charts in the Dashboard. If you want to expand the Dashboard to see the graphs and charts, then click this icon again Show/Hide Console and Tree Views If you want to collapse the client interface so that only the Dashboard is shown, then click the icon. That will collapse the client interface to show only the Dashboard. If you want to expand the client interface to show the Dashboard and the Console and Tree Views, then click this icon again View CA Workload Automation AE Performance Graphs You can view detailed CA Workload Automation AE performance graphs by clicking the icon. That will open a dialog that lets users view, for any CA Workload Automation AE instance, the total scheduling latency per minute, and the number of events processed per minute. Both the graphs show values over the last six hours. You can also export the values for any graph to CLIENT INTERFACE 34

35 a file on your local machine. The data can be exported in CSV or HTML format. The graph and data can be exported to a report in PDF format View Dashboard Help You can open the Dashboard Help dialog by clicking the icon. The Help dialog provides details about how the Health Gauges set their values, when the icon indicators turn on and off, what is the information shown in the graphs and charts. CLIENT INTERFACE 35

36 The Tree View 3.4. The Tree View The Tree View is a tool for navigating through past and upcoming SLAs across all CA Workload Automation AE instances. The view shows every SLA job and lets users find details about any SLA. If you click an SLA in the Tree View, the SLA Console will show additional information about the selected SLA. Current SLAs Custom SLA Views SLA Deadline Tree Layout SLA Job CA Workload Automation AE Instance The Tree lets users navigate through all upcoming and historical SLAs across all CA Workload Automation AE instances. The tree has the following four main branches: Current SLAs, Search, Year, and Instance. CLIENT INTERFACE 36

37 The tree hierarchy for each branch is as follows: Current SLAs -> All Upcoming SLAs & Recently Finished SLAs Search -> All Custom SLA Views -> SLAs for each View Year -> Months -> SLAs for each Month CA Workload Automation AE Instance -> SLA Job -> SLAs for each Job CLIENT INTERFACE 37

38 The Tree View As new SLA jobs are added, additional SLAs are defined, or as time progresses, the Tree will continue to add new branches. The Tree refreshes automatically in real-time. The Current SLAs branch shows all upcoming SLAs that are being predicted by idash, and all SLAs that had their deadline expire in the last 24 hours. SLAs will be moved in and out of this branch as time progresses. The Search branch lists all custom views that you have created. Each view will then show all the SLAs that match the view definition. Each view has a summary status flag next to its name. The summary status flag shows the worst status of any SLA within the view. You can create custom view definitions by clicking the Search icon on the Tree View Toolbar. The Year branch is created for each historical and current year of SLA data being stored in idash. Each year branch then lists all the months for which SLA data exists and each month shows the days for which SLA data exists. Under each day, you will see all the SLAs that had or have deadlines on that day. The CA Workload Automation AE Instance branch is created for each CA Workload Automation AE instance configured in idash. Under each instance, you will see a branch for each Job that has an SLA deadline. Under each SLA job, you will see all the historical and upcoming SLAs for that job. CLIENT INTERFACE 38

39 Tree Icon Indicators Each SLA job, date, and SLA deadline has icons that indicate certain conditions. The following table provides a description of those icon indicators: Tree Object SLA Job Icon Indicator What does it mean? There is a CA Workload Automation AE Alarm in Open state for this SLA job. The alarm meets the idash Alarm policy. Date The current date. All folders previous to this date have historical SLA data, and all folders after this date have future SLA data. SLA Deadline Indicates that this is a Start By deadline for the SLA job. SLA Deadline Indicates that this is an End By deadline for the SLA job. SLA Deadline Indicates this SLA deadline was MET successfully. SLA Deadline Indicates this SLA deadline was MISSED. SLA Deadline Indicates this SLA deadline is AT RISK. SLA Deadline Indicates this SLA deadline is in PREDICTED_MISS state. SLA Deadline Indicates this SLA deadline is ON_TIME and predicted to be MET. When you click an SLA deadline in the Tree View, the SLA Console will highlight that SLA. CLIENT INTERFACE 39

40 The Tree View Create Custom Views You can click the icon to create a list of views that show only those SLAs that match your defined View criteria Creating New Views Click the New icon and enter a name for the View. The dialog to create new Views has a main area and two tabs: Status and Time. You can create Views to show SLAs based on the name of the SLA job, name of a Critical JobList job, or both. When you specify a job name string in the Critical Path job, all SLAs that contain this job in their Critical JobList will be shown when you select the View. CLIENT INTERFACE 40

41 If you want to view SLAs based on their statuses too, then select those statuses in the Status tab. In the Time tab, specify the time range, in days, for the SLAs to be seen. Any upcoming SLA that has its deadline within the time range specified and any historical SLA that had its deadline within the time range specified in the past will be shown in the View. So, for example, if you choose a time parameter of 2 Days, then SLAs that have a deadline in the next 2 Days and SLAs whose deadline expired within the last 2 Days will match the time parameter. Click the Save icon to save the view, and then click Search to go to the View now, or Cancel to just close out the dialog. You can use the Tree View to navigate to any Custom View The SLA Console The SLA Console lets users monitor upcoming SLAs, view detailed information about Critical Path jobs for any SLA, send events for Critical Path jobs, see the Job Flow, generate HTML, CSV, PDF reports, and so on. The SLA Console View shares SLA context with the Tree View. The SLA Console shows real-time information about upcoming and historical SLAs across all CA Workload Automation AE instances. CLIENT INTERFACE 41

42 The SLA Console You can open the Critical Path Monitor, to view the detailed information about the jobs in the Critical JobList for any SLA, by double-clicking any SLA in the SLA Console. The Critical Path Monitor shows forecasted and real-time information for jobs in the Critical JobList for the SLA selected in the SLA Console or the Tree View SLA Console Details The SLA Console shows details about each upcoming SLA within the forecast window and information about historical SLAs. The default sort order for this view lists all upcoming SLAs at the top and historical SLAs after that. The historical SLAs are sorted by their SLA deadline in an ascending order. By default, the upcoming SLAs are sorted according to their Critical Ratio number in an ascending order Critical Ratio The Critical Ratio is an index number for an SLA and is derived by the following formula: Amount of Time Remaining until Deadline / Amount of Time Remaining until Expected Completion. The higher the Critical Ratio, the greater the possibility of meeting the SLA deadline. Critical Ratio is a number that is valid until the SLA has been MET or the SLA deadline has passed. This number assists users in prioritizing problematic SLAs for remedial actions. As time progresses, this value degrades for problematic SLAs, absent any positive actions, and the value improves for ON_TIME SLAs, absent any negative conditions. The following table provides details about possible values in the Critical Ratio column of the SLA Console: Icons Description High Critical Ratio If the Critical Ratio for an SLA is greater than 1.05, then it is considered to be Sunny. This means that the SLA deadline is predicted to be MET, and either the deadline is near, or the time difference between the SLA deadline and the forecasted completion time is high. CLIENT INTERFACE 42

43 Icons Description Tight Critical Ratio If the Critical Ratio for an SLA is greater than 1.0 but less than or equal to 1.05, then it is considered to be Partly Cloudy. This means that the SLA deadline is predicted to be MET, but either the deadline is far in the future or the time difference between the SLA deadline and the forecasted completion time is marginal. Low Critical Ratio If the Critical Ratio for an SLA is less than 1.0, then it is considered to be Overcast. This means that the SLA is predicted to be Missed. The lower the number, the greater the possibility that the SLA will be MISSED. SLA Uptrend If the Critical Ratio for an SLA is noticed to be trending higher, then idash will use this icon to indicate that the SLA is trending up. The SLA will trend up if the forecasted time to completion is holding steady or improving as the SLA deadline comes closer. SLA Downtrend If the Critical Ratio for an SLA is noticed to be trending lower, then idash will use this icon to indicate that the SLA is trending down. The SLA will trend down if the forecasted time to completion is increasing as the SLA deadline comes closer. An SLA that is trending down can be in the danger of being MISSED SLA Console Columns The following table provides details about the columns shown in the SLA Console: Column SLA Job Time Remaining SLA Deadline Description The name of the CA Workload Automation AE job on which the SLA deadline has been assigned. The lower row shows the name of the instance where the job resides. The top value listed in this column shows the time remaining until the SLA deadline. The bottom value is the time remaining until the forecasted completion of the SLA. If the time remaining until the forecasted completion of the SLA is greater than the time remaining until the deadline, then the bottom value is shown in RED. The top value listed in this column shows the actual SLA deadline date and time. The bottom value shows the actual forecasted completion time. If the forecasted completion time of the SLA is past the SLA deadline, then the bottom value is shown in RED. CLIENT INTERFACE 43

44 The SLA Console Status Progress The top value listed in this column shows the current status of the SLA. The bottom value shows the type of SLA: Start By or End By. Section SLA Status lists all the possible statuses for an SLA. This column shows the progress of the SLA in terms of the Critical JobList. This column shows how many jobs from the Critical JobList have finished the processing necessary for the SLA to be met. You can get more details about any SLA from this console by using the Console Toolbar or by right-clicking an SLA. To get more information about the Critical JobList for any SLA, double-click the SLA Critical Path Monitor The Critical Path Monitor shows all the jobs that make up the Critical JobList for the SLA selected in the Console or in the Tree View. This dialog lets users view real-time job run data, forecasted job runs, or a combination of both. Time View Table View Flow View CLIENT INTERFACE 44

45 Table View Columns The following provides details about each column in the Critical Path Monitor: Column Progress Instance, Job Status Start End Duration Next Start Latency Machine Description This column shows two values and a progress bar. The first value shows, in percentage, how much the job has run compared to its average runtime. If the job has run longer than its average runtime, the value will be greater than 100%. If the job has run longer than 120% of its average runtime, the value will be shown in RED. The second value depends on the status of the job. If the job is RUNNING, then the value shown is either the time left until the estimated completion of the job (indicated by the "-" sign), or the time the job has been running longer than its average runtime (indicated by the "+" sign). If the job has completed, then the time shown indicates how much shorter or longer was the duration of the run compared to its average runtime. The progress bar is shown for RUNNING jobs, and it indicates the percentage time elapsed compared to the average runtime. The name of the CA Workload Automation AE instance and job. The current or forecasted status of the CA Workload Automation AE job. If the status = FUTURE, then the status shown by the icon is a forecasted status. The actual last start time of the job or a forecasted start time of the job. If the value in this column has an icon next to it, then it is a forecasted start time. The actual last end time of the job or a forecasted end time of the job. If the value in this column has an icon next to it, then it is a forecasted end time. The actual or forecasted duration of the job run. The next scheduled Start Time of the job, as calculated by CA Workload Automation AE. The time difference between when the CA Workload Automation AE scheduler could have started the job at the earliest, and the time when the job was actually started. This value is shown for actual job runs only. The machine where the job ran. This value is shown for actual job runs only. CLIENT INTERFACE 45

46 The SLA Console Column Next Start Description The next start time of the job, as set by the CA Workload Automation AE scheduler. You can take actions, view details, and so on for one or more jobs in this Monitor by using the Toolbar or by right-clicking a job Time View The Time View shares the same space as the Table View in the Critical Path Monitor. This view provides a live Gantt view of past, current, and predicted runs of all jobs being currently seen. The number of runs in the view is governed by the Past Hours setting of the currently selected SLA. If the SLA has been MET or is still active, then the Time View will show a Gantt chart of all historical runs between the SLA Deadline and the value of the Past Hours setting. If the SLA has been MISSED, then the Time View will show a Gantt chart of all historical runs (and if valid, any current or predicted runs) between the SLA End Tracking and the value of the Past Hours setting. Historical Runs Run duration greater than Average Current and Predicted Runs CLIENT INTERFACE 46

47 As the above screen shows, jobs that are currently running show a sliver of current duration, within an overall depiction of predicted run time. The combination of that view and the Progress column will show the time remaining for that job to complete. Jobs that have run longer than their average runtime, display a striped run. The stripes start after the average run duration has passed. The color of the run displayed is based on the completion status. Job runs that ended in FAILURE or TERMINATED will be shown in red. The SLA Deadline is shown as a vertical green band. If the SLA has an At Risk Warning value, then the Risk Deadline is shown as a vertical yellow band. The Gantt view starts at the time calculated as SLA Deadline Past Hours, and the Gantt view ends at End Tracking value. These values can be specified for each SLA, from the SLA Definition dialog Job Flow View The bottom section of the Critical Path Monitor shows the Job Flow of the Critical JobList. The statuses shown in the Job Flow are either Real-time or Forecasted, depending on the view toggle selection. The current Critical Path for the SLA is highlighted by a bold border around the jobs and the arrows. This Critical Path is automatically changed to a different set of jobs, if needed. CLIENT INTERFACE 47

48 The SLA Console You can double-click a job and drag it to a new position to create the desired layout. The Job Flow shares context with the Table. When you click a job in this view, the Table will also show it and vice-versa. Using the view dividers, you can adjust the size of each view or hide any view. CLIENT INTERFACE 48

49 4. VIEW TOOLS The SLA Console and the Critical Path Monitor provide the capability to perform actions and view detailed information on individual items displayed. You can use the Toolbar or select an item and use the right-click menu SLA Console Tools You can move your mouse over the Toolbar icons to see the associated flyover text. Icon Description Refresh the data from CA Workload Automation AE Print the Current SLA Console. Define up to 4 sort keys for the display (see below) Generate an HTML file showing the current SLA Console. Save the chart as comma separated values (CSV format) Save the view as an XLS spread sheet. Generate a PDF report that shows all the SLAs from the chart and provides summary Pie Chart of SLA statuses and SLA Performance. Generate a PDF report that shows just the summary Pie Charts of the SLAs. Open the Critical Path Monitor. View details of the selected SLA (see below) VIEW TOOLS 49

50 SLA Console Tools Icon Description Open the SLA Definition dialog View the details of the SLA Job. View the definition of the SLA Job View historical run data for the SLA Job. Help Refresh Click the Refresh icon to refresh the data shown in the SLA Console. This performs a one-time refresh Print Click the Print icon to create a print out of the data currently shown in the SLA Console. All the columns shown in the SLA Console are printed. All graphics or icons shown in any of the columns are also printed. Given the number of columns in the SLA Console, we recommend that you create printouts in Landscape orientation Sort You can define the sort criteria for the SLA Console by clicking the You can define up to four different sort keys. icon. VIEW TOOLS 50

51 View HTML Click the icon to generate an HTML report file containing information about all the SLAs currently shown in the Console. All the rows shown in the SLA Console will be present in the HTML file. You can save, print, and this HTML report. The HTML file can be saved to your local machine Save CSV or XLS Click the next two icons to generate a CSV or XLS file containing information about all the SLAs currently shown in the Console. You can use a spreadsheet program to open these files. Each column of the SLA Console will be mapped to a column in the files. These files do not show the Critical Ratio and Progress columns from the SLA Console View PDF Click the icon to generate a PDF file containing information about all the SLAs currently shown, and some summary charts that shows the status distribution and performance distribution of these SLAs. Additional details about the report data are provided in Chapter 5: idash Reports View PDF Summary Click the icon to generate a PDF file containing just the summary charts of all the SLAs currently shown. These summary charts are the same as in the full PDF report generated from the previous icon. Additional details about the report data are provided in Chapter 5: idash Reports. VIEW TOOLS 51

52 SLA Console Tools Critical Path Monitor Click the icon to open the Critical Path Monitor for the selected SLA SLA Detail You can view detailed information about a selected SLA by clicking this icon after selecting an SLA record in the Console or Tree View Summary This area shows the following information: Field Job, Instance Deadline Complete / Predicted Description The SLA Job name and the CA Workload Automation AE instance. The SLA deadline assigned to the SLA Job for this occurrence. The estimated or actual date and time when the SLA will VIEW TOOLS 52

53 Field Description be/was met. If the SLA is predicted to be missed, then this field will show the value in RED. SLA Type SLA Status Shows whether the SLA deadline is a Start By or End By deadline. The current status of the SLA Description This area shows the text in the description field of the job definition and the instance and box hierarchy of the SLA job Long Running This area shows those Critical JobList jobs that, for this SLA, ran more than 110% of their average runtime. VIEW TOOLS 53

54 SLA Console Tools Globals This area shows the Critical JobList jobs that have a dependency on Global Variables and the value of those Global Variables Machines This area shows all the Critical JobList jobs and the machines that they ran on the last time. This area will show you those machines that are needed to be functioning in order for the SLA to be met. VIEW TOOLS 54

55 SLA Definition You can view the definition of the selected SLA by clicking this icon. If you have the authorization to modify SLA definitions, then you will be able to modify existing SLA definitions or create new SLA definitions from this dialog. VIEW TOOLS 55

56 SLA Console Tools In this screen, you can view or specify the parameters for the selected SLA. This includes the deadline parameters, the frequency of the SLA, the Alarm specifications, the idash server forecast parameters, and any Override defined for the SLA. To get more details on each of these fields, refer to the Section 4.3 Creating SLA Definitions in the CA Workload Automation idash Administration Guide Job Detail This icon opens the Job Detail dialog that shows comprehensive information about the SLA Job. The Description area in the Job Detail shows information similar to that shown in the Description area in the SLA Detail dialog Last Run VIEW TOOLS 56

57 This area shows details about the last job run for this SLA job. This is the last job run prior to the SLA deadline. If the SLA selected has not been MET or MISSED, then the information shown here is the forecasted job run Dependencies This area shows the starting conditions and a list of immediate predecessors and successors for the SLA job. VIEW TOOLS 57

58 SLA Console Tools Globals This area shows the global variables that are used by the SLA job in its starting conditions. You can see the current name and value of the Global Variables Machines This area shows the name of the machine on which the SLA job last ran Date - Time This area shows the date conditions in the job definition of the SLA job. In this area, only those fields that have been defined in the job will be highlighted. VIEW TOOLS 58

59 Latency idash analyzes the CA Workload Automation AE job run data to generate latency information for each job. A job could have latencies due to multiple reasons. This dialog shows the latency value for each criterion, and then shows the total effective latency. The information with actual values is available only for historical SLAs. For upcoming SLAs, any latency due to the nature of the job definition will be shown Average Runtime idash evaluates the historical runs of CA Workload Automation AE jobs and builds an internal table with average run times for the jobs. The average run times are calculated based on the day of the week, the day of the month, and an aggregate average. The forecasting engine will use the highest average runtime for any given day. VIEW TOOLS 59

60 SLA Console Tools Job Definition By clicking this icon, you can view the job definition of the SLA job. idash retrieves the job definition and shows it to you in a browser window. The job definition is shown in JIL format. VIEW TOOLS 60

61 Run Data You can view all the historical runs for the SLA job by clicking this icon. The Run Data dialog retrieves all CA Workload Automation AE runs from the CA Workload Automation AE Instance database and from the idash job runs archive. The idash job runs archive stores historical job run information from the CA Workload Automation AE database. This archive is maintained by the idash daemon. The Run Data dialog Tool bar lets you print, sort, and generate HTML, CSV, XLS, and PDF report files Help Icon You can click this icon to open the SLA Console Help dialog. The Help dialog provides details about the columns and values shown in the SLA Console. VIEW TOOLS 61

62 SLA Console Tools Right-Click All Toolbar actions can be performed by right-clicking a job. Menu Option Critical Path Monitor View SLA Detail Description Open the Critical Path Monitor for the selected SLA View details of the selected SLA SLA Definition See the SLA Definition Job Detail View details of the SLA Job Job Definition View the SLA Job Definition Run Data View run data for the job SLA Help Open the SLA Help Dialog. VIEW TOOLS 62

63 4.2. Critical Path Monitor Tools You can move your mouse over the Toolbar icons to see the associated flyover text. Most of the tools in the Critical Path Monitor are quite similar to the SLA Console Tools, except that they apply to the selected job rather than the SLA job. Icon Description Refresh the data from CA Workload Automation AE Print the Job Flow shown Create an SVG file with the Job Flow shown. This file can be opened in Visio. Rotate the Job Flow Layout to stream the jobs in vertical or horizontal order. Open the Help Dialog. Change the Zoom level in the Job Flow View. View the chart as HTML Save the chart as comma separated values (CSV format) or XLS spreadsheet Create a detailed PDF report file showing all the Job Runs listed in the Console and some summary charts for the jobs. Create a PDF report file that shows just the summary charts for the Job Runs listed in the Console. View Real-time Job Run and status information. VIEW TOOLS 63

64 Critical Path Monitor Tools Icon Description Create a PDF report file that shows a Gantt chart for the forecasted or actual job runs listed in the Console. Distills the jobs to include just those jobs that are in the current Critical Path, and those jobs that have special conditions and errors. Shows just those jobs that are in the current Critical Path. View the Job Definition (CA Workload Automation AE JIL) in a browser window. View details of the Job: description, last run, dependencies, global variables referenced, machines, date/time. View run data previous run history for the job. Open the sendevent dialog to issue events for the selected job. Execute a User Command. These are defined by the idash Administrator. The first two icons on the Toolbar let you refresh the status of the jobs and to Print the Job Flow, as shown in the dialog. The printout will be tiled across multiple pages, if needed Save as SVG You can click the icon labeled Save As SVG to save the Job Flow layout in a SVG file format. A SVG file can be opened from various graphical software products, including Microsoft Visio. When you save the file in SVG format, the current Job Flow view and the statuses of jobs will be shown Rotate Layout You can change the layout by clicking this icon. The layout will be toggled between Left to Right and Top to Bottom. VIEW TOOLS 64

65 If you save the file as SVG, or Print the Job Flow, the current rotated layout will be shown. You can Zoom In/Out in the Job Flow dialog by using the Zoom settings. VIEW TOOLS 65

66 Critical Path Monitor Tools View Real-time The job runs shown in the Critical Path Monitor can be toggled between two categories: Real-time, and Forecasted. The Real-time view shows the current status and run data for each job. The Forecasted view shows the predicted status and job runs as pertaining to the selected SLA. The job runs shown in the forecasted view state FUTURE as their status, and the Start and End times of the jobs show an icon in their column indicating a predicted value. All actual values do not show that icon. You can toggle between Real-time and Forecasted view by clicking this icon. When the view is showing Real-time data, the icon is highlighted with a red border View Gantt Chart Clicking this icon will generate a PDF file with a Gantt chart of all the jobs in the Critical Path Monitor. The Gantt chart will show real-time, historical, or forecasted job run information. The Critical Path Jobs will be highlighted with an icon and lines drawn to indicate the path Distill Critical Path By clicking this icon, you can filter out the view to see only those jobs that are in the current Critical Path of the SLA, and those jobs that have special VIEW TOOLS 66

67 conditions, such as jobs in FAILURE/TERMINATED/ON_HOLD status, jobs that are dependent on Global Variables, jobs that are running longer than their average run time, and so on. This lets users quickly analyze the issues for any SLA and take any necessary actions View Critical Path By clicking this icon, you can filter out the view so only those jobs are in the current Critical Path of the SLA are shown Job Definition By clicking this icon, you can view the job definition of the selected Critical JobList job. idash retrieves the job definition and shows it to you in a browser window. The job definition is shown in JIL format. VIEW TOOLS 67

68 Critical Path Monitor Tools Job Detail This icon opens the Job Detail dialog that shows comprehensive information about the selected job. The information shown in this dialog is very similar to that shown in the Job Detail dialog for SLA jobs Run Data You can view all the historical runs for any Critical JobList job by clicking this icon. The Run Data dialog retrieves all CA Workload Automation AE runs from the CA Workload Automation AE Instance database and from the idash job runs archive. The idash job runs archive stores historical job run information from the CA Workload Automation AE database. This archive is maintained by the idash daemon. The Run Data dialog Tool bar lets you print, sort, generate HTML, CSV, XLS, or PDF report files User Command The idash administrator creates user commands. When a User Command is executed, the script defined in the command is executed on the idash server with environmental variables containing information about the job. An example, shown below, might be sending with job information to a system administrator. VIEW TOOLS 68

69 Select the Mail command. Since the User Command was set up with a nonempty Input Prompt, the idash GUI will open a dialog with an input prompt. Type the desired information, and click OK Right-Click All Toolbar actions can be performed by right-clicking a job Alarm Manager The Alarm Manager provides a consolidated tool for managing CA Workload Automation AE Alarms across all instances. The Alarm Manager can be opened by clicking the Alarms icon on the bottom of the main GUI. The Alarm icon turns red whenever a new CA Workload Automation AE Alarm is created. When you click this icon, it opens the Alarm Manager and turns the icon back to default. This way, you will be always notified whenever a new Alarm is created. VIEW TOOLS 69

70 Alarm Manager You can Acknowledge or Close single, multiple, or All alarms from the Alarm Manager. You can provide responses every time you perform an action on the alarm. All responses are stored inside the CA Workload Automation AE database for each alarm and can be seen by just clicking the alarm. Button Acknowledge Acknowledge All Close Close All Refresh Enabled Show Closed Alarms Hide Closed Alarms Close Window Description Acknowledge the selected Open alarm(s). If multiple alarms are selected, the Acknowledge button will acknowledge those alarms that are in the Open state. The Enter Alarm Response input box will appear. Type in the desired response text for the alarms, and select OK. Acknowledge all the Open alarms. The Enter Alarm Response input box will appear. Type in the desired response text for the alarms, and select OK. Close the selected Open or Acknowledged alarm(s). If multiple alarms are selected, the Close button will Close those alarms that are in the Open or Acknowledged state. The Enter Alarm Response input box will appear. Type in the desired response text for the alarms, and select OK. Close all the Open and Acknowledged alarms. The Enter Alarm Response input box will appear. Type in the desired response text for the alarms, and select OK. By default, the Alarm Manager refreshes the alarm data with every client refresh. To prevent the Alarm Manager from automatically refreshing while you are working with it, deselect this option. Includes Closed alarms on the Alarm Manager list. Removes Closed alarms from the Alarm Manager list. Closes the Alarm Manager dialog. Information Box User Comment Description The user who Acknowledged or Closed the alarm. Some optional details about the alarm. VIEW TOOLS 70

71 Information Box Description State Time Response The time of the most recent state transition of the alarm (to state Open, Acknowledged or Closed). The response input when the alarm was transitioned from Open to Acknowledged, or to Closed. If the alarm has been Acknowledged or Closed multiple times, all the responses entered will be shown. VIEW TOOLS 71

72 CA Workload Automation AE Archive Reports 5. idash REPORTS The idash Database lets users store CA Workload Automation AE archive files and generate reports from them. The CA Workload Automation AE Job Runs, Events, and Audit files can be loaded in to the database. The files can be loaded from the Admin Tool or from the Command line. idash also provides reporting capability for its own data, including historical or upcoming SLAs. Each report can be generated in PDF, HTML, CSV, and XLS formats. The PDF reports show graphs, charts, and data. The other formats show only the data CA Workload Automation AE Archive Reports After a report is generated, it can be saved in the following formats: CSV (comma separated, for use in a spreadsheet), HTML, PDF, and XLS formats. You can also save just the Summary part of the report, which shows all the information except the data. The Summary part can be saved only in PDF format. To access the CA Workload Automation AE Archive Reports, use the Reports menu and select Job Run Reports, Event Reports, or Autotrack Reports. idash REPORTS 72

73 Job Runs Reports Job Run data when a job ran, what machine it ran on, the completion status can be shown on a Job Runs report. When you select Run Reports from the Report menu, the following screen is displayed: To run an existing report, select the report from the pull-down and click the Process Report icon. The report will be displayed in a new window. To copy an existing report definition, use the Copy prompted to enter a new name for the copy. icon. You will be To create a new report, click the New click OK: icon. Enter a name for the report and idash REPORTS 73

74 CA Workload Automation AE Archive Reports Define details for the report as described below. If specific CA Workload Automation AE instances are desired, clear the All Instances check box and click the Add button to select the instances to be shown on the report. On the Time tab, select the number of historical days or a specific time interval to display. On the Status tab, select the job statuses that should be included. If not all jobs should be shown on the report, use the Job tab to enter job names, including wild cards, which should be shown on the report. Clear the All Jobs check box and click the Add button to enter an expression. The example above will include all jobs that start with Pay. idash REPORTS 74

75 If you don't remember the job names, or to test the expression being entered, use the Find Job button at the bottom to see a list of jobs, as shown below: To filter by the machines on which the job ran, use the Machine tab. Clear the All Machines check box, and click the Add button to enter an expression. The above will report on all jobs that ran on the sybprod1 machine, as well as jobs that ran on any machine beginning with prsyb. idash REPORTS 75

76 CA Workload Automation AE Archive Reports It is possible to specify what data is required on the report. The available fields are as follows: Day Duration End Time Exit Code Instance Job Name Machine Ntry Run Num Start Time Status On the Columns tab, clear the All Columns check box and then click the Add button to include the desired fields. Use the Move Up and Move Down buttons to define the order in which the data will appear on the report. Also, the sort criteria can be supplied for the report. You can apply up to three sort keys for each report. The sort keys have to be chosen from the columns selected for the report's data. You can specify the format for the date and time values shown in the report. The format can include the timezone for the data as well. When the report specification is complete, click the Save icon. idash REPORTS 76

77 To delete a report, select the report and then click the Delete icon. For assistance, click the Help icon. The following is a sample PDF report generated from the CA Workload Automation AE Job Runs archive data. The PDF summary report shows just the first five pages of the detailed report. idash REPORTS 77

78 CA Workload Automation AE Archive Reports idash REPORTS 78

79 Event Reports Event data specifics on each event that was processed by the scheduler can be shown on an Event report. is the New Report icon. is the Save Report icon. is the Delete Report icon. is the Process Report icon. is the Copy Report icon. is the Help icon. To define a new report, or to modify an existing or copied report, enter details as described in the Section Job Runs Reports. You can select which Events should be included in the report. idash REPORTS 79

80 CA Workload Automation AE Archive Reports A sample PDF report generated from the CA Workload Automation AE Events archive data is as follows: idash REPORTS 80

81 Autotrack Reports Autotrack is a CA Workload Automation AE utility that saves data about each action taken by a user. This includes starting jobs, putting them on hold, stopping the server components, and so on. Select Autotrack Reports from the main Report menu. The report definition options are similar to the other reports. You can specify the audit types, jobs, instances, time interval, and users for each report. idash REPORTS 81

82 CA Workload Automation AE Archive Reports Use the Run button to process the report. A sample PDF report generated from the CA Workload Automation AE Autotrack archive data is as follows: idash REPORTS 82

83 Saving Report Output After the report has processed, the same options are available for all reports: Print Sort Save as HTML Save as CSV Save as XLS Save as PDF Save as PDF Summary Help The HTML, CSV, and XLS report formats just show the data, no graphs or charts. The PDF Detailed report shows both the graphs/charts, and the data. The PDF Summary reports just show the graphs/charts and summary information about the data retrieved for the report. idash REPORTS 83

84 CA Workload Automation AE Real-Time Reports 5.2. CA Workload Automation AE Real- Time Reports You can generate on-demand reports of CA Workload Automation AE jobs based on certain characteristics of the job Job Status Reports This is a report of jobs based on their current status. Select Job Status Reports from the Report menu. You can narrow down the list of jobs to be included in the report by using the fields listed below. Field Name Box Level Box Name Defined Machine Description Exclusion Instance Job Name Job Type Owner Status Time Description Traverse box levels up to this value specified here. Include the Box Jobs listed here and all of their children jobs. Include only those jobs that are defined to run on the machine names listed here. Include only those jobs whose description field matches the value specified here. Exclude those jobs whose names match the value specified here. Include only those jobs that run on the CA Workload Automation AE instance specified here. Include only those jobs whose names match the value specified here. Include only those jobs whose job_type field matches the value specified here. Include only those jobs whose owner field matches the value specified here. Include only those jobs whose current status matches the value specified here. Include only those jobs whose current status was achieved within idash REPORTS 84

85 Field Name Description the time frame specified here. Sort Time Format Specify up to three sort keys for the report. Specify the format for the date, time and timezone fields in the values shown in the report. The Column field is used to specify which information should be shown in the report for all the jobs included in the report. The data for these columns is derived from the job definition and the job status tables in the CA Workload Automation AE database. idash REPORTS 85

86 CA Workload Automation AE Real-Time Reports idash REPORTS 86

87 5.3. idash SLA Reports You can generate on-demand reports of any historical or upcoming SLAs, performance and trends of any SLA, and the forecasted or actual Critical JobList of any SLA SLA Reports To generate SLA reports, you have a few options. You can create a Custom View by using the Search icon on the SLA Console, and then generate a report using the idash GUI or CLI. Or you can navigate to a list of SLAs using the Tree View, and then generate a report using the GUI only. Refer to Section Create Custom Views to get more information on how to create SLA View Definitions. To generate a report from the GUI, click the View name in the Tree View and then click the HTML/CSV/PDF/PDF Summary icon on the SLA Console toolbar. The detailed PDF report is as follows: idash REPORTS 87

88 idash SLA Reports The first page of the SLA report provides a breakdown of SLAs based on their statuses and performance. The SLA performance chart is for historical SLAs only. It provides a summary about how many SLAs missed their deadline, how many met the deadline but were within the Risk Window, and how many finished Ahead of Schedule and before the Risk Window SLA Trend Report You can generate reports that display the performance trends of one or more SLAs. These reports show how well the SLA has been performing against its deadline, or how poorly has it missed its deadline. To generate this report, select SLA Trend Reports from the Report menu. After specifying the Instance and Time information, provide one or more SLA job names in the SLA Job tab. You can find list of jobs with defined SLAs by using the Find SLA button at the bottom. idash REPORTS 88

89 idash REPORTS 89

90 idash SLA Reports idash REPORTS 90

91 Critical JobList Report For any SLA, you can generate job runs reports that show the historical or predicted job behavior of the Critical Jobs. These reports can be generated from the GUI or the CLI. You can also generate a report of the real-time job run information of the Critical Jobs from the GUI. A Gantt chart report can be also created from the GUI or the CLI. To generate Critical JobList reports from the GUI, select the desired SLA in the Tree or SLA Console, and then open the Critical Path Monitor. You can then click any of the buttons to generate a detailed HTML, CSV, PDF, or XLS report, a PDF Summary report, or a Gantt chart report of historical, forecasted or real-time job run information. Refer to Section 4.2 Critical Path Monitor Tools for more information on which buttons to click. The PDF report of the Critical JobList for a historical SLA is as follows: idash REPORTS 91

92 idash SLA Reports Job Performance: This chart provides a summary of how the Critical Jobs performed for this SLA. It lists the number of jobs that did not run, that ran longer than 120% of their average runtime, ran shorter than 80% of their average runtime, and ran within their average runtime range. Job Status: This chart provides a status distribution of the Critical Jobs. Job Status: This chart provides the run machine distribution of the Critical Jobs Single Job Report You can select any SLA job or any one of its Critical Jobs and generate a HTML, CSV, PDF or XLS report of all the historical job runs for that job. To generate this report, select the job in the Critical Path Monitor and then click the Run Data button in the toolbar. That will fetch all the associated job runs from the CA Workload Automation AE archive and the real-time database. idash REPORTS 92

93 5.4. Other Reports Server Statistics Report You can generate a report for CA Workload Automation Event performance and Latency statistics. Click the icon on the Dashboard, or select Server Statistics Report from the Report menu, to open the Event and Latency graphs. Go to the Detail tab and click the CSV, HTML, or PDF report buttons to generate the desired report. idash REPORTS 93

94 Other Reports The PDF Report of this data is as follows: The next chapter describes the idash Client CLI that lets you generate reports from the command line. idash REPORTS 94