UcmPsTools Documentation
  • Welcome! - UcmPsTools
  • Using UcmPsTools
    • QuickStart
    • About UcmPSTools
    • Using UcmPsTools in your Automation
    • Cmdlet Reference
      • Accounts and Voice Apps
        • New-UcmOffice365User -todo
        • New-UcmTeamsResourceAccount - todo
      • Auditing and Planning
        • Measure-UcmOnPremNumberRange
      • Call Management
        • New-UcmCsFixedNumberDiversion
      • Connections and Modules
      • Licences and Service Plans
      • Reporting and Logging
        • Complete-UcmReport
        • Export-UcmCSVReport
        • Export-UcmHTMLReport
        • Initialize-UcmReport
        • New-UcmReportItem
        • New-UcmReportStep
        • Search-UcmCsOnPremNumberRange
        • Write-UcmLog
    • Example Scripts
  • UcmPsTools In Depth
    • More about UcmPsTools
    • Security In UcmPsTools
    • UcmPsTools Cmdlet Status Reporting
  • Contributing to UcmPsTools
    • New Function Rules
    • Pull Process
Powered by GitBook
On this page
  • Description
  • Parameters
  • Notes
  • Example
  • Inputs
  • Outputs
  1. Using UcmPsTools
  2. Cmdlet Reference
  3. Reporting and Logging

Initialize-UcmReport

Checks for clears and creates a new object to store status for reporting later.

PreviousExport-UcmHTMLReportNextNew-UcmReportItem

Last updated 2 years ago

For a full overview, check

Description

Creates a new PSCustomObject to store a report. Must be called before or

Parameters

Title: "HTML Report" SubTitle: "The results were as follows" StartDate: (Get-Date -format dd.MM.yy.hh.mm) NiceDate: (Get-Date -displayhint datetime)

Notes

This function will create a few global variables, including the two below which specify the filenames for CSV or HTML reports. by default, the filename is based on the Title parameter and the time the report was initialized.

 $Global:HTMLReportFilename=".\$Title - $StartDate.html"
 $Global:CSVReportFilename=".\$Title - $StartDate.csv"

Once the report has been initialized, these variables can be updated to change the filenames before or are called.

Example

Initialize-UcmReport

Inputs

This function accepts no inputs

Outputs

This function does not create pipelined output

About UCM Reporting Cmdlets
New-UcmReportItem
New-UcmReportStep
Export-UcmCsvReport
Export-UcmHtmlReport