Notificações no Jitterbit App Builder

Introdução

Notificações são mensagens enviadas aos usuários logados do aplicativo quando algo acontece. Elas podem ser enviadas pelos seguintes métodos:

• Email

• SMS (usando o serviço Twilio)

• Alerta do App Builder (um pop-up no aplicativo que aparece quando o usuário está conectado a um aplicativo)

Notificações do sistema são tipos de notificação enviadas por administradores de sistema para usuários selecionados quando algo acontece, geralmente um evento que afeta vários usuários.

Desde o App Builder 4.44, você pode selecionar IDE > Manutenção (Beta) e selecione a aba Notificações para visualizar e gerenciar notificações.

Notificações

Uma mensagem de notificação pode ter várias opções que definem como o usuário pode responder.

Para emails e alertas do App Builder, URLs são incluídas na mensagem que vinculam de volta ao App Builder.

Para SMS, os usuários podem responder com o nome da opção para executar o evento associado.

Os links de notificação ficam ativos por 7 dias, após os quais expiram e não ficam mais ativos. (Este prazo de validade não pode ser alterado.)

Quando opções estão presentes em uma Notificação, a resposta do Usuário é rastreada automaticamente pelo App Builder.

As notificações podem incluir anexos de vários tipos de arquivo (por exemplo, .PDF, .DOCX, .TXT, .XLSX, etc.). Se você estiver usando anexos de arquivo, a notificação usará o data/pdf diretório se nenhum outro diretório for especificado. Alternativamente, se você especificar um FileDataSourceId, este será o local onde o App Builder procurará o(s) anexo(s).

Para usar os objetos de dados públicos necessários para Notificação, seu aplicativo requer que o App Builder (Sealed) esteja configurado como uma Fonte de Dados disponível para o aplicativo. Além de ser uma Fonte de Dados disponível para o aplicativo, você precisa estabelecer ou configurar um link entre as Fontes de Dados.

O App Builder usará as informações de URL especificadas na Regra de Notificação, se estiverem disponíveis. Caso não sejam encontradas, o App Builder retornará e usará a URL padrão do Site do Servidor. O valor padrão do Site do Servidor é configurado em IDE > Provedores de Segurança > Mais (no painel Configuração) > Sites. Para obter mais informações sobre sites e URL, consulte Sites e aliases artigo.

Opções

As notificações podem ter 0 ou mais opções. Quando não há opções, nenhuma resposta do usuário é esperada. Nesse caso, a resposta do usuário não é rastreada e nenhum link é adicionado à mensagem enviada. Esta é considerada uma notificação Informativa.

Quando uma Notificação contém uma ou mais opções, uma mensagem é enviada com links de URL de volta ao App Builder, permitindo que o Usuário responda de alguma forma. A resposta do Usuário à mensagem (ou seja, qual opção ele selecionou) é rastreada pela notificação.

Configuração

As opções de notificação podem ser configuradas de duas maneiras:

1. Link para a página: Um link é fornecido para permitir que o usuário navegue até uma página. A navegação bem-sucedida até a página considera uma resposta completa à opção.

2. Executar evento de página: Um link é fornecido para enviar o usuário para uma página e executar um evento específico antes que a página seja renderizada. A resposta do usuário é considerada concluída assim que o evento é acionado.

Para que uma página seja elegível para qualquer uma dessas opções, ela deve ser marcada como Compartilhada.

Exemplo

Um administrador pode executar um evento que faz com que um email seja enviado a um usuário. O email contém um texto e os três botões a seguir:

1. Avaliação: Ao clicar, o usuário é levado para uma página específica.

2. Aprovar: Quando clicado, o usuário é levado para uma página diferente e executa um evento em alguns objetos de dados na página.

3. Rejeitar: Quando clicado, o usuário é levado para uma página diferente e executa um evento na mesma página ou em objetos de dados de uma página diferente.

O evento deve ser executado antes da renderização da página, pois pode afetar os dados contidos nos painéis da página. Para executar um evento, o desenvolvedor do aplicativo deve fazer o seguinte:

• Configure a página Link para como Compartilhada.

• Inclua o evento no Objeto de Dados da página ou como uma das fontes de dados do painel de linha única na página. (Mais ilustrações deste ponto estão disponíveis na seção Vinculação de Eventos de Objeto de Dados abaixo.)

Associação de eventos de objetos de dados

O App Builder limita os eventos que podem ser vinculados a um link. Essa limitação permite apenas eventos que pertencem a um Objeto de Dados ou Tabela vinculados a um painel de linha única não vinculado na página de destino. Por exemplo, considere uma página com 6 painéis de linha única:

• Customer→ CustomerAddress→ CustomerMap
• Employee→ EmployeeAddress→ EmployeeMap

Neste exemplo, Customer e Employee Os painéis não estão vinculados a nenhum outro painel na página. Portanto, um desenvolvedor pode escolher eventos dessas duas fontes de dados de painéis (junto com um objeto de dados de página, se houver).

O App Builder também limita os eventos que podem ser vinculados a eventos não relacionados ao sistema. Por exemplo, o desenvolvedor não pode vincular de volta aos eventos Salvar, Inserir, Atualizar ou Excluir.

Registro de notificação

Vinculando a uma notificação

A página Registro de Notificação no App Builder permite que o desenvolvedor vincule uma Notificação a um aplicativo. Essa relação é de 1 para 1. Informações adicionais sobre a mensagem de notificação podem ser configuradas no registro da notificação.

Criação de mensagens

A mensagem de notificação pode ser definida na seção Modelo da página Registro de Notificação. Este é o conteúdo principal da notificação em si.

As substituições são realizadas no Modelo e usam o {{nome do campo}}sintaxe. As substituições podem adicionar um opcional url sinalizador para indicar que o valor é uma URL e requer codificação de URL, por exemplo {{nome do campo|url}}.

Para substituição, o corpo pode conter:

Hello {{NomeDoCliente}},

Neste exemplo, CustomerName deve estar contido nas colunas da regra de notificação junto com os outros campos obrigatórios.

Para emails, um Assunto pode ser especificado na página de Registro de Notificação. O campo Assunto também suporta substituições.

Traduções

As notificações suportam traduções rudimentares. Há três campos usados para traduções:

1. Opção de notificação Nome.

2. Registro de notificação Mensagem.

3. Assunto do registro de notificação para Emails.

Ao criar a mensagem de notificação, o App Builder tentará encontrar traduções para cada um desses campos, supondo que seu conteúdo especifique a chave de tradução correspondente. O desenvolvedor também precisa adicionar as chaves ao pacote de tradução do aplicativo manualmente (atualmente, elas não são importadas automaticamente para um aplicativo). Tome cuidado com o campo Modelo para adicionar a chave de tradução como uma string bruta e não como HTML. Há um ícone de "código" no canto inferior direito do campo Modelo de Registro de Notificação que permite editar a string diretamente.

Limitações

1. O evento executado no link de opção pertence aos Dados da Página ou a um Objeto de Dados de Painel de Linha Única. Atualmente, não exibimos nenhum resultado de validação nem publicamos mensagens para eventos em nível de página. Em outras palavras, o evento é executado primeiro e, ao ser concluído, o usuário é redirecionado para sua página. Ao acessar a página, os resultados do evento são perdidos. Portanto, se o evento tiver uma mensagem de publicação ou falhar na validação, o sistema não exibirá esses resultados ao usuário final. O desenvolvedor pode contornar isso facilmente exibindo dados em seus painéis que mudam com base na execução bem-sucedida de um evento.

   Devido à limitação acima, os avisos de validação farão com que um evento não seja executado. Não temos uma interface de usuário que permita ao usuário aceitar ou rejeitar o aviso.

2. A tabela Arquivo de uma fonte de dados do Amazon S3 não pode ser obtida por uma regra de notificação.

Objetos de dados públicos de notificação

Os objetos de dados públicos usados como alvos de Notificação são definidos abaixo.

Colunas comuns

Estas colunas são comuns aos objetos de dados públicos de Notificação:

| Nome | Obrigatório | Multi-alvo | Exemplo | Descrição | |-----------|--------------|------------|------------------------------------------------------------------------------------------------------------------------------------------| | Vinculação() | Não | Sim | ID do Cliente | Se fornecido, identificará o registro correspondente à opção para esta notificação. Várias vinculações podem ser definidas. |

Email

O objeto de dados públicos Email é semelhante, mas não totalmente consistente, com a funcionalidade do plugin de Email SMTP. As colunas para o objeto de dados públicos Email são as seguintes:

Mensagem de texto

O objeto de dados públicos Mensagem de Texto é usado para enviar SMS. As colunas para o objeto de dados públicos Mensagem de Texto são as seguintes:

Alerta do App Builder

O objeto de dados públicos de notificação Alerta do App Builder é semelhante, mas não totalmente consistente, ao objeto de dados públicos Create_Notification. As colunas do objeto de dados públicos Alerta do App Builder são as seguintes:

Notificação push

O objeto de dados públicos Notificação Push permite que a notificação envie uma notificação push a um Usuário. As colunas do objeto de dados públicos Notificação Push são as seguintes:

Configuração de notificação

Exemplo de configuração de notificação

Estas são as etapas necessárias para configurar uma notificação. (Este exemplo mostra como adicionar uma Notificação de Aprovação do Cliente à página Clientes da Northwinds.)

1. Criar notificação: Crie uma regra que tenha como alvo um objeto de dados públicos de notificação:

   1. Navegue até o App Workbench.
   2. Clique em Notificações.
   3. Clique em + Notificação.
   4. Atribua um Nome. Por exemplo CustomersRequestApprovalAlert.
   5. Confirme que o objetivo é Notificação.
   6. Selecione Alerta do App Builder como Destino. Caso não veja este objeto de dados disponível, crie uma conexão de Fonte de Dados com o App Builder (Selado) para o aplicativo em que você está trabalhando.
   7. Clique em Salvar.

2. Defina a notificação mvSQL:

   1. Clique no botão +Tabelas.
   2. Adicione sua tabela 'selecionar de'. Por exemplo Customers.

   3. Adicione as seguintes colunas e clique na aba Colunas para definir:

      Coluna	Alias	Alvo
      todos	Para	Para
      "C".CustomerId	CustomerId	Vinculação()
      "C".NomeDoCliente	NomeDoCliente

      Nota

      Observe que adicionamos CustomerName para que possamos usá-lo posteriormente como parâmetro de substituição em nossa mensagem de Notificação.

3. Defina as opções de notificação:

   1. Navegue até o App Workbench.
   2. Clique em Notificações
   3. Selecione a Regra de Negócios de Notificação. Por exemplo: CustomerRequestApprovalAlert.

   4. Insira as informações da Mensagem para a Notificação no campo Corpo

      Por exemplo: Avalie o seguinte cliente:

      Cliente: {{NomeDoCliente}}

   5. Clique no ícone de lápis e insira qualquer Ajuda Técnica para ajudar a explicar a Notificação para outros desenvolvedores.

4. (Opcional) Defina uma página de aterrissagem e um evento de pré-lançamento para serem executados:

   1. Na página App Workbench > Notificações, selecione a Notificação.
   2. Clique no botão + Opção.
   3. Crie uma nova opção:
      1. Defina Índice como 10.
      2. Defina Nome como Revisar.
      3. Selecione o valor Link para a Página. No nosso exemplo, criaremos um link para a página "Cliente" da Northwinds. Se a página para a qual você deseja criar o link não aparecer, certifique-se de que ela tenha sido marcada como "Compartilhada" nas Configurações do Edge Case.
   4. Clique na marca de seleção para salvar o registro.

5. Registrar notificação com um evento: Registre a notificação como uma ação com um evento. Neste caso, estamos assumindo que o evento está associado a um botão na página de inicialização. Também assumiremos que o evento se chama "Solicitar Aprovação".

   1. Navegue até o Evento para o Objeto de Dados.
   2. Clique no ícone Lógica de negócios.
   3. Clique no botão Eventos.
   4. Selecione o Evento. Por exemplo: Request Approval.
   5. Clique em Registrar Existente no painel Ações.
   6. Selecione Notificação como Tipo de Ação.
   7. Selecione a Notificação que criamos na etapa anterior. Por exemplo: CustomerRequestApprovalAlert.
   8. Clique em Salvar.
   9. Verifique se as Vinculações Explícitas estão corretas. Por exemplo: CustomerId - CustomerId.

6. Teste: Neste ponto, a Notificação está completamente configurada. Navegue até a sua página e clique no botão que executa o evento de notificação. Todos os usuários do App Builder no sistema deverão ver um pop-up com a mensagem de notificação.

Exemplo de configuração de notificação por SMS

Estas são as etapas necessárias para configurar uma notificação por SMS. (Este exemplo mostra como adicionar uma Notificação de Aprovação do Cliente à página de Clientes da Northwinds.)

1. Configurar a segurança do App Builder

   1. Navegue até IDE > Provedores de segurança.
   2. Clique em + Autenticação do usuário no painel Autenticação do usuário.
      1. Insira um Nome (por exemplo Http Basic Auth).
      2. Selecione Autenticação básica HTTP como o Tipo.
      3. Clique em Ativado para habilitar.
      4. Clique em Salvar.
   3. Navegue até IDE > Gerenciamento de usuários.
      1. Clique duas vezes no registro do usuário que você deseja autenticar quando receber uma resposta por SMS.
      2. Observe que este usuário deve ter acesso ao seguinte:
         • Aplicativo App Builder.
         • O evento que será executado na própria notificação.
   4. Clique no ícone Chaves em Autenticação.
   5. Clique em Criar.
   6. Selecione o provedor Http Basic Auth criado anteriormente.
   7. Clique em Salvar.

   Nota

   A "Chave" secreta criada para este provedor. A combinação do Nome de Usuário e da Chave secreta será usada na configuração do Twilio.

2. Configurar o Twilio:

   1. Crie um serviço de mensagens:

      1. Faça login na sua conta Twilio.
      2. Navegue até Nuvem de comunicações > SMS programável.
      3. Clique em Serviços de mensagens.
      4. Crie um novo serviço de mensagens (notificações, bidirecional) e anexe um número de telefone Twilio a ele.
      5. Anote o MessagingServiceSid. Ele será usado para configuração posterior.
      6. Habilite a opção "Processar mensagem de entrada".
      7. Insira o seguinte URL de solicitação:
         • https://:@/webhook/v1/vinyl/bridge_inbound
         • Por exemplo : https://admin:P124asfgOmkA@vinyl.zudy.com/webhook/v1/vinyl/bridge_inbound

   2. Reúna as credenciais do Twilio

      1. Navegue até Painel do console > Configurações.
      2. Anote as credenciais do LIVE:
         • Conta Sid
         • Token de autenticação

3. Configurar endpoint SMS:

   1. Navegue até IDE > Servidores de Notificação.
   2. Clique duas vezes no registro 'SMS'.
   3. Adicione a seguinte configuração:
      • Nome de usuário: Conta Twilio Sid
      • Senha: Token de autenticação Twilio
      • MessagingServiceSid: Serviço de mensagens Twilio Sid

4. Configurar URL do site:

   1. Navegue até IDE > Provedores de segurança.
   2. Em Configuração, clique em Mais > Sites.
   3. Clique em + Site.
   4. Defina o valor da URL como a URL do seu site. Por exemplo: https://vinyl.zudy.com.
   5. Clique em Salvar.

5. Configurar notificação por SMS:

   1. Criar notificação: Crie uma regra que tenha como alvo um objeto de dados públicos de notificação:

      1. Navegue até App Workbench > Notificações.
      2. Clique em + Notificação.
      3. Atribua um Nome.
      4. Selecione Notificação como Finalidade.
      5. Selecione Mensagem de texto como destino. Caso não veja este objeto de dados disponível, crie uma conexão de fonte de dados com o App Builder (selado) para o aplicativo em que você está trabalhando.
      6. Clique em Salvar.

   2. Defina a notificação mvSQL:

      1. Clique no botão +Tabela e adicione a Tabela que a Regra requer. Ex.: Customers.

      2. Clique na aba Colunas e adicione as seguintes colunas:

         Coluna	Alias	Alvo
         '+15551112222' (substitua pelo seu número de telefone)	Para()	Para()
         "C".CustomerId	CustomerId	Vinculação()
         "C".NomeDoCliente	NomeDoCliente

         !!! note "Nota" Adicionamos "CustomerName" para que possamos usá-lo posteriormente como um parâmetro de substituição em nossa mensagem de notificação.

   3. Defina as opções de notificação: Além de definir as informações da mensagem, definiremos duas opções para este exemplo de notificação. Uma que é ativada ao responder ao SMS e outra que é um link para uma página:

      1. Clique na aba de navegação Notificação.

      2. Insira a seguinte mensagem no Corpo da Mensagem:

         Reply {{1}} to approve {{NomeDoCliente}}. Review {{Revisão}}
         

      3. Clique no botão +Opção no painel Opções:

         1. Defina Índice como 10.
         2. Defina Nome como Revisão.
         3. Selecione a página para vincular. Em nosso exemplo, criaremos um link para a página "Cliente" da Northwinds. Se a página para a qual você deseja criar o link não aparecer, certifique-se de que ela tenha sido marcada como "Compartilhada" nas Configurações do Edge Case.
         4. Defina a opção Tipo como 'Link'.
      4. Clique no botão +Opção no painel Opções
         1. Defina Índice como 20.
         2. Defina Nome como 1.
         3. Selecione a página para vincular. Em nosso exemplo, vincularemos à página "Cliente" da Northwinds e executaremos o evento "Aprovar".
         4. Defina a opção Tipo como 'Resposta por SMS'.

   4. Registre a Notificação como uma Ação com um Evento. Neste caso, estamos assumindo que o Evento está associado a um botão na página de inicialização. Também assumiremos que o evento se chama 'Solicitar Aprovação':

      1. Navegue até o Evento do objeto de dados.
      2. Clique no ícone Lógica de Negócios.
      3. Clique no botão Eventos.
      4. Selecione o Evento. Por exemplo: Solicitar Aprovação.
      5. Clique em Registrar Existente no painel Ações.
      6. Selecione Notificação como Tipo de Ação.
      7. Selecione a Notificação que criamos na etapa anterior. Por exemplo: Customer_RequestApprovalSms.
      8. Clique em Salvar.
      9. Verifique se as Vinculações Explícitas estão corretas. Por exemplo: CustomerId- CustomerId.

   5. Configurar notificação push: As notificações push são configuradas de forma semelhante a outras notificações no App Builder. O administrador do servidor do App Builder deve configurar o endpoint de notificação push corretamente para que funcionem conforme o esperado. Se estiver configurando notificações push com a API Blabber, você deverá baixar o aplicativo complementar para iOS, fazer login no servidor correspondente com as credenciais corretas e habilitar as notificações push no próprio aplicativo. Além disso, uma chave de API é necessária para concluir a configuração.

   6. Teste: Neste ponto, a Notificação está completamente configurada. Navegue até a sua página e clique no botão que executa o evento de notificação.

Notificações do sistema

As notificações do sistema são exibidas para usuários ativos e permanecem na Central de Notificações (abaixo do menu de hambúrguer) quando descartadas.

Os administradores podem enviar notificações do sistema imediatamente ou agendá-las para envio.

Para configurar uma notificação do sistema, siga estes passos:

1. Selecione IDE > Manutenção (Beta) e selecione a aba Notificações.

2. No painel Notificações agendadas, clique no botão Agendar ou Enviar agora.

3. Na caixa de diálogo Notificação, insira valores para os seguintes campos:

   • Para: Clique no menu e selecione uma das seguintes opções:

     • Todos

     • Um grupo de usuários com base no seguinte:

       • Seu acesso a um aplicativo ou fonte de dados concedido por seus grupos ou funções.

       • Grupo de segurança.

       • Funções da fonte de dados.

   • De: Define quem enviou a notificação (geralmente o usuário do serviço).

   • Agendar para: (Opcional) Agende uma notificação para ser enviada mais tarde (por exemplo, uma hora antes de uma atualização planejada do aplicativo).

   • Expira em: Data/hora em que a notificação expira e não será mais exibida aos usuários. Nesse momento, os usuários que visualizaram e descartaram a mensagem terão a notificação removida de suas centrais de notificações.

   • Corpo: O conteúdo da mensagem mostrada aos usuários.

4. Clique no botão Enviar ou Agendar.

Um serviço em segundo plano envia notificações agendadas. Por padrão, o serviço é executado pela conta Usuário do Serviço. Para alterar o usuário que executa o serviço, siga estas etapas:

1. Selecione IDE > Manutenção (Beta) e selecione a aba Configurações.

2. Clique no menu Usuário de notificação em segundo plano e selecione o usuário para executar o serviço.