Notificações no Jitterbit App Builder

Introdução

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

• Email

• SMS (usando o serviço Twilio)

• Alerta do App Builder (um popup no aplicativo que aparece quando o usuário está logado em um aplicativo)

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

Desde o App Builder 4.44, você pode selecionar IDE > Manutenção (Beta), e então selecionar 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 estão incluídas na mensagem que linkam de volta para o 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 estão ativos por 7 dias, após os quais eles expiram e não estão mais ativos. (Esse tempo de expiração não pode ser alterado.)

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

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

Para usar os objetos de dados públicos necessários para Notificação, seu aplicativo requer que App Builder (Selado) 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. Se não forem encontradas, o App Builder irá usar o 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 de Configuração) > Sites. Para mais informações sobre sites e URLs, veja o artigo Sites e aliases.

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 de saída. Isso é considerado uma notificação Informativa.

Quando uma Notificação contém 1 ou mais opções, uma mensagem é enviada com links de URL de volta ao App Builder que permitem ao Usuário responder 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 página: Um link é fornecido que permite ao usuário navegar para uma página. Navegar com sucesso para a página é considerado uma resposta completa à opção.

2. Executar evento da página: Um link é fornecido que envia o usuário para uma página e executa um evento específico antes que a página seja renderizada. A resposta do Usuário é considerada completa uma vez que o evento é acionado.

Para que uma página seja elegível para qualquer uma dessas opções, a página 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 algum texto e os seguintes três botões:

1. Revisar: Ao ser clicado, o usuário é levado a uma página específica.

2. Aprovar: Ao ser clicado, o usuário é levado a uma página diferente e executa um evento contra alguns objetos de dados na página.

3. Rejeitar: Ao ser clicado, o usuário é levado a uma página diferente e executa um evento contra os objetos de dados da mesma página ou de uma página diferente.

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

• Configurar a página Link Para como Compartilhada.

• Incluir o evento no Objeto de Dados da página ou como uma das fontes de dados de painel de linha única na página. (Uma ilustração adicional deste ponto está disponível na seção de Vinculação de Eventos de Objeto de Dados abaixo.)

Vinculação de eventos de objeto 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 que está vinculado a um painel de linha única não vinculado na página de destino. Por exemplo, considere uma página que possui 6 painéis de linha única:

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

Neste exemplo, os painéis Customer e Employee não estão vinculados a nenhum outro painel na página. Portanto, um desenvolvedor pode escolher eventos das fontes de dados desses dois painéis (junto com um objeto de dados da página, se um for especificado).

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

Registro de notificações

Vinculando a uma notificação

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

Criação de mensagem

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

Substituições são realizadas no Modelo e usam a sintaxe {{fieldname}}. As substituições podem adicionar uma flag opcional url para indicar que o valor é uma URL e requer codificação de URL, por exemplo, {{fieldname|url}}.

Para substituição, o corpo pode conter:

Olá {{CustomerName}},

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. Existem três campos que são usados para traduções:

1. Nome da Opção de Notificação.

2. Mensagem de Registro de Notificação.

3. Assunto de 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, assumindo que seu conteúdo especifica a chave de tradução correspondente. O desenvolvedor também precisa adicionar as chaves ao pacote de tradução para o aplicativo manualmente (atualmente, elas não são importadas automaticamente para um aplicativo). Deve-se ter cuidado com o campo Template 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 Template de Registro de Notificação que permite editar diretamente a string.

Limitações

1. O evento executado no link da opção pertence aos Dados da Página ou a um Objeto de Dados de Painel de Linha Única. Atualmente, não exibimos resultados de validação ou mensagens pós-evento para eventos de nível de página. Em outras palavras, o evento é executado primeiro; quando é concluído, o usuário é redirecionado para sua página. Quando eles chegam à sua página, os resultados do evento são perdidos. Portanto, se o evento tiver uma mensagem pós ou falhar na validação, o sistema não mostrará 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, 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 File de uma fonte de dados Amazon S3 não pode ser puxada 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 estão definidos abaixo.

Colunas comuns

Essas colunas são comuns entre os objetos de dados públicos de Notificação:

Email

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

Mensagem de Texto

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

Alerta do Construtor de Aplicativos

O objeto de dados público Alerta do Construtor de Aplicativos é semelhante, mas não totalmente consistente com o objeto de dados público Create_Notification. As colunas do objeto de dados público Alerta do Construtor de Aplicativos são as seguintes:

Notificação Push

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

Configuração de Notificações

Exemplo de configuração de notificação

Estes são os passos necessários para configurar uma notificação. (Este exemplo mostra como adicionar uma Notificação de Aprovação de Cliente à página de Clientes do Northwinds.)

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

   1. Navegue até App Workbench.
   2. Clique em Notifications.
   3. Clique em + Notification.
   4. Atribua um Nome. Por exemplo CustomersRequestApprovalAlert.
   5. Confirme que o Propósito é Notification.
   6. Selecione App Builder Alert como o Alvo. Se você não ver este objeto de dados disponível, crie uma conexão de Fonte de Dados para o App Builder (Sealed) para o aplicativo em que está trabalhando.
   7. Clique em Save.

2. Definir mvSQL da notificação:

   1. Clique no botão +Tables.
   2. Adicione sua Tabela 'select from'. Por exemplo Customers.

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

      Coluna	Alias	Alvo
      all	To	To
      "C".CustomerId	CustomerId	Binding()
      "C".CustomerName	CustomerName

      Nota

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

3. Definir opções de notificação:

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

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

      Por exemplo: Por favor, revise o seguinte cliente:

      Cliente: {{CustomerName}}

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

4. (Opcional) Definir uma página de destino e um evento de pré-lançamento para executar:

   1. Na página App Workbench > Notfications, selecione a Notificação.
   2. Clique no botão + Option.
   3. Crie uma nova opção:
      1. Defina Index como 10.
      2. Defina Name como Revisar.
      3. Selecione o valor Link to Page. No nosso exemplo, vamos vincular à página 'Customer' do Northwinds. Se a página que você deseja vincular não aparecer, verifique se ela foi marcada como "Shared" nas Configurações de Edge Case.
   4. Clique no checkmark para salvar o registro.

5. Registrar notificação com um evento: Registrar 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 lançamento. Também vamos assumir que o evento é chamado de 'Solicitar Aprovação'.

   1. Navegue até o Evento para o Objeto de Dados.
   2. Clique no ícone de 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 de Ações.
   6. Selecione Notificação como o Tipo de Ação.
   7. Selecione a Notificação que criamos na etapa anterior. Por exemplo: AlertaSolicitacaoAprovacaoCliente.
   8. Clique em Salvar.
   9. Verifique se os Vínculos Explícitos estão corretos. Por exemplo: IdCliente - IdCliente.

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

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

Estes são os passos necessários para configurar uma notificação SMS. (Este exemplo mostra a adição de uma Notificação de Aprovação de Cliente à página de Clientes do Northwinds.)

1. Configurar a segurança do App Builder

   1. Navegue até IDE > Provedores de Segurança.
   2. Clique em + Autenticação de Usuário no painel de Autenticação de Usuário.
      1. Insira um Nome (por exemplo, Http Basic Auth).
      2. Selecione Autenticação Básica HTTP como o Tipo.
      3. Clique em Habilitado para ativar.
      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 uma resposta SMS chegar.
      2. Observe que este Usuário deve ter acesso ao seguinte:
         • Aplicação App Builder.
         • O Evento que será executado na própria notificação.
   4. Clique no ícone de Chaves na Autenticação.
   5. Clique em Criar.
   6. Selecione o provedor Http Basic Auth criado anteriormente.
   7. Clique em Salvar.

   Nota

   A chave secreta "Key" que é criada para este provedor. A combinação do Nome de Usuário e da chave secreta será usada ao configurar o Twilio.

2. Configurar o Twilio:

   1. Criar serviço de mensagens:

      1. Faça login na sua conta do Twilio.
      2. Navegue até Comunicações Cloud > 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 do Twilio a ele.
      5. Anote o MessagingServiceSid. Isso será usado para configuração posteriormente.
      6. Ative a opção "Processar Mensagem de Entrada".
      7. Insira a seguinte URL de Requisição:
         • https://<username>:<secret_key>@<seu_servidor_vinyl>/webhook/v1/vinyl/bridge_inbound
         • Ex.: https://admin:P124asfgOmkA@vinyl.zudy.com/webhook/v1/vinyl/bridge_inbound

   2. Coletar credenciais do Twilio

      1. Navegue até Console Dashboard > Configurações.
      2. Anote as credenciais LIVE:
         • Account Sid
         • Auth Token

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: Twilio Account Sid
      • Senha: Twilio Auth Token
      • MessagingServiceSid: Twilio Messaging Service 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 para a URL do seu site. Por exemplo: https://vinyl.zudy.com.
   5. Clique em Salvar.

5. Configurar notificação SMS:

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

      1. Navegue até App Workbench > Notificações.
      2. Clique em + Notificação.
      3. Atribua um Nome.
      4. Selecione Notificação como o Propósito.
      5. Selecione Mensagem de Texto como o Alvo. Se você não ver este objeto de dados disponível, crie uma conexão de Fonte de Dados para o App Builder (Selado) para o aplicativo em que 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	Destino
         '+15551112222' (substitua pelo seu número de telefone)	To()	To()
         "C".CustomerId	CustomerId	Binding()
         "C".CustomerName	CustomerName

         Nota

         Adicionamos "CustomerName" para que possamos usá-lo mais tarde como um parâmetro de substituição em nossa mensagem de Notificação.

   3. Defina 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, 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:

         Responda {{1}} para aprovar {{CustomerName}}. Revise {{Review}}
         

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

         1. Defina Índice como 10.
         2. Defina Nome como Revisar.
         3. Selecione a página para a qual deseja vincular. No nosso exemplo, vamos vincular à página 'Cliente' do Northwinds. Se a página que você deseja vincular não aparecer, certifique-se de que ela foi marcada como "Compartilhada" nas Configurações de Casos Especiais.
         4. Defina o Tipo da Opção como 'Link'.
      4. Clique no botão +Opção no painel de Opções
         1. Defina Índice como 20.
         2. Defina Nome como 1.
         3. Selecione a página para a qual deseja vincular. No nosso exemplo, vamos vincular à página 'Cliente' do Northwinds e executar o evento 'Aprovar'.
         4. Defina o Tipo da Opção como 'Resposta 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 lançamento. Também vamos assumir que o evento é chamado de 'Solicitar Aprovação':

6. Navegue até o Evento para o objeto de dados.

7. Clique no ícone Lógica de Negócios.
8. Clique no botão Eventos.
9. Selecione o Evento. Por exemplo: Aprovação de Solicitação.
10. Clique em Registrar Existente no painel de Ações.
11. Selecione Notificação como o Tipo de Ação.
12. Selecione a Notificação que criamos na etapa anterior. Por exemplo: Customer_RequestApprovalSms.
13. Clique em Salvar.

14. Verifique se os Vínculos Explícitos estão corretos. Por exemplo: Ex.: CustomerId - CustomerId.

15. Configure a 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 corretamente o endpoint de Notificação Push para que funcionem como esperado. Se você estiver configurando Notificações Push com a API Blabber, deve baixar o aplicativo complementar para iOS, fazer login no servidor correspondente com as credenciais adequadas e habilitar as notificações push no próprio aplicativo. Além disso, uma chave de API é necessária para concluir a configuração.

16. Teste: Neste ponto, a Notificação está completamente configurada. Navegue até 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 em seu Centro de Notificações (sob o menu de hambúrguer) quando dispensadas.

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

Para configurar uma notificação do sistema, siga estas etapas:

1. Selecione IDE > Manutenção (Beta), em seguida, 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: Uma data/hora quando a notificação expira e não será mais exibida para os usuários. Nesse momento, os usuários que viram e dispensaram a mensagem terão a notificação removida de seus centros de notificação.

   • Corpo: O conteúdo da mensagem exibido para os 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 do Usuário do Serviço. Para alterar qual usuário executa o serviço, siga estas etapas:

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

2. Clique no menu Usuário de Notificação em Segundo Plano, em seguida, selecione o usuário para executar o serviço.