Esta descrição comporta dois tipos de indicações : Aquelas relevando da norma SData e aquelas específicas a X3.
Norme SData
As informações relativas ao standard SData são disponíveis ao endereço seguinte : http://interop.sage.com/daisy/sdata/Metadata/TypicalSDataSchema.htm.
Indicações específicas Safe X3
- Baliza esquema.
Indicação do NomeSpace (serp) utilizado por "Safe X3" para identificar as informações específicas no esquema.
xmlns:serp="http://schemas.sage.com/sdata/serp/2010"
- Baliza importação.
Esta baliza permite referenciar outras descrições XSD necessária a utilização do presente contrato. - serp:conName="xxxxxx".
Este atributo permite de indicar o código "Safe X3" do contrato importado. No quadro do contrato CRM, trata-se aqui de referenciar o nome do contrato "comum" em Sage X3, que contém a descrição dos recursos comuns a todos os contratos e necessários ao contrato CRM.
- Baliza complexTypecom um atributo nomeda forma xxxx--tipo.
Esta baliza pertence ao standard SData e descreve a estrutura de um recurso.
Sobre esta "tag", os atributos específicos "Safe X3" podem ser acrescentados : - serp:trtCode="STRGC1TRAACO".
Este atributo permite indicar o código do tratamento "Safe X3" que toma em carga a gestão dos acessos ao recurso : operações CRUDT (Criar, Ler, Update, Apagar, Template), - serp:stcResCode="GC1TRAACO".
Este atributo permite de indicar o código da estrutura "Safe X3" Este atributo permite indicar o código da estrutura "Safe X3" que toma em carga o recurso, - serp:stcClobMaxSize="12".
Este atributo permite indicar o tamanho máximo do "clob" permitem gerir a troca dos dados entre o servidor "Safe X3" e o componente "Safe X3 Java Bridge Server".
- Baliza complexTypecom um atributo nomeda forma xxxx--tipo.
Esta baliza pertence ao standard SData e descreve o acesso a uma coleção de um recurso.
Sobre esta "tag", os atributos específicos "Safe X3" podem ser acrescentados : - serp:trtCode="STRGCTTRAACO".
Este atributo permite indicar o código do tratamento "Safe X3" que toma em carga a gestão do acesso à coleção (Query), - serp:stcColCode="GCTTRAACO".
Este atributo permite indicar o código da estrutura "Safe X3" que toma em carga a coleção de um recurso, - serp:stcClobMaxSize="12".
Este atributo permite indicar o tamanho máximo do clob permitindo gerir a troca dos dados entre o servidor "Safe X3" e o componente "Safe X3 Java Bridge Server", - serp:maxQueryEntries="50".
Este atributo permite indicar o número máximo de recursos devolvidos por uma interrogação.
Este limite permite evitar muito solicitar o servidor. O cliente poderá aceder aos dados seguintes por paginação ou em afinando os critérios de pesquisa, - serp:linkingQueryEntries="1000".
Este atributo permite indicar o número máximo de recursos devolvidos pelo programa de linking,
Este atributo é utilizado unicamente no quadro interno de colocação em obra da função de linking.
- Baliza elementocontido numa baliza "complexType".
Esta baliza pertence ao standard SData e permite definir as informações pertencendo a um recurso SData.
Cada elemento pode ser um elemento final (rubrica) ou um elemento afetando outros recursos (relação de tipo de referência, filhos, associação).
- Gestão das interrogações - Filtro.
É possível numa interrogação de utilizar os elementos assinalados pelo atributo canFilter="true".
- Caso das relações referência ou associação
O filtro não pode levar que sobre uma única rubrica do recurso para razões técnicos.
Exemplo : no contrato CRM : A estrutura GC1TRAACO contém o campo BPCINV ligado ao recurso fatura "TradingAccount" que tem uma relação de tipo de referência.
Neste caso, o contrato comporta :
- na descrição do recurso principal e sobre o elemento descrevendo a relação, o atributo serp:filter="byReference".
Este atributo indica a restrição de utilização do recurso incluido numa interrogação (Nota : a título de informação unicamente), - na descrição do recurso ligado e sobre o elemento único, o atributo: serp:reference="true".
Este atributo indica a rubrica utilizavel por uma interrogação levando sobre este recurso incluido.
- Gestão das interrogações - Coleção obtida a partir de uma propriedade.
Elas são a utilizar quando o número de dados está desconhecido e necessita de ter os mecanismos de paginação de um query clássico.
Estas interrogações são possiveis se o atributo canGet="true" está posicionado sobre o elemento possuindo a relação de tipo associação.
Isto é o caso para as encomendas de um cliente :
/tradingAccount('DIS001')/salesOrders.
É também possível de obter este resultado com a ajuda de um query clássico
/salesOrders=where tradingAccount.refrerence eq 'DIS001.
Exemplo:A estrutura GC1TRAACO contém o campo QCTORDER ligado ao recurso "salesOrders" que tem uma relação de tipo associação.
Na estrutura aplicativa, os campos neste caso utilizam o código estrutura ASDCOLBV1.
Ao nível contrato, falta indicar sobre o elemento descrevendo a relação associação o tratamento e o sub-programa carregados de tratar estes pedidos: - serp:trtQueryProperty - tratamento,
- serp:spgQueryProperty -sub-programa.
- Baliza enumeração.
- serp:valor="99"
Este atributo permite de fazer uma correspondência automática entre o valor de enumeração SData (uma cadeia de caracter) e o valor utilizado no quadro de "Safe X3" (número de linha do menu local gerando a enumeração).