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 as definições de configuração de e para as tabelas do sistema.

Quando Usar o ConfigTool

É possível usar o configTool quando desejar fazer o seguinte:

Para importar partições e modelos de origem de dados fornecidos com o Campaign que, em seguida, poderão ser modificados e duplicados usando a página Configuração.

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

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

Excluir as categorias que não possuem o link Excluir Categoria. Para isso, use o configTool para exportar a configuração e, em seguida, exclua manualmente o XML que cria a categoria e use 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 do 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 as configurações existentes usando o configTool e faça o backup do arquivo resultante para que haja uma maneira de restaurar a configuração, caso haja algum erro ao usar o configTool para importação.

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]

Exclua as propriedades de configuração e suas definições, especificando um caminho na hierarquia de propriedade de configuração.

O caminho do elemento deve usar os nomes internos das categorias e propriedades. É possível obtê-los acessando a página Configuração, selecionando a categoria ou a propriedade desejada e consultando 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.

Observe o seguinte.

Somente categorias e propriedades em 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 as categorias que não possuem o link Excluir Categoria na página Configuração, use a opção -o.

Quando -d for usado com o comando -vp, o configTool excluirá 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]

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

Para importar, especifique um caminho para o elemento-pai no qual deseja importar suas categorias. O utilitário configTool importa as propriedades na categoria especificada no caminho.

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

O caminho do elemento-pai deve usar nomes internos de categorias e propriedades. É possível obtê-los acessando a página Configuração, selecionando a categoria ou a propriedade necessária e consultando 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 importação relativo ao diretório tools/bin ou é possível especificar um caminho de diretório completo. Se 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 sobrescrição.

-x -p "elementPath" -f exportFile

Exporte as propriedades de configuração e suas definições em um arquivo XML com um nome especificado.

É possível exportar todas as propriedades de configuração ou limitar a exportação para uma categoria específica ao especificar um caminho na hierarquia de propriedade de 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 consultando 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 atual ou é possível 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 gravará o arquivo para o diretório tools/bin na instalação do Marketing Platform. Se uma extensão xml não for fornecida, o configTool a incluirá.

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

Esse comando é usado, principalmente, em atualizações manuais, para importar propriedades de configuração. Se você aplicar um fix pack contendo uma nova propriedade de configuração e, em seguida, fizer upgrade, a importação de um arquivo de configuração como parte do processo de upgrade manual poderá substituir os valores que foram configurados quando o fix pack foi aplicado. O comando -vp assegura que a importação não substitua os valores de configuração definidos anteriormente.

Após usar o utilitário configTool com a opção -vp, você deverá reiniciar o servidor de aplicativos da web no qual o Marketing Platform está implementado para que as mudanças sejam aplicadas.

Quando -d for usado com o comando -vp, o configTool excluirá 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 sobrescrição. O parâmetro productName deve ser um dos nomes listados acima.

Observe o seguinte.

Quando o comando -r for usado, o arquivo de registro deverá ter <application> como a primeira tag no XML.

Outros arquivos podem ser fornecidos com o produto, que podem ser usados para inserir as propriedades de configuração no banco de dados Marketing Platform. Para esses arquivos, use o comando -i. Somente o arquivo que tiver 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, use o utilitário populateDb ou execute o instalador do Marketing Platform novamente, da maneira descrita no IBM® Marketing Platform Installation Guide.

Após a instalação inicial, para registrar novamente produtos que não sejam o Marketing Platform, use o configTool com o comando -r e -o para substituir 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 reconhecidos pelo configTool não foram alterados. Os nomes de produto válidos para uso com o configTool são listados abaixo, junto com nomes atuais dos produtos.

Nomes de Produto para Registro e Cancelamento de Registro do configTool
Nome do produto	Nome usado no configTool
Marketing Platform	Manager
Campaign	Campaign
Distributed Marketing	Collaborate
eMessage	emessage
Interact	interact
Contact Optimization	Optimize
Marketing Operations	Plan
CustomerInsight	Insight
Digital Analytics for On Premises	NetInsight
Opportunity Detection	Detectar
Leads	Leads
Interaction History	InteractionHistory
Attribution Modeler	AttributionModeler
IBM® SPSS® Modeler Advantage Enterprise Marketing Management Edition	SPSS
Digital Analytics	Coremetrics

-u productName

Cancelar registro especificado pelo productName. Não é necessário incluir um caminho para a categoria do produto, o nome do produto é suficiente e é necessário. O processo remove todas as definições de propriedade e configuração para o produto.

Opções

-o

Ao ser usado com -i ou -r, ele substitui uma categoria ou um registro de produto existente (nó).

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

Exemplos

Importe definições de configuração a partir de um arquivo chamado Product_config.xml no diretório conf na instalação do Marketing Platform.

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

Importe um dos modelos de origens de dados do Campaign fornecidos na partição padrão do Campaign, a partition1. O exemplo assume o modelo de origem de dados Oracle, OracleTemplate.xml, foi colocado no diretório tools/bin na instalação do Marketing Platform.

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

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

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

Exporte uma partição existente do Campaign (completa com entradas de origem de dados), salve-a em um arquivo denominado partitionTemplate.xml e armazene-o no diretório padrão tools/bin na instalação do Marketing Platform.

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

Registre manualmente um aplicativo chamado productName, usando um arquivo chamado app_config.xml no diretório padrão tools/bin na instalação do Marketing Platform e force-o a substituir um registro existente desse aplicativo.

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

Cancele o registro de um aplicativo chamado productName.

configTool -u productName