Árvore de páginas

 

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 prghur/pep/pepapi006.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 pepapi006 deve ser executada de forma persistente.

Sintaxe para executar a API em modo persistente:

run prghur/fpp/pepapi006.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_justif_func

Contém informações das justificativas

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cdn_empresa

like func_ptoelet.cdn_empresa

like func_ptoelet.cdn_empresa

Código da empresa do funcionário

Sim

TOTVS 11.2.1

cdn_estab

like func_ptoelet.cdn_estab

like func_ptoelet.cdn_estab

Código do estabelecimento do funcionário

Sim

TOTVS 11.2.1

cdn_funcionario

like func_ptoelet.cdn_funcionario

like func_ptoelet.cdn_funcionario

Código de matrícula do funcionário

Sim

TOTVS 11.2.1

des_tip_justif

Caracter

x(12)

Descrição do tipo de justificativa

Sim

TOTVS 11.2.1

dat_justif_func

Data

99/99/9999

Data da justificativa

Sim

TOTVS 11.2.1

num_horar_inic_justif

like par_marcac_ptoelet.num_horar_inic_proces_mpe

like par_marcac_ptoelet.num_horar_inic_proces_mpe

Horário de início da justificativa em segundos

Sim

TOTVS 11.2.1

num_horar_term_justif

like par_marcac_ptoelet.num_horar_fim_proces_mpe

like par_marcac_ptoelet.num_horar_fim_proces_mpe

Horário de término da justificativa em segundos

Sim

TOTVS 11.2.1

des_sentido_marcacao

Caracter

X(20)

Descrição do sentido da marcação relacionada a justificativa onde as opções são Entrada e Saída.

Não

TOTVS 11.2.1

des_sit_motiv_justif

like sit_afast.des_sit_afast

like sit_afast.des_sit_afast

Descrição do motivo para as justificativas do tipo Marcação ou Autorização e Descrição da situação de afastamento para as justificativas do tipo afastamento

Não

TOTVS 11.2.1

des_status_justif

Caracter

X(11)

Descrição do status de aprovação da justificativa.

Não

TOTVS 11.2.1

idi_status_justif

Inteiro

9

Indicador do status de aprovação da justificativa

Não

TOTVS 11.2.1

   

Tabela Temporária

Descrição

Entrada/Saída

tt_qtd_justif_coord

Contém informações da quantidade de justificativas com o coordenador

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cdn_empresa

like func_ptoelet.cdn_empresa

like func_ptoelet.cdn_empresa

Código da empresa do funcionário

Sim

TOTVS 11.2.1

cdn_estab

like func_ptoelet.cdn_estab

like func_ptoelet.cdn_estab

Código do estabelecimento do funcionário

Sim

TOTVS 11.2.1

cdn_funcionario

like func_ptoelet.cdn_funcionario

like func_ptoelet.cdn_funcionario

Código de matrícula do funcionário

Sim

TOTVS 11.2.1

qti_justificadas

Inteiro

99999

Quantidade de Justificativas de ponto implementadas pelos colaboradores sem nehuma ação de aprovação

Não

TOTVS 11.2.1

qti_aprovadas

Inteiro

99999

Quantidade de Justificativas de ponto implementadas pelos colaboradores aprovadas pelo Coordenador ou pelo RH.

Não

TOTVS 11.2.1

qti_reprovadas

Inteiro

99999

Quantidade de Justificativas de ponto implementadas pelos colaboradores Reprovadas pelo Coordenador ou pelo RH.

Não

TOTVS 11.2.1

   

Tabela Temporária

Descrição

Entrada/Saída

tt_qtd_justif_rh

Contém informações da quantidade de justificativas com o RH

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cdn_empresa

like func_ptoelet.cdn_empresa

like func_ptoelet.cdn_empresa

Código da empresa do funcionário

Sim

TOTVS 11.2.1

cdn_estab

like func_ptoelet.cdn_estab

like func_ptoelet.cdn_estab

Código do estabelecimento do funcionário

Sim

TOTVS 11.2.1

cdn_funcionario

like func_ptoelet.cdn_funcionario

like func_ptoelet.cdn_funcionario

Código de matrícula do funcionário

Sim

TOTVS 11.2.1

qti_justificadas

Inteiro

99999

Quantidade de Justificativas de ponto implementadas pelos colaboradores sem nehuma ação de aprovação

Não

TOTVS 11.2.1

qti_aprovadas

Inteiro

99999

Quantidade de Justificativas de ponto implementadas pelos colaboradores aprovadas pelo Coordenador ou pelo RH.

Não

TOTVS 11.2.1

qti_reprovadas

Inteiro

99999

Quantidade de Justificativas de ponto implementadas pelos colaboradores Reprovadas pelo Coordenador ou pelo RH.

Não

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_mostra_justif_colab

Requisito

Inexistente.

Sintaxe

run procedure pi_mostra_justif_colab in h-handle

(input p_cdn_empresa,

input p_cdn_estab,

input p_cdn_funcionario,

output table tt_erros,

output table tt_justif_func.).

Descrição

Mostra o detalhe das justificativas de ponto incluídas pelo Colaborador via Portal HCM, indicando o status de Aprovação das mesmas.

 

Parâmetros

Descrição

 

tt_justif_func

Tabela temporária com os registros de justificativas.

Retorno

Temp-table tt_justif_func populada.

procedure pi_mostra_justif_coord

Requisito

Inexistente.

Sintaxe

run procedure pi_mostra_justif_coord in h-handle

(input p_cdn_empresa,

input p_cdn_estab,

input p_cdn_funcionario,

output table tt_erros,

output table tt_justif_func.).

Descrição

Mostra o detalhe das justificativas de ponto inclu¡das via Portal HCM pelos colaboradores subordinados do Coordenador, conforme as suas permissões de acesso defininidas para o seu papel de Coordenador, indicando o status de aprovação das mesmas.

 

Parâmetros

Descrição

 

tt_justif_func

Tabela temporária com os registros de justificativas.

Retorno

Temp-table tt_justif_func populada.

procedure pi_mostra_justif_rh

Requisito

Inexistente.

Sintaxe

run procedure pi_mostra_justif_rh in h-handle

(input p_cdn_empresa,

input p_cdn_estab,

input p_cdn_funcionario,

output table tt_erros,

output table tt_justif_func.).

Descrição

Mostra o detalhe das justificativas de ponto inclu¡das via Portal HCM pelos colaboradores dos Estabelecimentos onde o usu rio de RH tem permissão de acesso, indicando o status de aprovação das mesmas.

 

Parâmetros

Descrição

 

tt_justif_func

Tabela temporária com os registros de justificativas.

Retorno

Temp-table tt_justif_func populada.

procedure pi_conta_justif_coord

Requisito

Inexistente.

Sintaxe

run procedure pi_conta_justif_coord in h-handle

(input p_cdn_empresa,

input p_cdn_estab,

input p_cdn_funcionario,

output table tt_qtd_justif_coord.).

Descrição

Mostra a quantidade de justificativas implementadas pelos colaboradores subordinados do coordenador com a indicação do status de aprovação das mesmas.

 

Parâmetros

Descrição

 

tt_qtd_justif_coord

Tabela temporária com os registros da quantidade de justificativas de coordenador.

Retorno

Temp-table tt_qtd_justif_coord populada.

procedure pi_conta_justif_rh

Requisito

Inexistente.

Sintaxe

run procedure pi_conta_justif_rh in h-handle

(input p_cdn_empresa,

input p_cdn_estab,

input p_cdn_funcionario,

output table tt_qtd_justif_rh.).

Descrição

Mostra a quantidade de justificativas implementadas pelos colaboradores dos estabelecimentos cujo usuário do RH tem permissão de acesso, com a indicação do status de aprovação das mesmas

 

Parâmetros

Descrição

 

tt_qtd_justif_rh

Tabela temporária com os registros da quantidade de justificativas de RH.

Retorno

Temp-table tt_qtd_justif_rh populada.

procedure pi_recebe_func_atualiza_justif_func

Requisito

Inexistente.

Sintaxe

run procedure pi_recebe_func_atualiza_justif_func in h-handle

(input p_cdn_empresa,

input p_cdn_estab,

input p_cdn_funcionario,

input p_des_tip_justif,

input p_dat_justif_func,

input p_num_horar_inic_justif,

input p_num_horar_term_justif,

input p_idi_status_justif,

output table tt_erros.).

Descrição

Recebe através de parâmetros as informações da Justificativa de Ponto aprovada/reprovada ou encerrada pelo Coordenador ou usuário do RH e monta a temp-table tt_justif_func que será utilizada na pi_atualiza_justif_func para localizar no progress o registro de marcação, autorização de hora extra ou situação de afastamento correspondente para atualizar ou eliminar conforme ação determinada no portal HCM.

 

Parâmetros

Descrição

 

p_cdn_empresa

p_cdn_estab

p_cdn_funcionario

p_des_tip_justif

p_dat_justif_func

p_num_horar_inic_justif

p_num_horar_term_justif

p_idi_status_justif

tt_erros

Parâmetro com código da empresa

Parâmetro com código do estabelecimento

Parâmetro com código do funcionário

Parámetro com descrição do tipo de justificativa

Parámetro com data da justificativa

Parâmetro com horário de início da justificativa

Parâmetro com horário de término da justificativa

Parâmetro com o status da justificativa.

Tabela temporária com as informações dos erros ocorridos.

Retorno

Temp-table tt_justif_func populada.


Método Negócio

Não há método de negócio disponível nesta api.