...

Introduction

• User Users might be interested to in automatically receive reports about past job executions.receiving reports about the JS7 - Task History, listing which jobs have been executed, the date and time at which they were executed and the respective execution result.
  • Such reports include similar information to that which is available in the JOC Cockpit's Task History view
  • The reports include the same information as available from the JOC Cockpit History view for tasks.
  • The reports are provided as Excel® files similar to what is those which are available for export from the JOC Cockpit Task History view.
• The report These reports can be scheduled e.g. , for example on a daily basis or more frequently to report about past job , to provide ongoing information about completed tasks and execution results.

...

Report the Task History from a

...

Job

Task History reports can be automated by JS7 jobs. The following PowerShell modules are used The PowerShell CLI is used by jobs to create reports. Two modules are applied for this purpose:

• the JobScheduler JS7 PowerShell Module to access the JS7 - REST Web Service API.
• ImportExcel PowerShell Module (3rd party) a reporting PowerShell Module. This example makes use of the ImportExcel PowerShell Module that can be used to create Excel® reports on Windows and Linux.

The Get-JobSchedulerTaskHistoryJS7TaskHistory cmdlet is used to retrieve task history Task History items and to forward them to the ImportExcel module within a job. Two flavors of the job are available for Windows and Linux. The difference is not about the handling of cmdlets or parameters but due to the fact that PowerShell is invoked differently on Windows and Linux. For Windows environments usually PowerShell is available with the OS, for Linux the job has to call pwsh to invoke the PowerShell.

Find a sample report: jobscheduler_reporting.xlsx

Please consider that below jobs are examples that have to be adjusted for your environment.

Windows Version

The job is the same for Windows and Unix.

A sample report is available for download which includes the report's Task-History worksheet: jobscheduler_reporting.xlsx

First Line of the Job

The only difference between platforms is the way in which PowerShell is invoked with the first line of the job.

#!/usr/bin/env pwsh

Explanation:

• Use of a shebang allows the pwsh PowerShell executable to be invoked.

@@findstr/v "^@@f.*&" "%~f0"|pwsh.exe -&goto:eof

Explanation:

• Credits for the Windows shebang replacement go to How to run a PowerShell script within a Windows batch file.
• If you consider this shebang replacement somewhat cryptic then add it to JS7 - Script Includes which are easily referenced from a shell job, for example, by using ##!include pwsh.
• The PowerShell executable pwsh.exe is available starting from PowerShell 6.0. PowerShell releases 5.x use the powershell.exe executable which can be specified accordingly with the shebang.

Job Implementation

Please note that the job listed below is an example which has to be modified for your environment.

Download (.json upload): jdTaskHistoryReport.workflow.jsonDownload: report_task_history_windows.job.xml

<?xml version="1.0" encoding="UTF-8" ?>
<job title="Report Task History" process_class="agent_windows">
  <script language="powershell"><![CDATA[
Import-Module $env:SCHEDULER_DATA/config/powershell/Modules/ImportExcel;
Import-Module $env:SCHEDULER_DATA/config/powershell/Modules/JobScheduler;

Connect-JS -Url $JOCCockpitUrl -Credential $JOCCockpitCredential@@findstr/v "^@@f.*&" "%~f0"|pwsh.exe -&goto:eof

Import-Module ImportExcel
Import-Module JS7

$credentials = ( New-Object -typename System.Management.Automation.PSCredential -ArgumentList 'root', ( 'root' | ConvertTo-SecureString -AsPlainText -Force) )
Connect-JS7 -Url $env:JS7_JOC_URL -Credentials $credentials -Id $env:JS7_CONTROLLER_ID | Out-Null;

# Dates in local timezonetime zone, output includes local date format
Get-JSTaskHistory -Timezone (Get-Timezone) )-RelativeDateFrom -3d `
                |  Select-Object -Property @{name="JobSchedulerController ID"; expression={$_.jobschedulerIdcontrollerId}}, `
                                           @{name="TaskAgent IDURL"; expression={$_.taskIdagentUrl}}, `
                                           @{name="JobTask History ID"; expression={$_.jobtaskId}}, `
                                           @{name="StatusOrder ID"; expression={$_.state._textorderId}}, `
                                           @{name="StartOrder TimeStatus"; expression={ Get-Date $_.state.startTime _text}}, `
                                           @{name="EndOrder TimePosition"; expression={ Get-Date $_.endTime position}}, `
                                           @{name="Duration (sec.)Workflow"; expression={ (New-Timespan -Start "$($_.startTime)" -End "$($_.endTime)").Seconds workflow}}, `
                                           @{name="CriticalityJob"; expression={$_.criticalityjob}}, `
                                           @{name="Exit CodeCriticality"; expression={$_.exitCodecriticality}}, `
                | Export-Excel -Path /tmp/jobscheduler_reporting.xlsx -WorksheetName "Task-History" -ClearSheet;
				
Write-Output ".. report created: /tmp/jobscheduler_reporting.xls";
]]></script>
  <run_time/>
</job>

Explanations

• Line 2-3: The job is executed with a Windows Agent that is assigned by a process class. The job is of type "powershell" and will use the Powershell version provided with the server.
• Line 4-5: The required PowerShell modules are imported. They could be installed with any location in the file system
• Line 7: The Connect-JS cmdlet is used to authenticate with the JOC Cockpit REST Web Service. The required URL and credentials are specified in a PowerShell profile, see PowerShell CLI 1.2 - Use Cases - Credentials Management
• Line 10: The Get-JSTaskHistory cmdlet is called 
  • with the parameter -Timezone to specify to which timezone date values in the report should be converted. The parameter value -Timezone (Get-Timezone) specifies that the timezone of the Agent's server is used. Otherwise specify the desired timezone e.g. like this: -Timezone (Get-Timezone -Id 'GMT Standard Time'). Without using this parameter any date values are stored as UTC dates to the report.
  • optionally with additional parameters, e.g. to specify the date range for which the report is created  A value -DateFrom (Get-Date -Hour 0 -Minute 0 -Second 0).AddDays(-7).ToUniversalTime() specifies that the report should cover the last 7 days (from midnight). Keep in mind that dates have to be specified for the UTC timezone. Without this parameter the report will be created for the last day.
  • see the Get-JSTaskHistory cmdlet for a full parameter reference.
• Line 11-19: From the output of the Get-JSTaskHistory cmdlet a number of properties are selected and and are specified for the sequence in which they should occur in the report. 
  • To add more speaking column headers the property names are mapped to a more readable textual representation.
  • Consider the handling of date formats in lines 15, 16. Use of the Get-Date cmdlet converts the output format of dates (not the timezone) to the default format that is in place on the Agent's server. Without using the Get-Date cmdlet any date values will be stored to the report in ISO format, e.g. 2020-12-31 10:11:12+02:00 for a date in the European central timezone that is UTC+1 in winter time and UTC+2 in summer time.
  • Lines 17 introduces a new property, a calculated duration. From the start time and end time values of a past start the difference in seconds is calculated and is forwarded to the report.
• Line 20: The list of properties per task history item is piped to the Export-Excel cmdlet that is available with the ImportExcel PowerShell Module. The report file name is specified and optionally the worksheet. For a full list of parameters see the ImportExcel PowerShell Module.

Linux Version

Download: report_task_history_linux.job.xml

<?xml version="1.0" encoding="UTF-8" ?>
<job title="Report Task History" process_class="agent_linux">
  <script language="shell"><![CDATA[
pwsh -NoLogo -NonInteractive -Command '& {
    . $env:SCHEDULER_DATA/config/powershell/JobScheduler.PowerShell_profile.ps1;
    Import-Module $env:SCHEDULER_DATA/config/powershell/Modules/ImportExcel;@{name="Sequence"; expression={$_.sequence}}, `
    Import-Module $env:SCHEDULER_DATA/config/powershell/Modules/JobScheduler;

    Connect-JS -Url $JOCCockpitUrl -Credential $JOCCockpitCredential | Out-Null;

    # Dates in local timezone, output includes local date format
    Get-JSTaskHistory -Timezone (Get-Timezone ) `
                |  Select-Object -Property @{name="JobSchedulerRetry IDCounter"; expression={$_.jobschedulerIdretryCounter}}, `
                                           @{name="TaskExit IDCode"; expression={$_.taskIdexitCode}}, `
                                           @{name="JobHistory Status"; expression={$_.jobstate._text}}, `
                                           @{name="StatusArguments"; expression={$_.state._textarguments}}, `
                                           @{name="Start Time"; expression={ Get-Date $_.startTime }}, `
                                           @{name="End Time"; expression={ Get-Date $_.endTime }}, `
                                           @{name="Duration (sec.)"; expression={ (New-Timespan -Start "$($_.startTime)" -End "$($_.endTime)").Seconds }}, `
                                           @{name="Criticality"; expression={$_.criticality}}, `
                                           @{name="Exit Code"; expression={$_.exitCode}} `
                | Export-Excel -Path /tmp/jobscheduler_reporting.xlsx -WorksheetName "Task-History" -ClearSheet;

    Write-Output ".. report created: /tmp/jobscheduler_reporting.xls";
}'
]]></script>
  <run_time/>
</job>
</job>

Explanations

xlsx"				

Explanation:

• Line 1: The job is executed with a Windows Agent and makes use of the PowerShell shebang for Windows, as described above.
• Line 3-4: The necessary PowerShell modules are imported. They could be installed in any location in the file system
• Line 6-7: The Connect-JS7 cmdlet is used to authenticate with the JS7 REST Web Service API. The required arguments for -Url , -Credentials and -Id can specified in a number of ways:
  • As described in the JS7 - How to connect to JOC Cockpit using the PowerShell Module article.
  • Using JS7 - Job Resources which inject environment variables to the PowerShell job.
  • Using a PowerShell profile.
• Line 10: The Get-JS7TaskHistory cmdlet is invoked:
  • with the -Timezone parameter to specify which time zone the date values in the report should be converted to. The -Timezone (Get-Timezone) parameter value specifies that the time zone of the Agent's server is used. Otherwise specify the desired time zone, for example like this: -Timezone (Get-Timezone -Id 'GMT Standard Time'). Without using this parameter any date values are stored in the report as UTC dates.
  • optionally with additional parameters, for example to specify the date or date range which the report is created for. A value -RelativeDateTo -3d specifies that the report should cover the last 3 days (until midnight). Keep in mind that dates have to be specified for the UTC time zone. Without this parameter the report will be created for the next day.
  • see the Get-JS7TaskHistory cmdlet for a full parameter reference.
• Line 11-28: From the output of the Get-JS7TaskHistory cmdlet a number of properties are selected and are specified for the sequence in which they should occur in the report. 
  • To add more appropriate column headers the property names are mapped to a more readable textual representation.
  • Consider the handling of date formats in line 17-21. Use of the Get-Date cmdlet converts the output format of dates (not the time zone) to the default format which is in place on the Agent's server. Without using the Get-Date cmdlet any date values will be stored in the report in ISO format, e.g. 2020-12-31 10:11:12+02:00 for a date in the European central time zone that is UTC+1 in winter time and UTC+2 in summer time.
  • Line 28 introduces a new property, a calculated duration. From the start time and end time values of a planned start the difference in seconds is calculated and is added to the report.
• Line 29: The list of properties for every Task History item is piped to the Export-Excel cmdlet which is available with the ImportExcel PowerShell Module. The report file name is specified and optionally the worksheet. For a full list of parameters see the ImportExcel PowerShell Module
• Basically the same explanations as for the Windows version of the job apply.
• Line 4: The PowerShell has to be invoked with pwsh. Consider that any subsequent PowerShell commands are quoted within a string that starts with line 3 and that ends with line 29. 
  • As the string is using a single quote all subsequent PowerShell commands make use of double quotes when required.
  • You could apply a different quoting style, however, quotes have to be consistent.
• Line 5: As an example a PowerShell profile is invoked that provides the variables for URL and credentials to access the JOC Cockpit REST Web Service. Such profiles can be stored in different locations and can be invoked automatically by pwsh on startup.