| oOutput | JsonObject | OUTPUT | Retorno contendo o metadados com campos e ações conforme parâmetros recebidos:
| Bloco de código |
|---|
| {
"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".| Bloco de código |
|---|
| {
"defaultFields": ["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
},
{
"gridColumnsvisible": 4false,
"dividerallowColumnsManager": "Processo"true,
"labelproperty": "Tipo ProcessocreationUser",
"propertywidth": "processType5%",
"disabledlabel": true"Criador",
"optionstype": ["string",
"order": 7
{ },
{
"valuevisible": 1false,
"allowColumnsManager": true,
"labelproperty": "Ordem de CompracreationUserName",
}"width": "15%",
]
}"label": "Nome Criador",
{
"gridColumns"type": 4,
"label": "Chave"string",
"propertyorder": "processKey",
"disabled": true8
},
{
"autoUploadvisible": truefalse,
"gridColumnsallowColumnsManager": 4true,
"dividerproperty": "Anexar DocumentocreationDatetime",
"labelwidth": "Selecione o documento20%",
"propertylabel": "documentUploadData",
"requiredtype": true"dateTime",
"typeorder": "upload"9
},
{],
"maxLength"tableCustomActions": 200[],
"gridColumnsactions": 4,
{
"labelnew": "Descrição/new",
"propertyremoveAll": "documentDescription"true,
"rowsremove": 4true
}
],
"titlepageCustomActions": "Novo Documento",
"breadcrumb": {
"items": [
{
"link": "/",
"label": "Documentos"
},
{
"link": "/new",
"label": "Novo Documento"
[]
} |
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".
| Bloco de código |
|---|
| {
"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.
| Bloco de código |
|---|
| {
"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",
"type": "string",
"order": 2
},
{
"property": "processKey",
"width": "15%",
"label": "Chave Processo",
"type": "string",
"order": 3
},
{
"property": "documentName",
"width": "20%",
"label": "Documento",
"type": "string",
"order": 4
},
{
"property": "documentSize",
"width": "10%",
"label": "Tamanho",
"type": "string",
"order": 5
},
{
"property": "documentDescription",
"width": "35%",
"label": "Descrição",
"type": "string",
"order": 6
},
{
"visible": false,
"allowColumnsManager": true,
"property": "creationUser",
"width": "5%",
"label": "Criador",
"type": "string",
"order": 7
},
{
"visible": false,
"property": "creationUserName",
"width": "20%",
"label": "Nome Criador",
"type": "string",
"order": 8
},
|
]}
} 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. "visible": false,
"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. |
