<action> 要素は <entry> 要素の子で、ユーザー操作を定義します。各 <action> 要素は、必ず 1 つの子要素を含む必要があります。
<action> 要素には次の 2 つの属性があります。
text – ユーザー操作のリンク用にレンダリングされるテキスト
tooltip (オプション) – ユーザー操作のリンクとして使用されるツールヒント
各 <action> 要素には、次の子要素のいずれかが含まれている必要があります。
<compCreate> 要素は <action> 要素の子で、名前が指定されたコンポーネント型の「component create」ページへのリンクを定義します。
<compCreate> 要素には次の 1 つの必須属性があります。
typeName – コンポーネント型の名前。コンポーネント型は、当該プラグイン、または当該プラグインが直接依存するプラグインに含まれている必要があります。コンポーネント型を hidden として定義することはできません。pluginName は、fullPluginName#componentTypeName のように、コンポーネント型名の接頭辞である必要があります。
<compDetails> 要素は <action> 要素の子で、名前付きコンポーネントの最新バージョンに関する「component details」ページへのリンクを定義します。
<compDetails> 要素には次の 2 つの必須属性があります。
path – コンポーネントの絶対パス。
name – コンポーネントの名前。コンポーネントは、当該プラグイン、または当該プラグインが直接依存するプラグインに含まれている必要があります。
<compList> 要素は <action> 要素の子で、名前が指定されたコンポーネント型によりフィルタリングされる「component list」ページへのリンクを定義します。オプションの path または flatView 属性が省略されている場合、それらの値は、ユーザーがリンクをクリックしたときにユーザーのセッションからピックアップされます。省略されてない場合、ユーザーのセッション値は、リンクをクリックしたあとにそれらを反映するよう変更されます。
<compList> 要素には次の 3 つの属性があります。
typeName – コンポーネント型の必須の名前。コンポーネント型は、当該プラグイン、または当該プラグインが直接依存するプラグインに含まれている必要があります。コンポーネント型を hidden として定義することはできません。pluginName は、fullPluginName#componentTypeName のように、コンポーネント型名の接頭辞である必要があります。
path (オプション) – フルパスで、これにより「components list」ページをフィルタリングします。パスは、スラッシュ (/) で始まる必要がありますが、スラッシュ (/) で終わってはいけません。パスが表すフォルダは、当該プラグインにより所有されるか、当該プラグインが直接依存するプラグインにより所有されるフォルダである必要があります。また、フォルダは当該プラグインに所有されるフォルダ、または当該プラグインが直接依存するプラグインにより所有されるフォルダを含むことができます。
flatView (オプション) – リストページでフラットビューフィルタを有効にする必要があるかどうかに関する文。
<compWhereInstalled> 要素は <action> 要素の子で、名前付きコンポーネントの最新バージョンに関する「Component Where Installed」ページへのリンクを定義します。
<compWhereInstalled> 要素には次の 2 つの必須属性があります。
path – コンポーネントの絶対パス。
name – コンポーネントの名前。コンポーネントは、当該プラグイン、または当該プラグインが直接依存するプラグインに含まれている必要があります。
<hostList> 要素は <action> 要素の子で、名前が指定されたホスト型によりフィルタリングされる「host list」ページへのリンクを定義します。
<hostList> 要素には次の 1 つの必須属性があります。
typeName – ホスト型の名前。ホスト型は、当該プラグイン、または当該プラグインが直接依存するプラグインに含まれている必要があります。ホスト型を hidden として定義することはできません。pluginName は、 fullPluginName#hostTypeName のように、ホスト型名の接頭辞である必要があります。
<planDetails> 要素は <action> 要素の子で、名前付きプランの最新バージョンに関する「plan details」ページへのリンクを定義します。
<planDetails> 要素には次の 2 つの必須属性があります。
path – プランの絶対パス。
name – プランの名前。プランは、当該プラグイン、または当該プラグインが直接依存するプラグインに含まれている必要があります。
<compProcedureRun> 要素は <action> 要素の子で、コンポーネントプロシージャを直接実行できるようにします。
<compProcedureRun> 要素には次の 4 つの必須属性があります。
name – 実行するプロシージャが含まれるコンポーネントの名前。コンポーネントは、当該プラグイン、または当該プラグインが直接依存するプラグインに含まれている必要があります。
path – コンポーネントへの絶対パス。
procedureName – コンポーネントプロシージャの名前。
procedureType – コンポーネントプロシージャの型。有効な値には、INSTALL、UNINSTALL または CONTROL が含まれます。
<external> 要素は <action> 要素の子で、N1 SPS製品の外部にある任意の URL へのリンクを定義します。たとえば、この要素を使用すると、特定のプラグインまたは機能に関する詳細情報が含まれる企業の Web ページへのリンクを指定できます。
<external> 要素には 1 つの属性 url があり、正しい形式の URL が指定できます。URL は、RFC3986 Uniform Resource Identifier (URI): Generic Syntax で指定されている、Uniform Resource Identifier (URI) のインターネット標準に準拠する必要があります。
プラグインユーザーインタフェース記述子の XML の形式が正しくなるよう、url 属性にはエスケープされた特殊文字を含むことができます。指定文字には、次のエスケープシーケンスを使用します。
文字 |
エスケープシーケンス |
---|---|
> |
> |
< |
< |
" |
" |
& |
& |