Referência do Config.xml (Office SharePoint Server)
Atualizado em: 2008-04-17
Quando você desejar controlar a forma como o Microsoft Office SharePoint Server 2007 será instalado, use o arquivo Config.xml junto com Setup.exe. Por exemplo, você pode usar o arquivo Config.xml para:
Executar uma instalação silenciosa do Office SharePoint Server 2007.
Instalar o Office SharePoint Server 2007 usando uma configuração comum em vários servidores.
Executar uma instalação automatizada ou baseada em scripts do Office SharePoint Server 2007.
Neste artigo:
Personalizando o Config.xml
Referência rápida de elementos do Config.xml
Como funciona
Formato do arquivo Config.xml
Referência de elementos do Config.xml
Personalizando o Config.xml
Para controlar a instalação, primeiro edite o arquivo Config. xml em um editor de texto para incluir os elementos necessários com as configurações apropriadas para eles. Em seguida, execute setup.exe /config [path and file name]
para especificar que Setup.exe será executado e usará as opções definidas no arquivo Config.xml.
Importante
Use um editor de texto, como o Bloco de Notas, para editar o Config.xml. Não use um editor XML de finalidade geral como o Microsoft Office Word 2007.
O DVD do produto contém exemplos de arquivos Config.xml. Eles são armazenados na pasta \Files da raiz do DVD, em pastas que correspondem a cenários diferentes. As pastas são:
Setup Contém um arquivo Config.xml para a configuração de uma instalação limpa para um único servidor (autônomo, com SQL Express).
SetupFarm Contém um arquivo Config.xml para a configuração de uma instalação limpa para um farm de servidores.
SetupFarmSidebySide Contém um arquivo Config.xml para a atualização gradual de um farm de servidores.
SetupFarmSilent Contém um arquivo Config.xml para a configuração de um farm de servidores em modo sem confirmação.
SetupFarmUpgrade Contém um arquivo Config.xml para a atualização no local de um farm de servidores.
SetupSilent Contém um arquivo Config.xml para a configuração de uma instalação limpa para um único servidor (autônomo, com SQL Express) em modo sem confirmação.
SetupSingleUpgrade Contém um arquivo Config.xml para a atualização no local de um único servidor existente (autônomo).
Importante
Os arquivos de configuração padrão incluídos no Office SharePoint Server 2007 omitem a configuração SETUP_REBOOT. Você precisará incluí-la se quiser suprimir reinicializações durante uma instalação de linha de comando.
Para obter mais informações sobre as diferenças entre os vários cenários de atualização, consulte Determinar método de atualização (Office SharePoint Server).
Referência rápida de elementos do Config.xml
A tabela a seguir contém uma lista dos elementos do Config.xml. Esses elementos podem aparecer em qualquer ordem, exceto por Configuration, que deverá ser o primeiro, e elementos como Command, cuja ordem no Config.xml afetará a forma como os comandos serão processados durante a instalação.
Elemento |
Descrição |
Configuration |
Elemento de nível superior. |
ARP |
Valores que controlam o texto e o comportamento de Adicionar ou Remover Programas no Painel de Controle para o produto. |
Command |
Executa um comando durante a instalação. |
Display |
O nível de interface do usuário que a Instalação exibe para o usuário. |
INSTALLLOCATION |
O caminho totalmente qualificado para a pasta no computador do usuário na qual o produto está instalado. |
Logging |
Opções para o tipo de log executado pela Instalação. |
DATADIR |
O local a ser usado para armazenar os arquivos de dados. |
Package |
O pacote ou produto a ser instalado. |
PIDKEY |
A chave de licença de volume de 25 caracteres. |
Setting |
Valores para propriedades do Windows Installer. |
Como funciona
A Instalação procura por uma cópia do Config.xml na mesma pasta do Setup.exe. Se nenhuma for encontrada, a Instalação usará o arquivo Config.xml presente na pasta \Files principal do produto que você está instalando.
Também é possível usar a opção de linha de comando /config da Instalação para especificar o local do arquivo. Por exemplo:
\\<servidor>\<compartilhamento>\setup.exe /config \\<servidor>\<compartilhamento>\<pasta>\Config.xml
Formato de arquivo do Config.xml
Os elementos XML do Config.xml começam com < e terminam com />.
O formato básico de elementos é:
<nome_elemento [nome_atributo="valor"] [nome_atributo="valor"] … />_
Por exemplo:
<Display Level="none" CompletionNotice="no" />
Os elementos e atributos diferenciam maiúsculas de minúsculas. Os valores de atributo devem ser colocados entre aspas (") e não diferenciam maiúsculas de minúsculas.
Uma definição de elemento pode ocupar várias linhas. Caracteres de espaço, de retorno de carro, de alimentação de linha e de tabulação serão ignorados em uma definição de elemento.
Por exemplo:
<Display
Level="none"
CompletionNotice="no"
/>
Observação
Para definições de elemento longas, coloque atributos em linhas separadas e use o recuo para facilitar a leitura do arquivo.
O elemento Configuration é um caso especial e é necessário. Todos os outros elementos estão contidos no elemento Configuration e o elemento está contido em </Configuration>.
O exemplo a seguir mostra um arquivo de configuração para uma instalação limpa do pacote do 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>
Importante
Os arquivos de configuração padrão incluídos no Office SharePoint Server 2007 omitem a configuração SETUP_REBOOT. Você precisará incluí-la se quiser suprimir reinicializações durante uma instalação de linha de comando.
Os comentários podem ser adicionados em qualquer local e são delimitados por "<!--" e "-->".
Por exemplo:
<!-- 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>
Referência de elementos do Config.xml
As convenções a seguir são usadas nas descrições desta referência:
negrito |
Nome de elemento ou de atributo |
normal |
Texto a ser digitado exatamente como mostrado |
itálico |
Espaço reservado para um valor a ser adicionado |
x|y |
Escolha entre diversos valores |
[x] |
Valor opcional |
Elemento Configuration
Elemento de nível superior. Esse elemento é necessário e todos os outros elementos devem aparecer dentro dele.
Sintaxe
<Configuration>
<Package Id="ID">
...
</Package>
...
</Configuration>
Atributos
Atributo |
Valor |
Descrição |
Package ID |
Package ID |
O pacote está sendo instalado. |
Comentários
O atributo Package Id identifica o produto e as tecnologias afetadas por este arquivo Config.xml.
Exemplo
A Identificação do Pacote para o Office SharePoint Server 2007 é spswfe. Como o Office SharePoint Server 2007 se baseia na tecnologia de plataforma do Windows SharePoint Services 3.0, também será necessário instalar o pacote sts (Windows SharePoint Services 3.0) ou a sua instalação não obterá êxito.
Use as IDs de pacote sts e spswfe do Config.xml para especificar o Windows SharePoint Services 3.0 e o Office SharePoint Server 2007 digitando o seguinte:
<Configuration>
<Package Id="sts">
...
</Package>
...
<Package Id="spswfe">
...
</Package>
...
</Configuration>
Elemento ARP
Especifica valores que controlam o texto e o comportamento de Adicionar ou Remover Programas no Painel de Controle para o produto.
Sintaxe
<ARP atributo**="valor"** [atributo**="valor"**] ... />_
Atributos
Atributo |
Valor |
Descrição |
ARPCOMMENTS |
texto |
Texto adicional; pode conter até 255 caracteres, embora talvez nem todos sejam exibidos. |
ARPCONTACT |
texto |
Lista de contatos de suporte técnico. |
ARPNOMODIFY |
Yes |
Impede que usuários modifiquem a instalação do produto indisponibilizando o botão Alterar. |
No (padrão) |
Permite que o usuário modifique a instalação do produto. |
|
ARPNOREMOVE |
Yes |
Impede que usuários removam o produto indisponibilizando o botão Remover. |
No (padrão) |
Permite que usuários removam o produto. |
|
ARPURLINFOABOUT |
URL |
URL da home page do produto. |
ARPURLUPDATEINFO |
URL |
URL para informações sobre atualizações de produto. |
ARPHELPLINK |
URL |
URL de um site em que usuários poderão receber suporte técnico. |
ARPHELPTELEPHONE |
texto |
Números de telefone do suporte técnico. |
Elemento Command
Especifica uma linha de comando a ser executada. Os comandos do elemento Command são processados somente durante as instalações e desinstalações iniciais. Se forem usados para personalizações após a instalação inicial, serão ignorados.
Sintaxe
<Command
Path="caminho"
[QuietArg="argumentos"]
[Args="args"]
[ChainPosition="Before" | "After"(default)]
[Wait="mseconds"]
[QuietWait="mseconds"]
[Execute="Install"(padrão) | "Uninstall"]
[Platform="x86"(padrão) | "x64"]
/>
Atributos
Você pode especificar aspas (") nos atributos Path e Args ao especificar duas aspas juntas ("").
Atributo |
Valor |
Descrição |
Path |
caminho |
Caminho totalmente qualificado para o arquivo de pacote Microsoft® Windows Installer (MSI) executável. |
QuietArg |
cadeia de caracteres |
Cadeia de caracteres de argumentos a serem anexados à linha de comando quando Display Level=None. |
Args |
cadeia de caracteres |
Cadeia de caracteres de argumentos a serem passados ao executável. |
ChainPosition |
Before |
Esse comando é executado antes da instalação principal do produto. |
After (default) |
Esse comando é executado depois da instalação principal do produto. |
|
Wait |
mseconds |
Quando você instala com o atributo Display Level definido como "Full" ou "Basic", esse será o número de milissegundos a ser aguardado após a execução do programa e antes de você prosseguir com a instalação. O padrão é 0 (zero), que indica nenhuma espera. |
QuietWait |
mseconds |
Quando você instala com o atributo Display Level definido como "None", esse será o número de milissegundos a ser aguardado após a execução do programa e antes de você prosseguir com a instalação. O padrão é 0 (zero), que indica nenhuma espera. |
Execute |
Install (padrão) |
A Instalação executa esse comando quando o produto principal é instalado. |
Uninstall |
A Instalação executa esse comando quando o produto principal é desinstalado. |
|
Platform |
x86 (padrão) |
Especifica que esse programa exige a plataforma x86 da Intel. Esse comando só será executado se o computador na qual a instalação está sendo executada atender ao requisito de plataforma. |
x64 |
Especifica que esse programa exige um processador de 64 bits que dê suporte a extensões x64 para a arquitetura x86. Esse comando só será executado se o computador na qual a instalação está sendo executada atender ao requisito de plataforma. |
Comentários
A linha de comando pode ser especificada para uma instalação em cadeia ou para um executável disparado quando o produto for instalado. Se assim indicado, especifique uma linha de comando para Setup.exe em vez de um único arquivo MSI.
Se houver dois ou mais elementos Command no arquivo Config.xml, eles serão executados na ordem em que forem especificados no Config.xml.
Exemplo
<Command Path=”myscript.exe” Args=”/id ""123 abc"" /q”/>
<Command Path="\\<server>\<share>\setup.exe /config \\<server>\<share>\<folder>\config.xml"
Elemento DATADIR
O local a ser usado para armazenar os arquivos de dados, incluindo os arquivos de índice de pesquisa.
Sintaxe
<DATADIR Value="caminho"/>
Atributos
Atributo |
Valor |
Descrição |
Value |
caminho |
A Instalação armazena os arquivos de dados no local especificado. |
Comentários
Você pode usar as variáveis de ambiente do sistema no caminho. Se esse elemento não for especificado, os dados serão armazenados no seguinte caminho:
%PROGRAMFILES%\Microsoft Office Servers\12.0\Data
Exemplo
<DATADIR Value=”d:\data”/>
Elemento Display
O nível de interface do usuário que a Instalação exibe para o usuário.
Sintaxe
<Display
Level="None" | "Basic" | "Full"(padrão)
CompletionNotice="Yes"(padrão) | "No"
SuppressModal="Yes" | "No"(padrão)
NoCancel="Yes" | "No"(padrão)
AcceptEula="Yes" | "No"(padrão)
/>
Atributos
Atributo |
Valor |
Descrição |
Level |
Nenhum |
Nenhuma interface do usuário da Instalação será exibida. |
Basic |
A Instalação exibe a tela de boas-vindas, a página de Chave do Produto (PIDKEY) (se necessário), a página de Termos de Licença para Software Microsoft (se necessário), uma barra de andamento e o aviso de conclusão (se permitido). |
|
Full (padrão) |
A Instalação exibe todas as interfaces do usuário. |
|
CompletionNotice |
Yes |
Só se aplica se Level for definido como "Basic" ou "None": a Instalação exibirá o aviso de conclusão. |
No (default) |
Só se aplica se Level for definido como "Basic": a Instalação não exibirá o aviso de conclusão. |
|
SuppressModal |
Yes |
Só se aplica se Level for definido como "Basic": a Instalação não exibirá mensagens de erro e outras caixas de diálogo que possam interrompê-la. |
No (default) |
Só se aplica se Level for definido como "Basic": a Instalação exibirá erros e outras caixas de diálogo, se necessário. |
|
NoCancel |
Yes |
Se Level for definido como "Full" ou "Basic", desabilita o botão de cancelamento (X no canto superior direito da caixa de diálogo de andamento). |
No (padrão) |
Se Level for definido como "Full" ou "Basic", permite que o usuário cancele a instalação a partir da barra de andamento. |
|
AcceptEULA |
Yes |
Os Termos de Licença para Software Microsoft são aceitos em nome do usuário; a Instalação não exibirá a página Termos de Licença para Software Microsoft. |
No (padrão) |
Se Level não for definido como "None", a instalação exibirá a página Termos de Licença para Software Microsoft. |
Comentários
Se esse elemento não for definido, as configurações padrão serão usadas. Se um valor inválido for especificado, a Instalação será encerrada.
Se o atributo Level for definido como "Basic" ou "None" e se você fornecer uma chave do produto usando o elemento PIDKEY, a Instalação irá supor que você também aceita os termos de licença em nome do usuário. Nesse caso, a despeito da forma como você definir o atributo AcceptEULA, não será solicitado que o usuário aceite os termos de licença durante a instalação.
Dica
O elemento Display só será usado pela Instalação se ela localizar o arquivo Config.xml na mesma pasta do setup.exe ou se você especificar o arquivo Config.xml usando a opção de linha de comando /config da instalação.
Exemplo
<Display Level=”basic”
CompletionNotice=”yes”
SupressModal=”no”
AcceptEula=”yes”
/>
Elemento INSTALLLOCATION
Especifica o caminho totalmente qualificado para a pasta no computador do usuário na qual o produto está instalado.
Sintaxe
<INSTALLLOCATION Value="caminho" />
Atributos
Atributo |
Valor |
Descrição |
Value |
caminho |
O caminho totalmente qualificado para a pasta no computador do usuário na qual o produto está instalado. |
Comentários
Você pode usar as variáveis de ambiente do sistema no caminho. Se esse elemento não for especificado, o produto será instalado no seguinte caminho:
%PROGRAMFILES%\Microsoft Office Servers\12.0\
Observe que a tecnologia do Windows SharePoint Services 3.0 não é afetada por esse elemento; ela é instalada no seguinte caminho:
%PROGRAMFILES%\Common Files\Microsoft Shared\web server extensions\12
Exemplo
<INSTALLLOCATION VALUE=”%ProgramFiles%\MyApps” />
Elemento Logging
Especifica o tipo de log executado pela Instalação.
Sintaxe
<Logging
Type="Off" | "Standard"(padrão) | "Verbose"
Path="caminho"
Template="nomedoarquivo.txt"
/>
Atributos
Atributo |
Valor |
Descrição |
Type |
Off |
A Instalação não cria arquivos de log. |
Standard (padrão) |
A Instalação grava informações de instalação no arquivo de log. |
|
Verbose |
A Instalação grava todas as informações de instalação no arquivo de log. |
|
Path |
Path |
O caminho totalmente qualificado para a pasta usada para o arquivo de log. Você pode usar variáveis de ambiente. O padrão é %temp%. |
Template |
nomedoarquivo.txt |
O nome do arquivo de log. Se você inserir a cadeia de caracteres * em qualquer lugar do nome do arquivo, um arquivo de log exclusivo será criado para cada instalação executada por Setup.exe (consulte a explicação a seguir). Se o * não for incluído e se o nome do arquivo já existir, as informações de log serão anexadas ao arquivo existente. A extensão de arquivo .txt deverá ser incluída. O modelo padrão é SetupExe(*).log. |
Comentários
Você pode especificar um * em qualquer lugar do valor de Template. A Instalação insere uma cadeia de caracteres nesse local com o seguinte formato:
AAAAMMDDHHMMSSxxx
onde:
AAAA = Ano
MM = Mês
DD = Dia
HH = Hora
MM = Minutos
SS = Segundos
xxx = uma cadeia de caracteres exclusiva gerada pela Instalação
Dica
O elemento Logging só será usado pela Instalação se você especificar o arquivo Config.xml usando a opção de linha de comando /config da Instalação. Se você não especificar um arquivo Config.xml a ser usado, a Instalação usará as opções de log padrão.
Exemplo
<Logging Type=”standard” Path=”%temp%”
Template=”MyLog(*).txt”
/>
Neste exemplo, a Instalação cria um arquivo de log sempre que instala o produto. A Instalação usa nomes de arquivo exclusivos como os a seguir:
%temp%\MyLog(20060428110717CFC).txt
%temp%\MyLog(20060429113143C70).txt
Elemento Package
O pacote ou produto a ser instalado.
A Identificação do Pacote para o Office SharePoint Server 2007 é spswfe. Como o Office SharePoint Server 2007 se baseia na tecnologia de plataforma do Windows SharePoint Services 3.0, também será necessário instalar o pacote sts (Windows SharePoint Services 3.0) ou a sua instalação não obterá êxito.
Elemento PIDKEY
A chave de licença de volume de 25 caracteres.
Sintaxe
<PIDKEY Value="chave de 25 caracteres" />
Atributos
Atributo |
Valor |
Descrição |
Value |
chave de 25 caracteres |
A chave de licença de volume de 25 caracteres. |
Comentários
Quando o valor de PIDKEY for definido, os usuários não precisarão inserir uma chave do produto ao executarem a Instalação.
Exemplo
<PIDKEY Value="1234512345123451234512345" />
Dica
Se o atributo Level do elemento Displayfor definido como "Basic" ou "None" e se você fornecer uma chave do produto usando o elemento PIDKEY, a Instalação irá supor que você também aceita os termos de licença em nome do usuário. Nesse caso, a despeito da forma como o atributo AcceptEULA do elemento Display for definido, não será solicitado que o usuário aceite os termos de licença durante a instalação.
Elemento Setting
Permite que você especifique valores para propriedades do Windows Installer.
Sintaxe
<Setting Id="nome" Value="valor" />
Atributos
Atributo |
Valor |
Descrição |
Id |
nome |
O nome da propriedade do Windows Installer. |
Value |
valor |
O valor a ser atribuído à propriedade. |
Valores
As IDs de configuração a seguir são usadas em instalações de servidores:
ID |
Valores aceitos |
Descrição |
LAUNCHEDFROMSETUPSTS |
Yes | No |
Use como parte do atributo Package Id. O padrão é Yes. |
REBOOT |
ReallySuppress |
Especifica (para o Windows Installer) se será ou não permitida uma reinicialização após a conclusão da Instalação. Use ReallySuppress para especificar a ausência de reinicialização. Deve ser especificado em nível global e não por pacote. |
SETUP_REBOOT |
Never, AutoAlways, Always, AutoIfNeeded, IfNeeded |
Especifica (para Setup.exe) se será ou não permitida uma reinicialização após a conclusão da Instalação. Use Never para especificar a ausência de reinicialização. Deve ser especificado em nível global e não por pacote. |
SETUPTYPE |
CLEAN_INSTALL, V2V_GRADUAL_UPGRADE, V2V_INPLACE_UPGRADE, SKU2SKU_UPGRADE |
Especifica se uma nova cópia do produto ou tecnologia deve ou não ser instalada (CLEAN_INSTALL), se será instalada a nova versão lado a lado com a versão anterior para uma atualização gradual (V2V_GRADUAL_UPGRADE), se será instalada a nova versão e atualizar a anterior no local (V2V_INPLACE_UPGRADE) ou se será preciso atualizar um produto para outro (como do Windows SharePoint Services 3.0 para o Office SharePoint Server 2007. Deve ser especificado em nível global e não por pacote. |
SETUPCALLED |
0 | 1 |
Use como parte do atributo Package Id. |
OFFICESERVERPREMIUM |
0 | 1 |
Use como parte do atributo Package Id. Especifica a versão do Office SharePoint Server 2007 que você está instalando: Standard (0) ou Enterprise (1). Observe que o PIDKEY usado substitui essa configuração. |
SERVERROLE |
SINGLESERVER, WFE, APPLICATION |
Especifica o tipo de servidor onde está sendo feita a instalação: autônomo (SINGLESERVER), servidor Web front-end (WFE) ou de aplicativos (APPLICATION). |
USINGUIINSTALLMODE |
0 | 1 |
Especifica se você está executando uma instalação silenciosa (0) ou se está usando a interface do usuário para Instalação (1). |
Comentários
Nem todas as propriedades do Windows Installer podem ser especificadas no elemento Setting. Se uma propriedade bloqueada for especificada, a Instalação será encerrada. Se uma propriedade suportada for especificada, a Instalação a passará diretamente para o Windows Installer. Para obter uma lista completa de propriedades do Windows Installer, incluindo uma explicação sobre propriedades suportadas e bloqueadas, consulte Setup properties in the 2007 Office system.
Exemplo
<Setting Id="REBOOT" Value="ReallySuppress" />
Baixe este livro
Este tópico foi incluído no livro baixável a seguir para facilitar a leitura e a impressão:
Consulte a lista completa de livros disponíveis em Livros baixáveis para o Office SharePoint Server 2007.