FPAPI018 - Realiza a exportação das informações dos bancos de horas dos funcionários.

Documento de API

Objetivo

Realiza a exportação das informações dos bancos de horas dos funcionários.

A API fpapi018 deve ser executada de forma persistente.

Sintaxe para executar a API em modo persistente:

run prghur/fpp/fpapi018.p persistent set h-handle.

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

Nos atributos das tabelas temporárias de entrada e saída:

Tabela Temporária	Descrição	Entrada/Saída
tt-TimeAccountMovement	Contém informações dos bancos de horas dos funcionários	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
companyCode	Caracter	X(03)	Código da empresa	Sim	2.10
siteCode	Caracter	X(05)	Código do estabelecimento	Sim	2.10
registry	Inteiro	Zzzzzzz9	Código de matrícula do funcionário	Sim	2.10
movementDate	Data	dd/mm/aaaa	Data de ocorrência do banco de horas	Sim	2.10
timeAccountFlow	Inteiro	99	Tipo de compensação	Sim	2.10
amount	Inteiro	999999	Quantidade de horas do movimento de banco, em segundos	Sim	2.10
timeAccountType	Inteiro	Z9	Código do banco de horas	Sim	2.10
timeAccountDescription	Caracter	X(30)	Descrição do banco de horas	Sim	2.10

Tabela Temporária	Descrição	Entrada/Saída
tt-erro	Contém código e descrição do erro	Saída

Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

Método Básico

Requisito	Inexistente.
Sintaxe	run procedure piTimeAccountMovement in h-handle (output table tt-TimeAccountMovement, output table tt-erro).
Descrição	O método realizará a exportação de todos os registros de banco de horas de todos os funcionários da base de dados.
	Parâmetros	Descrição
	tt-TimeAccountMovent tt-erro	Temp-table de saída com as informações de banco de horas. Temp-table de saída que conterá os erros do processo.
Retorno	Temp-tables tt-TimeAccountMovent e tt-erro populadas. As mensagens possíveis para este método são: "Não existem movimentos de banco de horas cadastrados!"

Requisito			Inexistente.
Sintaxe			run procedure pifindMovementeByFlow in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, input p_tipo_movto, input p_tipo_banco, output table tt-TimeAccountMovement, output table tt-erro).
Descrição			O método realizará a exportação das informações de dos bancos de horas dos funcionários subordinados a determinado coordenador, com base na unidade de lotação.
			Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario p_tipo_movto p_tipo_banco tt-TimeAccountMovent tt-erro			Código da empresa do coordenador ou funcionário responsável. Código do estabelecimento do coordenador ou funcionário responsável Código de matrícula do coordenador ou funcionário responsável. Tipo de lançamento dos movimentos do banco de horas que se deseja exportar (a API soma + 1 para o tipo de compensação passado como parâmetro). Informar: 0 : para lançamentos positivos; 1 : para lançamentos negativos. Código do banco de horas que se deseja exportar. Temp-table de saída com as informações de banco de horas. Temp-table de saída que conterá os erros do processo.
Retorno		Temp-tables tt-TimeAccountMovent e tt-erro populadas. As mensagens possíveis para este método são: "Não existem movimentos de banco de horas para o tipo informado!".

Requisito			Inexistente.
Sintaxe			run procedure pifindMovementByCoo in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, output p_positiveAmount, output p_negativeAmount).
Descrição			O método realizará a exportação da quantidade de horas positivas e negativas de bancos de horas dos funcionários subordinados a determinado coordenador, com base na unidade de lotação.
			Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario p_positiveAmount p_negativeAmount			Código da empresa do coordenador ou funcionário responsável. Código do estabelecimento do coordenador ou funcionário responsável Código de matrícula do coordenador ou funcionário responsável. Quantidade de horas de banco positivas Quantidade de horas de banco negativas
Retorno		Variáveis p_positiveAmount e p_negativeAmount populadas.

Requisito			Executar o método pi-emptyfuncionario para garantir que não existam informações desnecessárias na temp-table tt-funcionario.
Sintaxe			run procedure pi-addfuncionario in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario).
Descrição			O método realizará a inclusão dos funcionários recebidos como parâmetro em uma temp table chamada tt-funcionario, que será utilizada para filtrar os funcionários que serão lidos no método pifindMovementeByFlowPeriod
			Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario			Código da empresa do funcionário. Código do estabelecimento do funcionário. Código de matrícula do funcionário.
Retorno		Essa procedure não retorna informações.

Requisito			Inexistente.
Sintaxe			run procedure pi-emptyfuncionario in h-handle.
Descrição			O método realizará a eliminação dos registros da temp table tt-funcionario, que é utilizada para filtrar os funcionários que serão lidos no método pifindMovementeByFlowPeriod
			Parâmetros	Descrição
	N.A.
Retorno		Essa procedure não retorna informações, apenas limpa tabela temporária tt-funcionario.

Requisito			Executar o método pi-addfuncionario para popular a temp-table tt-funcionario com os funcionários para os quais se deseja exportar as informações do banco de horas.
Sintaxe			run procedure pifindMovementeByFlowPeriod in h-handle (input p_tipo_movto, input p_tipo_banco, input p_dat_per_ini, input p_dat_per_fim, output table tt-TimeAccountMovement, output table tt-erro).
Descrição			O método realizará a exportação das informações do banco de horas dos funcionários subordinados a determinado coordenador, com base na unidade de lotação, que ocorreram em determinado período de data.
			Parâmetros	Descrição
	p_tipo_movto p_tipo_banco p_dat_per_ini p_dat_per_fim tt-TimeAccountMovent tt-erro			Tipo de lançamento dos movimentos do banco de horas que se deseja exportar (a API soma + 1 para o tipo de compensação passado como parâmetro). Informar: 0 : para lançamentos positivos; 1 : para lançamentos negativos. Código do banco de horas que se deseja exportar. Data inicial do período a ser considerado. Data final do período a ser considerado. Temp-table de saída com as informações de banco de horas. Temp-table de saída que conterá os erros do processo.
Retorno		Temp-tables tt-TimeAccountMovent e tt-erro populadas. As mensagens possíveis para este método são: "Não existem movimentos de banco de horas para o tipo/período informado!".

Método Negócio