Serviço externo - Cadastro

O serviço externo é a configuração de serviços que serão liberados a outros sistema.

Essa opção pode ser utilizada por administradores do sistema.
Esta tela é acessada no módulo COMUM, para permitir esse acesso, na aplicação de segurança é necessário dar permissão na opção “Serviço externo” no módulo “Novo - Comum” e no modulo “COMUM”.
Veja aqui os procedimentos para dar acesso a um recurso.

O administrador poderá disponibilizar os serviços que estiverem disponíveis, os serviços disponibilizados e utilizados pela Edusoft já estão cadastrados. Quando o dono do serviço for edusoft o administrador só poderá alterar os seguintes campos: Ip's liberados, https, usuário, senha e valor padrão (parâmetros do detalhe). Já os serviços cadastrado pelo administrador, o mesmo terá permissão para alteração de todos os campos.

O acesso a essa funcionalidade pode ser feito direto pelo menu.

Ao acessar a tela de serviço externo, o administrador poderá recupera um serviço já cadastrado ou incluir um novo.

Para cadastrar/editar um serviço o usuário deve informar:

• Descrição: Informe uma descrição para identificação do serviço
• Dono: Identificação do dono do serviço, está disponível apenas a opção Cliente para selecionar, quando está selecionado Edusoft é um serviço criado pelo Edusoft, somente alguns campos estão disponíveis para alteração.
• Ativo: ativa/desativar o serviço, quando inativo não é possível executar o serviço.
• Ip's liberados: Informe quais ip's podem acessar este o serviço, os ip's deve ser separados por vírgula (xxx.xxx.xxx.xxx, xxx.xxx.xxx.xxx). Quando não informado não terá restrição de ip.
• Https: Quando marcado este campo o Mentor Web deve está configurado como o protocolo https.
• Protocolo do serviço: Define qual será o formato da resposta.
• Tipo de autenticação: Define qual será o tipo de autenticação. No momento a autenticação disponível é Token edusoft, uma requisição “GET” passando nome do serviço, usuário e senha onde retorna o token de autenticação a ser passado para o serviço.
• Usuário: Usuário que deve ser passado na requisição GET para gerar o token.
• Senha: Senha que deve ser passado na requisição GET para gerar o token.

• No detalhe:
• Nome: Nome do serviço, é o nome único que identifique o serviço ao executar.
• Tipo de serviço: Informação de qual é o tipo serviço que está sendo disponibilizado.
  • Método java: São serviços previamente disponibilizados pela Edusoft que executarão processo/consultas no sistema. Clique aqui para verificar os serviços disponibilizados pela Edusoft.
  • Instrução SQL: São serviços que cadastrados com instruções SQLs. Que ao executar o serviço, será retornado os campos conforme a instrução feita. Clique aqui para verificar como montar o SQL.
    
  • Transformação Kettle: São anexados transformações Kettle (.ktr). Que ao executar o serviço, será executado os passos definidos no arquivo. Clique aqui para verificar como cadastrar.
    
  • Agendamento Kettle: São anexados agendamento Kettle (.kjb). Onde sua execução será agendada conforme definido no arquivo. Clique aqui para verificar como cadastrar.
    

• Tipo de operação: Qual a operação a ser executa:
• Consultar: Será um serviço que retorna um ou uma lista de itens. Disponível para método java e instrução SQL.
• Processo: Sistema processo as informações podendo não possuir retorno (Apenas para Método java).
  

• Comando:
• Quando “Método java” deve ser selecionado qual o serviço será utilizado.
• Quando “Instrução SQL” é aberto uma caixa de texto para adicionar o SQL.
  
• Quando “Transformação/Agendamento Kettle” anexo do arquivo correspondente ao processo (.ktr ou .kjb).
  

• Opções:
  • Parâmetros: Definição dos parâmetros que serão passados ao requisitar o serviço. (Exemplo: Parâmetros do SQL, Parâmetros do Método).
  • Campos de retornos: Definição do campo que contém a mensagem do erro quando a requisição não tiver sucesso. Também deve ser definidos os campos retornados quando a requisição for bem sucedida.
    
  • Step (Passo): Apenas quando Transformação/Agendamento Kettle que possuem algum passo que utiliza outra Transformação/Agendamento Kettle

• Tempo máximo: Tempo máximo que a instrução SQL pode demorar para executar.
• Ativo: ativa/desativar o item em questão do serviço, quando inativo não é possível executar este item.

No botão de ações, você pode ir para a tela inicial, gravar, incluir novo, clonar e excluir.

Documentação técnica (Acesso restrito)