Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/fpp/fpapi041.p |
Objetivo
Retorna temp-table com os registros dos movimentos calculados.
Funcionamento
A API fpapi041 deve ser executada de forma persistente.
Sintaxe para executar a API em modo persistente:
run prghur/fpp/fpapi041.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-Divergence | Contém os registros dos pares de batidas dos colaboradores. | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
companyCode | Inteiro | Zz9 | Código da empresa | Sim | 2.10 |
siteCode | Inteiro | Zz9 | Código do estabelecimento | Sim | 2.10 |
registry | Inteiro | Zzzzzzz9 | Código de matrícula do funcionário | Sim | 2.10 |
processDate | Data | 99/99/9999 | Data de processo | Sim | 2.10 |
initalDate | Data | 99/99/9999 | Início da marcação | Sim | 2.10 |
endDate | Data | 99/99/9999 | Fim da marcação | Sim | 2.10 |
initialTime | Inteiro | -999999 | Hora do início do cálculo | Sim | 2.10 |
endTime | Inteiro | -999999 | Hora de fim do cálculo | Sim | 2.10 |
DivergenceTypeEnum | Inteiro | 99 | Tipo de ocorrência | Sim | 2.10 |
motiveCode | Inteiro | zzz9 | Observação | Não | 2.10 |
EmployeeSituationCode | Inteiro | Z9 | Situação de afastamento | Não | 2.10 |
eventCode | Caracter | x(03) | Evento | Não | 2.10 |
eventDescription | Caracter | x(30) | Descrição do evento | Não | 2.10 |
absenceBenefited | Lógico | Yes/no | Ausência justificada? | Sim | 2.10 |
timeAccount | Inteiro | Z9 | Tipo de compensação | Não | 2.10 |
Tabela Temporária | Descrição | Entrada/Saída |
tt-recordTime | Contém informações das marcações dos colaboradores. | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
recordDate | Data | 99/99/9999 | Data da batida | Sim | 2.10 |
processDate | Data | 99/99/9999 | Data de processo | Sim | 2.10 |
recordTime | Inteiro | 999999 | Horário | Sim | 2.10 |
recordFlow | Inteiro | 9 | Identificação | Sim | 2.10 |
source | Inteiro | 9 | Origem Batida | Sim | 2.10 |
Tabela Temporária | Descrição | Entrada/Saída |
tt-DayType | Contém os dias do período de ponto. | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
companyCode | Inteiro | Zz9 | Código da empresa | Sim | 2.10 |
siteCode | Inteiro | Zz9 | Código do estabelecimento | Sim | 2.10 |
Registry | Inteiro | Zzzzzzz9 | Código de matrícula do funcionário | Sim | 2.10 |
holidayDayCalendar | Data | 99/99/9999 | Data referência | Sim | 2.10 |
DayType | Caracter | x(02) | Tipo Dia | Sim | 2.10 |
HoursWork | Inteiro | >>>9 | Jornada de trabalho | Sim | 2.10 |
HoursInterv | Inteiro | >9 | Intervalo Refeição | Não | 2.10 |
statusDay | Caracter | x(1) | Dia justificado | Não | 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 autoriz_marcac
Requisito | Inexistente. | |
Sintaxe | run procedure autoriz_marcac in h-handle (input p_cdn_empresa, output p_log_permite_alter, output table tt-erro). | |
Descrição | O método retornará se é possível alterar batidas. | |
| Parâmetros | Descrição |
| p_cdn_empresa p_log_permite_alter tt-erro | Empresa Indica se é permitido alterar batidas Erros do processo. |
Retorno | Temp-table tt-erro populada quando houver erro. As mensagens possíveis para este método são: "Parâmetros do Ponto Eletrônico não encontrados!" |
procedure entrada_saida
Requisito | Inexistente. | |||
Sintaxe | run procedure entrada_saida in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, output p_bate_entr_saida, output table tt-erro). | |||
Descrição | O método retornará se determinado colaborador bate entrada e saída. | |||
| Parâmetros | Descrição | ||
| p_cdn_empresa p_cdn_estab p_cdn_funcionario p_bate_entr_saida tt-erro | Empresa Estabelecimento Matrícula Indica se o colaborador bate entrada e saída Erros do processo. | ||
Retorno | Temp-table tt-erro populada quando houver erro. As mensagens possíveis para este método são: "Funcionário Ponto Eletrônico não encontrado!" |
procedure marcac_ptoelet
Requisito | Inexistente. | |||
Sintaxe | run procedure marcac_ptoelet in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, input p_dat_inic_per, input p_dat_term_per, output tt-Divergence, output tt-recordTime, output tt-DayType, output table tt-erro). | |||
Descrição | O método retornará as marcações de ponto, divergências e os dias de período de ponto dos colaboradores. | |||
| Parâmetros | Descrição | ||
| p_cdn_empresa p_cdn_estab p_cdn_funcionario p_dat_inic_per p_dat_term_per tt-Divergence tt-recordTime tt-DayType tt-erro | Empresa Estabelecimento Matrícula Data de início do período Data de término do período Temp-table com os pares de batidas Temp-table com as marcações Temp-table com os dias do período de ponto Erros do processo. | ||
Retorno | Temp-tables tt-Divergence, tt-recordTime, tt-DayType e tt-erro populadas. As mensagens possíveis para este método são: "Funcionário Ponto Eletrônico não encontrado!" "Não existem marcações para este funcionário!" "Não foi encontrado calendário para este funcionário!" |
Método Negócio