接続の確立

CData Cmdlets ユーザーは、データモジュールをインストールし、接続プロパティを設定してスクリプトを開始できます。このセクションでは、CSV インポートおよびエクスポートcmdlet などのネイティブPowerShell cmdlet でActCRM Cmdlets を使用する例を示します。

インストールおよび接続

PSGet がある場合は、PowerShell Gallery から次のコマンドを使ってcmdlet をインストールできます。CData サイトからセットアップを取得することもできます。

Install-Module ActCRMCmdlets

プロファイルに以下を追加すると、次のセッションでcmdlet がロードされます。

Import-Module ActCRMCmdlets;

Connect-ActCRM cmdlet を使って、別のcmdlet に渡すことができる接続オブジェクトを作成します。

$conn = Connect-ActCRM -URL 'https://myActCRMserver.com' -User 'myUser' -Password 'myPassword' -ActDatabase 'MyActDB

Act! CRM への接続

Act! CRM またはAct! Premium Cloud のどちらかに接続します。接続するには以下を設定します。

User：Act! データベースへの認証に使われるユーザー名。
Password：Act! データベースへの認証に使われるパスワード。
URL：Act! CRM アカウントがホストされているURL。例：http://serverName/
ActDatabase：接続するAct! データベース名。これは、アカウントのAbout Act! Premium メニューに移動し、ページ右上にある? メニューで確認できます。表示されたウィンドウにあるDatabase Name を使用します。
ActCloudRegion （Act! Premium Cloud のみ）：Act! Premium Cloud アカウントのリージョン。

メタデータのキャッシュ

ActCRM メタデータの取得は高負荷になる可能性があることに注意してください。CacheMetadata プロパティを設定して、メタデータをローカルに格納することをお勧めします。

データの取得

Select-ActCRM cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。

$results = Select-ActCRM -Connection $conn -Table "Activities" -Columns @("FullName, Company") -Where "FullName='Anna'"

Invoke-ActCRM cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

cmdlet は行オブジェクトをパイプラインに一度に一行ずつ返します。以下は、結果をCSV ファイルにエクスポートします。

Select-ActCRM -Connection $conn -Table Activities -Where "FullName = 'Anna'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myActivitiesData.csv -NoTypeInformation

Select-ActCRM からの結果をSelect-Object cmdlet にパイプして、Export-CSV cmdlet にパイプする前にいくつかのプロパティを実行していることがわかるでしょう。これをする理由は、CData Cmdlets は接続、テーブル、およびカラムの情報を結果セットの各行オブジェクトに追加しますが、必ずしもその情報がCSV ファイルに必要ではないからです。

ただし、これによってcmdlet の出力を別のcmdlet にパイプすることが容易になります。以下に、結果セットをJSON に変換する例を示します。

 
PS C:\> $conn  = Connect-ActCRM -URL 'https://myActCRMserver.com' -User 'myUser' -Password 'myPassword' -ActDatabase 'MyActDB
PS C:\> $row = Select-ActCRM -Connection $conn -Table "Activities" -Columns (FullName, Company) -Where "FullName = 'Anna'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Activities",
  "Columns":  [

  ],
  "FullName":  "MyFullName",
  "Company":  "MyCompany"
}

データの削除

以下は、抽出条件に合うあらゆるレコードを削除します。

Select-ActCRM -Connection $conn -Table Activities -Where "FullName = 'Anna'" | Remove-ActCRM

データの変更

cmdlet はデータクレンジング同様、データの変換を容易にします。次の例は、レコードがすでに存在するかどうか、挿入する前に更新が必要かどうかをチェックしてから、CSV ファイルのデータをAct! CRM にロードします。

Import-Csv -Path C:\MyActivitiesUpdates.csv | %{
  $record = Select-ActCRM -Connection $conn -Table Activities -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-ActCRM -Connection $conn -Table Activities -Columns @("FullName","Company") -Values @($_.FullName, $_.Company) -Where "Id  = `'$_.Id`'"
  }else{
    Add-ActCRM -Connection $conn -Table Activities -Columns @("FullName","Company") -Values @($_.FullName, $_.Company)
  }
}

Cmdlets for Act! CRM