SAP（カスタムソース）

SAP（カスタムソース）コネクターを使用すると、magritte-sap-source コネクタータイプのソースを手動で設定して、Foundry を SAP システムに接続できます。このコネクターは、新しい SAP コネクターで利用可能なガイド付き設定ではなく、YAML ベースのカスタム設定を使用します。

サポートされている機能

セットアップ

1. Data Connection アプリケーションを開き、画面右上の + 新規ソースを選択します。

2. カスタムソースを追加を選択します。

3. ソースの名前と場所を指定します。

4. カスタム YAML セクションに、ソース定義を入力します。

   Copied!
   1
   2
   3
   type: magritte-sap-source
   url: https://<host>:<port>/sap/palantir
   usernamePassword: <username>:{{password}}

   • <host> は SAP アプリケーションサーバーのホスト名です。
   • <port> は Internet Communication Manager（ICM）の HTTPS（または HTTP）ポートです。
   • ユーザー名とパスワードは、コネクターのインストール時に Foundry 用に作成した技術ユーザーのものです。

   {{password}} を表示どおりに入力してください。保存後、ダイアログの右側にある暗号化された値にパスワードの値を入力してください。

5. 保存を選択します。

Foundry でのコネクターのセットアップについて詳しくはこちら。

ストリーミング同期を有効にする（SLT のみ）

ストリーミング同期をサポートするには、ソースで SLT 接続タイプを明示的に設定する必要があります。ソースの YAML に connectionType パラメーターを追加します。

Copied!
1
2
3
4
5
6
7
type: magritte-sap-source
url: https://<host>:<port>/sap/palantir
usernamePassword: <username>:{{password}}
connectionType:
  type: slt
  slt:
    context: <context>

context の値は、SLT Replication Server とソース ERP システム間の RFC 接続の一意の識別子です。SLT の設定について詳しくはこちら。

ソース設定

ソースでは、次のパラメーターを設定できます。

ネットワークと接続

Foundry が SAP システムにアクセスできるように、エグレスポリシーを適切に設定してください。オンプレミスの SAP 環境では、通常、トラフィックを正しくルーティングするために Agent プロキシポリシーが必要です。

多くの SAP システムではカスタム署名の証明書を使用しているため、初めて接続を設定するときに SSL ハンドシェイク例外が発生する場合があります。お使いのシステムの正しいカスタム証明書を入手し、ソースに追加してください。

ソース探索

ソースを作成したら、SAP Source Explorer を使用して対話的に探索します。

1. ソースに移動し、ソースを探索して同期を作成を選択します。

   

2. リモート接続および SLT 接続の場合は、適切なコンテキストを選択します。

   

3. 関心のあるテーブルまたはモジュールを選択し、グラフに追加します。

   

バッチ同期

同期を作成する

Foundry に抽出する SAP オブジェクトごとに同期を作成します。

1. ソースの概要ページで、バッチ同期の横にある + 新規を選択します。
2. 標準設定として、名前、対象データセット、スケジュールを設定します。
3. トランザクションタイプを次のいずれかの選択肢に設定します。
   • APPEND — インクリメンタル（差分連携）更新用です。詳細はインクリメンタル同期を参照してください。
   • SNAPSHOT — フルロード用です。
4. SAP オブジェクトタイプを選択します（以下の SAP オブジェクトタイプを参照）。
5. SLT を使用する場合、またはリモートシステムに接続する場合は、コンテキストを選択します。コンテキストの詳細は、リモートエージェントをインストールするを参照してください。
6. オブジェクト名を入力します。入力すると、選択した SAP オブジェクトタイプに基づいて、一致するオブジェクトが項目に候補として表示されます。
7. インクリメンタル同期を設定する場合は、増分フィールドを指定します。
8. 必要に応じて、追加設定タブで追加のパラメーターを設定します。

SAP オブジェクトタイプ

同期設定 UI の SAP オブジェクトタイプドロップダウンでは、次のオブジェクトタイプを利用できます。

リモートオブジェクトタイプには、リモートシステムを識別するコンテキストの値が必要です。リモート接続について詳しくはこちら。

BEx クエリの設定

BEx は、SAP BW InfoProvider を基盤とする多次元クエリフレームワークです。BEx クエリは標準の SAP BW アクセス方法を使用し、SAP BW のすべての権限概念を継承します。BEx クエリは、InfoProvider ビューに適用されるビジネスロジックを表します。

オブジェクトタイプとして BW BEx Query を選択すると、同期エディターに専用の BEx クエリビルダーが表示され、次のオプションを使用できます。

BEx のページング設定については、同期パラメーターセクションの高度な YAML パラメーターを参照してください。

関数の設定

SAP 関数モジュールは、SAP システムからのデータ抽出と、SAP システムへのデータの書き戻しの両方を実行できます。コネクターは、テーブル形式の出力パラメーターを1つ以上持つ関数からのみデータを抽出できます。

関数の結果を抽出するには、Foundry の技術ユーザーに次の権限ロールが必要です。

• /PALANTIR/SERVICE_USER
• /PALANTIR/CONTENT_FUNCTION_ALL
• 特定の関数の実行に必要な権限ロールまたはオブジェクト

関数が2個以上の出力パラメーターを返す場合は、paramName パラメーターを使用して、Foundry データセットに書き込む出力を指定します。

Copied!
1
2
3
4
type: magritte-sap-source-adapter
sapType: function
obj: BAPI_USER_GETLIST
paramName: USERLIST

入力パラメーターは inputParams を使用して設定できます。次の3種類の値に対応しています。

テーブル型の入力パラメーターを使用する例：

Copied!
1
2
3
4
5
6
type: magritte-sap-source-adapter
sapType: function
obj: EM_GET_NUMBER_OF_ENTRIES
inputParams:
  IT_TABLES: '[{"TABNAME":"TSTC"}]'
paramName: IT_TABLES

アドバンスドタブ専用のオブジェクトタイプ

次のオブジェクトタイプはドロップダウンでは利用できず、アドバンスドタブから設定する必要があります。

トランザクションコード

SAP レポートによって生成されたデータを抽出します。ABAP List Viewer (ALV) を使用するレポートにのみ対応しています。

トランザクションコード名による指定：

Copied!
1
2
3
type: magritte-sap-source-adapter
sapType: tcode
obj: ZTEST_ALV

プログラム名による指定：

Copied!
1
2
3
4
type: magritte-sap-source-adapter
sapType: tcode
obj: RSUSR200
programType: program

次の任意のパラメーターを同期の YAML に追加できます。

HANA ビュー

SAP アプリケーション層で有効化された HANA ビューからデータを抽出します。前提条件については、SAP から HANA ビューを取り込むを参照してください。

新しい統合には、同期設定 UI で HANA ビューをオブジェクトタイプとして選択できる SAP ERP コネクターを使用します。

Copied!
1
2
3
type: magritte-sap-source-adapter
sapType: hanaview
obj: ZEXT_SBOOK

CDS ビュー

ABAP CDS (Core Data Services) ビューからデータを抽出します。ABAP CDS は、アプリケーションサーバーの中央データベース上でセマンティックデータモデルを定義します。

インクリメンタル（差分）同期

インクリメンタル同期は、同じテーブルから APPEND 形式のトランザクションを実行できる、状態を保持する同期です。インクリメンタル同期を有効にするには、トランザクションタイプを APPEND に設定します。

次のインクリメンタルの種類を利用できます。

次のテーブルは、オブジェクトタイプごとに対応するインクリメンタルの種類を示しています。

インクリメンタルフィールドの値は、単調増加する値であることが理想的です。システムは、ある日付の途中で同期が実行された場合にデータの欠落を防ぐため、「以上」の比較を使用します。その結果、Foundry データセットに重複する値が含まれる場合があるため、変換パイプラインの最初のステップで削除する必要があります。

テーブルタイプのインクリメンタル同期では、maxRowsPerSync 設定（詳細設定タブで設定）を使用して、1回の実行で返される行数の概算上限を設定します。これは、ネットワーク障害などの断続的な問題によって長時間の同期が中断される可能性がある場合に、大きなテーブルの初回同期を、より小規模で障害に強い一連の実行に分割するのに便利です。設定の詳細については、YAML パラメーターの詳細設定を参照してください。

ツインテーブルの設定

インクリメンタルツインテーブル設定では、ツインテーブルを指定します。インクリメンタルツインマッピング設定では、主要テーブルとツインテーブルの結合条件を定義します。

マッピング構文：

{PRIMARY_TABLE_NAME}-{FIELD_NAME}={TWIN_TABLE_NAME}-{FIELD_NAME}

複数の結合条件は、セミコロン（AND 演算子）で組み合わせることができます。

InfoProvider のリクエストベースのインクリメンタル（差分連携）

SAP BW では、DSO と InfoCube はデータ転送プロセス（DTP）を使用して読み込まれます。各 DTP は読み込みリクエストを作成し、コネクターはこれらのリクエストを使用して変更されたデータを取得します。

詳細設定タブで設定します。

Copied!
1
2
3
4
type: magritte-sap-source-adapter
sapType: infoprovider
obj: <technical-name-of-infoprovider>
incrementalType: REQUEST

インクリメンタル状態のリセット

フルロードを強制し、インクリメンタル取り込みを再初期化するには、次の手順を実行します。

1. 同期設定で詳細設定タブに切り替えます。
2. YAML に resetIncrementalState: true を追加します。
3. トランザクションタイプを SNAPSHOT に設定します（incremental* パラメーターはそのまま保持します）。
4. 同期を実行します。これにより完全なスナップショットが実行され、データセット内のすべてのファイルが置き換えられます。
5. YAML から resetIncrementalState: true を削除します。
6. トランザクションタイプを APPEND に戻します。

以降の同期では、通常どおりインクリメンタルな追加が再開されます。

同期パラメーター

次のパラメーターは、追加設定タブまたは詳細設定 YAML ビューで利用可能です。

一般パラメーター

デバッグログ

オンに設定すると、この同期のデバッグログが有効になります。

継続的なリソースチェック

オンの場合、すべてのページングリクエストがリソースチェック（メモリー、CPU）の対象になります。オフの場合、最初のページリクエストのみがチェックされます。詳細については、パフォーマンスパラメーターを参照してください。

リソースチェック

オフに設定すると、この同期のすべてのリソースチェックが無効になります。

フィルター

SAP から抽出したデータを絞り込みます。すべてのフィールド名はデータディクショナリと一致している必要があります。

例：

• 価格が500から650の範囲内: PRICE=500:650
• 得意先が A、B、または C: CUSTOMER=A,B,C
• 価格が500から650の範囲内、かつ得意先が A、B、または C: PRICE=500:650;CUSTOMER=A,B,C
• 品目が PAL、DIS、または SAP で始まる: MATERIAL=PAL*,DIS*,SAP*
• 日付が2019年8月9日以降（形式 YYYYMMDD）: DATE>=20190809

動的フィルター

動的フィルターでは、特別なキーワードと関数を使用して、より柔軟なフィルター式を作成します。アドオンのバージョン SP26 以降で利用可能です。

固定キーワード

日付計算関数

関数は、固定キーワードと直接組み合わせることも、入れ子にすることもできます。

• 単一の関数: [ADDDAY([TODAY], 1)]
• 入れ子: [GETDAY([ADDDAY([FIRSTDAYOFMONTH], -1)])]

例：

• 今日より後のレコード: BUDAT>[TODAY]
• 前月の最終日より後のレコード: BUDAT>[ADDDAY([FIRSTDAYOFMONTH], -1)]

詳細 YAML パラメーター

次のパラメーターには詳細設定タブが必要で、基本ビューには対応する設定がありません。

• maxRowsPerSync（SLT およびテーブルタイプのインクリメンタル同期）：同期の1回の実行で返される行数を制限します（近似値）。非常に大きなテーブルの初回同期を、小規模な実行に分割するのに役立ちます。

Copied!
1
maxRowsPerSync: 500000

• bexSettings（BEx のみ）：BEx クエリのページングを設定します。コネクターのバージョン SP22 以降で利用可能です。

Copied!
1
2
3
bexSettings:
  bexPaging: true
  bexMemberLimit: 10

• bexPaging：自動生成されたフィルターを使用するページングを有効にします。デフォルトは false です。
• bexMemberLimit：フィルター候補を選択するためのしきい値です。この値より多くのメンバーを持つ InfoObjects は、フィルター生成から除外されます。デフォルトは 200 です。最小値は 2 です。

-ignoreUnexpectedValues：同期が Unexpected value encountered in SAP data Failed to parse value XXX in field YYY で失敗する場合、日付または数値の値をパースできていません。同期を続行し、パースできない値を null に設定するには、次のようにします。

Copied!
1
ignoreUnexpectedValues: true

同期の終了時に、パース例外の概要を含む警告がログに記録されます。

-outputSettingsOverride：特定の同期について、ソースレベルの Parquet ファイルサイズ設定をオーバーライドします。

Copied!
1
2
3
4
5
outputSettingsOverride:
  maxFileSize:
    type: rows
    rows:
      max: 10000

Copied!
1
2
3
4
5
outputSettingsOverride:
  maxFileSize:
    type: bytes
    bytes:
      approximateMax: 400MB

ストリーミング同期

ストリーミング同期は、SAP SLT Replication Server を介した接続でのみサポートされ、接続の種類として SLT を明示的に設定したソースが必要です（上記のストリーミング同期を有効にするを参照）。

各ストリーミング同期は、SLT Replication Server に専用の Operational Delta Queue (ODQ) を作成し、購読します。Foundry はキューを定期的にポーリングします（デフォルトの間隔：1秒）。

• キューが空の場合、次のポーリングまで追加のリクエストは行われません。
• キューにあるレコードが50,000件以下の場合、同期的に処理されます。
• レコードが50,000件を超える場合、ページ分割して処理されます。

遅延を最小限に抑えるには、SLT Replication Server で利用可能なダイアログワークプロセスの数が、アクティブなストリーミング同期の数以上である必要があります。

ストリーミング同期を作成する

1. SAP ソースを開きます。概要ページでストリーミング同期のテーブルまで下にスクロールし、+ ストリーミング同期を作成を選択します。

   

2. ストリーミングする SAP テーブルの名前を入力します。

   

3. 出力ストリーミングデータセットの場所を選択します。

   

   続行する前に、画面下部のプレビューペインの読み込みが完了していることを確認してください。ストリーミングデータセットのスキーマは、このプレビューから生成されます。場合によっては、プレビューにデータが表示されず、スキーマのみが表示されることがありますが、それで十分です。

4. ストリーミング同期を作成を選択します。ストリームをすぐに開始するか、作成後に手動で開始するかを選択できます。

   

スループットとパーティションキー

スループット設定を通常から非常に高いに切り替えると、パフォーマンスが向上する場合がありますが、使用するパーティションの数は増加します。複数のパーティションを使用する場合、SAP からの一意のレコード間の順序を保証するために、パーティションキーを設定する必要があります。これらのキーは、SAP のテーブルの主キーに対応している必要があります。

Webhook

SAP Webhook を使用すると、Foundry から汎用モジュール（通常は BAPI（Business Application Programming Interface））を呼び出して、SAP にデータを書き戻せます。Webhook の設定方法の概要については、Webhookを参照してください。

Webhook のタスク本文は、Handlebars ↗ 構文を使用して作成する JSON ドキュメントです。呼び出す SAP 汎用モジュールの名前を指定し、その入力を指定して、返す出力を選択します。

タスク本文のフィールド

1件のレコードを書き戻す

次の例では、BAPI_SALESORDER_CHANGE を呼び出して販売伝票の購入日を変更し、SAP の RETURN テーブルを返します。リモートの SAP システムを対象にするには、システムのコンテキスト名を指定する remote ブロックを追加します。

Copied!
1
2
3
4
5
6
7
8
9
10
11
{
    "function-name": "BAPI_SALESORDER_CHANGE",
    "inputs": {
        "SALESDOCUMENT": {{json sales-doc-id}},
        "ORDER_HEADER_IN": { "PURCH_DATE": {{json purchase-date}} },
        "ORDER_HEADER_INX": { "UPDATEFLAG": "U", "PURCH_DATE": "X" }
    },
    "output": "RETURN",
    "remote": { "context": "<SAP_CONTEXT_NAME>" },
    "api-version": 2
}

複数のレコードを書き戻す

1回の呼び出しで複数のレコードを書き戻すには、inputs にオブジェクトの配列を渡し、output に必要な変数を列挙します。任意の parallel ブロックを使用して実行を調整します。次の例では、BAPI_PR_CREATE を使用して2件の購買依頼を作成し、2個の出力変数を返します。

Copied!
1
2
3
4
5
6
7
8
9
10
11
{
    "function-name": "BAPI_PR_CREATE",
    "commit": true,
    "parallel": { "max-jobs": 2, "max-calls-per-job": 4 },
    "inputs": [
        { "PRHEADER": { "PR_TYPE": "NB" }, "PRITEM": [ { "MATERIAL": "100-100", "PLANT": "1100", "QUANTITY": "1" } ] },
        { "PRHEADER": { "PR_TYPE": "NB" }, "PRITEM": [ { "MATERIAL": "100-200", "PLANT": "1100", "QUANTITY": "2" } ] }
    ],
    "output": ["NUMBER", "PRHEADEREXP"],
    "api-version": 2
}

Webhook の実行は SAP 側で並列化できます。inputs が2個以上のオブジェクトを含む配列である場合、または parallel ブロックを明示的に指定した場合は、空のブロックであっても自動的に並列化されます。任意の parallel ブロックを使用して実行を調整します。

• max-jobs — 同時に実行するジョブの最大数。
• max-calls-per-job — 各ジョブが処理するレコードの最大数。

省略した設定には SAP アドオンで定義された値が使用されます。デフォルトは3個のジョブと、ジョブあたり4回の呼び出しです。

max-jobs をレコード数より大きい値に設定しても問題ありません。余分なジョブは使用されず、リソースが無駄になることはありません。

レスポンス

parallel ブロックを指定しない1件のレコードの場合、レスポンスはリクエストした出力変数の数によって異なります。

1件のレコードで出力変数が1個の場合、その変数の行のリストが返されます。

Copied!
1
2
3
[
    { "NUMBER": "0010048439" }
]

1件のレコードで出力変数が複数の場合、変数名をキーとするオブジェクトが返されます。output["NUMBER"] のように名前でアクセスします。

Copied!
1
2
3
4
{
    "NUMBER": [ { "NUMBER": "0010048439" } ],
    "PRHEADEREXP": [ { "PREQ_NO": "0010048439", "PR_TYPE": "NB" } ]
}

並列ライトバックでは、入力が1件しかない場合でも、入力レコードごとに1個の要素を持つ配列が返されます。以下に例を示します。

Copied!
1
2
3
4
5
6
7
[
    {
        "OUTPUT": { "NUMBER": [ { "NUMBER": "0010048439" } ], "PRHEADEREXP": [ { "PREQ_NO": "0010048439" } ] },
        "ROWNO": 1,
        "MSG": [ { "MSGTYP": "S", "MSGTXT": "Purchase requisition 0010048439 created" } ]
    }
]

• OUTPUT は、そのレコードの結果であり、単一レコードのレスポンスと同じ形式です。
• ROWNO は、inputs 配列内の対応するエントリーの位置（1から始まる）です。これにより、各結果をその入力に対応付けられます。
• MSG は、そのレコードの SAP メッセージログです。各メッセージには、種類（MSGTYP：成功は S、エラーは E、警告は W、情報は I、中止は A）とテキスト（MSGTXT）が含まれます。レコードごとに個別のメッセージが報告されるため、どのレコードの処理に成功し、どのレコードの処理に失敗したかを確認できます。

HTTP レスポンスが成功を示さない場合、Webhook はエラーを返します。Webhook のレスポンスが成功を示していても、SAP の業務エラーが含まれている場合があります。SAP の RETURN 出力が利用可能な場合は、その出力をリクエストして内容を確認し、レコードごとの MSG エントリーを確認して、要求した変更に成功したかどうかを判断してください。

SAP アドオンの互換性

複数の出力変数、一括ライトバック、および並列ライトバックを使用するには、api-version を 2 に設定します。バージョン 2 には SAP アドオン 2.29.0 以降が必要です。api-version を省略すると、Webhook はバージョン 1 を使用します。このバージョンは、単一の入力と単一の出力変数をサポートし、parallel ブロックは使用できません。

バージョン 2 に切り替える際は、0 より大きい値の retries-per-request 設定を削除してください。

関連ドキュメント

次のガイドでは、SAP 側と Foundry 側の両方の設定を伴うワークフローについて説明しています。

• SAP から長いテキストを抽出する：STXL テーブルから長いテキストを解凍して取り込みます。
• カスタム権限とロール管理を設定する：SAP アドオンのカスタム権限ロールを設定します。
• エクストラクターを設定する：SAP BW Business Content エクストラクターを設定します。
• SAP から HANA ビューを取り込む：HANA 外部ビューを公開して取り込みます。
• OAuth 2.0 を使用したユーザーに紐づく SAP ライトバック：SAP へのユーザー名を指定したライトバック用に OAuth 2.0 を設定します。