[CAIレシピ] CAIでXQueryを利用する時に覚えておきたいこと

はじめに

CAIプロセスの実装時には、フィールドへの値の割り当てを計算式として指定できます。計算式では関数を指定するだけではなく、XQuery言語で記述したコードを指定することもできます。

XQuery言語に なじみ のない方もいらっしゃると思うので、本記事ではCAIプロセス開発でXQueryを利用する場合に最初に覚えておきたいことを紹介してみようと思います。

CAIがサポートするXQueryのバージョン

XQueryにはいくつかバージョンがあり、CAIでは XQuery 3.0 をサポートしています。

HOW TO: Parse JSON and retrieve the values of the ...
XQuery programming language provides a means to extract and manipulate data from XML documents or any data source that can be viewed as XML.
Currently, we use XQuery version 3.0 within the Cloud Application Integration.

なお、CAIではXQuery 1.0以降でサポートされている関数宣言(declare function)をサポートしていません。基本的にXQuery 3.0をサポートしているものの制限事項もあるようです。

FAQ: Is it possible to write custom functions or user defined functions for XQuery in CAI?
Please note that it is not possible to explicitly declare functions within a process generated through Application Integration Designer.

利用可能なXQuery関数

CAIプロセスの開発では、XQueryの標準関数(fn:xxx)に加えて、IICS側で用意している関数も利用できます。利用可能な関数の一覧は次のドキュメントから確認できます。
Design > Understanding Data Types and Field Properties > Using Functions

XQueryの基本 - FLWOR構文

XQueryの基本になるFLWOR構文を理解しておくと、XQueryを利用したコーディングを理解しやすいと思います。FLWOR構文は、以下の5つの要素から構成されます。

• For ... 変数を使ってデータの反復処理を行う
• Let ... 変数に値を割り当てる
• Where ... 条件を指定してデータをフィルタリングする
• Order by ... データを並べ替える
• Return ... 結果を返す

次のXQueryのコードサンプルを見てみましょう。

FLWOR構文のサンプル

for $book in 
  <books>
    <book>
      <title>Book 1</title>
      <price>1000</price>
    </book>
    <book>
      <title>Book 2</title>
      <price>1500</price>
    </book>
    <book>
      <title>Book 3</title>
      <price>2000</price>
    </book>
  </books>/book
let $discount := $book/price * 0.1
where $book/price >= 1500
order by $book/price descending
return 
<book>
  <title>{string($book/title)}</title>
  <price>{string($book/price)}</price>
  <discounted-price>{($book/price - $discount)}</discounted-price>
</book>

//実行結果
<book>
  <title>Book 3</title>
  <price>2000</price>
  <discounted-price>1800</discounted-price>
</book>
<book>
  <title>Book 2</title>
  <price>1500</price>
  <discounted-price>1350</discounted-price>
</book>

このコードサンプルでは次の要件で書庫データ(books)を操作しています。

• For: 書庫データ(books)のbook要素を対象に反復処理します
• Let: 各book要素の値引き価格(10%)の計算結果をdiscount変数に代入します
• Where: priceが1500以上のデータだけを取得します
• Order by: priceの高い順に並べ替えます(descending)
• Return: 元のXMLデータに加えて値引き後価格を追加したXMLデータを返します

XQuery と XPath

XQueryはXPathを組み込んでいるため、XQueryのクエリでXPathを使ってデータの選択が行われます。XPathは、XQueryの中で「データを選択するための手段」を提供し、XQueryはその後の操作や変換を行います。

様々なサンプルを次の記事で紹介しているので、参考にしていただければと思います。

• XQuery+XPathサンプル

XQueryの動作確認をしたい場合

XQueryのコードは次のページでも動作確認ができます。

例えば前述したXQueryのコードサンプルを画面右上にコピー&ペースト、出力結果をxml形式とすることで、コードの実行結果を確認できます。

XQueryの実装で困った場合

生成AIに聞くと、とっても親切に教えてもらえます。また、生成AIに実装要件を伝えると、XQueryのサンプルコードも書いてくれますので、実装時に非常に強力な補助ツールになるでしょう。

例えば、1から10までの合計を取得する処理(等差数列の和)についてChatGPTに聞くと次のようにコードを教えてくれます。

CUIコーディング vs GUIコーディング

ジャンプステップによる実行制御でも等差数列の和を求める実装方法を確認していました。

この実装では等差数列の和を求めるために3つのステップを利用していましたが、XQueryを活用すると割り当てステップ1つで同じ処理を実装できます。

CUIコーディング(XQueryによるロジックの定義) と GUIコーディング(ステップによるロジックの定義)のメリット・デメリットを理解して、どちらのコーディングスタイルを選択するかをプロジェクトで検討しても良いかもしれませんね。

• CUIコーディングのメリット・デメリット
  苦手な人もいるが、少ないパーツ(ステップ)で処理を実装できるため処理の全体像を把握しやすくなる場合がある
• GUIコーディングのメリット・デメリット
  万人にわかりやすいが、パーツ(ステップ)が多くなり処理の全体像を把握しにくくなる場合がある

参考情報

• Qiita - IICS CAIの実装レシピ - マスターページ