IBM Rational Host Access Transformation Services V8.0 ...public.dhe.ibm.com/.../hats80_restfulwebtutorial_part1.pdfHost Access Transformation Services V8.0 RESTful Web サービス開発

IBM Rational Host Access Transformation Services V8.0 RESTful Web サービス開発チュートリアル第 1 回 HATS RESTful Web サービスの作成（前編）

日本 IBM システムズ・エンジニアリング(ISE) 株式会社

2012 年 3 月

『HATS V8.0 RESTful Web サービス開発チュートリアル』

2/47

© 2012 IBM Corporation

目次

目次 ......................................................................................................................................2 0. はじめに ........................................................................................................................3

0.1. 当資料について ......................................................................................................3 0.2. 対象読者 .................................................................................................................3 0.3. 前提環境 .................................................................................................................3

1. 概要 ...............................................................................................................................5 1.1. 学習目標 .................................................................................................................5 1.2. 所要時間 .................................................................................................................5 1.3. 前提 ........................................................................................................................5

2. HATS RESTful Web サービスの作成 ...........................................................................6 2.1. マクロの作成 ..........................................................................................................6

2.1.1. 正常時の処理を記録 ........................................................................................6 2.1.2. エラー時の処理を追加 ..................................................................................29


3/47


0. はじめに

0.1. 当資料について

当資料では、IBM Rational Host Access Transformation Services（以下、HATS）におい

て、HATS V8.0 の新機能である HATS RESTful Web サービスの開発方法について説明し

ます。HATS アプリケーション開発者はこのチュートリアルを通して、スムーズに HATS RESTful Web サービスの開発スキルを身に付けることができます。チュートリアルでは、受発注業務を行うための IBM i のホスト・アプリケーションを例に

とり、HATS RESTful Web サービス開発の手順を説明いたします。当資料の読者とはホス

ト・アプリケーションの環境が異なる場合もあると思いますが、適宜、読者の環境に当て

はめて読み進めていってください。当資料に含まれる情報は可能な限り正確を期しておりますが、IBM / ISE の正式なレビュー

を受けておらず、当資料に記載された内容に関して何ら保証するものではありません。当

ガイドでの記載内容はあくまでも支援情報であり、読者の責任において取り扱われるもの

とし、当資料の内容によって受けたいかなる損害に関しても一切の保証をするものではあ

りません。

0.2. 対象読者

・ホスト・アプリケーションの Web サービス化および他システムとの連携を検討されて

いる方・ HATS において RESTful Web サービスの使用を検討されている方・ HATS アプリケーション開発者

0.3. 前提環境

HATS Toolkit V8.0 以降が前提となります。 HATS Toolkit V8.0 の前提要件の最新情報は下記リンク先よりご確認いただけます。 http://www-01.ibm.com/support/docview.wss?uid=swg27019102 ■開発環境通常の HATS 前提要件と同様です。HATS Toolkit の要件を満たす Rational Software Delivery Platform (以下、Rational SDP)製品、WAS のテスト環境および HATS Toolkit V8.0 以降をインストールしてください。 ■実行環境


4/47


RESTful Webサービスを使用するHATSアプリケーションの実行環境がJAX-RSをサポー

トしている必要があります。JAX－RS は以下の WebSphere Application Server (WAS)および Feature Pack でサポートされます。 • WebSphere Application Server V6.1 Feature Packs • WebSphere Application Server V7.0 Feature Pack for Web 2.0 and Mobile • WebSphere Application Server V8.0 ※追加の Feature Pack 不要

■サポートされる Web ブラウザー通常の HATS 前提要件と同様です。要件を満たす Web ブラウザーを使用してください。 Rational SDPおよびHATSのインストール手順についてはそれぞれ以下をご参照ください。「RAD V8 インストール手順」（動画デモ） http://www.youtube.com/watch?v=61WzijNdML8&lr=1 「IBM Rational Host Access Transformation Services V7.5.1 開発ガイド－初心者のた

めのはじめの一歩－」の「1. はじめての HATS」 http://www.ibm.com/developerworks/jp/rational/library/em/cms/hats751_developmentguide/ ※HATS V7.5.1 の資料になりますが、基本的なインストール手順は V8.0 でも同様です。なお、このチュートリアルでは Web ブラウザーとして Firefox を使用することを前提とし

ています。また、RESTful Web サービスのテストを行うために「Poster」という Firefoxのアドオンとして無償で提供されるツールを使用します。Poster を使用して HTTP リクエ

スト（GET / POST / PUT / DELETE）を発行し、レスポンスを確認することができます。 Poster は以下のサイトからダウンロードしてインストールしてください。 https://addons.mozilla.org/ja/firefox/addon/poster/


5/47


1. 概要

1.1. 学習目標

このチュートリアルでは、HATS RESTful Web サービスの開発方法について学習します。

また、RESTful Web サービス・クライアントの例として AJAX を使用してブラウザー上か

ら RESTful Web サービスを呼び出すサンプルの作成方法を学習します。 HATS RESTful Web サービスを使用することで、例えばブラウザー上のマッシュアップに

ホスト・アプリケーションを参加させることができます。これにより、ブラウザーからホ

スト上のデータに容易にアクセスして利用することができます。他の Web サービス API と連携させて全く新しいサービスを創出することもできます。

1.2. 所要時間

このチュートリアルを終了するには、約 120 分かかります。このチュートリアルに関連し

たその他の概念や機能について調べる場合は、終了までにさらに時間がかかります。

1.3. 前提

このチュートリアルは、HATS Toolkit が既にインストールされており、かつ HATS Toolkit上に HATS Web プロジェクトが作成されていることを前提としています。HATS Toolkitのインストール手順および HATS Web プロジェクトの作成方法については下記資料をご参

照ください。「HATS V7.5.1 開発ガイド－初心者のためのはじめの一歩：第 1 回はじめての HATS」 http://www.ibm.com/developerworks/jp/rational/library/em/cms/hats751_developmentguide/part1/


6/47


2. HATS RESTful Web サービスの作成

ここでは、HATS RESTful Web サービスを作成する方法について学習します。商品検索サ

ービスとして、商品コードをキーに販売価格や在庫数といった商品情報を取得する

RESTful Web サービスを作成します。 HATS RESTful Web サービスは、以下の手順で作成します。 1. マクロの作成 2. 統合オブジェクトの作成 3. RESTful Web サービスの作成

2.1. マクロの作成

HATS Web プロジェクトにマクロを作成します。正常時（正しい商品コードが入力された

とき）の処理と、エラー時（例えば、誤った入力値が入力されたときなど）の処理を一つ

のマクロとして記録します。マクロの設計については、下記資料も参考してください。「HATS RESTful Web サービス開発ガイド」 http://www.ibm.com/developerworks/jp/rational/library/em/cms/hats_restfulweb_guide/ 2.1.1. 正常時の処理を記録

まず、正常時の処理として以下の一連のフローを記録します。 1. ホスト・アプリケーションへサイン・オン 2. 在庫照会メニューより、商品コードをキーに在庫照会し、結果を取得 3. ホスト・アプリケーションからサイン・オフマクロはホスト端末を使用して記録します。マクロの記録に際しては、ホスト端末で行っ

たキー入力などの操作が自動的に記録されます。「HATS プロジェクト」ビューから、HATSプロジェクトを右クリックし、「HATS ホスト端末をオープン」→「main」を選択してホス

ト端末を開きます。※main は接続ファイル名です。


7/47


ホスト端末が表示されたら、マクロの記録を開始します。ここでは、ホスト接続時に表示

される初期画面が「サイン・オン」画面なので、ここからマクロの記録を開始します。ツ

ール・バーから「マクロを作成」アイコン（）をクリックします。

マクロの名前を任意に入力し、「終了」をクリックします。ここでは、マクロ名を

「ShohinSearchMacro」とします。


8/47


マクロを開始する画面を認識させるため、画面認識基準を設定します。マクロを正しく開

始できるよう、マクロの開始画面を一意に認識できる画面認識基準を設定し、「次へ」をク

リックします。


9/47


画面認識基準を追加する必要があれば、ここからさらに追加してください。追加する必要

がなければ「終了」をクリックします。


10/47


ホスト端末でマクロとして記録する操作を実行します。ここで操作したとおりの操作がマ

クロとして記録されるため、できるだけ正確に操作を行います。マクロは後から修正でき

ますが、この時点で正確に操作を記録することをお勧めします。まず、サイン・オンの操作を記録します。ここでは、共通のユーザーID とパスワード（と

もに”WHPDEMO”）を使用します。ユーザーID とパスワードの入力欄にそれぞれ

「WHPDEMO」と入力し、実行キーを押下してサイン・オンを実行します。


11/47


サイン・オンを行うと、このアプリケーションでは「プログラム・メッセージの表示」画

面が表示されます。これは通常は表示されませんが、同じユーザーID で 2 つ以上のセッシ

ョンを接続したときに表示されます。ここでは、プログラム・メッセージですが、実業務

においては、たとえば月末のバッチ処理を実施する日だけ、サイン・オン後にバッチ処理

を実施することを警告するメッセージを表示するなど、ある条件のときのみ表示される画

面があるかもしれません。その場合、このような画面をマクロの中に記録しておかないと、

マクロがうまく動作しません。マクロに記録していない画面が表示されるとマクロがハン

グしてしまうため、こういった画面も記録しておく必要があります。マクロでは、このような画面を「作業中の画面」として記録します。「画面認識基準の定義」

アイコン（）をクリックします。


12/47


「画面認識基準の定義」ウィザードが表示されます。この画面を一意に認識できる画面認

識基準を設定し、「作業中の画面」にチェックを入れます。このチェックを入れることで、

この画面が表示される場合も、マクロがうまく動作するようになります。設定を終えたら

「終了」をクリックします。


13/47


この画面を処理するのに必要な操作を行います。ここでは、実行キーを押下します。

「メイン・メニュー」画面が表示されたら、続けて在庫照会の操作を記録します。オプシ

ョン欄に「09」を入力し、実行キーを押下します。


14/47


オプション欄に「2」を入力し、実行キーを押下します。


15/47


商品コードを入力する画面が表示されます。ここでは、商品コードをマクロの入力値とし

てユーザーから指定できるように定義します。カーソルが商品コード入力欄の先頭にある

ことを確認し、「プロンプト・アクションを追加」アイコン（）をクリックします。


16/47


画面認識基準を設定し、「終了」をクリックします。


17/47


プロンプト・アクションの名前を入力します。（この名前が Web サービスの入力パラメータ

ー名になります。）名前は英小文字から始める必要があります。ここでは、「shohinCode」と入力し、「OK」をクリックします。

プロンプト・アクションの設定が終了すると、プロンプトが表示されるので、実際に使用

する値を入力します。ここでは、有効な商品コードとして「BB0001」を入力し、「OK」を

クリックします。


18/47


プロンプトで入力した値がホスト端末に入力されます。商品コードが入力されたことを確

認し、実行キーを押下します。


19/47


商品コードによる在庫照会結果が表示されます。この画面から商品情報を取得し、マクロ

の出力値として定義します。まず、商品名を取得します。商品名が出力される領域をドラ

ッグして囲み、「抽出アクションを追加」アイコン（）をクリックします。このとき、商

品名として取り得る桁の最大値を囲むようにしてください。囲んだ領域がそのまま出力値

として抽出されます。領域内で文字がない箇所は半角ブランクとして抽出されます。


20/47


画面認識基準を設定し、「終了」をクリックします。


21/47


抽出アクションの名前を入力します。（この名前が Web サービスの出力パラメーター名にな

ります。）名前は英小文字から始める必要があります。ここでは、「shohinName」と入力し

ます。「位置」欄には予めホスト画面上で囲んだ領域が開始行/開始桁、終了行/終了桁で指定され

ます。抽出領域を変更したい場合はこの値を修正します。「抽出形式」欄では抽出形式を指定します。ここでは、「この領域を 1 つのストリングとし

て抽出」を選択します。抽出アクションの設定が終わったら、「終了」をクリックします。


22/47


「商品コード（shohinCode）」、「引当可能数（hikiate）」、「販売単価（kakaku）」について

も同様に抽出アクションを定義します。※（）内はこのチュートリアルで指定する抽出ア

クションの名前です。すべての抽出アクションを定義したら、最後にサイン・オフの操作を記録します。サイン・

オフするためにメイン・メニューまで戻ります。ここでは、[F1]キーを 2 回押下してメイン・

メニューに戻ることができます。


23/47


「メイン・メニュー」画面が表示されたら、ホスト・アプリケーションからサイン・オフ

します。オプション欄に「90」を入力し、実行キーを押下します。


24/47


サイン・オフ処理が完了したら、マクロの記録を停止します。「マクロの停止」アイコン（）

をクリックします。


25/47


マクロを終了する画面に対して画面認識基準を設定し、「終了」をクリックします。


26/47


最後にマクロを保管します。「マクロを保存」アイコン（）をクリックします。


27/47


続いて、記録したマクロが正しく動作するかどうかテストを行います。ホスト端末で「サ

イン・オン」画面を表示し、記録したマクロを実行します。「マクロを実行」アイコン（）

のすぐ右にある逆三角マークをクリックし、「ShohinSearchMacro」を実行します。

プロンプトが表示されるので、商品コードを入力し、「OK」をクリックします。ここでは、

有効な商品コードは「BB0001」～「BB0024」です。


28/47


マクロが実行され、抽出結果が表示されます。定義した抽出アクションが正しく実行され

ていることを確認します。

また、マクロが正常に終了することを確認します。マクロの終了画面（ここでは、「サイン・

オン」画面）で停止していることを確認します。

以上で正常時のマクロ処理の記録が完了しました。このままでは誤った入力値が入力された場合に、エラー画面でマクロが停止してしまいま

す。次項では、エラー時にもマクロ処理が正常終了するように、作成したマクロにエラー

時の処理を追加します。


29/47


2.1.2. エラー時の処理を追加

「2.1.1. 正常時の処理を記録」で作成したマクロを編集し、エラー時の処理を追加します。

ここでは、ホスト上に存在しない商品コード（「BB0001～BB0024」以外の半角文字）が入

力された場合の処理を追加します。初めに、作成済みのマクロにエラー画面を追加するために、エラー画面の画面キャプチャ

ーを取得します。ホスト端末を起動し、ホスト画面を操作してエラー画面を表示させます。

このアプリケーションではホスト上に存在しない商品コードを入力した場合、以下のよう

なエラー画面が表示されます。エラー画面が表示されたら、「画面キャプチャーを作成」ア

イコン（）をクリックします。


30/47


画面キャプチャーの名前を任意に入力し、「終了」をクリックします。

ホスト・アプリケーションからサイン・オフし、ホスト端末を閉じます。次に、「2.1.1. 正常時の処理を記録」で作成したマクロを編集するために「Visual Macro Editor (VME)」で開きます。「HATS プロジェクト」ビューからマクロを右クリックし、「ア

プリケーションから開く」→「Visual Macro Editor」を選択します。


31/47


マクロにエラー画面を追加します。「パレット」ビューの「画面」をクリックしてから、マ

クロの「設計」タブ内の空白スペースをクリックします。

エラー画面を選択し、「次へ」をクリックします。


32/47


「画面の関連付け（オプション）」にて「前の画面」と「次の画面」を選択し、画面を関連

付けます。このアプリケーションでは、「前の画面」に商品コードを入力する画面（ここで

は「画面 5」）を選択します。また、エラー画面が表示された後は[F1]キーを押下すると、

検索オプションを選択する画面に戻ることができます。従って、「次の画面」は検索オプシ

ョンを選択する画面（ここでは「画面 7」）を選択します。※画面の関連付けは画面を挿入

した後で行うことも可能です。「終了時にレイアウトをリセット」にチェックを入れると、「設計」タブに表示されるマク

ロのフローが整形されます。画面の設定が完了したら「次へ」をクリックします。


33/47


エラー画面の画面認識基準を設定します。「フィールドの総数」、「入力フィールドの数」、「カ

ーソルの位置」のチェックを外し、「追加」をクリックします。

エラー画面を一意に認識できる基準を設定する必要があります。画面 ID（DEMO09-3）を

認識基準として設定します。


34/47


このアプリケーションでは、画面 ID だけでは商品コードを入力する画面とエラー画面を識

別することができません。エラーの場合は、24 行目にエラー・コードおよびメッセージが

表示されるので、エラー・コードおよびメッセージの表示領域に何かしら文字が表示され

たら、つまり空白（ブランク）でなかったらという基準を設定します。「強調表示するフィールド」欄で「保護」にチェックを入れると保護フィールドが色付け

されます。24 行目の 6 桁目から 75 桁目までがエラー・コードおよびメッセージの表示領

域であることがわかります。24 行目の 6 桁目から 75 桁目までをドラッグして囲むと、「ス

トリング」欄に自動的に文字が入力されます。「ストリング」欄に自動入力された文字をす

べて削除し、代わりに半角スペースを 70 桁分入力します。そして、「属性」欄の「反転」

にチェックを入れ、「OK」をクリックします。


35/47


画面認識基準の設定が完了したら、「次へ」をクリックします。


36/47


エラー画面で実行するアクションを定義します。「追加」をクリックしてアクションを追加

します。ここでは、エラー・コードおよびメッセージを取得するための「抽出」アクショ

ンと、画面を遷移するための[F1]キーの入力アクションを追加します。


37/47


「抽出」アクションを選択し、「次へ」をクリックします。


38/47


エラー・コードが表示される領域をドラッグして囲み、任意の名前（ここでは「errorCode」）を入力します。「抽出形式」は「この領域を 1 つのストリングとして抽出」を選択し、「終

了」をクックします。

同様の手順で、エラー・メッセージを取得する抽出アクションを追加します。


39/47


さらに、画面遷移のための操作として「入力」アクションを追加します。

キーボードを使用して画面遷移のためのキー操作を指定します。「ストリング」欄にカーソ

ルを合わせて、キーボードの[F1]キーを押下すると、ストリング欄に「[PF1]」が入力され

ます。入力アクションを設定したら、「終了」をクリックします。


40/47


アクションの定義がすべて完了したら、「終了」をクリックします。なお、定義したアクションは上から順に実行されます。従って、抽出アクションは入力ア

クションよりも上部に定義する必要があることにご注意ください。


41/47


エラー画面の処理がマクロの「設計」タブのフローに挿入されたことを確認したら、マク

ロを保存します。

以上で、マクロにエラー時の処理フローを追加できました。


42/47


マクロをデバッグし、誤った商品コードを入力したときでもマクロが正常に終了すること

を確認します。ここでは、Visual Macro Editor (VME)のデバッグ機能を使用します。

「接続」アイコン（）をクリックし、ホスト画面を表示します。


43/47


ホスト画面が表示されたら、マクロの開始画面である「サイン・オン」画面が表示されて

いることを確認し、「マクロを実行」アイコン（）をクリックします。


44/47


商品コードに存在しないコードを入力し、「OK」をクリックします。

マクロが実行され、抽出結果が表示されます。エラー・コードおよびメッセージが正しく

取得できていることを確認します。


45/47


また、マクロが正常に終了していることを確認します。マクロの終了画面（ここでは、「サ

イン・オン」画面）で停止していることを確認します。


46/47


VME でマクロをデバッグ実行した場合、実行された画面フローが色付けされるため、実際

に使用した経路を確認することができます。

マクロのデバッグが完了したら、「切断」アイコン（）をクリックしてホスト接続を切断

します。※ホスト接続を切断する際は、ホスト・アプリケーションからサイン・オフされ

ていることを確認してください。

ここでは例として、ホスト上存在しない商品コードが入力された場合のエラー処理を追加

しました。基本的には、ホスト・アプリケーション上発生し得るすべてのエラーを洗い出

し、ホスト・アプリケーションが持つエラー・ハンドリングのロジックを利用して、マク

ロでエラー処理を記録します。しかし実際には、ホスト・アプリケーションの作りなどに

よって、マクロですべてのエラー・ハンドリングをすることが難しいケースも考えられま

す。そのような場合は、正常ケースとして想定する入力値のみマクロに渡るよう、フロン

ト・エンド側で制御するということが有効です。また、ホスト・アプリケーションのロジ

ックを使用したエラー・ハンドリングに頼ると、ユーザーの単純な入力ミスの場合でも都

度 Web サービスを呼び出してしまい、ホストとのデータ通信が発生します。ユーザー利便


47/47


性の観点から、単純なエラー・ハンドリングはユーザーの入力時などフロント・エンド側

で実施することが有効と考えられます。基本的にはマクロですべてのエラー処理を記録し

ますが、マクロでハンドリングできないエラーやユーザーの単純な入力ミスなどは、フロ

ント・エンド側でハンドリングすることを検討することが重要です。

Documents

IBM Rational Host Access Transformation Services V8.0 ...public.dhe.ibm.com/.../hats80_restfulwebtutorial_part1.pdfHost Access Transformation Services V8.0 RESTful Web サービス開発