O utilitário configTool

As propriedades e os valores na página Configuração são armazenados nas tabelas do sistema. É possível usar o utilitário configTool para importar e exportar definições de configuração das e para as tabelas de sistema.

Quando utilizar configTool

Você pode desejar usar o configTool pelas razões a seguir.

Importar partição e modelos de origem de dados fornecidos com o Campaign, que podem então ser modificados e duplicados utilizando a página Configuração.

Registrar (importar propriedades de configuração para) produtos IBM® EMM, se o instalador do produto não puder incluir as propriedades no banco de dados automaticamente.

Exportar uma versão XML das definições de configuração para backup ou importar em uma instalação diferente de IBM® EMM.

Excluir categorias que não possuam o link Excluir Categoria. Isso é feito utilizando o configTool para exportar sua configuração e, em seguida, excluindo-se manualmente o XML que cria a categoria, e usando o configTool para importar o XML editado.

Esse utilitário modifica as tabelas usm_configuration e usm_configuration_values no banco de dados de tabelas do sistema Marketing Platform, que contêm as propriedades de configuração e seus valores. Para obter melhores resultados, crie cópias de backup dessas tabelas ou exporte suas configurações existentes usando o configTool e fazendo backup do arquivo resultante para ter uma forma de restaurar sua configuração se cometer um erro ao usar o configTool para importar.

Sintaxe

configTool -d -p "elementPath" [-o]

configTool -i -p "parent ElementPath" -f importFile [-o]

configTool -x -p "elementPath" -f exportFile

configTool -vp -p "elementPath" -f importFile [-d]

configTool -r productName -f registrationFile [-o] configTool -u productName

Comandos

-d -p "elementPath" [o]

Exclui propriedades de configuração e suas definições, especificando um caminho na hierarquia de propriedades da configuração.

O caminho do elemento deve usar os nomes internos de categorias e propriedades. É possível obtê-los indo até a página Configuração, selecionando a categoria desejada e procurando no caminho exibido entre parênteses na área de janela à direita. Delimite um caminho na hierarquia da propriedade de configuração usando o caractere |, e coloque o caminho entre aspas duplas.

Observe o seguinte.

Apenas categorias e propriedades dentro de um aplicativo podem ser excluídas usando este comando, não aplicativos inteiros. Utilize o comando -u para cancelar o registro de um aplicativo inteiro.

Para excluir categorias que não tenham o link Excluir Categoria na página Configuração, utilize a opção -o.

Ao utilizar -d com o comando -vp, o configTool exclui todos os nós-filhos no caminho especificado se esses nós não estiverem incluídos no arquivo XML especificado.

-i -p "parentElementPath" -f importFile [o]

Importa propriedades de configuração e suas definições a partir de um arquivo XML especificado.

Para importar, é possível especificar um caminho até o elemento-pai sob o qual deseja importar suas categorias. O utilitário configTool importa propriedades sob a categoria que você especifica no caminho.

É possível incluir categorias em qualquer nível abaixo do nível superior, mas não é possível incluir categorias no mesmo nível que a categoria superior.

O caminho do elemento-pai deve utilizar os nomes internos de categorias e propriedades. É possível obtê-los indo até a página Configuração, selecionando a categoria ou propriedade desejada e procurando no caminho exibido entre parênteses na área de janela à direita. Delimite um caminho na hierarquia da propriedade de configuração usando o caractere |, e coloque o caminho entre aspas duplas.

É possível especificar um local de arquivo de importação relativo ao diretório tools/bin ou especificar um caminho de diretório completo. Se você especificar um caminho relativo ou nenhum caminho, o configTool primeiro consultará o arquivo relativo ao diretório tools/bin.

Por padrão, esse comando não sobrescreve uma categoria existente, mas é possível usar a opção -o para forçar uma sobrescrita.

-x -p "elementPath" -f exportFile

Exporta propriedades de configuração e suas configurações para um arquivo XML com um nome especificado.

É possível exportar todas as propriedades de configuração ou limitar a exportação a uma categoria específica especificando um caminho na hierarquia de propriedades da configuração.

O caminho do elemento deve usar os nomes internos de categorias e propriedades, que podem ser obtidos acessando a página Configuração, selecionando a categoria ou propriedade desejada e procurando o caminho exibido entre parênteses na área de janela à direita. Delimite um caminho na hierarquia da propriedade de configuração usando o caractere |, e coloque o caminho entre aspas duplas.

É possível especificar um local do arquivo de exportação relativo ao diretório ou especificar um caminho de diretório completo. Se a especificação de arquivo não contiver um separador (/ no UNIX™, / ou \ no Windows™), o configTool grava o arquivo no diretório tools/bin sob sua instalação do Marketing Platform. Se você não fornecer a extensão xml, o configTool a incluirá.

-vp -p "elementPath" -f importFile [-d]

Este comando é utilizado principalmente em upgrades manuais para importar as propriedades de configuração. Se você tiver aplicado um fix pack que contenha uma nova propriedade de configuração e, em seguida, fizer upgrade, a importação de um arquivo de configuração como parte de um processo de upgrade manual poderá substituir valores que foram definidos quando o fix pack foi aplicado. O comando -vp assegura que a importação não substitua valores de configuração anteriormente configurados.

Depois de utilizar o utilitário configTool com a opção -vp, você deve reiniciar o servidor de aplicativos da web no qual o Marketing Platform está implementado para que as alterações sejam aplicadas.

Ao utilizar -d com o comando -vp, o configTool exclui todos os nós-filhos no caminho especificado se esses nós não estiverem incluídos no arquivo XML especificado.

-r productName -f registrationFile

Registre o aplicativo. O local do arquivo de registro pode ser relativo ao diretório tools/bin ou pode ser um caminho completo. Por padrão, esse comando não sobrescreve uma configuração existente, mas é possível usar a opção -o para forçar uma sobrescrita. O parâmetro productName deve ser um dos nomes que são listados acima.

Observe o seguinte.

Ao usar o comando -r, o arquivo de registro deve ter <application> como a primeira tag no XML.

Outros arquivos podem ser fornecidos com seu produto, que podem ser usados para inserir propriedades de configuração no banco de dados do Marketing Platform. Para esses arquivos, use o comando -i. Apenas o arquivo que possuir a tag <application> como a primeira tag poderá ser usado com o comando -r.

O arquivo de registro para o Marketing Platform é denominado Manager_config.xml e a primeira tag é <Suite>. Para registrar esse arquivo em uma nova instalação, utilize o utilitário populateDb ou execute novamente o instalador do Marketing Platform, conforme descrito no IBM® Marketing Platform Installation Guide.

Após a instalação inicial, para registrar novamente produtos diferentes do Marketing Platform, utilize configTool com o comando -r e -o para sobrescrever as propriedades existentes.

O utilitário configTool usa nomes de produto como parâmetros com os comandos que registram e cancelam o registro dos produtos. Com a liberação 8.5.0 do IBM® EMM, muitos nomes de produtos foram alterados. No entanto, os nomes que são reconhecidos pelo configTool não foram alterados. Os nomes de produto válidos para uso com o configTool são listados abaixo, junto com os nomes atuais dos produtos.

Nomes de produtos para registro e remoção de registro do configTool
Nome do produto	Nome usado no configTool
Marketing Platform	Gerenciador
Campaign	Campanha
Distributed Marketing	Colaborar
eMessage	emessage
Interact	interagir
Contact Optimization	Otimizar
Marketing Operations	Plano
CustomerInsight	Insight
Digital Analytics for On Premises	NetInsight
Opportunity Detection	Detectar
Leads	Oportunidades
Interaction History	InteractionHistory
Attribution Modeler	AttributionModeler
IBM® SPSS® Modeler Advantage Enterprise Marketing Management Edition	SPSS
Digital Analytics	Coremetrics

-u productName

Cancela o registro de um aplicativo especificado pelo productName. Você não precisa incluir um caminho para a categoria do produto; o nome do produto é o suficiente, e é necessário. O processo remove todas as propriedades e definições de configuração do produto.

Opções

-o

Quando utilizado com -i ou -r, ele sobrescreve uma categoria existente ou registro de produto (nó).

Quando utilizado com -d, é possível excluir uma categoria (nó) que não possua o link Excluir Categoria na página Configuração.

Exemplos

Importa definições de configuração de um arquivo denominado Product_config.xml no diretório conf sob a instalação do Marketing Platform.

configTool -i -p "Affinium" -f Product_config.xml

Importa um dos modelos de origem de dados fornecidos pelo Campaign para a partição padrão do Campaign, partition1. O exemplo assume que você colocou o modelo de origem de dados Oracle, OracleTemplate.xml, no diretório tools/bin sob a instalação do Marketing Platform.

configTool -i -p "Affinium|Campaign|partitions|partition1|dataSources" -f OracleTemplate.xml

Exporta todas as definições de configuração para um arquivo denominado myConfig.xml no diretório D:\backups.

configTool -x -f D:\backups\myConfig.xml

Exporta uma partição existente do Campaign (completa com entradas da origem de dados), a salva em um arquivo chamado partitionTemplate.xml e a armazena no diretório tools/bin padrão sob a instalação do Marketing Platform.

configTool -x -p "Affinium|Campaign|partitions|partition1" -f partitionTemplate.xml

Registra manualmente um aplicativo denominado productName usando um arquivo chamado app_config.xml no diretório padrão tools/bin sob a instalação do Marketing Platform, e o força a sobrescrever um registro existente desse aplicativo.

configTool -r product Name -f app_config.xml -o

Cancela o registro de um aplicativo denominado productName.

configTool -u productName