Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

A sintaxe para a chamada da API, que deve ser de forma persistente:


run lapllap/mlaapi018.p persistent set h-handle.

...

pi-verifica-utiliza-tipo-aprov

Requisito

Nenhum.

Descrição

Verifica se há algum tipo de aprovação para o tipo solicitado.

Parâmetros

Tipo

Input/Output

Descrição

i-tipoINTEGERINPUT

Tipo de aprovação.

1 - Hierarquia

2 - Lista

3 - Padrão

4 - Técnica

5 - Faixa

l-utiliza

LOGICAL

OUTPUT

Indica a existência do tipo de aprovação.

Retorno

Não se aplica.



pi-retorna-chave-doc

Requisito

Nenhum.

Descrição

Retorna a chave de um determinado documento

Parâmetros

Tipo

Input/Output

Descrição

p-cod-tip-codINTEGERINPUT

Código do documento

tt-chave

TEMP-TABLE

OUTPUT

Chaves do documento

Retorno

Não se aplica.



pi-localiza-info-documento

Requisito

Nenhum.

Descrição

Localiza informações como Empresa, Estabelecimento, Valor, Lotação, Item e Referência de um documento, com base em sua chave

Parâmetros

Tipo

Input/Output

Descrição

i-documentoINTEGERINPUT

Código do documento

tt-chave

TEMP-TABLE

INPUT

Chaves do documento (para localização)

c-empresaCHARACTEROUTPUTCódigo da empresa do documento
c-estabelCHARACTEROUTPUTCódigo do estabelecimento do documento
de-valor-docDECIMALOUTPUTValor do documento
c-lotacaoCHARACTEROUTPUTLotação do documento
c-itemCHARACTEROUTPUTItem do do documento
c-familiaCHARACTEROUTPUTFamília do Item do documento
c-referenciaCHARACTEROUTPUTReferência do documento
l-item-informadoLOGICALOUTPUTIndica se localizou o item

Retorno

Retorna "NOK" caso não consiga localizar o documento com base na chave recebida.

Trata a localização dos documentos: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 13, 14, 16, 18, 19, 20 e 21.



pi-valida-parametros-de-compra

Requisito

Nenhum.

Descrição

Se for recebido um documento de compras, valida se o mesmo está ativo na aprovação eletrônica (CD1750).

Parâmetros

Tipo

Input/Output

Descrição

i-documentoINTEGERINPUT

Código do documento

l-configurado

LOGICAL

OUTPUT

Indica se o documento está parametrizado corretamente na aprovação de compras.

Retorno

Caso não seja um documento de compras irá retornar como configurado.

Documentos considerados de compras: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 e 19.




pi-verifica-mla-param-aprov

Requisito

Nenhum.

Descrição

Verifica a existência de parametrização de aprovação para empresa e estabelecimento (MLA0000)

Parâmetros

Tipo

Input/Output

Descrição

c-empresaCHARACTERINPUT

Código da empresa

c-estabCHARACTERINPUTCódigo do estabelecimento

l-existe

LOGICAL

OUTPUT

Indica se existe a parametrização

Retorno

Não se aplica.



pi-verifica-mla-tipo-doc-aprov

Requisito

Nenhum.

Descrição

Verifica a existência de parametrização de tipo de documento (MLA0101)

Parâmetros

Tipo

Input/Output

Descrição

i-documentoINTEGERINPUT

Código do documento

c-empresaCHARACTERINPUT

Código da empresa

c-estabCHARACTERINPUTCódigo do estabelecimento

l-existe

LOGICAL

OUTPUT

Indica se existe a parametrização

l-aprovLOGICALOUTPUTIndica se o documento está marcado para sofrer aprovação
i-prioridade-aprovINTEGEROUTPUTPrioridade de aprovação do documento

Retorno

Não se aplica.



pi-verifica-usuario

Requisito

Nenhum.

Descrição

Retorna a existência do usuário, sua lotação e forma de geração do documento

Parâmetros

Tipo

Input/Output

Descrição

c-cod-usuarCHARACTERINPUT

Código do usuário

c-lotacaoCHARACTEROUTPUT

Código da lotação

i-responsavelINTEGEROUTPUTResponsável pela geração (1 - Lotação, 2 - Centro de Custo)

l-utiliza-lotacao-orig

LOGICAL

OUTPUT

Indica se deve utilizar a lotação do usuário do documento de origem

Retorno

Retorna "NOK" caso não encontre o usuário.



pi-retorna-tipos-aprovacao-prioridade

Requisito

Nenhum.

Descrição

Retorna os tipos de aprovação conforme a prioridade

Parâmetros

Tipo

Input/Output

Descrição

i-documentoINTEGERINPUT

Código do documento

c-empresaCHARACTERINPUT

Código da empresa

i-prioridadeINTEGERINPUTPrioridade de aprovação (1 - Documento, 2 - Item, 3 - Referência, 4 - Família)
c-item-fam-refCHARACTERINPUTCódigo do item, família ou referência (conforme a prioridade informada)
c-programaCHARACTEROUTPUTNome do programa de configurações
tt-tipo-aprovTEMP-TABLEOUTPUTTipos de aprovação do documento

Retorno

Não se aplica.

Tabelas temporárias utilizadas como parâmetro:



pi-retorna-familia-item

Requisito

Nenhum.

Descrição

Verifica se o item existe e caso exista, retorna sua família.

Parâmetros

Tipo

Input/Output

Descrição

c-itemCHARACTERINPUT

Código do item

c-familiaCHARACTEROUTPUTCódigo da família

Retorno

Se o item não existir retorna "NOK"



pi-valida-existencia-usuar

Requisito

Nenhum.

Descrição

Verifica se o usuário informado existe

Parâmetros

Tipo

Input/Output

Descrição

c-usuarCHARACTERINPUT

Código do usuário

l-existeLOGICALOUTPUTIndica existência do usuário

Retorno

Não se aplica.



pi-verifica-referencia

Requisito

Nenhum.

Descrição

Verifica existência da referência

Parâmetros

Tipo

Input/Output

Descrição

c-empresaCHARACTERINPUT

Código da empresa

i-documentoINTEGERINPUTCódigo do documento
c-referenciaCHARACTERINPUTCódigo da referência

Retorno

Retorna "NOK" caso a referência não exista.



pi-verifica-lotacao

Requisito

Nenhum.

Descrição

Verifica existência da lotação no MLA

Parâmetros

Tipo

Input/Output

Descrição

c-empresaCHARACTERINPUT

Código da empresa

c-lotacaoCHARACTERINPUTCódigo da lotação

Retorno

Retorna "NOK" caso a referência não exista.



pi-retorna-lotacao

Requisito

Nenhum.

Descrição

Retorna a informação da lotação ou da onde ela deve vir, para cada documento

Parâmetros

Tipo

Input/Output

Descrição

c-lotacao-localizadaCHARACTERINPUT

Lotação que foi localizada para o documento (caso não tenha sido, enviar em branco)

c-usuar-geradorCHARACTERINPUTUsuário gerador da pendência
i-documentoINTEGERINPUTCódigo do documento
c-lotacaoCHARACTEROUTPUTLotação a ser utilizada
c-msg-lotacao-docCHARACTEROUTPUTMensagem indicando da onde a lotação vem

Retorno

Não se aplica.



pi-retorna-hierarquia-aprovadores

Requisito

Nenhum.

Descrição

Retorna os aprovadores da hierarquia

Parâmetros

Tipo

Input/Output

Descrição

i-documentoINTEGERINPUTCódigo do documento
c-empresaCHARACTERINPUT

Código da empresa

c-estabCHARACTERINPUTCódigo do estabelecimento
c-lotacao-docCHARACTERINPUTCódigo da lotação
tt-aprovadoresTEMP-TABLEOUTPUTAprovadores da hierarquia

Retorno

Não se aplica.



pi-retorna-aprovadores-lista-por-prioridade

Requisito

Nenhum.

Descrição

Retorna os aprovadores da lista conforme prioridade de aprovação

Parâmetros

Tipo

Input/Output

Descrição

i-documentoINTEGERINPUTCódigo do documento
c-empresaCHARACTERINPUT

Código da empresa

c-estabCHARACTERINPUTCódigo do estabelecimento
i-prioridadeINTEGERINPUTPrioridade de aprovação (1 - Documento, 2 - Item, 3 - Referência, 4 - Família)
c-item-fam-refCHARACTERINPUTCódigo do item, família ou referência (conforme a prioridade)
c-programaCHARACTEROUTPUTNome do programa de configurações
tt-aprovadoresTEMP-TABLEOUTPUTAprovadores da lista

Retorno

Não se aplica.



pi-retorna-aprovador-padrao

Requisito

Nenhum.

Descrição

Retorna o aprovador padrão para o tipo de aprovação, empresa e estabelecimento

Parâmetros

Tipo

Input/Output

Descrição

i-tip-aprovINTEGERINPUTCódigo do tipo de aprovação
c-empresaCHARACTERINPUT

Código da empresa

c-estabCHARACTERINPUTCódigo do estabelecimento
tt-aprovadoresTEMP-TABLEOUTPUTAprovador padrão

Retorno

Não se aplica.



pi-retorna-faixa-aprovacao

Requisito

Nenhum.

Descrição

Verifica a faixa de aprovação conforme valor e documento

Parâmetros

Tipo

Input/Output

Descrição

i-documentoINTEGERINPUTCódigo do documento
c-empresaCHARACTERINPUT

Código da empresa

c-estabCHARACTERINPUTCódigo do estabelecimento
c-lotacaoCHARACTERINPUTCódigo da lotação
de-valorDECIMALINPUTValor da pendência
i-num-faixaINTEGEROUTPUTNúmero da faixa
c-des-faixaCHARACTEROUTPUTDescrição da faixa
de-lim-iniDECIMALOUTPUTLimite inicial da faixa
de-lim-fimDECIMALOUTPUTLimite final da faixa

Retorno

Se a faixa não existir retorna "NOK"



pi-verifica-aprovadores-hierarquia-faixa

Requisito

Nenhum.

Descrição

Retorna os aprovadores da hierarquia/faixa

Parâmetros

Tipo

Input/Output

Descrição

i-documentoINTEGERINPUTCódigo do documento
c-empresaCHARACTERINPUT

Código da empresa

c-estabCHARACTERINPUTCódigo do estabelecimento
c-lotacaoCHARACTERINPUTCódigo da lotação
i-num-faixaINTEGERINPUTNúmero da faixa
tt-aprovadoresTEMP-TABLEOUTPUTAprovadores da hierarquia/faixa

Retorno

Não se aplica.



pi-verifica-permissao-limite-usuario

Requisito

Nenhum.

Descrição

Verifica a permissão e limite do usuário no documento

Parâmetros

Tipo

Input/Output

Descrição

c-cod-usuarCHARACTERINPUTCódigo do usuário
i-documentoINTEGERINPUTCódigo do documento
c-empresaCHARACTERINPUT

Código da empresa

c-estabCHARACTERINPUTCódigo do estabelecimento
de-valorDECIMALINPUTValor da pendência
l-existeLOGICALOUTPUTIndica se existe o cadastro da permissão para o usuário
l-validaLOGICALOUTPUTIndica se a permissão no documento está na validade
l-limiteLOGICALOUTPUTIndica se existe o limite está válido

Retorno

Não se aplica.




pi-verifica-lotacao-usuario

Requisito

Nenhum.

Descrição

Verifica a permissão do usuário na lotação

Parâmetros

Tipo

Input/Output

Descrição

c-cod-usuarCHARACTERINPUTCódigo do usuário
c-empresaCHARACTERINPUT

Código da empresa

c-lotacaoCHARACTERINPUTCódigo da lotação
l-existeLOGICALOUTPUTIndica se existe o cadastro de lotação para o usuário
l-validaLOGICALOUTPUTIndica se a permissão na lotação está na validade

Retorno

Não se aplica.



pi-verifica-verba-usuario

Requisito

Nenhum.

Descrição

Verifica a verba do usuário para o documento em questão

Parâmetros

Tipo

Input/Output

Descrição

c-cod-usuarCHARACTERINPUTCódigo do usuário
i-documentoINTEGERINPUTCódigo do documento
c-empresaCHARACTERINPUT

Código da empresa

c-estabCHARACTERINPUTCódigo do estabelecimento
de-valorDECIMALINPUTValor da pendência
l-usa-verbaLOGICALOUTPUTIndica se o documento utiliza verba
l-existe-verbaLOGICALOUTPUTIndica se existe a verba cadastrada
l-verba-validaLOGICALOUTPUTIndica se a verba está na validade e valor correto

Retorno

Não se aplica.


Tabelas temporárias utilizadas como parâmetro:


tt-docs-existentes

Entrada/Saída

Temp-table contendo os tipos de documento cadastrados

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cod-tip-doc

Inteiro

>>9

Código do documento

Sim

-

des-tip-doc
Caracterex(40)Descrição do documentoSim-



tt-mla-prog-consulta

Entrada/Saída

Temp-table contendo os programas de consulta

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

Definição dos campos deve ser LIKE mla-prog-consulta

-



tt-mla-chave-doc-aprov

Entrada/Saída

Temp-table contendo as chaves de um documento

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

Definição dos campos deve ser LIKE mla-chave-doc-aprov
r-RowidROWID-RowidNão-



tt-mla-chave-doc-aprov-doc

Entrada/Saída

Temp-table contendo as chaves de um documento a ser validado

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

Definição dos campos deve ser LIKE mla-chave-doc-aprov
r-RowidROWID-RowidNão-



tt-param-usuar

Entrada/Saída

Temp-table contendo parâmetros para exportação de usuários

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cod-usuar-ini

Caractere

x(12)

Código Usuário inicial a ser considerado na exportação

Sim

-

cod-usuar-fim

Caractere

x(12)

Código Usuário final a ser considerado na exportação

Sim

-

l-comprador
LógicoYES/NOConsidera usuário somente se ele for compradorSim-
l-aprovador
LógicoYES/NOConsidera usuário somente se ele for aprovadorSim-
l-solicitante
LógicoYES/NOConsidera usuário somente se ele for solicitanteSim-
l-requis
LógicoYES/NOConsidera usuário somente se ele for requisitanteSim-
l-requis-manut
LógicoYES/NOConsidera usuário somente se ele for requisitante de manutençãoSim-
sc-codigo-iniCaracterex(20)Centro de custo inicial do usuário a ser considerado na exportaçãoSim-
sc-codigo-fimCaracterex(20)Centro de custo final do usuário a ser considerado na exportaçãoSim-
cod-lotacao-iniCaracterex(20)Lotação inicial do usuário a ser considerado na exportaçãoSim-
cod-lotacao-fimCaracterex(20)Lotação final do usuário a ser considerado na exportaçãoSim-
l-utiliza-lotacaoLógicoYES/NOIndica a utilização do centro de custo do usuário que está sendo exportado, se não marcado, gera com a lotação do usuário de cópiaSim-

RowErrors

Entrada/Saída

Temp-table com dados dos erros ocorridos durante o processo

Saída

Atributo

Tipo

Descrição

Obrigatório

Evolução

ErrorSequence

 INTEGER

Número da sequência do erro

Sim

Não se aplica

ErrorNumber

INTEGER Código do erro 

Sim

Não se aplica

ErrorDescriptionCHARACTER Descrição do erro SimNão se aplica
ErrorParametersCHARACTER Parâmentros da mensagem de erro SimNão se aplica
ErrorTypeCHARACTER Tipo do erro SimNão se aplica
ErrorHelpCHARACTER Texto de ajuda da mensagem de erro SimNão se aplica
ErrorSubTypeCHARACTERSubtipo do erroSimNão se aplica



tt-chave

Entrada/Saída

Temp-table contendo as chaves de um documento

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

Definição dos campos deve ser LIKE mla-chave-doc-aprov

-

valorCHARACTERx(20)Valor da chaveNão-



tt-tipo-aprov

Entrada/Saída

Temp-table contendo os tipos de aprovação

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

seqINTEGER>>>>>>>>9Sequência do tipo de aprovaçãoSim-
cod-tip-aprovINTEGER>9Código do tipo de aprovaçãoSim-
des-tip-aprovCHARACTERx(40)Descrição do tipo de aprovaçãoSim-
prioridade-aprovINTEGER>9Prioridade de aprovaçãoSim-
log-limiteLOGICALyes/noSomente aprovadores com limiteSim-
nr-min-aprovINTEGER>9Número mínimo de aprovaçõesSim-
ind-tip-aprovINTEGER>9Tipo de aprovaçãoSim-



tt-docs-existentes

Entrada/Saída

Temp-table contendo os tipos de documento cadastrados

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cod-tip-doc

Inteiro

>>9

Código do documento

Sim

-

des-tip-doc
Caracterex(40)Descrição do documentoSim-

tt-mla-prog-consulta

Entrada/Saída

Temp-table contendo os programas de consulta

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

Definição dos campos deve ser LIKE mla-prog-consulta

-

tt-mla-chave-doc-aprov

Entrada/Saída

Temp-table contendo as chaves de um documento

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

Definição dos campos deve ser LIKE mla-chave-doc-aprovr-RowidROWID-RowidNão-

tt-mla-chave-doc-aprov-doc

Entrada/Saída

Temp-table contendo as chaves de um documento a ser validado

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

Definição dos campos deve ser LIKE mla-chave-doc-aprovr-RowidROWID-RowidNão-

tt-param-usuar

Entrada/Saída

Temp-table contendo parâmetros para exportação de usuários

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cod-usuar-ini

Caractere

x(12)

Código Usuário inicial a ser considerado na exportação

Sim

-

cod-usuar-fim

Caractere

x(12)

Código Usuário final a ser considerado na exportação

Sim

-

l-comprador
LógicoYES/NOConsidera usuário somente se ele for compradorSim-l-aprovador
LógicoYES/NOConsidera usuário somente se ele for aprovadorSim-l-solicitante
LógicoYES/NOConsidera usuário somente se ele for solicitanteSim-l-requis
LógicoYES/NOConsidera usuário somente se ele for requisitanteSim-l-requis-manut
LógicoYES/NOConsidera usuário somente se ele for requisitante de manutençãoSim-sc-codigo-iniCaracterex(20)Centro de custo inicial do usuário a ser considerado na exportaçãoSim-sc-codigo-fimCaracterex(20)Centro de custo final do usuário a ser considerado na exportaçãoSim-cod-lotacao-iniCaracterex(20)Lotação inicial do usuário a ser considerado na exportaçãoSim-cod-lotacao-fimCaracterex(20)Lotação final do usuário a ser considerado na exportaçãoSim-l-utiliza-lotacaoLógicoYES/NOIndica a utilização do centro de custo do usuário que está sendo exportado, se não marcado, gera com a lotação do usuário de cópiaSim-

RowErrors

Entrada/Saída

Temp-table com dados dos erros ocorridos durante o processo

Saída

Atributo

Tipo

Descrição

Obrigatório

Evolução

ErrorSequence

 INTEGER

Número da sequência do erro

Sim

Não se aplica

ErrorNumber

INTEGER Código do erro 

Sim

Não se aplica

ErrorDescriptionCHARACTER Descrição do erro SimNão se aplicaErrorParametersCHARACTER Parâmentros da mensagem de erro SimNão se aplicaErrorTypeCHARACTER Tipo do erro SimNão se aplicaErrorHelpCHARACTER Texto de ajuda da mensagem de erro SimNão se aplicaErrorSubTypeCHARACTERSubtipo do erroSimNão se aplica

tt-chave

Entrada/Saída

Temp-table contendo as chaves de um documento

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

Definição dos campos deve ser LIKE mla-chave-doc-aprov

-

valorCHARACTERx(20)Valor da chaveNão-tt-tipo-aprov

tt-aprovadores


Entrada/Saída

Temp-table contendo os

tipos de aprovação

aprovadores

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

seq
INTEGER>>>>>>>>9Sequência do tipo de aprovaçãoSim
-
cod-tip-
aprovINTEGER>9
Código do tipo de aprovação
Sequência aprovadorSim-
des
cod-
tip-aprov
usuarCHARACTERx(
40
12)
Descrição
Código do
tipo de aprovação
usuárioSim-
prioridade
nome-
aprov
usuar
INTEGER>9Prioridade de aprovação
CHARACTERx(40)Nome do UsuárioSim-
log-limite
mestreLOGICAL
yes
Sim/
noSomente aprovadores com limite
NãoUsuário mestreSim-
nr
log-
min-aprovINTEGER>9Número mínimo de aprovações
dependLOGICALSim
-ind-tip-aprovINTEGER>9Tipo de aprovação
/NãoIndica dependência entre os aprovadoresNão
Sim
-