Gerar receitas e editar páginas de receitas no Jitterbit Citizen Integrator

Introdução

Citizen Integrator, acessível através do portal Harmony, é o aplicativo web click-and-run da Jitterbit para usuários não técnicos personalizarem e implantar rapidamente as integrações do Design Studio usando receitas pré-criadas do Citizen Integrator.

No Citizen Integrator, você pode fazer upload de um Design Studio projeto para gerar uma receita do Citizen Integrator e então configurar as etapas da receita na página Gerar Receita. Para receitas existentes, a página Editar Receita também disponibiliza essas etapas para edição.

Nota

As receitas do Citizen Integrator podem ser geradas ou importadas para o Design Studio somente. Para Integration Studio, em vez disso use Receitas de integração do Integration Studio ou Modelos de processo do Integration Studio, acessado através do Jitterbit Marketplace.

Aviso

Somente usuários que são membros de uma papel com permissão Admin dentro da organização selecionada podem gerar e editar receitas do Citizen Integrator dentro da organização.

Acesse a página de geração de receitas

A opção de gerar uma receita do Citizen Integrator está disponível em Citizen Integrator - Minhas receitas. Após a geração da receita, você será levado para a página Gerar Receita para configurar melhor as etapas da sua receita.

Na página Minhas Receitas, na seção Minhas Receitas, a opção para gerar uma receita está disponível apenas para usuários com permissões de Admin na organização selecionada.

Clique no ícone JPK para abrir uma janela onde você pode carregar um Design Studio Jitterpak que irá gerar uma receita.

Na janela Gerar Receita, use o botão Escolher Arquivo para navegar até o Jitterpak (.JPK) que você gostaria de carregar.

Em seguida, clique em Enviar para gerar sua nova receita e abrir a página Gerar Receita, onde você pode configurar ainda mais as etapas da sua receita (consulte Gerar ou editar etapas da receita abaixo).

Acesse a página de edição de receitas

A opção de editar uma receita do Citizen Integrator está disponível em Citizen Integrator - Minhas receitas página.

Na página Minhas Receitas, na seção Minhas Receitas, a opção para editar uma receita ficará disponível quando você selecionar apenas uma receita na tabela, e estará disponível apenas para usuários com permissões de Admin na organização selecionada.

Para selecionar uma receita, clique em qualquer lugar na linha ou marque a caixa à esquerda da receita.

Então clique no ícone de edição para abrir a página Editar receita onde você pode atualizar as etapas da sua receita (consulte Gerar ou editar etapas da receita abaixo).

Gerar ou editar etapas da receita

Depois de acessar as páginas Gerar Receita ou Editar Receita conforme descrito acima, você pode configurar as etapas da receita por meio da interface de usuário do Citizen Integrator da seguinte maneira.

Nome e descrição da receita

Na primeira seção, insira o nome básico e a descrição da sua receita.

• Nome da receita: Forneça ou modifique o nome da sua receita.
• Descrição da receita: Forneça ou modifique a descrição da sua receita.

Variáveis do projeto de receita

A próxima seção é usada para adicionar quaisquer variáveis de projeto à receita para as quais você deseja que os usuários possam definir valores ao usar a receita. Para obter mais informações, consulte Variáveis.

Remover ou restaurar variáveis do projeto

No lado esquerdo, todas as variáveis de projeto existentes serão listadas.

• Gerar receita: Ao gerar uma receita, todas as variáveis de projeto do arquivo Jitterpak são exibidas. Se nenhuma variável de projeto estiver incluída no Jitterpak, nenhuma será exibida.
• Editar receita: Ao editar uma receita, as variáveis de projeto existentes dos metadados JSON da receita ou da receita gerada anteriormente são exibidas.

Para remover uma variável de projeto da receita, clique no ícone de lixeira ao lado do nome da variável do projeto à esquerda.

Para restaurar uma variável de projeto que você removeu anteriormente, use o menu suspenso no canto superior direito para selecionar uma variável removida anteriormente e clique no botão Restaurar variável.

Dica

Você não pode adicionar novas variáveis de projeto que ainda não existam no Jitterpak para a receita. Se quiser adicionar uma nova variável de projeto, você deve primeiro criá-la no Jitterpak no Design Studio.

Configurar variáveis do projeto

No lado direito, os campos da variável selecionada estão disponíveis para serem configurados.

• Nome: O nome da variável do seu projeto existente não é editável.

• Nome de exibição: Este campo pode ser usado se você quiser que um nome diferente seja exibido na interface do Citizen Integrator.

• Descrição: Este campo pode ser usado para inserir texto abaixo do campo, por exemplo, para fornecer instruções sobre o que os usuários devem inserir.

• Valor: Este campo pode ser usado se você quiser atribuir um valor padrão à sua variável de projeto. Isso pode ser usado para fornecer um valor padrão com outros valores opcionais para a variável de projeto. Por exemplo, um valor padrão de "Produção" com outras opções para "Desenvolvimento" ou "QA". Essas opções são fornecidas no campo Tipo.

• Reg Expression: Este campo pode ser usado para fornecer uma expressão regular (string) que o valor da variável do projeto deve corresponder quando a receita for configurada antes que as ações Test Connection ou Run Operation possam ser usadas. Por exemplo: ".+@.+[.].+".

• Tipo: Este campo pode ser usado para definir o tipo de valor que o usuário pode fornecer. Use o menu suspenso para selecionar entre texto, senha, caixa de seleção, menu suspenso ou área de texto. Para caixa de seleção e menu suspenso, opções adicionais ficam disponíveis para configuração. Insira um Rótulo e um Valor para cada seleção ou use o ícone da lixeira para remover uma linha.

  

• Campo obrigatório: Se esta caixa estiver marcada, o campo da variável do projeto deverá ser preenchido quando a receita for configurada antes que as ações Test Connection ou Run Operation possam ser usadas.

Passos da receita

A próxima seção é usada para configurar as etapas que os usuários precisarão seguir para configurar a receita do Citizen Integrator.

Adicionar ou remover etapas

No lado esquerdo, todas as etapas de receita existentes serão listadas.

• Gerar receita: Ao gerar uma receita, as etapas de introdução e revisão são adicionadas por padrão.
• Editar receita: Ao editar uma receita, as etapas existentes dos metadados JSON da receita ou da receita gerada anteriormente são exibidas.

Para remover uma etapa da receita, clique no ícone da lixeira ao lado do nome da etapa à esquerda. As etapas de Introdução e Revisão, bem como quaisquer etapas geradas automaticamente, não podem ser removidas.

Para adicionar uma nova etapa, clique no botão Adicionar Nova Etapa no canto superior direito. Uma nova etapa será criada antes da etapa de Revisão.

Configurar etapas

No lado direito, os campos para o passo selecionado estão disponíveis para serem configurados. Os seguintes campos são comuns para todos os tipos de passo:

• Nome da etapa: Insira um nome para a etapa que aparecerá na receita (por exemplo, Introdução ou Autenticação do Salesforce).
• Tipo: Selecione um dos seguintes tipos de etapas:
  • Descrição: Usado para fornecer informações sobre a receita e/ou seus componentes.
  • Configuração de etapas: Usada para definir uma ou mais variáveis de projeto para verificar a conectividade de um endpoint específico.
  • Executar operação: Usado para executar uma operação antes que a receita seja implantada.
  • API Binding: Usado quando há necessidade de externalizar operações como APIs.
• Descrição: Insira uma descrição da etapa que aparecerá na receita.

Cada tipo de etapa e quaisquer campos que ficam disponíveis quando a etapa é selecionada são abordados em detalhes abaixo.

Nota

Informações adicionais e documentação sobre todas as partes possíveis do arquivo de metadados JSON são fornecidas em Criando novas receitas.

• Descrição: Este tipo de etapa é usado para fornecer informações sobre a receita e/ou seus componentes.
  • Detalhes: Insira aqui qualquer HTML que você gostaria de renderizar nesta etapa.

• Configuração de etapas: Esse tipo de etapa geralmente é usado para testar uma conexão de endpoint.

  • Obrigatório: Marque esta caixa se quiser exigir que esta etapa seja concluída antes de implantar a receita (por exemplo, para testar ou validar se uma conexão de endpoint foi bem-sucedida).
  • Variáveis do projeto: Use o menu suspenso para adicionar variáveis do projeto à etapa ou use o ícone da lixeira para removê-las. As variáveis do projeto são configuradas na seção anterior.

  • Ação: Marque esta caixa se quiser incluir uma ação dentro da etapa (por exemplo, testar a conexão usando credenciais fornecidas). Quando marcada, os seguintes campos adicionais ficam disponíveis:

    • Nome do botão: Insira um nome para aparecer no botão de ação (por exemplo, Testar conexão).
    • Ação de Etapa: Use o menu suspenso para selecionar uma ação. Todos os endpoints existentes do arquivo Jitterpak serão listados no menu suspenso.

    Após selecionar uma ação, uma etapa de ação será automaticamente adicionada sob a etapa atual. Você precisará clicar na etapa gerada automaticamente na lista de etapas à esquerda para configurar os detalhes da etapa. Mais informações são fornecidas sob o tipo de etapa gerada automaticamente abaixo.

• Executar operação: Este tipo de etapa é usado para executar uma operação do arquivo Jitterpak.

  • Obrigatório: Marque esta caixa se quiser exigir que esta etapa seja concluída antes de implantar a receita.
  • Caminho da operação: Todas as operações existentes do arquivo Jitterpak serão listadas aqui. Selecione a operação que você deseja executar nesta parada.
  • Descrição da operação: Insira uma descrição sobre a operação selecionada para fornecer informações na receita sobre o que a operação faz.
• API Binding: Este tipo de etapa é usado quando há necessidade de externalizar operações como APIs. Os campos devem conter as informações necessárias para a API. Veja API Manager para mais informações.

• Etapa gerada automaticamente: Este tipo de etapa é criado automaticamente quando você escolhe o tipo Configuração de etapa e marca a caixa de seleção Ação com uma Ação de etapa selecionada.

  • Executar operação: Consulte a etapa Executar operação acima para obter informações sobre campos configuráveis.

  • Testar conexões: Todas as variáveis necessárias são mostradas com base na ação selecionada. Você pode codificar um valor padrão ou usar variáveis de projeto configuradas na seção anterior.

    

    • Valor padrão: Digite um valor padrão na caixa de texto para codificar o valor da variável. Os usuários não poderão alterar esse valor ao implantar uma receita.
    • Variável do projeto: Marque a caixa de seleção e use o menu suspenso para selecionar uma variável do projeto para usar que você configurou na seção anterior.

Pós-configuração

Depois de configurar sua receita gerada ou editada do Citizen Integrator conforme descrito acima, use os botões na parte inferior da página quando estiver pronto.

• Visualizar: Use este botão para ver uma prévia do arquivo JSON gerado para ser usado em sua receita.

  

• Salvar em arquivo: Use este botão para baixar o arquivo JSON gerado.

• Cancelar: Use este botão para fechar a página sem salvar as alterações.

• Carregar / Atualizar: Esses botões validarão a receita e a carregarão na organização selecionada (na página Gerar receita) ou atualizarão a receita (na página Editar receita).