Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prghur/pep/pepapi008.p |
Objetivo
API para efetuar a inclusão de situação de afastamento informadas pelo funcionário no processo de Justificativas de Ponto no Portal via execução do programa de geração Coletiva de Situações PE1610.
Funcionamento
A API pepapi008 deve ser executada de forma persistente.
Sintaxe para executar a API em modo persistente:
run prghur/fpp/pepapi008.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_sit_afast | Contém informações das situações de afastamento | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cdn_sit_afast | Inteiro | 999 | Código da situação de afastamento | Sim | TOTVS 11.2.1 |
des_motiv_marcacao | Caracter | X(20) | Descrição da situação de afastamento | Sim | TOTVS 11.2.1 |
des_tip_justif | Caracter | X(20) | Descrição do tipo de justificativa | 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_sit_afast
Requisito | Inexistente. | |
Sintaxe | run procedure pi_retorna_sit_afast in h-handle (output table tt_sit_afast.). | |
Descrição | Retorna a lista de Situações de Afastamento relacionadas as situações específicas do Ponto (PE0040) para utilização no processo de Justificativas de Ponto do funcionário via Portal HCM. | |
| Parâmetros | Descrição |
| tt_sit_afast | Tabela temporária com os registros das situações de afastamento. |
Retorno | Temp-table tt_motivo_marcacao. |
procedure pi_incluir_sit_afast
Requisito | Inexistente. | |
Sintaxe | run procedure pi_incluir_sit_afast in h-handle (input p_cdn_empresa, input p_cdn_estab, input p_cdn_funcionario, input p_cdn_sit_afast, input p_cod_cid, input p_dat_inic_sit_afast, input p_dat_term_sit_afast, input p_hra_inic_sit_afast, input p_hra_term_sit_afast, output table tt_erros.). | |
Descrição | Incluir Situação de Afastamento para a Justificativa deste tipo justificativa informada pelo funcionário via Portal. É criada tt-digita e tt-param contendo as informações vindas do Portal e ‚ chamada a execução do programa de Geração Coletiva de Situações PE1610RP.p que foi preparado para verificar se está sendo chamado via Portal e neste caso assumir este conteúdo passado via parâmetro em vez da seleção e digitação efetuada no PE1610.w. | |
| Parâmetros | Descrição |
| tt_erros | Tabela temporária com os registros dos erros ocorridos no processo. |
Retorno |
|
Método Negócio