Execução de Web Services

Os web services podem ser executados a partir de regras LSP, aplicação de terceiros ou depuração. Cada um desses formatos pode possuir suas próprias configurações e características.

Nota

Para mais informações sobre as regras LSP, acesse o manual da Tecnologia, selecione sua respectiva versão do Gestão de Pessoas | HCM na seção Tecnologia | XT e, através do menu (na lateral esquerda), acesse Ferramentas de Apoio > LSP - Linguagem Senior de Programação > Chamando um web service via Regra.

Tipos de execução

A seguir estão os quatro tipos possíveis de execução dos web services:

Local

Modo utilizado apenas para realizar testes e, no caso de web services customizados, para a depuração de regras LSP. O processamento da requisição ocorre na mesma instância do aplicativo, diretamente dentro do sistema, e é executado no mesmo momento da chamada.

Parâmetros para aplicação de terceiros	Permite uso em LSP?	O ambiente em que o sistema Senior está instalado deve possuir o Middleware?
Como a execução é local, não há alteração nos parâmetros utilizados.	Sim	Não

Síncrono

Ao executar, é enviada uma solicitação do servidor WildFly que gera uma instância do sistema Senior para processar a requisição. O processamento tem início no momento da chamada e o retorno é realizado pelo servidor WildFly.

Parâmetros para aplicação de terceiros	Permite uso em LSP?	O ambiente em que o sistema Senior está instalado deve possuir o Middleware?
Não aplicável	Sim	Sim

Assíncrono

Parâmetros para aplicação de terceiros	Permite uso em LSP?	O ambiente em que o sistema Senior está instalado deve possuir o Middleware?
Não aplicável	Sim	Sim

Agendado

A solicitação de execução será direcionada ao Middleware Senior, porém não ocorrerá no momento da requisição; ela será agendada para execução no Middleware. Os web services agendados ficam armazenados no WildFly, com o agendamento sendo gerido pelo web service ScheduledService. Esse serviço controla os agendamentos e mantém todas as informações criptografadas dos web services agendados.

Neste modo de execução, não há retorno da execução para o solicitante.

Parâmetros para aplicação de terceiros

Permite uso em LSP?

O ambiente em que o sistema Senior está instalado deve possuir o Middleware?

Nome	Preenchimento	Tipo	Descrição
id	Obrigatório	String	Identificador do serviço previamente agendado quando a operação for “Alterar” (operation = 1).
operation	Obrigatório	Integer	Operação a ser realizada: 0 = Adicionar: agenda um novo serviço; 1 = Alterar: altera o agendamento do serviço identificado pelo parâmetro “id”.
regularity	Obrigatório	Integer	Periodicidade de execução do serviço, indicando como deve ser tratado o intervalo (parâmetro “interval”): 0 = Executa apenas uma vez; 1 = O intervalo é medido em minutos; 2 = O intervalo é medido em horas; 3 = O intervalo é medido em dias; 4 = O intervalo é medido em semanas; 5 = O intervalo é medido em meses.
interval	Obrigatório	Integer	Intervalo de execução do serviço, conforme a periodicidade (parâmetro “regularity”).
initDate	Obrigatório	String	Data inicial de execução do serviço. Formato: DD/MM/YYYY.
initTime	Obrigatório	String	Hora inicial de execução do serviço. Formato: HH:MM:SS (24 horas).
fixedHour	Obrigatório	String	Hora em que o serviço deve ser executado, quando o parâmetro “regularity” for 3, 4 ou 5.
fixedDay	Obrigatório	Integer	Dia em que o serviço deve ser executado, quando o parâmetro “regularity” for 5.
weekDays	Obrigatório	String	Dias da semana em que o serviço deve ser executado, quando o parâmetro “regularity” for 4. Deve ser informada uma String com o valor decimal de todos os dias concatenados sem separador, em que “1” representa o domingo e “7” representa o sábado. Exemplo weekDays = “246” indica execução na segunda-feira, na quarta-feira e na sexta-feira.
execLate	Obrigatório	Boolean	Indica se o serviço pode ou não ser executado atrasado.
validDate	Obrigatório	String	Data de validade do serviço, indicando até quando ele pode ser executado. Formato: DD/MM/YYYY.
parameters	Obrigatório	Complex	Ver descrição na documentação das portas deste serviço.

Não, pois não é possível informar a periodicidade na regra.

Sim

Autenticação

Parâmetros para aplicação de terceiros quando houver autenticação
Nome	Preenchimento	Tipo	Descrição
user	Obrigatório	String	Nome do usuário para autenticação.
password	Obrigatório	String	Senha do usuário para autenticação.
encryption	Obrigatório	Integer	Versão de criptografia, podendo ser: 0 – Indica que usuário e senha trafegam como strings abertas no padrão “texto - utf8”; 1 – A senha é cifrada com um algoritmo próprio da Senior (não utilizável por sistemas terceiros); 2 – O serviço recebe um token Senior de autenticação no lugar da senha; 3 – O serviço recebe um token do serviço de usuários cloud (não utilizável por sistemas terceiros). Nota Para mais informações sobre o logon integrado com criptografia, acesse o manual da Tecnologia, selecione sua respectiva versão do Gestão de Pessoas \| HCM na seção Tecnologia \| XT e, através do menu (na lateral esquerda), acesse Manual de Instalação > Central de Configuração > Opções de segurança > Logon integrado com criptografia.

PORTAL DE DOCUMENTAÇÃO
Gestão de Pessoas \| HCM - versão 6.10.4