PEPAPI004 - Retorna ocorrências para portlet de colaborador.

Documento de API

Produto:	Datasul
Ocorrência:	Documentação de API
Nome Físico	prghur/pep/pepapi004.p

Objetivo

Retornar a quantidade de ocorrências de ponto do colaborar existentes para o período de ponto vigente e demais informações necessárias para compor as telas de justificativas do ponto, entre elas Dias do Período, lista das batidas de ponto e lista das ocorrências de ponto.

Funcionamento

A API pepapi004 deve ser executada de forma persistente.

Sintaxe para executar a API em modo persistente:

run prghur/fpp/pepapi004.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_qtd_ocor_func	Contém informações das ocorrências do colaborador	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	Sim	TOTVS 11.2.1
cdn_estab	Like func_ptoelet.cdn_estab	Like func_ptoelet.cdn_estab	Código do estabelecimento	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
field qti_he_nautoriz	Inteiro	999999999	Quantidade de horas extras não autorizadas, em segundos.	Não	TOTVS 11.2.1
qti_faltas	Inteiro	999999999	Quantidade de dias com falta durante o período de ponto	Não	TOTVS 11.2.1
qti_atrasos	Inteiro	999999999	Quantidade de ocorrências de atrasos durante o período de ponto	Não	TOTVS 11.2.1
qti_batidas_sem_par	Inteiro	999999999	Quantidade de dias com batida sem par durante o período de ponto.	Não	TOTVS 11.2.1
qti_ocorr_nao_aprov	Inteiro	999999999	Quantidade de ocorrências ainda não aprovadas pelo gestor responsável	Não	TOTVS 11.2.1

Tabela Temporária	Descrição	Entrada/Saída
tt_dias_periodo_ponto_func	Contém informações dos dias do período de ponto do colaborador	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	Sim	TOTVS 11.2.1
cdn_estab	Like func_ptoelet.cdn_estab	Like func_ptoelet.cdn_estab	Código do estabelecimento	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
dat_proces	Data	99/99/9999	Data de processo referente ao dia do cálculo do ponto do funcionário”	Sim	TOTVS 11.2.1
log_calculado	Lógico	Yes/No	Indica se para esta data o cálculo do ponto está ou não efetuado	Sim	TOTVS 11.2.1
des_dia_semana	Caracter	X(07)	Dia da semana	Sim	TOTVS 11.2.1
cod_tip_dia	Caracter	X(02)	Tipo de dia de acordo com o calendário do turno/turma/localidade do funcionário	Sim	TOTVS 11.2.1

Tabela Temporária	Descrição	Entrada/Saída
tt_marcacoes_func	Contém informações das marcações do colaborador	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	Sim	TOTVS 11.2.1
cdn_estab	Like func_ptoelet.cdn_estab	Like func_ptoelet.cdn_estab	Código do estabelecimento	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
dat_marcacao	like marcac_ptoelet.num_horar_marcac_ptoelet	like marcac_ptoelet.num_horar_marcac_ptoelet	Data em que a marcação foi efetuada	Sim	TOTVS 11.2.1
num_horar_marcacao	Inteiro	99999999	Horário da marcação em segundos	Sim	TOTVS 11.2.1
idi_sentido_marcacao	like marcac_ptoelet.idi_marcac_ptoelet_entr_saida	like marcac_ptoelet.idi_marcac_ptoelet_entr_saida	Indicador do sentido da marcação	Não	TOTVS 11.2.1
idi_origem_marcacao	like marcac_ptoelet.idi_orig_marcac_ptoelet	like marcac_ptoelet.idi_orig_marcac_ptoelet	Indicador da origem da marcação	Sim	TOTVS 11.2.1
idi_sit_marcacao	like marcac_ptoelet.idi_status_	like marcac_ptoelet.idi_status_	Indicador do status da situação da marcação	Não	TOTVS 11.2.1
cdn_motiv_marcacao	like marcac_ptoelet.cdn_motiv_marcac	like marcac_ptoelet.cdn_motiv_marcac	Código do motivo/justificativa da marcação	Não	TOTVS 11.2.1

Tabela Temporária	Descrição	Entrada/Saída
tt_ocor_ponto_func	Contém informações das ocorrências do colaborador	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	Sim	TOTVS 11.2.1
cdn_estab	Like func_ptoelet.cdn_estab	Like func_ptoelet.cdn_estab	Código do estabelecimento	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
dat_proces_mpe	like par_marcac_ptoelet.dat_proces_mpe	like par_marcac_ptoelet.dat_proces_mpe	Data de processo da ocorrência	Sim	TOTVS 11.2.1
idi_tip_ocor_mpe	like par_marcac_ptoelet.idi_tip_ocor_mpe	like par_marcac_ptoelet.idi_tip_ocor_mpe	Identificador do tipo da ocorrência do funcionário	Sim	TOTVS 11.2.1
des_tip_ocor_mpe	Caracter	X(20)	Descrição da Ocorrência do Funcionário	Sim	TOTVS 11.2.1
num_horar_inic_proces	like par_marcac_ptoelet.num_horar_inic_proces_mpe	like par_marcac_ptoelet.num_horar_inic_proces_mpe	Horário de início da ocorrência em segundos.	Sim	TOTVS 11.2.1
num_horar_fim_proces	like par_marcac_ptoelet.num_horar_fim_proces_mpe	like par_marcac_ptoelet.num_horar_fim_proces_mpe	Horário de término da ocorrência em segundos.	Sim	TOTVS 11.2.1
qti_segundos_ocor	Inteiro	99999999	Duração do tempo da ocorrência em segundos.	Sim	TOTVS 11.2.1
cdn_sit_afast_func	like par_marcac_ptoelet.cdn_sit_afast_func	like par_marcac_ptoelet.cdn_sit_afast_func	Código da situação relacionada a ocorrência	Não	TOTVS 11.2.1
des_sit_motiv	Caracter	X(20)	Descrição da situação ou motivo relacionado a ocorrência	Não	TOTVS 11.2.1
cdn_obs_func	par_marcac_ptoelet.cdn_obs_func	par_marcac_ptoelet.cdn_obs_func	Código da observação da justificativa, relacionada a ocorrência	Não	TOTVS 11.2.1
des_obs_func	Caracter	X(20)	Descrição da observação da justificativa, relacionada a ocorrência	Não	TOTVS 11.2.1
log_pode_justificar	Lógico	Yes/No	Determina se a ocorrência pode ser justificada pelo funcionário	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_conta_ocorrencias_func

Requisito	Inexistente.
Sintaxe	run procedure pi_conta_ocorrencias_func in h-handle (input p_cdn_empresa, Input p_cdn_estab, Input p_cdn_funcionario, Output table tt_qtd_ocor_func).
Descrição	Verificar as informações relativas ao período de ponto do funcionário e retorna para o portal a tabela temporária tt_qtd_ocor_func que contém as quantidades de ocorrências de Horas Extras, Faltas, Atrasos ou Batidas. Essas informações são geradas considerando o mês e ano de referência da empresa, verificando a partir desta data os dias de abrangência dos períodos de ponto em aberto do funcionário em relação ao critério de ponto dentro ou fora do mês de referência, conforme parametrizado no cadastros de categoria salarial.
	Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario tt_qtd_ocor_func	Parâmetro com código da empresa. Parâmetro com código do estabelecimento. Parâmetro com código de matrícula do funcionário. Tabela temporária com a quantidade de ocorrências do funcionário.
Retorno	Temp-tables tt_qtd_ocor_func populada.

procedure pi_lista_dias_ponto_func

Requisito	Inexistente.
Sintaxe	run procedure pi_lista_dias_ponto_func in h-handle (input p_cdn_empresa, Input p_cdn_estab, Input p_cdn_funcionario, Output table tt_dias_periodo_ponto_func).
Descrição	Verificar as informações relativas ao período de ponto do funcionário e retorna para o portal a tabela temporária tt_qtd_ocor_func que contém as quantidades de ocorrências de Horas Extras, Faltas, Atrasos ou Batidas. Essas informações são geradas considerando o mês e ano de referência da empresa, verificando a partir desta data os dias de abrangência dos períodos de ponto em aberto do funcionário em relação ao critério de ponto dentro ou fora do mês de referência, conforme parametrizado no cadastros de categoria salarial.
	Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario tt_dias_periodo_ponto_func	Parâmetro com código da empresa. Parâmetro com código do estabelecimento. Parâmetro com código de matrícula do funcionário. Tabela temporária com informações dos dias do período de ponto do funcionário.
Retorno	Temp-tables tt_dias_periodo_ponto_func populada.

procedure pi_lista_batidas_func

Requisito	Inexistente.
Sintaxe	run procedure pi_lista_batidas_func in h-handle (input p_cdn_empresa, Input p_cdn_estab, Input p_cdn_funcionario, Output table tt_marcacoes_func).
Descrição	Verificar as informações relativas ao período de ponto do funcionário e retorna para o portal a tabela temporária tt_qtd_ocor_func que contém as quantidades de ocorrências de Horas Extras, Faltas, Atrasos ou Batidas. Essas informações são geradas considerando o mês e ano de referência da empresa, verificando a partir desta data os dias de abrangência dos períodos de ponto em aberto do funcionário em relação ao critério de ponto dentro ou fora do mês de referência, conforme parametrizado no cadastros de categoria salarial.
	Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario tt_marcacoes_func	Parâmetro com código da empresa. Parâmetro com código do estabelecimento. Parâmetro com código de matrícula do funcionário. Tabela temporária com informações das batidas do funcionário.
Retorno	Temp-tables tt_marcacoes_func populada.

procedure pi_lista_ocorrencias_func

Requisito	Inexistente.
Sintaxe	run procedure pi_lista_ocorrencias_func in h-handle (input p_cdn_empresa, Input p_cdn_estab, Input p_cdn_funcionario, Output table tt_ocor_ponto_func).
Descrição	Verificar as informações relativas ao período de ponto do funcionário e retorna para o portal a tabela temporária tt_qtd_ocor_func que contém as quantidades de ocorrências de Horas Extras, Faltas, Atrasos ou Batidas. Essas informações são geradas considerando o mês e ano de referência da empresa, verificando a partir desta data os dias de abrangência dos períodos de ponto em aberto do funcionário em relação ao critério de ponto dentro ou fora do mês de referência, conforme parametrizado no cadastros de categoria salarial.
	Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario tt_ocor_ponto_func	Parâmetro com código da empresa. Parâmetro com código do estabelecimento. Parâmetro com código de matrícula do funcionário. Tabela temporária com informações das ocorrências do funcionário.
Retorno	Temp-tables tt_ocor_ponto_func populada.

procedure pi_verifica_ocorrencias_func

Requisito	Inexistente.
Sintaxe	run procedure pi_verifica_ocorrencias_func in h-handle (input p_cdn_empresa, Input p_cdn_estab, Input p_cdn_funcionario, input p_tip_retorno).
Descrição	Verificar as informações relativas ao período de ponto do funcionário e retorna para o portal a tabela temporária tt_qtd_ocor_func que contém as quantidades de ocorrências de Horas Extras, Faltas, Atrasos ou Batidas. Essas informações são geradas considerando o mês e ano de referência da empresa, verificando a partir desta data os dias de abrangência dos períodos de ponto em aberto do funcionário em relação ao critério de ponto dentro ou fora do mês de referência, conforme parametrizado no cadastros de categoria salarial.
	Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario p_tip_retorno	Parâmetro com código da empresa. Parâmetro com código do estabelecimento. Parâmetro com código de matrícula do funcionário. Parâmetro que indica qual tabela temporária está sendo gravada.
Retorno	Temp-tables de retorno das procedures anteriores populadas.

Método Negócio

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

Árvore de páginas