Recuperando os valores da propriedade de arquivos externos

Você pode especificar que uma propriedade aceita um valor a partir de um arquivo XML ou JSON sobre HTTP. Em seguida, quando executa o processo, o servidor solicita a você uma lista de valores desse arquivo.

Antes de Iniciar

Em um servidor que é acessível a partir do IBM® UrbanCode Deploy, hospede um arquivo XML ou JSON que contém os valores para a propriedade. É possível formatar esse arquivo de várias maneiras diferentes. Você também deve identificar o caminho para os valores com três parâmetros. Exemplos desses parâmetros de caminho estão incluídos nos arquivos de exemplo.
A maneira mais simples para formatar o arquivo é fornecer uma lista simples de valores para a propriedade, como nos exemplos a seguir:
<company>
  <employee>Alice</employee>
  <employee>Bob</employee>
  <employee>Chris</employee>
<company>
Para arquivos XML, você utiliza XPath para especificar o caminho para os valores. No arquivo XML anterior, o parâmetro Base Path é a expressão XPath //company/employee e os parâmetros Value Path e Label Path estão em branco.
O exemplo a seguir mostra o arquivo equivalente em JSON:
{
  company: {
    employee: [
      "Alice",
      "Bob",
      "Chris"
    ]
  }
}
No arquivo JSON anterior, o parâmetro Base Path é company.employee e os parâmetros Value Path e Label Path estão em branco.
Você pode incluir informações de rótulo e valor separadas no arquivo. Por exemplo, o arquivo XML a seguir inclui os nomes e números de ID.
<company>
  <employee>
    <name>Alice</name>
    <id>1</id>
  </employee>
  <employee>
    <name>Bob</name>
    <id>2</id>
  </employee>
  <employee>
    <name>Chris</name>
    <id>3</id>
  </employee>
</company>
Neste caso, o parâmetro Base Path é a expressão XPath //company/employee. O parâmetro Value Path é uma expressão XPath que mostra o caminho para o valor relativo ao caminho base; neste caso, a expressão é ./id. Da mesma forma, uma expressão XPath do parâmetro Label Path que mostra o caminho para o rótulo relativo ao caminho base; neste caso, a expressão é ./name.
O arquivo JSON a seguir é equivalente ao arquivo XML anterior :
{
  company: {
    employees: [
      { name: "Alice", employee.id: 1 },
      { name: "Bob", employee.id: 2 },
      { name: "Chris", employee.id: 3}
    ]
  }
} 
Neste caso, o parâmetro Base Path é company.employees. O parâmetro Value Path é employee\.id e o parâmetro Label Path é name.
Nota: Ao especificar o caminho para um arquivo JSON, coloque pontos nos nomes de atributos com barras invertidas, como no parâmetro Value Path no exemplo anterior.
Ao utilizar os atributos em um arquivo XML, utilize o caractere @ para especificar um atributo em XPath. Por exemplo, o arquivo XML a seguir tem valores nos atributos:
<company>
  <employee id="1">Alice</employee>
  <employee id="2">Bob</employee>
  <employee id="3">Chris</employee>
<company>
Neste caso, o parâmetro Base Path é a expressão XPath //company/employee. O parâmetro Value Path é ./@id e o parâmetro Label Path é um ponto (.) .

Sobre Esta Tarefa

Você pode utilizar esses valores de propriedade remotos em definições de propriedade, como propriedades de ambiente do componente, mas não em propriedades gerais como propriedades do sistema, propriedades do aplicativo, ou as propriedades do componente.

Procedimento

  1. Crie uma definição de propriedade. Por exemplo, clique em um componente, acesse a guia Configuração, clique em Definições de propriedade do ambiente e clique em Incluir propriedade.
  2. Especifique os campos Nome, Descrição, Rótulo, Padrão e Obrigatório como de costume.
  3. Na lista Tipo, selecione Seleção de HTTP para um único valor de propriedade ou selecione Multiseleção de HTTP para permitir vários valores de propriedade. Vários campos novos aparecem.
  4. Especifique os campos a seguir. Esses campos são específicos para os parâmetros a partir de arquivos externos.
    URL
    Especifique a URL do XML externo ou arquivo JSON.
    Nome do usuário
    Se a URL exigir um nome de usuário, especifique-a aqui.
    Senha
    Se a URL exigir uma senha, especifique-a aqui.
    Formato de dados
    Especifique o tipo de arquivo: JSON ou XML.
    Caminho base
    Para arquivos XML, especifique uma expressão XPath para os dados. Para arquivos JSON, especifique o caminho através dos atributos JSON aos dados, separando os caminhos com pontos (.) . Consulte os exemplos na parte superior desta página.
    Caminho do valor
    Especifique o caminho para os valores de parâmetros, relativo ao parâmetro Base Path .
    Caminho do rótulo
    Especifique o caminho para os rótulos do parâmetro, relativo ao parâmetro Base Path .
    Valor padrão
    Especifique o valor padrão para o parâmetro.
  5. Clique em Salvar.

Resultados

Agora, quando você executar o processo, a janela Executar processo incluirá um parâmetro que recupera valores a partir do arquivo externo.

Feedback