JS7 JobScheduler

Space shortcuts

Page tree

Introduction

  • Users might be interested in automatically receiving reports about the JS7 - Daily Plan which list the scheduled workflows and the date and time when they are executed.
    • Such reports include similar information to that which is available in the JOC Cockpit's Daily Plan view.
    • The reports are provided as Excel® files similar to those which are available for export from the JOC Cockpit Daily Plan view.
  • These reports can be scheduled, for example on a daily basis, to provide ongoing information about completed orders and timed orders for workflow execution.

Report the Daily Plan from a Job

Daily Plan reports can be automated by by JS7 jobs. The following PowerShell modules are used for this purpose:

The Get-JS7DailyPlanOrder cmdlet is used to retrieve Daily Plan items and to forward them to the ImportExcel module within a job. The job is the same for Windows and Unix.

Find a sample report for download that includes the report with its Daily-Plan worksheet: jobscheduler_reporting.xlsx

First Line of the Job

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

Shebang for PowerShell Job with Unix
#!/usr/bin/env pwsh

Explanation:

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


Shebang for PowerShell Job with Windows
@@setlocal enabledelayedexpansion & set f=%RANDOM%.ps1 & @@findstr/v "^@@[fs].*&" "%~f0" > !f! & powershell.exe -NonInteractive -File !f! & set e=!errorlevel! & del /q !f! & exit !e!/b&

Explanation:

  • Credits for the Windows shebang replacement 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 that 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 executable powershell.exe that 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): jdDailyPlanReport.workflow.json


Daily Plan Report Job
@@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

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

# Dates in local time zone, output includes local date format
Get-JS7DailyPlanOrder -Timezone (Get-Timezone) `
                |  Select-Object -Property @{name="Workflow"; expression={$_.workflowPath}}, `
                                           @{name="Order ID"; expression={$_.orderId}}, `
                                           @{name="Status"; expression={$_.state._text}}, `
                                           @{name="Order Name"; expression={$_.orderName}}, `
                                           @{name="Late"; expression={$_.late}}, `
                                           @{name="Start Type"; expression={ $startModes["$($_.startMode)"] }}, `
                                           @{name="Repeat Interval"; expression={$_.period.repeat}}, `
                                           @{name="Planned Start Time"; expression={ Get-Date $_.plannedStartTime }}, `
                                           @{name="Expected End Time"; expression={ Get-Date $_.expectedEndTime }}, `
                                           @{name="Expected Duration (sec.)"; expression={ (New-Timespan -Start "$($_.plannedStartTime)" -End "$($_.expectedEndTime)").Seconds }}, `
                                           @{name="Start Time"; expression={ Get-Date $_.startTime }}, `
                                           @{name="End Time"; expression={ Get-Date $_.endTime }}, `
                                           @{name="Duration (sec.)"; expression={ (New-Timespan -Start "$($_.startTime)" -End "$($_.endTime)").TotalSeconds }} `
                | Export-Excel -Path /tmp/jobscheduler_reporting.xlsx -WorksheetName "Daily-Plan" -ClearSheet
				
Write-Output ".. report created: /tmp/jobscheduler_reporting.xlsx"

Explanations

  • Line 1: The job is executed with a Windows Agent and uses the PowerShell shebang for Windows, as explained above.
  • Line 3-4: The required PowerShell modules are imported. They could be installed at 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:
  • 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-JS7DailyPlanOrder cmdlet is invoked
    • with the -Timezone parameter to specify which time zone 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 the desired time zone can be specified, for example like this: -Timezone (Get-Timezone -Id 'GMT Standard Time').
    • When this parameter is not specified then any date values will be stored in the report as UTC dates.
    • optionally with additional parameters, for example to specify the date or date range which the report is being created for. A value -RelativeDateTo +7d specifies that the report should cover the next 7 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-JS7DailyPlanOrder cmdlet for a full parameter reference.
  • Line 14-26: From the output of the Get-JS7DailyPlanOrder 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 appropriate column headers the property names are mapped to a more readable textual representation.
    • Note the handling of date formats in line 21-25. Use of the Get-Date cmdlet converts the output format of dates (not the time zone) 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 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 which is UTC+1 in winter time and UTC+2 in summer time.
    • Lines 23, 26 introduce a new property, a calculated duration. This is the difference in seconds between the start time and end time values of a planned start and optionally of a past start, which is calculated and forwarded to the report.
  • Line 27: The list of properties per Daily Plan 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.