この記事はGerald Venzlによる”Introducing the Oracle Database Error Help Portal“の日本語翻訳したものです。

2023年7月25日

ユーザーの生産性を向上させる継続的な取り組みの中で、Oracle Databaseの新しいエラー・ヘルプ・ポータルをご紹介します。 これによりユーザーはOracle Databaseのエラーについてより早く、改善された洞察を得ることができるようになります。

新しいポータルには、https://docs.oracle.com/error-help/db/およびOracle Database ドキュメントのランディング・ページから簡単にアクセスできます:

エラー・ヘルプ・ポータル - ドキュメント・ランディング・ページ

正規化されたURL

エラー・ヘルプ・ポータルは、正規化されたURLスキームを利用しています。つまり、URL自体に正しいエラー・メッセージ番号を入力することで、各エラー・メッセージに素早くアクセスできます。次に例を示します::

https://docs.oracle.com/error-help/db/ora-01034/

URLスキーム

Oracle Database 23c以降、発生したエラーに対してツールによって自動的にこれらのURLが生成され、ワンクリックでエラー・メッセージのドキュメントが表示されることにも注目します。

概要と読者エクスペリエンスの向上

これまでのOracle Databaseのエラー・メッセージ・ドキュメントとは異なり、ポータルでは各エラー・メッセージが単一のWebページに表示されるため、読者/ユーザーのエクスペリエンスが向上します。各ページで、ユーザーは、エラー・メッセージが該当するOracle Databaseリリース、ページの最終更新日、エラー・メッセージ自体、その原因およびユーザーが取るべき推奨アクションをすぐに確認できます。

エラー・ビュー

以前のリリース

ユーザーは、エラー・ヘルプ・ポータルで表示される一部のエラー・メッセージ・テキストと原因およびアクションが、Oracle Databaseの現行バージョンで表示されるものと異なることに気づく場合があります。ユーザーの生産性をさらに高めるためのオラクルの継続的な取り組みの一環として、オラクルは、Oracle Databaseによって生成されるエラー・メッセージを、より有意義で、実用的で、エンド・ユーザーにとって明確になるように改善し続けています。

エンド・ユーザーの混乱の可能性を回避するために、エラー・ヘルプ・ポータルには、サポートされているPrevious Releases(以前のリリース)に表示されるエラー・メッセージ・テキストが引き続き表示されます:

以前のバージョン

エラー・メッセージ・テキスト・パラメータ

全体的なもう1つの改善点は、エラー・メッセージ・テキスト内の変数値(エラー・メッセージ・パラメータとも呼ばれる)が文書化されているため、エラー・メッセージによって生成される値が何を意味するのかをユーザーがよりよく理解できるようになったことです:

ユーザーは、ポータルに表示されるエラー・メッセージ・テキストの中には、このようなエラー・メッセージ・パラメータの使用を示す斜体の単語が含まれていること、およびエラー・メッセージの下にある箇条書きリストにそれぞれについて詳細に説明されていることがわかります:

エラー・パラメータ

追加情報

ユーザーに追加情報や背景を必要とするエラー・メッセージの場合、Cause(原因)やAction(アクション)の下に、新しいAdditional Information(追加情報)セクションが表示されます:

追加情報

詳しいユーザー向け

詳しいユーザーは、Chromeなどの一般的なブラウザのサイト検索機能で正規化されたURLが利用できることにすでに気が付いているかもしれません。そのため、ショートカットとエラー・メッセージ番号のみをブラウザのURLフィールドに入力してドキュメント・ページを検索できるメカニズムを提供しています:

Chromeのサイト内検索

Chromeでの設定方法は次の通りです:

  1. 設定 –> 検索エンジン –> 検索エンジンとサイト内検索を管理する
  2. サイト内検索まで下にスクロールし、追加ボタンをクリック

お好きな名前とショートカット(前述のスクリーンショットは”err”を使用)を指定して新しい検索エンジンを追加し、URLフィールドに次のURLを貼り付けます: “https://docs.oracle.com/error-help/db/%s/”

Chromeの検索エンジン編集

  1. 追加をクリックし、設定ページを閉じます

今後はURLバーに”err”(または選択したショートカット文字)を入力してTabをクリックすると、URLフィールドに入力したエラー番号がエラー・ヘルプ・ポータルのURLに追加され、エラー・メッセージ・ページに移動します。

フィードバックを求めてます!

Oracle Databaseドキュメント・チームは積極的にフィードバックを求めています。欠落しているもの、間違っているもの、改善できるものが見つかった場合は、ページの下部にある”Thumbs Up“アイコンを探し、その上にマウスを移動して”Thumbs Up“または”Thumbs Down“アイコンをクリックしてください。

フィードバック・ボタン

どちらのボタンをクリックしても、新しいウィンドウが開き、Oracle Databaseドキュメント・チームに詳細情報を提供できるテキスト・ボックスが表示されます。エラー・メッセージおよびエラー・ヘルプ・ポータルの改善方法をより深く理解するのに役立つため、時間をかけてボックスに入力してください。ご意見ありがとうございます!

フィードバック・ボックス

この先の道は

オラクルは、エラー・メッセージおよびエラー・ヘルプ・ポータルの拡張に積極的に取り組んでいます。これは、データベースのリリース全体で継続的なタスクになります。エラー・メッセージの中には、エラー・ヘルプ・ポータルの新機能をすべてを反映させる必要があるものがあります。優先順位付けに役立つフィードバック・メカニズムをお待ちください。私たちは、時間と労力を要する、可能な限り最高のエクスペリエンスを提供するように努めています。 優先順位をつけるために、フィードバックの仕組みをご利用ください。私たちは可能な限り最高のエクスペリエンスを提供するよう努めていますが、これには時間と労力がかかります。

私たちの目標は、ポータルを他のオラクル製品にも拡張することです。そのため、すでに正規化されたURL内に製品名が表示されています。

新しいエラー・ヘルプ・ポータルが、発生したエラーの理由と解決策をユーザーがすばやく見つけるのに役立ち、生産性がさらに向上することを願っています。