【CPI】Looping Process Callで大量データをターゲットシステムにPostする

## はじめに
Cloud Integrationの機能に、ローカルのプロセスの中でODataサービスをページに分けて呼び、全レコードが終わるまで処理を繰り返すというものがあることを最近知りました。
ちょうど「ソースシステムからターゲットシステムへ、全レコードを連携したい」（ただし、レコードが大量なため分割して取得するなどの工夫が必要）という場面があったので、この機能を使えるか検証してみることにしました。

## 仕組み
上記の機能は[Looping Process Call](https://help.sap.com/docs/cloud-integration/sap-cloud-integration/define-looping-process-call)というコンポーネントによって提供されます。Looping Process Callは、**指定した条件が満たされている間**、ローカルプロセスを繰り返し実行します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/2698e329-b1f6-b615-ebdf-3f13e6cbfb1e.png)
ODataサービスはGetリクエストが来たときに、そのサービスで決められた最大の件数だけを返すようになっているものがあります。たとえばCAPの場合、デフォルトの最大取得件数は1000件です。
試しにCAPのODataサービスに件数を指定せずにリクエストすると、レスポンスの最後に`@odata.nextLink`というプロパティが返ってきます。これは「続きのデータをリクエストしたい場合はクエリにこれを指定してください」という意味です。

```
"@odata.nextLink": "Stock?$skiptoken=1000"
```

Cloud Integrationでは、ODataリクエストの後にプロパティの有無によって後続データがあるかどうかを判断し、後続がある場合はExchange Propertyの`<Recieverチャネル名>.OData.hasMoreRecords`にtrueを自動的に設定します。以下はフローをトレースした結果で、Exchange PropertyにOData.hasMoreRecordsが設定されています。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/798ea78d-f474-7b1d-0cae-eb284d761d87.png)
つまり、ローカルプロセスを繰り返し実行するかどうかの判定はCloud Integrationが自動的に行ってくれるので開発者が意識しなくてよいということです。

## シナリオ
在庫データをソースシステムからターゲットシステムへ、全件同期する仕組みを作ります。ソース、ターゲットそれぞれにODataサービスがあり、取得と登録を行うことができます。
※SDIなどを使ってテーブル連携ができればよいのですが、それができない制約があります。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/a3e44701-fe43-3ffa-7e60-0d32fafca2de.png)

在庫データは1万件あり、ODataで一度に取得したり、一度のバッチリクエストで登録することはできません。そこでCloud Integrationにより、①ソースからデータを分割して取得し、②ターゲットが受け取ることができるサイズに分割して登録を行います。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/f3b54f67-94be-d3af-2fea-719e18d6befe.png)

今回ソースのODataサービスはCAP (Cloud Foundry)、ターゲットはRAP (BTP ABAP Environment)で作成しています。サービスの作成についての説明は省略しますが、ソースはGitリポジトリに格納しています。

ソース：https://github.com/miyasuta/stock-source
ターゲット：https://github.com/miyasuta/stock-target

## 作成したフロー
作成したフローはメインのフローと2つのローカルプロセスから構成されます。

**メインのフロー**
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/c674fc77-024b-cf78-1a21-24ac6cc0d3bf.png)
**ローカルプロセス1**
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/5ee96a9f-825d-9b77-1c9e-05c19424f1ef.png)
**ローカルプロセス2**
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/3385ec38-d4bb-59c9-0d91-3f2c5accda4c.png)

このうちローカルプロセス1はBTP ABAP Environmentの認証用のトークンを取得する処理で、処理内容については以下のブログで説明しています。

https://qiita.com/tami/items/c40104ecad4c58d2953b

以下では、メインのフローとローカルプロセス2について見ていきます。

### メインのフロー
メインのフローはHTTPSで起動し、はじめにローカルプロセス1を呼び出してBTP ABAP Environmentのトークンを取得します。取得したトークンはExchange Propertyに設定されます。次に、ローカルプロセス2を繰り返し呼び出します。

Looping Process Callの設定は以下のようになっています。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/41e71cf8-d947-afe9-c625-2bc40553bca6.png)

|項目  |設定値  |
|---|---|
|Local Integration Process  |呼び出すローカルプロセスを指定  |
|Expression Type  |Non-XML  |
|Condition Expression  |`${property.<ODataのレシーバチャネル名>.OData.hasMoreRecords} = 'true'`  |
|Max. Numbers of Iterations|想定される最大の繰り返し数を指定|

ODataのレシーバチャネル名は、Request Replyの先にあるRecieverの名前（ここではstock-source-srv）です。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/87b752ad-4783-35d5-a60f-f3405b65aafd.png)

### ローカルプロセス2
ローカルプロセス2はメインのフローから繰り返し呼ばれる処理です。このプロセスでは、ソースシステムから在庫データを取得し、ターゲットシステムに登録します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/4c37c571-ecd6-1bd7-5ba1-98ce58a46892.png)

#### ①OData V4 Receiver Adapter
ソースシステムに接続して在庫データを取得します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/3a8d02d8-5167-2ff6-e78f-d80cd34a168f.png)
Looping Process Callと連携して繰り返し処理を行うため、**Process in Pages**にチェックをつけるのがポイントです。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/de55d8fe-3f7c-202c-f0c1-0a233beac38a.png)

参考：[Configure the OData V4 Receiver Adapter | Help Portal](https://help.sap.com/docs/integration-suite/sap-integration-suite/configure-odata-v4-receiver-adapter)
>By selecting Process in Pages, you enable the adapter to process messages in pages, the page size of which is defined in the server-side system. To use Process in Pages, you must use the adapter in a Local Integration Process that is invoked by a Looping Process Call step.

#### ②Router
ページごとにデータを取得していると、最後のリクエストの結果が0件になることがあります。これをそのまま後続のマッピング処理に流すとエラーになるので、結果が0件の場合は処理を終了させます。このため、Routerでは"/Stock/Stock"というプロパティが存在するかどうかをチェックしています。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/4b61f797-4501-2de1-1f77-6cda734c5482.png)


0件のときのペイロード：/Stock/Stockが存在しない
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/d424a442-455a-5cfe-ec5b-c081085a6c03.png)
0件でないときのペイロード：/Stock/Stockが存在する
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/537b3a24-34f6-8b88-ea91-b8ee67b19dda.png)

#### ③Message Mapping
ここでは、取得したデータをOData V2のバッチリクエストの構造にマッピングします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/074c3c32-baaa-6a31-1489-47d40da2c6ae.png)

※マッピング先のXMLスキーマの取得方法は以下のブログに記載しています。

https://qiita.com/tami/items/6a5ba7dc26bd825b6559#post-so-odata-v2-receiver-adapter

#### ④Content Modifier
ここでは、BTP ABAP EnvironmentのODataサービスを呼ぶためのAuthorizationヘッダを設定します。トークンはメインのフローで取得しExchange Propertyに持っていたものを設定します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/1aa1248f-ec0e-06fc-5d1b-0d23b3a1267d.png)

#### ⑤General Splitter
①では1000件単位にデータが取得されます（※）が、1000件を同時にターゲットシステムに登録しようとすると時間がかかります。そこでデータをさらに分割してバッチリクエストするために、General Splitterを使用します。
※登録する単位はサービスにより変わります
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/4b57c68c-4600-d3e7-6af1-11a5f4892415.png)

General Splitterでは、インプットデータがXPath Expressionで指定したノードで分割され、複数のパートに分かれます。イメージとしては以下のようなインプットを、

```xml
<?xml version="1.0" encoding="UTF-8"?>
<batchParts>
	<batchChangeSet>
		<batchChangeSetPart>
			<method>POST</method>
			<Stock>
				<StockType>
					<Productid>0000009001</Productid>
					<Batch>5572641653</Batch>
					<Location>69</Location>
					<Quantity>368</Quantity>
					<SourceLastChanged>2023-07-12T02:32:15Z</SourceLastChanged>
				</StockType>
			</Stock>
		</batchChangeSetPart>
	</batchChangeSet>
	<batchChangeSet>
		<batchChangeSetPart>
			<method>POST</method>
			<Stock>
				<StockType>
					<Productid>0000009002</Productid>
					<Batch>5240626519</Batch>
					<Location>2</Location>
					<Quantity>659</Quantity>
					<SourceLastChanged>2023-07-12T14:40:53Z</SourceLastChanged>
				</StockType>
			</Stock>
		</batchChangeSetPart>
	</batchChangeSet>
</batchParts>
```
以下のようにbatchChangeSetで切り出して複数のパートに分けます。
```xml
<?xml version="1.0" encoding="UTF-8"?>
<batchParts>
	<batchChangeSet>
		<batchChangeSetPart>
			<method>POST</method>
			<Stock>
				<StockType>
					<Productid>0000009001</Productid>
					<Batch>5572641653</Batch>
					<Location>69</Location>
					<Quantity>368</Quantity>
					<SourceLastChanged>2023-07-12T02:32:15Z</SourceLastChanged>
				</StockType>
			</Stock>
		</batchChangeSetPart>
	</batchChangeSet>
</batchParts>
```
```xml
<?xml version="1.0" encoding="UTF-8"?>
<batchParts>
	<batchChangeSet>
		<batchChangeSetPart>
			<method>POST</method>
			<Stock>
				<StockType>
					<Productid>0000009002</Productid>
					<Batch>5240626519</Batch>
					<Location>2</Location>
					<Quantity>659</Quantity>
					<SourceLastChanged>2023-07-12T14:40:53Z</SourceLastChanged>
				</StockType>
			</Stock>
		</batchChangeSetPart>
	</batchChangeSet>
</batchParts>
```
この際、**Grouping**によって1つのパートに含まれるレコードの数を、**Number of Concurrent Processes**によって、General Splitterの後の処理を何並列で実行するかを指定できます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/e787e6a4-a293-c983-0589-d26c0e8b4a39.png)
上記の例では1000個のデータを100個ずつに分け、5並列でバッチリクエストを投げます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/2faa5c86-6caa-d170-81d7-48156e74ae1b.png)

#### ⑥OData V2 Receiver Adapter
BTP ABAP EnvironmentのODataサービスを呼んで在庫データを登録します。この環境ではCSRFトークンチェックが行われるので、**CSRF Protected**にtrueを設定します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/94f5dff7-dd17-ce26-af23-8f3d8dd340f1.png)
Processingタブでは、**Enable Bath Processing**にチェックを入れます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/431d1f38-bcb0-637f-7231-7dfa6c50302b.png)
ヘッダには、ステップ④で設定したAuthorizationを設定します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/1d1343bd-09db-2772-6241-8ea6aca7bd2b.png)

※OData V2のAdapterを使っているのは、V4では任意の数のバッチリクエストに任意の数のリクエストを入れることができないためです。詳しくは以下のブログに書いています。

https://qiita.com/tami/items/6a5ba7dc26bd825b6559#%E4%BB%BB%E6%84%8F%E3%81%AE%E6%95%B0%E3%81%AE%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E3%82%92%E6%8A%95%E3%81%92%E3%82%89%E3%82%8C%E3%81%AA%E3%81%84

## 動作確認
Postmanからフローを起動すると、以下のように結果が返ってきます。レスポンスボディには、最後のローカルプロセスのペイロードの内容が設定されています。本来はメインのフローで呼び出し元に返したい内容を設定する必要があります。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/2ffa8848-f8b2-ed81-778f-0f514424155a.png)

1万件を連携するのにかかった時間は1分弱でした。なお、General Splitterを使わずに1000件を同時に登録した場合は1回の登録に30秒ほどかかりました（10000件では単純計算で5分）。100件ずつ5パラにした場合は1000の登録が7秒ほどで終了しました。

## バッチリクエストのエラーハンドリングについて
今回作成したフローではバッチリクエストのエラーハンドリングは行っていませんが、本来はやるべきです。バッチリクエストの場合、個別のリクエストがエラーになっても呼び出し自体は正常終了するので、フロー全体は正常終了になります。エラーハンドリングをする場合、バッチレスポンスの中のステータスコードを見てエラーの有無を判断する必要があります。

```xml:エラーがあるときのバッチレスポンス
<batchPartResponse>
    <batchChangeSetResponse>
      <batchChangeSetPartResponse>
        <headers>
          <Accept></Accept>
          <Accept-Language></Accept-Language>
          <Content-Length>1364</Content-Length>
          <dataserviceversion>1.0</dataserviceversion>
          <Content-Type>application/xml;charset=utf-8</Content-Type>
        </headers>
        <statusInfo>Bad Request</statusInfo>
        <contentId/>
        <body>&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;&lt;error xmlns=&quot;http://schemas.microsoft.com/ado/2007/08/dataservices/metadata&quot;&gt;&lt;code&gt;MC_CSP_USR_RUNTIME/006&lt;/code&gt;&lt;message xml:lang=&quot;en&quot;&gt;The key value is already in use. Please enter a different one.&lt;/message&gt;&lt;innererror&gt;&lt;application&gt;&lt;component_id&gt;BC-ESI-ESF-GW&lt;/component_id&gt;&lt;service_namespace&gt;/SAP/&lt;/service_namespace&gt;&lt;service_id&gt;ZAPI_STOCK_O2&lt;/service_id&gt;&lt;service_version&gt;0001&lt;/service_version&gt;&lt;/application&gt;&lt;transactionid&gt;de8c151fb1874ba1903f446cda69fcf6&lt;/transactionid&gt;&lt;timestamp&gt;20230712211001.3201380&lt;/timestamp&gt;&lt;Error_Resolution&gt;&lt;SAP_Transaction&gt;For backend administrators: use ADT feed reader &quot;SAP Gateway Error Log&quot; or run transaction /IWFND/ERROR_LOG on SAP Gateway hub system and search for entries with the timestamp above for more details&lt;/SAP_Transaction&gt;&lt;SAP_Note&gt;See SAP Note 1797736 for error analysis (https://service.sap.com/sap/support/notes/1797736)&lt;/SAP_Note&gt;&lt;Batch_SAP_Note&gt;See SAP Note 1869434 for details about working with $batch (https://service.sap.com/sap/support/notes/1869434)&lt;/Batch_SAP_Note&gt;&lt;/Error_Resolution&gt;&lt;errordetails&gt;&lt;errordetail&gt;&lt;ContentID/&gt;&lt;code&gt;MC_CSP_USR_RUNTIME/006&lt;/code&gt;&lt;message&gt;The key value is already in use. Please enter a different one.&lt;/message&gt;&lt;propertyref/&gt;&lt;severity&gt;error&lt;/severity&gt;&lt;target/&gt;&lt;transition&gt;true&lt;/transition&gt;&lt;/errordetail&gt;&lt;/errordetails&gt;&lt;/innererror&gt;&lt;/error&gt;</body>
        <statusCode>400</statusCode>
      </batchChangeSetPartResponse>
    </batchChangeSetResponse>
```
## 注意点
大量データを連携することでIntegration Suiteで処理されるメッセージサイズが大きくなり、課金額が膨らむ可能性があります。Cloud Integrationでは250KBごとに1メッセージとカウントされ、メッセージの数によって課金額が決まります（参考：[Discovery Center](https://discovery-center.cloud.sap/serviceCatalog/integration-suite?region=all&tab=service_plan)）
実際にこの方法を採用するかどうかは、メッセージサイズや連携頻度を確認し、許容範囲かどうかを見極めて決定する必要があります。

※1つのフローで処理されたメッセージサイズを確認する方法がわからなかったのですが、Usage AnalyticsからはIntegration Suite全体で処理された1日あたりのメッセージ数を見ることができました。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/276021/2b4a5efd-a873-1877-cadd-dc290f017354.png)