Elemento Field (Campo) no FSD

O elemento "field" (campo) define um campo único nos dados de entrada ou de saída.

<field
		name
		output='yes|no'
		field-sep
		valid-value
		default-value
		leading-chars
		trailing-chars
		output-if-empty='no'
		max-length='128'
		min-length='0'
		truncate='no'
		quoted='auto'
</field>

Atributos

  • name (nome)

    Define o nome do campo. Se o atributo de saída estiver definido como yes (sim), este nome será usado como nome da marca XML na saída e para coincidir a escolha com uma marca XML durante a entrada.

  • output (saída)

    Define se o campo deverá ser incluído na saída ou não. Os valores válidos para este atributo são yes (sim) e no (não), onde yes significa que o registro faz com que uma marca seja gerada na saída e no significa que o campo simplesmente descreve a estrutura de dados e não pode ser usado para ignorar dados. O default é yes.

  • record-sep (sep-registro)

    Define uma cadeia de separadores de campo opcional para o campo. Pode ser qualquer valor de cadeia. Também podem ser usados os seguintes valores especiais:

    • \r O caractere de retorno de carro
    • \r O caractere de alimentador de linha
    • \r O caractere de tabulação

    Se nenhum separador de campo for especificado, o atributo max-length (comprimento-máx) será usado para ler os dados, que são de comprimento fixo. O separador de campo pode ser omitido no último campo de um registro. Nesse caso, será usado o separador de registro do campo, se houver algum especificado.

  • valid-value

    Você pode usar este atributo para definir um valor que o campo deve ter. Ele é usado durante a leitura de dados de formato simples para validá-los e também como parte do elemento "choice" (escolha) para ajudar na conciliação de padrões. Durante a gravação de dados de formato simples, quando o atributo output (saída) estiver definido como não, o valor fixo especificado por você para valid-value (valor-válido) será gravado nesses dados.

  • leading-chars

    Uma cadeia contendo caracteres a serem separados do início do valor quando lidos a partir do arquivo de formato simples. Quando os dados estiverem gravados no arquivo de formato simples e o atributo trailing-chars (caracteres-secundários) não estiver especificado, o primeiro desses caracteres será usado para preencher o valor à esquerda deixando-o no comprimento correto (conforme determinado pelo atributo min-length [comprimento-mín]).

  • trailing-chars

    Uma cadeia contendo caracteres a serem separados do fim do valor quando lidos a partir do arquivo de formato simples. Quando os dados estiverem gravados no arquivo de formato simples, o primeiro desses caracteres será usado para preencher o valor à direita deixando-o no comprimento correto (conforme determinado pelo atributo min-length [comprimento-mín]).

  • output-if-empty (saída-se-vazio)

    Determina se o campo deverá ser gravado quando o conteúdo estiver vazio. Os valores válidos para este atributo são yes (sim) e no (não). O default é no.

  • max-length (comprimento-máx)

    Define o comprimento máximo dos dados. Este valor é usado para determinar a quantidade de dados que devem ser lidos. O default é 128.

  • min-length (comprimento-mín)

    Define o comprimento mínimo dos dados. É usado para validação, para conciliação de padrões pelo elemento "choice" (escolha) e também para enchimento quando os atributos leading-chars ou trailing-chars estiverem especificados. O default é 0.

  • truncate (truncar)

    Se esta opção estiver definida como yes (sim), os dados gravados novamente no formato de arquivo de formato simples serão truncados para o max-length (comprimento-máx) especificado. O default é no (não).

  • quoted (entre aspas)

    Esta opção determina se devem ser colocadas aspas em volta dos dados ou não. É usada para permitir que o caractere de separador de campo apareça dentro dos dados reais (já que o processador FSD não procurará em uma cadeia entre aspas referente ao separador de campo). Este atributo pode ser definido como os seguintes valores:

    • Não

      Os dados não devem ser tratados como uma cadeia entre aspas, ou seja, eles serão gravados literalmente dentro e fora do arquivo de formato simples.

    • Sim

      Os dados devem ser tratados como uma cadeia entre aspas. Ao serem convertidos de formato simples para XML, os dados terão as aspas removidas e quaisquer aspas com caractere de escape serão convertidas em aspas simples.

      Ao serem convertidos de XML para formato simples, os dados serão colocados entre aspas e quaisquer aspas existentes passarão a ter caracteres de escape, ou seja, aspas simples serão convertidas em aspas duplas, isto é, " se tornará "", etc.

    • Auto

      Esta opção só é aplicável na conversão de dados de arquivo de formato simples delimitado em XML. Se os dados contiverem o separador de campo, eles serão tratados como se a opção 'quoted' (entre aspas) estivesse definida como yes (sim). O default para este valor é auto.