FPAPI022 - Realiza a exportação da estrutura de reporte da empresa.

Documento de API

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

Objetivo

Realiza a exportação da estrutura de reporte da empresa tanto das permissões normais (FP9100/FP0590) do sistema quanto as pemissões por Área de Negócio (FP9140).

Funcionamento

A API fpapi022 deve ser executada de forma persistente.

Sintaxe para executar a API em modo persistente:

run prghur/fpp/fpapi022.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-ReportStructure	Contém informações da estrutura de reporte.	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
id	Inteiro	Zz9	Identificação sequencial da tabela temporária	Sim	2.10
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
coordinatorCode	Inteiro	Zz9	Código para identificar se o registro é de um coordenador	Sim	2.10
cod_usuario	Caracter	X(12)	Código do usuário	Sim	2.10
Idi_area_negoc	int	99	Área de Negócio	Não	2.10F
Cod_area_negoc_custom	Caracter	X(100)	Código Área de Negõcio Customizada	Não	2.10F

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 piReportStructure

Requisito	Inexistente.
Sintaxe	run procedure piReportStructure in h-handle (input p_cdn_empresa, Input p_cdn_estab, Input p_cdn_funcionario, Output table tt-ReportStructure, Output table tt-erro).
Descrição	O método retornará os colaboradores subordinados a determinado colaborador.
	Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario tt-ReportStructure tt-erro	Código da empresa do colaborador. Código do estabelecimento do colaborador. Código de matrícula do colaborador. Estrutura de reporte da empresa. Erros do processo.
Retorno	Temp-tables tt-ReportStructure e tt-erro populadas. As mensagens possíveis para este método são: "Usuário Datasul HCM não encontrado!" "Usuário não possui subordinados!"

procedure pi-findEmployeesTeamOfManager

Requisito			Inexistente.
Sintaxe			run procedure pi-findEmployeesTeamOfManager in h-handle (input p_cdn_empresa, Input p_cdn_estab, Input p_cdn_funcionario, Output table tt-ReportStructure, Output table tt-erro).
Descrição			O método retornará os colaboradores subordinados a determinado colaborador.
			Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario tt-ReportStructure tt-erro			Código da empresa do colaborador. Código do estabelecimento do colaborador. Código de matrícula do colaborador. Estrutura de reporte da empresa. Erros do processo.
Retorno		Temp-tables tt-ReportStructure e tt-erro populadas. As mensagens possíveis para este método são: "Usuário Datasul HCM não encontrado!" "Usuário não possui subordinados!"

procedure pi-findEmployeesTeamByManager

Requisito			Inexistente.
Sintaxe			run procedure pi-findEmployeesTeamByManager in h-handle (Output table tt-ReportStructure, Output table tt-erro).
Descrição			O método retornará os colaboradores subordinados e seus coordenadores.
			Parâmetros	Descrição
	p_cdn_empresa p_cdn_estab p_cdn_funcionario tt-ReportStructure tt-erro			Código da empresa do colaborador. Código do estabelecimento do colaborador. Código de matrícula do colaborador. Estrutura de reporte da empresa. Erros do processo.
Retorno		Temp-tables tt-ReportStructure e tt-erro populadas. As mensagens possíveis para este método são: "Usuário Datasul HCM não encontrado!" "Usuário não possui subordinados!"

Método Negócio

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

Árvore de páginas