Page History

...

#!/usr/bin/env pwsh

...

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

...

@@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 time zone, output includes local date format
Get-JS7AuditLog -Timezone (Get-Timezone) `
                |  Select-Object -Property @{name="Account"; expression={$_.account}}, `
                                           @{name="Category"; expression={$_.category}}, `
                                           @{name="Controller ID"; expression={$_.controllerId}}, `
                                           @{name="ID"; expression={$_.id}}, `
                                           @{name="Parameters"; expression={$_.parameters}}, `
                                           @{name="Request"; expression={$_.request}}, `
                                           @{name="Created"; expression={(Get-Date $_.created)}} `
                | Export-Excel -Path /tmp/jobscheduler_reporting.xlsx -WorksheetName "Audit-Log" -ClearSheet
							
Write-Output ".. report created: /tmp/jobscheduler_reporting.xlsx"

ExplanationsExplanation:

• Line 1: The job is executed with a Windows Agent and makes use of the PowerShell shebang for Windows, see above explanation.
• Line 3-4: The required PowerShell modules are imported. They could be installed with 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:
  • Consider JS7 - How to connect to JOC Cockpit using the PowerShell Module.
  • Use of JS7 - Job Resources that inject environment variables to the PowerShell job.
  • Use of a PowerShell profile.
• Line 10: The Get-JS7AuditLog cmdlet is invoked
  • with the parameter -Timezone to specify to which time zone date values in the report should be converted. The parameter value -Timezone (Get-Timezone) 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 as UTC dates to the report.
  • optionally with additional parameters, for example to specify the date or date range for which the report is created  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-JS7AuditLog cmdlet for a full parameter reference.
• Line 11-17: From the output of the Get-JS7AuditLog 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 17 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 to 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 18: The list of properties per Audit Log 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.

...