Interface
Antes de criar o seu estabelecimento, é preferível ler a documentação :Antes de começar.
A função principal da ficha de parametrização "interface" é de identificar e localizar um web service X3 em fornecendo :
- o seu nome de publicação ou alias,
- as coordenadas do servidor de web service que entrega o serviço.
As interações entre uma aplicação web XTEND e o back-office X3 coloca em jogo duas categorias de serviços :
- os serviços de tipo "Aceso" que descrevem os acessos aos dados,
- os serviços de tipo "Acção" que descrevem as acções utilizadores.
O número de parâmetros dos web services de tipo "Acess" ou "Acção sub-programa" está limitado a 50.
Em modo "web service", a variável global X3 GUSER contém o código utilizador X3 pasado em parâmetro no momento da chamada do "web service".
XTEND valoriza o código utilizador X3 em função do facto que o utilizador esteja assinado ou não:
- O utilizador XTEND não assinado utiliza o código utilizador X3 definido por defeito na Pool "web service".
- O utilizador XTEND assinado utiliza o código utilizador X3 que é devolvido pela função de "login"
Interfaces de tipo "Acesso"
O servidor XTEND não acede directamente na base de dados X3 via um conector de base de dados, mas através de chamada de web services especializados : de tipo sub-programa ou lista esquerda.
As interfaces de tipo "Acesso" permitem definir estes web services que funcionam como fornecedores de dados (data providers)
Estes web services são chamados pelos "tokens" de tipo bloco.
Acesso gerado tabela
Permite gerar automaticamente um "web service" para aceder aos registos de uma tabela da base de dados X3:
1. Geração de um tratamento L4G,
2. Criação de uma ficha na tabela dos sub-programas,
3. Publicação do "web service"
O "web service" gerado está imediatamente operacional sobre todos os servidores de "web services" que publicam o dossier.
Acesso gerado vista
Idem "Acesso gerado tabela" mas pelas vistas X3.
Acesso lista esquerda
Permite de utilizar o "web service" "lista esquerda" de um objecto X3 como fonte de dados.
Acesso "sub-programa"
O tipo Acesso de sub-programa é geralmente utilizado para acrescentar os camops calculados aos campos da tabela/vista na qual se pretende aceder.
Exemplos: : acrescentar a disponibilidade e o preço dos artigos num catálogo.
Para calcular os valores dos campos "calculados" falta poder passar ao tratamento L4G dos parâmetros contextuais complementares àqueles que passados em standard pelo servidor XTEND via os parâmetros AXPARCOD e AXPARVAL (ver as acções utilizadores).
Exemplos: : um código cliente ou uma quantidade/data registada pelo utilizador.
Quadro de parâmetros "acesso sob-programa"
Este quadro permite de definir a lista dos parâmetros complementares.
O valor dos parâmetros de tipo "registado" e preenchido na ficha "token" ligação dinâmica ou Bloco.
Contrariamente às acções utilizador, o acesso sub-programa não permite de registar o "mapping" dos parâmetros.
O quadro dos parâmetros pode ser considerado como um "mapping" sobre a lista dos parâmetros AXPARCOD/AXPARVAL.
Optimizações
Como para acesso gera a tabela, é por vezes necessário de optimizar a chamada dos "web services" para melhorar os tempos de respostas.
- Este quadro permite ao programador definir (registar) os seus próprios tipos de optimizações.
- O servidor XTEND valorizará o parâmetro $OPTIMZE no momento da chamada do web service
- O programador L4G terá em carga de realizar o tratamento de optimização em função do valor do parâmetro.
Interfaces de tipo "Acção"
Os interfaces de tipo "acção utilizador" permitem definir os web services (tratamentos L4G) que agem sobre os dados do back-office X3.
A interface "Acção" está associada a uma ficha. acção web que permite descrever o "mapping" dos parâmetros.
Estas acções web são associadas aos "tokens" de tipo ligação dinâmica para ser inserido nos elementos de interface gráfica como os botões (<input type="button" onClick="">) ou as âncoras(<a href="button" onClick="">).
Acção utilizador
Uma acção utilizador XTEND se traduz sempre pela chamada de um "web service" X3 que pode seja um sub-programa seja uma acção associada a um objecto X3
Uma acção XTEND espera os parâmetros em entrada, efectua um tratamento e valoriza um certo número de parâmetros em devolução como chamada de um sub-progrrma em L4G.
No caso de uma aplicação XTEND, os parâmetros em entrada são geralmente registados pelo utilizador num formulário HTML e os valores reenviados pelo sub-programa estão guardados em memória na sessão utilizador (mapping) no objectivo de ser afixado numa página HTML ou utilizadas como parâmetros de outras acções.
Acção sub-programa
Previamente falta ter programado o tratamento L4G e ter criado a ficha sub-programa.
Uma vez o interface criado, o botão "Gerar o acesso" permite publicar o web service.
Acção objecto X3
O código da acção X3 (botão de acção do objecto) foi preenchida na ficha acção web.
Uma vez o interface criado, o botão "Gerar o acesso" permite publicar o web service.
Gestão do ecrã
Cabeçalho
Campos
Os seguintes campos estão presentes neste separador :
| Código do interface |
| Estabelecimento Web corrente. |
| Permet de définir un intitulé associé à chaque fiche. |
Fechar
Separador Geral
Apresentação
Parâmetros gerais da interface
Os parâmetros a registar dependem do tipo de interface seleccionado.
Fechar
Campos
Os seguintes campos estão presentes neste separador :
Tipo de interface
| Os interfaces de tipo "acesso aos dados" :
Os interfaces de tipo "ação" :
|
Tabela/View
| Código da tabela para um "Acesso gerado tabela". |
| Código da vista para um "Acesso gerado vista". |
Assunto
| Código objeto para os tipos de interface "Ação utilizador objeto" e "Acesso dados lista esquerda" |
| Código da transação para as interfaces de tipo "Acesso dados lista esquerda" e "Ação utilizador objeto" |
| Este campo permite tomar em conta as zonas invisíveis para o web service objeto no caso das interfaces "Acesso lista esquerda" e "Ação utilizador objeto". |
|
|
Subprograma
| Nome do tratamento chamado pelo web service. Este campo está a preencher unicamente para os interfaces "Acesso dados sub-programa" e "Ação utilizador sub-programa".
|
| Nome do sub-programa chamado pelo web service. Este campo está a preencher unicamente para os interfaces "Acesso dados sub-programa" e "Ação utilizador sub-programa".
|
Publicação
| Nome de publicação do web service. |
| Número máximo de registos reenviados pelo web service, modificável via o botão "Gerar o acesso". |
|
|
|
|
Fechar
Separador Avançado
Campos
Os seguintes campos estão presentes neste separador :
Afixação das mensagens de tipo
| Um web service X3 pode reenviar as mensagens de tipo :
O facto de assinalar um tipo de mensagem indica ao servidor XTEND que deve tomar em conta este tipo de mensagem em volta da chamada do web service para afixar via o "token" campo de nome AMSGUSER. |
|
|
|
|
| Os interfaces dos tipos "Acesso" são os mais solicitados pelo motor XTEND ; a "fluidez" do estabelecimento web depende fortemente dos tempos de resposta dos web services chamados. Este quadro propõe, para cada tipo de acesso, a lista das otimizações possíveis que são selecionadas no momento da chamada nos "token" bloco. |
Pool
| A pool de web service permite localizar o web service :
|
| Código da pool XTEND, se esta é diferente da pool por defeito registadao ao nível do parãmetro "estabelecimento web". Utilizar uma pool XTEND particular para um interface permite de repartir a carga entre diferentes pools de conexão quando se dispunha de pouco de licenças web services. Exemplo: A pool por defeito pode ser utilizada para a chamada dos web services interativos a fracos tempos de resposta. |
Acesso
| Este parâmetro permite controlar o acesso aos web services via os perfis :
Este parâmetro está geralmente utilizado pelas aplicações que utilizam as bibliotecas AJAX de XTEND. |
|
|
Quadro Param. Acesso subprograma
| Código do parâmetro |
| Tipo de valor para o parãmetro :
|
| Valor de um parâmetro de tipo "Constante". |
Fechar
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
Este botão permite copiar uma interface. |
Os seguintes campos estão presentes na janela aberta por este botão : Bloco número 1
Quadro Interface
Fechar "Esta documentação descreve o botão-ícone [Gerar o acesso]. Este botão permite gerar automaticamente o web service cujo nome de publicação está definido no interface. O "web service" gerado está imediatamente operacional sobre todos os servidores de "web services" que publicam o dossier.
O botão "Gerar o acesso" efectua as operações seguintes :
para os interfaces de tipo : Acesso dado tabela, Acesso dados vista O tratamento e a ficha sub-programa são gerados automaticamente. Acesso dados sub-programa, acção utilizador sub-programa O tratamento e a ficha sub-programa devem estar criados manualmente antes de gerir o acesso. Acção utilizador objecto, Acesso dados lista esquerda Não existe tratamento nem de ficha sub-programa a criar. |
Barra de menu
Utilitários / Cópia Web Service
O utilitário cópia "web service" permite seleccionar uma ou várias interfaces (campo interface vazio) de um estabelecimento XTEND do dossier X3 corrente e de copiar/publicar os "web services" associados a um outro dossier.
Para activar a cópia falta seleccionar pelo menos uma interface na lista.
Cópia de um sub-programa
- Cópia de um "web service" tratamento L4G,
- Criação da ficha "sub-programa",
- Publicação do "web service"
Cópia de um "web service" objecto X3
- Publicação do "web service"
Origem/Dossier : Dossier corrente.
Origem/Estabelecimento Web : Código do estabelecimento XTEND que permite de afixar a lista dos interfaces (Estabelecimento corrente por defeito).
Origem/Interface : Código de interface para afixar que os "web services" desta interface.
Destino/Dossier : Dossier de destino para a cópia.
Utilitários / Criação "token" campo
Este utilitário permite criar os "tokens" campos a partir :
- da lista dos campos de uma tabela X3,
- da lista dos campos de uma vista X3,
- dos parâmetros do "web service" associado a uma interface
Coluna : | Descrição |
Parâmetro | Código do campo da tabela ou do parâmetro do "web service" |
Título | Intitulado do campo |
"Token" campo | Código "XTEND" para o parãmetro (mesmo código por defeito) |
Existe | Assinalado se o campo já existe no dicionário |
Tipo | Tipo de campo (XTEND) |
Menu | Identificação do menu para o tipo MenuLocal |
dimensão | Número máximo de valores do parâmetro ou campo |
Geração | Para os campos de dimensão superior a 1, indica se falta gerar um índice (NOMCHAMP + INDICE). |
Índice | Índice do campo para cálculo do nome |
Valide os campos após a geração para que eles sejam tomados em conta pelo servidor XTEND.
A validação gera um novo dicionário XML dos parâmetros XTEND.
O novo dicionário não está tomado em conta automaticamente sobre "reload/F5" da página HTML no navegador que se a opção da ficha de parametrização do estabelecimento "Técnica \ Verificar actualizações \ Dicionário web" está assinalado.
Senão falta forçar o recarregamento do dicionário com URL :
'http://hostname:port/xtend/svc/SolutionX3/DossierX3/SiteXtend/admin/reposit/reload'