Entidade

Tomado em mão

Criação

Os dados manipulados pelo servidor XTEND provêm exclusivamente de chamada. interfaces (web services X3). Existem duas maneiras de criar estes dados ou entidades :

• seja por uma acção utilizador,
• seja por um acesso aos dados :.

Uma entidade é sempre o resultado de um "mappinh" com a estrutura de dados reenviada pelo "web service" X3 a saber :

• Os campos de um "grupo de publicação" para um sub-programa L4G,
• Os campos de um "bloco ecrã" para um objecto X3.

Entidades criadas por uma acção

Estas entidades são criadas seguinet à chamada, pelo utilzador, de um interface de tipo acção via um botão ou uma âncora.

Para optimizar os tempos de resposta e a carga do servidor de "web service" :

• Acumule a acção utilizador e a criação de entidades em retorno numa mesma chamada de "web services" antes que chamar dois "web services"

Todas as entidades emitidas de um "mapping" com uma interface de tipo "Acção" estão guardadas em memória e disponíveis a duração da sessão utilizador.

No caso onde uma acção sobre um objecto (como a validação de uma encomenda X3), as entidades represenram geralmente um sub-conjunto da encomenda X3.

Estas entidades (cabeçalho e linhas de encomedas) são conservados em memória para ser :

• afixados :
• passados em parâmetro de uma outra acção (confirmação da encomenda)
• ou bem utilizados como critérios de selecção (detalhe dos artigos).

No caso de uma acção de login utilizador o sub-programa L4G valida as informações de login, e reenvia geralmente uma estrutura de dados que contêm as informações da conta utilizador.

Estes dados poderão ser afixados ou utilizados como parâmetros de acções (código representante, código estabelecimento para a encomenda) ou de "token" blocos condicionados para gerar a afixação das páginas.

Entidades criadas por um acesso aos dados

Estas entidades são criadas em seguida a uma chamada, pelo "token bloco" inserido numa página HTML, de um interface de tipo acesso. Estas entidades podem ser consideradas como de simples registos reenviados por um pedido SQL.

Todas as entidades emitidas de um "mapping" com uma interface de tipo "Acesso" estão guardadas em memória e disponíveis apenas duração da construção da página HTML.

Os dados destas entidades podem ser utilizadas como parâmetros de acção ou como critérios de selecção nos blocos.

Neste caso, o valor está conservado no contexto de dados associados à página HTML (e não no contexto da sessão utilizador)

Este contexto está guardado na página HTML ele própria ("tag span"spécifique) e manipula pelas funções JavaScript da livraria XTEND.

Este princípio assegura um bom funcionamento das páginas com as teclas devolução (Back) e reload (F5).

Exemplo :

No caso de um catálogo de artigos, o código de artigo, emitido de um pedido sobre uma tabela X3, está conservada seguindo este princípio. Pode assim ser passado :

• em parâmetro do bloco que afixa o detalhe do artigo
• ou bem em parâmetro da acção que se acrescenta ao cesto.

Entidade ASESSION

Esta entidade está criada ao arranque da sessão. Ela permite o acesso a todos os dados da sessão utilizador.

Parametrização

A parametrização de uma entidade consite em :

• associar uma interface,
• registar a lista dos camops.

Os campos têm geralmente sido criados previamente via a função de ajuda na criação dos campos do menu "utilitários" de interface.

O menu Utilitários\Ajuda ao preenchimento propõe uma ajuda para associar os campos na entidade.

Entidade de tipo sessão

Este tipo está reservado e corrresponde às entidades internas do servidor XTEND.

ASESSION Contém os dados da sessão utilizador.

AHTMLFORM representa o conteúdo do formulário HTML do pedido HTTP corrente.

AHTTPCOOKIE representa o conteúdo dos "cookies" do pedido HTTP corrente.

Entidade de tipo sessão

Uma entidade de tipo acção criado por uma "acção" utilizador (mapping do resultado da chamada do "web service").

As entidades de tipo acção não são anexados a nenhuma interface porque ela pode potencialmente ser criados por várias interfaces.

Exemplo :

Uma entidade encomeda SOH pode ser criada palas acções Criar/Modificar/Suprimir.

Estas três acções farão referência à mesma entidade no seu "mapping"

Processo de criação das entidades acção.

1. Identifique as entidades na fase de especificação do projecto,

2. Crie as "web services" e interfaces sem forçosamnte desenvolver o código associado,

3. Gere os campos via o menu "utilitários" da ficha interface,

4. Crie as entidades e associar os campos.

 Não existe utilitário de criação automática das entidades de tipo acção a partir de uma interface.

Identificador

No momento da criação de uma entidade acção o motor XTEND cria um campo "AID" para cada entidade que coném um identificador único.

Este campo pode estar utilizado em "Scripting" servidor para os métodos removeData e getData da interface IXtdJsActEntity.

Entidade de tipo "acesso dados"

Entidade criada pela chmada de uma interface de tipo "Acesso dados" que o equivalem de um pedido SQL sobre a base X3.

O quadro "Campos"é utilizado para declarar os campos da entidade e para efectuar o "mapping" entre o código do campo XTEND (código coluna) e o nome do parâmetro sub-programa ou campo do objecto X3 (coluna parâmetros do interface).

Escolhe-se geralmente e mesmo nome excepto se existe conflito com um outro campo de tipo diferente.

O grupo de publicação da interface "Acesso dados" que contém os campos do pedido está afixado em "RES".

Processo de criação das entidades acção.

1. Gere a interface a partir de uma tabela X3 ou da lista esquerda de um objecto,

 2. Gere os campos via o menu "utilitários" da ficha interface,

3. Crie as entidades e associar os campos.

 Não existe utilitário de criação automática das entidades de tipo "acesso dados" a partir de uma interface na versão actual.

Pré-requisitos

Consulte a docuemntação de Implementação

Gestão do ecrã

Cabeçalho

Separador Generalidades

Listagens

Por defeito, os seguintes listagens estão associados à função :

 PRTSCR : Impressão ecran

Mas pode ser alterado por parametrização.

Botões específicos

Barra de menu

Utilitários / Ajuda preenchimento

Ajuda à criação das entidades

Ver a documentação de tomado em mão da função.

Esta função permite criar as entidades a partir dos parâmetros de um interface.

1. Abrir a função Entidade,

2. Criar uma nova Entidade,

3. Seleccionar o tipo de interface :

4. Para o tipo "Acesso tabela" seleccionar a interface que será anexada à entidade,

5. Activar o menu "Utilitários/Ajuda ao preenchimento"

Apos ter seleccionada de interface, a lista dos parâmetros reagrupados por grupos de publicação está afixada :

Processo de criação :

• seleccione os campos por duplo-clique sobre a primeira coluna,
• depois seleccione um "token" campo na coluna "Token" campo.

 É aconselhado criar todos os campos XTEND previamente via a função utilitária "Criação dos campos".
Se o camop não existe você pode aceder à função "Token" campo por F12 para o criar

Utilitários / Validação com verificação

Validação com uma verificação da coerência dos dados do dicionário XTEND.

Mensagens de erro

Não existe outra mensagem de erro, para além das mensagens genéricas.

Tabelas consideradas

Consulte a docuemntação de Implementação