en-US/about_UkgProReports.help.txt
|
TOPIC
about_UkgProReports SHORT DESCRIPTION UkgPro.Reports is a PowerShell module that lets you run UKG Pro Reports-as-a-Service reports and return the output as PowerShell objects. LONG DESCRIPTION UkgPro.Reports is a compiled C# module that calls the UKG Pro Reports-as-a-Service SOAP API over HTTPS. Use it to authenticate with a UKG Pro service account or web user, list available reports, inspect parameters, run reports, and return CSV rows, raw text, or XML. The module supports Windows PowerShell 5.1 and PowerShell 7 on Windows, Linux, and macOS. It keeps credentials, access keys, and UKG session tokens in process memory and does not write them to disk. SESSIONS Connect-UkgProReportService authenticates and returns a UkgProReportSession object. The returned session is stored as the current in-memory session, so later commands (Get-UkgProReport, Get-UkgProReportParameter, Invoke-UkgProReport) work without passing -Session. The current session applies to the whole PowerShell process. Sessions do not carry over to another process or across PowerShell remoting boundaries. Pass -Session when you work with more than one session. Use Disconnect-UkgProReportService to log off when you are done. CREDENTIALS AND ACCESS KEYS Authentication requires: - A UKG Pro service account or web user credential (username and password). - The client access key from the UKG Pro Web Services administrative page. - The user access key for the service account or web user. Keys and passwords stay in memory. Use Get-Credential or a secret store such as the SecretManagement module instead of putting secrets in scripts. REPORT PARAMETERS Reports may require input parameter values. Get-UkgProReportParameter returns parameter metadata (name, data type, whether the parameter is required, and whether it is multi-valued) for a report path. New-UkgProReportParameter creates a typed parameter value. For simple cases you can also pass a hashtable of name/value pairs directly to Invoke-UkgProReport. OUTPUT Invoke-UkgProReport returns parsed rows (PSObject) by default. Use -As RawText for decoded text, -As Xml for XML report output, or -OutFile to write the output directly to a file without sending it through the pipeline. UKG recommends creating smaller reports because report downloads are subject to a 5-minute service timeout. For large report output, prefer -OutFile over parsing into the pipeline. SEE ALSO Connect-UkgProReportService Disconnect-UkgProReportService Get-UkgProReport Get-UkgProReportParameter Invoke-UkgProReport New-UkgProReportParameter |