2021年1月20日水曜日

解析対象スキーマの変更による影響の確認

 Oracle APEXのアプリケーションの設定である、解析対象スキーマを変更した場合、どのような影響があるかを確認しました。結論を先に記載すると、データベースの接続ユーザーが変わったのと同じ影響があります。

特に意識して設定をしなければ、ワークスペースを作成する際に、同名のデータベース・ユーザー( = スキーマ)を作成していると思います。

そして、そのワークスペースに作成したアプリケーションの解析対象スキーマは、上記のデータベース・ユーザーがデフォルトの設定になります。

一般的には、Oracle APEXのアプリケーションで扱うデータベース・オブジェクトは、このデータベース・ユーザー( = スキーマ)の持ち物として作成しているでしょう。

これから、解析対象スキーマと異なるスキーマにオブジェクトを作成し、そのオブジェクトを扱うアプリケーションを作成します。アプリケーションの作成後、解析対象スキーマを変更し、影響を確認します。

確認作業はAutonomous Databaseを使って実施します。

Oracle APEXのワークスペースおよびデータベース・ユーザーはAPEXDEVとして作成されていることを前提とします。


SQL Developer Webによるデータベース・ユーザーおよび表の作成


SQL Developer Webにアクセスし、左のメニューか、もしくは真ん中のパネルの管理に含まれるデータベース・ユーザーを実行します。


開いた画面から、ユーザーの作成を実行します。


最低限、ユーザー名、パスワード、パスワードの確認を設定します。その他の設定は、今回の検証に影響しません。設定した後、ユーザーの作成を実行します。


データベース・ユーザーが作成されました。


続いて、表EMPを作成します。SQLの実行画面を開いて、オブジェクトの作成を開きます。


スキーマとして先ほど作成したHR(選択リストに表示されない場合は、一旦ブラウザをリロードします)を選択し、名前にEMPを指定します。列の一般タブから、列EMPNOとENAMEを以下の属性で追加します。

名前: EMPNO, データ型: NUMBER, PKおよびID列をチェック
名前: ENAME, データ型: VARCHAR2(80)


制約のタブに移り、ENAMEのNOT NULLにチェックを入れます。


DDLを確認し、作成を行います。


表EMPが作成されたことを確認し、画面を閉じます。


データベース・ユーザーAPEXDEVから検索のみを許可するよう、SQLの実行画面よりGRANT文を発行します。また、確認に使用するデータを表EMPに数行書き込んでおきます。SQLの実行が正常終了していることを、スクリプト出力から確認します。
grant select on hr.emp to apexdev;
alter user hr quota unlimited on data;
insert into hr.emp(ename) values('SCOTT');
insert into hr.emp(ename) values('ADAM');
insert into hr.emp(ename) values('SHARON');
commit;

以上でSQL Developer Webを使ったスキーマHRの準備は完了です。

Oracle APEX管理サービスによるワークスペースとスキーマの紐づけ


続いて、Oracle APEXの管理サービスにアクセスし、ワークスペースの管理を開きます。


ワークスペースとスキーマの割当ての管理を実行します。


スキーマの追加をクリックします。


スキーマとして既存を選択し、次へ進みます。


新たに作成したスキーマを紐づけるワークスペースを選択します。今回の例ではAPEXDEVです。選択後、次に進みます。


ワークスペースに紐づけるスキーマを選択します。今回の例ではHRです。選択後、次に進みます。


設定内容を確認し、スキーマの追加を実行します。


ワークスペースにスキーマが紐づけられました。


以上で、Oracle APEXの管理サービスでの作業は完了です。

確認に使用するアプリケーションの作成


最初にアプリケーション・ビルダーから空のアプリケーションを作成しておきます。スクリーンショットと詳細手順は割愛します。

続いて、そのアプリケーションに、スキーマHRの表EMPを扱うレポートとフォームを作成します。

ページ作成ウィザードを実行します。


コンポーネントのフォームをクリックします。


フォーム付きレポートをクリックします。


レポート・タイプとして対話モード・レポート、レポート・ページ名、フォーム・ページ名としてそれぞれ、従業員一覧、従業員編集とします。フォーム・ページ・モードをモーダル・ダイアログにします。次に進みます。


ナビゲーションのプリファレンスとして、新規ナビゲーション・メニュー・エントリの作成を選択すると、新規ナビゲーション・メニュー・エントリはレポート・ページ名と同名の従業員一覧になります。そのまま次に進みます。


データ・ソースの指定にて、表/ビューの所有者としてHRを選択します。これはワークスペースにスキーマHRを紐づけたため選択可能になりました。表/ビューの名前にEMP(表)を選択し、次へ進みます。


フォームの主キー型として主キー列の選択を選択し、主キー列としてEMPNO (Number)を選択します。作成をクリックします。


以上で確認に使用するアプリケーションの作成が完了しました。

解析対象スキーマの影響確認


作成したアプリケーションを実行し、レポートを開きます。スキーマHRに存在する表EMPの内容がリストされていることが確認できます。これはデータベース・ユーザーAPEXDEVにSELECT権限を与えられているからです。(実際はSELECT権限がないとページ自体、ページ作成ウィザードで作成することができません)。

作成をクリックし、データの投入を試みます。ORA-1031が発生し、作成できません。同様に既存の行の変更や削除も同様にエラーとなります。


ページ・デザイナにてフォームの定義を確認します。表の所有者としてHRが設定されていることが確認できます。


アプリケーションの定義を開き、セキュリティの項目にある解析対象スキーマをHRヘ変更し、変更の適用を実行します。


作成したアプリケーションから一旦サインアウトし、サインインし直してから、表EMPを操作してみます。今度は作成/変更の適用/削除、すべての操作が可能です。解析対象スキーマとして設定したHRの権限でアクセスされています。


ワークスペースをスキーマが紐づいていないと、表/ビューの所有者の選択対象とリストされないので、ソースの設定として宣言的にデータベース・オブジェクトを選ぶことができなくなります。つまり、以下のような定義ですむところを


以下のようにSQLで、手書きしなければなりません。


しかし、アプリケーションの解析対象スキーマも開発者によって変更できるようになるため、アプリケーションによっては権限設定を迂回することが可能になります。

解析対象スキーマはOracle APEXの標準ビューであるAPEX_APPLICATIONSのOWNER列で参照できるので、不用意に解析対象スキーマが変更されているアプリケーションが無いことを確認することができます。

ワークスペース・ユーティリティのApplication Expressビューを開きます。


ビューよりAPEX_APPLICATIONSを選んで開きます。


列にOWNERを含めて結果を表示させます。


OWNER(解析対象スキーマ)を確認することができます。


問合わせを開くと、確認に使用するSQLを参照することができます。

データベースが提供しているオブジェクトの保護機能の利用には、スキーマを分けるのが最初の作業になります。そのための基本的な操作方法と注意点の紹介でした。スキーマ設計の一助になれば幸いです。

完

2021年1月13日水曜日

ビルド・オプション(Build Options)を利用する

Oracle APEXのアプリケーションに組み込んだ機能の有効化/無効化をするために、いくつかの方法が提供されています。本記事では、あまり使われることがないと思われるビルド・オプション(Build Options)について紹介します。

いままで、サーバー側の条件で制御していたけど、ビルド・オプションを使った方が良いかな?と思えることもあるでしょう。

ビルド・オプションの用途


マニュアルには、ビルド・オプションの3つのユース・ケースが紹介されています。

ユースケース1: インストール・タイプに基づいて機能を有効および無効にする


それぞれのビルド・オプションに紐づいたコンポーネントは完成された状態であり、ユーザーが必要性を判断してビルド・オプションのステータス(含める/除外)を設定します。アプリケーション作成ウィザードでは、機能として情報ページ、アクセス制御、アクティビティ・レポートなどが選択できますが、それがこのユースケースと言えます。

ユースケース2: インストール・タイプに基づいて機能を有効および無効にする


ビルド・オプションのステータスを含めるにして活用します。以下のシナリオが、このユースケースでの一例になります。
  1. 本番稼働中のアプリケーションのコピーを、開発中のアプリケーションとします。
  2. 開発中のアプリケーションに新機能を追加します。新機能にビルド・オプションを紐付けます。開発中のアプリケーションでは、ステータスは含めるにします。
  3. 開発中アプリケーションを本番稼働中のアプリケーションに置き換えます。新機能のビルド・オプションのステータスは除外とし、新機能は一般の利用者に見えないようにします。
  4. テストを十分行ったのち、本番稼働中のアプリケーションのビルド・オプションのステータスを含めるに変更します。この変更の後、利用者は新機能を利用できます。


ユースケース3: 機能の削除の影響を特定する


ビルド・オプションのステータスを除外にして活用します。以下のシナリオが、このユースケースでの一例になります。
    1. 本番稼働中のアプリケーションのコピーを、開発中のアプリケーションとします。
    2. 開発中のアプリケーションから取り除くコンポーネントを、ビルド・オプションに紐付けます。ステータスを除外にします。
    3. 開発中のアプリケーションで、コンポーネントを除外しても問題が発生しないことを確認します。
    4. 開発中のアプリケーションを本番稼働中のアプリケーションに置き替えます。ビルド・オプションのステータスは除外のままです。
    5. 本番稼働中のアプリケーションでも問題がないことが確認できたら、ビルド・オプションに紐づいているコンポーネントをアプリケーションから削除します。
    アプリケーションをバージョンアップする際には、新機能は追加対象、旧機能は除外対象として、双方のユースケース(2と3)がひとつのアプリケーションに同居することもあるでしょう。


    動作確認用のアプリケーションの作成

    最近のOracle APEXが提供しているアプリケーション作成ウィザードでは、機能としてあらかじめ、情報ページ、アクセス制御、アクティビティ・レポート、構成オプション、フィードバック、テーマスタイルの選択、を選んで組み込むことができます。これらの機能はそれぞれビルド・オプションに紐づいています。これらの機能をすべて組み込んだ空のアプリケーションを作成し、それを使ってビルド・オプションの働きを確認します。

    アプリケーション・ビルダーから作成を実行し、アプリケーション作成ウィザードを起動します。

    名前をビルド・オプションの確認とし、機能のすべてをチェックをクリックし、すべての機能を選択したのち、アプリケーションの作成を実行します。

    アプリケーションが作成されます。ページ番号が10000以上のページはすべて、上記でチェックを入れた機能と関連しているページです。

    作成されたアプリケーションを実行します。管理ページを開くと、選択した機能に対応したリージョンの存在を確認できます。左上、左下、右上、右下の順番で、構成オプション、テーマ・スタイルの選択、アクティビティ・レポート、アクセス制御、フィードバックです。

    情報ページがここに含まれていませんが、こちらは右上のメニューから呼び出される機能です。

    ビルド・オプションを確認します。共有コンポーネントのアプリケーション・ロジックに含まれます。

    アプリケーション作成ウィザードで選択した6つの機能が、ビルド・オプションとして定義されています。


    ビルド・オプションのステータス


    この中から、フィードバックの機能を取り上げて、ビルド・オプションの働きについて確認します。


    機能:フィードバックをクリックして定義を開きます。


    現在のビルド・オプションのステータスは、含めるになっています。つまり、関連コンポーネントとしてリストされている、それぞれのコンポーネントが有効になっています。ステータスを除外に変更すると、関連コンポーネントは実際には削除されませんが、存在していないのと同様の扱いになります。また、ここでコンポーネントの削除を行うとデータとしても削除されます。

    先ほどの管理ページを開きます。ここで、フィードバックに関係するメニューやリージョンを赤枠で囲っています。


    機能:フィードバックのステータスを除外に変更すると、表示が以下に変わり、メニューやリージョンが無くなります。


    リージョンでのビルド・オプションの指定は、プロパティ・エディタの構成に含まれています。

    ビルド・オプションとして機能:フィードバックが指定されているので、このビルド・オプションのステータスが含めるとなっているときに、有効になります。反対の効果となる選択肢として、{非機能:フィードバック}を選ぶことができます。この指定の場合は、ステータスが除外のときに有効になります。

    ただし、この非機能の指定は、どうしても必要な場合に限定した方がよいでしょう。非機能の指定は以下になります。


    ビルド・オプション機能:フィードバックのステータスが除外のときに、ページ番号10000を開くと以下のようになります。


    メニュー上のフィードバックを呼び出す項目は消去されたままで、ビルド・オプションとして{非機能:フィードバック}を設定したリージョンは表示されます。これは設定した通りの効果です。共有コンポーネントのビルド・オプションから、機能:フィードバックの状態を確認します。


    ビルド・オプションに{非機能:フィードバック}を設定したコンポーネントが、関連コンポーネントに現れていないことが確認できます。機能:フィードバックを設定していたときの関連コンポーネントのリストは以下でした。ページ番号10000のページ・リージョン、フィードバックが無くなっていることがわかります。


    非機能として設定されているビルド・オプションがあると、コンポーネントの削除に失敗します。


    使用状況のレポートを表示することにより、ビルド・オプションが非機能で設定されているコンポーネントを調べることができます。


    このように、ビルド・オプションのステータスを含めるまたは除外とすることにより、そのビルド・オプションに紐づいた機能を有効にしたり、無効にしたりできます。


    エクスポートのデフォルト


    テスト環境ではビルド・オプションのステータスを含めるに設定し、本番環境では一旦除外したい状況を考えます。

    ここでは仮に機能: フィードバックを開発中とします。


    この開発中アプリケーションをエクスポートし、本番環境にインポートすると、エクスポートのデフォルトが引き継がれ、本番環境でのステータスは含めるになります。

    本番環境にインポートしたときに、機能: フィードバックがデフォルトで除外となってほしい場合を考えます。ステータスを一旦除外にし、エクスポートしてから、再度含めるに戻す、というのも手間がかかります。

    ビルド・オプションの属性のエクスポートのデフォルトを除外に設定すると、この後にエクスポートされたアプリケーションをインポートすると、エクスポート時点のビルド・オプションのステータスにかかわらず、除外がデフォルトになります。


    エスクポート前のアプリケーションでのビルド・オプションの設定は以下のように、エクスポートのデフォルトが除外です。


    エスクポートしたアプリケーションを以下の画面で、次のアプリケーションとしてインストールとして新規アプリケーションIDを自動割当てを選んでインポートします。


    新規に作成されたアプリケーションのビルド・オプションは、エクスポートのデフォルトとして設定されていたステータスが反映されます。



    アップグレード時にステータスを維持


    インポート時に既存のアプリケーションを置き換えることが可能な場合は、アップグレード時にステータスを維持をはいに設定することで、置き換えられるアプリケーションの設定を維持することができます。

    エクスポート時のビルド・オプションのエクスポートのデフォルトが含める、アップグレード時にステータスを維持がはい、だったとします。


    この状態のアプリケーションのエクスポートで、すでに存在する以下のビルド・オプション、機能: フィードバックのステータスが除外となっているアプリケーションを置き換えても、ビルド・オプションのステータスは除外のまま維持されます。



    インポート時にビルド・オプションを設定する


    アプリケーションのインポート時にビルド・オプションを設定することも可能です。アプリケーションのサポートするオブジェクトを開きます。


    インストールに含まれるビルド・オプションを開きます。


    ビルド・オプションのプロンプトにチェックを入れると、インポート時にユーザーによるビルド・オプションの変更が可能になります。機能: フィードバックにチェックを入れた上で、アプリケーションをエクスポートし、インポートしてみます。


    アプリケーションのインポートを実行します。ビルド・オプションの設定を可能にするには、サポートするオブジェクトのインストールをONに指定する必要があります。


    使用可能なビルド・オプションとして、ビルド・オプションのプロンプトでチェックを入れたビルド・オプションが現れます。含めるにするか除外にするか、チェックを入れることで指定できます。


    インポートされたアプリケーションのビルド・オプションのステータスは、ここで設定されたステータスになります。

    APEX_UTIL.SET_BUILD_OPTION_STATUSの使用


    コードからビルド・オプションを指定するAPIが提供されています。APEX_UTIL.SET_BUILD_OPTION_STATUSです。以下のように呼び出します。

    begin
    apex_util.set_build_option_status(
    p_application_id => 97521,
    p_id => 26026092390449248099,
    p_build_status => 'EXCLUDE'
    );
    end;

    p_idはビルド・オプションのIDになります。APEX_APPLICATION_BUILD_OPTION_STATUSビューから確認することができます。以下のようなSQLにてビルド・オプション・IDを取得します。

    select build_option_id
    from apex_application_build_options
    where workspace = 'DBCLOUD_DEMO'
    and application_id = 97521
    and feature_identifier = 'APPLICATION_FEEDBACK';

    ビルド・オプションのステータスについては、APEX_UTIL.GET_BUILD_OPTION_STATUSを呼び出すことによっても取得できます。以下のようなスクリプトになります。

    select
    APEX_UTIL.GET_BUILD_OPTION_STATUS(
    p_application_id => 97521,
    p_id => 26026092390449248099
    )
    from dual;

    インストール済みのアプリケーションに含まれるビルド・オプションであれば、APIを呼び出した時点で変更されます。

    アプリケーションのインストール・スクリプト内でビルド・オプションを設定する場合は、インポート時に既存のアプリケーションを置き換えること、および、サポートするオブジェクトをインストールするをONとすることが前提です。また、アップグレード時にステータスを維持をはいに設定します。

    APIによるビルド・オプションの設定は、ビルド・オプション自体が定義済みであることを前提としているため、インポート時に新規にアプリケーションIDが割り振られる場合は利用できません。また、アップグレード時にステータスを維持がいいえの場合は、APIによる変更がエクスポートのデフォルトとして設定されているステータスで上書きされてしまいます。

    終わりに


    以上がビルド・オプションにまつわる設定の紹介になります。コンポーネントの有効化/無効化は、サーバー側の条件や認可スキームを使うことが多いですが、ビルド・オプションを使うとひとつの設定でアプリケーション全体を変更できるため、便利に使うことができます。

    完

    ADWはresult_cache_modeがforceであることに注意

     Autonomous Databaseのワークロード・タイプとして、Data WarehouseとTransaction Processingがあります。このワークロード・タイプで、初期化パラメータresult_cache_modeが異なります。ADWはforceになっており、その場合に少々コーディングで気を付けるべきことがありました。

    2023年5月16日追記 ----

    May 2023のアップデートで、ADBのRESULT_CACHE_MODEを変更できるようになりました。

    What’s New for Oracle Autonomous Database on Shared Exadata Infrastructure
    RESULT_CACHE_MODE Parameter is Modifiable at Session and System Level
    ----

    タイプがPL/SQL動的コンテンツのリージョンを作成し、以下のコードを記述します。

    declare
    l_app_user varchar2(80);
    begin
    select v('APP_USER') into l_app_user from dual;
    htp.p('<p>v function: ' || l_app_user || '</p>');
    select sys_context('APEX$SESSION','APP_USER') into l_app_user from dual;
    htp.p('<p>sys_context: ' || l_app_user || '</p>');
    l_app_user := v('APP_USER');
    htp.p('<p>PL/SQL: ' || l_app_user || '</p>');
    end;

    最初にユーザーRESCACHE001でサインインし、このリージョンの表示を確認します。

    サインアウトし、次にユーザーRESCACHE002にてサインインします。同じリージョンの表示が以下になります。


    つまり、以下のSQLは結果キャッシュが働くため、以前の検索結果が返されることがあり得ます。

    select v('APP_USER') into l_app_user from dual;

    Oracle APEXが提供するvファンクションだけではなく、ファンクション全般に言えることだと思いますが、v('APP_USER')の結果はOracle APEXアプリケーションにたいして影響が大きいので要注意です。

    なお、result_cache_modeがmanualである、Autonomous Transaction Processingでは発生しない現象です。

    完

    2021年1月9日土曜日

    jsQRを組み込んでOracle APEXでQRコードを読み取る

     気になっていたので、扱いやすそうに見えたjsQRというJavaScriptライブラリを、Oracle APEXのアプリケーションに組み込んでみました。カメラがQRコードを認識したときに、ページ・アイテム(ここではQRコードからのデータ)に、読み取ったデータを設定しています。


    こちらにjsQRが提供しているデモのページがあります。このデモのページのソースを、ほとんどコピペしてOracle APEXのアプリに組み込みました。

    デモのコードの中に一行だけ、以下のコードをQRコードが認識されたときに実行される部分に追加しています。P1_QRCODEはページ・アイテムの名前です。

    $s('P1_QRCODE', code.data);

    この後にJavaScriptのコードを追加することで、QRコードを認識した時点で次の処理に遷移する、といったことも可能でしょう。

    作成したアプリケーションはこちらからアクセスできます。

    上記のアプリケーションのエクスポートをダウンロードできるよう、こちらにおきました。

    テストはAppleのMacbook ProのSafariで確認しています。

    Chrome, Edgeでは動かず、iPad, iPhoneでは動画としての取り込みをしてくれない(1秒くらいでビデオが止まる)ので、おそらくビデオ映像を取得するために呼び出しているnavigator.mediaDevices.getUserMediaにもっと詳しいオプションが必要だったり、デバイスを検知してオプションを切り替える、といった処理が必要なのではないか?と予想しています。

    今回は動かすだけが目的だったので、これで完了です。実際のコードは、アプリケーションのエクスポートをインストールすると参照できます。

    完