Destination Adapter: beqom Data Foundation

Description

The beqom Data Foundation destination adapter delivers data through a REST API. The adapter handles authentication and ensures entities are delivered in the correct ingestion order. Errors from the Data Foundation Ingestion API are reported in the pipeline results file. See Pipeline results.

Authentication

The Accelerate Integration adapter connects to the Accelerate platform using Client Credentials. The Client Credentials are available through the Accelerate application interface.

Configuration

Required Parameters

To use this adapter, set the adapter configuration attribute to accelerate_integration.

client_id (string)

Your Accelerate client ID.

client_secret_name (string)

Alias of the secret containing your client secret.

base_domain (string)

The base domain for your Accelerate instance.

entity_type_data_frame_mapping (object)

Mapping of entity names to Data Frame names, each entry is a mapping beqom_entity_type -> data_frame_name

entity_ingestion_order (array of strings)

Ordered list of entity types for ingestion, e.g. ["Employment", "Worker"]

A list of entities is available in the Data Foundation Entities Documentation.

Optional Parameters

ingestion_mode (string, default: "full")

Controls which Data Foundation ingestion endpoint is used.

"full" — Upload the complete effective-dated history for each worker included in the file. Any previously uploaded worker records missing from the file are treated as soft deleted.

"incremental" — Upload only what has changed. New effective-dated records are added, and existing records are updated when field values change. Records not included remain unchanged. For ranged entities, you can now close old windows and add new ones without resending the entire history.

Example configuration

{
  "version": 1,
  "destination_adapters": [
    {
      "adapter": "accelerate_integration",
      "configuration": {
        "client_id": "my.client.id",
        "client_secret_name": "my-client-secret",
        "base_domain": "prod.accelerate.bqm-weu-aks-prd-1.beqom.io",
        "entity_type_data_frame_mapping": {
          "Worker": "my_worker_data_frame",
          "Demographics": "demographics_data_frame",
          "Employment": "employment_data_frame",
          "CompensationHistory": "compensationhistory_data_frame",
          "Absence": "absence_data_frame",
          "JobArchitecture": "jobarchitecture_data_frame",
          "Gender": "gender_data_frame",
          "MaritalStatus": "maritalstatus_data_frame",
          "Nationality": "nationality_data_frame",
          "EducationLevel": "educationlevel_data_frame",
          "Ethnicity": "ethnicity_data_frame",
          "EmploymentStatus": "employmentstatus_data_frame",
          "Organization": "organization_data_frame",
          "LegalEntity": "legalentity_data_frame",
          "CostCenter": "costcenter_data_frame",
          "CompensationElement": "compensationelement_data_frame",
          "AbsenceType": "absencetype_data_frame"
        },
        "entity_ingestion_order": [
          "Demographics",
          "Employment",
          "CompensationHistory",
          "Absence",
          "JobArchitecture",
          "Gender",
          "MaritalStatus",
          "Nationality",
          "EducationLevel",
          "Ethnicity",
          "EmploymentStatus",
          "Organization",
          "LegalEntity",
          "CostCenter",
          "CompensationElement",
          "AbsenceType",
          "Worker"
        ]
      }
    }
  ]
}

Error Handling

As this destination adapter uses the Data Foundation Ingestion endpoint, see the detailed error-handling documentation in the Ingestion status endpoint of the Data Foundation documentation