Page History

...

the JobScheduler PowerShell Module
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-JobSchedulerDailyPlanJobSchedulerTaskHistory cmdlet is used to retrieve daily plan 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.

...

Windows Version

Download: report_dailytask_planhistory_windows.job.xml

Code Block

language	powershell
title	Task History Report (Windows version)
linenumbers	true
collapse	true

<?xml version="1.0" encoding="UTF-8" ?>
<job title="Report Task History" process_class="agent_windows">
  <settings/>
  <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 | Out-Null;

# Dates in local timezone, output includes local date format
Get-JSTaskHistory -Timezone (Get-Timezone ) `
                |  Select-Object -Property @{name="JobScheduler ID"; expression={$_.jobschedulerId}}, `
                                           @{name="Task ID"; expression={$_.taskId}}, `
                                           @{name="Job"; expression={$_.job}}, `
                                           @{name="Status"; expression={$_.state._text}}, `
                                           @{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>

...

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: For better readability of the report the start types of jobs are mapped to a textual representation (single start, cyclic start etc.).Line 13: 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 1411-2619: 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 line 21, 22 and 24, 25lines 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 23, 26 introduce 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 2720: The list of properties per daily plan 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_dailytask_planhistory_linux.job.xml

Code Block

language	powershell
title	Daily Plan Task History Report (Linux version)
linenumbers	true
collapse	true

<?xml version="1.0" encoding="ISOUTF-8859-18" ?>
<job title="Report DailyTask PlanHistory" 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;
	    Import-Module $env:SCHEDULER_DATA/config/powershell/Modules/JobScheduler;

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

	# start mode mapping
	$startModes = @{"0"="single start"; "1"="repeat start-start"; "2"="repeat end-start"}

	# Dates in local time zonetimezone, output includes local date format
	    Get-JSDailyPlanJSTaskHistory -Timezone (Get-Timezone ) `
                |  Select-Object -Property @{name="JobJobScheduler Chain/JobID"; expression={ "$($_.jobChain)$($_.job)"jobschedulerId}}, `
                                           @{name="OrderTask ID"; expression={$_.orderIdtaskId}}, `
                                           @{name="Status"; expression={$_.state._text}}, `
                                           @{name="Job Stream"; expression={$_.jobStreamjob}}, `
                                           @{name="LateStatus"; expression={$_.late}}, `
                                           @{name="Start Type"; expression={ $startModes[ "$($_.startMode)"] }}, `
                                           @{name="Repeat Interval"; expression={$_.period.repeatstate._text}}, `
                                           @{name="Planned Start Time"; expression={ Get-Date $_.plannedStartTimestartTime }}, `
                                           @{name="Expected End Time"; expression={ Get-Date $_.expectedEndTimeendTime }}, `
                                           @{name="Expected Duration (sec.)"; expression={ (New-Timespan -Start "$($_.plannedStartTimestartTime)" -End "$($_.expectedEndTimeendTime)").Seconds }}, `
                                           @{name="Start TimeCriticality"; expression={ Get-Date $_.startTime criticality}}, `
                                           @{name="EndExit TimeCode"; expression={ Get-Date $_.endTime exitCode}}, `
                                           @{name="Duration (sec.)"; expression={ (New-Timespan -Start "$($_.startTime)" -End "$($_.endTime)").Seconds }} `| Export-Excel -Path /tmp/jobscheduler_reporting.xlsx -WorksheetName "Task-History" -ClearSheet;

    Write-Output ".. report          | Export-Excel -Path created: /tmp/jobscheduler_reporting.xlsx -WorksheetName "Daily-Plan" -ClearSheetxls";
}'
]]></script>
  <run_time/>
</job>
</job>

ExplantionsExplanations

Basically the same explanations as for the Windows version of the job apply.
Line 34: 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 45: 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.

...

Space shortcuts

Page tree

Versions Compared

Old Version 2

New Version Current

Key

Windows Version

Linux Version