Oracle APEX Workshop II 日本語版

Oracle APEX Workshop II APEX RESTハンズオン 2020年8月 20.1対応版日本オラクル株式会社 Copyright
© 2020, Oracle and/or its affiliates 1

• 使用する表の作成 • REST APIの有効化(1/3) AutoRESTによるREST API定義 • REST APIの有効化(2/3)
APEXのユーザー・インターフェースを使用したREST API定義 • REST APIの有効化(3/3) PL/SQLスクリプトを使用したREST API定義 • アプリケーションの作成 • アプリケーションのカスタマイズ • REST操作のテスト • LOVの作成本ワークショップにて実施する内容 Copyright © 2020, Oracle and/or its affiliates 2

3 Copyright © 2020, Oracle and/or its affiliates 資料のダウンロード •
以下のリンクにアクセスし、資料をダウンロードする。ワークショップで使用するスニペット https://apex.oracle.com/pls/apex/r/japancommunity/simcontents/downloa d?id=APEX_Workshop2_snippets.txt REST APIを定義するスクリプト https://apex.oracle.com/pls/apex/r/japancommunity/simcontents/downloa d?id=workshop2-enable.txt

• 本ワークショップでは、オラクル・データベースに存在する従業員データを保持する表（EMP, DEPT) に、REST APIによるインターフェースを作成します。 • REST APIを使用して、これらのリモート表を扱うAPEXアプリケーションを作成します。このアプリケーションは、リモート表のデータの一覧に加えて、挿入、更新および削除を行います。 •
REST APIの作成方法として３通りの手順が含まれています。どれかひとつの手順を行うことで、後続の作業を継続することができます。３つすべて実施することもできます。 • ワークショップの環境にapex.oracle.comを使用する場合、AutoRESTで作成したREST APIのパフォーマンスはあまり良くありません。大量の表をホストしているためです。AutoREST以外の方法で作成したREST APIでは、そのようなことは発生しません。作業補足 Copyright © 2020, Oracle and/or its affiliates 4

6 Copyright © 2020, Oracle and/or its affiliates Step 1
- ワークスペースのリクエスト • ブラウザよりhttps://apex.oracle.com/にアクセスする。 • 「無料で開始」をクリックする。 • 「無償ワークスペース」のリクエストをクリックする。

- 新規に作成するワークスペース情報の指定 • 名、姓、電子メール、ワークスペース名、国、使用状況を、それぞれ入力する。 • Oracleプライバシ・ポリシーを確認する。 • 国は「日本」、使用状況の組織は教育機関を想定しているため、「個人」を選択します。ワークスペースの制限は • 英数字と”_”アンダースコア • 30文字以下 • 大文字小文字の区別なし • 他の利用者も含み、既に使用済みのワークスペース名は使えない

- アンケートへの回答 • 「Oracle APEXは初めてですか？」という質問に回答する。 • 「学校の授業で使いますか？」という質問に回答する。

- リクエストする理由の入力 • ワークスペースを作成する理由について入力する。

- サービス規約への同意 • 本サービスの利用規約に同意します。 • apex.oracle.comは学習/検証の用途の利用に制限されています。

– ワークスペースの作成リクエストを送信 • 指定した内容が正しいことを確認し、「リクエストの送信」をクリックする。

– メールを受信した後、ワークスペースを作成 • 数分で、[email protected] からメールが届く。 • メール本文にある「Create Workspace」をクリックする。

– サインイン画面に進む • 「サインイン画面に進みます」をクリックする。

– パスワードの設定 • パスワードを設定して、「パスワードの変更」をクリックする。

– Oracle APEXホーム画面 • アプリケーション・ビルダー • アプリケーション開発を行う。 • SQLワークショップ • DBの操作、表、ビュー、索引、パッケージといったDBオブジェクトの作成 /更新/削除を行う。 • チーム開発 • アプリケーションのリリース管理を行う機能を提供する。 • アプリケーション・ギャラリー • サンプル・アプリケーションを提供する。

• SQLワークショップからユーティリティ、「サンプル・データセット」を呼び出す。 Step 1 – サンプル・データセットの呼び出し Copyright © 2020, Oracle
and/or its affiliates 17

• 言語として、ドロップダウン・リストから「Japanese」を選択する。 • スキーマは画面上のデフォルト値を変更しない。 • 「次」をクリックする。 Step 3 – 日本語のサンプル・データセットを使用
Copyright © 2020, Oracle and/or its affiliates 19

• 作成されるデータセット・データベース・オブジェクトを確認し「データセットのインストール」をクリックする。 Step 4 – サンプル・データセットのインストール Copyright © 2020,
Oracle and/or its affiliates 20

REST APIの有効化(1/3) AutoRESTによるREST API定義 Copyright © 2020, Oracle and/or its
affiliates 23

• RESTfulサービスがスキーマにたいして有効化されていなければ、ORDSに登録されていないスキーマと表示される。 • その場合、「ORDSにスキーマを登録」をクリックする。 Step 2 – ORDSにスキーマを登録 Copyright

• RESTfulアクセスの有効化を「ON」にする。 • スキーマ別名は変更不要です。スキーマ名に”_”(アンダースコア)が含まれる場合は取り除きます。 • サンプル・サービスは同名のEMP、DEPT表のインストールを行うため、インストールしない。 (「OFF」に設定する) • メタデータ・アクセスに必要な認可は「OFF」とする。 •
すべて設定したのち、「スキーマ属性の保存」をクリックする。 Step 3 – ORDSスキーマ属性の設定 Copyright © 2020, Oracle and/or its affiliates 26

• 左ペインのオブジェクト・セレクタより「表」を選ぶ。 • EMPを検索し、検索結果からEMP表を選択する。 • 「 REST」タブをクリックし、REST APIの属性情報を表示する。 • オブジェクトのRESTの有効化を「はい」にする。
• 認可が必要を「いいえ」にする。 • 上記を設定し、「適用」をクリックする。 Step 6 – EMP表のREST API有効化 Copyright © 2020, Oracle and/or its affiliates 29 実運用の場面ではセキュリティを考慮し、 1. オブジェクト別名をつける(表名と同じにしない) 2. 認証と認可を要求するといった設定を行う。

• REST APIの有効化が行われると、RESTful URLとしてEMP表にアクセスするREST APIのエントリが現れるので、をクリックして、クリップボードにコピーする。 Step 7 –
REST API有効化完了 Copyright © 2020, Oracle and/or its affiliates 30

• クリップボードにコピーしたURLにて、EMP表にブラウザからアクセスする。 • JSON形式のデータが取得されることを確認する。 Step 8 – REST APIのテスト Copyright

• EMP表と同じ作業をDEPT表に実施し、REST APIを有効化する。 Step 9 – DEPT表のREST API有効化 Copyright ©
2020, Oracle and/or its affiliates 32

REST APIの有効化(2/3) APEXのユーザー・インターフェースを使用した REST API定義 Copyright © 2020, Oracle and/or
its affiliates 33

• RESTfulサービスがスキーマにたいして有効化されていなければ、ORDSに登録されていないスキーマと表示される。 • その場合、「ORDSにスキーマを登録」をクリックする。 Step 2 – ORDSにスキーマを登録 Copyright

• RESTfulアクセスの有効化を「ON」にする。 • スキーマ別名は変更不要です。スキーマ名に”_”(アンダースコア)が含まれる場合は取り除く。 • サンプル・サービスは同名のEMP、DEPT表のインストールを行うため、インストールしない。 (「OFF」に設定する) • メタデータ・アクセスに必要な認可は「OFF」とする。 •
すべて設定したのち、「スキーマ属性の保存」をクリックする。 Step 3 – ORDSスキーマ属性の設定 Copyright © 2020, Oracle and/or its affiliates 36

• 左ペインより「モジュール」をクリックする。 • 「モジュールの作成」をクリックする。 • 以下、モジュールの設定をする。 • モジュール名：emp.rest
• ベース・パス：/emp/ • 公開：ON • 「モジュールの作成」をクリックする。 Step 5 – モジュールの作成 Copyright © 2020, Oracle and/or its affiliates 38

• 左ペインより、モジュールの「emp.rest」をクリックする。 • 右ペイン下にある、「テンプレート作成」をクリックする。 Step 6 – テンプレート作成の呼び出し

• URIテンプレートとして「hol/」を入力する。 • 「テンプレートの作成」をクリックする。 Step 7 – テンプレートの作成(従業員全体)

• モジュールemp.restに含まれるテンプレート「hol/」をクリックする。 • 右ペイン下にある、「ハンドラの作成」をクリックする。 Step 8 –
ハンドラ作成の呼び出し Copyright © 2020, Oracle and/or its affiliates 41

• メソッドは「GET」を選択する。 • ソースタイプは「Collection Query」を選択する。 • ソースとして、下に記載のSQLを入力する。 •
「ハンドラの作成」をクリックする。 Step 9 – GETハンドラの作成(従業員一覧) Copyright © 2020, Oracle and/or its affiliates 42 select * from emp

• 左ペインの「hol/」をクリックする。 • 「ハンドラの作成」をクリックして右の画面を開く。 • メソッドは「POST」を選択する。 • ソースとして、下に記載のPL/SQLコードを入力する。 • 「ハンドラの作成」をクリックする。
Step 10 – POSTハンドラの作成(従業員追加) Copyright © 2020, Oracle and/or its affiliates 43 begin insert into emp (empno, ename, job, mgr, hiredate, sal, comm, deptno) values (:empno,:ename,:job,:mgr,:hiredate,:sal,:comm,:deptno); :forward_location:=:empno; :status_code:=201; end;

• 左ペインの「emp.rest」をクリックする。 • 「テンプレートの作成」をクリックして下の画面を開く。 • URLテンプレートとして「hol/:empno」を入力する。 • 「テンプレートの作成」をクリックする。 Step 11
– テンプレートの作成(従業員単位) Copyright © 2020, Oracle and/or its affiliates 44

• 左ペインのテンプレート「hol/:empno」をクリックする。 • 「ハンドラの作成」をクリックする。 • メソッドは「GET」を選択する。 • ソース・タイプは「Collection Query Item」を選択する。
• ソースとして、下に記載のSQLを入力する。 • 「ハンドラの作成」をクリックする。 Step 12 – GETハンドラの作成(従業員情報取得) Copyright © 2020, Oracle and/or its affiliates 45 select * from emp where empno = :empno

• テンプレートhol/:empnoのハンドラの作成を呼び出す。 • メソッドは「PUT」を選択する。 • ソースとして、下に記載のPL/SQLを入力する。 • 「ハンドラの作成」をクリックする。 Step 13
– PUTハンドラの作成(従業員情報更新) Copyright © 2020, Oracle and/or its affiliates 46 begin update emp set ename=:ename, job=:job, mgr=:mgr, hiredate=:hiredate, sal=:sal, comm=:comm, deptno=:deptno where empno=:empno; :forward_location:=:empno; :status_code:=200; end;

• テンプレートhol/:empnoのハンドラの作成を呼び出す。 • メソッドは「DELETE」を選択する。 • ソースとして、下に記載のPL/SQLを入力する。 • 「ハンドラの作成」をクリックする。
Step 14 – DELETEハンドラの作成(従業員情報削除) Copyright © 2020, Oracle and/or its affiliates 47 begin delete emp where empno = :empno; :status_code := 200; end;

• 左ペインより「モジュール」をクリックする。 • 「モジュールの作成」をクリックする。 • 以下、モジュールの設定をする。 • モジュール名：dept.rest
• ベース・パス：/dept/ • 公開：ON • 「モジュールの作成」をクリックする。 Step 15 – DEPT表のモジュール作成 Copyright © 2020, Oracle and/or its affiliates 48

• 左ペインより、モジュールの「dept.rest」をクリックする。 • 右ペインにある、「テンプレートの作成」をクリックする。 Step 16 – テンプレート作成の呼び出し

• URIテンプレートとして「hol/」を入力する。 • 「テンプレートの作成」をクリックする。 Step 17 – テンプレートの作成

• モジュールdept.restに含まれるテンプレート「hol/」をクリックする。 • 右ペイン下にある「ハンドラの作成」をクリックする。 Step 18 –
ハンドラ作成の呼び出し Copyright © 2020, Oracle and/or its affiliates 51

• メソッドは「GET」を選択する。 • ソース・タイプは「Collection Query」を選択する。 • ソースとして、下に記載のSQLを入力する。 •
「ハンドラの作成」をクリックする。 Step 19 – GETハンドラの作成(部署一覧) Copyright © 2020, Oracle and/or its affiliates 52 select * from dept

• 右ペインのモジュールemp.restに含まれる、テンプレート「hol/」をクリックする。 • コピー・アイコンをクリックし、完全なURL をコピーする。 • ブラウザにURLをペーストし、呼び出す。 •
JSON形式のデータが取得されることを確認する。 • dept.restについても同様に確認する。 Step 20 – REST APIのテスト Copyright © 2020, Oracle and/or its affiliates 53

REST APIの有効化(3/3) PL/SQLスクリプトを使用したREST API定義 Copyright © 2020, Oracle and/or its
affiliates 54

• スクリプト・エディタにて、 • スクリプト名に「手動REST」と入力する。 • workshop2-enable.txtファイルの内容をスクリプト本体としてコピペする。 • 「実行」をクリックする。 Step 2
– REST APIを作成するスクリプトの実行 Copyright © 2020, Oracle and/or its affiliates 56 • 「即時実行」をクリックする。

• 「アプリケーション・ビルダー」をクリックする。 • 「作成」をクリックする。 • 「新規アプリケーション」をクリックする。 Step 1 – アプリケーションの作成

• 名前に「リモート従業員」と入力する。 • その他はデフォルトの設定のままとする。 • 「アプリケーションの作成」をクリックする。 Step
2 – アプリケーションの作成 Copyright © 2020, Oracle and/or its affiliates 60

• 「共有コンポーネント」をクリックする。 • データ・ソースのグループに含まれる「Webソース・モジュール」をクリックする。 Step 3 – Webソース・モジュールの作成

• Webソース・タイプは「Oracle REST Data Services」を選ぶ。 • 名前は「REST Emp Source」を指定する。静的IDとして使用されるた
め、別の値は設定しない。 • URLエンドポイントとして、EMP 表のRESTful URIとしてテストした値を指定する。 • HTTPSホスト名の指定は不要。 • 「次」をクリックする。 Step 5 – Webソース・モジュールの作成 Copyright © 2020, Oracle and/or its affiliates 63 AutoRESTの場合、処理が次に移るまで数十秒程度かかる場合があります。 URLエンドポイントは AutoRESTの場合は https://APEXホスト名/プレフィックス/スキーマ別名/emp/ 手動作成した場合は https://APEXホスト名/プレフィックス/スキーマ別名/emp/hol/

• 自動的に設定されたベースURLとサービスURLパスを確認して、「次」をクリックする。 • 自動設定された値の変更は通常不要。 Step 6 – Webソース・モジュールの作成 Copyright ©
2020, Oracle and/or its affiliates 64 手順によってはパスにhol/がつく。

• 認証は設定していないので、「OFF」のままにする。 • 「検出」をクリックする。 Step 7 – Webソース・モジュールの作成 Copyright ©
2020, Oracle and/or its affiliates 65 処理が次に移るまで、１分近く待ちます。

• EMP表のWebソース・モジュールの作成が完了した。 • モジュール名の「REST EMP Source」をクリックし、設定内容を確認する。 Step 9 – Webソース・モジュールの作成

• REST EMP Sourceの検出された操作を確認する。 • URLパターン :empno で定義されたGET, PUT,
DELETEの操作がなければ、「操作の追加」をクリックする。 • REST APIをAutoRESTではなく、手動で設定した場合、これらの操作は自動検出されない。 • URLパターン :empno の操作、GET、 PUT、DELETEの３つを追加する。 • AutoRESTでREST APIを作成した場合は不要となる手順。 Step 9.1 – 操作の追加を呼び出す Copyright © 2020, Oracle and/or its affiliates 68

• Webソース操作として、以下を設定する。 • URLパターン：:empno • HTTPメソッド：GET • データベース操作：単一行のフェッチ • 「作成」をクリックする。
• AutoRESTでREST APIを作成した場合は不要となる手順。 Step 9.2 – GET操作の追加(従業員情報取得) Copyright © 2020, Oracle and/or its affiliates 69

• 「操作の追加」をクリックする。 • Webソース操作として、以下を設定する。 • URLパターン：:empno • HTTPメソッド：PUT • データベース操作：行の更新
• 「作成」をクリックする。 • AutoRESTでREST APIを作成した場合は不要となる手順。 Step 9.3 – PUT操作の追加(従業員情報更新) Copyright © 2020, Oracle and/or its affiliates 70

• 本ワークショップでは、Oracle APEXとOracle REST Data Servicesを使用しているため、リクエスト本文テンプレートはデフォルトのまま、変更は不要。 • 「生成」をクリックすると、デフォルトのテンプレートが入力される。呼び出し元がOracle APEXで
ない場合、または、REST APIのハンドラが標準的でない場合は変更が必要。 Step 9.4 – リクエストのテンプレートについて Copyright © 2020, Oracle and/or its affiliates 71 説明のみ、作業不要

• 「操作の追加」をクリックする。 • Webソース操作として、以下を設定する。 • URLパターン：:empno • HTTPメソッド：DELETE • データベース操作：行の削除
• 「作成」をクリックする。 • AutoRESTでREST APIを作成した場合は不要となる手順。 Step 9.5 – DELETE操作の追加(従業員情報削除) Copyright © 2020, Oracle and/or its affiliates 72

• 可能な操作として、以下が検出されていることを確認する。 • 従業員一覧をとるGET • 従業員の追加 • empnoを引数として(URLパターンが:empno)、従業員を削除するDELETE
• empnoを引数として(URLパターンが:empno)、従業員の情報を取り出す GET • empnoを引数として(URLパターンが:empno)、従業員の情報を更新する PUT • 静的IDがREST_EMP_Sourceであること。 Step 10 – Webソース・モジュールの確認 Copyright © 2020, Oracle and/or its affiliates 73

• EMPで実施した操作と同じ手順を繰り返す。 • DEPTで操作するWebソース・モジュールを追加する。 • 「最初から」を選び、EMPのコピーとはしない。 • 名前は「REST DEPT Source」とする。
• URLエンドポイントはempのところがdeptとなる。 • 静的IDはREST_DEPT_Sourceになっていること。 Step 11 – DEPTのWebソース・モジュールの追加 Copyright © 2020, Oracle and/or its affiliates 74 手順によってはパスにhol/がつく。

• 以下の設定を行う。 • レポート・タイプ：対話モード・レポート • レポート・ページ番号：2 • レポート・ページ名：従業員一覧 •
フォーム・ページ番号：3 • フォーム・ページ名：従業員編集 • フォーム・ページ・モード：モーダル・ダイアログ • ブレッドクラム：Breadcrumb • エントリ名：従業員一覧 • 「次」をクリックする。 Step 14 – ページの作成 Copyright © 2020, Oracle and/or its affiliates 77

• ナビゲーションのプリファレンスとして「新規ナビゲーション・メニュー・エントリの作成」を選択する。 • この結果として、アプリケーションの左メニューにエントリが追加される。 •
新規ナビゲーション・メニュー・エントリが「従業員一覧」であることを確認する。 • 親ナビゲーション・メニュー・エントリとして、「- 親が選択されていません -」が選ばれていることを確認する。 • 「次」をクリックする。 Step 15 – ページの作成 Copyright © 2020, Oracle and/or its affiliates 78

• データ・ソースとして「Webソース」を選択する。 • Webソース・モジュールとして「REST EMP Source」を選択する。 • レポートに表示する列として、全ての項目が右側の領域に一覧されていることを
確認する。 • 「次」をクリックする。 Step 16 – ページの作成 Copyright © 2020, Oracle and/or its affiliates 79

• 主キー列として「EMPNO(Number)」を選択する。 • 「作成」をクリックする。 Step 17 – ページの作成 Copyright

• ページの作成を確認する。 • 「ページの保存と実行」をクリックする。 Step 18 – アプリケーションの実行 Copyright

• 左サイドのメニューから「従業員一覧」をクリックする。 • 開発者ツール・バーより「ページの編集２」をクリックする。 Step 1 – アプリケーションの実行

• 「ページの保存と実行」をクリックする。 • 列ヘッダーが変更されていることを確認する。 Step 5 – 変更の確認 Copyright

• レンダリング・ビュー(左ペイン)より、ページ・アイテムP3_HIREDATEを選択する。 • プロパティ・エディタ(右ペイン)より、 • ラベルを「採用日」に変更する。 • 外観の書式マスクを「YYYY-MM-
DD」に変更する。 Step 12 – ページ・アイテムの改善(P3_HIREDATE) Copyright © 2020, Oracle and/or its affiliates 96

• レンダリング・ビュー(左ペイン)にて、ページ・アイテムの位置をドラッグ・アンド・ドロップで変更する。 • P3_EMPNO, P3_ENAME, P3_DEPTNO, P3_JOB, P3_MGR, P3_SAL,
P3_COMM, P3_HIREDATEの順 Step 14 – ページ・アイテムの配置変更 Copyright © 2020, Oracle and/or its affiliates 98 クリックドラッグリリース最終結果

ドラッグ • レイアウト・ビュー(中央ペイン)で、P3_COMMを選択する。 • P3_COMMをP3_SALの後ろにドラッグし、ドロップする。 Step 15 – ページ・アイテムの配置変更 Copyright
© 2020, Oracle and/or its affiliates 99 クリックリリース

• アプリケーションの実行画面へ移動する。 • 従業員編集の画面が開いていれば、それを閉じる。 • 「作成」をクリックする。 Step 1 – 行の挿入

• 以下、値を指定する。 • 従業員番号：1234 • 名前：山田太郎 • 部署：10 • 職種：店員
• マネージャー：7839 • 固定給：1500 • 歩合：指定なし • 採用日：本日 • 値を指定したら、「作成」をクリックする。 • レポート上に新しいエントリが作成されていることを確認する。 Step 2 – 行の挿入 Copyright © 2020, Oracle and/or its affiliates 104 日付ピッカーにて選択

• レポートから、名前「斉藤大介」を選んで、編集アイコンをクリックする。 • 以下、値を編集する。 • 固定給：1500 •
歩合：750 • 値を変更したら、「変更の適用」をクリックする。 • レポート上の「斉藤大介」のエントリの固定給、歩合が変更されていることを確認する。 Step 3 – 行の更新 Copyright © 2020, Oracle and/or its affiliates 105

• 戻り列として「DEPTNO」を選択する。 • 表示列として「DNAME」を選択する。 • 「作成」をクリックする。 Step 4 – LOV作成

• レンダリング・ビュー(左ペイン)のレポート1の列を開いて、DEPTNOをクリックする。 • プロパティ・エディタ(右ペイン)で、以下の設定をする。 • タイプ：プレーン・テキスト(LOVに基づく) • LOV：DEPT LOV •
ヘッダーの位置合せ：先頭 • レイアウトの列の位置合せ：先頭 • ツール・バーの「保存」をクリックする。 Step 6 – 従業員一覧レポートのアップデート Copyright © 2020, Oracle and/or its affiliates 113

• ページ番号を２から３へ変更し、ページ３へ移動する。 • レンダリング・ビュー(左ペイン)で、「P3_DEPTNO」をクリックする。 • プロパティ・エディタ(右ペイン)にて、以下を設定する。 •
タイプ：選択リスト • LOVのタイプ：共有コンポーネント • LOV：DEPT LOV • 追加値の表示：OFF • NULL値の表示：OFF • ツール・バーの「保存」をクリックする。 Step 7 – 従業員一覧フォームのアップデート Copyright © 2020, Oracle and/or its affiliates 114

• 任意のレコードの編集アイコンをクリックする。 • 「部署」をクリックし、選択リストになっていることを確認する。 Step 9 – アプリケーションの実行 Copyright

Oracle APEX Workshop II 日本語版

Oracle APEX Workshop II 日本語版

More Decks by oracle4engineer

Other Decks in Programming

Featured

Transcript