Configurar o acesso do OData ao data warehouse (somente no local)

ccppmop157
Os clientes SaaS podem acessar o data warehouse e desenvolver painéis e relatórios de análise usando terminais REST (OData). Um servidor HDP (Hybrid Data Pipeline) no ambiente do
Clarity PPM
se conecta ao data warehouse e expõe os terminais do OData para as entidades do data warehouse. Como desenvolvedor ou usuário corporativo de relatórios, você pode usar uma ferramenta de inteligência de negócios (por exemplo, Microsoft Power BI ou Tableau) para acessar os terminais do OData. Usando os terminais do OData como fontes de dados, você pode criar seus próprios painéis e relatórios.
2
2
A imagem a seguir mostra o fluxo de dados do data warehouse até uma ferramenta externa de BI usando o OData do HDP:
A imagem mostra o fluxo de dados do data warehouse até uma ferramenta externa de BI usando o OData do HDP.
Fornecer acesso ao Serviço do OData no data warehouse
Como administrador do sistema, abra a página Serviço do OData para visualizar os URLs do terminal do OData v2 ou v4. Forneça o URL ou a sequência de caracteres de autenticação do OData para os usuários de relatório. Usando suas credenciais do
Clarity PPM
, os usuários de relatório podem configurar suas ferramentas de BI para se conectar ao serviço do OData.
A dica a seguir será aplicável apenas se você estiver usando a conta de serviço do OData para usuário único disponível no CA PPM 15.3. Depois de atualizar para a 15.4 ou superior, para qualquer relatório criado anteriormente, atualize as configurações de conexão para usar agora as novas credenciais de usuário do CA PPM. A partir da release 15.4, os terminais do OData não podem mais ser acessados pela conta de serviço de usuário único do OData.
Siga estas etapas:
  1. Para acessar o data warehouse usando o OData, certifique-se de que esteja usando a edição SaaS do CA PPM 15.4 ou superior.
  2. Efetue logon no
    Clarity PPM
    .
  3. Clique em
    Administração
    ,
    Organização e acesso
    ,
    Recursos
    .
    1. Conceda o direito de acesso
      Serviço do OData no data warehouse - Ir para
      aos administradores responsáveis por gerenciar o acesso à conexão do OData. Com esse direito, os administradores poderão abrir a página Serviço do OData no data warehouse na próxima etapa.
    2. Conceda o direito
      OData - Access
      para acessar o OData do PPM e atuar em nome de outros usuários como uma conexão confiável.
  4. Clique em
    Administração
    ,
    Configurações gerais
    ,
    Serviço do OData no data warehouse
    .
    As seguintes informações são exibidas:
    • URL do terminal do OData v2 no data warehouse
      Defina o URL do OData para a instância do
      Clarity PPM
      15.4 ou mais recente, que expõe o data warehouse para o cliente. Use este URL para autenticação externa com o OData v2.
      Exemplo
      : http://
      <host:porta>
      /api/odata/ppm_hdp_datasource_v2
    • URL do terminal do OData v4 no data warehouse
      Defina o URL do OData para a instância do
      Clarity PPM
      15.4 ou mais recente, que expõe o data warehouse para o cliente. Use este URL para autenticação externa com o OData v4.
      Exemplo
      : http://
      <host:porta>
      /api/odata4/ppm_hdp_datasource_v4
    • Autenticador do OData
      Define o qualificador a ser usado no acesso aos terminais do OData com as credenciais de usuário do
      Clarity PPM
      .
  5. Compartilhe o URL (v2 ou v4) e a sequência de caracteres de autenticação do OData com os desenvolvedores e os usuários de relatório para que eles possam acessar os terminais do OData.
Acesso aos terminais do OData usando as credenciais do CA PPM
Com os direitos de acesso necessários e suas credenciais do
Clarity PPM
, os usuários de relatórios podem acessar o serviço do OData.
Siga estas etapas:
  1. Como administrador do
    Clarity PPM
    , conceda aos usuários de relatório acesso aos terminais do OData da seguinte maneira:
    1. Para usuários existentes, atribua o direito de acesso
      Serviço do OData no data warehouse - Ir para
      .
    2. Para novos usuários do relatório, crie-os como recursos no
      Clarity PPM
      e atribua o direito de acesso
      Serviço do OData no data warehouse - Ir para
      .
  2. Como um usuário com os direitos necessários, acesse o serviço do OData usando suas credenciais do
    Clarity PPM
    da seguinte maneira:
    • Digite o nome de usuário com o sufixo símbolo de barra vertical (|) seguido pelo Autenticador do OData como se segue:
      <USUÁRIO_DO_CA PPM>
      |
      <AUTENTICADOR_DO_ODATA>.
      Por exemplo, se o nome de usuário do
      Clarity PPM
      for
      PPMODataUser
      e o Autenticador do OData for
      PPMOData
      , digite o seguinte nome de usuário:
      PPMODataUser|PPMOData
      .
    • Digite a senha do
      Clarity PPM
      .
Os usuários não podem acessar os terminais do OData no data warehouse usando as respectivas credenciais de domínio ou as credenciais de logon do CA On Demand Portal em um ambiente SSO federado. Para permitir o acesso ao URL do terminal do OData no data warehouse nesses ambientes, conclua as seguintes etapas:
  1. Crie usuários de relatório específicos no
    Clarity PPM
    .
    É possível reutilizar usuários de produto existentes, desde que eles não tenham a opção Autenticação externa marcada nas propriedades do recurso em Administração. Se a opção estiver marcada, crie novos usuários de relatório.
  2. Configure uma senha para esses usuários no
    Clarity PPM
    para que eles possam usá-la para acessar os Terminais do OData no data warehouse.
Ativar o conteúdo personalizado para o data warehouse
Quaisquer dados que você desejar disponibilizar no data warehouse deverão ser primeiro adicionados ao produto. Além disso, os dados deverão ser ativados especificamente para o data warehouse. Por exemplo, para visualizar seus atributos personalizados do projeto nos relatórios, adicione os atributos ao objeto Projeto no
Clarity PPM
Studio. Também ative os atributos para o data warehouse marcando a caixa de seleção
Incluir no data warehouse
. Consulte
Ativar objetos personalizados e atributos do Data warehouse
no tópico acima (
Configurar os domínios do data warehouse e dos relatórios avançados
).
Atualizar os terminais do OData
À medida que novas tabelas e colunas forem adicionadas ao data warehouse, os terminais do OData poderão ficar desatualizados. Execute ou programe as rotinas a seguir na ordem listada para atualizar os terminais do OData com as alterações mais recentes do data warehouse. Esse procedimento garante que os relatórios reflitam os dados mais atuais disponíveis. Consulte
Referência a rotinas
para obter detalhes adicionais sobre as rotinas.
  1. Carregamento do data warehouse
    : execute essa rotina imediatamente após configurar o
    Clarity PPM
    para o OData. A rotina copia os dados das tabelas e visualizações do
    Clarity PPM
    para o esquema do data warehouse.
  2. Carregar direitos de acesso do data warehouse
    : a rotina extrai os direitos de acesso relativos aos investimentos e recursos do banco de dados do
    Clarity PPM
    e os carrega no data warehouse. Execute a rotina sempre que os direitos de acesso do usuário forem alterados. Execute-a também depois de executar a rotina de carregamento do data warehouse com a opção carga completa.
  3. Restauração do modelo do OData para o data warehouse
    : execute essa rotina apenas quando houver uma alteração no esquema do data warehouse, como um novo objeto ou atributo. A rotina cria os terminais do OData para v2 e v4 com base no esquema do data warehouse. O conector do OData pode usar os terminais para a criação de relatórios. Execute a rotina Atualizar ao menos uma vez após configurar o
    Clarity PPM
    para o OData.
O acesso do usuário somente leitura ao data warehouse atualizado pode variar devido à sequência das rotinas necessárias de carregamento e atualização. A sequência completa de atualizações pode ocorrer em alguns minutos ou em até duas horas. Por exemplo, todos os novos objetos personalizados são carregados na Etapa 1 ao executar a rotina de carregamento do data warehouse. De forma completamente automatizada, uma rotina separada do banco de dados para a atualização de concessões cria e atualiza as permissões e os sinônimos para esses novos objetos do banco de dados, que agora estão no data warehouse. A rotina automatizada de atualização de concessões do banco de dados está programada para ser executada a cada 2 horas. Os novos objetos personalizados não ficarão visíveis como terminais do OData para as ferramentas de geração de relatórios até que a rotina de atualização de concessões seja concluída e a rotina de atualização do modelo do OData para o data warehouse seja executada novamente.
Verificar a conexão do OData
Execute as etapas a seguir para verificar se você está conectado ao serviço do OData.
  1. Abra um navegador.
  2. Dependendo da sua versão do OData (v2 ou v4), copie e cole o URL do terminal do OData que você anotou do
    Clarity PPM
    .
  3. Digite o nome de usuário e a senha para acessar o serviço do OData e tentar se conectar.
    • Se a conexão for bem-sucedida, você verá uma saída do OData com formato XML.
    • Se você não vir essa saída, entre em contato com o Suporte da CA.
Conectar a ferramenta de BI ao serviço do OData no data warehouse
Como um desenvolvedor de relatórios, conecte a sua ferramenta de BI existente à fonte de dados do OData. Os objetos do OData serão expostos e você poderá começar a criar relatórios para seus usuários finais.
Os procedimentos desta seção são apenas recomendações. Consulte a documentação da ferramenta de BI específica para obter instruções de configuração para as seguintes tarefas:
  • Conectar-se e criar relatórios usando o feed do OData.
  • Recuperar apenas dados de amostra ao estabelecer uma conexão com o OData.
  • Recuperar dados limitados durante a criação de relatórios para melhorar o desempenho.
Trabalhe com o administrador da ferramenta de BI para resolver quaisquer problemas de conexão que possam ocorrer.
Dica do Suporte da CA
: se virmos o erro a seguir nos logs, isso indicará que um cliente tentou recuperar registros demais de uma só vez:
ForbiddenException: The top request exceeds the maximum entities per page limit of 10000
Neste exemplo, a solicitação para recuperar 50.000 linhas falhou:
"GET /api/odata/test_DataSource/DWH?$top=50000 HTTP/1.1"
O limite de serviço do OData é de 10.000 entidades por página. Com SSIS, se a implementação não passar o parâmetro $top, o mesmo erro poderá ocorrer. Portanto, é melhor usar a paginação para permanecer dentro do limite de 10.000 registros. O Suporte da CA observou esse problema com SSIS. No entanto, o limite de paginação de 10.000 entidades também se aplica ao tentar automatizar com outras ferramentas de BI.
Conectar-se ao OData usando o Microsoft Power BI Desktop
Se atualmente você estiver usando o Power BI, siga as etapas de alto nível a seguir para se conectar ao OData.
Siga estas etapas:
  1. No menu principal do Power BI, selecione
    Get Data
    ,
    OData Feed
    .
  2. Na janela
    OData Feed
    , digite o URL do terminal do OData no data warehouse (v2 ou v4) que você anotou do
    Clarity PPM
    .
  3. Clique em
    OK
    .
  4. Selecione
    Básico
    .
  5. Digite o nome de usuário e a senha que você anotou do
    Clarity PPM
    para acessar o serviço do OData.
  6. Clique em
    Conectar
    .
    Quando a conexão for estabelecida com êxito, você verá uma lista de tabelas do data warehouse que poderão ser usadas para criar os relatórios.
Conectar-se ao OData usando o Microsoft Excel
Clarity PPM expõe o OData, e você pode usar ferramentas de terceiros, como o Microsoft Excel, para consumir o OData. No entanto, oficialmente, o Clarity PPM não oferece suporte a nenhum consumo do OData com nenhuma ferramenta de terceiros. Você pode usar as informações fornecidas neste artigo da base de conhecimento para estabelecer conexão com o OData usando o Microsoft Excel.
Não é recomendável usar o Excel para a geração de relatórios. Para criar relatórios, é recomendável usar uma ferramenta de geração de relatórios, como o Power BI. O Power BI processa os dados mais rapidamente usando o armazenamento em cache e oferece maior segurança e controle dos dados. O Excel não oferece uma forma conveniente de mapear os usuários do relatório com os usuários do
Clarity PPM
.
Conectar-se ao OData usando o Tableau Desktop
Ao se conectar ao OData usando o Tableau, você deverá especificar entidades do OData individuais (tabelas).
  1. Em
    Connect
    ,
    To a Server
    , selecione o
    OData
    como a fonte de dados.
  2. Na janela do OData, no campo Server, digite o URL do terminal do OData no data warehouse (v2 ou v4) que você anotou do
    Clarity PPM
    . Use o seguinte formato:
    http://<host>:<porta>/api/odata/datasource/
    <entidade>
    Sendo que
    <entidade>
    especifica o nome da tabela do data warehouse.
  3. Selecione
    use a specific username and password
    . Especifique o nome de usuário e a senha para acessar o serviço do OData.
  4. Clique em
    Efetuar logon
    .
  5. Repita as etapas deste procedimento para conectar-se às demais tabelas do data warehouse.
O OData v4 não é suportado pelo Tableau; ele oferece suporte apenas à v2. O Microsoft Power BI oferece suporte a ambos.
Implementar a segurança no nível da linha para os relatórios de BI
Trabalhe com a organização de segurança das informações para revisar as informações de acesso e armazenamento de dados. Determine a compatibilidade das informações com seus padrões de segurança de dados. O HDP não aproveita os usuários, grupos ou o modelo de segurança ORG disponíveis no
Clarity PPM
. O desenvolvedor de relatórios de BI pode usar as tabelas de segurança do data warehouse para restringir os dados visíveis aos usuários de relatório.
Antes que os usuários gerem relatórios, implemente a segurança no nível da linha para proteger os dados. Ative a segurança no nível da linha do investimento e do recurso nos relatórios de BI. Apenas os recursos e investimentos relevantes ficarão visíveis para os usuários finais, com base nos direitos de acesso que eles tiverem.
Exemplo
: o usuário A tem acesso ao investimento 1 e ao investimento 2. O usuário B tem acesso ao investimento 1 e ao investimento 4. Quando o usuário A efetuar logon no ambiente de geração de relatórios, os relatórios de investimentos mostrarão apenas as linhas dos investimentos 1 e 2. O usuário B verá apenas as linhas dos investimentos 1 e 4.
Para ativar a segurança no nível da linha para os relatórios, use o atributo ID do usuário do BI para mapear os usuários do
Clarity PPM
com os usuários do relatório em sua ferramenta de BI. O atributo ID do usuário do BI está incluso no objeto Recurso e é instalado pelo Acelerador de PMO. Consulte Instalar o complemento Acelerador de PMO. Por padrão, o atributo não está configurado para ser exibido nas visualizações. Além disso, por padrão, o atributo é ativado para o data warehouse. No entanto, a opção
Incluir no data warehouse
não fica marcada e é somente leitura para o atributo de segurança.
Configurar a segurança no nível da linha no CA PPM
Como administrador, execute as seguintes etapas no
Clarity PPM
:
  1. Configure as visualizações do recurso para adicionar o atributo ID do usuário do BI. Consulte
    Objetos e Atributos do CA PPM Studio
    para obter detalhes.
  2. Preencha o valor do atributo ID do usuário do BI para todos os usuários do relatório com seus respectivos valores de logon de segurança de BI. Por exemplo, mapeie o usuário do
    Clarity PPM
    (usuário A) com o valor usuá[email protected]<nome_da_empresa>.org da ID do usuário do BI.
Configurar a segurança no nível da linha na ferramenta de BI
Os desenvolvedores de relatórios que estiverem usando qualquer ferramenta de BI poderão usar a segurança do data warehouse para implementar a segurança no nível da linha, conforme descrito por seus fornecedores. Este procedimento fornece as etapas genéricas de alto nível usando o Power BI como exemplo. Consulte a documentação da ferramenta de BI para obter instruções sobre como implementar a segurança no nível da linha na sua ferramenta de BI. Por exemplo, consulte a documentação do Microsoft Power BI para obter instruções sobre como implementar a segurança no nível da linha no Power BI para restringir o acesso aos dados de relatórios.
Siga estas etapas:
  1. Carregue as tabelas a seguir no Power BI Desktop para preencher os dados do relatório:
    • DWH_INV_INVESTMENT: caso esteja gerando relatórios sobre investimentos, a tabela preencherá os dados de investimentos. Normalmente, esta tabela é usada com a segurança do investimento. Dependendo do caso de uso, também será possível usar outras tabelas que contenham a chave de investimento.
    • DWH_RES_RESOURCE: caso esteja gerando relatórios sobre recursos, a tabela preencherá os dados de recursos. Normalmente, esta tabela é usada com a segurança do recurso. Dependendo do caso de uso, também será possível usar outras tabelas que contenham a chave de recurso.
    • DWH_INV_SECURITY_V: a visualização preenche as informações sobre os direitos de acesso aos investimentos. A visualização inclui a coluna BI_User_ID, que é a ID do usuário da ferramenta de BI, e reflete o valor como preenchido no
      Clarity PPM
      .
    • DWH_RES_SECURITY_V: a visualização preenche as informações sobre os direitos de acesso aos recursos. A visualização inclui a coluna BI_User_ID, que é a ID do usuário da ferramenta de BI, e reflete o valor como preenchido no
      Clarity PPM
      .
  2. Crie relacionamentos entre as tabelas e visualizações.
  3. Defina uma condição where para restringir os dados a um usuário específico.
    Por exemplo, no Power BI, vá para Modeling, Manage Roles, Create Role e crie uma expressão DAX no atributo BI_User_ID, conforme mostrado a seguir:
    [BI_USER_ID] = USERNAME()
  4. Salve e publique o relatório.
Funções suportadas do data warehouse do PPM
As seguintes funções do data warehouse são suportadas no Odata v4:
DWH_CAL_CURRENT_DATE_FCT DWH_CAL_DATE_ADD_FCT DWH_CAL_DATEDIFF_FCT DWH_CAL_DATEFORMAT_FCT DWH_CAL_DATELABEL_FCT DWH_CAL_DIFF_IN_SECONDS_FCT DWH_CAL_END_OF_MONTH_FCT DWH_CAL_PERIOD_START_FCT DWH_CAL_STARTDATE_FCT DWH_CAL_TRUNC_DATE_FCT DWH_CHART_COLOR_MAP_FCT DWH_CONVERT_CURRENCY_FCT DWH_DAYS_LATE_PCT_FCT DWH_DISPLAY_MAPPING_FCT DWH_GET_RETAIN_PRECISION_FCT DWH_INV_REMAINING_ALLOC_FCT DWH_NULL_DATE_FCT DWH_NULL_NUMBER_FCT DWH_NULL_VARCHAR_FCT DWH_START_DAYS_LATE_FCT DWH_START_DAYS_LATE_PCT_FCT DWH_TO_CHAR_FCT
As funções do OData v4 são suportadas, no entanto, as seguintes exceções não são:
  • importações de função
  • funções que retornam tipos de primitivo
  • funções que retornam entidades ou tipos complexos
  • funções que estão associadas a entidades
  • funciona com os parâmetros OUT ou INOUT
  • funções com aliases de parâmetro
  • funções invocadas pelas opções $filter, $select ou $orderby do Odata
  • funções invocadas por valores de parâmetros, incluindo os parâmetros de consulta de URL
  • funções integradas
  • funções sobrecarregadas
  • funções não associadas (operações estáticas)
As visualizações de RU, como DWH_INV_TEAM_RU_PER_FACTS_M_V, não são expostas como OData.
O OData v2 não oferece suporte a nenhuma função. Mesmo as funções do data warehouse não são suportadas pela v2.