Actions CMS
Open
Função para buscar e exibir conteúdo proveniente de integrações com serviços externos.
Parâmetros:
Path
Nome do mapeamento de integração
permissionLevel
parameters -> querystring
critérios do tipo chave&valor (ex “&filterBy=1&data=01/01/18”) que serão utilizados como campos da querystring a ser concatenada ao final da url definida em PATH
parameters -> initialSearchForm
Possibilita a abertura de uma tela de pesquisa (baseada em forms dinâmicos} antes da execução da chamada ao serviço. Os campos do fomulário são utilizados como parâmetro da querystring.
parameters -> formParameters
Envia para o formulário de pesquisa - definido em initialSearchForm - valores para prévio preenchimento dos campos. Deve ser informado o nome definido “identifier” de cada campo no formato “identifier=valor” e separados por “&”.
parameters -> actionConfirmation
Possibilita a exibição de um popup de confirmação antes da execução da ação.
type:Tipo da janela de mensagem. Pode ser: Info (azul), warning (amarela), error (vermelha) e success (verde)
message: Mensagem a ser exibida
btnYes: Botão que confirma a execução da action. Se informado, será exibido com o label descrito. Se vazio, não é exibido na tela.
btnNo: Botão que cancela a execução da action. Se informado, será exibido com o label descrito. Se vazio, não é exibido na tela.
JSON esperado:
Open-goto
Mesmo funcionamento da action OPEN. Entretanto, remove do fluxo todas as telas que foram abertas anteriormente. Caso o usuário acione o “back”, será direcionado à tela inicial do endpoint.
JSON esperado:
Open-search
Mesmo funcionamento da action OPEN, disponibilizando um formulário de pesquisa antes de exibir a lista.
parameters -> formParameters Envia para o formulário de pesquisa - definido em initialSearchForm - valores para prévio preenchimento dos campos. Deve ser informado o nome definido “identifier” de cada campo no formato “identifier=valor” e separados por “&”.
parameters -> actionConfirmation Possibilita a exibição de um popup de confirmação antes da execução da ação.
type:Tipo da janela de mensagem. Pode ser: Info (azul), warning (amarela), error (vermelha) e success (verde)
message: Mensagem a ser exibida
btnYes: Botão que confirma a excução da action. Se informado, será exibido com o label descrito. Se vazio, não é exibido na tela.
btnNo: Botão que cancela a excução da action. Se informado, será exibido com o label descrito. Se vazio, não é exibido na tela.
Path
Nome do mapeamento de integração
permissionLevel
parameters -> initialSearchForm
Possibilita a abertura de uma tela de pesquisa (baseada em forms dinâmicos} antes da execução da chamada ao serviço. Os campos do fomulário são utilizados como parâmetro da querystring.
parameters -> formParameters
Envia para o formulário de pesquisa - definido em initialSearchForm - valores para prévio preenchimento dos campos. Deve ser informado o nome definido “identifier” de cada campo no formato “identifier=valor” e separados por “&”.
parameters -> actionConfirmation
Possibilita a exibição de um popup de confirmação antes da execução da ação.
type:Tipo da janela de mensagem. Pode ser: Info (azul), warning (amarela), error (vermelha) e success (verde)
message: Mensagem a ser exibida
btnYes: Botão que confirma a excução da action. Se informado, será exibido com o label descrito. Se vazio, não é exibido na tela.
btnNo: Botão que cancela a excução da action. Se informado, será exibido com o label descrito. Se vazio, não é exibido na tela.
JSON esperado:
Open-view
Função que exibe um link ou conteúdo HTML em uma webview dentro do App, sendo obtido através de mapeamento ou por link direto.
Quando utilizado o mapeamento, este tanto pode retornar um conteúdo HTML ou um link.
Parâmetros:
permissionLevel
title
Define o titulo da tela que será aberta com webview
Utilização sem integração
parameters -> url
Url direta do link que deve ser exibido
Utilização com integração
Path
Nome do mapeamento de integração a ser utilizado
parameters -> querystring
Pertencente ao elemento path, critérios do tipo chave&valor (ex “&filterBy=1&data=01/01/18”) que serão utilizados como campos da querystring a ser concatenada ao final da url definida em PATH.
parameters -> initialSearchForm
Pertencente ao elemento path, Possibilita a abertura de uma tela de pesquisa (baseada em forms dinâmicos} antes da execução da chamada ao serviço. Os campos do fomulário são utilizados como parâmetro da querystring.
parameters -> formParameters
Pertencente ao elemento path, Envia para o formulário de pesquisa - definido em initialSearchForm - valores para prévio preenchimento dos campos. Deve ser informado o nome definido “identifier” de cada campo no formato “identifier=valor” e separados por “&”.
parameters -> actionConfirmation
Possibilita a exibição de um popup de confirmação antes da execução da ação.
type:Tipo da janela de mensagem. Pode ser: Info (azul), warning (amarela), error (vermelha) e success (verde)
message: Mensagem a ser exibida
btnYes: Botão que confirma a execução da action. Se informado, será exibido com o label descrito. Se vazio, não é exibido na tela.
btnNo: Botão que cancela a execução da action. Se informado, será exibido com o label descrito. Se vazio, não é exibido na tela.
parameters -> screenRotation
Indica se o app permite a rotação da tela. True ou false.
parameters -> screenSwipeRefresh
Indica se o app permite a reload da página da tela. True ou false.
parameters -> blockVideoAutoplay
Se deve bloquear o autoplay de vídeos. True ou false. O valor padrão é false.
OBS: Essa propriedade só tem efeito no iOS.
parameters -> userAgent
Você pode configurar um User Agent alternativo, que será utilizado pelo componente de browser interno do aplicativo. É pouco provável que você precise utilizar essa propriedade. Mas no caso de alguma página de internet não estar funcionando corretamente em alguma plataforma (iOS ou Android), você pode definir um valor de User Agent alternativo para que a página se comporte como se estive sendo executada no browser de um aparelho específico.
Exemplo de um user agent válido: Mozilla/5.0 (Linux; Android 8.0.0; SM-G960F Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.84 Mobile Safari/537.36 O user agent acima indica que o browser está rodando em um Samsung Galaxy S9.
OBS: Essa propriedade só tem efeito para os aplicativos móveis.
JSON esperado:
Open - download
Função que faz o download de um arquivo utilizando como fonte um mapeamento ou um link direto.
Quando utilizado o mapeamento, este tanto pode retornar o base64 do arquivo ou um link (ver template necessária)
Parâmetros:
permissionLevel
Utilização sem integração
parameters -> url
Url direta do arquivo que deve ser exibido
Utilização com integração
Path
Nome do mapeamento de integração a ser utilizado
parameters -> querystring
Pertencente ao elemento path, critérios do tipo chave&valor (ex “&filterBy=1&data=01/01/18”) que serão utilizados como campos da querystring a ser concatenada ao final da url definida em PATH.
parameters -> initialSearchForm
Pertencente ao elemento path, Possibilita a abertura de uma tela de pesquisa (baseada em forms dinâmicos} antes da execução da chamada ao serviço. Os campos do fomulário são utilizados como parâmetro da querystring.
parameters -> formParameters
Pertencente ao elemento path, Envia para o formulário de pesquisa - definido em initialSearchForm - valores para prévio preenchimento dos campos. Deve ser informado o nome definido “identifier” de cada campo no formato “identifier=valor” e separados por “&”.
parameters -> actionConfirmation
Possibilita a exibição de um popup de confirmação antes da execução da ação.
type:Tipo da janela de mensagem. Pode ser: Info (azul), warning (amarela), error (vermelha) e success (verde)
message: Mensagem a ser exibida
btnYes: Botão que confirma a excução da action. Se informado, será exibido com o label descrito. Se vazio, não é exibido na tela.
btnYes: Botão que cancela a excução da action. Se informado, será exibido com o label descrito. Se vazio, não é exibido na tela.
JSON esperado
Open - download - share
Veja a seção do OPEN-DOWNLOAD para mais informações sobre como configurar a action.
Open - exames (depreciado)
Open - QRcode
Abre uma tela para leitura de um código de barras antes de executa um mapeamento, adicionando o valor lido ao final da querystring definida.
Parâmetros:
permissionLevel
Path
Nome do mapeamento de integração a ser utilizado
parameters -> querystring
Pertencente ao elemento path, critérios do tipo chave&valor (ex “&filterBy=1&data=01/01/18”) que serão utilizados como campos da querystring a ser concatenada ao final da url definida em PATH.
parameters -> type
Informa o tipo leitor que deve ser aberto: qrcode Ou barcode ou both
JSON esperado:
Open - PDF
Função que realiza a abertura de arquivo PDF dentro do APP
Parâmetros:
permissionLevel
Utilização sem integração
parameters -> url
Url direta do arquivo que deve ser exibido
Utilização com integração
Path
Nome do mapeamento de integração a ser utilizado
parameters -> querystring
Pertencente ao elemento path, critérios do tipo chave&valor (ex “&filterBy=1&data=01/01/18”) que serão utilizados como campos da querystring a ser concatenada ao final da url definida em PATH.
parameters -> initialSearchForm
Pertencente ao elemento path, Possibilita a abertura de uma tela de pesquisa (baseada em forms dinâmicos} antes da execução da chamada ao serviço. Os campos do fomulário são utilizados como parâmetro da querystring.
parameters -> formParameters
Pertencente ao elemento path, Envia para o formulário de pesquisa - definido em initialSearchForm - valores para prévio preenchimento dos campos. Deve ser informado o nome definido “identifier” de cada campo no formato “identifier=valor” e separados por “&”.
parameters -> actionConfirmation
Possibilita a exibição de um popup de confirmação antes da execução da ação.
type:Tipo da janela de mensagem. Pode ser: Info (azul), warning (amarela), error (vermelha) e success (verde)
message: Mensagem a ser exibida
btnYes: Botão que confirma a excução da action. Se informado, será exibido com o label descrito. Se vazio, não é exibido na tela.
btnYes: Botão que cancela a excução da action. Se informado, será exibido com o label descrito. Se vazio, não é exibido na tela.
Json Esperado:
Share
Função que aciona os apps de COMPARTILHAMENTO no dispositivo, informando um texto ou texto + arquivo.
O arquivo é buscado através da conexão definida em PATH , que deve retornar um objeto do tipo “FileList”, trazendo no interior o base64 do arquivo, Possui 6 parâmetros:
text
texto do compartilhamento.
querystring
Pertencente ao elemento path, critérios do tipo chave&valor (ex “&filterBy=1&data=01/01/18”) que serão utilizados como campos da querystring a ser concatenada ao final da url definida em PATH.
initialSearchForm
Pertencente ao elemento path, Possibilita a abertura de uma tela de pesquisa (baseada em forms dinâmicos} antes da execução da chamada ao serviço. Os campos do fomulário são utilizados como parâmetro da querystring.
formParameters
Pertencente ao elemento path, Envia para o formulário de pesquisa - definido em initialSearchForm - valores para prévio preenchimento dos campos. Deve ser informado o nome definido “identifier” de cada campo no formato “identifier=valor” e separados por “&”.
actionConfirmation
Possibilita a exibição de um popup de confirmação antes da execução da ação.
type:Tipo da janela de mensagem. Pode ser: Info (azul), warning (amarela), error (vermelha) e success (verde)
message: Mensagem a ser exibida
btnYes: Botão que confirma a excução da action. Se informado, será exibido com o label descrito. Se vazio, não é exibido na tela.
btnYes: Botão que cancela a excução da action. Se informado, será exibido com o label descrito. Se vazio, não é exibido na tela.
Contendo assim dois exemplos de compartilhamento de texto + arquivo acessando mapeamento:
Json esperado em conexão
Print
Função que aciona os apps de IMPRESSÃO no dispositivo. O documento a ser impresso pode ser buscado a partir de uma URL ou de uma conexão mapeada. Possui 6 parâmetros:
url
Url do arquivo para impressão.
querystring
Parâmetro Opcional. Pertencente ao elemento path, critérios do tipo chave&valor (ex “&filterBy=1&data=01/01/18”) que serão utilizados como campos da querystring a ser concatenada ao final da url definida em PATH.
initialSearchForm
Pertencente ao elemento path, Possibilita a abertura de uma tela de pesquisa (baseada em forms dinâmicos} antes da execução da chamada ao serviço. Os campos do fomulário são utilizados como parâmetro da querystring.
formParameters
Parâmetro Opcional. Pertencente ao elemento path, Envia para o formulário de pesquisa - definido em initialSearchForm - valores para prévio preenchimento dos campos. Deve ser informado o nome definido “identifier” de cada campo no formato “identifier=valor” e separados por “&”.
actionConfirmation
Parâmetro Opcional..Possibilita a exibição de um popup de confirmação antes da execução da ação.
type:Tipo da janela de mensagem. Pode ser: Info (azul), warning (amarela), error (vermelha) e success (verde)
message: Mensagem a ser exibida
btnYes: Botão que confirma a excução da action. Se informado, será exibido com o label descrito. Se vazio, não é exibido na tela.
btnYes: Botão que cancela a excução da action. Se informado, será exibido com o label descrito. Se vazio, não é exibido na tela.
Alarm
Habilita a funcionalidade de alarmes na plataforma, exibindo uma tela de listagem onde se pode agendar alarmes com uma breve descrição, também possibilita a criação de alarmes recorrentes.
Características :
Cada alarme é vinculado ao usuário autenticado e ao endpoint.
Os alarmes são desativados ao fazer logoff do aplicativo
Os alarmes são reagendados ao fazer login, caso o usuário possua alarmes predefinidos.
Os alarmes são registrados apenas localmente no aparelho.
O título da tela é o título retornado na action, caso este seja vazio ou nulo o valor default será: "Alarmes"
Particularidades plataforma iOS:
Caso esteja fora do app, na tela bloqueada, a notificação dispara o som por apenas 30 segundos.
O usuário poderá configurar no máximo 9 alarmes.
Last updated