Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/pep/pepapi007.p |
Objetivo
API para efetuar a inclusão de Autorizações de Horas informadas pelo funcionário no processo de Justificativas de Ponto no Portal, atualizando as informações no PE3000 via execução do programa de importação de autorizações PE3030.
Funcionamento
A API pepapi007 deve ser executada de forma persistente.
Sintaxe para executar a API em modo persistente:
run prghur/fpp/pepapi007.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_motivo_marcacao | Contém informações de motivos de justificativas | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cdn_motiv_marcacao | Inteiro | 999 | Código do motivo da marcação | Sim | TOTVS 11.2.1 |
des_motiv_marcacao | Caracter | X(20) | Descrição do motivo da marcação | Sim | TOTVS 11.2.1 |
Tabela Temporária | Descrição | Entrada/Saída |
Tt_erros | Contém código e descrição do erro | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
Code | Inteiro | 999 | Código do erro | Sim | TOTVS 11.2.1 |
Description | Caracter | X(60) | Descrição do erro | Sim | TOTVS 11.2.1 |
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_retorna_motivo_marcacao
Requisito | Inexistente. | |
Sintaxe | run procedure pi_retorna_motivo_marcacao in h-handle (input p_cdn_empresa, output table tt_motivo_marcacao.). | |
Descrição | Retorna a lista de motivos de marcação de Ponto para utilização no processo de Justificativas de Ponto do funcionário via Portal HCM. | |
| Parâmetros | Descrição |
| p_cdn_empresa tt_motivo_marcacao | Parâmetro com a empresa. Tabela temporária com os registros dos motivos de marcação. |
Retorno | Temp-table tt_motivo_marcacao. |
procedure pi_incluir_marcac_ptoelet
Requisito | Inexistente. | |
Sintaxe | run procedure pi_incluir_marcac_ptoelet in h-handle (input p_cdn_empresa, Input p_cdn_estab, Input p_cdn_funcionario, Input p_dat_marcac, Input p_hra_marcac, Input p_idi_sentido_marcac, Input p_cdn_motiv_marcac, output table tt_erros.). | |
Descrição | Incluir marcação de Ponto para a Justificativa deste tipo justificativa informada pelo funcionário via Portal. É atribuído conteúdo para a variável c-dados com as informações vindas do Portal e ‚ chamdada a execução do programa de importação de autorizações de hora PE3030 que foi preparado para verificar se está sendo chamado via Portal e neste caso assumir o conteúdo da c-dados passada via parametro em vez de ler um arquivo de importação padrão. | |
| Parâmetros | Descrição |
| p_cdn_empresa p_cdn_estab p_cdn_funcionario p_dat_marcac p_hra_marcac p_idi_sentido_marcac p_cdn_motiv_marcac tt_erros | Parâmetro com a empresa. Parâmetro com o estabelecimento. Parâmetro com código de matrícula do funcionário. Parâmetro com a data da marcação. Parâmetro com a hora da marcação. Parâmetro com o sentido da marcação. Parâmetro com o código do motivo da marcação. Tabela com os erros encontrados no processo. |
Retorno |
|
Método Negócio