Gestão de Pessoas - Manual do Usuário > Integrações com outros sistemas > Web services > Jurídico > Com.senior.g5.rh.jr.relatorios

Web service com.senior.g5.rh.jr.relatorios

Tipo de execução

Para cada tipo de execução, existem diferentes parâmetros que podem ser comuns a todas as portas.

Autenticação

Caso seja utilizada alguma forma de autenticação para integração de informações através de web services, é necessário identificado o tipo no parâmetro <encryption>, conforme seus valores possíveis.

WSDL

Porta

Relatorios

JR - Relatórios - Impressão

Necessita autenticação: Sim

Situação de versão: Atual

Versão: 1

Requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
  <soapenv:Body>
    <ser:Relatorios>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <prPrintDest>String</prPrintDest>
        <prRemetente>String</prRemetente>
        <prDir>String</prDir>
        <prExecFmt>String</prExecFmt>
        <prDest>String</prDest>
        <prFileName>String</prFileName>
        <prRelatorio>String</prRelatorio>
        <prCC>String</prCC>
        <prFileExt>String</prFileExt>
        <prEntrada>String</prEntrada>
        <prCCo>String</prCCo>
        <prUniqueFile>String</prUniqueFile>
        <prOrder>String</prOrder>
        <prAssunto>String</prAssunto>
        <prTypeBmp>String</prTypeBmp>
        <prRetorno>String</prRetorno>
        <prMensagem>String</prMensagem>
        <prFileLayout>String</prFileLayout>
        <prLOG>String</prLOG>
        <prAnexoBool>String</prAnexoBool>
        <prLayoutEXCEL>String</prLayoutEXCEL>
        <prLayoutSAGA>String</prLayoutSAGA>
        <prSaveFormat>String</prSaveFormat>
        <prEntranceIsXML>String</prEntranceIsXML>
      </parameters>
    </ser:Relatorios>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetros da requisição:

Nome Preenchimento Tipo Descrição
prPrintDest Opcional String Indica qual impressora será utilizada. Utilizar com o formato de saída: tefPrint
prRemetente Opcional String Indica o remetente do e-mail. Utilizar com o formato de saída: tefMail
prDir Opcional String Diretório em que será salvo o arquivo.
prExecFmt Opcional String Indica qual será o tipo de saída do modelo. Valores possíveis:
  • tefFile: Por arquivo;
  • tefMail: Por e-mail;
  • tefPrint: Enviado diretamente para a impressora.
prDest Opcional String Indica o destinatário do e-mail. Utilizar com o formato de saída: tefMail
prFileName Opcional String Nome do arquivo que será gerado.

Caso o nome possua pontos, é necessário incluir a extensão do arquivo ao nome. Por exemplo, um arquivo no formato PDF com o nome ponto.no.nome, deverá ser informado da seguinte maneira: ponto.no.nome.PDF.
prRelatorio Opcional String Nome do modelo (arquivo) que será utilizado para a execução do relatório.
prCC Opcional String Indica o endereço para cópia do e-mail. Utilizar com o formato de saída: tefMail
prFileExt Opcional String Indica a extensão do arquivo, este parâmetro não é obrigatório para execução via regra. Utilizar com o formato de saída: tefFile.
prEntrada Opcional String Parâmetros de entrada do relatório. Este parâmetro do serviço deve seguir a formatação adequada conforme o tipo de execução.

Para as regras LSP, não é recomendável que a tag XML <![CDATA[]]> seja utilizada para passagem de valores nos parâmetros de entrada. Pois, a sua utilização pode causar comportamentos indesejados, como por exemplo, a perda de dados.
prCCo Opcional String Indica o endereço de cópia oculta do e-mail. Utilizar com o formato de saída: tefMail
prUniqueFile Opcional String Indica se imagens serão geradas como uma imagem única. Valores possíveis:
  • S: Como imagem única;
  • N: Várias imagens.
prOrder Opcional String Define a ordenação que será utilizada na geração do relatório. Este parâmetro não está disponível para ser utilizado através da execução do web service via regra ou através da chamada via sistema de terceiros (síncrono ou assíncrono). Este parâmetro é utilizado apenas internamente para execução de um relatório, como, por exemplo, ao clicar no botão Imprimir de uma rotina específica, em que é possível determinar a ordenação do relatório na passagem dos parâmetros no código-fonte da rotina.
prAssunto Opcional String Assunto do e-mail. Utilizar com o formato de saída: tefMail
prTypeBmp Opcional String Indica se o tipo da imagem será Bitmap
prRetorno Opcional Blob Campo Blob para armazenamento do relatório.
prMensagem Opcional String Texto da Mensagem do e-mail. Utilizar com o formato de saída: tefMail. Para que seja feito envio do e-mail do relatório no formato HTML, sem quebra, acesse Central de Configurações Senior > Conexões de rede > Envio de e-mail e habilite as opções Utilizar SSL, Usar STARTTLS e o comando de inicialização EHLO.
prFileLayout Opcional String Indica o layout do arquivo.
prLOG Opcional String Indica o log do relatório.
prAnexoBool Opcional String Indica se o relatório será enviado como anexo ou corpo de mensagem:
  • T: Será como Anexo
  • F: Será como corpo da mensagem
Utilizar com o formato de saída: tefMail
prLayoutEXCEL Opcional String Layout utilizado quando o formato de saída for Excel.
prLayoutSAGA Opcional String Layout utilizado quando o formato de saída for Saga.
prSaveFormat Opcional String Indica o formato do arquivo salvo em arquivo. Valores possíveis:
  • tsfNormal: para IMP (valor padrão, caso não informado)
  • tsfCSV: para CSV
  • tsfBitMap: para Bitmap
  • tsfJPEG: para JPEG
  • tsfTextReportW : para Arquivo Texto Windows
  • tsfExportFileW: para Arquivo Exportação Windows
  • tsfTextReportD: para Arquivo Texto DOS
  • tsfExportFileD: para Arquivo Exportação DOS
  • tsfHTML: para HTML
  • tsfSaga: para Exportação Layout Saga
  • tsfFileExcel: para Exportação Layout Excel
  • tsfExcel: para Arquivo para Excel
  • tsfSpreadSheet: para Arquivo para Excel (Open XML)
  • tsfPDF: para Arquivo Formato PDF
  • tsfWordProcessing: para Documento do Word (Open XML)
Utilizar com o formato de saída: tefFile.
prEntranceIsXML Opcional String Indica se o parâmetro de entrada será na formatação XML (uso interno do sistema) ou na formatação aberta para regra.

Para a execução do web service de relatório via regra é necessário preencher o parâmetro prEntranceIsXML com o valor "F - Falso" e o parâmetro prEntrada, caso seja necessário, com a seguinte formatação: <nome_ variável1 =valor_variável1><nome_ variável2 =valor_variável2>. Por exemplo: <eCodEmp=1><eNumCad=12345>.

O valor "V - Verdadeiro" é restrito para uso dos sistemas.

Resposta:

Observação

Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
  <soapenv:Body>
    <ser:RelatoriosResponse>
      <result>
        <prRetorno>String</prRetorno>
        <prLOG>String</prLOG>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:RelatoriosResponse>
  </soapenv:Body>
</soapenv:Envelope>

Atributos da resposta:

Nome Preenchimento Tipo Descrição
erroExecucao Opcional String Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:
- Vazio ou nulo, indicando que a execução foi feita com sucesso;
- A mensagem do erro ocorrido no servidor.
prRetorno Opcional Blob Campo Blob para armazenamento do relatório
prLOG Opcional String  

Este artigo ajudou você?