Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | Prghur/rsp/rsapi002 |
Objetivo
Realizar a verificação de informações referentes a provisão de pessoal tais como: quantidade de funcionários previstos e quantidade de funcionários efetivos, para acompanhamento de saldo de vagas.
Funcionamento
A API utilizada para verificação de saldo orçamentário e quantidade de funcionários no quadro efetivo da empresa.
A API necessita ser executada em modo persistente para que seja possível a execução dos métodos internos que possuem o objetivo de retornar ao programa chamador as informações solicitadas, tais como: quantidade de funcionários previstos, quantidade de funcionários efetivos, quantidade de requisições, saldo disponível para novas contratações ou requisições.
A sintaxe para executar a API em modo persistente é:
run prghur/rsp/rsapi002.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
Tabela Temporária | Descrição | Entrada/Saída |
tt-variac | Contém a quantidade de funcionários na posição consultada. É possível armazenar nesta tabela as informações de até 12 meses e diferenciar através do tipo de movimento a informação armazenada: previsto, realizado, requisição, saldo. | Entrada/Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
v_cod_movto | Integer | Não utilizado | Não utilizado | Sim | 2.06 |
v_tip_movto | Character | x(28) | Descrição | Não | 2.06 |
v_qti_orig | Integer | >>>9 | Orig | Não | 2.06 |
v_mes_01 | Character | x(04) | Jan | Não | 2.06 |
v_mes_02 | Character | x(04) | Fev | Não | 2.06 |
v_mes_03 | Character | x(04) | Mar | Não | 2.06 |
v_mes_04 | Character | x(04) | Abr | Não | 2.06 |
v_mes_05 | Character | x(04) | Mai | Não | 2.06 |
v_mes_06 | Character | x(04) | Jun | Não | 2.06 |
v_mes_07 | Character | x(04) | Jul | Não | 2.06 |
v_mes_08 | Character | x(04) | Ago | Não | 2.06 |
v_mes_09 | Character | x(04) | Set | Não | 2.06 |
v_mes_10 | Character | x(04) | Out | Não | 2.06 |
v_mes_11 | Character | x(04) | Nov | Não | 2.06 |
v_mes_12 | Character | x(04) | Dez | Não | 2.06 |
v_num_mes | Integer | extent 60 | Não Utilizado | Não | 2.06 |
v_processo | Integer | extent 60 | Não Utilizado | Não | 2.06 |
Métodos
Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
Método Básico
Pi_cria_tt
Requisito | - Informações referentes a planilha a ser consultada selecionadas no programa chamador. - Informação referente ao tipo de consulta (realizado, previsto, requisição ou saldo) informado no programa chamador. - Informações referentes ao cenário orçamentário utilizado (código do cenário, mês/ano de início e fim do cenário) informados no programa chamador. - Quantidade de meses do cenário orçamentário informado no programa chamador. - Temp-table para envio e retorno de informações definida no programa chamador. | |
Sintaxe | run pi_cria_tt in h-handle (input v_num_navegacao, input v_num_inf /* Tipo informação consultada */, input cargo_planilha_orcto.num_seq_planilha_orcto, input cargo_planilha_orcto.cdn_vers_planilha, input v_cdn_empres_usuar, input cenar_orcto.cdn_cenar_orcto, input planilha_orcto.cod_rh_ccusto, input planilha_orcto.cdn_estab, input planilha_orcto.cod_unid_lotac, input planilha_orcto.cdn_turno_trab, input cargo_planilha_orcto.cdn_cargo, input cargo_planilha_orcto.cdn_niv_cargo, input cenar_orcto.num_mes_inic_valid, input cenar_orcto.num_ano_inic_valid, input cenar_orcto.num_mes_fim_valid, input cenar_orcto.num_ano_fim_valid, input v_qtd_mes, input "RS0320", input-output table tt-variac). | |
Descrição | Procedure utilizada para verificação de saldo orçamentário. Retorna uma tabela temporária contendo campo do tipo decimal com valor consultado. Para que a API retorne o valor desejado é necessário que receba como parâmetro de entrada o número identificador da informação a ser consultada conforme descrito a seguir:
1 - Quantidade de funcionários previstos para a posição. 2 - Quantidade de funcionários efetivos (realizado) para a posição. 3 - Quantidade de requisições para a posição. 4 - Quantidade de saldo para novas requisições (funcionários previstos - (realizados + requisições)). Obs: Para que seja possível a verificação da quantidade de funcionários realizados é necessário que o procedimento Aplica Realizado - OP0520 - do módulo de Orçamento de Pessoal tenha sido executado. | |
| Parâmetros | Descrição |
| v_nav
v_contador
v_seq_planilha
v_vers_planilha
v_empresa
v_cenar_corrent
v_ccusto
v_estab
v_unid_lotac
v_turno
v_cargo
v_nivel
v_mes_inic
v_ano_inic
v_mes_term
v_ano_term
v_qtd_meses
p_nom_prog
tt-variac
| Número de navegação. Em caso de cenários com mais de 12 meses, é possível realizar navegações que possibilitarão ao usuário visualizar dados do 2º ao 13º mês, do 3º ao 14º mês, do 4º ao 15º mês, sucessivamente. Caso não seja necessária a utilização desta navegação deverá ser enviado valor 0 para a API. Caso contrário deverá ser enviado o número correspondente ao primeiro mês da faixa. Ex: Período 1º ao 12º Mês: Enviar 0. Período 2º ao 13º Mês: Enviar 2. Período 3º ao 14º Mês: Enviar 2...
Recebe o tipo de informação a ser consultada: 1 - previsto, 2 - realizado, 3 - requisições, 4 - saldo.
Seqüência da planilha (campo num_seq_planilha_orcto da tabela cargo_planilha_orcto).
Número da versão da planilha (campo cdn_vers_planilha_orcto da tabela cargo_planilha_orcto).
Código da empresa (empresa corrente do usuário).
Código do cenário corrente (param_orcto.cdn_cenar_orcto_corren).
Código do centro de custo da planilha (planilha_orcto.cod_rh_ccusto).
Código do estabelecimento da planilha (planilha_orcto.cdn_estab).
Código da unidade de lotação da planilha (planilha_orcto.cod_unid_lotac).
Código do turno da planilha (planilha_orcto.cdn_turno_trab).
Código do cargo da planilha (cargo_planilha_orcto.cdn_cargo).
Código do nível do cargo (cargo_planilha_orcto.cdn_niv_cargo).
Mês início do cenário orçamentário (cenar_orcto.num_mes_inic_valid).
Ano início do cenário orçamentário (cenar_orcto.num_ano_inic_valid).
Mês final do cenário orçamentário (cenar_orcto.num_mes_fim_valid).
Ano final do cenário orçamentário (cenar_orcto.num_ano_fim_valid).
Quantidade total de meses do cenário.
Nome do programa chamador.
Tabela temporária contendo as quantidades a serem retornadas ao programa chamador. |
Retorno | A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Será retornada uma tabela temporária contendo as informações encontradas para a seleção enviada a API. |