Histórico da Página

Informações Gerais

   Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos). 

Objetivo

Disponibilizar uma API  para inclusão de strings de tradução no AtuSX.

Definição da Regra de Negócio

Deverá ser desenvolvida uma API de integração com o AtuSX para permitir a inclusão de strings de tradução diretamente em sua base de dados.

O nome da rotina RESTFul deverá ser ATUSX.

A API deverá ser desenvolvida usando os fundamentos do RESTFul e deverá contemplar os seguintes metadados do AtuSX:

• Dicionário de perguntas – SX1
• Dicionário de tabelas – SX2
• Dicionário de campos – SX3
• Cadastro de tabelas genéricas – SX5
• Dicionário de Parâmetros – SX6
• Dicionário de Pastas e agrupamentos – SXA 
• Dicionário de consultas padrões – SXB
• Dicionário de regras de dependência – XXA
• Dicionário de grupo de campos – SXG
• Help e help de campos
• Tabela de strings de tradução de programas – arquivos .CH
• Menus do sistema

As chamadas do REST deverão ser organizadas da seguinte forma

 Todos os métodos REST deverão receber um JSON no corpo da mensagem que deverá conter as seguintes informações:

• version: Versão do dicionário no AtuSX
• project: Código do projeto no AtuSX
• package: Código do pacote no AtuSX
• key: Array contendo os valores que representam a chave da tabela de destino no AtuSX. (Mais adiante listaremos todos os valores possíveis para esse item).
  Esta opção poderá conter os seguinte valores:

   

  URI	Valores
  /question
  /table
  /field
  /genericTable
  /parameter
  /folder
  /lookup
  /???
  /???
  /help
  /programText
  /menu

   

   

• property: Mnemônico

  property: Mnemonico

  que representa alguma coluna específica da tabela que será atualizada.

   (Mais adiante listaremos todos os

  
  Os valores possíveis para esse

  item).

  parâmetro são:

  URI	Valores
  /question	description, definition1, definition2, definition3. definition4, definition5
  /table	description
  /field	title, description, options
  /genericTable	description
  /parameter	description1, description2, description3
  /folder	description
  /lookup	description
  /???
  /???
  /help	text
  /programText	text
  /menu	text

• idiom: Idioma no qual se deseja incluir o temo traduzido.  (Mais adiante listaremos todos os valores possíveis para esse itemA lista de possíveis valores para esse parâmetro são: pt-br (português do Brasil), pt (ortuguês de Portugal), en (ingles), es (espanhol), ru (russo).
• value: Valor traduzido

O JSON deverá ser montado seguindo o seguinte modelo:

[
	{
		"version" : "<AtuSX version -non obligatory->",
		"project" : "<AtuSX project -non obligatory->",
		"package" : "<AtuSX package -non obligatory->",
		"key" : [
			<Index Keys separate by ",">
		],
		"property" : "<Field to update>",
		"idiom" : "<pt-br, pt, en, es, ru>",
		"value" : "<Tranlated term>"
	},
	...
]

De modo geral o JSON enviado deverá ser um array onde cada linha será um JSON correspondente a um UPDATE na tabela do AtuSX. Esses JSONs deverão ter todas as informações necessárias para a localização do registro que será atualizado e o valor a ser incluído.

Opcional

Fluxo do Processo

<Nesta etapa incluir representações gráficas que descrevam o problema a ser resolvido e o sistema a ser desenvolvido. Exemplo: Diagrama - Caso de Uso, Diagrama de Atividades, Diagrama de Classes, Diagrama de Entidade e Relacionamento e Diagrama de Sequência>.