UkgPro.Reports

1.0.0

en-US/UkgPro.Reports-help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Connect-UkgProReportService</command:name>
      <command:verb>Connect</command:verb>
      <command:noun>UkgProReportService</command:noun>
      <maml:description>
        <maml:para>Authenticates to the UKG Pro Reports-as-a-Service BI data service.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Connect-UkgProReportService calls the UKG Pro BI Data Service LogOn operation using a service account or web user credential, client access key, and user access key. The command returns a UkgProReportSession object and stores it as the current in-memory session for subsequent commands.</maml:para>
      <maml:para>No credentials, API keys, or UKG session tokens are persisted by the module.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Connect-UkgProReportService</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>BaseUri</maml:name>
          <maml:description>
            <maml:para>Specifies the UKG Pro services base URI. For example, `https://service2.ultipro.com/services`.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue>
          <dev:type>
            <maml:name>Uri</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>Credential</maml:name>
          <maml:description>
            <maml:para>Specifies the UKG Pro service account or web user credential.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue>
          <dev:type>
            <maml:name>PSCredential</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>ClientAccessKey</maml:name>
          <maml:description>
            <maml:para>Specifies the client access key from UKG Pro Web Services administration.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>String</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>UserAccessKey</maml:name>
          <maml:description>
            <maml:para>Specifies the user access key for the service account or web user.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>String</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>BaseUri</maml:name>
        <maml:description>
          <maml:para>Specifies the UKG Pro services base URI. For example, `https://service2.ultipro.com/services`.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue>
        <dev:type>
          <maml:name>Uri</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>Credential</maml:name>
        <maml:description>
          <maml:para>Specifies the UKG Pro service account or web user credential.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue>
        <dev:type>
          <maml:name>PSCredential</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>ClientAccessKey</maml:name>
        <maml:description>
          <maml:para>Specifies the client access key from UKG Pro Web Services administration.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>UserAccessKey</maml:name>
        <maml:description>
          <maml:para>Specifies the user access key for the service account or web user.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>None</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>UkgPro.Reports.Models.UkgProReportSession</maml:name>
        </dev:type>
        <maml:description>
          <maml:para>Returns a connected UKG Pro report session.</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para>Use Disconnect-UkgProReportService when the report workflow is complete.</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>------ Example 1: Connect to UKG Pro Reports-as-a-Service ------</maml:title>
        <dev:code>$connectSplat = @{
    BaseUri = 'https://service2.ultipro.com/services'
    Credential = Get-Credential
    ClientAccessKey = 'CLIENT_ACCESS_KEY'
    UserAccessKey = 'USER_ACCESS_KEY'
}
 
$session = Connect-UkgProReportService @connectSplat</dev:code>
        <dev:remarks>
          <maml:para>Authenticates to UKG Pro and stores the returned session as the current module session.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Disconnect-UkgProReportService</maml:linkText>
        <maml:uri></maml:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Disconnect-UkgProReportService</command:name>
      <command:verb>Disconnect</command:verb>
      <command:noun>UkgProReportService</command:noun>
      <maml:description>
        <maml:para>Ends a UKG Pro Reports-as-a-Service session.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Disconnect-UkgProReportService calls the BI Data Service LogOff operation for the supplied session. If no session is supplied, the command logs off the current in-memory session.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Disconnect-UkgProReportService</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none">
          <maml:name>Session</maml:name>
          <maml:description>
            <maml:para>Specifies the session to disconnect. If omitted, the current connected session is used.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">UkgProReportSession</command:parameterValue>
          <dev:type>
            <maml:name>UkgProReportSession</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>Current session</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none">
        <maml:name>Session</maml:name>
        <maml:description>
          <maml:para>Specifies the session to disconnect. If omitted, the current connected session is used.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">UkgProReportSession</command:parameterValue>
        <dev:type>
          <maml:name>UkgProReportSession</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>Current session</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
        <maml:name>Confirm</maml:name>
        <maml:description>
          <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false"></command:parameterValue>
        <dev:type>
          <maml:name></maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
        <maml:name>WhatIf</maml:name>
        <maml:description>
          <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false"></command:parameterValue>
        <dev:type>
          <maml:name></maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>UkgPro.Reports.Models.UkgProReportSession</maml:name>
        </dev:type>
        <maml:description>
          <maml:para>You can pipe a session object to this cmdlet.</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>None</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para>The module does not persist session state beyond the current PowerShell process.</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>--------------- Example 1: Disconnect a session ---------------</maml:title>
        <dev:code>Disconnect-UkgProReportService -Session $session</dev:code>
        <dev:remarks>
          <maml:para>Logs off the provided session.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>---------- Example 2: Disconnect the current session ----------</maml:title>
        <dev:code>Disconnect-UkgProReportService</dev:code>
        <dev:remarks>
          <maml:para>Logs off the current in-memory session.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Connect-UkgProReportService</maml:linkText>
        <maml:uri></maml:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Get-UkgProReport</command:name>
      <command:verb>Get</command:verb>
      <command:noun>UkgProReport</command:noun>
      <maml:description>
        <maml:para>Gets reports available to the connected UKG Pro user.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Get-UkgProReport calls the UKG Pro Reports-as-a-Service GetReportList operation and returns reports available to the authenticated account.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-UkgProReport</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">
          <maml:name>Session</maml:name>
          <maml:description>
            <maml:para>Specifies the connected UKG Pro report session. If omitted, the current connected session is used.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">UkgProReportSession</command:parameterValue>
          <dev:type>
            <maml:name>UkgProReportSession</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>Current session</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">
        <maml:name>Session</maml:name>
        <maml:description>
          <maml:para>Specifies the connected UKG Pro report session. If omitted, the current connected session is used.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">UkgProReportSession</command:parameterValue>
        <dev:type>
          <maml:name>UkgProReportSession</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>Current session</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>None</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>UkgPro.Reports.Models.UkgProReportInfo</maml:name>
        </dev:type>
        <maml:description>
          <maml:para>Returns report name and path information.</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para>The returned Path value can be passed to Get-UkgProReportParameter or Invoke-UkgProReport.</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>-------------- Example 1: List available reports --------------</maml:title>
        <dev:code>Get-UkgProReport -Session $session</dev:code>
        <dev:remarks>
          <maml:para>Returns available reports for the supplied session.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>---------------- Example 2: Find a report path ----------------</maml:title>
        <dev:code>Get-UkgProReport | Where-Object Name -like '*Birthday*'</dev:code>
        <dev:remarks>
          <maml:para>Searches the available reports for report names that include "Birthday".</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Get-UkgProReportParameter</maml:linkText>
        <maml:uri></maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Invoke-UkgProReport</maml:linkText>
        <maml:uri></maml:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Get-UkgProReportParameter</command:name>
      <command:verb>Get</command:verb>
      <command:noun>UkgProReportParameter</command:noun>
      <maml:description>
        <maml:para>Gets parameter metadata for a UKG Pro report.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Get-UkgProReportParameter calls the UKG Pro Reports-as-a-Service GetReportParameters operation for the specified report path.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-UkgProReportParameter</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="ReportPath">
          <maml:name>Path</maml:name>
          <maml:description>
            <maml:para>Specifies the Cognos report path or storeID value.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>String</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
          <maml:name>Session</maml:name>
          <maml:description>
            <maml:para>Specifies the connected UKG Pro report session. If omitted, the current connected session is used.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">UkgProReportSession</command:parameterValue>
          <dev:type>
            <maml:name>UkgProReportSession</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>Current session</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="ReportPath">
        <maml:name>Path</maml:name>
        <maml:description>
          <maml:para>Specifies the Cognos report path or storeID value.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
        <maml:name>Session</maml:name>
        <maml:description>
          <maml:para>Specifies the connected UKG Pro report session. If omitted, the current connected session is used.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">UkgProReportSession</command:parameterValue>
        <dev:type>
          <maml:name>UkgProReportSession</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>Current session</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>String</maml:name>
        </dev:type>
        <maml:description>
          <maml:para>You can pipe an object with a Path or ReportPath property to this cmdlet.</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>UkgPro.Reports.Models.UkgProReportParameter</maml:name>
        </dev:type>
        <maml:description>
          <maml:para>Returns parameter metadata for the report.</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para>Use New-UkgProReportParameter to create execution parameter values for Invoke-UkgProReport.</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>--------------- Example 1: Get report parameters ---------------</maml:title>
        <dev:code>$report = Get-UkgProReport | Where-Object Name -eq 'Employee Birthdays' | Select-Object -First 1
Get-UkgProReportParameter -Path $report.Path</dev:code>
        <dev:remarks>
          <maml:para>Returns parameter metadata for the selected report.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>New-UkgProReportParameter</maml:linkText>
        <maml:uri></maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Invoke-UkgProReport</maml:linkText>
        <maml:uri></maml:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Invoke-UkgProReport</command:name>
      <command:verb>Invoke</command:verb>
      <command:noun>UkgProReport</command:noun>
      <maml:description>
        <maml:para>Executes and retrieves a UKG Pro report.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Invoke-UkgProReport calls the UKG Pro Reports-as-a-Service ExecuteReport operation and then retrieves the report stream from the BI Streaming Service. By default, the command requests comma-delimited output and parses the returned content into PowerShell objects.</maml:para>
      <maml:para>Use -As RawText to return decoded report text. Use -As Xml to request XML output without delimiter parsing. Use -OutFile to write the decoded report content directly to disk.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Invoke-UkgProReport</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="ReportPath">
          <maml:name>Path</maml:name>
          <maml:description>
            <maml:para>Specifies the Cognos report path or storeID value.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>String</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
          <maml:name>Session</maml:name>
          <maml:description>
            <maml:para>Specifies the connected UKG Pro report session. If omitted, the current connected session is used.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">UkgProReportSession</command:parameterValue>
          <dev:type>
            <maml:name>UkgProReportSession</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>Current session</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ReportParameter">
          <maml:name>Parameter</maml:name>
          <maml:description>
            <maml:para>Specifies report execution parameters. The value can be a hashtable or one or more UkgProReportParameter objects.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
          <dev:type>
            <maml:name>Object</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>Delimiter</maml:name>
          <maml:description>
            <maml:para>Specifies the delimiter requested from UKG when text output is used. Valid values are Comma, Pipe, Space, Tab, and Character. The default value is Comma.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">UkgProReportDelimiter</command:parameterValue>
          <dev:type>
            <maml:name>UkgProReportDelimiter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>Comma</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>DelimiterCharacter</maml:name>
          <maml:description>
            <maml:para>Specifies the custom one-character delimiter when -Delimiter Character is used.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>String</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>As</maml:name>
          <maml:description>
            <maml:para>Specifies how report output is returned. Parsed returns PowerShell objects. RawText returns decoded text. Xml requests XML report output and returns decoded text.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">UkgProReportOutputMode</command:parameterValue>
          <dev:type>
            <maml:name>UkgProReportOutputMode</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>Parsed</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>OutFile</maml:name>
          <maml:description>
            <maml:para>Specifies a file path where decoded report content is written. When this parameter is used, report content is not written to the pipeline.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>String</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="ReportPath">
        <maml:name>Path</maml:name>
        <maml:description>
          <maml:para>Specifies the Cognos report path or storeID value.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ReportParameter">
        <maml:name>Parameter</maml:name>
        <maml:description>
          <maml:para>Specifies report execution parameters. The value can be a hashtable or one or more UkgProReportParameter objects.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
        <dev:type>
          <maml:name>Object</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>Delimiter</maml:name>
        <maml:description>
          <maml:para>Specifies the delimiter requested from UKG when text output is used. Valid values are Comma, Pipe, Space, Tab, and Character. The default value is Comma.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">UkgProReportDelimiter</command:parameterValue>
        <dev:type>
          <maml:name>UkgProReportDelimiter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>Comma</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>DelimiterCharacter</maml:name>
        <maml:description>
          <maml:para>Specifies the custom one-character delimiter when -Delimiter Character is used.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>As</maml:name>
        <maml:description>
          <maml:para>Specifies how report output is returned. Parsed returns PowerShell objects. RawText returns decoded text. Xml requests XML report output and returns decoded text.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">UkgProReportOutputMode</command:parameterValue>
        <dev:type>
          <maml:name>UkgProReportOutputMode</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>Parsed</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>OutFile</maml:name>
        <maml:description>
          <maml:para>Specifies a file path where decoded report content is written. When this parameter is used, report content is not written to the pipeline.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
        <maml:name>Session</maml:name>
        <maml:description>
          <maml:para>Specifies the connected UKG Pro report session. If omitted, the current connected session is used.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">UkgProReportSession</command:parameterValue>
        <dev:type>
          <maml:name>UkgProReportSession</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>Current session</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>String</maml:name>
        </dev:type>
        <maml:description>
          <maml:para>You can pipe an object with a Path or ReportPath property to this cmdlet.</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>PSObject</maml:name>
        </dev:type>
        <maml:description>
          <maml:para>Returns parsed report rows when -As Parsed is used.</maml:para>
        </maml:description>
      </command:returnValue>
      <command:returnValue>
        <dev:type>
          <maml:name>String</maml:name>
        </dev:type>
        <maml:description>
          <maml:para>Returns raw report text when -As RawText or -As Xml is used.</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para>UKG recommends smaller report downloads because large report retrievals can hit service timeouts. Use -OutFile for large report output that does not need to flow through the pipeline.</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>--------- Example 1: Execute a report with parameters ---------</maml:title>
        <dev:code>$parameters = New-UkgProReportParameter -Name Month -Value 1 -DataType xsdDouble
Invoke-UkgProReport -Session $session -Path $report.Path -Parameter $parameters</dev:code>
        <dev:remarks>
          <maml:para>Runs the report and returns parsed rows.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------- Example 2: Save raw report output --------------</maml:title>
        <dev:code>Invoke-UkgProReport -Session $session -Path $report.Path -As RawText -OutFile C:\Temp\report.csv</dev:code>
        <dev:remarks>
          <maml:para>Writes the decoded report output to a file.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>----------- Example 3: Request pipe-delimited output -----------</maml:title>
        <dev:code>Invoke-UkgProReport -Path $report.Path -Delimiter Pipe</dev:code>
        <dev:remarks>
          <maml:para>Requests pipe-delimited output from UKG and parses the result into PowerShell objects.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>New-UkgProReportParameter</maml:linkText>
        <maml:uri></maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Get-UkgProReportParameter</maml:linkText>
        <maml:uri></maml:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>New-UkgProReportParameter</command:name>
      <command:verb>New</command:verb>
      <command:noun>UkgProReportParameter</command:noun>
      <maml:description>
        <maml:para>Creates a report parameter object.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>New-UkgProReportParameter creates a typed parameter object for Invoke-UkgProReport. Use this command when a report requires parameter values at execution time.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>New-UkgProReportParameter</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">
          <maml:name>Name</maml:name>
          <maml:description>
            <maml:para>Specifies the report parameter name.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>String</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
          <maml:name>Value</maml:name>
          <maml:description>
            <maml:para>Specifies the report parameter value.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>String</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>Required</maml:name>
          <maml:description>
            <maml:para>Marks the report parameter as required.</maml:para>
          </maml:description>
          <dev:type>
            <maml:name>SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>DataType</maml:name>
          <maml:description>
            <maml:para>Specifies the UKG/Cognos parameter data type. The default value is `xsdString`.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>String</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>xsdString</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>MultiValued</maml:name>
          <maml:description>
            <maml:para>Marks the report parameter as multi-valued.</maml:para>
          </maml:description>
          <dev:type>
            <maml:name>SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">
        <maml:name>Name</maml:name>
        <maml:description>
          <maml:para>Specifies the report parameter name.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
        <maml:name>Value</maml:name>
        <maml:description>
          <maml:para>Specifies the report parameter value.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>Required</maml:name>
        <maml:description>
          <maml:para>Marks the report parameter as required.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>False</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>DataType</maml:name>
        <maml:description>
          <maml:para>Specifies the UKG/Cognos parameter data type. The default value is `xsdString`.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>xsdString</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>MultiValued</maml:name>
        <maml:description>
          <maml:para>Marks the report parameter as multi-valued.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>False</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>None</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>UkgPro.Reports.Models.UkgProReportParameter</maml:name>
        </dev:type>
        <maml:description>
          <maml:para>Returns a report parameter object.</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para>Get-UkgProReportParameter can be used to inspect parameter metadata for a report before creating execution values.</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>------------- Example 1: Create a month parameter -------------</maml:title>
        <dev:code>New-UkgProReportParameter -Name Month -Value 1 -DataType xsdDouble -MultiValued</dev:code>
        <dev:remarks>
          <maml:para>Creates a parameter object that can be passed to Invoke-UkgProReport.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------- Example 2: Create a date parameter --------------</maml:title>
        <dev:code>New-UkgProReportParameter -Name PayDate -Value '2026-05-19T00:00:00' -DataType xsdDateTime</dev:code>
        <dev:remarks>
          <maml:para>Creates a date parameter value for a report.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Get-UkgProReportParameter</maml:linkText>
        <maml:uri></maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Invoke-UkgProReport</maml:linkText>
        <maml:uri></maml:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
</helpItems>