Connecting to ADP

Establishing a Connection shows how to authenticate to ADP and configure any necessary connection properties. You can also configure cmdlet capabilities through the available Connection properties, from data modeling to firewall traversal. The Advanced Settings section shows how to set up more advanced configurations and troubleshoot connection errors.

Connecting from PowerShell

The CData Cmdlets PowerShell Module for ADP provides a familiar way to interact with ADP from PowerShell. The cmdlets provide a standard PowerShell interface and an SQL interface to live data. The CData cmdlets enable you to work with ADP using standard PowerShell objects; you can chain the cmdlets to each other or other cmdlets in pipelines. The cmdlets also support PowerShell debug streams.

Data Manipulation with Cmdlets

See Establishing a Connection to learn how to get started with the Connect-ADP cmdlet. You can then pass the ADPConnection object returned to other cmdlets for accessing data:

• Select-ADP
• Add-ADP
• Update-ADP
• Remove-ADP

Executing SQL from PowerShell

You can execute any SQL query with the Invoke-ADP cmdlet.

Accessing Debug Output from Streams

See Capturing Errors and Logging to obtain the debug output through PowerShell streams.

PowerShell Version Support

The standard cmdlets are supported in PowerShell 2, 3, 4, and 5.

ADP Version Support

The cmdlet leverages the following ADP APIs to enable access to ADP Workforce Now data:

• Applicant Onboard V2 API
• Payroll Data Input API
• Payroll Output API
• Team Time Cards API
• Time Cards API
• Time Off Balances API
• Time Off Request API
• Validation Table Code List API
• Work Assignment API
• Work Assignment API
• Work Schedules API
• Worker Management API
• Workers API