Reports
From OpsWise Documentation Wiki
Contents |
Creating and Generating Reports
The OpsWise Automation Center installation includes a number of predefined reports, as described below. You can also create, save, and run your own reports as needed. The Activity Screen also uses reports created using this feature to define what task instances are displayed. When you create a report for the Activity Screen, you select records only from a specific table called the Activity table. When you save the report, it appears automatically in the drop-down menu on the Activity screen. For normal reports, the report appears on the Reports menu when you save it.
When you create reports, you need to know the table names of the data you want to include. See OpsWise Automation Center Tables.
Predefined Reports
The following reports have been predefined within OpsWise Automation Center:
Agent Connection
- Agent Connection Status
- All Agents
Connector
All Connectors
Activity
- Active Task Instances
- Active Workflow Task Instances
- Active/Late Task Instances
- All Task Instances by Status
- Cancelled Task Instances
- Held Task Instances
- In Doubt Task Instances
- Queued Task Instances
- Running Task Instances
- Today's Failed Task Instances by Status
- Today's Successful Task Instances
- Today's Task Instances by Created Time
- Today's Task Instances by Type
- Undeliverable Task Instances
- Unsuccessful Task Instances
- Waiting For Resources Task Instances
- Waiting Task Instances
- Workflow Task Instances
- Workflow Task Instances with Problems
History
- Duration
- Stuff that Didn't Run Right
User
- Users
Group Member
- Group Membership
User Role
- Role Allocation
Creating an Activity Report
Follow the steps below to create a sample Activity report that shows all tasks instances, sorted by resource.
- From the Navigation pane, select Reports. The main report screen displays.
This screen provides a list of all reports that your userid has access to, along with a New button that allows you to create a new report. - Under My Saved reports, click New. A blank reports screen displays.
- In the Name field, enter "Tasks Sorted by Resource".
- In the Visible to field, select Me. This identifies who will have access to the report as follows:
- Me — Only you can view/run the report.
- Everyone — All users can view/run the report.
- All other options — The remainder of the dropdown list consists of the groups that have been entered by selecting Security > Groups from the Navigation pane.
- In the Type field, select List.
- In the Table field, select the OpsWise Automation Center report table you want to use. For this tutorial, select Activity[ops_exec], which is the table used for all Activity reports and contains information about all task activity.
- In Group by, select Agent. This field specifies that the report should be displayed in sections by agent.
- The Columns section displays a list of available fields in the Available section, and the selected fields in the Selected section. A number of default fields appear in the Selected section. For this tutorial, we will select Instance Name, Agent, Status, Type, and Duration. Select and deselect fields as follows:
- On the Selected list, double click fields to remove them from the report.
- On the Available list, double click fields to add them to the report.
- To run the report, click Run Report. OpsWise Automation Center creates a list of Task Types, as shown in the example.
- To expand all sections of the report, click the plus (+) sign.
- Now you will filter the report to select only tasks that ran today:
- Under Filter and Order, click on the box with a plus sign (+) and the word "and", as shown:
- You are prompted to select filtering criteria.
- For choose field, select Created.
- Select 'on'.
- Keep the default 'Today'.
- Click Run Report again. The report is re-run with the filter applied, removing those task instances that ran before today.
- To save the report, click Save.
- The report is now listed in your section (My Saved Reports) of the Reports list. To view it, click Reports from the Navigation Pane. It has also been added to the list of Activity reports on the Activity screen. If you want to print the report, save it first and then print it (see Viewing, Running, Printing an Existing Report).
Viewing, Running, Printing an Existing Report
- Select Reports from the Navigation Pane. The Reports page displays.
- Scroll down and click on the report you want to view and run. The report specifications display. The lower pane displays the results, if any, of the last time the report was run.
- If necessary, you can make changes to the report specifications. To run the report, click Run Report.
- To print the report, click the printer icon on the right end of the title bar. A preview screen generates. Select Click to Print to print the report.
Modifying a Report
- Display the report you want to modify.
- Make your changes and click Update.
Copying a Report
- Display the report you want to copy.
- Give the report a new name, specify your changes, if any, and click Insert.
Deleting a Report
- Display the report you want to delete.
- Click Delete.
Creating a Gauge from a Report
You can create a gauge from your report and, optionally, add it to your home page or dashboard. A gauge is a "live" report that is updated according to the refresh setting on the home page or dashboard.
- Display the report you want to make into a gauge.
- Click Make Gauge.
- Refer to Customizing Your Home Page for information about adding a gauge to a home page.
Scheduling Automatic Report Distribution
These instructions show you how to set up a report to be run and distributed to an emailing list on specific dates and times.
Setting Up the Email Properties
Before you can schedule automatic report distribution, you must first set up the email server you want to use.
- From the navigation pane, select Automation Center Administration > Configuration > Report Email Properties.
- Specify the outgoing and incoming mail server information and click Submit.
Scheduling the Report
- Display the report you want to schedule and click the Schedule button. Or, from the navigation pane, select Automation Center > Scheduled Report Emails, click New, and browse for the report you want to schedule.
- Use the field descriptions below for guidance to complete the fields.
- Click Submit.
Scheduled Email of Report Field Descriptions
| Field Name | Description |
|---|---|
| Name | The name of the report schedule. |
| Active | Indicates whether the schedule is active or not. Only active schedules are executed. |
| Report | The name of the report being scheduled. Click the magnifying glass to browse for a report. |
| Every | Use this field to specify when the report should be run and distributed. Options:
|
| Users | Use this field to select users (specified via Security > Users) that will receive the report. The user records must contain the email addresses. See Adding Users. |
| Day | If Every = Week, specify the day of the week when the report should be run and distributed. Options: Monday through Sunday. |
| Day | If Every = Month, specify the numeric day of the month when the report should be run and distributed. Options: 1 through 31. |
| Time | Use this field in conjunction with the Every field to specify a time when the report should be run and distributed. |
| Groups | Use this field to select groups of users (specified via Security > Groups) that will receive the report. The record of each user in the group must contain the email addresses. See Adding Groups. |
| Email Addresses | Specify a comma-separated list of email addresses for those receiving this report. |
| Subject | Specify the subject line of the email. |
| Introductory Message | Write a message that will go in the body of the email. You can format the message using the standard formatting options provided. You can also specify font color  , background color  , horizontal rule  , web link  , images  , tables  . To can also toggle between wysiwyg and html source  . |
| Type | Specify the output type for the report. Options: PDF landscape, PDF, Excel, CSV (comma-separated values). |
| Include detail |
OpsWise Automation Center Activity Table
When you create an Activity report, you only select data from the Activity[ops_exec] table. This table contains all data about executed task instances.
| Field Name | Description |
|---|---|
| Agent | For agent-based tasks, the name of the agent. |
| Attempt | A counter that keeps track of the number of times this task instance was attempted. |
| Average Estimated End Time | |
| CPU Time | Number of CPU seconds for the task instance. |
| Calendar | The name of the calendar. |
| Class | The type of task instance, such as Sleep Task Instance or Workflow Task Instance. |
| Created | The date and time when the task instance was created. |
| Created by | The user ID of the user who created the task. |
| Credentials(credentials) | Login credentials for a remote machine. |
| Credentials(credentials_var) | The variable specified in the login credentials field. |
| Credentials Variable | True or false. If enabled, the Credentials field (see above) converts from a reference field (where you browse and select a record) into a text field that allows you to enter a variable. |
| Current Retry Count | System-supplied. Displays only for a running task instance. Displays the number of times the system has retried the task after it first went to failure status. |
| Duration | The amount of time, in miliseconds, the task instance took to run. |
| Duration in Seconds | The amount of time, in seconds, the task instance took to run |
| Early Finish | True or false. If enabled, and if the task instance finishes before the time or period specified, the task instance is flagged as early. |
| Early Finish Duration | If Early Finish Type is Duration, this specifies the shortest amount of time this task instance should take to run. |
| Early Finish Time | If Early Finish Type is Time, use this to specify the time before which the task finish time is considered early. |
| Early Finish Type | Time or Duration. |
| End Time | The date and time the task instance finished. |
| Execution User | The ID of the user, if any, who launched the task. |
| Exit Code | The exit code, if any, returned by the process. |
| Finished Early | True or false. If enabled, and if the task instance finishes before the time or period specified, the task instance is flagged as early. |
| Finished Late | True or false. If enabled, and if the task instance finishes after the time or period specified, the task instance is flagged as late. |
| Forced Finished | True or False. Indicates whether the task instance was force-finished. |
| Hold Reason | Not used. |
| Hold on Start | True or false. If enabled, when the task is launched it appears in the Activity display with a status of Held. |
| IO Other | Total input/output operations for this task. |
| IO Reads | Total input/output reads for this task. |
| IO Writes | Total input/output writes for this task. |
| Instance Name | The name of the task instance. |
| Instance Reference Id | The internal reference ID for the task instance. |
| Invoked by | The user or process that launched the task. |
| Late Finish | True or false. Indicates whether or not the task instance is flagged as having finished late. |
| Late Finish Duration | If Late Finish Type is Duration, specifies the longest amount of time this task instance should take to run. |
| Late Finish Time | If Late Finish Type is Time, specifies the time after which the task finish time is considered late. |
| Late Finish Type | Time or duration. |
| Late Start | If enabled, and if the task instance starts after the time specified in the Late Start Time field (see below), the task instance is flagged as late. |
| Late Start Duration | N/A. |
| Late Start Time | If Late Start Type is Time, specifies the time after which the task start time is considered late. |
| Late Start Type | Time or Duration |
| Longest Estimated End Time | |
| Maximum Retries | The maximum number of retries specified by the user. |
| Member of Groups | One or more Opswise groups that this task definition belongs to. |
| Memory Peak | The peak amount of memory used during the execution of this task instance. |
| Memory Used | The amount of memory used during the execution of this task instance. |
| Queued Time | The amount of time this task instance spent in queued status. |
| Resources State | |
| Retry Indefinitely | True or false. Whether the system was instructed to retry the task indefinitely. |
| Retry Interval (Seconds) | The number of seconds that should elapse between retries, as specified by the user. |
| Run Called | True or false. |
| Run Criteria Run Time | True or false. |
| Run Criteria Trigger Time | True or false. |
| Security Name | The task name. |
| Shortest Estimated End Time | |
| Start Time | Date and time when the task instance launched. |
| Started Late | True or false. Indicates whether the task instance was flagged as a late start. |
| Status | The status of the task instance. |
| Status Description | Detailed description of task instance status. |
| Summary | Summary provided to describe the task. |
| Sys id | |
| Task | Task name. |
| Task Priority | Priority assigned to the task instance. |
| Trigger Id | Name of the trigger that launched the task instance, if any. |
| Type | Task type. |
| Updated | The date the task record was last updated. |
| Updated by | The user ID who last updated the task. |
| Updates | The number of updates that have been made to the task record. |
| User Estimated End Time | |
| Vertex Id | Each task within a workflow has a unique vertex ID, which distinguishes it from other tasks of the same name, if any. |
| Workflow Id | For a workflow, the name of the task. |
| Show Related Files | Not supported for reports. |
OpsWise Automation Center Report Tables
Described below are the OpsWise Automation Center tables that you can use when creating reports.
| Table Name | Description |
|---|---|
| Abort Action [ops_abort_action] | |
| Action [ops_notification] | |
| Activity [ops_exec] | Task instance activity (running tasks). |
| Agent Cluster [ops_agent_cluster] | |
| Agent Connection [ops_agent] | Agent resource definitions. |
| Approval [sysapproval_approver] | Agent group definitions. |
| Audit Records [ops_audit] | User activity. |
| Backup [ops_backup] | |
| Building [cmn_building] | |
| Calendar [ops_calendar] | Calendar records. |
| Calendar Custom Days [ops_cal_cust_join] | Custom days associated with a calendar. |
| Cluster Locks [ops_cluster_lock | |
| Cluster Nodes [ops_cluster_node | |
| Command [ops_command] | |
| Command Response [ops_command_response] | |
| Company [core_company] | |
| Connector [ops_connector] | |
| Cost center [cmn_cost_center] | |
| Credentials [ops_credentials] | Login credentials entered into the OpsWise Automation Center credentials option under Security. |
| Cron Trigger [ops_trigger_cron] | Cron trigger records. |
| Currently In Use By [ops_resource_usage] | Virtual resource usage. |
| Custom Days [ops_custom_day] | Defined custom days. |
| Database Connection [ops_database_connection] | |
| Department [cmn_department] | |
| Dictionary Entry [sys_dictionary] | |
| Email Connection [ops_connect_email] | Defined Email Connection resources. |
| Email Notifications [ops_email_notification]] | Defined Email Notifications. |
| Email Task [ops_task_email] | Email tasks. |
| Email Task Instance [ops_exec_email] | Email task instances. |
| Email Template [ops_email_template] | |
| Event Message History [ops_debug_event] | |
| File Monitor [ops_task_file_monitor] | File Monitor tasks. |
| File Monitor Instance [ops_exec_file_monitor] | File Monitor task instances. |
| File Monitor Trigger [ops_trigger_fm] | File Monitor triggers. |
| Forecasts [ops_trigger_forecast] | |
| FTP File Monitor [ops_task_ftp_file_monitor] | |
| FTP File Monitor Instance [ops_exec_ftp_file_monitor] | |
| FTP Task [ops_task_ftp] | FTP tasks. |
| FTP Task Instance [ops_exec_ftp] | FTP task instances. |
| Global [global] | |
| Group [sys_user_group] | |
| Group Member [sys_user_grmember] | |
| Group Role [sys_group_has_role] | |
| Heartbeat [ops_msgque_heartbeat] | Heartbeats generated between agents and the core scheduler. |
| Heartbeat Tags [ops_msgque_heartbeattags] | |
| History [ops_history] | Task activity. |
| Incident fact table [incident_fact_table] | |
| Input Queue [ops_msgqueue_in] | |
| Input Queue Tags [ops_msgque_intags] | |
| JobStep Files Data [ops_exec_zos_files] | |
| JUnit Tests [ops_junit_tests] | |
| Label [label] | |
| Label auto [label_auto] | |
| Label entry [label_entry] | |
| Label history [label_history] | |
| Label table [label_table] | |
| Linux/Unix Agent [ops_unix_agent] | Defined Linux/Unix agent resources. |
| Linux/Unix Agent Cluster [ops_unix_agent_cluster] | |
| Linux/Unix Agent Group Relation [ops_unix_agent_group_join] | Linux/Unix Agents and the groups they belong to. |
| Linux/Unix Task [ops_task_unix] | Linux/Unix tasks. |
| Linux/Unix Task Instance [ops_exec_unix] | Linux/Unix task instances. |
| Location [cmn_location] | |
| Manual Task [ops_task_manual] | Manual tasks. |
| Manual Task Instance [ops_exec_manual] | Manual task instances. |
| Note [ops_note] | Notes attached to OpsWise Automation Center records. |
| Opswise Counters [ops_counter] | |
| Opswise Externalizables [ops_externalizable] | |
| Opswise Groups [ops_generic_group] | |
| Opswise License [ops_license] | |
| Opswise Map [ops_map] | |
| Opswise Permissions [ops_permission] | |
| Opswise Properties [ops_config] | OpsWise properties entered from the OpsWise properties menu option. |
| Opswise Subscriptions [ops_subscription] | |
| Output [ops_exec_output] | Outputs, such as STDOUT, attached to task instances. |
| Output Message History [ops_debug_omsg] | |
| Output Queue [ops_msgque_out] | |
| Output Queue Tags [ops_msgque_outtags] | |
| Outstanding Requests [ops_resource_order] | |
| Restart Data [ops_zos_restart] | |
| Set Variable [ops_variable_action] | |
| Sleep Task [ops_task_sleep] | Sleep tasks. |
| Sleep Task Instance [ops_exec_sleep] | Sleep task instances. |
| SQL Result Set [ops_sql_results] | |
| SQL Task [ops_task_sql] | |
| SQL Task Instance [ops_exec_sql] | |
| Stored Procedure Parameters [ops_stored_proc_param] | |
| Stored Procedure Task [ops_task_stored_proc] | |
| Stored Procedure Task Instance [ops_exec_stored_proc] | |
| Sys audit [sys_audit] | |
| Task [ops_task] | Tasks of every type. |
| Task Instance Run Criteria [ops_exec_run_criteria] | |
| Task Monitor [ops_task_monitor] | |
| Task Monitor Instance [ops_exec_monitor] | |
| Task Monitor Trigger [ops_trigger_tm] | |
| Task Run Criteria [ops_task_run_criteria] | |
| Task Virtual Resources [ops_task_to_resource] | Virtual resources assigned to tasks. |
| Temporary Trigger [ops_trigger_temp] | Temporary triggers. |
| Time Trigger [ops_trigger_time] | Time triggers. |
| Trigger [ops_trigger] | Triggers of every type. |
| User [sys_user] | User records. |
| User Role [sys_user_has_role] | Role records. |
| Variables [ops_local_variable] | Local variables, entered into the Variables tab on a task record. |
| Variables [ops_variable] | Variables, entered by selecting Variables from the Navigation pane. |
| Virtual Resource [ops_virtual_resource] | Virtual resource records. |
| Windows Agent [ops_windows_agent] | Windows agents. |
| Windows Agent Cluster [ops_windows_agent_cluster] | Windows agent groups. |
| Windows Agent Cluster Relation [ops_windows_agent_cluster_join] | Windows agents that belong to groups. |
| Windows Task [ops_task_windows] | Windows tasks. |
| Windows Task Instance [ops_exec_windows] | Windows task instances. |
| Workflow task [ops_task_workflow] | Workflow tasks. |
| Workflow task edges [ops_task_workflow_edge] | |
| Workflow Task Instance [ops_exec_workflow] | Workflow task instances. |
| Workflow Task Instance Edges [ops_exec_workflow_edge] | |
| Workflow Task Instance Vertices [ops_exec_workflow_vertex] | |
| Workflow Task Vertices [ops_task_workflow_vertex] | |
| z/OS Agent [ops_zos_agent] | z/OS agents. |
| z/OS Agent Cluster [ops_zos_agent_cluster] | z/OS agent groups. |
| z/OS Agent Cluster Relation [ops_zos_agent_cluster_join] | z/OS agent groups. |
| z/OS Restartable JobSteps [ops_exec_zos_jobstepsui] | |
| z/OS Restartable JobSteps ND [ops_exec_zos_jobsteps] | |
| z/OS Task [ops_task_zos] | z/OS tasks. |
| z/OS Task Instance [ops_exec_zos] | z/OS task instances |
