Action Formulários

Open-frm-categories

Função que retorna a lista de CATEGORIAS do módulo de Formulários da plataforma mobileX.

Pode ser solicitada a listagem a partir da raiz (todas as categorias) ou a partir de uma categoria específica.A lista resultante já virá com ação de clique padrão, podendo ser:

• Se a categoria possuir filhas, a ação padrão será abrir a lista de categorias filhas .

• Senão, abre a lista de serviços

Parâmetros	Descrição
parameters -> querystring	Formada pelo identificador do módulo de formulário desejado, podendo ser: module: Retorna todas as categorias de formulário a partir do módulo informado Módulo de Questionário (NPS) Módulo de Coleta de Dados (FormsGerais) parentId: Guid ou identificador único da categoria raiz. Opcional

Exemplo para todas as categorias:

{
    "order": 0,
    "name": "open-frm-categories",
    "permissionLevel": 2,
    "publishLevel": 1,
    "title": "",
    "icon": "",
    "parameters": [
            {"title":"querystring","value":"?module=NPS"}   -> Para o módulo de questionário
            {"title":"querystring","value":"?module=FormGeral"}-> Para o módulo de Coleta
    ]
}

Exemplo para listagem a partir de uma categoria superior:

{
    "order": 0,
    "name": "open-frm-categories",
    "permissionLevel": 2,
    "publishLevel": 1,
    "title": "",
    "icon": "",
    "parameters": [
            {"title":"querystring","value":"?parentId=xxx"} 
    ]
}

Open-frm-forms

Função que retorna a lista de SERVIÇOS de uma categoria do módulo de Formulários da plataforma mobileX.

A lista resultante virá com ação de clique de acordo com a variável “add” informada na querystring:

Parâmetros	Descrição
parameters -> querystring	CategoryId: Id da categoria Add: Indica se, ao clicar no serviço, qual o tipo de ação a ser executada Se add=true: a ação padrão será adicionar uma nova solicitação de atendimento para o serviço. Se add=false: abre a lista de solicitações realizadas para o serviço pelo usuário logado.

Exemplo para todas as categorias:

{
    "order": 0,
    "name": "open-frm-forms",
    "permissionLevel": 2,
    "publishLevel": 1,
    "parameters": [
            {"title":"querystring","value":"?categoryId=dcc9736e...&add=false"}
    ]
}

Open-frm-submissionforms

Função que retorna a lista de submissões realizadas pelo usuário logado, a partir de uma categoria ou serviço do módulo de Formulários da plataforma mobileX.

Se a categoria é informada, o app exibirá todas as submissões realizadas pelo usuário para quaisquer serviços desta categoria (incluindo suas filhas).

Parâmetros

Descrição

parameters -> querystring

Deve informar: CategoryId: Se informado, retorna as solicitações do usuário para todos os serviços cadastrados para a categoria indicada. ServiceId: Se informado, retorna as solicitações do usuário para todos o serviço indicado. Add: Indica se a opção de adicionar atendimento estará disponível na tela. Se add=true, a opção de adicionar solicitação é exibida. Se add=false, a opção permanece oculta.

Exemplo:

{
    "order": 0,
    "name": "open-frm-submissionform",
    "permissionLevel": 2,
    "publishLevel": 1,
    "parameters": [
            {"title":"querystring","value":"?categoryId=xxx&add=false/true"}   OU
            {"title":"querystring","value":"?serviceId=xxxx&add=false/true"}
    ]
}

Open-frm-submissionforms-view

Função que retorna o Detalhamento de uma Submissão. O detalhamento é composto pelas informações da submissão.

Exemplo:

{
    "order": 0,
    "name": "open-frm-submissionform-view",
    "permissionLevel": 2,
    "publishLevel": 1,
    "parameters": [
            {"title":"querystring","value":"?id=xxx"}
    ]
}

Open-frm-submissionforms-add

Função que disponibiliza o processo de uma nova submissão de um formulário.

Parâmetros	Descrição
Querystring	formada pelo id do formulário.
formParameters	Necessário apenas se desejar o preenchimento do form com dados prévios

Importante: Para exibir a sempre a última versão do formulário é necessário informar o “rootParentId” do form como formID ou o identifier (recomendado).

Exemplo:

{
    "order": 0,
    "name": "open-frm-submissionform-add",
    "permissionLevel": 2,
    "publishLevel": 1,
    "parameters": [          
            {"title":"value", "value":"?formId=xx"},
            {"title":"formParameters","value":"filterby=1&nome=ana"}   
    ]
}

Open-frm-submissionforms-edit

Função que disponibiliza o processo de edição de uma submissão.

Parâmetros	Descrição
Querystring	Formada pelo id do formulário.
formParameters	Dados para preenchimento do form com dados prévios

Importante: Para exibir a sempre a última versão do formulário é necessário informar o “rootParentId” do form como formID.

Exemplo:

{
    "order": 0,
    "name": "open-frm-submissionform-edit",
    "permissionLevel": 2,
    "publishLevel": 1,
    "parameters": [          
            {"title":"querystring", "value":"?id=xx"},
            {"title":"formParameters","value":"filterby=1&nome=ana"}
    ]
}

Open-frm-submissionforms-del

Função que disponibiliza a exclusão de uma submissão.

Parâmetros	Descrição
Querystring	Formada pelo id da submissão

Exemplo:

{
	"order": 0,
	"name": "open-frm-submissionform-del",
	"permissionLevel": 2,
	"publishLevel": 1,
	"parameters": [
		{"title":"querystring", "value": "?id=xxx"
	]
}

Open-frm-submissionforms-change_status

Função que disponibiliza o processo de abertura de submissão.

Parâmetros	Descrição
Querystring	Formada pelo id da submissão

Exemplo:

{
	"order": 0,
	"name": "open-frm-submissionform-change_status",
	"permissionLevel": 2,
	"publishLevel": 1,
	"parameters": [
		{"title":"querystring", "value": "?id=xxx"
		}
	]
}

Open-offline-form-answer

Função que exibe tela de sincronização de dados para apps offline, a action carrega uma tela fixa nos fronts mobile sendo possível sincronizar telas, formulários e dados de formulários, para serem visualizados quando o dispositivo estiver sem rede(offline) e exibe uma listagem dos formulários submetidos offline e pendentes de sincronização.

Exemplo:

{
    "order": 0,
    "name": "open-offline-form-answer",
    "permissionLevel": 2,
    "publishLevel": 1,
    "parameters": []
}