セットアップリンク、アドインリンク、簡単な状態リンク、ヘルプリンクへのエントリの追加

[アーティクル]
10/05/2023

適用対象: Windows Server 2016 Essentials、Windows Server 2012 R2 Essentials、Windows Server 2012 Essentials

[セットアップ]、[アドイン]、[簡単な状態] タスク一覧にタスクを追加でき、ダッシュボードのホームページの [コミュニティリンク] セクションにリンクを追加できます。タスクやリンクをこれらの一覧とセクションに追加するには、OEMHomePageContent.home ファイルという名前の XML ファイルまたは OEMHomePageContent.dll という名前の埋め込みリソースファイルを %ProgramFiles%\Windows Server\Bin\Addins\Home に配置します。埋め込みリソースファイルを使用して、追加したタスクとリンクのテキストをローカライズできます。 .home ファイルには、タスクとリンクの XML 定義が含まれます。

セットアップ、アドイン、簡単な状態タスク一覧にタスクを追加し、ヘルプタスクにリンクを追加する

[セットアップ]、[アドイン]、[簡単な状態] タスク一覧にタスクを追加し、[ヘルプ] タスクにリンクを追加するには、XML を使用してタスクとリンクを定義し、任意で埋め込みリソースファイルを作成して、ファイルをサーバーにインストールします。 XML ファイルをリソースファイルなしでサーバーにインストールする場合、OEMHomePageContent.home という名前にする必要があります。アセンブリが XML ファイルとリソースファイルのインストールに使用されている場合、OEMHomePageContent.dll という名前にし、Authenticode 署名する必要があります。

タスクとリンクの定義

メモ帳などのテキストエディターを使用して .home ファイルを作成できます。埋め込みリソースファイルも作成している場合は、Visual Studio 2010 以上を使用してファイルを定義できます。次の手順では、Visual Studio 2010 以降を使用してファイルを作成する方法を示します。

タスクとリンクを定義するには

[スタート] メニューのプログラムを右クリックし、[管理者として実行] を選択して、Visual Studio 2010 以降を管理者として開きます。
[ファイル] をクリックし、[新規作成] をクリックし、[プロジェクト] をクリックします。
[テンプレート] ウィンドウで、[クラスライブラリ] をクリックし、[名前] ボックスに「OEMHomePageContent」と入力して、[OK] をクリックします。
Class1.cs ファイルを削除します。
新しいプロジェクトを右クリックし、[追加] をクリックし、[新しい項目] をクリックします。
[テンプレート] ウィンドウで [XML ファイル] をクリックし、[名前] ボックスに「OEMHomePageContent.home」と入力して、[追加] をクリックします。

注意

XML ファイルをリソースファイルなしでインストールする場合、OEMHomePageContent.home という名前にする必要があります。アセンブリに含める場合は、拡張子が .home である限り、任意の名前を指定できます。

次の XML コードを OEMHomePageContent.home ファイルに追加します。


<Tasks version=?2.0? xmlns=?https://schemas.microsoft.com/WindowsServerSolutions/2010/01/Dashboard>
   <SetupMyServerTasks>
      <Task name="MyTask"
         description="MyTaskDescription"
         id="GUID">
              <Action
              name=?MyAction1Name?
              image=?IconForAction1?
              type=?TaskType?
              exelocation=?ActionExeLocation? />
              <Action
              name=?MyAction2Name?
              image=?IconForAction2?
              type=?TaskType?
              exelocation=?ActionExeLocation? />
               ¦
       </Task>
               ¦
    </SetupMyServerTasks>
<MailServiceTasks>
     <!-- Same schema as in œSetupMyServerTasks? but the tasks are shown in œConnect to Email Service? category. -->
</MailServiceTasks>
<LineOfBusinessTasks>
     <!-- Same schema as in œSetupMyServerTasks? but the tasks are shown in œAdd-ins? category. -->

<GetQuickStatusTasks>
      <Task name="MyQuickStatusTask1"
         description="MyQuickStatusTask1Desc   "
         id="GUID"
         assembly="AssemblyName of quick status query implementation"
         class="ClassName of quick status query implementation"
         replaceid="GUID"/>
           <!--  Same schema as Actions in œSetupMyServerTasks? -->
         </Task>
</GetQuickStatusTasks>
   <Links>
      <Link
         ID=?GUID?
         Title="Displayed text of the link"
         Description="A very short description"
         ShellExecPath="Path to the application or URL"/>
   </Links>
</Tasks>

各値の説明:

属性	説明
Name (Task)	一覧のタスクに表示される名前です。埋め込みリソースファイルを作成する場合、この属性の値は文字列リソースです。
description (Task)	タスクの説明です。埋め込みリソースファイルを作成する場合、この属性の値は文字列リソースです。
id (Task)	タスクの識別子です。この識別子は、GUID でなければなりません。 exe タスクには新しい GUID を作成しますが、グローバルタスクには、サブタブの作業ウィンドウに対してタスクを定義したときに作成した GUID を使用します。GUID の作成の詳細については、「Guid の作成 (guidgen.exe)」を参照してください。
image	このフィールドは無視されます。
Name (Action)	タスクの名前を表示します。
Type (Action)	タスクの種類を説明します。タスクは、グローバルタスク、exe、または URL タスクのいずれかです。グローバルタスクは、サブタブの作業ウィンドウに対してタスクを定義したときに作成したグローバルタスクと同じです。サブタブの作業ウィンドウと、ホームページの作業の開始タスク一覧または共通タスク一覧で使用できるグローバルタスクの作成の詳細については、Windows Server Solutions SDK の「方法: サブタブの作成」の「サポートクラスの作成」を参照してください。 exe タスクは、作業の開始タスク一覧または共通タスク一覧からアプリケーションを実行するために使用できます。
exelocation	タスクに関連付けられているアプリケーションへのパスです。この属性は、exe タスクに対してのみ使用されます。
replaceid	このタスクに置き換えられるタスクの識別子です。
アセンブリ	簡単な状態のクエリを実装するためのクラスを提供するアセンブリの AssemblyName。アセンブリは、Program files\ windows server\bin\ に配置する必要があります。
class	クラスの名前で簡単な状態のクエリを実装します。このクラスは、ITaskStatusQuery インターフェイスを実装する必要があります。
Title (link)	リンクに表示されるテキストです。埋め込みリソースファイルを作成する場合、この属性の値は文字列リソースです。
Description (link)	リンク先の説明です。埋め込みリソースファイルを作成する場合、この属性の値は文字列リソースです。
ShellExecPath	アプリケーションへのパスまたは URL です。注: ShellExecPath 属性では環境変数がサポートされます。

次のコード例は、アプリケーションへのリンクの定義方法を示しています。

<Links>
   <Link Title="Calc" Description="Launches Calc" ShellExecPath="%windir%\system32\calc.exe" />
</Links>

次のコード例は、Web ページへのリンクの定義方法を示しています。

<Links>
   <Link Title="Browser" Description="Open browser" ShellExecPath="http://www.adventureworks.com/" />
</Links>

タスクまたはリンクを表すように属性値を変更します。
ソリューションエクスプローラーで、[OEMHomePageContent.home] を右クリックし、[プロパティ] をクリックします。 [プロパティ] ウィンドウで、[ビルドアクション] の下にある [埋め込まれたリソース] を選択します。
OEMHomePageContent.home ファイルを保存します。

簡単な状態のクエリを実装する方法については、 Windows Server Solutions SDKのドキュメントとサンプルを参照してください。

セットアップ/アドインタスクのステータスの変更

[セットアップ] と [アドイン] の一覧に表示されるタスクのステータスを、完了 (アドイン用に構成されています) と完了していません (アドイン用に構成されていません) で切り替えることができます。

新しいタスクに関連付けられるアプリケーションを定義するときは、Microsoft.WindowsServerSolutions.Administration.ObjectModel.TaskStatusHelper 名前空間の SetTaskStatus メソッドを使用して、タスクのステータスを変更することができます (このメソッドは Windows Server Solutions SDK に付属していますが、ドキュメント化されていません)。たとえば、列挙値 TaskStatus.Complete で SetTaskStatus メソッドを呼び出し、チェックマークを灰色から緑色に変更できます (SetTaskStatus(id, TaskStatus.Complete)、id はタスクの識別子)。使用可能な列挙値は TaskStatus.Complete、TaskStatus.Incomplete、TaskStatus.Hidden です。

タスクの置換

タスクの GUID をタスク定義の replaceid 属性に追加することで、作業の開始タスクまたは共通タスク一覧で事前に定義されたタスクを置換できます。次の表は、タスクと、ダッシュボードで置換できる対応する識別子の一覧です。

タスク名	識別子
他のマイクロソフト製品の更新プログラムの入手	8412D35A-13EE-4112-AE0B-F7DBC83EA83D
サーバーバックアップのセットアップ	F68B3F3F-19DE-499D-9ACB-4BB41B8FF420
Anywhere Access のセットアップ	8991302D-676A-4A7C-B244-D1E08AE0EFEA
電子メールアラート通知のセットアップ	DE6F2B36-F19C-4FAF-998B-9772300E3530
ユーザーアカウントの追加	6D5B5D5F-2EC7-4B1F-9580-4DB084B278B1
サーバーフォルダーの追加	03F1F438-D94E-439B-A9F7-0C817C37D625
Anywhere Access - 簡単な状態	6093B462-1F04-4212-8804-9BC823070FAD
サーバーバックアップ - 簡単な状態	156947D8-21DC-45FE-A9A8-2F80AE304191
サーバーフォルダー - 簡単な状態	C657E8AB-AC1F-4AA1-8E80-5AF6BB27C314
アクティブなユーザーアカウント - 簡単な状態	68BCB125-CE8F-467F-B65B-56AD45A614B5
電子メールアラート通知 - 簡単な状態	75AB06E7-A679-4D62-A5EC-65362FE4F9DB
コンピューター - 簡単な状態	7966A974-D52D-4F5D-B37F-05C1B73CEEF3

(省略可能) リソースファイルの作成

作業の開始タスク、共通タスク、コミュニティリンクに追加するタスクのテキストをローカライズする場合、.home ファイルと、テキスト文字列を定義する .home.resx ファイルが含まれるアセンブリを作成する必要があります。

リソースファイルを作成するには

タスク用に作成したプロジェクトを右クリックし、[追加] をクリックし、[新しい項目] をクリックします。
[テンプレート] ウィンドウで、[リソースファイル] をクリックし、[名前] ボックスに「OEMHomePageContent.home.resx」と入力して、[追加] をクリックします。

注意

リソースファイルには、拡張子が .home.resx である限り、任意の名前を指定できます。
追加するタスクまたはリンクごとに、OEMHomePageContent.home.resx ファイルに、OEMHomePageContent.home ファイルで定義されている Task 要素と Link 要素に一致する文字列と値を追加する必要があります。次のコード例は、リソースファイル用に構造化された Tasks.xml ファイルの例を示しています。
```
<Tasks version=?2.0? xmlns=?https://schemas.microsoft.com/WindowsServerSolutions/2010/01/Dashboard>
   <SetupMyServerTasks>
      <Task name="MyTask"
         description="MyDescription"
         id="GUID">
         <Action
         name="MyActionname"
         image="IconForAction"
         type="TaskType"
         exelocation="ActionExeLocation" />
      </Task>
   </SetupMyServerTasks>
</Tasks>
```
注意

ローカライズに使用される属性の識別子にスペースを含めることはできません。
適切な値を使用して MyTask、MyTaskDescription、MyActionName、および IconForAction のリソース名を .resx ファイルに追加します。
OEMHomePageContent.home.resx ファイルを保存し、ソリューションをビルドします。

Authenticode 署名によるアセンブリの署名

オペレーティングシステムで使用するために、アセンブリを Authenticode で署名する必要があります。アセンブリの署名の詳細については、「 Authenticode によるコードの署名と確認 (英語の場合があります)」を参照してください。

タスクのファイルのインストール

.home および .home.resx ファイルを作成した後、ファイルをサーバーにインストールする必要があります。

タスクのファイルをインストールするには

エラーなしでソリューションがビルドされることを確認します。
埋め込みリソースファイルを作成しなかった場合、OEMHomePageContent.home ファイルをサーバー上の %ProgramFiles%\Windows Server\Bin\Addins\Home にコピーします。埋め込みリソースファイルを作成した場合、OEMHomePageContent.dll ファイルをサーバー上の %ProgramFiles%\Windows Server\Bin\Addins\Home にコピーします。

参照

イメージの作成とカスタマイズ追加のカスタマイズデプロイのイメージの準備カスタマーエクスペリエンスのテスト

セットアップ リンク、アドイン リンク、簡単な状態リンク、ヘルプ リンクへのエントリの追加

セットアップ、アドイン、簡単な状態タスク一覧にタスクを追加し、ヘルプ タスクにリンクを追加する