iFlow から SAP CPI の技術設計書を生成する

SAP Cloud Integration（SAP CPI）のどのプロジェクトでも技術設計書が求められ、その多くは 2 回書かれます。1 回目は構築前に仕様書から、2 回目は引き継ぎの際に iFlow から書きます。iFlow が変わっているからです。2 回目は、ほとんどが iFlow にすでに書かれていることの書き写しです。

この記事では、iFlow の技術設計書に含めるべき内容を挙げ、それを iFlow そのものから Word、PDF、HTML で、あるいは自社の Word テンプレートで生成する方法を紹介します。

設計書の役割

技術設計書は、その iFlow を作っていない人に、それがどう動くのかを伝えるものです。どのシステムをつなぐのか、途中でメッセージに何をするのか、どのように失敗するのか、運用担当者が動かすために何を知っておくべきか。レビューのとき、引き継ぎのとき、そして何か月も後にインターフェースが壊れたときに読まれます。

設計書に書くこと

• インターフェースの概要：名前、ID、package、目的、センダーとレシーバー、そのアダプターとアドレス。
• フロー：ダイアグラムと、プロセスごとにメッセージに何が起きるのかを説明する短い文章。
• ルーティング：各 Router、そのルートと条件、デフォルトルート。
• マッピングとスクリプト：それぞれが何をするのかを 1～2 文で。
• header とプロパティ：iFlow が設定するものと読むもの。
• エラー処理：Exception Subprocess と、それが何をするのか。
• セキュリティ：使用する認証情報とキーの名前（シークレットそのものは決して書かない）。
• 外部化パラメーターと、使用する Data Store、JMS キュー、ProcessDirect のリンク。
• 運用：どこで監視するのか、失敗したときにどうするのか、誰に連絡するのか。

手書きの設計書が古くなる理由

このリストの項目は、すべて iFlow の中にすでにあります。手で書き出すということは、アドレス、条件、パラメーター名を書き写すことであり、iFlow を変更するたびにその写しは少しずつ不正確になります。iFlow から生成した設計書は生成した日には正確で、変更後に作り直すのも 1 分で済みます。

iFlow から生成する

1. デザイナーで iFlow を開き、「Kitegra ツール」ボタンをクリックして「この iFlow をドキュメント化」を選びます。「iFlow ドキュメント」が新しいタブで開きます。
2. 読み取られた内容を確認します。参加者とアダプター、プロセスとそのステップ、ルート、マッピングとスクリプト、header とプロパティ、パラメーター、Security Material の名前、ストアとリンク、エラー処理です。
3. 「テンプレート」を選びます。「技術設計」、「簡易サマリー」、「運用引き継ぎ」のいずれかです。
4. 「プロジェクト」と「作成者」を入力します。次の設計書のために保持されます。
5. Word、PDF、HTML のいずれかでダウンロードします。

ダイアグラムは iFlow から描かれ、各プロセスには「… 経由で … からメッセージを受信します。」や「エラー時: …。」のような説明文が付きます。デザイナーを使わない場合は、代わりに「iFlow をアップロード（ZIP または .iflw）」を選びます。アップロードしたファイルはプランの iFlow 数にカウントされません。PDF のラベルは英語です。

自社の Word テンプレートを使う

プロジェクトにテンプレートがある場合は、「独自の Word テンプレート」を選びます。.docx ファイルの中で内容を入れたい場所にプレースホルダーを書き、「入力してダウンロード」を選びます。

Interface:   {{iflowName}} ({{iflowId}})
Package:     {{package}}
Project:     {{project}}        Author: {{author}}        Date: {{date}}

Purpose
{{description}}

Senders: {{senders}}        Receivers: {{receivers}}
Adapters: {{adapters}}

How it works
{{narrative}}

Routing: {{routes}}
Scripts: {{scripts}}
Error handling: {{errorHandling}}

ページには埋め込まれるすべてのプレースホルダーが一覧表示されます。その中には {{iflowName}}、{{package}}、{{narrative}}、{{routes}}、{{parameters}}、{{securityMaterial}}、{{errorHandling}} があります。Message Mapping には専用のシートがあります。Excel での Message Mapping のドキュメント化を参照してください。

Kitegra でできること

ドキュメントは、Kitegra の iFlow Docs 領域の機能です。設計書はブラウザー内で作られ、スクリプトとマッピングが Kitegra に送られることはありません。iFlow をドキュメント化する前に、レビューのチェックリストで、設計書に書きたくないような問題を見つけておきましょう。

Helper、Message Monitor、iFlow Inspector、iFlow Docs は、それぞれ使用した iFlow の数をカウントします。Kitegra アカウントなしではモジュールごとに 5 つ、Free プランでは 50、Starter では 100、Pro では 300 で、Business は上限なしです。Toolbox とワークスペースの追加機能は無料です。プランを比較する。

次の iFlow で試してみましょう

Kitegra が SAP Integration Suite のデザイナーに何を加えるのかを読むか、Kitegra のほかの Chrome 拡張機能と並べて確認できます。

よくある質問