Árvore de páginas

Carregando...

 

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 prghur/fpp/fpapi043.p

 

Objetivo

Realiza a alteração das divergências e o cálculo do ponto com as alterações efetuadas.

 

Funcionamento

A API fpapi043 deve ser executada de forma persistente.

Sintaxe para executar a API em modo persistente:

run prghur/fpp/fpapi043.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.

 

Tabelas Temporárias

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

 

Tabela Temporária

Descrição

Entrada/Saída

tt_marcac_ptoelet

Contém informações da marcação alterada e da alteração realizada.

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cdn_empresa

Inteiro

Zz9

Código da empresa

Sim

2.10

cdn_estab

Inteiro

Zz9

Código do estabelecimento

Sim

2.10

cdn_funcionario

Inteiro

Zzzzzzz9

Código de matrícula do funcionário

Sim

2.10

dat_proces

Data

dd/mm/aaaa

Data de processo da marcação/batida

Sim

2.10

num_hora

Inteiro

999999

Nova hora da marcação/batida (em segundos)

Sim

2.10

num_hora_antiga

Inteiro

999999

Hora da marcação/batida original (em segundos)

Sim

2.10

Identific

Inteiro

9

Identificação de operação a realizar com a marcação/batida (0-inclui, 1-modifica, 2-elimina)

Sim

2.10

dat_batida

Data

dd/mm/aaaa

Data de ocorrência da marcação/batida

Sim

2.10

idi_entr_sai

Inteiro

9

Identificação de Entrada/Saída da marcação/batida

Sim

2.10

Tabela Temporária

Descrição

Entrada/Saída

tt_par_marcac_ptoelet

Contém informações dos pares de ocorrências alterados e das alterações realizadas.

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cdn_empresa

Inteiro

Zz9

Código da empresa

Sim

2.10

cdn_estab

Inteiro

Zz9

Código do estabelecimento

Sim

2.10

cdn_funcionario

Inteiro

Zzzzzzz9

Código de matrícula do funcionário

Sim

2.10

num_horar_inic_mpe

Inteiro

999999

Hora início da ocorrência (em segundos)

Sim

2.10

num_horar_term_mpe

Inteiro

999999

Hora término da ocorrência (em segundos)

Sim

2.10

cdn_ocor

Inteiro

99

Tipo da ocorrência original

Sim

2.10

cdn_tip_comp

Inteiro

99

Tipo de compensação (a ser utilizado quando for gerada uma autorização prévia de horas extras)

Não

2.10

cdn_bat

Inteiro

99

Tipo da ocorrência após alteração

Sim

2.10

dat_batida

Inteiro

Dd/mm/aaaa

Data de início da ocorrência

Sim

2.10

num_horar_inic_proces_mpe

Inteiro

999999

Hora de início de cálculo da ocorrência (em segundos)*

Não

2.10

num_horar_fim_proces_mpe

Inteiro

999999

Hora de término de cálculo da ocorrência (em segundos)*

Não

2.10

cdn_sitpto

Inteiro

Z9

Nova situação de afastamento da ocorrência

Não

2.10

cdn_ponto

Inteiro

Z9

Antiga situação de afastamento da ocorrência

Não

2.10

cdn_motivo

Inteiro

Zzz9

Motivo da autorização prévia de horas extras

Não

2.10

log_quebra

Lógico

Yes/No

Indica se existiu quebra no par

Sim

2.10

dat_proces_mpe

Data

Dd/mm/aaaa

Data de processo da ocorrência

Sim

2.10

*Estes campos não são obrigatórios, pois são calculados dentro da própria API.

 

Tabela Temporária

Descrição

Entrada/Saída

tt_quebra_par

Contém informações dos pares de ocorrências quebrados e das novas quebras realizadas.

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cdn_empresa

Inteiro

Zz9

Código da empresa

Sim

2.10

cdn_estab

Inteiro

Zz9

Código do estabelecimento

Sim

2.10

cdn_funcionario

Inteiro

Zzzzzzz9

Código de matrícula do funcionário

Sim

2.10

dat_proces_mpe

Data

Dd/mm/aaaa

Data de processo da ocorrência

Sim

2.10

num_hora_ini

Inteiro

999999

Hora de início da quebra do par (em segundos)

Sim

2.10

num_hora_fim

Inteiro

999999

Hora de término da quebra do par (em segundos)

Sim

2.10

Tabela Temporária

Descrição

Entrada/Saída

tt-erro

Contém código e descrição do erro

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

Code

Inteiro

Zz9

Código do erro

Sim

2.10

Description

Caracter

X(60)

Descrição do erro

Sim

2.10

 

Métodos

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

 

Método Básico

procedure pi_cria_tt_marcac_ptoelet

Requisito

Inexistente.

Sintaxe

run procedure pi_cria_tt_marcac_ptoelet in h-handle

(input p_cdn_empresa,

 Input p_cdn_estab,

 Input p_cdn_funcionario,

 Input p_dat_proces,

 Input p_num_hora,

 Input p_num_hora_antiga,

 Input p_identific,

 Input p_dat_batida,

 Input p_idi_entr_sai).

Descrição

O método realizará a alteração na marcação conforme o parâmetro de identificação enviado (inclusão, alteração ou eliminação de batida).

 

Parâmetros

Descrição

 

p_cdn_empresa

p_cdn_estab

p_cdn_funcionario

p_dat_proces

p_num_hora

p_num_hora_antiga

p_identific

p_dat_batida

p_idi_entr_sai

tt-erro

Código da empresa do funcionário.

Código do estabelecimento.

Código de matrícula do funcionário.

Data de processo da marcação/batida

Nova hora da marcação/batida (em segundos)

Hora da marcação/batida original (em segundos)

Identificação de operação a realizar com a marcação/batida (0-inclui, 1-modifica, 2-elimina).

Data de ocorrência da marcação/batida

Identificação de Entrada/Saída da marcação/batida

Temp-table de saída que conterá os erros do processo.

Retorno

Temp-tables tt_marcac_ptoelet e tt-erro populadas.

As mensagens possíveis para este método são:

"Não existe funcionário ponto com os dados informados."

procedure pi_cria_tt_par_marcac_ptoelet

Requisito

Inexistente.

Sintaxe

run procedure pi_cria_tt_par_marcac_ptoelet in h-handle

(input p_cdn_empresa,

 input p_cdn_estab,

 input p_cdn_funcionario,

 input v_num_hra_ini,

 input v_num_hra_fim,

 input v_cdn_ocor,

 input v_cdn_tip_comp,

 input v_cdn_bat,

 input v_dat_batida,

 input v_cdn_sitpto,

 input v_cdn_ponto,

 input v_cdn_motivo,

 input v_log_quebra,

 input v_dat_proces,

 output table tt-erro).

Descrição

O método realizará a alteração no par de ocorrência.

 

Parâmetros

Descrição

 

p_cdn_empresa

p_cdn_estab

p_cdn_funcionario

v_num_hra_ini

v_num_hra_fim

v_cdn_ocor

v_cdn_tip_comp

 

v_cdn_bat

v_dat_batida

v_cdn_sitpto

v_cdn_ponto

v_cdn_motivo

v_log_quebra

v_dat_proces

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.

Hora início da ocorrência (em segundos)

Hora término da ocorrência (em segundos)

Tipo da ocorrência original.

Tipo de compensação (a ser utilizado quando for gerada uma autorização prévia de horas extras)

Tipo da ocorrência após alteração

Data de início da ocorrência

Nova situação de afastamento da ocorrência

Antiga situação de afastamento da ocorrência

Motivo da autorização prévia de horas extras

Indica se existiu quebra no par

Data de processo da ocorrência

Temp-table de saída que conterá os erros do processo.

Retorno

Temp-tables tt_par_marcac_ptoelet e tt-erro populadas.

As mensagens possíveis para este método são:

"Não existe funcionário ponto com os dados informados.".

procedure pi_cria_tt_quebra_par

Requisito

Inexistente.

Sintaxe

run procedure pi_cria_tt_quebra_par in h-handle

(input p_cdn_empresa,

 input p_cdn_estab,

 input p_cdn_funcionario,

 input v_dat_processo,

 input v_num_hra_ini,

 input v_num_hra_fim).

 

Descrição

O método realizará a quebra do par de ocorrências.

 

Parâmetros

Descrição

 

p_cdn_empresa

p_cdn_estab

p_cdn_funcionario

v_dat_processo

v_num_hra_ini

v_num_hra_fim

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.

Data de processo da ocorrência.

Hora de início da quebra do par (em segundos).

Hora de término da quebra do par (em segundos).

Temp-table de saída que conterá os erros do processo.

Retorno

Temp-tables tt_quebra_par e tt-erro populadas.

As mensagens possíveis para este método são:

"Não existe funcionário ponto com os dados informados.".

 

Método Negócio

Não há método de negócio disponível nesta api.