customlinks.xmlファイルの作成
次の各項の説明に従ってcustomlinks.xml
ファイルを作成し、グローバル・ヘッダーに対してカスタマイズを指定します。
ファイルの作成
instanceconfig.xml
ファイルで指定されている任意の絶対パスに、customlinks.xml
ファイルを配置できます。CustomLinks要素の追加を参照してください。推奨されるこのファイルのデフォルトの作成場所は、プレゼンテーション・サービスのデータ・ディレクトリです。
BI_DOMAIN/bidata/components/OBIPS/customMessages
ファイル内の要素
次の表は、customlinks.xml
ファイルで指定できる要素と属性について説明しています。デフォルトで表示される既存のリンクを非表示にするには、それらのエントリをファイルでコメント・アウトできます。「お気に入り」や「ダッシュボード」などのデフォルトのリンクの順序は変更できません。
要素または属性 | オプションかどうか | データ型 | 説明 |
---|---|---|---|
locations |
オプション |
該当なし |
追加するリンクの場所を指定するための親要素として使用します。場所を指定しなかった場合、リンクはデフォルトで、グローバル・ヘッダーの「ヘルプ」リンクの前で「はじめに」セクションの終わりに配置されます。 |
location: name |
必須 |
文字列 |
locations親要素を指定する場合は、この属性を使用します。値は次のとおりです。 header: グローバル・ヘッダーにリンクを配置するように指定します。 |
location: insertBefore |
オプション |
文字列 |
その前にこのリンクを挿入する、既存のリンクのIDを指定します。指定したIDが無効な場合、リンクはデフォルトの場所に挿入されます。 有効な値の詳細は、「insertBefore属性の指定」を参照してください。 |
link: id |
必須 |
文字列 |
リンクの位置を指定する一意のIDとして使用します。カスタム・リンクのIDを指定し、それらをデフォルト・リンクに対して相対的な場所に配置できます。 |
link: name |
必須 |
文字列 |
翻訳されないリンクの名前を指定します。 |
link: localizedName |
オプション |
文字列 |
翻訳されるリンクのメッセージIDを指定します。これは、翻訳されない名前に優先します。 |
link: iconSmall |
オプション |
文字列 |
グローバル・ヘッダーにリンクとともに表示するアイコンのファイル名を指定します。アイコンの表示はfmap構文によって制御されます。 |
link: privilege |
オプション |
文字列 |
リンクを表示するためにユーザーへの付与が必要な権限の名前を指定します。次の例に示すように、この権限は式として表されます。 privileges.Access['Global Answers']&& privileges.Access['Global Delivers'] |
link: accessibility |
オプション |
ブール |
アクセシビリティ・モードで、accessibility属性がtrueに設定されている場合にのみリンクが使用可能になるように指定します。値は、trueおよびfalseで、falseがデフォルトです。 以前のリリースでは、vpat属性はaccessibility属性と同じ目的を果たしていました。vpat属性は非推奨となりました。 |
link: src |
必須 |
文字列 |
リンクのURLを指定します。 |
link: target |
オプション |
文字列 |
リンクを開くブラウザ・ウィンドウを指定します。値は次のとおりです。 self: プレゼンテーション・サービスが実行されているウィンドウと同じウィンドウで開きます。 blank: 新しいウィンドウで開きます。 any-name: 指定された名前のウィンドウで開きます。 |
link: description |
オプション |
文字列 |
翻訳されないリンクの説明を指定します。 |
link: localizedDesc |
オプション |
文字列 |
翻訳されるリンクのメッセージIDを指定します。これは、翻訳されない説明に優先します。 |
システムの起動および停止で説明されているように、customlinks.xml
ファイルの更新後、このファイルは次回プレゼンテーション・サービスを再起動する際にリロードされます。
insertBefore属性の指定
insertBefore
属性を含めると、既存のリンクのIDを指定して、その前に別のリンクを挿入できます。次のリストは、グローバル・ヘッダーの有効なIDを示しています。
- Navigation Bar
- catalog
- dashboard
- favorites
- home
- new
- open
- user
- admin
- help
- logout
ファイルと出力の例
次のコード例は、リンクをグローバル・ヘッダー・セクションに含めるように構成した、customlinks.xml
ファイルを示しています。
<?xml version="1.0" encoding="utf-8"?>
<customLinks xmlns="com.siebel.analytics.web/customlinks/v1">
<link id="l1" name="OTN" description="OTN open in new window" src="http://www.example.com" target="blank" >
<locations>
<location name="header" />
</locations>
</link>
<link id="l2" name="Google Search" description="Google open in named window" src="http://www.google.com/" target="google" iconSmall="common/info_ena.png" >
<locations>
<location name="header" insertBefore="advanced" />
</locations>
</link>
<link id="l5" name="Gmail" description="gmail" src="http://www.gmail.com" target="blank" iconLarge="common/gmail.png" >
<locations>
<location name="header" insertBefore="catalog" />
</locations>
</link>
</customLinks>
このファイルは、次のように「ホーム」ページを変更します。ホーム・ページに対する次の変更に注意してください。
-
次を含むようにグローバル・ヘッダーが変更されます。
-
Google Search: カスタム・アイコンを使用するGoogleホーム・ページへのリンク。「詳細」リンクの前に配置されます。
-
OTN: Oracle Technology Networkページへのリンク。「ヘルプ」リンクの前に配置されます。
-
Gmail: Gmailホーム・ページへのリンク。「カタログ」リンクの前に配置されます。
-