Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/fpp/fpapi030.p |
Objetivo
Realiza a exportação das jornadas de trabalho e intervalos.
Funcionamento
A API fpapi030 deve ser executada de forma persistente.
run prghur/fpp/fpapi030.p persistent set h-handle.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
Tabela Temporária | Descrição | Entrada/Saída |
tt-HoursWork | Contém informações das jornadas de trabalho | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
codeHoursWork | Inteiro | Zzz9 | Código da Jornada | Sim | 2.10 |
descriptionHoursWork | Caracter | X(30) | Descrição da jornada | Sim | 2.10 |
initialFirstPeriodHoursWork | Inteiro | 999999 | Horário de início da jornada | Sim | 2.10 |
endFirstPeriodHoursWork | Inteiro | 999999 | Horário de fim da jornada | Sim | 2.10 |
Tabela Temporária | Descrição | Entrada/Saída |
tt-HoursInterval | Contém informações dos intervalos | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
orderHoursWorkInterval | Inteiro | 99 | Código da Jornada | Sim | 2.10 |
intervalType | Inteiro | 99 | Descrição da jornada | Sim | 2.10 |
codeHoursWork | Inteiro | Zzz9 | Código da Jornada | Sim | 2.10 |
codeHoursInterval | Inteiro | Z9 | Código do intervalo | Sim | 2.10 |
initialIntervalHoursInterval | Inteiro | 999999 | Horário de início do intervalo | Sim | 2.10 |
endIntervalHoursInterval | Inteiro | 999999 | Horário de fim do intervalo | 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 piHoursWork
Requisito | Inexistente. | |
Sintaxe | run procedure piHoursWork in h-handle (output table tt-HoursWork, output table tt-HoursInterval, output table tt-erro). | |
Descrição | O método retornará o cadastro de jornadas e intervalos. | |
| Parâmetros | Descrição |
| tt-HoursWork tt-HoursInterval tt-erro | Temp-table com o cadastro de jornadas Temp-table com o cadastro de intervalos Erros do processo. |
Retorno | Temp-tables tt-erro, tt-HoursInterval e tt-HoursWork populadas. As mensagens possíveis para este método são: "Não existem jornadas cadastradas!" |
Método Negócio