configTool

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

Quando Usar o configTool

Você poderá desejar usar o configTool pelos seguintes motivos.

Para importar dados da partição e modelos de origem de dados fornecidos com o Campaign, que podem ser modificados e duplicados usando a página Configuração.

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

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

Para excluir as categorias que não têm o link Excluir Categoria. Você faz isso usando configTool para exportar a configuração, em seguida, excluindo manualmente o XML que cria a categoria e usando configTool para importar o XML editado.

Este 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 suas configurações existentes usando configTool e faça backup do arquivo resultante para que tenha uma forma de restaurar sua configuração se fizer um 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 propriedades 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 propriedade desejada e observando o caminho exibido entre parênteses na área de janela à direita. Delimite um caminho na hierarquia de 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. Use o comando -u para cancelar o registro de um aplicativo inteiro.

Para excluir categorias que não têm o link Excluir Categoria na página Configuração, use a opção -o.

Ao usar -d com o comando -vp, o configTool excluirá os nós filhos no caminho que especificar se esses nós não forem incluídos no arquivo XML que especificar.

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

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

Para importar, você especifica um caminho para o elemento-pai, sob o qual deseja importar as categorias. O utilitário configTool importa propriedades sob a categoria que especificar 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 da categoria superior.

O caminho do elemento-pai deve usar os nomes internos de categorias e propriedades. É possível obtê-los acessando a página Configuração, selecionando a categoria ou propriedade necessária e observando a página exibida entre parênteses na área de janela à direita. Delimite um caminho na hierarquia de 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 completo de diretório. Se especificar um caminho relativo ou não especificar nenhum caminho, o configTool olha primeiro para o arquivo relativo ao diretório tools/bin.

Por padrão, este 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 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 determinando um caminho na hierarquia de propriedades 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 observando o caminho exibido entre parênteses na área de janela à direita. Delimite um caminho na hierarquia de propriedade de configuração usando o caractere | e coloque o caminho entre aspas duplas.

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

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

Este comando é usado principalmente em upgrades manuais para importar as propriedades de configuração. Se tiver aplicado um fix pack que contém uma nova propriedade de configuração e fizer upgrade, importar um arquivo de configuração como parte de um processo manual de upgrade pode substituir 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 configurados anteriormente.

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

Ao usar -d com o comando -vp, o configTool excluirá os nós filhos no caminho que especificar se esses nós não forem incluídos no arquivo XML que especificar.

-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, este 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.

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

Podem ser fornecidos outros arquivos com seu produto que possa usar para inserir propriedades de configuração no banco de dados do Marketing Platform. Para esses arquivos, use o comando -i. Somente o arquivo que possui a tag <application> como a primeira tag pode 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 este arquivo em uma nova instalação, use o utilitário populateDb ou execute novamente o instalador do Marketing Platform conforme descrito no IBM® Marketing Platform Guia de Instalação.

Após a instalação inicial, para cancelar o registro dos produtos que não o Marketing Platform, use configTool com o comando -r e -o para substituir as propriedades existentes.

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

Nomes de Produtos para Registro e Remoção de Registro de 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	Detect
Leads	Leads
Interaction History	InteractionHistory
Attribution Modeler	AttributionModeler
IBM® SPSS® Modeler Advantage Enterprise Marketing Management Edition	SPSS
Digital Analytics	Coremetrics

-u productName

Cancele o registro de um aplicativo especificado pelo productName. Não é necessário incluir um caminho na categoria do produto; o nome do produto é suficiente e é necessário. O processo remove todas as propriedades e definições de configuração para o produto.

Opções

-o

Quando usado com -i ou -r, substitui um registro existente de categoria ou produto (nó).

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

Exemplos

Importe definições de configuração 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

Exportar uma partição existente do Campaign (completa com entradas de origem de dados), salvá-la em um arquivo denominado partitionTemplate.xml e armazená-la no diretório tools/bin padrão sob a 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 deste aplicativo.

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

Cancelar registro de um aplicativo denominado productName.

configTool -u productName