Cmdlets for Act! CRM

Build 22.0.8462

Getting Started

Connecting to Act! CRM

Establishing a Connection shows how to authenticate to Act! CRM 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 Act! CRM provides a familiar way to interact with Act! CRM from PowerShell. The cmdlets provide a standard PowerShell interface and an SQL interface to live data. The CData cmdlets enable you to work with Act! CRM 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-ActCRM cmdlet. You can then pass the ActCRMConnection object returned to other cmdlets for accessing data:

  • Select-ActCRM
  • Add-ActCRM
  • Update-ActCRM
  • Remove-ActCRM

Executing SQL from PowerShell

You can execute any SQL query with the Invoke-ActCRM 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.

Act! CRM Version Support

The cmdlet models Act! Premium on-premises and Act! Premium Cloud accounts as relational databases, surfacing Contacts, Activities, Opportunities, and other objects as database tables. Act! Premium for Desktop is also supported; however, a subscription is required to use the API.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462