接続の確立

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

インストールおよび接続

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

Install-Module SageIntacctCmdlets

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

Import-Module SageIntacctCmdlets;

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

$conn = Connect-SageIntacct -User 'myusername' -CompanyID 'TestCompany' -Password 'mypassword' -SenderID 'Test' -SenderPassword 'abcde123'

Sage Intacct への接続

独自のWeb サービスクレデンシャル、埋め込みクレデンシャル（Basic 認証）、またはOkta クレデンシャルのいずれかを使用して、Sage Intacct への接続を確立できます。

Sage Intacct への認証

Sage Intacct は2種類の認証をサポートします。Basic およびOkta です。選択した認証方法に関連するプロパティを設定して、接続を構成します。

Basic 認証

Basic 認証スキームでは、埋め込みクレデンシャルを使用してデータの読み書きが可能です。オプションとして、独自のWeb サービスクレデンシャルを指定することもできます。

Basic 認証を使用して認証を行うには、以下のプロパティを設定します。

AuthScheme：Basic。
CompanyID：Sage Intacct にログインする際に会社を識別するために使用するID。
User：Sage Intacct へのログインに使用するログイン名。
Password：ログインクレデンシャル用のパスワード。
（オプション）SenderID およびSenderPassword：Web サービスのSender ID およびパスワード。

Okta

Okta への認証には、以下のプロパティを設定します。

AuthScheme：Okta。
CompanyID：Sage Intacct にログインする際に会社を識別するために使用するID。
User：Okta ユーザー。
Password：Okta ユーザーのパスワード。
SSOLoginURL：SSO プロバイダーのログインURL。

また、以下のSSOProperties を設定します。

IntacctUserID：User 接続プロパティで設定したOkta ユーザーにマッピングされたSage Intacct ユーザーID。
APIToken（オプション）：Okta クライアントのリクエストコンテキストをオーバーライドする、信頼されたアプリケーションまたはプロキシ経由でユーザーを認証する場合、顧客がOkta 組織から作成したAPI トークンを指定します。

接続文字列の例：

AuthScheme=Okta; CompanyID=myCompanyID; SSOLoginURL='https://example.okta.com/home/appType/0bg4ivz6cJRZgCz5d6/46'; User=oktaUserName; Password=oktaPassword; SSOProperties='IntacctUserID=intacct_user';

データの取得

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

$results = Select-SageIntacct -Connection $conn -Table "Customer" -Columns @("Name, TotalDue") -Where "CustomerId='12345'"

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

cmdlet 出力のパイプ処理

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

Select-SageIntacct -Connection $conn -Table Customer -Where "CustomerId = '12345'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myCustomerData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-SageIntacct -User 'myusername' -CompanyID 'TestCompany' -Password 'mypassword' -SenderID 'Test' -SenderPassword 'abcde123'
PS C:\> $row = Select-SageIntacct -Connection $conn -Table "Customer" -Columns (Name, TotalDue) -Where "CustomerId = '12345'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Customer",
  "Columns":  [

  ],
  "Name":  "MyName",
  "TotalDue":  "MyTotalDue"
}

データの削除

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

Select-SageIntacct -Connection $conn -Table Customer -Where "CustomerId = '12345'" | Remove-SageIntacct

データの変更

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

Import-Csv -Path C:\MyCustomerUpdates.csv | %{
  $record = Select-SageIntacct -Connection $conn -Table Customer -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-SageIntacct -Connection $conn -Table Customer -Columns @("Name","TotalDue") -Values @($_.Name, $_.TotalDue) -Where "Id  = `'$_.Id`'"
  }else{
    Add-SageIntacct -Connection $conn -Table Customer -Columns @("Name","TotalDue") -Values @($_.Name, $_.TotalDue)
  }
}

Cmdlets for Sage Intacct