- 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 in 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: Create an object
$reportDatafrom the output of the Get-JSTaskHistory cmdlet in which a number of properties are selected and are specified for the sequence in which they should occur in the report.
- Line 21: The location where the Excel file will be saved is specified with the
- Line 23: Create a variable
$workSheetNamethat is used to store the name of the worksheet.
- Line 25-30: Creates a spreadsheet and passes on the Excel Package object which provides the reference to the workbook and turns to the worksheets inside it.
$xlsxFilestores the path of the Excel® file.
- If we are updating an existing worksheet and the new data wouldn’t completely cover the area consumed by previous data, then we may be left with “ghost” data. To ensure this doesn’t happen, we can use the
-ClearSheetoption to remove previous data in a worksheet.
-PassThrureturns the Pivot Table so it can be customized.
-AutoSizeparameter allows us to resize the columns of the spreadsheet to fit the data added and to get the column-widths right.
- For adding color to conditional text
-ConditionalTextis used. Additional types of conditional format are supported. Here we use conditional text for the job status color like (successful=green, incomplete=orange, failed=red).
To assign a name to the worksheet the
-WorksheetNameparameter is used. The default name of the worksheet is sheet1.
- The -
IncludePivotChartparameters generate the Pivot Table and Pivot Chart. The parameter -
ChartTypelets you pick what type of chart you want to use, there are many examples to choose from: Area, Line, Pie, ColumnClustered, ColumnStacked100, ColumnClustered3D, ColumnStacked1003D, BarClustered, BarOfPie, Doughnut, etc.
- The -
PivotDataparameters describe how to tabulate the data.
- Line 3334: The
-PivotTableNameparameter is used as the name for the new Pivot Table.
- Line 3435: By default, a Pivot Table will be created in its own worksheet, but it can be created in an existing worksheet. In the above job example the
$excel.$WorkSheetName.cells["K1"]parameter defines the cell in an existing worksheet where the pivot table will be created.
- Line 3536:
$excel.$WorkSheetNamerefers to the worksheet in which the source data are found.
- Line 3637: The
-PivotRowsparameter is used for fields to set as rows in the Pivot Table.
- Line 3738: The
-PivotDataparameter contains a hash table in the form "FieldName"="Function," where a function is one of Average(), Count(), CountNums(), Max(), Min(), Product(), None(), StdDev(), StdDevP(), Sum(), Var(), VarP().
- Line 3839: To apply a table style to the Pivot Table the
-PivotTableStyleparameter is used. The PivotTableStyle “Medium6” is the default table style but there are plenty of others to choose from. Example: PivotTableStyles = None, Custom, Light1 to Light21, Medium1 to Medium28, Dark1 to Dark11".