ColdFusion から Sage X3 Cloud のデータにクエリ

CData JDBC ドライバーを使用すると、ColdFusion の高速開発ツールを使って Sage X3 Cloud のデータ にシームレスに接続できます。本記事では、ColdFusion から Sage X3 Cloud のデータ に接続し、Sage X3 Cloud テーブルにクエリを実行する方法を説明します。

ColdFusion で Sage X3 Cloud 用JDBC データソースを作成

JDBC データソースを設定すると、cfquery タグや executeQuery などのCFScript から標準SQL を実行できるようになります。

1. インストールディレクトリから、ドライバーのJAR ファイルと.lic ファイルをColdFusion のクラスパスにコピーします。例えば、C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib にコピーします。または、ColdFusion Administrator の［Java と JVM］ページで、［ColdFusion Class Path］ボックスにファイルへのパスを入力します。

   ドライバーのJAR ファイルとライセンスファイルは、インストールディレクトリの lib サブフォルダにあります。

   この手順の後、サーバーを再起動してください。

2. ドライバーをデータソースとして追加します。

   ColdFusion Administrator 画面で、［データ＆サービス］ノードを展開し、［データソース］をクリックします。［新しいデータソースの追加］セクションで、データソースの名前を入力し、［ドライバー］メニューから［Other］を選択します。

   

3. ドライバーのプロパティを設定します。

   • JDBC URL：JDBC URL に接続プロパティを入力します。JDBC URL は jdbc:sagex3cloud: で始まり、その後にセミコロン区切りで name=value 形式の接続プロパティを指定します。

     Sage X3 Cloud では OAuth 2.0 の Client Credentials フローを使用し、API へのアクセスには X-API-Key も必要です。AuthScheme を OAuth に設定し、以下の接続プロパティを指定します。

     • URL：Sage X3 Cloud インスタンスのベース URL。
     • OAuthAccessTokenUrl：OAuth トークンエンドポイント（例：https://your-auth-domain/oauth/token）。
     • OAuthClientId：OAuth アプリケーションのクライアント ID。
     • OAuthClientSecret：OAuth アプリケーションのクライアントシークレット。
     • Audience：トークンリクエストで使用する API の Audience 値。
     • XAPIKey：Sage X3 Cloud の管理者から提供された X-API-Key。
     • Folder：Sage X3 のフォルダ名（例：SEED）。このフォルダがデフォルトのスキーマとして使用されます。
     • Folders（オプション）：Sage X3 フォルダのカンマ区切りリスト（例：SEED,PERF）。各フォルダが個別のスキーマとして公開されるため、Schema.Table 構文でフォルダをまたいだクエリを実行できます。

     ドライバーは Client Credentials フローでアクセストークンを取得し、すべての API リクエストで X-API-Key とあわせて送信します。InitiateOAuth を GETANDREFRESH（デフォルト）に設定しておけば、トークンの取得と更新は自動で行われます。

     組み込みの接続文字列デザイナー

     JDBC URL の構築には、Sage X3 Cloud JDBC ドライバーに組み込まれた接続文字列デザイナーをご利用ください。JAR ファイルをダブルクリックするか、コマンドラインから実行します。

     
     java -jar cdata.jdbc.sagex3cloud.jar
     

     接続プロパティを入力し、接続文字列をクリップボードにコピーします。

     

     一般的なJDBC URL は次のようになります。

     jdbc:sagex3cloud:AuthScheme=OAuth;URL=https://x3server/;OAuthAccessTokenUrl=https://auth-domain/oauth/token;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;Audience=https://api-audience;XAPIKey=your_api_key;Folder=SEED;

   • Driver Class：ドライバークラスを入力します。ドライバークラスは cdata.jdbc.sagex3cloud.SageX3CloudDriver です。
   • Driver Name：ドライバーのユーザー定義名を入力します。
   • Username：認証に使用するユーザー名を入力します。
   • Password：認証に使用するパスワードを入力します。

これで、［操作］列で CData Sage X3 Cloud データソースを有効にして接続をテストできます。ステータスがOK と表示されたら、Sage X3 Cloud データソースの準備完了です。

クエリの実行

cfquery タグで Sage X3 Cloud にSQL ステートメントを送信できます。cfqueryparam タグを使用して、パラメータ化クエリを作成し、クエリ文字列によるSQL インジェクションを防止します。

注意：cfquery とcfscript を使用するには、.cfm ファイルを作成します。その.cfm ファイル内に、クエリを実行するコードを記述します（下記参照）。ファイルをWeb サーバーのルートディレクトリ（Adobe ColdFusion の場合はwwwroot など）に直接配置します。変更を反映するには、ファイル配置後にサービスを再起動してください。

<cfquery name="SageX3CloudQuery" dataSource="CDataSageX3Cloud">
  SELECT * FROM BPCUSTOMER WHERE BPCNUM = <cfqueryparam value="#BPCNUM#" cfsqltype="cf_sql_varchar">
</cfquery>
<cfdump var="#SageX3CloudQuery#">

CFScript で記述すると以下のようになります。

<cfscript>
result = queryExecute(
  "SELECT * FROM BPCUSTOMER WHERE BPCNUM = ?",
  [
    { value="MARTIN", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataSageX3Cloud" }
);

writeDump( var= result );
</cfscript>

その後、以下のように.cfm ファイルにリクエストを送信できます。

http://MyServer:8500/query.cfm?BPCNUM=MARTIN