スコアの文書化 (クラシック)

Experience Optimization の一部の機能は Finder（クラシック）とリンクしています。

Nexthink Finder は Windows のみで動作するデスクトップアプリケーションですが、その機能は現在 Nexthink の web インターフェース内で利用可能です。 Nexthink はブラウザから直接使用でき、ほとんどの機能は追加のデスクトップアプリケーションを必要としなくなりました。

各コンポジットおよびリーフスコアは、その主な目的がユーザービューまたはデバイスビューのスコアタブに表示されたときにスコアの詳細なドキュメントを提供するための Document 要素を定義に含めることができます。

スコアのドキュメントにはオプションで以下を含めることができます:

他の HTTP リソースへのリンク。
リモートアクションへのリンク（手動トリガーを許可する必要があります）。

この記事は、XML 形式でスコアの定義を書くことに精通していることを前提としており、特にスコアのドキュメント化に焦点を当てています。

ドキュメント構造

Document 要素は、コンポジットまたはリーフスコアの定義の最後に見つかることができるオプションの XML 要素です。

Document 要素の構造は次の通りです:

A Header.
Section のリスト。

<Document>
  <Header>[<Main documentation header>]</Header>
  <!-- List of sections -->
  <Sections>
    <Section>...</Section>
    ...
  </Sections>
</Document>

\ ヘッダーとセクションのリストはオプションですが、スコアのドキュメントはこれらの要素に提供される内容の有用性に依存します。

ドキュメントセクション

リストの各セクションには順にタイトル、説明文、HTTP リンク、リモートアクションへのリンクが含まれます。通常、各リンクやリンクのグループの前には、それらの目的を説明する文章を記述します。

<Section>
  <Title>[Title for the section]</Title>
  <Description>[Text describing the contents]</Description>
  <RemoteAction ... />
  <HTTP ... />
  ...
</Section>

\ 必要なだけ多くの説明、リモートアクション、および HTTP リンクをセクションに追加し、最も適した順序にします。

HTTP リンクの追加

HTTP リンクを追加するには、href 属性に宛先 URL を提供し、オプションで URL の代わりに表示するテキストを指定します:

<HTTP href="http(s)://url">[Text for the link]</HTTP>

リモートアクションへのリンクの追加

手動トリガーを許可するリモートアクションへのリンクを追加するには、リモートアクションのユニークな識別子 (UID) を提供します:

<RemoteAction UID="[identifier]" />

リモートアクションの UID を取得するには:

リモートアクションを編集する権限を持つユーザーとして Finder にログインします。
左側のパネルの Remote actions セクションで希望のリモートアクションを探します。
リモートアクション名を右クリックします。
Export > Remote action to clipboard を選択します。
お気に入りの XML またはプレーンテキストエディタを開きます。
エディターでクリップボードの内容を貼り付けるには Ctrl+V を押します。
リモートアクションの XML 内の Action 要素の UID 属性を見つけます。

Finder はリモートアクションの名前をリンクのテキストとして使い、リンクの前にリモートアクションの特徴的なロケットアイコンを付けます。

リモートアクションをスコアのドキュメントに追加することは、デバイスに適用されるスコアに対してのみ意味があります。

レンダリングの例

Finder はスコアのドキュメント要素を次のように表示します: