基本機能

インターシステムズのドキュメントは、HTML 形式と PDF (Adobe Page Description Format) の形式で提供されます。

インターシステムズのサーバの実行時は、いつでもオンライン・ドキュメントを表示できます。
クラス・リファレンスの情報は、オンライン・ドキュメントのホーム・ページから利用できます。
オンライン・ドキュメントの PDF ファイルは、表示することも、印刷することもできます。

オンライン・ドキュメント

ローカル・サーバがオンラインのときは、Web ブラウザで HTML 形式のドキュメントを表示できます。オンライン・ドキュメント・システムでは、インターシステムズのコア・テクノロジ、および Caché、Ensemble、HealthShare、Zen、DeepSee、TrakCare などのインターシステムズ独自の製品と機能に関する情報にアクセスできます。

起動

サーバ稼動中は、以下のいずれかの方法でオンライン・ドキュメントにアクセスできます。

Windows のシステム・トレイで InterSystems キューブを探します。InterSystems キューブをクリックしてキューブ・メニューを表示し、メニューから [ドキュメント] を選択します。
Windows の [スタート] メニューから [プログラム] を選択します。インターシステムズ社製品の名前およびサーバ・インスタンス名に移動し、[ドキュメント] オプションを選択します。
ローカルのインターシステムズ・サーバでブラウザのページに次の URL を入力します。57772 は、このサーバに構成されている Web サーバ・ポート番号です。
http://localhost:57772/csp/docbook/DocBook.UI.HomePageZen.cls
管理ポータル使用中に、ページ上部のバナーにある [ヘルプ] リンクをクリックします。2 番目のウィンドウがポップアップします。必要な情報がここに表示されない場合、このページの左上のナビゲーション・バーにあるドキュメントリンクをクリックします。

上記のいずれかの方法で [ドキュメント] を要求したときに、インターシステムズの目的のインスタンスを実行していない場合、ドキュメント・システムは、そのインスタンスの実行が困難であるかのように応答します。つまり、HTML ページには、システムが停止しているときに役立つと考えられるインターシステムズ・ドキュメントに移動できるリストが表示されます。これらのドキュメントを表示するには、このページの言語名 ([英語] または [日本語]) をクリックして、リストからドキュメントを選択します。これらのドキュメントは、PDF 形式なのでサーバが停止していても表示できます。HTML 形式でドキュメントの完全なセットを表示する場合は、目的のインスタンスを再起動し、再度 [ドキュメント] を要求します。

スタジオには、オンライン・ドキュメントの表示に便利な 2 つのショート・カットがあります。

コードを表示中に、ソース・コードの任意のテキスト文字列を選択して F1 キーを押します。オンライン・ドキュメントの [検索結果] ページが開き、このテキスト文字列の検索結果が表示されます。ハイライト表示したテキスト文字列が ObjectScript 言語のキーワードの場合、その特定の項目のドキュメントが表示されます。
スタジオの [ヘルプ] メニューから、[オンライン・ドキュメント] オプションを選択します。オンライン・ドキュメントのホーム・ページが開き、ここから特定のドキュメントまたはトピックに移動できます。

これらの方法をすべて実行してもオンライン・ドキュメントを表示できない場合は、インターシステムズのサポート窓口Opens in a new tabにご相談ください。その場合でも、“ドキュメントの印刷” の章の説明のとおりに、インターシステムズの PDF 形式ドキュメントにはアクセスできます。

移動

InterSystems ドキュメント・システムの各ページの上部にはバナーがあり、そこに左から右の順で以下の選択肢が表示されています。

オプション	動作
ホーム	メインのホーム・ページに移動します。
«	現在表示されているドキュメントの前の章または前の参照ページを表示します。前の章または前の参照ページがない場合は、淡色で表示されます。« リンクは、ブラウザの [戻る] ボタンと異なり、参照履歴ではなく、ドキュメントの順序に基づいて機能します。
»	現在表示されているドキュメントの次の章または次の参照ページを表示します。次の章または次の参照ページがない場合は、淡色で表示されます。» リンクは、ブラウザの [次へ] ボタンと異なり、参照履歴ではなく、ドキュメントの順序に基づいて機能します。

バナーの下のナビゲーション・バーには、左から右の順で以下の項目が表示されます。

オプション	動作
ドキュメント・システムのナビゲーション経路	メイン・ドキュメント・ページに戻るには、この経路にあるドキュメントをクリックします。
移動	ドキュメントを表示している場合にのみ、[移動] ボックスが表示されます。メインのドキュメント・ページには表示されません。[移動] ボックスには、現在のページにあるセクションのタイトル・リストが表示されます。そのうちの 1 つを選択すると、選択したセクションに直接移動します。
検索	[検索] フィールドに単語を記入して Enter キーを押すと、その単語の [検索結果] ページに移動します。[検索] ラベルをクリックすると、詳細検索のページに移動できます。詳細は、“検索エンジンの使用法” の章を参照してください。

ナビゲーション・バーの下側のメニューには、左から右の順で以下の選択肢が表示されます。ドキュメントの表示中は、これらの選択肢が表示されません。メイン・ページでのみ使用できます。

オプション	動作
はじめに	製品の [はじめに] ページが表示されます。
クラス・リファレンス	クラス・リファレンスのドキュメント・システムを開きます。
検索ページ	オンライン・ドキュメントの検索機能を呼び出します。

セキュリティ

セキュリティ機能が、オンライン・ドキュメントを表示する機能に影響する可能性があります。

例えば、使用しているインターシステムズ・サーバのセキュリティ設定によっては、あらゆるユーザがオンライン・ドキュメントにアクセスできるようにするには、特別な構成が必要になる場合があります。背景情報については、"Caché セキュリティ管理ガイド" の “Caché インスタンスのセキュリティの強化” の章を参照してください。詳細な手順は、前記の章の “ドキュメントやサンプルを使用可能にする” のセクションを参照してください。

また、Windows 上で InterSystems キューブを介してドキュメントにアクセスするときに使用するユーザ ID は UnknownUser です。これは、オンライン・ドキュメントを使用する際に以下のような問題が発生する可能性があります。

InterSystems サーバ・インスタンスのインストール時に、セキュリティ・レベルを [通常] または [ロック・ダウン] にすると、UnknownUser には %DB_DocBook:R 特権のみが与えられます。Caché クラス・リファレンスのドキュメントを読むには、これだけでは不十分です。このドキュメントを読むためには、%Development:Use 特権が必要です。
オンライン・ドキュメントのプログラム例を実行するには、アクセス権 %DB_SAMPLES:W が必要です。UnknownUser にこのアクセス権が付与されていない場合は、実行可能なプログラム例の画面に [実行する] ボタンが表示されません。

これらの問題はどちらも、必要な権限を持つロールを定義し、それを UnknownUser に割り当てることにより解決できます。または、オンライン・ドキュメントを実行するときに必ずこれらのロールが追加されるように、/csp/docbook のアプリケーション定義を編集する方法もあります。"Caché セキュリティ管理ガイド" の “ロール” の章を参照してください。

クラス・リファレンス・ドキュメント

オンライン・ドキュメントのホーム・ページには、クラス・リファレンスというリンクが表示されます。このドキュメント・システムには、インターシステムズ製品のコードで使用するオブジェクト指向クラスについて、インターシステムズの開発者によるコメントが収録されています。一般的な公共使用のコメントはすべて、システム内で参照できます。

クラス・リファレンスのドキュメントを表示するには、以下のいずれかを実行します。

オンライン・ドキュメント・システムを起動します。メイン・ページで [クラス・リファレンス] をクリックします。
ローカルのインターシステムズ・サーバでブラウザのページに次の URL を入力します。57772 は、このサーバに構成されている Web サーバ・ポート番号です。
http://localhost:57772/csp/documatic/%25CSP.Documatic.cls
スタジオの [ビュー] メニューで [クラス・ドキュメントの表示] オプションを選択します。
スタジオでコードを表示し、データ型の名前を選択して F1 キーを押します。このデータ型を定義するクラスの説明が表示されたクラス・リファレンスが開きます。

クラス・リファレンスのメイン・ページを表示しているときに、左側のパネルの名前を使用して、ドキュメントで説明を表示するネームスペース、パッケージ、およびクラスに移動します。右側のパネルに目的のドキュメントが表示されます。クラス・リファレンスには固有のバナーがあり、2 つの選択肢が左から右の順で表示されます。

オプション	動作
DocBook	メインのホーム・ページに移動します。
検索	クラス・リファレンスの検索ページに移動します。

独自に作成したクラスをインストール環境に追加するときに、特定のドキュメント規約を使用してこれらのクラスにコメントを追加すると、クラス・リファレンスにそのコメントを表示できます。詳細は、"Caché オブジェクトの使用法" の "クラスの定義とコンパイル" の章の “クラス・ドキュメントの作成” を参照してください。

Note:

クラス・リファレンスの右上隅の [プライベート] チェック・ボックスにチェックが付いている場合のみ、プライベートのクラス・メンバのドキュメントが表示されます。クラス・リファレンスの右上隅の [ストレージ] チェック・ボックスにチェックが付いている場合のみ、ストレージに関する情報のドキュメントが表示されます。

PDF 形式によるクラス・リファレンスはありません。検索機能については、“検索エンジンの使用法” の章の説明にあるオンライン・ドキュメント検索とはまったく別のものが用意されています。

ドキュメントの印刷

オンライン・ドキュメントの全編が PDF 形式で用意されています。docs.intersystems.comOpens in a new tab を参照してください。PDF ファイルの限定セットは、その製品のインストール先ディレクトリ (通常は C:\InterSystems\Ensemble\docs など) にもあります。

ドキュメントを印刷する場合は、ブラウザから HTML ページを印刷するのではなく、その HTML ページと内容が同じで、事前に書式設定済みの PDF ファイルを利用することを強くお勧めします。これらのファイルを各自で印刷できるほか、専門の印刷業者に印刷と製本を依頼することもできます。詳細は、“ドキュメントの印刷” の章を参照してください。

多くのインターシステムズの製品は、コアとなる基本テクノロジを共有しているので、目的のドキュメントを見つけるために複数のサブディレクトリを調べることが必要になる場合があります。例えば、Ensemble 製品には、Ensemble に関する情報用の docs\ensemble が用意されています。また、Ensemble と Caché で共有するテクノロジの情報用の docs\cache も用意されています。