Árvore de páginas

Carregando...

 

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 prghur/fpp/fpapi038.p 

 

Objetivo

Realiza a identificação da lotação de um ou mais colaboradores, de acordo com o método executado. As lotações identificadas são: Unidade de lotação, Cargo, Classe de Ponto, Jornada de Trabalho, Categoria Salarial, Turno de trabalho, Sindicato e Centro de Custo.

 

Funcionamento

A API fpapi038 deve ser executada de forma persistente.

Sintaxe para executar a API em modo persistente:

run prghur/fpp/fpapi038.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-employeeAllocation

Contém informações da lotação do colaborador.

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

companyCode

Inteiro

Zz9

Código da empresa

Sim

2.10

siteCode

Inteiro

Zz9

Código do estabelecimento

Sim

2.10

registry

Inteiro

Zzzzzzz9

Código de matrícula do funcionário

Sim

2.10

allocationUnitCode

Caracter

X(11)

Código da Unidade de Lotação

Sim

2.10

allocationPlanCode

Inteiro

Zz9

Código do Planto de Lotação

Sim

2.10

positionEmployeeCode

Inteiro

Zzzz9

Código do Cargo

Sim

2.10

timeAttendanceClassEmployeeCode

Inteiro

Zz9

Código da classe de ponto do funcionário

Não

2.10

hoursWorkCode

Inteiro

Zzz9

Código da jornada de trabalho

Sim

2.10

paymentCategoryCode

Inteiro

99

Código da categoria salarial

Sim

2.10

workTurnCode

Inteiro

9999

Código do Turno de trabalho

Sim

2.10

workGroupCode

Inteiro

Z9

Código da turma de trabalho

Sim

2.10

laborUnionCode

Inteiro

Zzzzzzz9

Código do Sindicato

Não

2.10

costCenterCode

Caracter

X(08)

Código do Centro de Custo

Sim

2.10

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

Zz9

Código do erro

Sim

2.10

Description

Caracter

X(60)

Descrição do erro

Sim

2.10

 

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-cargaInicial

Requisito

Inexistente.

Sintaxe

run procedure pi-cargaInicial in h-handle

(input p_dat_refer,

 Output table tt-employeeAllocation,

 Output table tt-erro).

Descrição

O método retornará a lotação de todos os colaboradores da base de dados em determinada data.

 

Parâmetros

Descrição

 

p_dat_refer

tt-employeeAllocation

tt-erro

Data de referência para pesquisa da lotação.

Temp-table de saída com as informações da lotação.

Temp-table de saída que conterá os erros do processo.

Retorno

Temp-tables tt-employeeAllocation e tt-erro populadas.

As mensagens possíveis para este método são:

"Não foi encontrado histórico de unidade de lotação para o funcionário informado!"

"Não foi encontrado histórico salarial para o funcionário informado!"

"Funcionário Classe Ponto não cadastrado!"

"Jornada do Colaborador não encontrada!"

"Funcionário Classe Ponto não encontrado!!"

"Não foi encontrado histórico de categoria salarial para o funcionário informado!"

"Não foi encontrado histórico de turno de trabalho para o funcionário informado!"

"Não foi encontrado histórico de sindicato para o funcionário informado!"

"Não foi encontrado histórico de centros de custo para o funcionário informado!"

procedure pi-AllocationService

Requisito

Inexistente.

Sintaxe

run procedure pi-AllocationService in h-handle

(input p_cdn_empresa,

 input p_cdn_estab,

 input p_cdn_funcionario,

 input p_dat_refer,

 Output table tt-employeeAllocation,

 Output table tt-erro).

 

Descrição

O método retornará a lotação de um determinado colaborador em uma determinada data.

 

Parâmetros

Descrição

 

p_cdn_empresa

p_cdn_estab

p_cdn_funcionario

p_dat_refer

tt-employeeAllocation

tt-erro

Código da empresa do funcionário.

Código do estabelecimento do funcionário.

Código de matrícula do funcionário.

Data de referência para pesquisa da lotação.

Temp-table de saída com as informações da lotação.

Temp-table de saída que conterá os erros do processo.

Retorno

Temp-tables tt-employeeAllocation e tt-erro populadas.

As mensagens possíveis para este método são:

"Não foi encontrado histórico de unidade de lotação para o funcionário informado!"

"Não foi encontrado histórico salarial para o funcionário informado!"

"Funcionário Classe Ponto não cadastrado!"

"Jornada do Colaborador não encontrada!"

"Funcionário Classe Ponto não encontrado!!"

"Não foi encontrado histórico de categoria salarial para o funcionário informado!"

"Não foi encontrado histórico de turno de trabalho para o funcionário informado!"

"Não foi encontrado histórico de sindicato para o funcionário informado!"

"Não foi encontrado histórico de centros de custo para o funcionário informado!"

procedure pi-AllocationFilter

Requisito

Inexistente.

Sintaxe

run procedure pi-AllocationFilter in h-handle

(input p_cdn_empresa,

 input p_cdn_estab,

 input p_cdn_funcionario,

 input p_cdn_empresa_ini,

 input p_cdn_empresa_fim,

 input p_cdn_estab_ini,

 input p_cdn_estab_fim,

 input p_cdn_funcionario_ini,

 input p_cdn_funcionario_fim,

 input p_cod_unid_lotac_ini,

 input p_cod_unid_lotac_fim,

 input p_cdn_turno_trab_ini,

 input p_cdn_turno_trab_fim,

 input p_dat_refer,

 output table tt-employeeAllocation,

 output table tt-erro).

Descrição

O método retornará a lotação de determinados colaboradores em um determinado período de data.

 

Parâmetros

Descrição

 

p_cdn_empresa

p_cdn_estab

p_cdn_funcionario

p_cdn_empresa_ini

p_cdn_empresa_fim

p_cdn_estab_ini

p_cdn_estab_fim

p_cdn_funcionario_ini

p_cdn_funcionario_fim

p_cod_unid_lotac_ini

p_cod_unid_lotac_fim

p_cdn_turno_trab_ini

p_cdn_turno_trab_fim

p_dat_refer

tt-employeeAllocation

tt-erro

Código da empresa do coordenador ou funcionário responsável.

Código do estabelecimento do coordenador ou funcionário responsável

Código de matrícula do coordenador ou funcionário responsável.

Código da empresa inicial para a pesquisa.

Código da empresa final para a pesquisa.

Código do estabelecimento inicial para a pesquisa.

Código do estabelecimento final para a pesquisa.

Código do funcionário inicial para a pesquisa.

Código do funcionário final para a pesquisa.

Código da unidade de lotação inicial para a pesquisa.

Código da unidade de lotação final para a pesquisa.

Código do turno de trabalho inicial para a pesquisa.

Código do turno de trabalho final para a pesquisa.

Data de referência para pesquisa da lotação.

Temp-table de saída com as informações da lotação.

Temp-table de saída que conterá os erros do processo.

Retorno

Temp-tables tt-employeeAllocation e tt-erro populadas.

As mensagens possíveis para este método são:

"Não foi encontrado histórico de unidade de lotação para o funcionário informado!"

"Não foi encontrado histórico salarial para o funcionário informado!"

"Funcionário Classe Ponto não cadastrado!"

"Jornada do Colaborador não encontrada!"

"Funcionário Classe Ponto não encontrado!!"

"Não foi encontrado histórico de categoria salarial para o funcionário informado!"

"Não foi encontrado histórico de turno de trabalho para o funcionário informado!"

"Não foi encontrado histórico de sindicato para o funcionário informado!"

"Não foi encontrado histórico de centros de custo para o funcionário informado!"

 

Método Negócio

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