Portal do Gestor (Produtor Rural) — Requisição externa
A funcionalidade de requisição externa permite cadastrar informações de serviços externos para o App do Produtor Rural para, assim, disponibilizar novas funcionalidades de forma fácil ao aplicativo e poderem ser utilizadas pelo Produtor.
Atualmente, há somente um serviço externo utilizado pelo aplicativo, que é a funcionalidade de informe de rendimentos do Produtor Rural. Com isso, as informações podem ser cadastradas através de um web service que gere um relatório de informe de rendimentos do Produtor e envie para o Produtor Rural.
O App do Produtor Rural irá usar o cadastro de requisição externa para poder disponibilizar o informe de rendimentos do Produtor através da funcionalidade Informe de rendimentos, presente no aplicativo.
Observação
Pode ser cadastrado qualquer web service que gere o informe de rendimentos e envie ao Produtor Rural. No caso de clientes que possuem o Gestão Empresarial | ERP da Senior, torna-se necessário ter o seguinte cadastro (podendo utilizar o web service com.senior.g5.co.ger.relatorio, porta Executar):
- URL: informe o web service referente à emissão do relatório de informe de rendimentos, do ERP do cliente. Atenção: a Empresa Agro deve disponibilizar a URL para acesso externo;
- Body: informe o body (corpo) da requisição externa, ou seja, o XML. Algumas requisições não necessitam do body, por isso, este campo é de preenchimento opcional.
Body da request para clientes que possuem o Gestão Empresarial | ERP da Senior:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Header/>
<soapenv:Body>
<ser:Executar>
<user>@USUARIO@</user>
<password>@SENHA@</password>
<encryption>@CRIPTOGRAFIA@</encryption>
<parameters>
<!--Optional:-->
<prAnexoBool>@ANEXO@</prAnexoBool>
<!--Optional:-->
<prAssunto>@ASSUNTO@</prAssunto>
<!--Optional:-->
<prDest>@DESTINATARIO@</prDest>
<!--Optional:-->
<prEntranceIsXML>@IS_XML@</prEntranceIsXML>
<prEntrada><ECodEmp=@EMPRESA@><eCgcCpf=@CPF_CNPJ@><eAnoCal=@ANO@></prEntrada>
<!--Optional:-->
<prExecFmt>tefMail</prExecFmt>
<!--Optional:-->
<prMensagem>@MENSAGEM@</prMensagem>
<!--Optional:-->
<prRelatorio>@RELATORIO@</prRelatorio>
<!--Optional:-->
<prRemetente>@REMETENTE@</prRemetente>
<!--Optional:-->
<prSaveFormat>tsfPDF</prSaveFormat>
<!--Optional:-->
<prUniqueFile>S</prUniqueFile>
</parameters>
</ser:Executar>
</soapenv:Body>
</soapenv:Envelope>
Em todos os locais em que consta @KEY@, deve-se ter um parâmetro cadastrado na lista de parâmetros da requisição externa.
Importante: o @ANO@, @CPF_CNPJ@ e @EMPRESA@ são vinculados aos parâmetros de requisição externa, pois eles são dinâmicos.
Fluxo completo do processo (Gestão Empresarial | ERP x Senior X x App do Produtor Rural)
O que você pode fazer:
Cadastro, consulta e exclusão de requisição externa
Cadastrar uma requisição externa
- Acesse a Senior X e, então, o menu Gestão Agro > App do Produtor > Requisição externa;
- Na tela Listagem de requisição externa, clique em Adicionar;
- Na tela Cadastro de requisição externa, preencha os seguintes campos da guia Detalhes:
- Tipo: neste campo, informe o tipo Informe de rendimentos;
- Empresa: informe o código da Empresa que será vinculada à requisição. Observação: é possível inserir mais de uma Empresa Agro para que sejam gerados todos os informes de rendimentos de todas as empresa, no qual o Produtor Rural está vinculado. Para isso, basta inserir os códigos das Empresas Agro e separá-los por ponto e vírgula (";").;
- URL: informe o web service referente à emissão do relatório de informe de rendimentos, do ERP do cliente. Atenção: a Empresa Agro deve disponibilizar a URL para acesso externo;
- Body: informe o body (corpo) da requisição externa, ou seja, o XML. Algumas requisições não necessitam do body, por isso, este campo é de preenchimento opcional.
- Depois de preencher os campos, clique no botão Salvar.
Caso você clique em Cancelar, o cadastro de requisição externa será cancelado e as informações serão perdidas.
Observação
- Os campos Tipo, Empresa e URL são obrigatórios;
- Atualmente, são feitas somente requisições SOAP.
Consultar uma requisição externa
- Acesse a Senior X e, então, o menu Gestão Agro > App do Produtor > Requisição externa;
- Na tela Listagem de requisição externa, serão apresentadas todas as requisições criadas;
- Na lista, identifique a requisição desejada.
Caso você queira editar uma requisição, basta marcar o checkbox (caixa de seleção) da requisição e, então, clicar no botão Editar. A tela Cadastro de requisição externa será aberta, sendo possível editar todos os campos da guia Detalhes.
Ao editar uma requisição externa, além da guia Detalhes, também fica disponível a guia Parâmetros, onde é possível incluir uma lista de registros. Para isso:
- Clique no botão Adicionar;
- A janela Parâmetro requisição externa será aberta;
- Nessa janela, preencha os seguintes campos:
- Chave: informe a chave do parâmetro;
- Valor: informe o valor do parâmetro.
- Depois de preencher os campos, clique no botão Salvar.
Caso você clique em Cancelar, o cadastro do parâmetro será cancelado e as informações serão perdidas.
Filtros
Na tela Listagem de requisição externa, ao clicar no botão (ícone de mais), presente no quadro Filtros, você pode fazer uma busca de requisições através da URL e/ou Body. Basta preencher os campos desejados e clicar no botão Filtrar. Para limpar a pesquisa, basta clicar em Limpar filtros.
Além desses filtros, você também pode classificar as colunas Tipo, URL, Criado por, Data de criação, Alterado por e Data de alteração (presentes no quadro Requisição externa) por ordem crescente ou decrescente. Para isso, basta clicar sobre a coluna desejada. Ao clicar pela primeira vez, o sistema irá classificar as informações em ordem crescente; clicando pela segunda vez sobre a coluna, o sistema irá classificar em ordem decrescente.
Excluir uma requisição externa
- Acesse a Senior X e, então, o menu Gestão Agro > App do Produtor > Requisição externa;
- Na tela Listagem de requisição externa, identifique a requisição que você deseja excluir;
- Marque o checkbox (caixa de seleção) da requisição e, então, clique no botão Excluir.
Observação
O sistema não permite excluir uma requisição externa com parâmetros vinculados. Ao tentar fazer a exclusão de uma requisição com parâmetros vinculados, um alerta será apresentado na tela, informando que existe um registro dependente e que deve-se excluir o parâmetro dependente primeiro.
Adicionar requisição de banner para o aplicativo
Esta etapa permite que o gestor cadastre uma ação de banner com URL válida dentro do aplicativo do Produtor Rural
- Na Senior X, siga pelo menu Tecnologia > Administração > Autorização > Gestão de Papéis;
- Em "Dados do Papel", parametrize com o papel de Produtor já existente;
- Inclua a permissão para externalRequest na filtragem (res://senior.com.br/agro/agrox/entities/externalReques). Para isso, selecione a guia "Permissões" e agrupe por "Recurso";
- Em "Ações" para esse recurso, selecione a opção "Visualizar";
- Acesse a Senior X e, então, o menu Gestão Agro > App do Produtor > Requisição externa;
- Clique em Adicionar;
- Na tela Cadastro de requisição externa, preencha os seguintes campos da guia Detalhes:
- Tipo: informe a opção "Ação do Banner";
- URL: indique o URL que deve ser acessado na seleção do banner exibido na home do aplicativo;
- Com a seleção do Tipo, o campo Empresa será bloqueado para preenchimento.
Observação
Só é permitido um registro do tipo "Ação de Banner". Em caso de tentativa de um novo cadastro, o sistema retornará uma mensagem de "Registro duplicado. O tipo de requisição externa "Ação de Banner" já foi cadastrado.
English
Español
