Compartilhar via

Referência do Config.xml (Windows SharePoint Services)

  • Artigo

Atualizado em: 2008-09-18

Quando você deseja controlar o modo como o Windows SharePoint Services 3.0 é instalado, use o arquivo Config.xml junto com Setup.exe. Por exemplo, use o arquivo config.xml para:

  • Executar uma instalação silenciosa do Windows SharePoint Services 3.0.

  • Instalar o Windows SharePoint Services 3.0 usando uma configuração comum entre vários servidores.

  • Executar uma instalação automatizada ou com script do Windows SharePoint Services 3.0.

Neste artigo:

  • Personalizando o Config.xml

  • Referência rápida de elementos do Config.xml

  • Como funciona

  • Formato de arquivo do 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 esses elementos. Em seguida, execute setup.exe /config [path and file name] para especificar que o Setup.exe execute e use 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 genérico, 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 ser usado na configuração de uma instalação limpa. Você precisa executar o psconfig.exe após executar a Instalação para concluir a configuração do servidor ou do farm de servidores.

  • SetupFarmSilent   Contém um arquivo config.xml a ser usado na configuração de um farm de servidores no modo silencioso.

  • SetupGradualUpgradeSilent   Contém um arquivo config.xml para ser usado na atualização gradativa de um farm de servidores existente.

  • SetupSilent   Contém um arquivo config.xml para ser usado na configuração de uma instalação limpa para um único servidor (autônomo, com o Banco de Dados Interno do Windows) em modo silencioso.

  • SetupUpgradeSilent   Contém um arquivo config.xml para ser usado na atualização gradativa de um farm de servidores existente.

Importante

Os arquivos de configuração padrão fornecidos com o Windows SharePoint Services 3.0 omitem a configuração SETUP_REBOOT. Inclua essa configuração se você quiser suprimir as 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 abordagem de atualização [Windows SharePoint Services].

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.

Logging

Opções para o tipo de log executado pela Instalação.

DATADIR

O local a ser usado para armazenar arquivos de dados.

Package

O pacote ou produto a ser instalado.

Setting

Valores para as propriedades do Windows Installer.

Como funciona

A Instalação procura uma cópia de Config.xml na mesma pasta que Setup.exe. Se nenhuma cópia for encontrada nessa pasta, a Instalação usará o arquivo Config.xml que reside na pasta principal \Files folder do produto que você está instalando.

Também é possível usar a opção de linha de comando de Instalação /config para especificar o local do arquivo Config.xml. Por exemplo:

\\<server>\<share>\setup.exe /config \\<server>\<share>\<folder>\config.xml

Formato de arquivo do Config.xml

Os elementos XML no arquivo Config.xml começam com < e terminam com />.

O formato básico de elementos é:

<nome_do_elemento [nome_do_atributo="valor"] [nome_do_atributo="valor"] … />

Por exemplo:

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

Os elementos e os atributos diferenciam maiúsculas e minúsculas. Os valores de atributos devem ser codificados entre aspas (") e não diferenciam maiúsculas e minúsculas.

Uma definição de elemento pode abranger várias linhas. Espaços, retornos de carro, alimentações de linha e caracteres de tabulação são ignorados na definição de um 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 ele é fechado com </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 fornecidos com o Windows SharePoint Services 3.0 omitem a configuração SETUP_REBOOT. Inclua essa configuração se você quiser suprimir as 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

Elemento ou nome do atributo

normal

Texto a ser inserido exatamente como mostrado

itálico

Espaço reservado para um valor a ser adicionado

x|y

Escolha entre vários valores

[x]

Valor opcional

Elemento Configuration

Elemento de nível superior. Esse elemento é necessário e todos os outros devem aparecer dentro dele.

Sintaxe

<Configuration>

<Id do Pacote="ID">

...

</Package>

...

</Configuration>

Atributos

Atributo

Valor

Descrição

Package ID

ID do Pacote

O pacote que está sendo instalado.

Comentários

O atributo Package Id identifica o produto e as tecnologias afetadas por este arquivo Config.xml.

Exemplo

A ID do Pacote do Windows SharePoint Services 3.0 é sts. Use a ID do Pacote sts no Config.xml para especificar o Windows SharePoint Services 3.0 digitando:

<Configuration>
   <Package Id="sts">
   ...
   </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 ter até 255 caracteres, embora nem todos eles sejam exibidos.

ARPCONTACT

texto

Lista de contatos de suporte técnico.

ARPNOMODIFY

Yes

Impede que os usuários modifiquem a instalação do produto tornando o botão Alterar indisponível.

No (padrão)

Permite que o usuário modifique a instalação do produto.

ARPNOREMOVE

Yes

Impede que os usuários removam o produto tornando o botão Remover indisponível.

No (padrão)

Permite que os usuários removam o produto.

ARPURLINFOABOUT

URL

URL da home page do produto.

ARPURLUPDATEINFO

URL

URL para informações sobre atualizações do produto.

ARPHELPLINK

URL

URL de um site do qual os usuários podem receber suporte técnico.

ARPHELPTELEPHONE

texto

Números de telefone de 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="argumentos"]

[ChainPosition="Before" | "After"(default)]

[Wait="milissegundos"]

[QuietWait="milissegundos"]

[Execute="Install"(padrão) | "Uninstall"]

[Platform="x86"(default) | "x64"]

/>

Atributos

Você pode especificar aspas (") nos atributos Path e Args ao especificar duas aspas juntas ("").

Atributo

Valor

Descrição

Path

caminho

O caminho totalmente qualificado para o arquivo de pacote executável Microsoft® Windows Installer (MSI).

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 argumentos a serem passados ao executável.

ChainPosition

Before

Esse comando é executado antes da instalação do produto principal.

After (default)

Esse comando é executado após a instalação do produto principal.

Wait

milissegundos

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

milissegundos

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 este comando quando o produto principal é instalado.

Uninstall

A Instalação executa este 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 foram especificados no arquivo 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 de sistema no caminho. Se esse elemento não for especificado, os dados serão armazenados no seguinte caminho:

%Arquivos de Programas%\Microsoft SQL Server\MSSQL$SHAREPOINT\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

None

Nenhuma interface do usuário da Instalação será exibida.

Basic

A Instalação exibe a tela de boas-vindas, a página de Termos de Licença para Software Microsoft (se necessária), 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 (padrão)

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 (padrão)

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 de Software Microsoft são aceitos em nome do usuário; a Instalação não exibe a página Termos de Licença de 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.

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 Logging

Especifica o tipo de log executado pela Instalação.

Sintaxe

<Logging

Type="Off" | "Standard"(padrão) | "Verbose"

Path="caminho"

Template="nome_de_arquivo.txt"

/>

Atributos

Atributo

Valor

Descrição

Type

Off

A Instalação não cria nenhum log.

Standard (padrão)

A Instalação grava informações 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

nome_de_arquivo.txt

O nome do arquivo de log. Se você inserir a cadeia de caracteres * em qualquer lugar do nome de arquivo, um arquivo de log exclusivo será criado para cada instalação realizada por Setup.exe (veja a explicação abaixo). Se * não for incluído e o nome de arquivo especificado 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 no valor Template. A Instalação insere uma cadeia de caracteres nesse local com o seguinte formato:

AAAAMMDDHHMMSSxxx

em que:

  1. AAAA = Ano

  2. MM = Mês

  3. DD = Dia

  4. HH = Hora

  5. MM = Minutos

  6. SS = Segundos

  7. 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”
/>

Com esse exemplo, a Instalação cria um arquivo de log cada vez que instala o produto. A Instalação usa nomes de arquivo exclusivos, como os seguintes:

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

Elemento Package

O pacote ou produto a ser instalado.

A ID do Pacote do Windows SharePoint Services 3.0 é sts.

Elemento Setting

Permite especificar valores para as 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

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

Especifica se será instalada uma nova cópia do produto ou tecnologia (CLEAN_INSTALL), instalada a nova versão paralelamente à versão anterior para permitir uma atualização gradativa (V2V_GRADUAL_UPGRADE) ou instalada a nova versão e atualizada a versão anterior (V2V_INPLACE_UPGRADE). Deve ser especificado em nível global, e não por pacote.

SETUPCALLED

0 | 1

Use como parte do atributo Package Id.

SERVERROLE

SINGLESERVER, WFE

Especifica o tipo de servidor no qual está sendo feita a instalação: autônomo (SINGLESERVER) ou Web front-end (WFE).

USINGUIINSTALLMODE

0 | 1

Especifica se você está executando uma instalação silenciosa (0) ou usando a interface de usuário para Instalação (1).

Comentários

Nem todas as propriedades do Windows Installer podem ser especificadas no elemento Setting. Se for especificada uma propriedade bloqueada, a Instalação encerrará o processo de instalação. Se for especificada uma propriedade suportada, a Instalação repassará a propriedade diretamente para o Windows Installer.

Exemplo

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

Baixar este manual

Este tópico está incluído no seguinte manual que você pode baixar para facilitar a leitura e a impressão:

Consulte a lista completa de manuais disponíveis na seção sobre os manuais para Windows SharePoint Services que podem ser baixados (em inglês).