クイック統計プロファイラ

このトピックは、セクションまたはタブのない単純なページ、ダイアログまたはその他のUIに使用します。ページ上のすべてのフィールドおよびオプションを説明する必要があります。

ヘルプ出力に正しく生成されるようにこのトピックを構成するには、次の手順を実行します。

1. Sect1要素を構成します。

   1. 状況依存トピックをSect1として作成します。

   2. 簡単な名詞句と見出し形式の文体を使用して、状況依存トピックにUIの名前を反映したタイトルを付けます。ページ・タイトルには総称名詞を含めます。たとえば、プリファレンス・ページ、プリファレンス・ダイアログ、編集ウィンドウ、リソース・カタログなどです。これが移行中のトピックの場合は、以前と同じタイトルを使用します。

   3. このトピックが目次に表示されないように、HelpTOC属性をTopicOnlyに設定します。

   4. UIの名前およびオプションで製品名が含まれるように、要素のサンプルOutputFileName属性を変更します。たとえば、製品がOracle XYZサーバーで、UIが「プリファレンス」ダイアログの場合、この属性の値をcs_pagename1.htmからcs_preferences.htmまたはxyz_cs_preferences.htmなどに変更します。

   5. ヘルプ・アイコン、ボタンまたはUIのtopicIDと一致するように、HelpTopicID属性を変更します。

      Sect1トピックのHelpTopicID属性の値として、エンジニアから提供されたtopicIDを使用します。ヘルプを別の形式から変換する場合は、既存のHelpTopicIDを使用します。または、自分でtopicIDをトピックに割り当ててから、その割り当てたtopicIDをエンジニアに提供することもできます。重要なのは、FrameMakerでトピックに割り当てるtopicIDが、開発によってUI、ヘルプ・アイコンまたはボタンに割り当てられているtopicIDと一致していることを確認することです。

2. 次のガイドラインに従って、InformalTable要素を構成します。

   1. 表のSummary属性とTitle属性を適宜変更します。

   2. HelpPara要素を使用して、ドキュメント化する必要があるUI内のすべての要素またはオプションを「要素」列に入力します。「要素」列では、UI要素を太字にしないでください。

   3. 「要素」列のテキストをインデントすることで、UI内に表示される要素をグループ化するには、HelpPara要素のRole属性を編集します。左マージンからテキストをインデントするには、「Level1」を選択します。UIに表示されるオプションの構成を反映するように、必要に応じてLevel1、Level2、Level3およびLevel4を使用して最大4レベルまでインデントを設定できます。

   4. 「説明」列では、HelpPara要素ではなくPara要素を使用します。この列ではテキストをインデントしません。オプションまたは要素を詳しく説明します。説明しているUI要素以外のUI要素を参照する場合は、Bold強調表示を使用します。コード・スニペットまたはコード参照を指定する場合は、Code強調表示を適用します。

   5. 「説明」列に、ドキュメント・ライブラリの管理者ガイド、開発者ガイドおよびユーザー・ガイドにある概念説明のトピックに移動するための「詳細」インライン・リンクを追加し、これらのブックにある個々のタスク・トピックに移動するための「方法」インライン・リンクを追加します。他の情報用のインライン・リンクは追加しないでください。かわりに、以下で説明するように、これらのその他のリンクは「関連トピック」見出しの下に追加します。

   6. 「詳細」リンクおよび方法リンクをブックに挿入するには、Xulink要素を使用し、属性値にはolink:DOCID (例: olink:ASADM11113)を入力します。リンク設定の詳細は、オンライン・ヘルプの標準のTopicID値の適用およびブックへのリンクの追加に関する項を参照してください。

   7. 「要素」列と「説明」列の両方で、以下で説明するように、必要に応じてインライン・グラフィックを追加します。インライン・グラフィックは控えめに使用し、UIの概要を示すためや画面上のラベルのない要素を定義するために必要である場合にのみ使用します。状況依存オンライン・ヘルプでは、アイコンとボタンは必須ではありません。

   8. インライン・グラフィックの高さは22ピクセルに制限されています。高さが22ピクセルを超えるイメージを挿入すると、OHW/OHJヘルプJARでイメージが縮小されて歪んで表示されるため、そのようなイメージは挿入しないでください。イメージの幅のピクセルには具体的な制限はありませんが、導入文の段落では、列の半分よりも広い幅のイメージを挿入する方が見栄えがよくなります。

3. インライン・グラフィックを挿入するには、次のガイドラインに従います。

   1. インライン・グラフィックを挿入する場所を選択します。

   2. 「要素」ウィンドウで、InlineGraphicを選択して「挿入」をクリックします。「新規要素の属性」ウィンドウが表示されます。

   3. AltText値を入力します。これは必須属性であり、テキストを入力しないとブックがエラーになります。「要素の挿入」をクリックします。「インポート」ダイアログが表示されます。

   4. グラフィック・フォルダからインポートするグラフィックを選択します。「インポート・グラフィックのスケーリング」ダイアログが表示されます。

   5. 72 dpiを選択します。「設定」をクリックします。グラフィックが挿入されます。

   6. [Space]キーを使用して、必要に応じてグラフィックの前後にスペースを1つ挿入し、イメージとテキストの間にスペースが1つ入るようにします。イメージとその前後のテキストの間には、(単語間のスペースと同様に)スペースが1つ必要です。行頭のイメージの前に余分なスペースを追加する必要はありません。

4. RelatedTopics要素およびリンクを含めるには、次のガイドラインに従います。

   1. RelatedTopics要素はSect1要素内の最後の要素であり、必須です。これはテンプレートに含まれているため、挿入する必要はありません。

   2. RelatedTopics要素の下で使用できる唯一の子要素は、Para要素です。RelatedTopics要素の下には、テンプレートにすでに存在しているものに加えて複数のPara要素を追加できます。

   3. 言及した技術がインラインの「方法」リンクと「詳細」リンクで説明されていない場合は、それらに関するトピックを追加します。

   4. ドキュメント・ライブラリ内の章またはSect1への相互参照を追加します。

   5. ブックにリンクを挿入するには、Xulink要素を使用し、属性値にはolink:DOCID (例: olink:ASADM11113)を入力します。リンク設定の詳細は、オンライン・ヘルプの標準のTopicID値の適用およびブックへのリンクの追加に関する項を参照してください。

クイック統計プロファイルは、複数のレコードまたはトランザクションについて、次の点に関する基本的な品質メトリックを提供します。

• 候補キー列

• 完全性データと欠落データ

• 重複

• 値の一意性と多様性

各入力属性は個別にプロファイリングされます。

クイック統計は、データとその品質の基本的な全体像を把握するのに役立ちます。

ドキュメントやメタデータでは、情報が欠落したり、不完全な情報、古い情報または信頼できない情報が含まれていることがよくあります。データ自体を分析してデータの明確な全体像を把握することが重要です。これにより、誤った前提に基づいて誤った判断をすることを防ぎます。

次の表に、構成オプションを示します。

構成	説明
入力	クイック・プロファイリング統計の取得の対象にする属性を指定します。
オプション	なし。
出力	データ属性またはフラグ属性の出力を記述します。
データ属性	なし。
フラグ	次のフラグが出力されます。 [Attribute name].Populated: どのレポートが移入済かを示します。使用可能な値はYまたはNです。

クイック統計プロファイラでは、統計を生成するためにレコードのバッチが必要です(たとえば、分析対象の属性ごとに重複値の数を調べるために)。したがって、処理が完了するまで結果が生成されないため、これはリアルタイム・レスポンスが必要なプロセスには適していません。

リアルタイム・データ・ソースからのトランザクションのバッチに対して実行した場合、リーダー・プロセッサで構成されたコミット・ポイント(トランザクションまたは制限時間)に到達すると処理が終了します。

次の表に、このプロファイラによって各属性ごとに生成される統計を示します。

統計	説明
データあり	その属性にデータを含むレコードの数。
データなし	その属性にデータを含まないレコードの数。これには、NULL値を含むレコードや、その他のタイプの非データ(スペースのみ、印刷不可能な文字など)を含むレコードも含まれます。数値をドリルダウンすると、検出された非データのタイプの明細が表示されます。
シングルトン	その属性で1回のみ検出された値を含むレコードの数。
重複	その属性で複数回検出された値を含むレコードの数。
個別	その属性で検出された異なる値の数。数値をドリルダウンすると、これらの値の明細が出現頻度別に表示されます。
コメント	クイック統計プロファイラの結果に基づいた自動コメント。後述の説明を参照してください。

「追加情報」ボタンをクリックすると、前述の統計が、分析対象レコードの総数に対するパーセンテージとして表示されます。

自動コメント

自動コメントは、データ内で関心を集める可能性がある部分を強調するために生成されます。次に例を示します。

• 属性が100%完全で一意の場合は、候補キーとして識別されます

• 属性が100%完全に近く一意の場合は、破損した可能性があるキーとして強調表示されます

• 属性が100%完全に近い(空白を含むことはできない)場合は、ユーザーにnullの調査を要求するコメントが表示されます

• 属性が100%一意に近い(重複が許容されない)場合は、ユーザーに重複の調査を要求するコメントが表示されます

• 属性に重複しない値が1つのみ含まれている場合は、その属性が冗長である可能性があることを示すコメントが表示されます

これらのコメントが複数適用されると、各コメントが連結されます。

例

この例では、クイック統計プロファイラを使用して、最初に顧客レコード表の概要を把握します。

表1-123 クイック統計プロファイラの例

入力フィールド	レコード合計	データあり	データなし	シングルトン	重複	固有の値
CU_NO	2001	2000	1	1997	3	1998
CU_ACCOUNT	2001	2000	1	2000	0	2000
TITLE	2001	1862	139	3	1859	8
NAME	2001	2000	1	1980	20	1990
GENDER	2001	1853	148	0	1853	2
BUSINESS	2001	1670	331	1629	41	1649
ADDRESS1	2001	1999	2	1926	73	1954
ADDRESS2	2001	1921	80	554	1367	839
ADDRESS3	2001	1032	969	278	754	379
POSTCODE	2001	1762	239	1604	158	1672
AREA_CODE	2001	1884	117	64	1820	270
TEL_NO	2001	1994	7	1875	119	1934
電子メール	2001	1936	65	1904	32	1920
ACC_MGR	2001	1996	5	0	1996	30
DT_PURCHASED	2001	1998	3	1090	908	1499
DT_ACC_OPEN	2001	1998	3	1093	905	1500
DT_LAST_PAYMENT	2001	1997	4	1026	971	1425
DT_LAST_PO_RAISED	2001	1998	3	1003	995	1433
BALANCE	2001	1999	2	7	1992	10

ほとんどの場合、サマリー・ビューの数値をドリルダウンすると、レコードが直接表示されます。ただし、数値から中間ビューが表示される場合もあります。

• サマリー・ビューで「BUSINESS」の重複数の値である41をドリルダウンすると、各重複値の頻度が表示されます。

• サマリー・ビューで「TITLE」の固有の値の数である8をドリルダウンすると、各固有値の頻度が表示されます。

• サマリー・ビューで「POSTCODE」のデータなしの数239をドリルダウンすると、検出された様々なデータなしのケースについてサマリー・ビューが表示されます(スナップショットでデフォルトの「データ処理なし」参照データ・マップが使用された場合は、これらすべてがNull値になることに注意してください)。