Ir para o conteúdo

Atividade de Consulta do SAP SuccessFactors

Introdução

Uma atividade de Consulta do SAP SuccessFactors, utilizando sua conexão do SAP SuccessFactors, recupera dados de objetos do SAP SuccessFactors e é destinada a ser usada como uma fonte para fornecer dados em uma operação.

Criar uma atividade de Consulta do SAP SuccessFactors

Uma instância de uma atividade de Consulta do SAP SuccessFactors é criada a partir de uma conexão do SAP SuccessFactors usando seu tipo de atividade Consulta.

Para criar uma instância de uma atividade, arraste o tipo de atividade para a tela de design ou copie o tipo de atividade e cole-o na tela de design. Para detalhes, veja Criar uma instância de atividade ou ferramenta em Reutilização de componentes.

Uma atividade de Consulta do SAP SuccessFactors existente pode ser editada a partir destes locais:

Configurar uma atividade de Consulta do SAP SuccessFactors

Siga estas etapas para configurar uma atividade de Consulta do SAP SuccessFactors:

Passo 1: Insira um nome e selecione um objeto

Neste passo, forneça um nome para a atividade e selecione um objeto. Cada elemento da interface do usuário deste passo é descrito abaixo.

  • Nome: Insira um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade de Consulta do SAP SuccessFactors e não deve conter barras / ou dois pontos :.

  • Selecionar um Objeto: Esta seção exibe os objetos disponíveis no endpoint do SAP SuccessFactors.

    • Objeto Selecionado: Após um objeto ser selecionado, ele é listado aqui.

    • Pesquisar: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de objetos. A pesquisa não diferencia maiúsculas de minúsculas. Se os objetos já estiverem exibidos na tabela, os resultados da tabela são filtrados em tempo real a cada tecla pressionada. Para recarregar objetos do endpoint ao pesquisar, insira os critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.

    • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para recarregar objetos do endpoint do SAP SuccessFactors. Isso pode ser útil se objetos foram adicionados ao SAP SuccessFactors. Esta ação atualiza todos os metadados usados para construir a tabela de objetos exibida na configuração.

    • Selecionando um Objeto: Dentro da tabela, clique em qualquer lugar em uma linha para selecionar um objeto. Apenas um objeto pode ser selecionado. As informações disponíveis para cada objeto são obtidas do endpoint do SAP SuccessFactors:

      • Nome: O nome do objeto

    Dica

    Se a tabela não for preenchida com objetos disponíveis, a conexão com o SAP SuccessFactors pode não ter sido bem-sucedida. Certifique-se de que você está conectado reabrindo a conexão e testando novamente as credenciais.

  • Salvar e Sair: Se habilitado, clique para salvar a configuração deste passo e fechar a configuração da atividade.

  • Próximo: Clique para armazenar temporariamente a configuração deste passo e continuar para o próximo passo. A configuração não será salva até que você clique no botão Concluído no último passo.

  • Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 2: Selecionar um subobjeto

Nesta etapa, selecione um subobjeto. Cada elemento da interface do usuário desta etapa é descrito abaixo.

  • Selecionar um Subobjeto: Esta seção exibe os subobjetos disponíveis no endpoint do SAP SuccessFactors.

    • Objeto Selecionado: O objeto selecionado na etapa anterior é listado aqui.

    • Subobjeto Selecionado: Após um subobjeto ser selecionado, ele é listado aqui.

    • Pesquisar: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de subobjetos. A pesquisa não diferencia maiúsculas de minúsculas. Se os subobjetos já estiverem exibidos na tabela, os resultados da tabela são filtrados em tempo real a cada tecla pressionada. Para recarregar subobjetos do endpoint ao pesquisar, insira os critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.

    • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para recarregar subobjetos do endpoint do SAP SuccessFactors. Isso pode ser útil se subobjetos foram adicionados ao SAP SuccessFactors. Esta ação atualiza todos os metadados usados para construir a tabela de subobjetos exibida na configuração.

    • Selecionando um Subobjeto: Dentro da tabela, clique em qualquer lugar em uma linha para selecionar um subobjeto. Apenas um subobjeto pode ser selecionado. As informações disponíveis para cada subobjeto são obtidas do endpoint do SAP SuccessFactors:

      • Nome: O nome do subobjeto.

      • Descrição: A descrição do subobjeto.

    Dica

    Se a tabela não for preenchida com subobjetos disponíveis, a conexão com o SAP SuccessFactors pode não ter sido bem-sucedida. Certifique-se de que você está conectado reabrindo a conexão e retestando as credenciais.

  • Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.

  • Próximo: Clique para armazenar temporariamente a configuração desta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.

  • Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 3: Definir uma string de filtro

Nesta etapa, uma String de Filtro da consulta é definida para uma consulta usando campos de objeto disponíveis e configurações de consulta. Cada elemento da interface desta etapa é descrito abaixo.

A interface utilizada nesta etapa da configuração de uma atividade Consulta do SAP SuccessFactors depende da aba selecionada:

  • Básico: Esta opção permite que você construa a String de Filtro com campos guiados.

  • Avançado: Esta opção oculta os campos guiados e permite que você modifique a String de Filtro diretamente.

Básico

Se a aba Básico estiver selecionada, a interface descrita abaixo é apresentada.

Dica

Campos com um ícone de variável suportam o uso de variáveis globais, variáveis de projeto e variáveis Jitterbit. Comece digitando um colchete aberto [ no campo ou clicando no ícone de variável para exibir um menu listando as variáveis existentes para escolher.

  • Campos de Objeto: Selecione os campos a serem usados na consulta com base na classe de objeto selecionada.

    • Pesquisar: Digite qualquer parte do nome de um campo na caixa de pesquisa para filtrar a lista de campos para o objeto selecionado. A pesquisa não diferencia maiúsculas de minúsculas. Os resultados listados são filtrados em tempo real a cada tecla pressionada.

    • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para recarregar os campos do objeto a partir do endpoint do SAP SuccessFactors.

    • Selecionar Todos na Classe de Objeto: Ao usar a caixa de pesquisa para filtrar, você pode usar esta caixa de seleção para selecionar todos os campos visíveis de uma vez.

    • Selecionar Campos: Selecione as caixas de seleção dos campos que você deseja incluir na consulta para que sejam automaticamente adicionados à String de Filtro. Você também pode selecionar todos os campos de uma vez usando a caixa de seleção pai.

    • Tamanho da Página: Insira um tamanho de página para habilitar a paginação dos resultados. O número de resultados em uma página totalizará o tamanho especificado. Um link para a próxima página de resultados também será incluído na resposta.

    • Incluir Contagem: Selecione para incluir o número de resultados de uma consulta como parte da resposta.

    • Busca de Texto Completo: Insira termos de busca para consultar objetos na classe de objeto selecionada. O endpoint do SAP SuccessFactors lida com a forma como a busca é interpretada para uma classe de objeto.

    • Pular: Insira um número de resultados a serem pulados na resposta da consulta.

    • Top: Insira um número máximo de resultados a serem recebidos na resposta da consulta.

    • Cláusulas Condicionais: Para adicionar condicionais, use esses campos como entrada para ajudar a construir as cláusulas, que então aparecem na String de Filtro.

      • Objeto: Use o dropdown para selecionar a classe de objeto a ser usada para a condicional.

      • Campo: Use o dropdown para selecionar o campo da classe de objeto a ser usado para a condicional.

      • Operador: Use o dropdown para selecionar um operador apropriado:

        Comparação
        Igual
        Maior que
        Maior ou Igual
        Menor que
        Menor ou Igual

      • Valor: Insira o valor desejado para comparar com as seleções do dropdown anterior.

      • Remover: Clique no ícone de excluir para remover a condicional da tabela.

      • Adicionar: Clique para adicionar uma nova condicional à tabela e à String de Filtro.

      • Remover Todos: Clique para remover todas as condicionais da tabela e da String de Filtro.

    • String de Filtro: À medida que você preenche os outros campos na aba Básico, a declaração da string de filtro nesta caixa de texto é automaticamente preenchida com os campos selecionados, condições e opções de consulta.

      Importante

      Devido a uma limitação do conector, se mais de um filtro estiver presente na String de Filtro, a operação falhará em tempo de execução.

  • Test Query: Clique para validar a consulta.

  • Back: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.

  • Next: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Finished na última etapa.

  • Discard Changes: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Advanced

Se a aba Advanced estiver selecionada, a interface descrita abaixo é apresentada.

Dica

Campos com um ícone de variável suportam o uso de variáveis globais, variáveis de projeto e variáveis Jitterbit. Comece digitando um colchete aberto [ no campo ou clicando no ícone de variável para exibir um menu listando as variáveis existentes para escolher.

  • Object Fields: Selecione os campos a serem usados na consulta com base na classe de objeto selecionada.

    • Page Size: Insira um tamanho de página para habilitar a paginação dos resultados. O número de resultados em uma página totalizará até o tamanho especificado. Um link para a próxima página de resultados também será incluído na resposta.

    • Filter String: Edite a declaração da string de filtro diretamente.

      Importante

      Devido a uma limitação do conector, se mais de um filtro estiver presente na Filter String, a operação falhará em tempo de execução.

    • Test Query: Clique para validar a consulta. Se a consulta for válida, uma amostra de até 10 registros recuperados da consulta é exibida em uma tabela. Se a consulta não for válida, mensagens de erro relevantes são exibidas. Se você editar a string de filtro enquanto estiver no modo Advanced, a consulta deve ser válida e validada através deste botão para habilitar o botão Next.

  • Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.

  • Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.

  • Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede que você confirme que deseja descartar as alterações.

Etapa 4: Revisar os esquemas de dados

Quaisquer esquemas de solicitação ou resposta são exibidos. Cada elemento da interface do usuário desta etapa é descrito abaixo.

  • Esquemas de Dados: Esses esquemas de dados são herdados por transformações adjacentes e são exibidos novamente durante o mapeamento de transformação.

    O conector SAP SuccessFactors utiliza a API OData v2 do SAP SuccessFactors HXM Suite. Consulte a documentação da API para obter informações sobre os nós e campos do esquema.

    A atividade Consulta utiliza JSON em seu esquema de resposta.

  • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para regenerar esquemas do endpoint do SAP SuccessFactors. Esta ação também regenera um esquema em outros locais ao longo do projeto onde o mesmo esquema é referenciado, como em uma transformação adjacente.

  • Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.

  • Concluído: Clique para salvar a configuração para todas as etapas e fechar a configuração da atividade.

  • Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede que você confirme que deseja descartar as alterações.

Próximas etapas

Após configurar uma atividade Consulta do SAP SuccessFactors, complete a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas da operação. Você também pode configurar as configurações da operação, que incluem a capacidade de encadear operações que estão no mesmo ou em diferentes fluxos de trabalho.

As ações de menu para uma atividade estão acessíveis a partir do painel do projeto e da tela de design. Para detalhes, veja o menu de ações da atividade em Noções básicas sobre conectores.

As atividades Query do SAP SuccessFactors podem ser usadas como fonte com esses padrões de operação:

Para usar a atividade com funções de script, escreva os dados em um local temporário e, em seguida, use esse local temporário na função de script.

Quando estiver pronto, implante e execute a operação e valide o comportamento verificando os logs da operação.