Incluindo um esquema da origem de dados REST com o assistente de descoberta do esquema

Um esquema da origem de dados pode ser criado para uma origem de dados REST. Criar esquemas simplifica a autoria de modelos de documentos para módulos com a mesma estrutura, e a lista de atributos iguais ou semelhantes.

Sobre Esta Tarefa

Quando você usa o Assistente de descoberta de esquema para criar esquemas de origem de dados, pode selecionar a partir de duas opções REST relatáveis que o aplicativo pode suportar, API REST 1.0 ou API REST 2.0. Verifique com seu administrador do sistema se você não souber a versão da API REST que seu aplicativo suporta.

Descoberta de esquema (API REST 1.0)

Procedimento

  1. No Document Studio, clique em Dados > Descoberta do esquema > Descoberta de esquema REST.
  2. Especifique os detalhes da conexão:
    1. Insira um Nome para a origem de dados.
    2. Insira uma Descrição para a origem de dados.
    3. Especifique a URL base para o recurso.
    4. Selecione o Tipo de autenticação na lista. Se nenhum tipo for selecionado, cada tipo será testado até que o tipo correto seja localizado. Especificar um tipo permitirá que esse processo seja eliminado.
    5. Se o recurso estiver em um servidor protegido, especifique o nome de Usuário.
    6. Se o recurso estiver em um servidor protegido, especifique a Senha.
  3. Clique em Avançar.
  4. Dependendo se sua origem de dados usa os serviços de dados, uma das seguintes janelas será exibida:

    Se a origem de dados não usar os serviços de dados, a janela Criar um recurso será exibida.

    1. Insira um Nome para o novo recurso.
    2. Insira uma Descrição para o novo recurso.
    3. Insira um Caminho relativo para o novo recurso.
    Se a origem de dados REST estiver acessível usando Reporting Data Services Adpters, a janela Localizar usando serviço de dados será exibida.
    1. Selecione um elemento na árvore do esquema XML.
    2. Selecione o valor href na lista de atributos.
    3. Clique em Avançar. A URL de recurso é exibida para o recurso selecionado.
  5. Selecione a URL e clique em Concluir ou use a URL para localizar o recurso-filho. Para localizar o recurso-filho:
    1. Selecione a URL de recurso e clique em Avançar.
    2. Selecione um elemento na área de janela de esquema XML.
    3. Selecione href na lista de atributos.
  6. Se você localizou um recurso-filho, clique em Concluir. O assistente é concluído e a URL é exibida na janela Configuração. Insira um nome de usuário e senha na janela de configuração se o recurso estiver em um servidor protegido.

Descoberta de esquema (API REST 2.0)

Sobre Esta Tarefa

Nota: Rational Publishing Engine suporta apenas o RDF abreviado. Os provedores devem aceitar e honrar as solicitações application/xml. Consulte Abrir serviços para Lifecycle Collaboration Core Specification Versão 2.0.
Rational Publishing Engine suporta apenas provedores OSLC v2 que seguem a especificação de REST v2.
  • Um serviço OSLC deve ter recursos de consulta definidos no recurso de serviço para todos os recursos pretendidos para relatório.
  • Cada recurso de consulta para relatório:
    • Deve ter oslc:queryBase apontando para o recurso que tem uma lista de recursos destinados para relatório. Os recursos na lista devem ser identificados como oslc:isMemberProperty no Resource Shape Resource do recurso da lista.
    • Deve ter oslc:resourceShape para descrever o recurso da lista.

Procedimento

  1. Clique em Dados > Descoberta de esquema > Descoberta de esquema REST v2.
  2. Especifique os detalhes da conexão:
    1. Especifique a URL base para o recurso.
      Você deve saber a URL do provedor de serviços que deseja aceitar. Essa URL é a URL equivalente do aplicativo de serviços de dados de relatório para a origem de dados REST relatável. Rational Publishing Engine busca os dados da origem de dados como uma lista de consultas. Esses recursos são armazenados pelo serviço do qual os dados podem ser consultados e interpretados. O serviço também fornece um serviço de consulta que ajuda a filtrar dados de acordo com uma condição configurada ou a refinar os subconjuntos de dados. Essas consultas são para um tipo de recurso e permitem que você acesse o recurso de um tipo específico. Um serviço ID2 relatável pode expor vários tipos de recursos, como uma solicitação de mudança do produto ou usuário. O serviço de consulta ajuda o usuário a recuperar dados de forma eficiente ou um subconjunto dos dados, mas ele não é obrigatório. O serviço de consulta existe para todos os recursos. Cada produto pode definir seus recursos e as consultas que acessam esses recursos.
    2. Selecione um Tipo de autenticação na lista.
    3. Se o recurso estiver em um servidor protegido, especifique o nome de Usuário.
    4. Se o recurso estiver em um servidor protegido, especifique a Senha.
  3. Clique em Avançar.
  4. Selecione um serviço REST v2 e sua consulta correspondente e clique em Avançar. As propriedades de exibição dos serviços selecionados.
  5. Selecione as propriedades necessárias na lista e clique em Testar oslc.select. Uma janela Confirmação de resultado exibe os serviços selecionados. Confirme se os serviços estão corretos. Se você clicar em Corrigir, o status do campo Testar oslc.select muda para true. Clique em Avançar.

    O campo Testar oslc.properties não é usado com frequência.

  6. Você deve inserir apenas o filtro ou cláusula de classificação da consulta, como cq:Product{cq:Product="Rational Publishing Engine"} em Consultar cláusula include oslc.where e Consultar cláusula include oslc.orderBy.
  7. Clique em Testar oslc.where e Testar oslc.orderBy para verificar a conexão. Rational Publishing Engine cria a solicitação completa usando as opções definidas.
  8. Clique em Avançar. O resumo de sua consulta é exibido. Clique em Concluir. O assistente é concluído e a URL é exibida na janela Configuração. Se o recurso estiver em um servidor protegido, você poderá fornecer um nome de usuário e senha na janela Configuração.