Report Commands

This page includes the following:

delete_report()

Delete saved report criteria.

Parameters:

report - name of a saved report

Dependencies:

Must be logged in
Need at least one saved report

Result:

Criteria of specified report is deleted

Example delete_report() command line usage:

>>> delete_report(report='report5') 
delete report "report5"
done

>>> delete_report('report5')

Example delete_report() script usage:

import sys
from jaws import *

login()
print 'begin' 
try:
      reps = reports() 
      for r in reps:
      delete_report(r) 

      print 'end'

finally:
      logout()

make_conversion_report()

Construct report criteria for the scheduler conversion report.

Parameters:

scheduler - name of the scheduler

Dependencies:

Must be logged in
Need at least one scheduler

Result:

ConversionReportCriteria constructed for specified scheduler, see ConversionReportCriteria

Example make_conversion_report() command line usage:

>>> make_conversion_report(scheduler='autosys45')
com.termalabs.dto.reporting.ConversionReportCriteria[identity=666319815,
    getSchedulerId()=UUID[402882aa4db54022014db56aa1ae4bef],
    getReportType()=CONVERSION_LOG_REPORT_TYPE,
    getName()=,
    getTimeZone()=TimeZone[America/Denver],
    getReportCriteriaId()=,
    getBeginDate()=CalendarDate[2015/06/30],
    getEndDate()=CalendarDate[2015/06/30],
    getDates()=[],
    getGroupBy()=ReportField[RUN_DATE],
    getSortBy()=ReportField[JOB_STREAM_NAME],
    isSortAscending()=true,
    getReportColumns()=[],
    getOutputFormat()=PDF,
    getPageOrientation()=AUTO,
    getPageSize()=US_LETTER,
    getMaximumPages()=20,
    getStartTimeOfDay()=,
    getEndTimeOfDay()=,
    getDaysOfWeek()=[MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY,
        SATURDAY, SUNDAY],
    isPublicReport()=false,
    getOwnerName()=,
    getOwnerDomainId()=,
    getDateMode()=RECENT_DAYS,
    getNoOfDays()=1,
    isIncludeCurrentDay()=true]

>>> make_conversion_report('autosys45')

Example make_conversion_report() script usage:

import sys
from jaws import *

login()
      print 'begin output' try:
      scheds = schedulers() for s in scheds:
        print s, make_conversion_report(s) 

      print 'end output'

finally:
      logout()

report_impl()

Get the Java object representing a saved report criteria.

Parameters:

name - name the report is saved under

Dependencies:

Must be logged in
Need at least one saved report

Result:

A JobStreamSummaryReportCriteria object representing the given report, see JobStreamSummaryReportCriteria

Example report_impl() command line usage:

>>> report_impl(name='jobstream summary')
com.termalabs.dto.reporting.JobStreamSummaryReportCriteria
[identity=1354863192,
    getReportType()=JOB_STREAM_SUMMARY_REPORT_TYPE,
    isIncludingCompleted()=true,
    isIncludingRunning()=false,
    isIncludingForecasted()=false,
    isIncludingNextForecastedOnly()=false,
    getForecastedRunWindow()=,
    getIncludedStates()=[LATE, ON_TIME, EARLY,
        EXCEEDS_SIMULATION_HORIZON, UNKNOWN, PREDICTION_TERMINATED],
    getApplicableStates()=[LATE, ON_TIME, EARLY,
        EXCEEDS_SIMULATION_HORIZON, UNKNOWN, PREDICTION_TERMINATED],
    getChartRuns()=false,
    getJobStreamSelector()=jobStreams: []; regexes: [];
        domains: [All Jobstreams],
    getName()=report1,
    getTimeZone()=TimeZone[America/Denver],
    getStartTimeOfDay()=,
    getEndTimeOfDay()=,
    getDaysOfWeek()=[MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY,
        SATURDAY, SUNDAY],
    isPublicReport()=false,
    getOwnerName()=admin,
    getOwnerDomainId()=,
    getDateMode()=RECENT_DAYS,
    getNoOfDays()=1,
    isIncludeCurrentDay()=true,
    getBeginDate()=CalendarDate[2015/06/30],
    getEndDate()=CalendarDate[2015/06/30],
    getDates()=[],
          getGroupBy()=ReportField[RUN_DATE],
    getSortBy()=ReportField[JOB_STREAM_NAME],
    isSortAscending()=true,
    getReportColumns()=[ReportField[JOB_STREAM_NAME], ReportField
        [TARGET_JOB_NAME], ReportField[TARGET_JOB_CONTAINER_PATH],
        ReportField[DURATION], ReportField[PCT_COMPLETE], ReportField
        [JOBS_IN_CRITICAL_PATH], ReportField[TOTAL_JOB_STREAM_TIME],
        ReportField[TOTAL_FINISH_START_LATENCY], ReportField[TOTAL_START_
        RUNNING_LATENCY], ReportField[TOTAL_AUTOSYS_LATENCY], ReportField
        [TOTAL_DESIGNED_DELAY], ReportField[TOTAL_OPERATIONAL_DELAY],
        ReportField[TOTAL_UNEXPECTED_DELAY], ReportField[
        TOTAL_NON_ AUTOSYS_DELAY], ReportField[TOTAL_OVERALL_DELAY],
        ReportField[EXPECTED_END_TIME], ReportField[EARLY_LATE],
        ReportField[BUSINESS_AREAS]],
    getOutputFormat()=PDF,
    getPageOrientation()=AUTO,
    getPageSize()=US_LETTER,
    getMaximumPages()=20,
    getReportCriteriaId()=UUID[402882aa4dda7964014e45971ecc0224]]

>>> report_impl('jobstream summary')

Example report_impl() script usage:

import sys
from jaws import *

login()
print 'begin output' 
try:
    reps = reports() 
    for r in reps:
      print r, report_impl(r) 

print 'end output'
 
finally:
   logout()

reports()

Get the names of all saved reports visible to the current user.

Parameters:

None

Dependencies:

Must be logged in

Result:

A list of saved reports

Example reports() command line usage:

>>> reports()
[u'termination_status', u'jobstream_detail', u'processing_load',

 u'trending_by_critical_path_history', u'jobstream_summary']

Example reports() script usage:

import sys
from jaws import *

login()
print 'begin output' 
try:
     reps = reports() for 
     r in reps:
       print r

     print 'end output' 

finally:
     logout()

run_report()

Run a report, given a Java object representing the criteria (see Report Commands).

Note: If the AAI server is not running on the default port, select_server() should be used prior to making this call, or the URL will have the wrong port, see select_server.

Parameters:

report - name of a saved report, or else the internal Java representation of the report's settings
keep_for_days (optional) - determines how long the report is retained on the server, allowing time for people to download it

Default: 1.0

Dependencies:

Must be logged in
Must have at least one saved report

Result:

A URL which can be used to retrieve the resulting report

Example run_report() command line usage:

>>> run_report(report='jobstream_detail', keep_for_days=7) 
run saved report "jobstream_detail"
done 
u'http://aai_user.broadcom.net:8080/aai/report/1436295123470.pdf'

Example run_report() script usage:

import sys
from jaws import *

login()
print 'begin output' 
try:
    reps = reports() 
    for r in reps:
      run_report(r, keep_for_days=7) 

    print 'end output'

finally:
    logout()

save_report()

Save a report criteria, given a Java object representing the criteria

Parameters:

report_impl - internal Java representation of the report's settings, as given by report_impl(), see report_impl().

Dependencies:

Must be logged in
Must have at least one saved report

Result:

Given report saved

Example save_report() command line usage:

>>> save_report(report_impl=report_impl('jobstream_detail')) 
save report "jobstream_detail"
done

>>> save_report(report_impl('jobstream_detail'))

Example save_report() script usage:

import sys
from jaws import *

login()
print 'begin' 
try:
    reps = reports() 
    for r in reps:
      save_report(report_impl(r)) 

    print 'end'

finally:
    logout()