Esta página foi traduzida pela API Cloud Translation.

Fonte em lote do SAP SuccessFactors

Esta página descreve como extrair dados de qualquer entidade no módulo SAP SuccessFactors Employee Central para oGoogle Cloud com o Cloud Data Fusion.

Para mais informações, consulte a visão geral do SAP no Google Cloud.

Antes de começar

Configure os seguintes sistemas e serviços usados pelo plug-in SAP SuccessFactors:

Configure o sistema SAP SuccessFactors. É necessário configurar permissões no sistema SAP.
Implante o plug-in do SAP SuccessFactors no Cloud Data Fusion. É necessário implantar uma versão de plug-in compatível com a versão do Cloud Data Fusion.
- Se você fizer upgrade da versão da instância ou do plug-in do Cloud Data Fusion, avalie o impacto das mudanças no escopo funcional e no desempenho do pipeline.
Estabeleça a conectividade entre o Cloud Data Fusion e o SAP SuccessFactors.
- Verifique se a comunicação está ativada entre a instância do Cloud Data Fusion e a do SAP SuccessFactors.
- Para instâncias particulares, configure o peering de rede VPC.

Configurar o plug-in

Acesse a interface da Web do Cloud Data Fusion e clique em Studio.
Verifique se a opção Pipeline de dados – lote está selecionada (não Tempo real).
No menu Origem, clique em SuccessFactors. O nó do SAP SuccessFactors aparece no seu pipeline.
Para configurar a origem, acesse o nó do SuccessFactors do SAP e clique em Propriedades.
Insira as seguintes propriedades. Para uma lista completa, consulte Propriedades.
1. Insira um rótulo para o nó da SAP SuccessFactors, por exemplo, SAP SuccessFactors tables.
2. Insira os detalhes da conexão. É possível configurar uma nova conexão única ou uma conexão existente e reutilizável.
  Conexão única
  Para adicionar uma conexão única ao SAP, siga estas etapas:
  1. Mantenha a opção Usar conexão desativada.
  2. Na seção Conexão, insira as seguintes informações da conta da SAP nestes campos:
    
    Forneça as credenciais do SAP.
    
    No campo URL base do SAP SuccessFactors, insira o URL base da sua conta do SAP SuccessFactors.
    
    No campo Nome da referência, insira um nome para a conexão que identifica essa origem para a linhagem.
    
    No campo Entity Name, insira o nome da entidade que você está extraindo, por exemplo, people.
    
    Para gerar um esquema com base nos metadados da SAP que mapeia os tipos de dados da SAP para os tipos de dados correspondentes do Cloud Data Fusion, clique em Get schema. Para mais informações, consulte Mapeamentos de tipo de dados.
    
    No campo URL do proxy, insira o URL do proxy, incluindo o protocolo, o endereço e a porta.
    
    Opcional: para otimizar a carga de transferência do SAP, insira as seguintes informações:
    
    Para extrair registros com base nas condições de seleção, clique em Opções de filtro e Selecionar campos.
    
    Em Expandir campos, insira uma lista de campos de navegação que serão expandidos nos dados de saída extraídos. Por exemplo, customManager.
    
    Em Parâmetros de consulta adicionais, insira os parâmetros a serem adicionados ao URL, por exemplo, fromDate=2023-01-01&toDate=2023-01-31.
    
    No campo Associated entity name, insira o nome da entidade a ser extraída, por exemplo, EmpCompensationCalculated.
    
    No campo Tipo de paginação, insira um tipo, por exemplo, Server-side pagination.
  Conexão reutilizável
  Para reutilizar uma conexão existente, siga estas etapas:
  1. Ative a opção Usar conexão.
  2. Clique em Procurar conexões.
  3. Clique no nome da conexão.
    
    Observação: para mais informações sobre como adicionar, importar e editar as conexões que aparecem ao navegar, consulte Gerenciar conexões.
  Se uma conexão não existir, crie uma conexão reutilizável seguindo estas etapas:
  1. Clique em Adicionar conexão > SAP SuccessFactors.
  2. Na página Criar uma conexão da SAP SuccessFactors que é aberta, insira um nome e uma descrição da conexão.
  3. Forneça as credenciais do SAP. Você pode pedir ao administrador da SAP os valores do nome de usuário e da senha de login da SAP.
  4. No campo URL do proxy, insira o URL do proxy, incluindo o protocolo, o endereço e a porta.
  5. Clique em Criar.

Propriedades

Propriedade	Macro ativada	Propriedade obrigatória	Descrição
Rótulo	Não	Sim	O nome do nó no pipeline de dados.
Usar conexão	Não	Não	Use uma conexão reutilizável. Se uma conexão for usada, não será necessário fornecer as credenciais. Para mais informações, consulte Gerenciar conexões.
Nome	Não	Sim	O nome da conexão reutilizável.
Nome de referência	Não	Sim	Identifica exclusivamente a origem da linhagem e anota os metadados.
URL base da SAP SuccessFactors	Sim	Sim	O URL base da API SuccessFactors.
Nome da entidade	Sim	Sim	O nome da entidade a ser extraída. Não oferece suporte a entidades com propriedades com o tipo de dados binários ou grandes volumes de dados. Por exemplo, `UserBadges` e `BadgeTemplates` não são compatíveis.
Nome de usuário do SAP SuccessFactors	Sim	Sim	O ID do usuário para autenticação, semelhante a `USER_ID@COMPANY_ID`. Por exemplo, `sfadmin@cymbalgroup`.
Senha do SAP SuccessFactors	Sim	Sim	A senha do SAP SuccessFactors para autenticação do usuário.
Opções de filtro	Sim	Não	A condição de filtro que restringe o volume de dados de saída, por exemplo, `Price gt 200`. Consulte as opções de filtro compatíveis.
Selecionar campos	Sim	Não	Campos que serão preservados nos dados extraídos. Por exemplo, `Category`, `Price`, `Name`, `Address`. Se o campo for deixado em branco, todos os campos que não são de navegação serão preservados nos dados extraídos. Todos os campos precisam ser separados por vírgula (,).
Abrir campos	Sim	Não	Lista de campos de navegação a serem expandidos nos dados de saída extraídos. Por exemplo, `customManager` Se uma entidade tiver registros hierárquicos, a fonte vai gerar um registro para cada linha na entidade que ela lê, e cada registro vai conter um campo extra que armazena o valor da propriedade de navegação especificada nos campos de expansão.
Nome da entidade associada	Sim	Não	Nome da entidade associada que está sendo extraída. Por exemplo, `EmpCompensationCalculated`
Tipo de paginação	Sim	Sim	O tipo de paginação a ser usado. A paginação do lado do servidor usa a paginação baseada em snapshots. Se a paginação baseada em snapshots for tentada em uma entidade que não oferece suporte ao recurso, o servidor vai forçar automaticamente a paginação com o deslocamento do cliente na consulta. Exemplos de entidades que oferecem suporte apenas à paginação do lado do servidor são `BadgeTemplates`, `UserBadges` e `EPCustomBackgroundPortlet`. Nenhum registro é transferido se a paginação do lado do cliente for escolhida nessas entidades, porque ela depende da API Count, que retorna `-1` como resposta. O padrão é Paginação do servidor.

Os seguintes operadores são aceitos:

Operador	Descrição	Exemplo
Operadores lógicos
`Eq`	Igual	`/EmpGlobalAssignment?$filter=assignmentClass eq 'GA'`
`Ne`	Diferente	`/RecurringDeductionItem?$filter=amount ne 18`
`Gt`	Maior que	`/RecurringDeductionItem?$filter=amount gt 4`
`Ge`	Maior ou igual a	`/RecurringDeductionItem?$filter=amount ge 18`
`Lt`	Menor que	`/RecurringDeductionItem?$filter=amount lt 18`
`Le`	Menor ou igual a	`/RecurringDeductionItem?$filter=amount le 20`
`And`	"E" lógico	`/RecurringDeductionItem?$filter=amount le 20 and amount gt 4`
`Or`	Lógico ou	`/RecurringDeductionItem?$filter=amount le 20 or amount gt 4`
`Not`	Negação lógica	`/RecurringDeductionItem?$filter=not endswith(payComponentType, 'SUPSPEE_US')`
Operadores aritméticos
`Add`	Adição	`/RecurringDeductionItem?$filter=amount add 5 gt 18`
`Sub`	Subtração	`/RecurringDeductionItem?$filter=amount sub 5 gt 18`
`Mul`	Multiplicação	`/RecurringDeductionItem?$filter=amount mul 2 gt 18`
`Div`	Divisão	`/RecurringDeductionItem?$filter=amount div 2 gt 18`
`Mod`	Módulo	`/RecurringDeductionItem?$filter=amount mod 2 eq 0`
Operadores de agrupamento
`( )`	Agrupamento de precedência	`/RecurringDeductionItem?$filter=(amount sub 5) gt 8`

Mapeamentos de tipo de dados

A tabela a seguir é uma lista de tipos de dados SAP com os tipos correspondentes do Cloud Data Fusion.

Tipo de dados do SuccessFactors	Tipo de dados do esquema do Cloud Data Fusion
`Binary`	`Bytes`
`Boolean`	`Boolean`
`Byte`	`Bytes`
`DateTime`	`DateTime`
`DateTimeOffset`	`Timestamp_Micros`
`Decimal`	`Decimal`
`Double`	`Double`
`Float`	`Float`
`Int16`	`Integer`
`Int32`	`Integer`
`Int64`	`Long`
`SByte`	`Integer`
`String`	`String`
`Time`	`Time_Micros`

Casos de uso

O exemplo de caso de uso a seguir são os dados de um único funcionário em EmployeePayrollRunResults:

Exemplo de propriedade	Valor de exemplo
externalCode	SAP_EC_PAYROLL_1000_0101201501312015_456_416
ID da pessoa	456
Usuário	user-1
ID do emprego	416
ID do provedor de folha de pagamento	SAP_EC_PAYROLL
Início do período de pagamento efetivo	01/01/2015
Fim do período de pagamento efetivo	31/01/2015
ID da empresa	BestRun Alemanha (1000)
Pagamento	28/01/2015
Moeda	EUR (EUR)
Tipo de execução da folha de pagamento	Normal (REGULAR)
ID do sistema	X0B

O exemplo mostra os resultados de um funcionário em EmployeePayrollRunResults:

`EmployeePayrollRunResults_externalCod`e	`EmployeePayrollRunResults_mdfSystemEffectiveStartDate`	`amount`	`createdBy`	`createdDate`
`SAP_EC_PAYROLL_2800_0101201901312019_305_265`	`1/31/2019 0:00:00`	`70923.9`	`sfadmin`	`12/10/2019 15:32:20`
`SAP_EC_PAYROLL_2800_0101201901312019_310_270`	`1/31/2019 0:00:00`	`64500`	`sfadmin`	`12/10/2019 15:32:20`
`SAP_EC_PAYROLL_2800_0201201902282019_305_265`	`2/28/2019 0:00:00`	`70923.9`	`sfadmin`	`12/10/2019 15:32:20`
`SAP_EC_PAYROLL_2800_0201201902282019_310_270`	`2/28/2019 0:00:00`	`64500`	`sfadmin`	`12/10/2019 15:32:20`
`SAP_EC_PAYROLL_2800_0301201903312019_305_265`	`3/31/2019 0:00:00`	`70923.9`	`sfadmin`	`12/10/2019 15:32:20`

Exemplo de pipeline

Confira exemplos de configurações no seguinte arquivo JSON:

  {
      "artifact": {
          "name": "data-pipeline-1",
          "version": "DATA_FUSION_VERSION",
          "scope": "SYSTEM"
      },
      "description": "",
      "name": "Demo_SuccessFactors_BatchSource",
      "config": {
          "resources": {
              "memoryMB": 2048,
              "virtualCores": 1
          },
          "driverResources": {
              "memoryMB": 2048,
              "virtualCores": 1
          },
          "connections": [
              {
                  "from": "SAP SuccessFactors",
                  "to": "BigQuery"
              }
          ],
          "comments": [],
          "postActions": [],
          "properties": {},
          "processTimingEnabled": true,
          "stageLoggingEnabled": false,
          "stages": [
              {
                  "name": "SAP SuccessFactors",
                  "plugin": {
                      "name": "SuccessFactors",
                      "type": "batchsource",
                      "label": "SAP SuccessFactors",
                      "artifact": {
                          "name": "successfactors-plugins",
                          "version": "PLUGIN_VERSION",
                          "scope": "USER"
                      },
                      "properties": {
                        "useConnection": "false",
                        "username": "${username}",
                        "password": "${password}",
                        "baseURL": "${baseUrl}",
                        "referenceName": "test",
                        "entityName": "${EmpCompensation}",
                        "proxyUrl": "${ProxyUrl}",
                        "paginationType": "serverSide",
                        "initialRetryDuration": "2",
                        "maxRetryDuration": "300",
                        "maxRetryCount": "3",
                        "retryMultiplier": "2",
                        "proxyUsername": "${Proxyusername}",
                        "proxyPassword": "${Proxypassword}"
                      }
                  },
                  "outputSchema": [
                      {
                          "name": "etlSchemaBody",
                          "schema": ""
                      }
                  ],
                  "id": "SAP-SuccessFactors"
              },
              {
                  "name": "BigQuery",
                  "plugin": {
                      "name": "BigQueryTable",
                      "type": "batchsink",
                      "label": "BigQuery",
                      "artifact": {
                          "name": "google-cloud",
                          "version": "BIGQUERY_PLUGIN_VERSION",
                          "scope": "SYSTEM"
                      },
                      "properties": {
                        "useConnection": "false",
                        "project": "auto-detect",
                        "serviceAccountType": "filePath",
                        "serviceFilePath": "auto-detect",
                        "referenceName": "Reff",
                        "dataset": "SF_Aug",
                        "table": "testdata_proxy",
                        "operation": "insert",
                        "truncateTable": "true",
                        "allowSchemaRelaxation": "true",
                        "location": "US",
                        "createPartitionedTable": "false",
                        "partitioningType": "TIME",
                        "partitionFilterRequired": "false"
                      }
                  },
                  "outputSchema": [
                      {
                          "name": "etlSchemaBody",
                          "schema": ""
                      }
                  ],
                  "inputSchema": [
                      {
                          "name": "SAP SuccessFactors",
                          "schema": ""
                      }
                  ],
                  "id": "BigQuery"
              }
          ],
           "schedule": "0 1 */1 * *",
        "engine": "spark",
        "numOfRecordsPreview": 100,
        "rangeRecordsPreview": {
            "min": 1,
            "max": "5000"
        },
        "description": "Data Pipeline Application",
        "maxConcurrentRuns": 1,
        "pushdownEnabled": false,
        "transformationPushdown": {}
      }
  }

Notas de lançamento

A seguir

Saiba mais sobre o SAP no Google Cloud.