Histórico da Página
...
- Visão Geral clique no conteúdo para acesso rápido à informação desejada ↓
- API x Pontos UPC Relacionados
- JSON de metadata
- Especificidades de Customização
- Observações Gerais
01. Visão Geral Âncora1 1
1 | |
1 |
Este documento tem como objetivo descrever o que poderá ser customizado na tela HTML do programa Processo de Embarques item de menu Embarque (html-meq.shippingProcess), aqui será descrito quais componentes e elementos podem ser customizados.
...
Segue a lista de APIs e Pontos de UPC responsáveis pelo processamento da interface dinâmica e dos dados do programa.
Para maiores detalhes de como cadastrar uma UPC para essa API podem ser visualizados aqui.
- Tela Embarques:
API REST: eqp/api/v1/shipping.p, eqp/api/v1/shippingOrder.p, eqp/api/v1/shippingAllocation.p
URL base para embarques: https://<servidor>:<porta>/api/eqp/v1/shipping
- URL base para aba de pedidos: https://<servidor>:<porta>/api/eqp/v1/shippingOrder
- URL base para aba de alocações: https://<servidor>:<porta>/api/eqp/v1/shippingAllocation
- Tela Pedidos:
- API REST PEDIDOS: eqp/api/v1/ordersForShipping.po
URL base para pedidos: https://<servidor>:<porta>/api/eqp/v1/ordersForShipping
Manipulação de Objetos da Interface (Metadata) - Tela Embarques | |||||
---|---|---|---|---|---|
Método (API) | Endpoint (API) | Endpoint (UPC) | Evento (UPC) | Entrada (UPC) | Observação |
GET | URL_Base/metadata/?type=list | getMetaData | list | Metadados | Estrutura metadados da listagem. |
GET | URL_Base/metadata/?type=new | getMetaData | new | Metadados | Estrutura metadados da tela de inclusão. |
GET | URL_Base/metadata/<código do embarque>?type=edit | getMetaData | edit | Metadados | Estrutura metadados da tela de edição. |
GET | URL_Base/metadata/<código do embarque>?type=copy | getMetaData | new | Metadados | Estrutura metadados da tela de cópia |
GET | URL_Base/metadata/<código do embarque>?type=detail | getMetaData | detail | Metadados | Estrutura metadados da tela de detalhes. |
Manipulação de Objetos da Interface (Metadata) - Tela Pedidos | |||||
---|---|---|---|---|---|
Método (API) | Endpoint (API) | Endpoint (UPC) | Evento (UPC) | Entrada (UPC) | Observação |
GET | URL_Base_pedidos/metadata/?type=list | getMetaData | list | Metadados | Estrutura metadados da listagem. |
Manipulação de Dados - Tela Embarques | |||||
---|---|---|---|---|---|
Método (API) | Endpoint (API) | Endpoint (UPC) | Evento (UPC) | Entrada (UPC) | Observação |
GET | URL_Base/<código do embarque> | findById | findById | Dados do registro | Executado depois de buscar um registro específico. |
GET | URL_Base?pageSize=20&page=1 | findAll | findAll | Dados dos registros | Executado depois de buscar os registros. |
POST | URL_Base | create | beforeCreate | Payload* | Executado antes de criar o cabeçalho do embarque. |
POST | URL_Base | create | afterCreate | Payload* | Executado depois da criação do cabeçalho do embarque. |
PUT | URL_Base/<código do embarque> | update | beforeUpdate | Payload* | Executado antes da alteração do cabeçalho do embarque. |
PUT | URL_Base/<código do embarque> | update | afterUpdate | Payload* | Executado depois da alteração do cabeçalho do embarque. |
DELETE | URL_Base/<código do embarque> | delete | beforeDelete | Vazio | Executado antes da eliminação de um registro. |
DELETE | URL_Base/<código do embarque> | delete | afterDelete | Vazio | Executado depois da eliminação de um registro. |
POST | URL_Base/terminate/<código do embarque> | terminate | beforeTerminate | Payload* | Executado antes de finalizar o embarque. |
POST | URL_Base/terminate/<código do embarque> | terminate | afterTerminate | Payload* | Executado depois de finalizar o embarque. |
POST | URL_Base/validate | validateForm | validateForm | Form* | Executa ao sair de algum campo que possui validação, por exemplo o externo (cabeçalho do embarque, aba de informações complementares). |
POST | URL_Base/wms/<código do embarque> | embarqueWMS | beforeEmbarqueWMS | Dados do registro | Executado antes de integrar o embarque para o WMS. |
POST | URL_Base/wms/<código do embarque> | embarqueWMS | afterEmbarqueWMS | Dados do registro | Executado depois de integrar o embarque para o WMS. |
Manipulação de Dados - Aba pedidos | |||||
Método (API) | Endpoint (API) | Endpoint (UPC) | Evento (UPC) | Entrada (UPC) | Observação |
GET | URL_Pedidos/orders/<código do embarque> | findById | findById | Dados do registro | Executado depois de buscar um registro específico. |
GET | URL_Pedidos/orderDeposits/<chave completa da linha> | ordersDeposit | ordersDeposit | Dados do registro | Executado depois de buscar um registro específico. |
POST | URL_Pedidos/totalAllocation/<código do embarque> | totalAllocation | beforeTotalAllocation | Dados do registro | Executado antes de alocar totalmente o resumo |
POST | URL_Pedidos/totalAllocation/<código do embarque> | totalAllocation | afterTotalAllocation | Dados do registro | Executado depois de alocar totalmente o resumo |
POST | URL_Pedidos/allocatePartial/<código do embarque> | partialAllocation | beforePartialAllocation | Dados do registro | Executado antes de alocar parcialmente o resumo |
POST | URL_Pedidos/allocatePartial/<código do embarque> | partialAllocation | afterPartialAllocation | Dados do registro | Executado depois de alocar parcialmente o resumo |
POST | URL_Pedidos/allocateCompound/<código do embarque> | allocateCompound | beforeAllocateCompound | Dados do registro | Executado depois de alocar o resumo composto |
POST | URL_Pedidos/allocateCompound/<código do embarque> | allocateCompound | afterAllocateCompound | Dados do registro | Executado depois de alocar o resumo composto |
POST | URL_Pedidos/allocateOrder/<código do embarque> | allocateOrder | beforeAllocateOrder | Dados do registro | Executado antes de alocar o pedido completo |
POST | URL_Pedidos/allocateOrder/<código do embarque> | allocateOrder | afterAllocateOrder | Dados do registro | Executado antes de alocar o pedido completo |
Manipulação de Dados - Aba alocações | |||||
Método (API) | Endpoint (API) | Endpoint (UPC) | Evento (UPC) | Entrada (UPC) | Observação |
GET | URL_Alocações | findById | findById | Dados do registro | Executado depois de buscar um registro específico. |
GET | URL_Alocações/allocationsCompound/<chave linha> | allocationsCompound | allocationsCompound | Dados do registro | Executado depois de buscar um registro específico. |
POST | URL_Alocações/deallocateCompound | deallocateCompound | beforeDeallocateCompound | Dados do registro | Executado antes de desalocar totalmente o composto |
POST | URL_Alocações/deallocateCompound | deallocateCompound | afterDeallocateCompound | Dados do registro | Executado depois de desalocar totalmente o composto |
POST | URL_Alocações/deallocateOrder | deallocateOrder | beforeDeallocateOrder | Dados do registro | Executado antes de desalocar totalmente o pedido |
POST | URL_Alocações/deallocateOrder | deallocateOrder | afterDeallocateOrder | Dados do registro | Executado depois de desalocar totalmente o pedido |
POST | URL_Alocações/totalDeallocate | totalDeallocation | beforeTotalDeallocation | Dados do registro | Executado antes de desalocar totalmente o resumo |
POST | URL_Alocações/totalDeallocate | totalDeallocation | afterTotalDeallocation | Dados do registro | Executado depois de desalocar totalmente o resumo |
POST | URL_Alocações/partialDeallocate | partialDeallocation | beforePartialDeallocation | Dados do registro | Executado antes de desalocar parcialmente o resumo |
POST | URL_Alocações/partialDeallocate | partialDeallocation | afterPartialDeallocation | Dados do registro | Executado depois de desalocar parcialmente o resumo |
POST | URL_Alocações/saveNarrative | saveNarrative | beforeSaveNarrative | Dados do registro | Executado antes de salvar o resumo da linha |
POST | URL_Alocações/saveNarrative | saveNarrative | afterSaveNarrative | Dados do registro | Executado depois de salvar o resumo da linha |
...
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "cargoType": "", "natOperacao": "", "shippingCompany": "", "freteGfeTabGener": null, "availableToAddOrders": true, "numExpShipping": "", "salesChannel": 0, "estabShipping": "1", "allowBeforeWMS": false, "moduloEx": null, "licensePlate": "", "route": "", "dateShipping": "2024-07-18", "driver": "eu", "integWMS": null, "sitFatur": 1, "negativeBalanceLot": "", "state": " ", "identShipping": "13", "externalDeposit": "", "codShipping": 2022031588890066, "sitShipping": 3 } |
Manipulação de Dados - Tela Pedidos | |||||
---|---|---|---|---|---|
Método (API) | Endpoint (API) | Endpoint (UPC) | Evento (UPC) | Entrada (UPC) | Observação |
GET | URL_Base_pedidos?pageSize=20&page=1 | findAll | findAll | Dados dos registros | Executado depois de buscar os registros. |
03. JSON de metadata Âncora3 3
3 | |
3 |
...
Campo | Descrição | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
orders | Coluna da tabela principal do step de "Pedidos", pode ser incluído mais colunas ou excluído as colunas padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-table, a interface PoTableColumn é implementada. OBS: Nessa tabela as ações são feitas utilizando cellTemplate e montadas as ações de alocar total e parcial dependendo se na linha pode ou não alocar parcialmente e/ou totalmente, ou seja, caso queira alterar para que essa ação não apareça deve ir na API de dados e não retornar ableToAllocate ou ableToAllocatePartially no objeto da linha em questão.
| ||||||||||
ordersSearch | Campos de busca avançada e do botão de alocar pedido, aba de cliente/pedido, pode incluir campos novos ou remover os padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-dynamic-form, a interface PoDynamicFormField é implementada.
| ||||||||||
ordersFilter | Campos do busca avançada, aba de filtros, podem incluir campos novos ou remover os padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-dynamic-form, a interface PoDynamicFormField é implementada.
| ||||||||||
modalPartialAllocateView | Campos que serão exibidos no cabeçalho da modal de alocação parcial para item normal, podem ser incluídos novos campos ou removido os padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-dynamic-view, a interface PoDynamicViewField é implementada.
| ||||||||||
modalPartialAllocateTable | Colunas da tabela de alocação parcial para item normal, podem ser incluído mais colunas ou excluído as padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-table, a interface PoTableColumn é implementada.
| ||||||||||
modalCompoundView | Campos que serão exibidos no cabeçalho da modal de alocação parcial para item composto, podem ser incluídos novos campos ou removido os padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-dynamic-view, a interface PoDynamicViewField é implementada.
| ||||||||||
modalCompoundTable | Colunas da tabela de alocação parcial para item composto, pode ser incluído mais colunas ou excluído as colunas padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-table, a interface PoTableColumn é implementada.
| ||||||||||
modalCompoundTablePhysical | Colunas da tabela de alocação parcial para item composto onde a alocação é física, pode ser incluído mais colunas ou excluído as padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-table, a interface PoTableColumn é implementada.
| ||||||||||
modalCompoundTableDeposits | Colunas da tabela de depósitos do filho para alocação parcial do item composto, pode ser incluído mais colunas ou excluído as padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-table, a interface PoTableColumn é implementada.
| ||||||||||
modalTotalAllocationProcessTable | Colunas da tabela de resultado a alocação total, pode ser incluído mais colunas ou excluído as padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-table, a interface PoTableColumn é implementada.
|
...
Campo | Descrição | ||||||
---|---|---|---|---|---|---|---|
finalizedShipping | Campos que serão exibidos ao finalizar o embarque, pode ser incluído novos campos ou removido os padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-dynamic-view, a interface PoDynamicViewField é implementada.
|
C) Tela - Resumo/Detalhe do Embarque Âncora 4c 4c
Campo | Descrição | |||||
---|---|---|---|---|---|---|
title | Título da página, aqui é apresentado o título recebido do metadata mais o número do embarque que está sendo apresentado.
| |||||
breadcrumb | Gera uma estrutura de navegação que apresenta a localização da URL atual, exibindo as antecessoras conforme é realizada a navegação na aplicação, é possível remover ou adicionar mais itens na lista. Na tela de resumo/detalhe por padrão vai aparecer dois itens, a página atual "Resumo Embarque" que não pode ser clicado e a tela de "Lista de Embarques" que ao clicar leva para a rota enviada no link, conforme exemplo abaixo.
| |||||
header | Campos que serão exibidos na segunda aba do resumo/detalhe do embarque, é feito uma concatenação com o "headerOptional" para exibir em um po-dynamic-view, pode ser incluído novos campos ou removido os padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-dynamic-view, a interface PoDynamicViewField é implementada.
| |||||
headerOptional | Campos que serão exibidos na segunda aba do resumo/detalhe do embarque, é feito uma concatenação com o "header" para exibir em um po-dynamic-view, pode ser incluído novos campos ou removido os padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-dynamic-view, a interface PoDynamicViewField é implementada.
| |||||
columnsResume | Coluna da tabela principal da aba de "Resumo", pode ser incluído mais colunas ou excluído as colunas padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-table, a interface PoTableColumn é implementada.
| |||||
columnsItens | Expansão da tabela principal, onde mostra os itens vinculados ao resumo, pode ser incluído mais colunas ou excluído as colunas padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-table, a interface PoTableColumn é implementada. Obs: nesta tabela o gerenciador de colunas é escondido, então mesmo que enviado a propriedade "allowColumnsManager" como true ela é desconsiderada.
| |||||
viewItens | Campos apresentados na expansão da tabela de itens, pode ser incluído novos campos ou removido os padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-dynamic-view, a interface PoDynamicViewField é implementada.
| |||||
columnsPackaging | Expansão da tabela principal, onde mostra as embalagens vínculados ao resumo, pode ser incluído mais colunas ou excluído as colunas padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-table, a interface PoTableColumn é implementada. Obs: nesta tabela o gerenciador de colunas é escondido, então mesmo que enviado a propriedade "allowColumnsManager" como true ela é desconsiderada.
| |||||
modalColumnsDeposit | Tabela da modal de listagem de depósitos do item, onde mostra o item e quais depósitos estão vinculados a ele, pode ser incluído mais colunas ou excluído as padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-table, a interface PoTableColumn é implementada.
| |||||
modalDepositView | Campos que serão exibidos no cabeçalho da modal de informações do do item, podem ser incluídos novos campos ou removido os padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-dynamic-view, a interface PoDynamicViewField é implementada.
|
d) Tela - Listagem de Pedidos Âncora 4d 4d
A tela de listar não foi desenvolvida utilizando o componente dinâmico completo, como o po-page-dynamic-table por exemplo, e sim usando po-page-list com uma po-table, por conta disso alguns elementos da tela não podem ser customizados e algumas propriedades do metadata são utilizados de forma um pouco diferente, a seguir a descrição de cada customização possível.
Propriedade | Description | |||||
---|---|---|---|---|---|---|
title | Título da página.
| |||||
pageCustomActions | Utilizado para remover os botões padrões ou para inserir novos botões, o botão inserido aqui deve conter label.
| |||||
tableCustomActions | Utilizado para remover os botões padrões ou para inserir novos. Para que uma ação padrão não seja criada basta que o metadata não contenha o seu label, caso necessário criar uma ação diferente ela deve possuir tanto label quanto url. Para mais informações sobre o que pode ser enviado consultar a documentação do po-table, a interface PoTableAction é implementada.
| |||||
fields | Utilizado para dizer quais campos devem aparecer na tabela, pode ser incluídos novos campos, ou retirado os que padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-table, a interface PoTableColumn é implementada.
650 | |||||
advancedFilters | Utilizado para montar o busca avançada, pode ser removido filtros ou incluídos novos (mas para que esses valores sejam considerados a API dos dados precisa ser customizada também). Para mais informações sobre o que pode ser enviado consultar a documentação do po-dynamic-form, a interface PoDynamicFormField é implementada.
| |||||
columnsDeliveries | Utilizado para dizer quais campos devem aparecer na tabela de resumos, pode ser incluídos novos campos, ou retirado os que padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-table, a interface PoTableColumn é implementada.
| |||||
columnsCompoundSonDeliveries | Utilizado para dizer quais campos devem aparecer na tabela de informações dos itens filhos de um item composto/configurado, pode ser incluídos novos campos, ou retirado os padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-table, a interface PoTableColumn é implementada.
| |||||
columnsVinculateShipping | Utilizado para dizer quais campos devem aparecer na tabela de viculação de embarques, pode ser incluídos novos campos, ou retirado os que padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-table, a interface PoTableColumn é implementada.
| |||||
modalVinculateShippingResult | Utilizado para dizer quais campos devem aparecer na tabela de resultados da vinculação de embarques, pode ser incluídos novos campos, ou retirado os que padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-table, a interface PoTableColumn é implementada.
| |||||
modalVinculateShippingErrors | Utilizado para dizer quais campos devem aparecer na tabela de erros na vinculação de embarques, pode ser incluídos novos campos, ou retirado os que padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-table, a interface PoTableColumn é implementada.
|
e) Tela - Detalhes do Pedido Âncora 4e 4e
A tela de detalhes do pedido não foi desenvolvida utilizando o componente dinâmico completo, como o po-page-dynamic-table por exemplo, e sim usando po-page-default com um po-dynamic-view e um po-table, por conta disso alguns elementos da tela não podem ser customizados e algumas propriedades do metadata são utilizados de forma um pouco diferente, a seguir a descrição de cada customização possível.
Propriedade | Description | |||||
---|---|---|---|---|---|---|
title | Título da página, é feito a concatenação do titulo recebido do metadata mais o número do pedido.
| |||||
breadcrumb | Usado para gerar uma estrutura de navegação que apresenta a localização da URL atual, exibindo as antecessoras conforme é realizado a navegação na aplicação, pode ser alterado tanto o link quanto o label deste componente, assim como removê-lo ou adicionar mais.
| |||||
dynamicViewField | Campos que serão exibidos no cabeçalho, podem ser incluídos novos campos ou removido os padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-dynamic-view, a interface PoDynamicViewField é implementada.
| |||||
pageCustomActions | Utilizado para remover os botões padrões ou para inserir novos. Para que uma ação padrão não seja criada basta que o metadata não contenha o seu label, caso necessário criar uma ação diferente ela deve possuir tanto label quanto url.
| |||||
deliveriesTableColumns | Utilizado para dizer quais campos devem aparecer na tabela de entregas do pedido, pode ser incluídos novos campos, ou retirado os padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-table, a interface PoTableColumn é implementada.
| |||||
columnsCompoundSonDeliveries | Utilizado para dizer quais campos devem aparecer na tabela de informações dos itens filhos de um item composto/configurado, pode ser incluídos novos campos, ou retirado os padrões. Para mais informações sobre o que pode ser enviado consultar a documentação do po-table, a interface PoTableColumn é implementada.
| |||||
accordionOrderDetailsTitle | Titulo do Accordion dos detalhes do cabeçalho do pedido, é uma String concatenada com virgula entre cada label enviado no metadata, caso venha "options" o valor utilizado será o label dentro de cada opção, campo de data serão formatados para o formato brasileiro.
|
05. Observações Gerais
Âncora | ||||
---|---|---|---|---|
|
...