Linha Datasul

Árvore de páginas

Versões comparadas

Versão antiga 10

changes.mady.by.user Tatiana Cristine da Rocha

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Usuário desconhecido (kleger.elias)

Gravado em

Chave

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

...

 { "defaultFields": [ {
pi-metadata-v1

Requisito

Nenhum.

Descrição

Repassa o parâmetro do tipo de evento recebido pela API de comunicação (cdp/api/v1/supplyDocuments) para a API de documentos (hubapi/apiDocuments) chamando o método pi-metadata-v1. . Existem duas apis de comunicação:

  • cdp/api/v1/supplyDocuments  : api que envia os eventos "list" ou "edit".
  • cdp/api/v1/supplyDocumentsView: api que envia o evento "view".

Retorna o metadados com os campos e ações ativos referentes a tela de Listagem (list), Consulta (view) ou Edição (edit), dependendo de qual tipo foi enviado pela requisição, para a montagem dinâmica da tela com as informações vindas do backend.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para a busca de metadados:

pathParams:  Informar: metadata.

queryParams →  type: Utilizando este atributo com uma das opções abaixo permite retornar as informações de:

  • list: Metadados da tela de listagem.
  • edit: Metadados da tela de inclusão do arquivo.


Bloco de código
titleExemplo
{
    "queryParams": {
    "type": "list"
  },
    "pathParams": [
       "metadata"
    ],
}
cEventCharacterINPUTIdentifica qual o tipo de evento vindo do queryParams para a busca do metadado correto.
cVersionCharacterINPUTIdentifica a versão da API.
oOutputJsonObjectOUTPUT

Retorno contendo o metadados com campos e ações conforme parâmetros recebidos:


  • Metadados List:


Bloco de código
titleList
  {
    "keepfilters": false,
    "literals": {},
    "validateFields": [],
    "title": "DocumentosAnexos de documentos",
    "fields": [
        {
            "visible": false,
            "property": "documentId",
            "label": "Código",
            "type": "number",
            "key": true,
            "order": 1
        },
        {
            "propertyvisible": "processTypeDescription"false,
            "widthproperty": "15%processType",
            "labeloptions": [
 "Tipo Processo",
              "type": "string",
 {
              "order": 2
     "label": "Ordem de }Compra",
        {
            "propertyvalue": "processKey",1
            "width": "15%",
   },
         "label": "Chave Processo",
     {
       "type": "string",
            "orderlabel": 3
"Cotação        }de Materiais",
        {
            "propertyvalue": "documentName",2
            "width": "20%"    }
            ],
            "label": "DocumentoTipo Processo",
            "type": "stringlabel",
            "order": 42,
        },
    "labels": [
   {
            "property": "documentSize", {
            "width": "5%",
            "label": "TamanhoOrdem de Compra",
                    "typevalue": "string",1
            "order": 5    },
        },
        {
            "property        "label": "documentDescriptionCotação de Materiais",
                    "widthvalue": "25%",
2
              "label": "Descrição",  }
            "type": "string",]
        },
    "order": 6
   {
     }
    ],
    "tableCustomActionsvisible": []false,
    "actions": {
        "newproperty": "/newprocessKey",
            "removeAlllabel": true"Chave Processo",
            "removetype": true"string",
    },
        "pageCustomActionsorder": []3
}                },
                {
                                                

Descrição dos campos:

  • keepFilters: Mantém na modal de Busca Avançada os valores preenchidos do último filtro realizado pelo usuário.
  • literals: Objeto com as literais usadas.
  • validateFields: Lista que define os campos que irão disparar o validate do form.
  • title: Título da página.
  • fields: São os campos a serem apresentados na tabela, sendo eles: 
    • property: Nome de referência do campo.
    • label: Rótulo do campo exibido.
    • type: Tipo do valor campo.
    • key: Valor lógico que indica se o campo é chave.
    • order: Informa a ordem de exibição do campo.
    • visible: Indica se o campo será visível.
    • width: Tamanho do campo.
  • tableCustomActions: Lista de ações customizadas da tabela que serão incorporadas às ações informadas através da propriedade actions.
    • actions:Ações que o usuário poderá executar na página através de botões:
    • new: Rota ou função para criar um novo recurso, caso seja preenchida habilita a ação de "Novo" na tela de listagem para criação de um novo anexo.
    • remove: Habilita a ação de exclusão na tabela.
    • removeAll: Habilita a ação de exclusão em lote na página.
  • pageCustomActions: Lista de ações customizadas da página que serão incorporadas às ações informadas através da propriedade actions. Essas ações ficam localizadas na parte superior da página em botões com ações. Ex: "Novo", "Excluir".
    • Metadados Edit:
    Bloco de código
    titleEdit
    "property": "documentName",
            "width": "20%",
            "label": "Documento",
            "type": "string",
            "order": 4
        },
        {
            "property": "documentSize",
            "width": "10%",
            "label": "Tamanho",
            "type": "string",
            "order": 5
        },
        {
            "property": "documentDescription",
            "width": "30%",
            "label": "Descrição",
            "type": "string",
            "order": 6
        },
        {
            "visible": false,
            "allowColumnsManager": true,
            "property": "creationUser",
            "width": "5%",
            "label": "Criador",
            "type": "string",
            "order": 7
        },
        {
            "visible": false,
            "allowColumnsManager": true,
            "property": "creationUserName",
            "width": "15%",
            "label": "Nome Criador",
            "type": "string",
            "order": 8
        },
        {
            "visible": false,
            "allowColumnsManager": true,
            "property": "creationDatetime",
            "width": "20%",
            "label": "Data",
            "type": "dateTime",
            "order": 9
        }
    ],
    "tableCustomActions": [],
    "actions": {
        "new": "/new",
        "removeAll": true,
        "remove": true
    },
    "pageCustomActions": []
}                                                                      

    Descrição dos campos:

    • literals: Objeto com as literais usadas.
    • validateFields: Lista que define os campos que irão disparar o validate do form.
    • title: Título da página.
    • fields: São os campos a serem apresentados na tabela, sendo eles: 
      • property: Nome de referência do campo.
      • label: Rótulo do campo exibido.
      • type: Tipo do valor campo.
      • key: Valor lógico que indica se o campo é chave.
      • order: Informa a ordem de exibição do campo.
      • visible: Indica se o campo será visível.
      • width: Tamanho do campo.
      • allowColumnsManager: Campo estará disponível no gerenciador de colunas.
    • tableCustomActions: Lista de ações customizadas da tabela que serão incorporadas às ações informadas através da propriedade actions.
    • actions:Ações que o usuário poderá executar na página através de botões:
      • new: Rota ou função para criar um novo recurso, caso seja preenchida habilita a ação de "Novo" na tela de listagem para criação de um novo anexo.
      • remove: Habilita a ação de exclusão na tabela.
      • removeAll: Habilita a ação de exclusão em lote na página.
    • pageCustomActions: Lista de ações customizadas da página que serão incorporadas às ações informadas através da propriedade actions. Essas ações ficam localizadas na parte superior da página em botões com ações. Ex: "Novo", "Excluir".


    • Metadados Edit:


    Bloco de código
    titleEdit
      {
    "defaultFields": [
        {
            "gridColumns": 4,
            "divider": "Processo",
            "label": "Tipo Processo",
            "property": "processType",
            "disabled": true,
            "options": [
                {
                    "value": 1,
                    "label": "Ordem de Compra"
                }
            ]
        },
        {
            "gridColumns": 4,
            "label": "Chave",
            "property": "processKey",
            "disabled": true
        },
        {
            "autoUpload": true,
            "gridColumns": 4,
            "divider": "Anexar Documento",
            "label": "Selecione o documento",
            "property": "documentUpload",
            "required": true,
            "type": "upload"
        },
        {
            "maxLength": 200,
            "gridColumns": 8,
            "label": "Descrição",
            "property": "documentDescription",
            "rows": 4
        }
    ],
    "title": "Novo anexo",
    "breadcrumb": {
        "items": [
            {
                "link": "/",
                "label": "Anexos de documentos"
            },
            {
                "link": "/new",
                "label": "Novo anexo"
            }
        ]
    }
}                                                                            


    Descrição dos campos:
    • defaultFields: Armazena as informações dos campos padrões do formulários: 
      • gridColumns: Tamanho de exibição do campo em telas.
      • divider: Exibirá um divisor acima, utilizando o seu conteúdo como título.
      • label: Rótulo do campo exibido.
      • property: Nome de referência do campo.
      • disabled: Função que deve retornar um booleano para habilitar ou desabilitar a ação para o registro selecionado.
      • options: Lista de opções que serão exibidas em um componente, podendo selecionar uma opção.
        • value: Valor que será usado como referência para exibição do conteúdo na coluna, representa o tipo de processo.
        • label: Rótulo do campo exibido, referenciando o nome do tipo de processo.
    • autoUpload: Define se o envio do arquivo será automático ao selecionar o mesmo.
    • required: Indica que o campo será obrigatório.
    • type: Tipo do valor do campo.
    • maxLength: Tamanho máximo de caracteres.
    • rows: Quantidade de linhas exibidas no campo "Descrição".
    • title: Título da página.
    • breadcrumb: Objeto com propriedades do breadcrumb, componente que gera uma estrutura de navegação que apresenta ao usuário a localização da URL atual, exibindo as antecessoras conforme é realizado a navegação na aplicação:
      • items: Lista de itens do breadcrumb:
        • link: Url do item.
        • label: Rótulo do item.


    • Metadados View:



    Bloco de código
    titleView
    {
    "keepfilters": false,
    "literals": {},
    "validateFields": [],
    "title": "Consulta de Anexos de Documentos",
    "fields": [
        {
            "visible": false,
            "property": "documentId",
            "label": "Código",
            "type": "number",
            "key": true,
            "order": 1
        },
        {
            "property": "processTypeDescription",
            "width": "15%",
            "label": "Tipo Processo",
            "
    gridColumns
    type":
    4
    "string",
            "
    divider
    order":
    "Processo", 
     2
        },
        {
    "label
          "property": "
    Tipo Processo
    processKey",
            "
    property
    width": "
    processType
    15%",
            "
    disabled
    label": "Chave
    true
    Processo",
            "type": "
    options": [ 
    string",
            "order": 3
    {
    },
        {
            "
    value
    property":
    1
    "documentName",
            "width": "20%",
            "label": "
    Ordem de Compra
    Documento",
            "type": "string",
    }
    ]
    "order": 4
        },
        {
            "
    gridColumns
    property":
    4
    "documentSize",
            "
    label
    width": "
    Chave
    10%",
            "
    property
    label": "
    processKey
    Tamanho",
            "
    disabled
    type":
    true }, {
    "string",
            "
    autoUpload
    order":
    true,
    5
        },
    "gridColumns": 4,
       {
            "
    divider
    property": "
    Anexar Documento
    documentDescription",
            "
    label
    width": "
    Selecione o documento
    35%",
            "
    property
    label": "
    documentUpload
    Descrição",
            "
    required
    type":
    true
    "string",
            "
    type
    order":
    "upload"
    6
        },
        {
            "
    maxLength
    visible":
    200
    false,
            "
    gridColumns
    allowColumnsManager":
    4
    true,
            "
    label
    property": "
    Descrição
    creationUser",
            "
    property
    width": "
    documentDescription
    5%",
            "
    rows
    label":
    4 
    "Criador",
    }
    ], 
        "
    title
    type": "
    Novo Documento
    string",
    "breadcrumb":
    { 
            "
    items
    order":
    [
    7
        },
    { 
        {
            "
    link
    visible":
    "/"
    false,

                "
    label
    property": "
    Documentos
    creationUserName",
    }
    "width": "20%",
    { 
    "label": "Nome Criador",
            
    "
    link
    type": "
    /new
    string",
            "order": 8
    "label": "Novo Documento"
        },
        {
    }
    ] 
    "visible": false,
    } }
     
     
     
                                                                           Descrição dos campos:
  • defaultFields: Armazena as informações dos campos padrões do formulários: 
    • gridColumns: Tamanho de exibição do campo em telas.
    • divider: Exibirá um divisor acima, utilizando o seu conteúdo como título.
    • label: Rótulo do campo exibido.
    • property: Nome de referência do campo.
    • disabled: Função que deve retornar um booleano para habilitar ou desabilitar a ação para o registro selecionado.
    • options: Lista de opções que serão exibidas em um componente, podendo selecionar uma opção.
      • value: Valor que será usado como referência para exibição do conteúdo na coluna, representa o tipo de processo.
      • label: Rótulo do campo exibido, referenciando o nome do tipo de processo.
  • autoUpload: Define se o envio do arquivo será automático ao selecionar o mesmo.
  • required: Indica que o campo será obrigatório.
  • type: Tipo do valor do campo.
  • maxLength: Tamanho máximo de caracteres.
  • rows: Quantidade de linhas exibidas no campo "Descrição".
  • title: Título da página.
    • "allowColumnsManager": true,
            "property": "creationDatetime",
            "width": "15%",
            "label": "Data",
            "type": "dateTime",
            "order": 9
        }
    ],
    "tableCustomActions": [],
    "pageCustomActions": []
}

    Possui os mesmos campos de retorno do metadados "List", sendo que a diferença é que se trata de uma tela de Consulta apenas, então, neste caso, não estão disponíveis as ações ("actions" no json), ou seja, os botões "Novo" e "Excluir" não são carregados na tela.

    A requisição é igual ao do metadados List (passando no queryparams o type = list) da api supplyDocuments, apenas alterando a api de origem que é a supplyDocumentsView. No método pi-metadata da supplyDocumentsView é feito o tratamento onde, ao receber o tipo "list" ele envia o tipo "view" para a apiDocuments fazer o tratamento e omitir os campos referente as ações da tela e exibe seu respectivo título da página

    breadcrumb: Objeto com propriedades do breadcrumb, componente que gera uma estrutura de navegação que apresenta ao usuário a localização da URL atual, exibindo as antecessoras conforme é realizado a navegação na aplicação:items: Lista de itens do breadcrumb:
  • link: Url do item.
    • label: Rótulo do item

    .

    RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante o processo de busca dos dados.

    Retorno

    Retorna informações do metadados ou erros ocorridos durante a busca

    ...

    pi-query-v1

    Requisito

    Nenhum.

    Descrição

    Repassa

    os parâmetros recebidos

    o parâmetro do tipo de evento recebido pela API de comunicação para a API de documentos (hubapi/apiDocuments) chamando o método pi-query-v1. Existem duas apis de comunicação:

    • cdp/api/v1/
    supplyDocuments)
    • supplyDocuments  : api de comunicação para a
    API de documentos (hubapi/apiDocuments) após a execução das validações de restrição, chamando o método
    • tela de anexos com as opções de criar/excluir documentos.
    • cdp/api/v1/supplyDocumentsView: api de comunicação para a tela de anexos de consulta apenas, onde somente é permitido o download dos documentos
    pi-query-v1
    • .

    Retorna a lista de anexos relacionados a um documento.

    Parâmetros

    Tipo

    		Input/Output

    Descrição

    oInput

    JsonObject

    		INPUT

    Parâmetros para a busca de anexos:

    queryParams:

    •   processType: Tipo do processo vinculado ao documento, sendo "1" a Ordem de Compra, com base na include uninc/i01un403.i.
    •   processKey: Código da chave do processo, identifica o processo ao qual o anexo pertence. A chave pode ou não ser composta. Caso seja, será separada por pipe "|" e deve ser enviada no formato encode. No exemplo abaixo, a chave "1234%7CABC" está no formato encode e corresponde a chave composta: "1234|ABC".


    Bloco de código
    titleExemplo
    {
    "queryParams": {
       "processType": "1",
       "processKey": "1234%7CABC"
  }
}

    Outros parâmetros que podem ser usados em conjunto com os queryParams de consulta dos anexos:

    • search: pesquisa por campos. Os parâmetros são os mesmos utilizados na queryParams de busca, sendo apenas adicionando o "search" na requisição juntamente com o critério de filtro que pode ser: nome do anexo, descrição do anexo ou usuário criador. No exemplo abaixo está sendo solicitada uma consulta utilizando  um filtro para mostrar apenas os documentos anexados pelo usuário "super".


    Bloco de código
    titleExemplo
    {
    "queryParams": {
       "processType": "1",
       "processKey": "1234%7CABC",
	   "search":"super"	
  }
}


    • order: Ordenação dos campos, podendo ser ascendente ou descendente ("-" sinal negativo).
      • Exemplo:
        • ordem por data ascendente: order=-createDatetime.
        • ordem por data descendente: order=-createDatetime.
    • pageSize: Tamanho da página (número de registros retornados). Se não informado será considerado: 10.


    aResultJsonArrayOUTPUT

    Retorno do processo, contendo os itens da listagem de anexos conforme parâmetros enviados.

    Bloco de código
    titleExemplo
    {
    "total": 3,
    "totalHits": 3,
    "hasNext": false,
    "items": [
        {
            "creationUserName": "Super",
            "documentDir": "c:\\tmp\\ERP\\1\\123\\5\\c3e349d230b2d176eefb7d58f2eb35e1.txt",
            "creationUser": "super",
            "documentDescription": "arquivo 123",
            "processKey": "123|5",
            "documentId": 392,
            "processType": 1,
            "documentName": "arquivo123.txt",
            "documentSize": "74 Bytes",
            "processTypeDescription": "Ordem de Compra",
            "creationDatetime": "2022-02-07T09:12:43.000"
        },
        {
            "creationUserName": "Super",
            "documentDir": "c:\\tmp\\ERP\\1\\123\\5\\e13190f35f57fcb02bcf91c799ed3191.txt",
            "creationUser": "SUPER",
            "documentDescription": "teste download",
            "processKey": "123|5",
            "documentId": 393,
            "processType": 1,
            "documentName": "testando.txt",
            "documentSize": "1GB",
            "processTypeDescription": "Ordem de Compra",
            "creationDatetime": "2022-02-07T18:01:17.000"
        },
        {
            "creationUserName": "Super",
            "documentDir": "c:\\tmp\\ERP\\2\\1234\\5\\2ca28ec306fb5e55c24448f2bdb1baa3",
            "creationUser": "SUPER",
            "documentDescription": "teste download",
            "processKey": "123|5",
            "documentId": 396,
            "processType": 1,
            "documentName": "testando.txt",
            "documentSize": "1GB",
            "processTypeDescription": "Ordem de Compra",
            "creationDatetime": "2022-02-07T18:08:29.000"
        }
    ]
}

    Para verificar o que significa cada campo, conferir no final desta documentação a descrição dos campos da temp-table: ttDocumentFile.

    lHasNextLogicalOUTPUTIndica que existem mais registros a serem mostrados
    iTotalHitsIntegerOUTPUTContagem do total de registros encontrados.
    RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante o processo.

    Retorno

     Retorna a lista de arquivos relacionados a um documento ou erros ocorridos durante a busca.

    ...

    pi-download-v1

    Requisito

    Nenhum.

    Descrição

    Repassa os parâmetros recebidos pela API de comunicação (cdp/api/v1/supplyDocuments) para a API de documentos (hubapi/apiDocuments) chamando o método pi-download-v1. Também realiza validações de restrição dos usuários em relação a menu e processosde restrição dos usuários em relação a menu e processos. Existem duas apis de comunicação:

    • cdp/api/v1/supplyDocuments  : api de comunicação para a tela de anexos com as opções de criar/excluir documentos.
    • cdp/api/v1/supplyDocumentsView: api de comunicação para a tela de anexos de consulta apenas, onde somente é permitido o download dos documentos.

    Retorna informações do arquivo em que o download está sendo efetuado.

    Parâmetros

    Tipo

    		Input/Output

    Descrição

    oInput

    JsonObject

    		INPUT

    Parâmetros para download do anexo:

    pathParams:  Informar: download e o documentId do documento.


    Bloco de código
    titleExemplo
    {
    "pathParams": [
    "download",
    "402"
  ],
}
    oOutputJsonObjectOUTPUT

    Retorno das informações do arquivo que está sendo realizado o download:


    Bloco de código
    titleExemplo
    {
    "headers": {
        "Content-Type": "application/octet-stream"
    },
    "payload": {
        "file": {
            "FN_File": "Evidencia_COD_DMANSUPIMPA2-605.docx",
            "DN_File": "UEsDBBQABgAIAAAAIQBkdsOlw57DhwEAAMOKCQAAEwAIAltD..."
        }
    }
}

    Descrição dos campos:

    • File : contém as informações do anexo
      • FN_File: Nome do arquivo com extensão, vindo da tabela arquivo_docto.
      • DN_File: Conteúdo do arquivo em base64.  


    RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante a busca dos códigos dos anexos.

    Retorno

    Retorna informações de nome e conteúdo do anexo que está sendo feito download ou erros ocorridos durante o processo.

    ...

    pi-valida-ordem

    Requisito

    Nenhum.

    Descrição

    Realiza a verificação das permissões do usuário logado em relação ao programa de ordens de compra. As validações ocorrem da seguinte forma:

    • cdp/api/vi/supplyDocuments: se for essa a api de origem, valida se o usuário possui permissão no programa html.cc0301.
    • cdp/api/vi/supplyDocumentsView: se for essa a api chamadora, valida se o usuário logado possui permissão no programa html.cc0505.

    Parâmetros

    Tipo

    		Input/Output

    Descrição

    iProcessType

    Integer

    		INPUTTipo do processo vindo da queryParams.
    RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante o processo.

    Retorno

    Informações sobre os erros ocorridos durante o processo.

    ...

    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ãoNão se aplica
    ErrorParametersCHARACTER Parâmetros da mensagem de erro SimNãoNão se aplica
    ErrorTypeCHARACTER Tipo do erro SimNãoNão se aplica
    ErrorHelpCHARACTER Texto de ajuda da mensagem de erro SimNãoNão se aplica
    ErrorSubTypeCHARACTERSubtipo do erroSimNãoNão se aplica



    ttDocumentFile

    Entrada/Saída

    Temp-table com os campos a serem retornados na busca dos documentos do processo.

    Saída

    Atributo

    		Nome no Objeto

    Tipo

    Descrição

    Obrigatório

    Evolução

    num_id_docto

    		documentId

     INTEGER

    		Número do ID do documento

    Sim

    Não se aplica

    cdn_tipo_processo

    		processTypeINTEGER Número do tipo do processo

    Sim

    Não se aplica

    desc_tipo_procesprocessTypeDescriptionCHARACTER Descrição do tipo do processoSimNão se aplica
    cod_chave_procesprocessKeyCHARACTER Código da chave do processoSimNão se aplica
    cod_usuar_doctocreationUserCHARACTER Código do usuário criadorSimNão se aplica
    nom_usuar_doctocreationUserNameCHARACTER Nome do usuário criadorSimNão se aplica
    dtm_criac_doctocreationDatetimeDATETIMEData e hora da criação SimNão se aplica
    nom_arq_docto documentNameCHARACTERNome do documentoSimNão se aplica
    nom_dir_docto documentDirCHARACTERCaminho do diretório do documentoSimNão se aplica
    ind_tam_doctodocumentSizeCHARACTERTamanho do documentoNãoNão se aplica
    des_doctodocumentDescriptionCHARACTERDescrição do documentoNãoNão se aplica