JS7 JobScheduler

Space shortcuts

Page tree

Versions Compared

Old Version 6

changes.mady.by.user Andreas Püschel

Saved on

compared with

New Version 7

changes.mady.by.user Alan Amos

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Introduction

  • User might be interested to in automatically receive receiving reports about the JS7 - Audit Log that state what changes have been applied to scheduling objects have been applied , at what date and time, by whom and for what reason.
    • Such reports include similar information as available from the JOC Cockpit's Audit Log view.
    • The reports are provided as Excel® files similar to what is those that are available for export from the JOC Cockpit Audit Log view.
  • Such reports can be scheduled, for example on a daily basis, to provide ongoing information about changes to scheduling objects.

...

The Get-JS7AuditLog cmdlet is used to retrieve Audit Log items and to forward them to the ImportExcel module within a job. The job is the same for Windows and Unix.

Find a A sample report is available for download that also includes the report with its 's Audit-Log worksheet: jobscheduler_reporting.xlsx

...

  • 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 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 executable powershell.exe that can be specified accordingly with the shebang.

Job Implementation

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

Download (.json upload): jdAuditLogReport.workflow.json

...

  • Line 1: The job is executed by with a Windows Agent and makes use of the PowerShell shebang for Windows, see as explained above explanation.
  • Line 3-4: The required PowerShell modules are imported. They could be installed with 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 arguments required arguments for -Url , -Credentials and -Id can specified in a number of ways:
  • Line 10: The Get-JS7AuditLog cmdlet is invoked:
    • with the parameter -Timezone to specify to parameter which specifies which time zone date values in the report should be converted to. The parameter value -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 When this parameter is not specified then any date values are will be stored as UTC dates to in the report.
    • optionally with additional parameters, for example to specify the date or date range for which the report is created  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 appropriate column headers the property names are mapped to a more readable textual representation.
    • Consider Note 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 for each Audit Log item is piped to the Export-Excel cmdlet that 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 article.

Further Resources

  • The Audit Log Report does not include information about login/logout of information for user accounts. In some countries such information is subject to data protection laws. Therefore this information is available exclusively with a log file that is accessible to system administrators and that can be used in compliance with applicable law.
  • Reporting is by nature is about the past. Users who look for in-real time information can consider to directly report reporting Audit Log output directly to a syslog server.

...