lib/netstandard2.1/CData.PaylocityCmdlets.Commands.dll-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!-- Cmdlet --><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"> <command:details> <command:name> Add-Paylocity </command:name> <maml:description> <maml:para>Inserts Paylocity data.</maml:para> </maml:description> <maml:copyright> <maml:para>Copyright (c) 2023 CData Software, Inc. - All rights reserved.</maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>Paylocity</command:noun> <dev:version>22.0</dev:version> </command:details> <maml:description> <maml:para>Inserts Paylocity data. The Add-Paylocity cmdlet allows you to use a syntax similar to SQL INSERT statements to create new Paylocity records.</maml:para><maml:para>Add-Paylocity -Connection $connection -Table "Employee" -Columns @("LastName") -Values @("Jon Doe")</maml:para><maml:para></maml:para><maml:para></maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Add-Paylocity [parameters]</maml:name> <command:parameter required="true" pipelineInput="true" position="named"> <maml:name>Columns</maml:name> <maml:description> <maml:para>The columns on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue > string[] </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue > DataConnection </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="named"> <maml:name>Table</maml:name> <maml:description> <maml:para>The table on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>The values that will be used to update the table.</maml:para> </maml:description> <command:parameterValue > string[] </command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="true" pipelineInput="true" position="named" > <maml:name>Columns</maml:name> <maml:description> <maml:para>The columns on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue required="true" > string[] </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position=0 > <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue required="true" > DataConnection </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="named" > <maml:name>Table</maml:name> <maml:description> <maml:para>The table on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue required="true" > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineInput="false" position="named" > <maml:name>Values</maml:name> <maml:description> <maml:para>The values that will be used to update the table.</maml:para> </maml:description> <command:parameterValue required="true" > string[] </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>InsertedRowId</maml:name> <maml:uri /> <maml:description> <maml:para> The unique Id of the inserted row. </maml:para> </maml:description> </dev:type> <maml:description> The unique Id of the inserted row. </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Example section --> <command:examples /> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet --><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"> <command:details> <command:name> Disconnect-Paylocity </command:name> <maml:description> <maml:para>Closes a connection to Paylocity.</maml:para> </maml:description> <maml:copyright> <maml:para>Copyright (c) 2023 CData Software, Inc. - All rights reserved.</maml:para> </maml:copyright> <command:verb>Disconnect</command:verb> <command:noun>Paylocity</command:noun> <dev:version>22.0</dev:version> </command:details> <maml:description> <maml:para>Closes a connection to Paylocity. The Disconnect-Paylocity cmdlet is used to close a connection that was opened by the Connect-Paylocity cmdlet.</maml:para><maml:para>Disconnect-Paylocity -Connection $connection</maml:para><maml:para></maml:para><maml:para></maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-Paylocity [parameters]</maml:name> <command:parameter required="true" pipelineInput="true" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue > DataConnection </command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="true" pipelineInput="true" position=0 > <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue required="true" > DataConnection </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> </command:inputTypes> <command:returnValues> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Example section --> <command:examples /> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet --><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"> <command:details> <command:name> Invoke-Paylocity </command:name> <maml:description> <maml:para>Searches and updates Paylocity data.</maml:para> </maml:description> <maml:copyright> <maml:para>Copyright (c) 2023 CData Software, Inc. - All rights reserved.</maml:para> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>Paylocity</command:noun> <dev:version>22.0</dev:version> </command:details> <maml:description> <maml:para>Searches and updates Paylocity data. The Invoke-Paylocity cmdlet allows you to use SQL statements to execute any SQL statement directly. Below is the syntax for a parameterized query:</maml:para><maml:para>$query = Invoke-Paylocity -Connection $connection -Query 'SELECT * FROM Employee WHERE EmployeeId=@EmployeeId' -Params @{'@EmployeeId'='1234'}</maml:para><maml:para></maml:para><maml:para>This cmdlet is also useful for executing stored procedures. Use the EXEC keyword to call a stored procedure:</maml:para><maml:para></maml:para><maml:para>$query = Invoke-Paylocity -Connection $connection -Query 'EXEC CreateSchema TableName = @TableName' -Params @{"Employee"}</maml:para><maml:para></maml:para><maml:para>To pass multiple</maml:para><maml:para><B></maml:para><maml:para>Params</maml:para><maml:para></B></maml:para><maml:para>parameters, use a semicolon (;) as a delimiter. The code below outlines the structure of an EXEC command with two parameters (</maml:para><maml:para><I></maml:para><maml:para>param1</maml:para><maml:para></I></maml:para><maml:para>and</maml:para><maml:para><I></maml:para><maml:para>param2</maml:para><maml:para></I></maml:para><maml:para>):</maml:para><maml:para></maml:para><maml:para>$query = Invoke-Paylocity -Connection $connection -Query 'EXEC MyStoredProc Input1=@param1, Input2=@param2' -Params @{'@param1' = 'value1'; '@param2' = 'value2'}</maml:para><maml:para></maml:para><maml:para></maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Invoke-Paylocity [parameters]</maml:name> <command:parameter required="true" pipelineInput="true" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue > DataConnection </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Params</maml:name> <maml:description> <maml:para>The parameters that will be used for the query.</maml:para> </maml:description> <command:parameterValue > Hashtable </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="false" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>The SQL query to execute.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="true" pipelineInput="true" position=0 > <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue required="true" > DataConnection </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="false" position="named" > <maml:name>Params</maml:name> <maml:description> <maml:para>The parameters that will be used for the query.</maml:para> </maml:description> <command:parameterValue > Hashtable </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineInput="false" position="named" > <maml:name>Query</maml:name> <maml:description> <maml:para>The SQL query to execute.</maml:para> </maml:description> <command:parameterValue required="true" > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AffectedRowsCount</maml:name> <maml:uri /> <maml:description> <maml:para> The number of rows affected by the operation. </maml:para> </maml:description> </dev:type> <maml:description> The number of rows affected by the operation. </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>InsertedRowId</maml:name> <maml:uri /> <maml:description> <maml:para> The unique Id of the inserted row. </maml:para> </maml:description> </dev:type> <maml:description> The unique Id of the inserted row. </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>QueryResults</maml:name> <maml:uri /> <maml:description> <maml:para> The results of the query. </maml:para> </maml:description> </dev:type> <maml:description> The results of the query. </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Example section --> <command:examples /> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet --><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"> <command:details> <command:name> Remove-Paylocity </command:name> <maml:description> <maml:para>Deletes Paylocity data.</maml:para> </maml:description> <maml:copyright> <maml:para>Copyright (c) 2023 CData Software, Inc. - All rights reserved.</maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>Paylocity</command:noun> <dev:version>22.0</dev:version> </command:details> <maml:description> <maml:para>Deletes Paylocity data. The Remove-Paylocity cmdlet allows you to use a syntax similar to SQL DELETE statements to delete Paylocity data.</maml:para><maml:para>$conn = Connect-Paylocity -InitiateOauth "GETANDREFRESH" -OAuthClientID "YourClientId" -OAuthClientSecret "YourClientSecret" -RSAPublicKey "YourRSAPubKey" -Key "YourKey" -IV "YourIV"</maml:para><maml:para>Remove-Paylocity -Connection $conn -Table "Employee" -Id "1234"</maml:para><maml:para></maml:para><maml:para>The Where parameter can also be used to specify the primary key:</maml:para><maml:para></maml:para><maml:para>Remove-Paylocity -Connection $conn -Table "exTablePowershell;" -Where "EmployeeId = 1234"</maml:para><maml:para></maml:para><maml:para>The primary key can also be passed to the cmdlet along the pipeline:</maml:para><maml:para></maml:para><maml:para>Select-Paylocity -Connection $conn -Table Employee -Where "EmployeeId = '1234'" | Remove-Paylocity</maml:para><maml:para></maml:para><maml:para></maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Remove-Paylocity [parameters]</maml:name> <command:parameter required="true" pipelineInput="true" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue > DataConnection </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="true" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the item on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="named"> <maml:name>Table</maml:name> <maml:description> <maml:para>The table on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Where</maml:name> <maml:description> <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="true" pipelineInput="true" position=0 > <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue required="true" > DataConnection </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="true" position="named" > <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the item on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="named" > <maml:name>Table</maml:name> <maml:description> <maml:para>The table on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue required="true" > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="false" position="named" > <maml:name>Where</maml:name> <maml:description> <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AffectedRowsCount</maml:name> <maml:uri /> <maml:description> <maml:para> The number of rows affected by the operation. </maml:para> </maml:description> </dev:type> <maml:description> The number of rows affected by the operation. </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Example section --> <command:examples /> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet --><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"> <command:details> <command:name> Connect-Paylocity </command:name> <maml:description> <maml:para>Opens a new connection to Paylocity</maml:para> </maml:description> <maml:copyright> <maml:para>Copyright (c) 2023 CData Software, Inc. - All rights reserved.</maml:para> </maml:copyright> <command:verb>Connect</command:verb> <command:noun>Paylocity</command:noun> <dev:version>22.0</dev:version> </command:details> <maml:description> <maml:para>The Connect-Paylocity cmdlet is used to create a persistent connection object to be used with related cmdlets. When executing the cmdlet a connection object is returned. Pass this object to the Connection parameter of related cmdlets to use the newly created connection object. To disconnect, call Disconnect-Paylocity.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>$conn = Connect-Paylocity</maml:name> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>AutoCache</maml:name> <maml:description> <maml:para>Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>BrowsableSchemas</maml:name> <maml:description> <maml:para>This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>CacheConnection</maml:name> <maml:description> <maml:para>The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>CacheLocation</maml:name> <maml:description> <maml:para>Specifies the path to the cache when caching to a file.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>CacheMetadata</maml:name> <maml:description> <maml:para>This property determines whether or not to cache the table metadata to a file store.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>CacheProvider</maml:name> <maml:description> <maml:para>The name of the provider to be used to cache data.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>CacheTolerance</maml:name> <maml:description> <maml:para>The tolerance for stale data in the cache specified in seconds when using AutoCache .</maml:para> </maml:description> <command:parameterValue > int </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="false" position="named"> <maml:name>CompanyId</maml:name> <maml:description> <maml:para>The ID of the company file.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>CustomFieldsCategory</maml:name> <maml:description> <maml:para>The custom field category in the company.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>FirewallPassword</maml:name> <maml:description> <maml:para>A password used to authenticate to a proxy-based firewall.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>FirewallPort</maml:name> <maml:description> <maml:para>The TCP port for a proxy-based firewall.</maml:para> </maml:description> <command:parameterValue > int </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>FirewallServer</maml:name> <maml:description> <maml:para>The name or IP address of a proxy-based firewall.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>FirewallType</maml:name> <maml:description> <maml:para>The protocol used by a proxy-based firewall.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>FirewallUser</maml:name> <maml:description> <maml:para>The user name to use to authenticate with a proxy-based firewall.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>InitiateOAuth</maml:name> <maml:description> <maml:para>Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="false" position="named"> <maml:name>IV</maml:name> <maml:description> <maml:para>The initialization vector (IV).</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="false" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>The secret key for the symmetric algorithm.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>A path to the directory that contains the schema files defining tables, views, and stored procedures.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Logfile</maml:name> <maml:description> <maml:para>A filepath which designates the name and location of the log file.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>LogModules</maml:name> <maml:description> <maml:para>Core modules to be included in the log file.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>MaxLogFileCount</maml:name> <maml:description> <maml:para>A string specifying the maximum file count of log files.</maml:para> </maml:description> <command:parameterValue > int </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>MaxLogFileSize</maml:name> <maml:description> <maml:para>A string specifying the maximum size in bytes for a log file (for example, 10 MB).</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>MaxRows</maml:name> <maml:description> <maml:para>Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.</maml:para> </maml:description> <command:parameterValue > int </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>OAuthAccessToken</maml:name> <maml:description> <maml:para>The access token for connecting using OAuth.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>OAuthClientId</maml:name> <maml:description> <maml:para>The client Id assigned when you register your application with an OAuth authorization server.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>OAuthClientSecret</maml:name> <maml:description> <maml:para>The client secret assigned when you register your application with an OAuth authorization server.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>OAuthExpiresIn</maml:name> <maml:description> <maml:para>The lifetime in seconds of the OAuth AccessToken.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>OAuthRefreshToken</maml:name> <maml:description> <maml:para>The OAuth refresh token for the corresponding OAuth access token.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>OAuthSettingsLocation</maml:name> <maml:description> <maml:para>The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>OAuthTokenTimestamp</maml:name> <maml:description> <maml:para>The Unix epoch timestamp in milliseconds when the current Access Token was created.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>OAuthVerifier</maml:name> <maml:description> <maml:para>The verifier code returned from the OAuth authorization URL.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Use offline mode to get the data from the cache instead of the live source.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Other</maml:name> <maml:description> <maml:para>These hidden properties are used only in specific use cases.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxyAuthScheme</maml:name> <maml:description> <maml:para>The authentication type to use to authenticate to the ProxyServer proxy.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxyAutoDetect</maml:name> <maml:description> <maml:para>This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.</maml:para> </maml:description> <command:parameterValue > bool </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxyExceptions</maml:name> <maml:description> <maml:para>A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxyPassword</maml:name> <maml:description> <maml:para>A password to be used to authenticate to the ProxyServer proxy.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>The TCP port the ProxyServer proxy is running on.</maml:para> </maml:description> <command:parameterValue > int </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>The hostname or IP address of a proxy to route HTTP traffic through.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxySSLType</maml:name> <maml:description> <maml:para>The SSL type to use when connecting to the ProxyServer proxy.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxyUser</maml:name> <maml:description> <maml:para>A user name to be used to authenticate to the ProxyServer proxy.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>PseudoColumns</maml:name> <maml:description> <maml:para>This property indicates whether or not to include pseudo columns as columns to the table.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Readonly</maml:name> <maml:description> <maml:para>You can use this property to enforce read-only access to Paylocity from the provider.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>RSAPublicKey</maml:name> <maml:description> <maml:para>Set this to the public key shared by Paylocity.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>RTK</maml:name> <maml:description> <maml:para>The runtime key used for licensing.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>SSLClientCert</maml:name> <maml:description> <maml:para>The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>SSLClientCertPassword</maml:name> <maml:description> <maml:para>The password for the TLS/SSL client certificate.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>SSLClientCertSubject</maml:name> <maml:description> <maml:para>The subject of the TLS/SSL client certificate.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>SSLClientCertType</maml:name> <maml:description> <maml:para>The type of key store containing the TLS/SSL client certificate.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>SSLServerCert</maml:name> <maml:description> <maml:para>The certificate to be accepted from the server when connecting using TLS/SSL.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Tables</maml:name> <maml:description> <maml:para>This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The value in seconds until the timeout error is thrown, canceling the operation.</maml:para> </maml:description> <command:parameterValue > int </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>UsePayEntryAPI</maml:name> <maml:description> <maml:para>Set to true if you want to access the Pay Entry API. When this property is set to true, you should specify different location for OAuthSettingsFile.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>UserDefinedViews</maml:name> <maml:description> <maml:para>A filepath pointing to the JSON configuration file containing your custom views.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>UseSandbox</maml:name> <maml:description> <maml:para>Set to true if you you are using sandbox account.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>The verbosity level that determines the amount of detail included in the log file.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Views</maml:name> <maml:description> <maml:para>Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter > <maml:name>AutoCache</maml:name> <maml:description> <maml:para>Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> false </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>BrowsableSchemas</maml:name> <maml:description> <maml:para>This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>CacheLocation</maml:name> <maml:description> <maml:para>Specifies the path to the cache when caching to a file.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "%APPDATA%\\CData\\Paylocity Data Provider" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>CacheMetadata</maml:name> <maml:description> <maml:para>This property determines whether or not to cache the table metadata to a file store.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> false </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>CacheTolerance</maml:name> <maml:description> <maml:para>The tolerance for stale data in the cache specified in seconds when using AutoCache .</maml:para> </maml:description> <command:parameterValue > int </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> 600 </dev:defaultValue> </command:parameter> <command:parameter required="true"> <maml:name>CompanyId</maml:name> <maml:description> <maml:para>The ID of the company file.</maml:para> </maml:description> <command:parameterValue required="true" > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>CustomFieldsCategory</maml:name> <maml:description> <maml:para>The custom field category in the company.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "PayrollAndHR" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>FirewallPassword</maml:name> <maml:description> <maml:para>A password used to authenticate to a proxy-based firewall.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>FirewallPort</maml:name> <maml:description> <maml:para>The TCP port for a proxy-based firewall.</maml:para> </maml:description> <command:parameterValue > int </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> 0 </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>FirewallServer</maml:name> <maml:description> <maml:para>The name or IP address of a proxy-based firewall.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>FirewallType</maml:name> <maml:description> <maml:para>The protocol used by a proxy-based firewall.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:possibleValues> <dev:possibleValue> <dev:value>NONE</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>TUNNEL</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>SOCKS4</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>SOCKS5</dev:value> </dev:possibleValue> </dev:possibleValues> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "NONE" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>FirewallUser</maml:name> <maml:description> <maml:para>The user name to use to authenticate with a proxy-based firewall.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>InitiateOAuth</maml:name> <maml:description> <maml:para>Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:possibleValues> <dev:possibleValue> <dev:value>OFF</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>GETANDREFRESH</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>REFRESH</dev:value> </dev:possibleValue> </dev:possibleValues> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "OFF" </dev:defaultValue> </command:parameter> <command:parameter required="true"> <maml:name>IV</maml:name> <maml:description> <maml:para>The initialization vector (IV).</maml:para> </maml:description> <command:parameterValue required="true" > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter required="true"> <maml:name>Key</maml:name> <maml:description> <maml:para>The secret key for the symmetric algorithm.</maml:para> </maml:description> <command:parameterValue required="true" > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Location</maml:name> <maml:description> <maml:para>A path to the directory that contains the schema files defining tables, views, and stored procedures.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "%APPDATA%\\CData\\Paylocity Data Provider\\Schema" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Logfile</maml:name> <maml:description> <maml:para>A filepath which designates the name and location of the log file.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>LogModules</maml:name> <maml:description> <maml:para>Core modules to be included in the log file.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>MaxLogFileCount</maml:name> <maml:description> <maml:para>A string specifying the maximum file count of log files.</maml:para> </maml:description> <command:parameterValue > int </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> -1 </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>MaxLogFileSize</maml:name> <maml:description> <maml:para>A string specifying the maximum size in bytes for a log file (for example, 10 MB).</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "100MB" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>MaxRows</maml:name> <maml:description> <maml:para>Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.</maml:para> </maml:description> <command:parameterValue > int </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> -1 </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>OAuthAccessToken</maml:name> <maml:description> <maml:para>The access token for connecting using OAuth.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>OAuthClientId</maml:name> <maml:description> <maml:para>The client Id assigned when you register your application with an OAuth authorization server.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>OAuthClientSecret</maml:name> <maml:description> <maml:para>The client secret assigned when you register your application with an OAuth authorization server.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>OAuthExpiresIn</maml:name> <maml:description> <maml:para>The lifetime in seconds of the OAuth AccessToken.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>OAuthRefreshToken</maml:name> <maml:description> <maml:para>The OAuth refresh token for the corresponding OAuth access token.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>OAuthSettingsLocation</maml:name> <maml:description> <maml:para>The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "%APPDATA%\\CData\\Paylocity Data Provider\\OAuthSettings.txt" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>OAuthTokenTimestamp</maml:name> <maml:description> <maml:para>The Unix epoch timestamp in milliseconds when the current Access Token was created.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>OAuthVerifier</maml:name> <maml:description> <maml:para>The verifier code returned from the OAuth authorization URL.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Offline</maml:name> <maml:description> <maml:para>Use offline mode to get the data from the cache instead of the live source.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> false </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Other</maml:name> <maml:description> <maml:para>These hidden properties are used only in specific use cases.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>ProxyAuthScheme</maml:name> <maml:description> <maml:para>The authentication type to use to authenticate to the ProxyServer proxy.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:possibleValues> <dev:possibleValue> <dev:value>BASIC</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>DIGEST</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>NONE</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>NEGOTIATE</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>NTLM</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>PROPRIETARY</dev:value> </dev:possibleValue> </dev:possibleValues> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "BASIC" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>ProxyAutoDetect</maml:name> <maml:description> <maml:para>This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.</maml:para> </maml:description> <command:parameterValue > bool </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> true </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>ProxyExceptions</maml:name> <maml:description> <maml:para>A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>ProxyPassword</maml:name> <maml:description> <maml:para>A password to be used to authenticate to the ProxyServer proxy.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>The TCP port the ProxyServer proxy is running on.</maml:para> </maml:description> <command:parameterValue > int </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> 80 </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>The hostname or IP address of a proxy to route HTTP traffic through.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>ProxySSLType</maml:name> <maml:description> <maml:para>The SSL type to use when connecting to the ProxyServer proxy.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:possibleValues> <dev:possibleValue> <dev:value>AUTO</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>ALWAYS</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>NEVER</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>TUNNEL</dev:value> </dev:possibleValue> </dev:possibleValues> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "AUTO" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>ProxyUser</maml:name> <maml:description> <maml:para>A user name to be used to authenticate to the ProxyServer proxy.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>PseudoColumns</maml:name> <maml:description> <maml:para>This property indicates whether or not to include pseudo columns as columns to the table.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Readonly</maml:name> <maml:description> <maml:para>You can use this property to enforce read-only access to Paylocity from the provider.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> false </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>RSAPublicKey</maml:name> <maml:description> <maml:para>Set this to the public key shared by Paylocity.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>RTK</maml:name> <maml:description> <maml:para>The runtime key used for licensing.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>SSLClientCert</maml:name> <maml:description> <maml:para>The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>SSLClientCertPassword</maml:name> <maml:description> <maml:para>The password for the TLS/SSL client certificate.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>SSLClientCertSubject</maml:name> <maml:description> <maml:para>The subject of the TLS/SSL client certificate.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "*" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>SSLClientCertType</maml:name> <maml:description> <maml:para>The type of key store containing the TLS/SSL client certificate.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:possibleValues> <dev:possibleValue> <dev:value>USER</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>MACHINE</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>PFXFILE</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>PFXBLOB</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>JKSFILE</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>JKSBLOB</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>PEMKEY_FILE</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>PEMKEY_BLOB</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>PUBLIC_KEY_FILE</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>PUBLIC_KEY_BLOB</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>SSHPUBLIC_KEY_FILE</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>SSHPUBLIC_KEY_BLOB</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>P7BFILE</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>PPKFILE</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>XMLFILE</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>XMLBLOB</dev:value> </dev:possibleValue> </dev:possibleValues> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "USER" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>SSLServerCert</maml:name> <maml:description> <maml:para>The certificate to be accepted from the server when connecting using TLS/SSL.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Tables</maml:name> <maml:description> <maml:para>This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Timeout</maml:name> <maml:description> <maml:para>The value in seconds until the timeout error is thrown, canceling the operation.</maml:para> </maml:description> <command:parameterValue > int </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> 60 </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>UsePayEntryAPI</maml:name> <maml:description> <maml:para>Set to true if you want to access the Pay Entry API. When this property is set to true, you should specify different location for OAuthSettingsFile.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> false </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>UserDefinedViews</maml:name> <maml:description> <maml:para>A filepath pointing to the JSON configuration file containing your custom views.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>UseSandbox</maml:name> <maml:description> <maml:para>Set to true if you you are using sandbox account.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> false </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Verbosity</maml:name> <maml:description> <maml:para>The verbosity level that determines the amount of detail included in the log file.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "1" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Views</maml:name> <maml:description> <maml:para>Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CData.PaylocityCmdlets.Commands.PaylocityPSConnection</maml:name> <maml:uri /> <maml:description> <maml:para> The Paylocity connection object. </maml:para> </maml:description> </dev:type> <maml:description> The PaylocityConnection object may be passed to related cmdlets to use the connection. </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Example section --> <command:examples /> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet --><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"> <command:details> <command:name> Select-Paylocity </command:name> <maml:description> <maml:para>Searches Paylocity data.</maml:para> </maml:description> <maml:copyright> <maml:para>Copyright (c) 2023 CData Software, Inc. - All rights reserved.</maml:para> </maml:copyright> <command:verb>Select</command:verb> <command:noun>Paylocity</command:noun> <dev:version>22.0</dev:version> </command:details> <maml:description> <maml:para>Searches Paylocity data. The Select-Paylocity cmdlet allows you to use a syntax similar to SQL SELECT statements to search Paylocity data.</maml:para><maml:para>$conn = Connect-Paylocity -InitiateOauth "GETANDREFRESH" -OAuthClientID "YourClientId" -OAuthClientSecret "YourClientSecret" -RSAPublicKey "YourRSAPubKey" -Key "YourKey" -IV "YourIV"</maml:para><maml:para>Select-Paylocity -Connection $conn -Table "Employee" -Columns @("FirstName","LastName") -Where "EmployeeId='1234'"</maml:para><maml:para></maml:para><maml:para></maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Select-Paylocity [parameters]</maml:name> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Columns</maml:name> <maml:description> <maml:para>The columns to return.</maml:para> </maml:description> <command:parameterValue > string[] </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue > DataConnection </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>GroupBy</maml:name> <maml:description> <maml:para>A comma-separated list of columns that the result set will be grouped by.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>The order in which columns will be returned.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Params</maml:name> <maml:description> <maml:para>The parameters that will be used for the query.</maml:para> </maml:description> <command:parameterValue > Hashtable </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="named"> <maml:name>Table</maml:name> <maml:description> <maml:para>The table on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Where</maml:name> <maml:description> <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter pipelineInput="false" position="named" > <maml:name>Columns</maml:name> <maml:description> <maml:para>The columns to return.</maml:para> </maml:description> <command:parameterValue > string[] </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position=0 > <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue required="true" > DataConnection </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="false" position="named" > <maml:name>GroupBy</maml:name> <maml:description> <maml:para>A comma-separated list of columns that the result set will be grouped by.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="false" position="named" > <maml:name>OrderBy</maml:name> <maml:description> <maml:para>The order in which columns will be returned.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="false" position="named" > <maml:name>Params</maml:name> <maml:description> <maml:para>The parameters that will be used for the query.</maml:para> </maml:description> <command:parameterValue > Hashtable </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="named" > <maml:name>Table</maml:name> <maml:description> <maml:para>The table on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue required="true" > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="false" position="named" > <maml:name>Where</maml:name> <maml:description> <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryResults</maml:name> <maml:uri /> <maml:description> <maml:para> The results of the query. </maml:para> </maml:description> </dev:type> <maml:description> The results of the query. </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Example section --> <command:examples /> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet --><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"> <command:details> <command:name> Sync-Paylocity </command:name> <maml:description> <maml:para>Syncs Paylocity data.</maml:para> </maml:description> <maml:copyright> <maml:para>Copyright (c) 2023 CData Software, Inc. - All rights reserved.</maml:para> </maml:copyright> <command:verb>Sync</command:verb> <command:noun>Paylocity</command:noun> <dev:version>22.0</dev:version> </command:details> <maml:description> <maml:para>Syncs Paylocity data. The Sync-Paylocity cmdlet allows you to replicate a data source locally and maintain it with the full caching functionality of the provider.</maml:para><maml:para>$conn = Connect-Paylocity -InitiateOauth "GETANDREFRESH" -OAuthClientID "YourClientId" -OAuthClientSecret "YourClientSecret" -RSAPublicKey "YourRSAPubKey" -Key "YourKey" -IV "YourIV"</maml:para><maml:para>Sync-Paylocity -Connection $conn -Table "Employee"</maml:para><maml:para></maml:para><maml:para></maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Sync-Paylocity [parameters]</maml:name> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Columns</maml:name> <maml:description> <maml:para>The columns to sync.</maml:para> </maml:description> <command:parameterValue > string[] </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue > DataConnection </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="true" position="named"> <maml:name>DestinationTable</maml:name> <maml:description> <maml:para>The table where the data will be placed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Params</maml:name> <maml:description> <maml:para>The parameters that will be used for the query.</maml:para> </maml:description> <command:parameterValue > Hashtable </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="named"> <maml:name>Table</maml:name> <maml:description> <maml:para>The table on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter pipelineInput="false" position="named" > <maml:name>Columns</maml:name> <maml:description> <maml:para>The columns to sync.</maml:para> </maml:description> <command:parameterValue > string[] </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position=0 > <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue required="true" > DataConnection </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="true" position="named" > <maml:name>DestinationTable</maml:name> <maml:description> <maml:para>The table where the data will be placed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="false" position="named" > <maml:name>Params</maml:name> <maml:description> <maml:para>The parameters that will be used for the query.</maml:para> </maml:description> <command:parameterValue > Hashtable </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="named" > <maml:name>Table</maml:name> <maml:description> <maml:para>The table on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue required="true" > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AffectedRowsCount</maml:name> <maml:uri /> <maml:description> <maml:para> The number of rows affected by the operation. </maml:para> </maml:description> </dev:type> <maml:description> The number of rows affected by the operation. </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Example section --> <command:examples /> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet --><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"> <command:details> <command:name> Update-Paylocity </command:name> <maml:description> <maml:para>Updates Paylocity data.</maml:para> </maml:description> <maml:copyright> <maml:para>Copyright (c) 2023 CData Software, Inc. - All rights reserved.</maml:para> </maml:copyright> <command:verb>Update</command:verb> <command:noun>Paylocity</command:noun> <dev:version>22.0</dev:version> </command:details> <maml:description> <maml:para>Updates Paylocity data. The Update-Paylocity cmdlet allows you to use a syntax similar to SQL UPDATE statements to update Paylocity data.</maml:para><maml:para>$conn = Connect-Paylocity -InitiateOauth "GETANDREFRESH" -OAuthClientID "YourClientId" -OAuthClientSecret "YourClientSecret" -RSAPublicKey "YourRSAPubKey" -Key "YourKey" -IV "YourIV"</maml:para><maml:para>Update-Paylocity -Connection $conn -Table "Employee" -Columns @("LastName") -Values @("Jon Doe") -Id "1234"</maml:para><maml:para></maml:para><maml:para>The Where parameter can also be used to specify the primary key of the table:</maml:para><maml:para></maml:para><maml:para>Update-Paylocity -Connection $conn -Table "Employee" -Columns @("LastName") -Values @("Jon Doe") -Where "EmployeeId = '1234'"</maml:para><maml:para></maml:para><maml:para>The primary key can also be passed to the cmdlet along the pipeline:</maml:para><maml:para></maml:para><maml:para>Select-Paylocity -Connection $conn -Table Employee -Where "EmployeeId = '1234'" | Update-Paylocity -Columns @("EmployeeId") -Values @("1234 2")</maml:para><maml:para></maml:para><maml:para></maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Update-Paylocity [parameters]</maml:name> <command:parameter required="true" pipelineInput="true" position="named"> <maml:name>Columns</maml:name> <maml:description> <maml:para>The columns on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue > string[] </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue > DataConnection </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="true" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the item on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="named"> <maml:name>Table</maml:name> <maml:description> <maml:para>The table on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>The values that will be used to update the table.</maml:para> </maml:description> <command:parameterValue > string[] </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Where</maml:name> <maml:description> <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="true" pipelineInput="true" position="named" > <maml:name>Columns</maml:name> <maml:description> <maml:para>The columns on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue required="true" > string[] </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position=0 > <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue required="true" > DataConnection </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="true" position="named" > <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the item on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="named" > <maml:name>Table</maml:name> <maml:description> <maml:para>The table on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue required="true" > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineInput="false" position="named" > <maml:name>Values</maml:name> <maml:description> <maml:para>The values that will be used to update the table.</maml:para> </maml:description> <command:parameterValue required="true" > string[] </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="false" position="named" > <maml:name>Where</maml:name> <maml:description> <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AffectedRowsCount</maml:name> <maml:uri /> <maml:description> <maml:para> The number of rows affected by the operation. </maml:para> </maml:description> </dev:type> <maml:description> The number of rows affected by the operation. </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Example section --> <command:examples /> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |