Cmdlets for Sage Intacct

Build 25.0.9434

接続の確立

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

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 およびパスワード（独自のWeb サービスクレデンシャルを使用している場合のみ）。

独自のWeb サービスクレデンシャルではなく、埋め込みクレデンシャルを使用する場合は、以下を実行する必要があります：

  • Web サービスダッシュボードで、会社 -> 会社情報 -> セキュリティタブに移動します。
  • Web サービス認証に"CData" を追加します。これは大文字・小文字が区別されます。これを行うには、会社 -> 会社情報（新しいUI では、設定 -> 会社）-> セキュリティ -> Web サービス認証 / 編集に移動します。

AzureAD

この構成には、2つのAzureAD アプリケーションが必要であることに注意してください：シングルサインオンに使用される"Sage Intacct" アプリケーションと、"Sage Intacct" アプリケーションに対するuser_impersonation 権限を持つ別の"コネクタ" アプリケーション。

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

  • AuthScheme：AzureAD。
  • CompanyID：Sage Intacct にログインする際に会社を識別するために使用するID。
  • SSOLoginURL：SSO プロバイダーのログインURL。
  • OAuthClientId：アプリ登録の概要セクションにリストされている、コネクタアプリケーションのアプリケーションId。
  • OAuthClientSecret：コネクタアプリケーションのクライアントシークレット値。新しいクライアントシークレットを作成すると、Azure AD にこれが表示されます。

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

  • IntacctUserID：User 接続プロパティで設定したOkta ユーザーにマッピングされたSage Intacct ユーザーID。
  • Resource：アプリ登録のBasic SAML Configuration セクションに記載されている、Sage Intacct アプリケーションのEntity ID。
  • AzureTenant：アプリケーションが登録されているAzure AD テナントのId。

次は接続文字列の例です。 

AuthScheme=AzureAD;CompanyID=myCompanyID;OAuthClientId=myClientId;OAuthClientSecret=myClientSecret;SSOLoginUrl=https://login.microsoftonline.com/myAzureTenant/saml2;SSOProperties='IntacctUserID=intacct_user;AzureTenant=myAzureTenant;Resource=https://saml.intacct.com;';

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';

OneLogin

OneLogin SSO で認証するには、以下のプロパティを設定します。

  • AuthScheme：OneLogin。
  • CompanyID：Sage Intacct にログインする際に会社を識別するために使用するID。
  • SSOLoginURL：SAML 2.0 エンドポイント。これはOneLogin のApplications -> your Sage Intacct app -> SSO で確認できます。
  • OAuthClientId：OneLogin OAuth アプリのクライアントId。これはOneLogin のDevelopers -> API Credentials で確認できます。
  • OAuthClientSecret：OneLogin OAuth アプリケーションのクライアントシークレット。クライアントId の下に記載されています。
  • User：OneLogin のユーザー名。
  • Password：OneLogin ユーザーのパスワード。

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

  • IntacctUserID：User 接続プロパティで設定したOkta ユーザーにマッピングされたSage Intacct ユーザーID。
  • Subdomain：SSO アプリにアクセスするOneLogin ユーザーのサブドメイン。例えば、OneLogin のURL がcdata.onelogin.com の場合、サブドメイン値はcdata です。
  • AppId：OneLogin 内のSage Intacct アプリのId。アプリを選択すると確認できます。URL がhttps://cdata.onelogin.com/apps/4157774/edit の場合、アプリId は4157774 です

次は接続文字列の例です。 

AuthScheme=OneLogin;CompanyID=myCompanyID;User=OneLoginUser;Password=OneLoginPassword;SSOProperties='IntacctUserID=intacct_user;Subdomain=subdomain;AppId=12345;';SSOLoginUrl=https://subdomain.onelogin.com/trust/saml2/http-post/sso/123eda45-1c23-123f-b26c-1be75d633ac6;OAuthClientId=myClientId;OAuthClientSecret=myClientId;

接続オブジェクトの作成

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

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

データの取得

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)
  }
}

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434