Citizen Integrator Gerar Ou Editar Receita¶

Introdução¶

Citizen Integrator, acessível através do Harmony Portal, é o aplicativo da Web de clicar e executar do 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.

Dentro do Citizen Integrator, você pode carregar um Design Studio para gerar uma receita do Citizen Integrator e, em seguida, configurar as etapas da receita na página Gerar receita. Para receitas existentes, a página Edit Recipe também disponibiliza essas etapas para edição.

Acessando a Página Gerar Receita¶

A opção de gerar uma receita de Citizen Integrator está disponível no Citizen Integrator - Minhas Receitas página. Após a geração da receita, você será direcionado para a página Gerar receita para configurar ainda mais as etapas da receita.

Na página Minhas receitas, na seção Minhas receitas, a opção de gerar uma receita está disponível apenas para usuários com permissões de administrador 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 deseja carregar.

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

Acessando a Página Editar Receita¶

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 de editar uma receita ficará disponível assim que você selecionar apenas uma receita na tabela e estará disponível apenas para usuários com permissões de administrador dentro da organização selecionada.

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

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

Gerando Ou Editando 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 com o 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 qualquer variável de projeto à receita para a qual você deseja que os usuários possam definir valores ao usar a receita. Para 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 do projeto do arquivo Jitterpak são exibidas. Se nenhuma variável de projeto for incluída no Jitterpak, nenhuma será exibida.
• Editar receita: ao editar uma receita, são exibidas as variáveis de projeto existentes dos metadados JSON da receita ou da receita gerada anteriormente.

Para remover uma variável de projeto da receita, clique no ícone da 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 Restore Variable.

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 de projeto existente não é editável.

• Nome de Exibição: Este campo pode ser usado se você deseja 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 do 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 é 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 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 Testar conexão ou Executar operação possam ser usadas.

Etapas da Receita¶

A próxima seção é usada para definir 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 Introdução e Revisão são adicionadas por padrão.
• Editar receita: ao editar uma receita, são exibidas as etapas existentes dos metadados JSON da receita ou da receita gerada anteriormente.

Para remover uma etapa da receita, clique no ícone da lixeira ao lado do nome da etapa à esquerda. As etapas 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 da etapa selecionada estão disponíveis para serem configurados. Os campos a seguir são comuns para todos os tipos de etapa:

• Nome da etapa: insira um nome para a etapa a ser exibida na receita (por exemplo, Introdução ou Autenticação do Salesforce).
• Tipo: Selecione um dos seguintes tipos de etapa:
  • Descrição: Usado para fornecer informações sobre a receita e/ou seus componentes.
  • Etapa de Configuração: Usado 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 a ser exibida na receita.

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

• Descrição: Este tipo de etapa é utilizado 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 etapa: 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 na etapa (por exemplo, testar a conexão usando as 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).
    • Etapa Ação: Use o menu suspenso para selecionar uma ação. Todos os endpoints existentes do arquivo Jitterpak serão listados no menu suspenso.

    Depois de selecionar uma ação, uma etapa de ação será adicionada automaticamente na 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 no tipo de etapa gerada automaticamente abaixo.

• Executar operação: Este tipo de etapa é usado para executar uma operação a partir 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 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 é utilizado quando há necessidade de externalizar operações como APIs. Os campos devem conter as informações necessárias para a API. Consulte API Manager Para maiores informações.

• Etapa gerada automaticamente: esse 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.

  • Operação de Execução: Consulte a etapa Operação de Execução acima para obter informações sobre os campos configuráveis.

  • Conexões de teste: 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 de projeto: Marque a caixa de seleção e use o menu suspenso para selecionar uma variável de projeto para usar que você configurou na seção anterior.

Pós-configuração¶

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

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

  

• Save to File: 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 a receita (na página Editar receita página).