Histórico da Página

...

Totvs custom tabs box

tabs	Filiais,Departamento,Centro de Custo,Gestores,Indicares Saldo,Indicadores Horas,Detalhemento Indicadores,Gráficos,Detalhamento dos Gráficos
ids	filiais,departamento,centrodecusto,gestores,indicadoresSaldo,indicadoresHoras,detalhamentoIndicadores,graficos,detalhamentoGraficos

.

Totvs custom tabs box items

default	yes
referencia	filiais

Filiais - api/rh/v1/DbHrBranches

API responsável por trazer todas as filiais para serem utilizadas no filtro do Dashboard RH. Assim será possível ter uma visão macro da empresa ou apenas de uma filial em específico.

Ativação/Desativação da API

Por padrão esta API estará no sistema, porém será necessário realizar a devida configuração do serviço REST.

Configuração de Webservice Rest no Protheus no formato apresentado na seguinte documentação (Exemplo de Configuração de Webservice REST)

Controle de Ambiente

Exige que os seguintes pontos sejam revisados:

Protheus com sua arquitetura devidamente estruturada.

Controle de Versão

O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.

Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância da linha Protheus.

Suporte

O suporte aos recursos da API será de responsabilidade da linha Protheus onde será analisada pela equipe de suporte da Totvs.

Fluxo das Informações

Esta API traz a funcionalidade exclusivamente para consultar todas as filiais cadastradas para serem utilizadas no filtro do Dashboard RH.

Cadastro

Esta API contempla apenas a consulta das filiais cadastradas.

Processos

O Dashboard RH realizará o consumo da API para buscar todas as filiais.

Como realizar a chamada da API REST

Preenchimento do EndPoint da API PONAPIDSB;
Utilizar a chamada do método GET e do Serviço api/rh/v1/DbHrBranches;

Internamente o Protheus identifica automaticamente o endereço do servidor REST, porém para que isso aconteça será necessário habilitar a porta multiprotocolo do Appserver. Para mais informações sobre a porta multiprotocolo acesse o link abaixo:
https://tdn.totvs.com/x/jIUoI

Formatos de Data

Por ser uma API que retorna todas as filiais, não existe qualquer parâmetro que precisa ser enviado.

Parâmetros e Chamada do Método:

Para a realização de testes foi utilizado a ferramenta Postman e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo:

{protocolo}://{host}:{porta}/{endereço Rest}/api/rh/v1/DbHrBranches

Response da API:

Bloco de código

title	Application/json

{
	"branches": [
		"D MG 01 ",
		"D MG 02 ",
		"D RJ 01 ",
		"D RJ 02 ",
		"M PR 01 ",
		"M PR 02 ",
		"M SP 01 ",
		"M SP 02 ",
		"M SP 03 "
	]
}

Totvs custom tabs box items

default	no
referencia	departamento

Departamentos - api/rh/v1/Departaments

API responsável por trazer todos os departamentos para serem utilizados no filtro do Dashboard RH.

Ativação/Desativação da API

Por padrão esta API estará no sistema, porém será necessário realizar a devida configuração do serviço REST.

Configuração de Webservice Rest no Protheus no formato apresentado na seguinte documentação (Exemplo de Configuração de Webservice REST)

Controle de Ambiente

Exige que os seguintes pontos sejam revisados:

Protheus com sua arquitetura devidamente estruturada.

Controle de Versão

O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.

Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância da linha Protheus.

Suporte

O suporte aos recursos da API será de responsabilidade da linha Protheus onde será analisada pela equipe de suporte da Totvs.

Fluxo das Informações

Esta API traz a funcionalidade exclusivamente para consultar todos os departamentos cadastrados para serem utilizadas no filtro do Dashboard RH.

Cadastro

Esta API contempla apenas a consulta dos departamentos cadastrados.

Processos

O Dashboard RH realizará o consumo da API para buscar todos os departamentos.

Como realizar a chamada da API REST

Preenchimento do EndPoint da API PONAPIDSB(Veriricar nome do fonte posteriormente);
Utilizar a chamada do método GET e do Serviço api/rh/v1/Departaments;

Internamente o Protheus identifica automaticamente o endereço do servidor REST, porém para que isso aconteça será necessário habilitar a porta multiprotocolo do Appserver. Para mais informações sobre a porta multiprotocolo acesse o link abaixo:
https://tdn.totvs.com/x/jIUoI

Formatos de Data

Por ser uma API que retorna todos os departamentos, não existe qualquer parâmetro que precisa ser enviado.

Parâmetros e Chamada do Método:

Para a realização de testes foi utilizado a ferramenta Postman e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo:

{protocolo}://{host}:{porta}/{endereço Rest}/api/rh/v1/Departaments

Response da API:

Bloco de código

title	Application/json

{
	"departaments": [
		{
			"label": "Financeiro (D MG 01)"
			"value": "0000001 - D MG 01"
		},
		{
			"label": "Recursos Humanos (D MG 01)"
			"value": "0000002 - D MG 01"
		},
		{
			"label": "Financeiro (M SP 01)"
			"value": "0000001 - M SP 01"
		}
	]
}

Totvs custom tabs box items

default	no
referencia	centrodecusto

Centros de Custo - api/rh/v1/CostCenter

API responsável por trazer todos os Centros de Custo para serem utilizados no filtro do Dashboard RH.

Ativação/Desativação da API

Por padrão esta API estará no sistema, porém será necessário realizar a devida configuração do serviço REST.

Configuração de Webservice Rest no Protheus no formato apresentado na seguinte documentação (Exemplo de Configuração de Webservice REST)

Controle de Ambiente

Exige que os seguintes pontos sejam revisados:

Protheus com sua arquitetura devidamente estruturada.

Controle de Versão

O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.

Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância da linha Protheus.

Suporte

O suporte aos recursos da API será de responsabilidade da linha Protheus onde será analisada pela equipe de suporte da Totvs.

Fluxo das Informações

Esta API traz a funcionalidade exclusivamente para consultar todos os Centros de Custo cadastrados para serem utilizadas no filtro do Dashboard RH.

Cadastro

Esta API contempla apenas a consulta dos Centros de Custo cadastrados.

Processos

O Dashboard RH realizará o consumo da API para buscar todos os Centros de Custo.

Como realizar a chamada da API REST

Preenchimento do EndPoint da API PONAPIDSB(Veriricar nome do fonte posteriormente);
Utilizar a chamada do método GET e do Serviço api/rh/v1/Departaments;

Internamente o Protheus identifica automaticamente o endereço do servidor REST, porém para que isso aconteça será necessário habilitar a porta multiprotocolo do Appserver. Para mais informações sobre a porta multiprotocolo acesse o link abaixo:
https://tdn.totvs.com/x/jIUoI

Formatos de Data

Por ser uma API que retorna todos os centros de custo, não existe qualquer parâmetro que precisa ser enviado.

Parâmetros e Chamada do Método:

Para a realização de testes foi utilizado a ferramenta Postman e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo:

{protocolo}://{host}:{porta}/{endereço Rest}/api/rh/v1/Departaments

Response da API:

Bloco de código

title	Application/json

{
	"costsCenter": [
		{
			"label": "Desenvolvimento Rotinas (D MG 01)"
			"value": "0000001 - D MG 01"
		},
		{
			"label": "Desenvolvimento Jornadas (D MG 01)"
			"value": "0000002 - D MG 01"
		},
		{
			"label": "Desenvolvimento Rotinas (M SP 01)"
			"value": "0000001 - M SP 01"
		}
	]
}

Totvs custom tabs box items

default	no
referencia	gestores

Gestores - api/rh/v1/DbHrManagers

API responsável por trazer todos os gestores para serem utilizados no filtro do Dashboard RH. Assim será possível realizar filtros dos funcionários separados por gestor ou gestores.

Ativação/Desativação da API

Por padrão esta API estará no sistema, porém será necessário realizar a devida configuração do serviço REST.

Configuração de Webservice Rest no Protheus no formato apresentado na seguinte documentação (Exemplo de Configuração de Webservice REST)

Controle de Ambiente

Exige que os seguintes pontos sejam revisados:

Protheus com sua arquitetura devidamente estruturada.

Controle de Versão

O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.

Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância da linha Protheus.

Suporte

O suporte aos recursos da API será de responsabilidade da linha Protheus onde será analisada pela equipe de suporte da Totvs.

Fluxo das Informações

Esta API traz a funcionalidade exclusivamente para consultar todos os gestores cadastrados para serem utilizadas no filtro do Dashboard RH.

Cadastro

Esta API contempla apenas a consulta dos gestores cadastrados.

Processos

O Dashboard RH realizará o consumo da API para buscar todos os gestores.

Como realizar a chamada da API REST

Preenchimento do EndPoint da API PONAPIDSB;
Utilizar a chamada do método GET e do Serviço api/rh/v1/DbHrManagers;

Internamente o Protheus identifica automaticamente o endereço do servidor REST, porém para que isso aconteça será necessário habilitar a porta multiprotocolo do Appserver. Para mais informações sobre a porta multiprotocolo acesse o link abaixo:
https://tdn.totvs.com/x/jIUoI

Formatos de Data

Por ser uma API que retorna todos os gestores, não existe qualquer parâmetro que precisa ser enviado.

Parâmetros e Chamada do Método:

Para a realização de testes foi utilizado a ferramenta Postman e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo:

{protocolo}://{host}:{porta}/{endereço Rest}/api/rh/v1/DbHrManagers

Response da API:

Bloco de código

title	Application/json

{
	"managers": [
		"GESTOR FINANCEIRO D MG (D MG 01  - 000001)",
		"GESTOR RH M SP (M SP 01  - 000001)",
		"GESTOR TI D MG (D MG 01  - 000002)"
	]
}

Observações:
1 - Para que o Dashboard RH consiga localizar corretamente os funcionários que percentem à um gestor é necessário informar a filial e matrícula (separados por espaço + "-" + espaço) dos gestores entre parênteses. Exemplo: Gestor A (M SP 01 - 000001), Gestor B (M SP 01 - 000002) e Gestor C (M SP 01 - 000003).
2 - Caso o ERP não possua uma hierarquia ou não foram encontrados os gestores, o retorno a API deverá ser um Array vazio. Enviado um Array vazio o Dashboard RH irá desativar o filtro por gestor e o botão de enviar e-mail para os gestores.

Totvs custom tabs box items

default	no
referencia	indicadoresSaldo

Saldo Banco de Horas - api/rh/v1/Balance

API responsável por trazer os saldos (Total, Positivo e Negativo) do banco de horas dos funcionários.

Ativação/Desativação da API

Por padrão esta API estará no sistema, porém será necessário realizar a devida configuração do serviço REST.

Configuração de Webservice Rest no Protheus no formato apresentado na seguinte documentação (Exemplo de Configuração de Webservice REST)

Controle de Ambiente

Exige que os seguintes pontos sejam revisados:

Protheus com sua arquitetura devidamente estruturada.

Controle de Versão

O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.

Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância da linha Protheus.

Suporte

O suporte aos recursos da API será de responsabilidade da linha Protheus onde será analisada pela equipe de suporte da Totvs.

Fluxo das Informações

Esta API traz a funcionalidade exclusivamente para consultar os saldos (Total, Positivo e Negativo) do banco de horas dos funcionários.

Cadastro

Esta API contempla apenas a consulta dos saldos (Total, Positivo e Negativo) do banco de horas dos funcionários.

Processos

O Dashboard RH realizará o consumo da API para buscar todos os saldos (Total, Positivo e Negativo) do banco de horas dos funcionários.

Como realizar a chamada da API REST

Preenchimento do EndPoint da API PONAPIDSB(Veriricar nome do fonte posteriormente);
Utilizar a chamada do método GET e do Serviço api/rh/v1/Balance;

Internamente o Protheus identifica automaticamente o endereço do servidor REST, porém para que isso aconteça será necessário habilitar a porta multiprotocolo do Appserver. Para mais informações sobre a porta multiprotocolo acesse o link abaixo:
https://tdn.totvs.com/x/jIUoI

Formatos de Data

As Entradas de dados tipo data(Date) acompanham o formato padrão YYYY-MM-DD.

Parâmetros de Entrada:

Parâmetro	Valor de Exemplo	Obrigatório	Tipo	Parâmetro	Descrição
startDate	"2024-07-01"	Sim	Date	Body	Data inicial do período
endDate	"2024-07-31"	Sim	Date	Body	Data final do período
branch	[" "] ou ["D MG 01", "D MG 02"]	Sim	Array	Body	Filiais selecionadas
departament	[" "] ou ["0000001 - M SP 01", "0000001 - M SP 01"]	Sim	Array	Body	Departamentos selecionados
costCenter	[" "] ou ["000000001 - M SP 01", "0000000001 - D MG 01"]	Sim	Array	Body	Centros de Custo selecionados
manager	[" "] ou ["GESTOR RH M SP (M SP 01 - 000001)", "GESTOR TI D MG (D MG 01 - 000002)"]	Sim	Array	Body	Gestores selecionados
accept	application/json	Sim	String	Header
content-type	application/json	Sim	String	Header

Parâmetros e Chamada do Método:

Para a realização de testes foi utilizado a ferramenta Postman e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo:

{protocolo}://{host}:{porta}/{endereço Rest}/api/rh/v1/Balance

Response da API:

Bloco de código

title	Application/json

{
	{
		"indicatorType": "CurrentBalance",
		"hours": 100.02
	},
	{
		"indicatorType": "balance",
		"hours": 200.15
	}, 
	{   
		"indicatorType": "positiveHours",
		"hours": 300.45
	}, 
	{   
		"indicatorType": "negativeHours",
		"hours": -100.30
	}
}

Totvs custom tabs box items

default	no
referencia	indicadoresHoras

Saldo Banco de Horas - api/rh/v1/BalanceHours

API responsável por trazer os funcionários com horas à vencer ou com horas vencidas.

Ativação/Desativação da API

Por padrão esta API estará no sistema, porém será necessário realizar a devida configuração do serviço REST.

Configuração de Webservice Rest no Protheus no formato apresentado na seguinte documentação (Exemplo de Configuração de Webservice REST)

Controle de Ambiente

Exige que os seguintes pontos sejam revisados:

Protheus com sua arquitetura devidamente estruturada.

Controle de Versão

O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.

Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância da linha Protheus.

Suporte

O suporte aos recursos da API será de responsabilidade da linha Protheus onde será analisada pela equipe de suporte da Totvs.

Fluxo das Informações

Esta API traz a funcionalidade exclusivamente para consultar os funcionários com horas à vencer ou com horas vencidas.

Cadastro

Esta API contempla apenas a consulta funcionários com horas à vencer ou com horas vencidas.

Processos

O Dashboard RH realizará o consumo da API para buscar todos os funcionários com horas à vencer ou com horas vencidas.

Como realizar a chamada da API REST

Preenchimento do EndPoint da API PONAPIDSB(Veriricar nome do fonte posteriormente);
Utilizar a chamada do método GET e do Serviço api/rh/v1/BalanceHours;

Internamente o Protheus identifica automaticamente o endereço do servidor REST, porém para que isso aconteça será necessário habilitar a porta multiprotocolo do Appserver. Para mais informações sobre a porta multiprotocolo acesse o link abaixo:
https://tdn.totvs.com/x/jIUoI

Formatos de Data

As Entradas de dados tipo data(Date) acompanham o formato padrão YYYY-MM-DD.

Parâmetros de Entrada:

Parâmetro	Valor de Exemplo	Obrigatório	Tipo	Parâmetro	Descrição
startDate	"2024-07-01"	Sim	Date	Body	Data inicial do período
endDate	"2024-07-31"	Sim	Date	Body	Data final do período
branch	[" "] ou ["D MG 01", "D MG 02"]	Sim	Array	Body	Filiais selecionadas
departament	[" "] ou ["0000001 - M SP 01", "0000001 - M SP 01"]	Sim	Array	Body	Departamentos selecionados
costCenter	[" "] ou ["000000001 - M SP 01", "0000000001 - D MG 01"]	Sim	Array	Body	Centros de Custo selecionados
manager	[" "] ou ["GESTOR RH M SP (M SP 01 - 000001)", "GESTOR TI D MG (D MG 01 - 000002)"]	Sim	Array	Body	Gestores selecionados
accept	application/json	Sim	String	Header
content-type	application/json	Sim	String	Header

Parâmetros e Chamada do Método:

Para a realização de testes foi utilizado a ferramenta Postman e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo:

{protocolo}://{host}:{porta}/{endereço Rest}/api/rh/v1/BalanceHours

Response da API:

Bloco de código

title	Application/json

{
	{
		"indicatorType": "hoursToExpire",
		"hours": 150.59
	},
	{
		"indicatorType": "expiredHours",
		"hours": 100.47
	}
}

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 10

Nova versão 11

Chave

Ativação/Desativação da API

Controle de Ambiente

Controle de Versão

Suporte

Fluxo das Informações

Cadastro

Processos

Como realizar a chamada da API REST

Formatos de Data

Ativação/Desativação da API

Controle de Ambiente

Controle de Versão

Suporte

Fluxo das Informações

Cadastro

Processos

Como realizar a chamada da API REST

Formatos de Data

Ativação/Desativação da API

Controle de Ambiente

Controle de Versão

Suporte

Fluxo das Informações

Cadastro

Processos

Como realizar a chamada da API REST

Formatos de Data

Ativação/Desativação da API

Controle de Ambiente

Controle de Versão

Suporte

Fluxo das Informações

Cadastro

Processos

Como realizar a chamada da API REST

Formatos de Data

Ativação/Desativação da API

Controle de Ambiente

Controle de Versão

Suporte

Fluxo das Informações

Cadastro

Processos

Como realizar a chamada da API REST

Formatos de Data

Ativação/Desativação da API

Controle de Ambiente

Controle de Versão

Suporte

Fluxo das Informações

Cadastro

Processos

Como realizar a chamada da API REST

Formatos de Data