Histórico da Página
...
pi-get-approverUser-v1 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Retorna informações de um aprovador do MLA. | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para a busca do aprovador: queryParams → fields: Campos que devem ser retornados na busca, separados por vírgula, verificar campos possíveis no oOutput. queryParams → expand: Utilizando este parâmetro com a informação "visualConfigurations", são retornadas também as configurações visuais do usuário. pathParams: Informar o código do usuário aprovador que se deseja buscar as informações.
| |||||
oOutput | JsonObject | OUTPUT | Informações do aprovador.
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação.: tt-aprovador: que contém as informações principais do aprovador tt-config-visual (visualConfigurations): contém as informações de configuração visual do usuário. | |||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante o processo de busca dos aprovadores | |||||
Retorno | Aprovadores do MLA conforme filtros passados. | |||||||
pi-ativa-mla | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Cria e ativa a função de ativação do módulo do MLA | Parâmetros |
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 | ||||
Não se aplica | .||||
pi-valida-funcao-excecao-aprov-compra | ||||
Requisito | Nenhum. | |||
Descrição | Verifica se há função de exceção ativa para gerar pendência pela aprovação de compras ao invés do MLA | |||
Parâmetros | Tipo | Input/Output | Descrição | |
i-documento | INTEGER | INPUT | Código do documento do MLA a ser verificado | |
l-ativo | LOGICAL | OUTPUT | Indica se a função existe e está ativada | |
Retorno | Não se aplica. | |||
pi-desativa-excecao-aprov-compra | ||||
Requisito | Nenhum. | |||
Descrição | Desativa a função de exceção para gerar pendência pela aprovação de compras ao invés do MLA | |||
Parâmetros | Tipo | Input/Output | Descrição | |
i-documento | INTEGER | INPUT | Código do documento do MLA | |
Retorno | Não se aplica. | |||
pi-verifica-doc-contrato | ||||
Requisito | Nenhum. | |||
Descrição | Verifica se o documento de contrato está habilitado para geração de pendência | |||
Parâmetros | Tipo | Input/Output | Descrição | |
l-ativo | LOGICAL | OUTPUT | Indica se o documento está habilitado | |
Retorno | Não se aplica. | |||
pi-ativa-doc-contrato | ||||
Requisito | Nenhum. | |||
Descrição | Ativa o documento de contrato para aprovação pelo MLA | Parâmetros | ||
Não se aplica | ||||
Retorno | Não se aplica. | |||
pi-verifica-doc-medicao | ||||
Requisito | Nenhum. | |||
Descrição | Verifica se o documento de medição de contrato está habilitado para geração de pendência | |||
Parâmetros | Tipo | Input/Output | Descrição | |
l-ativo | LOGICAL | OUTPUT | Indica se o documento está habilitado | |
Retorno | Não se aplica. | |||
pi-ativa-doc-medicao | ||||
Requisito | Nenhum. | |||
Descrição | Ativa o documento de medição de contrato para aprovação pelo MLA | Parâmetros | ||
Não se aplica | ||||
Retorno | Não se aplica. | |||
pi-verifica-doc-evento | ||||
Requisito | Nenhum. | |||
Descrição | Verifica se o documento de evento de contrato está habilitado para geração de pendência | |||
Parâmetros | Tipo | Input/Output | Descrição | |
l-ativo | LOGICAL | OUTPUT | Indica se o documento está habilitado | |
Retorno | Não se aplica. | |||
pi-ativa-doc-evento | ||||
Requisito | Nenhum. | |||
Descrição | Ativa o documento de evento de contrato para aprovação pelo MLA | Parâmetros | ||
Não se aplica | ||||
Retorno | Não se aplica. | |||
pi-exporta-ccusto | ||||
Requisito | Nenhum. | |||
Descrição | Exportação de centros de custo conforme empresa | |||
Parâmetros | Tipo | Input/Output | Descrição | |
c-empresa | CHARACTER | INPUT | Código da empresa | |
c-arq | CHARACTER | OUTPUT | Arquivo (.csv) gerado com os centros de custo. Obs.: O arquivo gerado é no formato para importação através do MLA0171. | |
Retorno | Caso não haja centros de custo a serem exportados, a variável c-arq terá o valor branco "". | |||
pi-exporta-ccusto-produtivo | ||||
Requisito | Nenhum. | |||
Descrição | Exportação de centros de custo produtivos | |||
Parâmetros | Tipo | Input/Output | Descrição | |
c-arq | CHARACTER | OUTPUT | Arquivo (.csv) gerado com os centros de custo Obs.: O arquivo gerado é no formato para importação através do MLA0171. | |
Retorno | Não se aplica. | |||
pi-retorna-documentos-existentes | ||||
Requisito | Nenhum. | |||
Descrição | Retorna quais os tipos de documento cadastrados no módulo | |||
Parâmetros | Tipo | Input/Output | Descrição | |
tt-docs-existentes | TEMP-TABLE | OUTPUT | Temp-table contendo os tipos | |
Retorno | Não se aplica. | |||
pi-verifica-prog-consulta | ||||
Requisito | Nenhum. | |||
Descrição | Verifica se há algum programa de consulta cadastrado para o documento. | |||
Parâmetros | Tipo | Input/Output | Descrição | |
i-documento | INTEGER | INPUT | Código do documento do MLA | |
Retorno | Se existir algum programa retorna "OK", caso contrário "NOK". | |||
pi-cria-programa-consulta | ||||
Requisito | Documento previamente cadastrado no MLA. | |||
Descrição | Cria os programas de consulta padrões para o documento. | |||
Parâmetros | Tipo | Input/Output | Descrição | |
i-documento | INTEGER | INPUT | Código do documento do MLA | |
c-empresa | CHARACTER | INPUT | Código da empresa | |
tt-mla-prog-consulta | TEMP-TABLE | OUTPUT | Programas criados | |
Retorno | Caso o documento não esteja tratado pelo método, ou seja, não há programas de consulta para criar, retorna "NOK". | |||
pi-verifica-chave-mla | ||||
Requisito | Documento previamente cadastrado no MLA. | |||
Descrição | Verifica a existência da chave do documento. | |||
Parâmetros | Tipo | Input/Output | Descrição | |
i-documento | INTEGER | INPUT | Código do documento do MLA | |
c-empresa | CHARACTER | INPUT | Código da empresa | |
tt-mla-chave-doc-aprov | TEMP-TABLE | OUTPUT | Chave do documento | |
Retorno | Se a chave não existe, retorna "NOK". | |||
pi-cria-chave-mla | ||||
Requisito | Documento previamente cadastrado no MLA. | |||
Descrição | Cria as chaves dos documentos padräes no MLA0102 de acordo com o documento | |||
Parâmetros | Tipo | Input/Output | Descrição | |
c-empresa | CHARACTER | INPUT | Código da empresa | |
i-documento | INTEGER | INPUT | Código do documento do MLA | |
pl-efetiva-criacao | LOGICAL | INPUT | Indica que a chave deve ser efetiva no banco de dados | |
pl-elimina-chave | LOGICAL | INPUT | Indica que a chave atual do documento deve ser eliminada | |
tt-mla-chave-doc-aprov | TEMP-TABLE | OUTPUT | Chave do documento | |
Retorno | Caso o documento não esteja tratado pelo método, ou seja, não há chaves para criar, retorna "NOK". Caso ocorra algum erro na criação da chave para o documento, retorna "NOK". | |||
pi-compara-chave-padrao-chave-doc | ||||
Requisito | Nenhum. | |||
Descrição | Compara a chave do documento recebida com a chave padrão do mesmo | |||
Parâmetros | Tipo | Input/Output | Descrição | |
c-empresa | CHARACTER | INPUT | Código da empresa | |
i-documento | INTEGER | INPUT | Código do documento do MLA | |
tt-mla-chave-doc-aprov-doc | TEMP-TABLE | OUTPUT | Chave do documento a ser validada | |
Retorno | Se a chave recebida estiver diferente da chave padrão do documento, retorna "NOK". | |||
pi-existencia-tipos-aprovacao | ||||
Requisito | Nenhum. | |||
Descrição | Verifica se há algum tipo de aprovação cadastrado. | Parâmetros | ||
Não se aplica | ||||
Retorno | Se existir algum tipo de aprovação retorna "OK", caso contrário "NOK". | |||
pi-cria-tipos-aprovacao | ||||
Requisito | Executar o "pi-existencia-tipos-aprovacao" antes para garantir que não há tipos de aprovação cadastrados. | |||
Descrição | Realiza a criação dos tipos de aprovação. Um de cada tipo:
| Parâmetros | ||
Não se aplica | ||||
Retorno | Não se aplica. |
Requisito
Usuários cadastrados.
Descrição
Exportação de usuários.
Parâmetros
Tipo
Descrição
c-arq
CHARACTER
Arquivo (.csv) gerado com os usuários
Obs.: O arquivo gerado é no formato para importação através do MLA0171.
Retorno
Retorna "NOK" caso ocorra algum erro.
Requisito
Aprovadores cadastrados no módulo do MLA.
Descrição
Verifica a existência de permissões cadastradas (MLA0104) para os usuários aprovadores do módulo.
Parâmetros
Tipo
Descrição
Retorno
Não se aplica.
Requisito
Aprovadores cadastrados no módulo do MLA.
Descrição
Verifica a existência de lotações cadastradas (MLA0106) para os usuários aprovadores do módulo.
Parâmetros
Tipo
Descrição
Retorno
Não se aplica.
Requisito
Nenhum.
Descrição
Verifica se algum documento utiliza controle de verba no módulo
Parâmetros
Tipo
Descrição
l-utiliza
LOGICAL
Indica utilização de verba por algum documento
Retorno
Não se aplica.
Requisito
Nenhum.
Descrição
Verifica se algum documento utiliza prioridade de aprovação por item ou referência.
Parâmetros
Tipo
Descrição
l-utiliza
LOGICAL
Indica utilização de prioridade por item ou referência
Retorno
Não se aplica.
Requisito
Nenhum.
Descrição
Verifica se algum documento utiliza prioridade de aprovação por referência.
Parâmetros
Tipo
Descrição
l-utiliza
LOGICAL
Indica utilização de prioridade por referência
Retorno
Não se aplica.
Requisito
Nenhum.
Descrição
Verifica se há algum tipo de aprovação para o tipo solicitado.
Parâmetros
Tipo
Descrição
Tipo de aprovação.
1 - Hierarquia
2 - Lista
3 - Padrão
4 - Técnica
5 - Faixa
l-utiliza
LOGICAL
Indica a existência do tipo de aprovação.
Retorno
Não se aplica.
Requisito
Nenhum.
Descrição
Retorna a chave de um determinado documento
Parâmetros
Tipo
Descrição
Código do documento
tt-chave
TEMP-TABLE
Chaves do documento
Retorno
Não se aplica.
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
Descrição
Código do documento
tt-chave
TEMP-TABLE
Chaves do documento (para localização)
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.
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
Descrição
Código do documento
l-configurado
LOGICAL
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.
Requisito
Nenhum.
Descrição
Verifica a existência de parametrização de aprovação para empresa e estabelecimento (MLA0000)
Parâmetros
Tipo
Descrição
Código da empresa
l-existe
LOGICAL
Indica se existe a parametrização
Retorno
Não se aplica.
Requisito
Nenhum.
Descrição
Verifica a existência de parametrização de tipo de documento (MLA0101)
Parâmetros
Tipo
Descrição
Código do documento
Código da empresa
l-existe
LOGICAL
Indica se existe a parametrização
Retorno
Não se aplica.
Requisito
Nenhum.
Descrição
Retorna a existência do usuário, sua lotação e forma de geração do documento
Parâmetros
Tipo
Descrição
Código do usuário
Código da lotação
l-utiliza-lotacao-orig
LOGICAL
Indica se deve utilizar a lotação do usuário do documento de origem
Retorno
Retorna "NOK" caso não encontre o usuário.
Requisito
Nenhum.
Descrição
Retorna os tipos de aprovação conforme a prioridade
Parâmetros
Tipo
Descrição
Código do documento
Código da empresa
Retorno
Não se aplica.
Requisito
Nenhum.
Descrição
Verifica se o item existe e caso exista, retorna sua família.
Parâmetros
Tipo
Descrição
Código do item
Retorno
Se o item não existir retorna "NOK"
Requisito
Nenhum.
Descrição
Verifica se o usuário informado existe
Parâmetros
Tipo
Descrição
Código do usuário
Retorno
Não se aplica.
Requisito
Nenhum.
Descrição
Verifica existência da referência
Parâmetros
Tipo
Descrição
Código da empresa
Retorno
Retorna "NOK" caso a referência não exista.
Requisito
Nenhum.
Descrição
Verifica existência da lotação no MLA
Parâmetros
Tipo
Descrição
Código da empresa
Retorno
Retorna "NOK" caso a referência não exista.
Requisito
Nenhum.
Descrição
Retorna a informação da lotação ou da onde ela deve vir, para cada documento
Parâmetros
Tipo
Descrição
Lotação que foi localizada para o documento (caso não tenha sido, enviar em branco)
Retorno
Não se aplica.
Requisito
Nenhum.
Descrição
Retorna os aprovadores da hierarquia
Parâmetros
Tipo
Descrição
Código da empresa
Retorno
Não se aplica.
Requisito
Nenhum.
Descrição
Retorna os aprovadores da lista conforme prioridade de aprovação
Parâmetros
Tipo
Descrição
Código da empresa
Retorno
Não se aplica.
Requisito
Nenhum.
Descrição
Retorna o aprovador padrão para o tipo de aprovação, empresa e estabelecimento
Parâmetros
Tipo
Descrição
Código da empresa
Retorno
Não se aplica.
Requisito
Nenhum.
Descrição
Verifica a faixa de aprovação conforme valor e documento
Parâmetros
Tipo
Descrição
Código da empresa
Retorno
Se a faixa não existir retorna "NOK"
Requisito
Nenhum.
Descrição
Retorna os aprovadores da hierarquia/faixa
Parâmetros
Tipo
Descrição
Código da empresa
Retorno
Não se aplica.
Requisito
Nenhum.
Descrição
Verifica a permissão e limite do usuário no documento
Parâmetros
Tipo
Descrição
Código da empresa
Retorno
Não se aplica.
Requisito
Nenhum.
Descrição
Verifica a permissão do usuário na lotação
Parâmetros
Tipo
Descrição
Código da empresa
Retorno
Não se aplica.
Requisito
Nenhum.
Descrição
Verifica a verba do usuário para o documento em questão
Parâmetros
Tipo
Descrição
Código da empresa
Retorno
Não se aplica.
Tabelas temporárias utilizadas como parâmetro:
ErrorDescription | CHARACTER | Descrição do erro | Sim | Não se aplica |
ErrorParameters | CHARACTER | Parâmentros da mensagem de erro | Sim | Não se aplica |
ErrorType | CHARACTER | Tipo do erro | Sim | Não se aplica |
ErrorHelp | CHARACTER | Texto de ajuda da mensagem de erro | Sim | Não se aplica |
ErrorSubType | CHARACTER | Subtipo do erro | Sim | Não se aplica |
tt-aprovador | Entrada/Saída | ||||
Temp-table com dados dos aprovadores | Saída | ||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
cod-usuar | userCode | CHARACTER | Código do aprovador | Não | Não se aplica |
nome-usuar | userName | CHARACTER | Nome do aprovador | Não | Não se aplica |
CHARACTER | E-mail do aprovador | Não | Não se aplica | ||
envia-email | sendEmail | LOGICAL | Indica se envia e-mail | Não | Não se aplica |
recebe-email | receiveEmail | LOGICAL | Indica se recebe e-mail | Não | Não se aplica |
usuar-mestre | masterUser | LOGICAL | Indica se o usuário é mestre | Não | Não se aplica |
mo-codigo | currency | INTEGER | Moeda do aprovador | Não | Não se aplica |
sigla-moeda | currencyAbbrev | CHARACTER | Sigla da moeda do usuário | Não | Não se aplica |
aprova-auto | automacticApproval | LOGICAL | Indica se o aprovador aprova automaticamente | Não | Não se aplica |
aprova-auto-aprov | automacticApprovalApprover | LOGICAL | Indica se o aprovador aprova automaticamente pendências do aprovador | Não | Não se aplica |
cod-estabel | siteCode | CHARACTER | Estabelecimento do aprovador | Não | Não se aplica |
cod-lotacao | allocationCode | CHARACTER | Lotação do aprovador | Não | Não se aplica |
libera-verba | releaseAmount | LOGICAL | Indica se o aprovador libera verba | Não | Não se aplica |
log-usuar-config | configuratorUser | LOGICAL | Indice se o aprovador é configurador visual | Não | Não se aplica |
empresa | companyCode | CHARACTER | Empresa do aprovador | Não | Não se aplica |
idioma | language | CHARACTER | Idioma do aprovador | Não | Não se aplica |
tt-config-visual | Entrada/Saída | ||||
Temp-table com dados de configurações visuais de aprovadores | Saída | ||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
cod-usuar | CHARACTER | Código do aprovador | Não | Não se aplica | |
idi-ordenacao | ordination | INTEGER | Ordenação padrão: 1 - xxxx / 2 - xxxx / 3 - xxxx | Não | Não se aplica |
log-mostra-todas-empresas | allCompanies | LOGICAL | Indica apresentação de pendências de todas as empresas | Não | Não se aplica |
log-aprova-sem-motiv | approveWithoutReason | LOGICAL | Indica aprovação sem informar motivo | Não | Não se aplica |
cdn-tempo-desf | undoTime | INTEGER | Tempo de desfazer | Não | Não se aplica |
idi-acao-swip-dire | rightSwipeAction | INTEGER | Ação do swipe (Direito) | Não se aplica | |
idi-acao-swip-esq | leftSwipeAction | INTEGER | Ação do swipe (Esquerdo) | Não | Não se aplica |
idi-visualiz-inicial | initialView | INTEGER | Visualização inicial | Não | Não se aplica |
num-registro-paginac | pageRecordsNumber | INTEGER | Número de registros por página |
tt-docs-existentes
Entrada/Saída
Temp-table contendo os tipos de documento cadastrados
Saída
Atributo
Tipo
Descrição
Obrigatório
Evolução
cod-tip-doc
Inteiro
Código do documento
Sim
-
tt-mla-prog-consulta
Entrada/Saída
Temp-table contendo os programas de consulta
Saída
Atributo
Tipo
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
Descrição
Obrigatório
Evolução
tt-mla-chave-doc-aprov-doc
Entrada/Saída
Temp-table contendo as chaves de um documento a ser validado
Entrada
Atributo
Tipo
Descrição
Obrigatório
Evolução
tt-param-usuar
Entrada/Saída
Temp-table contendo parâmetros para exportação de usuários
Entrada
Atributo
Tipo
Descrição
Obrigatório
Evolução
cod-usuar-ini
Caractere
Código Usuário inicial a ser considerado na exportação
Sim
-
cod-usuar-fim
Caractere
Código Usuário final a ser considerado na exportação
Sim
-
tt-chave
Entrada/Saída
Temp-table contendo as chaves de um documento
Saída
Atributo
Tipo
Descrição
Obrigatório
Evolução
Definição dos campos deve ser LIKE mla-chave-doc-aprov
-
tt-tipo-aprov
Entrada/Saída
Temp-table contendo os tipos de aprovação
Saída
Atributo
Tipo
Descrição
Obrigatório
Evolução
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
Sim
Não se aplica
ErrorNumber
Sim
Não se aplica
tt-aprovador
Entrada/Saída
Temp-table com dados dos aprovadores
Saída
Atributo
Tipo
Descrição
Obrigatório
Evolução
cod-usuar
CHARACTER
Não
Não se aplica
nome-usuar
Não
Não se aplica
Não | Não se aplica |