Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/pep/pepapi005.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 pepapi005 deve ser executada de forma persistente.
Sintaxe para executar a API em modo persistente:
run prghur/fpp/pepapi005.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_tip_compensacao | Contém informações das tipos de compensação | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cdn_tip_compensacao | Inteiro | 99999999 | Código do tipo de compensação | Sim | TOTVS 11.2.1 |
des_tip_compensacao | Caracter | Char x(20) | Descrição do tipo de compensação | Sim | TOTVS 11.2.1 |
Tabela Temporária | Descrição | Entrada/Saída |
tt_motivo_autorizacao | Contém informações dos motivos das autorizações | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cdn_motiv_autorizacao | Inteiro | 99999999 | Código do motivo da autorização | Sim | TOTVS 11.2.1 |
des_motiv_autorizacao | Caracter | Char x(20) | Descrição do motivo da autorização | Sim | TOTVS 11.2.1 |
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 | 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_tipo_compensacao
Requisito | Inexistente. | |
Sintaxe | run procedure pi_retorna_tipo_compensacao in h-handle (output table tt_tip_compensacao). | |
Descrição | Retorna a lista de tipos de compensação de autorizações de Hora Extra para utilização no processo de justificativas de ponto do funcionário via Portal HCM. | |
| Parâmetros | Descrição |
| tt_tip_compensacao | Tabela temporária com os registros de tipo de compensação. |
Retorno | Temp-table tt_tip_compensacao populada. |
procedure pi_retorna_motivo_autorizacao
Requisito | Inexistente. | |
Sintaxe | run procedure pi_retorna_motivo_autorizacao in h-handle (input p_cdn_empresa, output table tt_motivo_autorizacao). | |
Descrição | Retorna a lista de motivos de inclusão de autorizações de Hora Extra para utilização no processo de justificativas de ponto do funcionário via Portal HCM. | |
| Parâmetros | Descrição |
| tt_motivo_autorizacao | Tabela temporária com os registros dos motivos de autorização. |
Retorno | Temp-table tt_motivo_autorizacao populada. |
procedure pi_incluir_autoriz_horas
Requisito | Inexistente. | |
Sintaxe | run procedure pi_incluir_autoriz_horasin h-handle (input p_cdn_empresa, Input p_cdn_estab, Input p_cdn_funcionario, Input p_hra_inic_autoriz, input p_dat_inic_autoriz, input p_hra_term_autoriz, input p_dat_term_autoriz, input p_idi_tip_autoriz, input p_cdn_tip_compcao, input p_cdn_obs_func, output table tt-erro). | |
Descrição | Incluir autorização de Hora para a Justificativa deste tipo justificativa informada pelo funcionário via Portal. Nesta PI, atribuído conteúdo para a variável c-dados com as informações de autorizações de hora PE3030, que foi preparado para verificar se está sendo chamado via Portal e, neste caso, assumir o conteúdo c-dados passado via parâmetro em vez de ler o arquivo de importação padrão. | |
| Parâmetros | Descrição |
| tt-erro | Tabela temporária com os registros dos erros decorrentes desta operação. |
Retorno | Temp-table tt_motivo_autorizacao populada. |
Método Negócio