Assistente de Pacote de Integração

Artigo
11/06/2024

O Assistente de Pacote de Integração (Assistente de IP) permite que você crie um novo Pacote de Integração a partir de um assembly de Integração existente. Os assemblies de integração podem ser criados usando o Assistente de Atividade de Linha de Comando (CLIActivityWizard) ou usando o SDK do Orchestrator. O Assistente de IP (IPWizard) empacota os assemblies, arquivos dependentes e metadados necessários em um .OIP arquivo que pode ser implantado por meio do Orchestrator Deployment Manager. Você pode criar Pacotes de Integração com aparência profissional com identidade visual completa e ícones personalizados, ou simplesmente empacotar atividades de linha de comando para que possam ser implantadas com mais facilidade usando o Assistente de IP.

Decidir quando criar um pacote de integração

É importante decidir se é apropriado usar atividades individualmente com as atividades do Pacote de Integração do .NET do Kit de Ferramentas ou se é melhor criar e implantar todas as atividades em um Pacote de Integração.

Quando você tem apenas algumas atividades ou quando está na fase de desenvolvimento e criando muitas alterações em uma atividade, basta usar os assemblies com as atividades do Pacote de Integração do .NET do Kit de Ferramentas para executar essas atividades em Runbooks. O empacotamento, o registro, a implantação, a desinstalação e a atualização de Pacotes de Integração incorrem em grande sobrecarga no processo de desenvolvimento.

Se você tiver um grupo de atividades para testar ou estiver mais avançado no ciclo de desenvolvimento e quiser testar todo o processo de instalação ou atualização de ponta a ponta, criar um Pacote de Integração é a melhor abordagem. O Pacote de Integração oferece uma experiência mais amigável e uma experiência de instalação completa. Os Pacotes de Integração também permitem a implantação das atividades em vários Runbook Servers ou Runbook Designers em toda a organização ou para clientes externos.

Criar um novo pacote de integração

O Assistente de Pacote de Integração permite que você crie Pacotes de Integração a partir dos assemblies compatíveis com o Orchestrator existentes e dos arquivos dependentes. Se ainda não tiver criado uma montagem compatível com o Orchestrator, consulte o Assistente de atividade de linha de comandos.

Observação

O Kit de Ferramentas de Integração não inclui mais os binários do Conjunto de Ferramentas XML (WiX) do Windows Installer, que é usado pelo Assistente de IP para criar Pacotes de Integração personalizados. Instale a versão mais recente (v3.11) do WiX Toolset antes de usar o IP Wizard.

Para criar um novo pacote de integração, siga estas etapas:

Inicie o Assistente de Pacote de Integração. Selecione Assistente para Iniciar > Pacote de Integração do Orchestrator. A página de boas-vindas é exibida.
Se você tiver um Pacote de Integração existente que deseja atualizar, selecione Importar Pacote de Integração. Para obter mais informações, consulte Atualizando um pacote de integração existente. Para criar um novo Pacote de Integração, selecione Avançar.

Importante

Se você quiser atualizar um IP existente, deverá selecionar Importar Pacote de Integração. Se você selecionar Avançar, o IP criado terá uma nova ID de produto exclusiva e novas IDs exclusivas para todas as atividades, mesmo que você reutilize um assembly anterior e use o mesmo produto e nomes de arquivo.

Na página Detalhes do Produto, insira ou modifique as informações conforme necessário para personalizar as informações sobre seu Pacote de Integração. A tabela abaixo descreve os campos e suas descrições:

Nome do campo	Descrição
Nome do produto	O nome do IP exibido no Deployment Manager
Nome da categoria	O texto que é exibido como o título da categoria para o IP no painel Atividades do Runbook Designer
Empresa	O nome da sua empresa. Essas informações são exibidas em Adicionar/Remover Programas em "Editor"
EULA	Um arquivo de texto formatado em RTF com uma `.EULA` extensão. O EULA é exibido para o usuário durante o registro usando o Deployment Manager e requer aceitação antes do registro.
Arquivo de recurso	Um assembly que contém ícones e outros recursos usados para fornecer os ícones de categoria e atividade. Por padrão, o arquivo de recurso padrão do Toolkit é usado (Microsoft.SystemCenter.Orchestrator.Integration.Toolkit.Wizard.Images.dll)
Versão	O número da versão do Pacote de Integração, que será exibido no Gerenciador de Implantação e usado para determinar se o IP é uma atualização.
Habilitar atualização	Se você importou um Pacote de Integração existente, essa caixa de seleção será marcada por padrão, permitindo que este Pacote de Integração atualize uma versão instalada existente. Se você desmarcar essa caixa de seleção, novas IDs de produto e atividade serão criadas para o IP (ele não atualizará uma versão existente). Se você quiser habilitar a instalação lado a lado de várias versões do seu IP, desmarque essa caixa de seleção.
Descrição	Uma descrição detalhada do seu Pacote de Integração
Ícone de categoria	O ícone de categoria padrão é exibido. Se você quiser escolher outro ícone, selecione o botão Modificar e selecione um novo ícone e, em seguida, selecione OK.

Quando terminar de inserir as informações do produto, selecione Avançar. A página Atividades é exibida. A página Atividades é onde você fará referência ao assembly ou assemblies que contêm as atividades que você definiu usando o Assistente de Atividade de Linha de Comando ou criou usando o SDK do Orchestrator.
Para adicionar uma nova atividade ao IP, selecione Adicionar.
Para abrir e adicionar o arquivo de assembly, selecione o botão de reticências (...) à direita de Biblioteca. Navegue até o arquivo de assembly desejado, selecione-o e selecione Abrir. O nome e o caminho do arquivo são exibidos no campo Biblioteca.
Para selecionar uma atividade no assembly, selecione a seta suspensa Classe e selecione o nome da atividade apropriada na lista. O nome e a descrição definidos na atividade são mostrados nos campos Nome de exibição e Descrição.
Se desejar, modifique o nome de exibição e a descrição da atividade.
O ícone de atividade padrão é exibido para a atividade. Se desejar um ícone diferente, selecione Modificar, selecione outro ícone no navegador e selecione OK.
Selecione OK para salvar a definição da atividade. O nome e a descrição da atividade agora aparecem na lista Atividades.
Continue adicionando atividades à lista conforme necessário. Quando terminar de adicionar atividades, selecione Avançar. A página Dependências e arquivos incluídos é exibida.
Nessa página, você pode definir uma lista de arquivos extras que deseja empacotar com o Pacote de Integração. Esses arquivos podem ser assemblies extras exigidos por suas atividades, scripts, documentação ou outros arquivos que você deseja implantar em Runbook Servers e Runbook Designers junto com suas atividades. Selecione Adicionar, selecione os arquivos necessários e, em seguida, selecione OK para adicionar arquivos à lista.
Quando terminar de adicionar arquivos à lista, selecione Avançar. A página Arquivo do Pacote de Integração do Orchestrator é exibida.
Na caixa de texto fornecida, insira o caminho e o nome do arquivo do Pacote de Integração a ser criado. Se você inserir um nome de arquivo que já existe, ele será substituído. Verifique se você tem acesso suficiente para gravar no caminho especificado ou o processo falhará. Se nenhum caminho for especificado, o arquivo OIP será criado na pasta Documentos (C:\users\<your username>\Documents). Selecione Avançar para iniciar a criação do IP.

Importante

Os caracteres no nome do arquivo devem ser válidos para o idioma instalado em seu sistema operacional.

Importante

Especifique um nome para o Pacote de Integração que não seja comum para garantir que ele não corresponda ao nome de outro Pacote de Integração. O Orchestrator não pode instalar dois Pacotes de Integração com o mesmo nome.
Quando o IP tiver sido criado com êxito, a página final do assistente exibirá o caminho e o nome do novo arquivo OIP. Selecione Concluir para sair do assistente. Se houver um erro, você poderá selecionar Voltar e repetir o processo de build.

Para obter informações sobre como implantar seu Pacote de Integração, consulte o artigo Como adicionar um Pacote de Integração.

Atualizar um pacote de integração existente

O Assistente do Pacote de Integração do Orchestrator permite importar um Pacote de Integração existente para que você possa fazer alterações e reempacotá-lo como uma nova versão. Certifique-se de marcar a caixa de seleção Ativar atualização , caso contrário, um novo IP será criado em vez de substituir ou atualizar a versão instalada anterior.

Dicas úteis de atualização de IP

Atualizar assemblies subjacentes

Quando você cria um Pacote de Integração, os metadados sobre o IP são armazenados no pacote para que possam ser lidos pelo assistente durante as atualizações subsequentes. Ao atualizar determinados itens, como atividades ou assemblies subjacentes para essas atividades, você precisa recompilar o IP. No entanto, se você modificar as configurações da atividade e selecionar um novo arquivo de montagem, ele redefinirá os campos na página Informações da atividade, exigindo que você insira as informações novamente.

Você pode manter as configurações de IP enquanto modifica apenas a montagem. Salve o novo assembly no mesmo caminho e nome de arquivo do assembly anterior (que é mostrado no campo Biblioteca da caixa de diálogo Informações da atividade).

Migração do pacote de integração QIK

Se você criou um Pacote de Integração usando o Assistente Opalis QIK, precisará convertê-lo para ser compatível com o Orchestrator antes que ele possa ser importado e usado pelo Orchestrator.

Antes de converter um IP, as seguintes etapas devem ser concluídas:

Se as atividades em seu IP foram criadas usando o Assistente da CLI do QIK, você deve seguir as etapas descritas em Migração de atividades da CLI do QIK para torná-las compatíveis com o Orchestrator. Se você não tiver uma cópia separada do assembly que contém as atividades, precisará instalar o IP em um servidor Opalis 6.3 primeiro e, em seguida, localizar o assembly no seguinte diretório: C:\Program Files (x86)\Common Files\Opalis Software\Opalis Integration Server\Extensions\Support\Quick Integration Kit 3.
Se as atividades em seu IP foram desenvolvidas de forma personalizada em C# usando a API do Opalis, você deve seguir as etapas descritas em Migrando atividades personalizadas da API QIK para torná-las compatíveis com o Orchestrator.

Observação

As atividades baseadas em Java que usam a API do Opalis para Java não são mais suportadas pelo Integration Toolkit ou pelo Orchestrator.
Se o seu IP contiver arquivos dependentes ou outros arquivos incluídos, esses arquivos deverão estar disponíveis para reempacotamento no novo IP. Se você não tiver uma cópia separada desses arquivos, precisará instalar o IP em um servidor Opalis 6.3 primeiro e, em seguida, localizar os arquivos no seguinte diretório: C:\Program Files (x86)\Common Files\Opalis Software\Opalis Integration Server\Extensions\Support\Bin.
Se o IP contiver um arquivo de recurso personalizado usado para ícones de atividade e categoria, esse arquivo deverá estar disponível para o novo IP. Se você não tiver uma cópia separada desse arquivo, precisará instalar o IP em um servidor Opalis 6.3 primeiro e, em seguida, localizar o arquivo no seguinte diretório: C:\Program Files (x86)\Common Files\Opalis Software\Opalis Integration Server\Extensions.
Se o seu IP usou os ícones padrão fornecidos pelo QIK para os ícones de categoria ou atividade e você deseja continuar usando esses ícones em vez de usar os novos ícones fornecidos no Orchestrator, você precisará obter o Opalis.QIK.Wizard.Images.dll arquivo e usá-lo como faria com um arquivo de recurso personalizado. Se você não tiver uma cópia separada desse arquivo, precisará instalar o IP em um servidor Opalis 6.3 primeiro e, em seguida, localizar o arquivo no seguinte diretório: C:\Program Files (x86)\Common Files\Opalis Software\Opalis Integration Server\Extensions.

Observação

Para facilitar o processo de conversão, você deve colocar todos esses arquivos nos locais em que estavam quando o IP foi originalmente empacotado antes de iniciar o Assistente de IP. O Assistente de IP faz referência a esses arquivos por seus caminhos originais. A seleção de um novo caminho é possível para todos os arquivos, mas a seleção de um novo caminho para assemblies que contêm as atividades resultará na redefinição de alguns dos detalhes da atividade, exigindo que você insira as informações novamente. Ao usar os caminhos originais para os arquivos, as informações existentes são simplesmente reutilizadas sem a necessidade de digitá-las novamente.

Converter um pacote de integração compatível com Opalis

Iniciar o Assistente de Pacote de Integração
Selecione o Pacote de Integração de Importação.
Selecione o arquivo OIP existente e selecione Abrir.
Você verá uma mensagem de aviso indicando que o IP não é compatível com o Orchestrator. Selecione OK.
Modifique os detalhes do produto conforme necessário para refletir quaisquer alterações. O número da versão do IP é incrementado automaticamente e a caixa de seleção "Atualizar" é marcada. Selecione Avançar.
Na página Atividades, percorra cada atividade e verifique se as informações foram preenchidas corretamente. Se o assembly da atividade não tiver sido migrado ou não estiver no mesmo local em que estava quando o IP foi criado, o campo Classe estará vazio. Para evitar a necessidade de redigitar qualquer informação, você deve substituir o assembly antes de iniciar o assistente.
Quando terminar de editar as atividades, selecione Avançar.
Certifique-se de que os arquivos dependentes ainda estejam no mesmo local mostrado ou remova-os e adicione novos arquivos dependentes. Selecione Avançar.
Insira um caminho e um nome de arquivo para o novo arquivo IP. Não use o mesmo nome do IP anterior para garantir que você mantenha uma cópia do IP anterior. Selecione Avançar para criar o IP.

Agora você tem um IP compatível com o Orchestrator e pode ser registrado e implantado usando o Orchestrator Deployment Manager.

Pacotes de integração – Problemas conhecidos

Limitação de comprimento do nome do arquivo

Ao incluir assemblies em seu Pacote de Integração, eles são adicionados automaticamente ao registro pelo instalador. Devido à limitação no comprimento do nome da chave do Registro, o caminho combinado e o nome de arquivo de um assembly não podem exceder 234 caracteres. Dado o caminho padrão em que os assemblies dentro de um IP são colocados, o comprimento máximo do nome de arquivo de um arquivo de assembly incluído não pode exceder 80 caracteres. Se um assembly com um nome de arquivo superior a 80 caracteres for incluído na instalação, a instalação falhará.

Recursos do Orchestrator

Além dessa referência online fornecida para o System Center Orchestrator, há muitos recursos que podem fornecer informações adicionais sobre a criação de runbooks, o uso do Kit de Ferramentas de Integração e as práticas recomendadas.

Compartilhar via