Config.xml リファレンス (Office SharePoint Server)

  • [アーティクル]

Microsoft Office SharePoint Server 2007 のインストール方法を制御する場合は、Setup.exe と共に Config.xml ファイルを使用します。config.xml file を使用すると、たとえば以下のことができます。

  • Office SharePoint Server 2007 のサイレント インストールを実行する。

  • 複数のサーバーで共通の構成を使用して Office SharePoint Server 2007 をインストールする。

  • Office SharePoint Server 2007 の自動インストールまたはスクリプト インストールを実行する。

この記事の内容 :

  • Config.xml をカスタマイズする

  • Config.xml 要素のクイック リファレンス

  • 動作

  • Config.xml ファイルの形式

  • Config.xml 要素のリファレンス

Config.xml をカスタマイズする

インストールを制御するには、最初にテキスト エディタで Config.xml ファイルを編集し、適切な設定を使用して要素を含めます。次に、setup.exe /config [path and file name] を実行し、Config.xml ファイルで設定したオプションを実行および使用するように Setup.exe を指定します。

重要

Config.xml を編集するには、メモ帳などのテキスト エディタを使用します。Microsoft Office Word 2007 などの汎用の XML エディタは使用しないでください。

製品の DVD には、Config.xml ファイルのサンプルが含まれています。サンプル ファイルは、DVD のルートにある \Files フォルダ内のさまざまなシナリオに対応するフォルダにあります。それらのフォルダは以下のとおりです。

  • Setup   1 台のサーバー (スタンドアロン、SQL Express を含む) のクリーン インストールを構成するために使用できる config.xml ファイルが含まれています。

  • SetupFarm   サーバー ファームのクリーン インストールを構成するために使用できる config.xml ファイルが含まれています。

  • SetupFarmSidebySide   既存のサーバー ファームを段階的にアップグレードするために使用できる config.xml ファイルが含まれています。

  • SetupFarmSilent   サイレント モードでサーバー ファームを構成するために使用できる config.xml ファイルが含まれています。

  • SetupFarmUpgrade   既存のサーバー ファームをアップグレードするために使用できる config.xml ファイルが含まれています。

  • SetupSilent   1 台のサーバー (スタンドアロン、SQL Express を含む) のクリーン インストールをサイレント モードで構成するために使用できる config.xml ファイルが含まれています。

  • SetupSingleUpgrade   既存の 1 台のサーバー (スタンドアロン) をアップグレードするために使用できる config.xml ファイルが含まれています。

重要

Office SharePoint Server 2007 に含まれる既定の構成ファイルでは、SETUP_REBOOT 設定が省略されます。コマンド ライン インストール中に再起動する場合は、この設定が含まれている必要があります。

さまざまなアップグレード シナリオの違いの詳細については、「アップグレード方法を決定する (Office SharePoint Server)」を参照してください。

Config.xml 要素のクイック リファレンス

次の表は、Config.xml の要素の一覧です。これらの要素は任意の順序で記述することができます。ただし、Configuration は最初に記述する必要があり、また、Command などの要素は Config.xml 内での順序がインストール時の処理方法に影響します。

要素

説明

Configuration

最上位の要素です。

ARP

製品についてコントロール パネルの [プログラムの追加と削除] のテキストと動作を制御する値です。

Command

インストール時にコマンドを実行します。

Display

セットアップがユーザーに対して表示する UI のレベルです。

INSTALLLOCATION

ユーザーのコンピュータ上の製品がインストールされるフォルダへの絶対パスです。

Logging

セットアップが実行するログ記録の種類を指定するオプションです。

DATADIR

データ ファイルの格納に使用する場所です。

Package

インストールするパッケージまたは製品です。

PIDKEY

25 文字のボリューム ライセンス キーです。

Setting

Windows インストーラのプロパティの値です。

動作

セットアップは、Setup.exe と同じフォルダで Config.xml のコピーを探します。ここにコピーが見つからない場合、インストールする製品のコア \Files フォルダにある Config.xml ファイルを使用します。

セットアップの /config コマンド ライン オプションを使用して、Config.xml ファイルの場所を指定することもできます。次に例を示します。

\\<サーバー>\<共有>\setup.exe /config \\<サーバー>\<共有>\<フォルダ>\config.xml

Config.xml ファイルの形式

Config.xml の XML 要素は、< で始まり、/> で終わります。

基本的な要素の形式は、次のとおりです。

<element_name [attribute_name="値"] [attribute_name="値"] … />

次に例を示します。

<Display Level="none" CompletionNotice="no" />

要素と属性では大文字と小文字が区別されます。属性値は二重引用符 (") で囲む必要があり、大文字と小文字は区別されません。

要素の定義は複数行にわたる場合があります。要素の定義内のスペース、復帰、改行、およびタブ文字は無視されます。

次に例を示します。

<Display
   Level="none"
   CompletionNotice="no"
/>

ヒント

要素の定義が長い場合は、各属性を独立した行に配置し、インデントを使用すると、ファイルが読みやすくなります。

Configuration 要素は特殊な要素で必須です。他のすべての要素は Configuration 要素内に含まれ、この要素は </Configuration> で閉じられます。

次の例は、Windows SharePoint Services 3.0 パッケージのクリーン インストール用のサンプルの構成ファイルを示しています。

<Configuration>

   <Package Id="sts">

      <Setting Id="REBOOT" Value="ReallySuppress"/>

      <Setting Id="SETUPTYPE" Value="CLEAN_INSTALL"/>

   </Package>

   <DATADIR Value="%CommonProgramFiles%\Microsoft Shared\Web Server Extensions\12\Data"/>

   <Logging Type="verbose" Path="%temp%" Template="Microsoft Windows SharePoint Services 3.0 Setup(*).log"/>

   <Setting Id="UsingUIInstallMode" Value="1"/>

   <Setting Id="SETUP_REBOOT" Value="Never"/>

</Configuration>

重要

Office SharePoint Server 2007 に含まれる既定の構成ファイルでは、SETUP_REBOOT 設定が省略されます。コマンド ライン インストール中に再起動する場合は、この設定が含まれている必要があります。

コメントは、"<!--" と "-->" で区切って、任意の場所に追加できます。

次に例を示します。

<!-- Install Windows SharePoint Services for clean install, using UI-->

<Configuration>

   <Package Id="sts">

      <Setting Id="REBOOT" Value="ReallySuppress"/>

      <!-- Tells Windows Installer not to reboot -->

      <Setting Id="SETUPTYPE" Value="CLEAN_INSTALL"/>

   </Package>

   <DATADIR Value="%CommonProgramFiles%\Microsoft Shared\Web Server Extensions\12\Data"/>

   <Logging Type="verbose" Path="%temp%" Template="Microsoft Windows SharePoint Services 3.0 Setup(*).log"/>

   <Setting Id="UsingUIInstallMode" Value="1"/>

   <Setting Id="SETUP_REBOOT" Value="Never"/>

   <!-- Tells Setup.exe not to reboot -->

</Configuration>

Config.xml 要素のリファレンス

このリファレンスの説明では、以下の表記規則を使用します。

太字

要素または属性名

通常のフォント

表示されているとおりに入力するテキスト

*イタリック*

追加する値のプレースホルダ

*x*|*y*

複数の値からの選択

[*x*]

省略可能な値

Configuration 要素

最上位の要素です。この要素は必須で、他のすべての要素はこの要素内に含まれている必要があります。

構文

<Configuration>

<Package Id="ID">

...

</Package>

...

</Configuration>

属性

属性

値

説明

Package ID

*Package ID*

インストールされるパッケージです。

備考

Package Id 属性は、この Config.xml ファイルの影響を受ける製品およびテクノロジを識別します。

例

Office SharePoint Server 2007 の Package ID は spswfe です。Office SharePoint Server 2007 は Windows SharePoint Services 3.0 のプラットフォーム テクノロジに基づいているので、sts (Windows SharePoint Services 3.0) パッケージもインストールしないと、インストールは正常に行われません。

sts および spswfe の Package ID を Config.xml で使用し、次のように入力して Windows SharePoint Services 3.0 および Office SharePoint Server 2007 を指定します。

<Configuration>
   <Package Id="sts">
   ...
   </Package>
   ...
   <Package Id="spswfe">
   ...
   </Package>
   ...
</Configuration>

ARP 要素

製品についてコントロール パネルの [プログラムの追加と削除] のテキストと動作を制御する値を指定します。

構文

<ARP attribute =" value " [attribute**="value"**] ... />

属性

属性

値

説明

ARPCOMMENTS

*text*

追加のテキストです。最大で 255 文字まで入力できますが、一部の文字が表示されない場合があります。

ARPCONTACT

*text*

技術サポートの連絡先の一覧です。

ARPNOMODIFY

Yes

[変更] ボタンを使用できないようにして、ユーザーが製品のインストールを変更できないようにします。

No (既定値)

ユーザーが製品のインストールを変更することを許可します。

ARPNOREMOVE

Yes

[削除] ボタンを使用できないようにして、ユーザーが製品を削除できないようにします。

No (既定値)

ユーザーが製品を削除することを許可します。

ARPURLINFOABOUT

*URL*

製品のホーム ページの URL です。

ARPURLUPDATEINFO

*URL*

製品の更新プログラムに関する情報の URL です。

ARPHELPLINK

*URL*

ユーザーがテクニカル サポートを受けることができる Web サイトの URL です。

ARPHELPTELEPHONE

*text*

テクニカル サポートの電話番号です。

Command 要素

実行するコマンド ラインを指定します。Command 要素のコマンドは、初期のインストールとアンインストール時にのみ処理されます。初期インストール後、カスタマイズのために Command 要素のコマンドを使用しても、コマンドは無視されます。

構文

<Command

Path=" path "

[QuietArg="arguments"]

[Args="args"]

[ChainPosition="Before" | "After"(既定値)]

[Wait="mseconds"]

[QuietWait="mseconds"]

[Execute="Install"(既定値) | "Uninstall"]

[Platform="x86"(既定値) | "x64"]

/>

属性

Path 属性および Args 属性で二重引用符 (") を指定するには、二重引用符を 2 つ ("") 指定します。

属性

値

説明

Path

*path*

Microsoft® Windows Installer (MSI) パッケージの実行可能ファイルへの絶対パスです。

QuietArg

*string*

Display Level=None である場合に、コマンド ラインに追加される引数の文字列です。

Args

*string*

実行可能ファイルに渡される引数の文字列です。

ChainPosition

Before

このコマンドは、主な製品のインストールの前に実行されます。

After (既定値)

このコマンドは、主な製品のインストールの後に実行されます。

Wait

*mseconds*

Display Level 属性を "Full" または "Basic" に設定してインストールする場合に、プログラムを実行してから、インストールを続行するまでに待機するミリ秒単位の時間です。既定値は 0 (ゼロ) で、待ち時間がないことを示します。

QuietWait

*mseconds*

Display Level 属性を "None" に設定してインストールする場合に、プログラムを実行してから、インストールを続行するまでに待機するミリ秒単位の時間です。既定値は 0 (ゼロ) で、待ち時間がないことを示します。

Execute

Install (既定値)

セットアップは、主な製品をインストールするときにこのコマンドを実行します。

Uninstall

セットアップは、主な製品をアンインストールするときにこのコマンドを実行します。

Platform

x86 (既定値)

このプログラムは Intel x86 プラットフォームを必要とすることを指定します。このコマンドは、インストールを実行するコンピュータがこのプラットフォームの要件に一致している場合にのみ実行されます。

x64

このプログラムが x86 アーキテクチャに対する x64 拡張機能をサポートする 64 ビット プロセッサを必要とすることを指定します。このコマンドは、インストールを実行するコンピュータがこのプラットフォームの要件に一致している場合にのみ実行されます。

備考

コマンド ラインは、チェーン インストールまたはこの製品をインストールするときに実行される実行可能プログラムについて指定できます。これを指定する場合は、単一の MSI ファイルではなく、Setup.exe のコマンド ラインを指定する必要があります。

Config.xml ファイルに複数の Command 要素がある場合は、Config.xml で指定されている順序で実行されます。

例

<Command Path=”myscript.exe” Args=”/id ""123 abc"" /q”/>

<Command Path="\\<server>\<share>\setup.exe /config \\<server>\<share>\<folder>\config.xml"

DATADIR 要素

検索インデックス ファイルを含めて、データ ファイルの格納に使用する場所です。

構文

<DATADIR Value=" パス "/>

属性

属性

値

説明

Value

パス

セットアップは、指定した場所にデータ ファイルを格納します。

備考

このパスでは、システム環境変数を使用できます。この要素が定義されていない場合、データは次のパスに格納されます。

%PROGRAMFILES%\Microsoft Office Servers\12.0\Data

例

<DATADIR Value=”d:\data”/>

Display 要素

セットアップがユーザーに対して表示する UI のレベルです。

構文

<Display

Level="None" | "Basic" | "Full"(既定値)

CompletionNotice="Yes"(既定値) | "No"

SuppressModal="Yes" | "No"(既定値)

NoCancel="Yes" | "No"(既定値)

AcceptEula="Yes" | "No"(既定値)

/>

属性

属性

値

説明

Level

None

セットアップの UI は表示されません。

Basic

セットアップは、起動画面、プロダクト キー (PIDKEY) のページ (必要な場合)、マイクロソフト ソフトウェア ライセンス条項のページ (必要な場合)、進行状況バー、および完了通知 (許可されている場合) を表示します。

Full (既定値)

セットアップはユーザーに対してすべての UI を表示します。

CompletionNotice

Yes

Level が "Basic" または "None" に設定されている場合にのみ適用され、セットアップは完了通知を表示します。

No (既定値)

Level が "Basic" に設定されている場合にのみ適用され、セットアップは完了通知を表示しません。

SuppressModal

Yes

Level が "Basic" に設定されている場合にのみ適用され、セットアップはインストールを中断するエラー メッセージおよびその他のダイアログ ボックスを表示しません。

No (既定値)

Level が "Basic" に設定されている場合にのみ適用され、セットアップは必要に応じてエラーおよびその他のダイアログ ボックスを表示します。

NoCancel

Yes

Level が "Full" または "Basic" に設定されている場合に、キャンセル ボタン (進行状況ダイアログの右上隅の X) を無効にします。

No (既定値)

Level が "Full" または "Basic" に設定されている場合に、ユーザーが進行状況バーからインストールを取り消すことができるようにします。

AcceptEULA

Yes

マイクロソフト ソフトウェア ライセンス条項はユーザーに代わって同意され、マイクロソフト ソフトウェア ライセンス条項のページは表示されません。

No (既定値)

Level が "None" に設定されていない場合、マイクロソフト ソフトウェア ライセンス条項のページが表示されます。

備考

この要素が定義されていない場合、既定の設定が使用されます。無効な値が指定されている場合は、セットアップはインストールを終了します。

Level 属性が "Basic" または "None" に設定されており、PIDKEY 要素を使用してプロダクト キーを指定した場合、セットアップは管理者がユーザーの代わりにライセンス条項にも同意したものと見なします。この場合、AcceptEULA 属性の設定にかかわらず、インストール中にユーザーに対してライセンス条項に対する確認のメッセージは表示されません。

注意

セットアップで Display 要素が使用されるのは、セットアップが setup.exe と同じフォルダで Config.xml ファイルを見つけた場合、またはセットアップのコマンド ライン オプション /config を使用して Config.xml ファイルを指定した場合だけです。

例

<Display Level=”basic”
   CompletionNotice=”yes”
   SupressModal=”no”
   AcceptEula=”yes”
/>

INSTALLLOCATION 要素

ユーザーのコンピュータ上の製品がインストールされるフォルダへの絶対パスを指定します。

構文

<INSTALLLOCATION Value=" パス " />

属性

属性

値

説明

Value

パス

ユーザーのコンピュータ上の製品がインストールされるフォルダへの絶対パスです。

備考

このパスでは、システム環境変数を使用できます。この要素が定義されていない場合、製品は次のパスにインストールされます。

%PROGRAMFILES%\Microsoft Office Servers\12.0\

Windows SharePoint Services 3.0 テクノロジは、この要素による影響を受けず、次のパスにインストールされます。

%PROGRAMFILES%\Common Files\Microsoft Shared\web server extensions\12

例

<INSTALLLOCATION VALUE=”%ProgramFiles%\MyApps” />

Logging 要素

セットアップが実行するログ記録の種類を指定します。

構文

<Logging

Type="Off" | "Standard"(既定値) | "Verbose"

Path=" path "

Template=" filename .txt"

/>

属性

属性

値

説明

Type

Off

セットアップはログを記録しません。

Standard (既定値)

セットアップはインストール情報をログ ファイルに書き込みます。

Verbose

セットアップはすべてのインストール情報をログ ファイルに書き込みます。

Path

*Path*

ログ ファイル用に使用されるフォルダへの絶対パスです。環境変数を使用できます。既定値は %temp% です。

Template

*filename* .txt

ログ ファイルの名前です。ファイル名の任意の場所に文字列 * を挿入した場合、Setup.exe によって実行される各インストールについて一意のログ ファイルが作成されます。後の説明を参照してください。* が含まれておらず、指定したファイル名が既に存在している場合、ログ情報は既存のファイルに追加されます。ファイル拡張子 .txt を含める必要があります。既定のテンプレートは SetupExe(*).log です。

備考

Template 値の任意の場所で * を指定できます。セットアップは、その場所に次の形式で文字列を挿入します。

YYYYMMDDHHMMSSxxx

それぞれの値の意味は以下のとおりです。

  1. YYYY = 年

  2. MM = 月

  3. DD = 日

  4. HH = 時

  5. MM = 分

  6. SS = 秒

  7. xxx = セットアップによって生成される一意の文字列

注意

Logging 要素がセットアップで使用されるのは、Setup /config コマンド ライン オプションを使用して Config.xml ファイルを指定する場合のみです。使用する Config.xml ファイルを指定しない場合、既定のログ オプションが使用されます。

例

<Logging Type=”standard” Path=”%temp%”
   Template=”MyLog(*).txt”
/>

この例では、セットアップは製品をインストールするたびにログ ファイルを作成します。次のような一意のファイル名が使用されます。

%temp%\MyLog(20060428110717CFC).txt
%temp%\MyLog(20060429113143C70).txt

Package 要素

インストールするパッケージまたは製品です。

Office SharePoint Server 2007 の Package ID は spswfe です。Office SharePoint Server 2007 は Windows SharePoint Services 3.0 のプラットフォーム テクノロジに基づいているため、sts (Windows SharePoint Services 3.0) パッケージもインストールしないと、インストールは正常に行われません。

PIDKEY 要素

25 文字のボリューム ライセンス キーです。

構文

<PIDKEY Value=" 25-character-key " />

属性

属性

値

説明

Value

*25-character-key*

25 文字のボリューム ライセンス キーです。

備考

PIDKEY 値が設定されている場合、セットアップを実行するときにプロダクト キーを入力する必要がありません。

例

<PIDKEY Value="1234512345123451234512345" />

注意

Display 要素の Level 属性が "Basic" または "None" に設定されており、PIDKEY 要素を使用してプロダクト キーを指定した場合、セットアップは管理者がユーザーの代わりにライセンス条項にも同意したものと見なします。この場合、Display 要素の AcceptEULA 属性の設定にかかわらず、インストール中にユーザーに対してライセンス条項に対する確認のメッセージは表示されません。

Setting 要素

Windows インストーラのプロパティの値を指定できます。

構文

<Setting Id=" 名前 " Value=" 値 " />

属性

属性

値

説明

Id

*名前*

Windows インストーラのプロパティの名前です。

Value

*値*

プロパティに割り当てる値です。

値

サーバーへのインストールには以下の設定 ID が使用されます。

ID

使用できる値

説明

LAUNCHEDFROMSETUPSTS

Yes | No

Package ID 属性の一部として使用します。既定値は Yes です。

REBOOT

ReallySuppress

セットアップの完了後に再起動を許可するかどうかを (Windows インストーラに対して) 指定します。再起動しないことを指定するには、ReallySuppress を使用します。パッケージ単位ではなく、グローバル レベルで指定する必要があります。

SETUP_REBOOT

Never、AutoAlways、Always、AutoIfNeeded、IfNeeded

セットアップ完了後の再起動を許可するかどうかを (Setup.exe に対して) 指定します。再起動しないことを指定するには、Never を使用します。パッケージ単位ではなく、グローバル レベルで指定する必要があります。

SETUPTYPE

CLEAN_INSTALL、V2V_GRADUAL_UPGRADE、V2V_INPLACE_UPGRADE、SKU2SKU_UPGRADE

製品またはテクノロジの新しいコピーをインストールするか (CLEAN_INSTALL)、段階的なアップグレードのために以前のバージョンと並行してインストールするか (V2V_GRADUAL_UPGRADE)、新しいバージョンをインストールして以前のバージョンをアップグレードするか (V2V_INPLACE_UPGRADE)、または 1 つの製品から別の製品にアップグレードするか (Windows SharePoint Services 3.0 から Office SharePoint Server 2007 など) を指定します。パッケージ単位ではなく、グローバル レベルで指定する必要があります。

SETUPCALLED

0 | 1

Package ID 属性の一部として使用します。

OFFICESERVERPREMIUM

0 | 1

Package ID 属性の一部として使用します。インストールする Office SharePoint Server 2007 のバージョン (標準版 (0) またはエンタープライズ版 (1)) を指定します。使用する PIDKEY がこの設定よりも優先されます。

SERVERROLE

SINGLESERVER、WFE、APPLICATION

インストール先のサーバーの種類 (スタンドアロン (SINGLESERVER)、フロントエンド Web サーバー (WFE)、またはアプリケーション (APPLICATION)) を指定します。

USINGUIINSTALLMODE

0 | 1

サイレント インストールを実行するか (0) 、セットアップにユーザー インターフェイスを使用するか (1) を指定します。

備考

Windows インストーラのすべてのプロパティを Setting 要素で指定できるわけではありません。ブロックされているプロパティが指定されている場合、セットアップはインストール処理を終了します。サポートされているプロパティが指定されている場合、セットアップはプロパティを直接 Windows インストーラに渡します。Windows インストーラのすべてのプロパティの一覧、サポートおよびブロックされるプロパティの説明については、「Setup properties in the 2007 Office system」を参照してください。

例

<Setting Id="REBOOT" Value="ReallySuppress" />

このドキュメントをダウンロードする

このトピックは、簡単に読んだり印刷したりできるように、次のダウンロード可能なドキュメントに収められています。

使用できるすべてのブックの一覧については、「Office SharePoint Server 2007 のダウンロード可能なブック」を参照してください。