SQL Server からNetSuite へストアドプロシージャで自動連携：SQL Gateway

古川えりか
古川えりか
コンテンツスペシャリスト
SQL Server のCDC 機能とストアドプロシージャを使って、リンクサーバー経由でNetSuite のデータを定期的に更新する方法

 トップ画像。SQL Gateway 経由でNetSuite をSQL Server へ連携。

シナリオ

SQL Serverにある既存テーブルの更新された値を、NetSuite に自動的に取り込んでいきます。構成は、NetSuite とSQL Server の間にSQL Gateway を配置し、SQL Gateway からデータソースへのアクセスはHTTP リクエスト、SQL Gateway からクライアントへはTDS プロトコル（SQL Server）でアクセスできるようにします。

SQL Gateway を使うことで、SQLServer のリンクサーバー経由やMySQL へ接続できるツール、サービスなどからもSaaS にアクセスすることが可能になります。もちろん参照だけでなく更新も可能です。

手順

やることは大枠でこちらの内容です。

  • CData ODBC ドライバインストール & DSN 設定
  • SQL Gateway TDS プロトコルI/F を作成
  • SQL Server リンクサーバーを作成
  • SQL Server CDC 機能をオンにする
  • SQL Server 更新用ストアドプロシージャの作成
  • SQL Server エージェントでスケジュール設定

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。

  1. NetSuite をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
  2. 多様なアプリケーション、ツールにNetSuite のデータを連携
  3. ノーコードでの手軽な接続設定
  4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData ODBC ドライバでは、1.データソースとしてNetSuite の接続を設定、2.SQL Server 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

CData ODBC ドライバのインストールとNetSuite への接続設定

まずは、本記事右側のサイドバーからNetSuite ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

CData ODBC ドライバをインストールすると SQL Gateway もあわせてインストールされるようになっています。ではこちらのリンクからNetSuite をクリックして、インストーラーをダウンロードします。ダウンロードボタンをクリックしてNetSuite ODBC Driver をダウンロードします。

ダウンロードしたNetSuiteODBCDriver.exe をダブルクリックしてインストールを開始します。
インストール自体はデフォルトのまま進んで構いません。インストール後にDSN 設定画面が開きます。

  1. 接続プロパティの指定がまだの場合は、DSN （データソース名）で行います。Microsoft ODBC データソースアドミニストレーターを使ってODBC DSN を作成および設定できます。一般的な接続プロパティは以下のとおりです：
    • AccountId
    • Schema
    • AuthScheme
    • OAuthClientId
    • OAuthClientSecret
    • OAuthAccessToken
    • OAuthAccessTokenSecret

    Microsoft ODBC データソースアドミニストレーターで必要なプロパティを設定する方法は、ヘルプドキュメントの「はじめに」をご参照ください。

    NetSuiteへの接続

    NetSuite では、2種類のAPI でデータにアクセスできます。どちらのAPI を使用するかは、Schema 接続プロパティで以下のいずれかを選択して指定してください。

    • SuiteTalk は、NetSuite との通信に使用されるSOAP ベースの従来から提供されているサービスです。幅広いエンティティをサポートし、INSERT / UPDATE / DELETE の操作も対応しています。ただし、SuiteQL API と比べるとデータの取得速度が劣ります。また、サーバーサイドでのJOIN に対応していないため、これらの処理はCData 製品がクライアントサイドで実行します。
    • SuiteQL は、より新しいAPI です。JOIN、GROUP BY、集計、カラムフィルタリングをサーバーサイドで処理できるため、SuiteTalk よりもはるかに高速にデータを取得できます。ただし、NetSuite データへのアクセスは読み取り専用となります。

    データの取得のみが目的でしたらSuiteQL をお勧めします。データの取得と変更の両方が必要な場合は、SuiteTalk をお選びください。

    NetSuite への認証

    CData 製品では、以下の認証方式がご利用いただけます。

    • トークンベース認証（TBA）はOAuth1.0に似た仕組みです。2020.2以降のSuiteTalk とSuiteQL の両方で利用できます。
    • OAuth 2.0 認証（OAuth 2.0 認可コードグラントフロー）は、SuiteQL でのみご利用いただけます。
    • OAuth JWT 認証は、OAuth2.0 クライアント認証フローの一つで、クライアント認証情報を含むJWT を使用してNetSuite データへのアクセスを要求します。

    トークンベース認証（OAuth1.0）

    トークンベース認証（TBA）は、基本的にOAuth 1.0 の仕組みです。この認証方式はSuiteTalk とSuiteQL の両方でサポートされています。管理者権限をお持ちの方がNetSuite UI 内でOAuthClientId、OAuthClientSecret、OAuthAccessToken、OAuthAccessTokenSecret を直接作成することで設定できます。 NetSuite UI でのトークン作成手順については、ヘルプドキュメントの「はじめに」セクションをご参照ください。

    アクセストークンを作成したら、以下の接続プロパティを設定して接続してみましょう。

    • AuthScheme = Token
    • AccountId = 接続先のアカウント
    • OAuthClientId = アプリケーション作成時に表示されるコンシューマーキー
    • OAuthClientSecret = アプリケーション作成時に表示されるコンシューマーシークレット
    • OAuthAccessToken = アクセストークン作成時のトークンID
    • OAuthAccessTokenSecret = アクセストークン作成時のトークンシークレット

    その他の認証方法については、ヘルプドキュメントの「はじめに」をご確認ください。

ここまでで、CData NetSuite ODBC Driver の設定が完了しました。続いてはSQL Gateway の設定に入っていきます。

SQL Gateway でTDS プロトコルI/F を作成

Windows メニューにある SQL Gateway クリックして起動します。

カバー

SQL Gateway が起動されたらこのようなコンソール画面が表示されます。最初に「サービス」タブから追加ボタンをクリックします。

カバー

以下の内容で設定します。

  • サービス名：任意
  • I/F：サービス名下のラジオボタンでTDS（SQL Server）を選択
  • データソース：先ほど設定したDSN
  • ポート：未使用のもの
カバー

外部からこの SQL Gateway にアクセスする際のユーザー情報を作成します。

カバー

作成後は「変更を保存」→「開始」の順でボタンをクリックします。サービスが正常に開始されると、このように緑色のランプが点灯します。

カバー

これで データソースからSQL Gateway 間の接続設定と、TDS プロトコルでのインタフェース設定が完了しました。

リンクサーバーの作成

次にSQL Server とSQL Gateway をつなぐために、リンクサーバーを作成していきます。
SSMS で対象の SQL Server に接続し、「サーバーオブジェクト」->「リンクサーバー」から右クリックでリンクサーバーの新規作成を行います。

  • リンクサーバー名：任意
  • サーバーの種類：その他
  • プロバイダー：SQL Server Native Client
  • データソース：SQL Gateway を起動しているインスタンスとポート
    「インスタンス,ポート」の書き方。
  • カタログ：SQL Gateway で指定したDSN
カバー

セキュリティに移動して、SQL Gateway で作成したユーザー情報を入力して設定は完了です。

カバー

これでNetSuite のオブジェクトがリンクサーバーにテーブルとして表示されるようになりました。

カバー

SQL Server の設定（CDC）

まずは CDC（Change Data Capture） 機能をオンにしていきます。ちなみにこの CDC とは、各テーブルのデータの変更情報を保持してくれる機能です。
※CDC はStandard Edition 以上、もしくはDeveloper Edition で利用可能です。

今回はこのCDC 機能を使って変更データを抽出し、NetSuite に連携していきます。

CDC 機能を利用するデータベースを指定して以下のSQL を実行します。

    USE cdata;
    GO
    EXECUTE sys.sp_cdc_enable_db;
    GO

CDC の対象とするテーブルを設定します。

    EXEC sys.sp_cdc_enable_table
    @source_schema = N'dbo',
    @source_name = N'顧客データ_東北支店',
    @role_name = N'cdc_role',
    @supports_net_changes = 1
    GO
カバー


各種パラメータの説明はMicrosoft の公式ドキュメントをご参照ください。上記以外にも設定できるようです。

これで対象 DB のシステムテーブルに、変更情報を保持してくれるテーブルが表示されました。

カバー

何も変更していない状態では、dbo_顧客データ_東北支店_CT テーブルのレコードはない状態です。

カバー

CDC 対象の顧客データ_東北支店 テーブルにあるメールアドレス列の値を変更してみます。

カバー

もう一度、dbo_顧客データ_東北支店_CT テーブルを参照すると変更前後のレコードが格納されました。ちなみに$operation=3 で更新前、4で更新後となります。

カバー

これで SQL Server で変更したデータを確認することが出来るようになりました！

ストアドプロシージャの作成

シンプルに CDC テーブルの Name という項目だけを使用して、それをリンクサーバーの [NetSuite].[顧客管理（営業支援パック）] テーブルに Insert、Delete、Update で連携するということをやってみます。

    CREATE PROCEDURE NetSuiteSP
    AS
    BEGIN
    SET ANSI_NULLS ON
    SET ANSI_WARNINGS ON

    --カーソルの値を取得する変数宣言
    DECLARE @Id varchar(50)
    DECLARE @email varchar(50)
    DECLARE @Operation int

    --カーソル定義
    DECLARE CUR_1 CURSOR FOR
    SELECT a.[RecordId], a.[メールアドレス],a.[__$operation]
    FROM [cdata].[cdc].[dbo_顧客データ_東北支店_CT] AS a,
    (SELECT[RecordId] , MAX([__$seqval]) AS seqval
    FROM [cdata].[cdc].[dbo_顧客データ_東北支店_CT]
    GROUP BY [RecordId]) AS b
    WHERE a.[RecordId] = b.[RecordId]
    AND a.[__$seqval] = b.seqval
    --'3'は更新前レコード
    AND a.[__$operation] <> '3'

    --カーソルオープン
    OPEN CUR_1;
    FETCH NEXT FROM CUR_1
        INTO @Id,@email,@Operation;
        WHILE @@FETCH_STATUS = 0
        BEGIN

        -- 削除レコードの場合
        IF @Operation = 1
        BEGIN
        DELETE FROM [NETSUITE_GATEWAY].[CData NetSuite Sys].[NetSuite].[顧客管理（営業支援パック）] WHERE
        RecordId=@Id;
        END
        -- 新規レコードの場合
        ELSE IF @Operation = 2
        BEGIN
        INSERT INTO [NETSUITE_GATEWAY].[CData NetSuite Sys].[NetSuite].[顧客管理（営業支援パック）]
        ([メールアドレス])
        Values(@email);
        END
        -- 更新レコードの場合
        ELSE IF @Operation = 4
        BEGIN
        UPDATE [NETSUITE_GATEWAY].[CData NetSuite Sys].[NetSuite].[顧客管理（営業支援パック）] SET
        [メールアドレス] =
        @email
        WHERE
        RecordId=@Id;
        END

        --次のレコード
        FETCH NEXT FROM CUR_1
        INTO @Id,@email,@Operation;
        END

    --カーソルクローズ
    CLOSE CUR_1;
    DEALLOCATE CUR_1;

    --CDC変更テーブルのレコード削除
    Truncate table [cdc].[dbo_顧客データ_東北支店_CT]

    END

スケジュール設定

最後にSQL Server エージェントでストアドプロシージャのスケジュール実行を設定します。

カバー

ステップで新規作成から、先ほど作成したストアドプロシージャを実行するよう設定します。

カバー

実行タイミングを設定します。今回は夜中に毎日実行されるようスケジューリングしました。

カバー

設定後はこのように次にジョブが実行される時間やステータスなどが表示されています。

カバー

これで設定が完了しました！

SQL Server のデータを更新

以下は変更テーブルの中身です。赤枠内のレコードが リンクサーバーを介してNetSuite に反映される想定です。
赤枠レコードの内訳は、

  • 1行目：削除レコード（__$operation:1）
  • 2行目：更新前レコード（__$operation:3）
  • 3行目：更新後レコード（__$operation:4）
  • 4行目：追加レコード （__$operation:2）
カバー

ではこれでAM 3:00に実行されるのを待ってみると、ジョブが実行されました。

カバー

リンクサーバーの[NetSuite].[顧客管理（営業支援パック）] テーブルを参照すると、先ほど確認したレコードが削除も含めて反映されていました。

カバー

これであとはこのまま起動しておくだけで、SQL Server で更新したレコードをもとにNetSuite が更新されるようになりました。

おわりに

いかがでしたでしょうか。SQL Server の CDC 機能とストアドプロシージャ、リンクサーバーでNetSuite に自動連携できるようになりました。

CData ODBC Driver for NetSuite は 30日間の無償評価版がご利用可能です。こちらから をぜひお試しください。

CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。

はじめる準備はできましたか？

NetSuite ODBC Driver の無料トライアルをダウンロードしてお試しください：

 ダウンロード

詳細：

NetSuite Icon NetSuite ODBC Driver お問い合わせ

NetSuite ODBC ドライバーは、ODBC 接続をサポートする任意のアプリケーションからリアルタイムなNetSuite データに直接接続できるパワフルなツールです。標準のODBC ドライバーインタフェースを使用して、データベースのようにNetSuite にアクセスし、潜在顧客、連絡先、営業案件、アカウントなどの読み、書き、更新を実行できます。

この記事の内容

関連記事