enableCustomMapping - hotglue Docs

Getting Started

Call enableCustomMapping with a map of connector IDs to table-pair configurations.

<script src="https://hotglue.xyz/widgetv3.js"></script>
<script>
  const hotglue = new Hotglue({
    tenantId: '<your-tenant-id>',
    environmentId: '<your-environment-id>',
    apiKey: '<your-api-key>',
    jwt: '<tenant-jwt>'
  });

  hotglue.enableCustomMapping({
    salesforce: [
      {
        id: 'products',
        sourceTable: {
          type: 'customSchema',
          tableName: 'products',
          customSchema: {
            id: { type: 'string' },
            title: { type: 'string' },
          },
        },
        targetTable: {
          type: 'catalog',
          tableName: 'Products',
          entity: { type: 'connector', id: 'salesforce' },
        },
      },
    ],
  });
</script>

Source to Target Custom Mapping Demo

Parameters

enableCustomMapping accepts Record<string, MappingConfiguration[]>. The key is a connector ID. Each configuration has:

Parameter	Description
`id`	Unique mapping ID.
`title`	Optional mapping title.
`sourceTable`	The source table.
`targetTable`	The target table.
`allowManyToOneFieldMappings`	Optional. Allow many source fields to use one target field.
`allowOneToManyTableMappings`	Optional. Allow one source table to be mapped to multiple target tables.

Each table has a type:

Type	Use	Parameters
`catalog`	A connector or source catalog table.	`tableName`, `tableLabel`, and `entity` with a type and ID
`customSchema`	A table and fields you define.	`tableName`, `tableLabel`, and field names with a type and optional `required` flag; optional `entity`. For one-to-many mappings, use `schemas` instead of `tableName` and `customSchema` to provide multiple selectable tables.
`metadataMapping`	Fields from connector metadata.	`tableName`, `tableLabel`, `entity`, `metadataKey`
`tenantInput`	A value entered by the tenant.	`tableName`, `tableLabel`, `tenantInputOptions` (`inputType: ‘text'	'number’`, optional` prefix`,` placeholder`)

The sourceTable and targetTable can use different types.

One source table to multiple target tables

Set allowOneToManyTableMappings to true and provide multiple custom-schema target tables with schemas. The widget groups target fields by table label, and saving creates one mapping entry for each selected target table.

hotglue.enableCustomMapping({
  salesforce: [
    {
      id: 'salesforce-to-hubspot',
      allowOneToManyTableMappings: true,
      sourceTable: {
        type: 'customSchema',
        tableName: 'events',
        customSchema: {
          event_field: { type: 'string' },
        },
      },
      targetTable: {
        type: 'customSchema',
        schemas: [
          {
            tableName: 'contacts',
            tableLabel: 'HubSpot Contacts',
            customSchema: { contact_id: { type: 'string' } },
          },
          {
            tableName: 'companies',
            tableLabel: 'HubSpot Companies',
            customSchema: { company_id: { type: 'string' } },
          },
        ],
      },
    },
  ],
});

For existing single-target configurations, no migration is required. Existing persisted mappings remain readable and are upgraded to version 2.0 with an entry-level id when they are saved again.

React example

import { useHotglue } from '@hotglue/widget';

const { enableCustomMapping, openWidget } = useHotglue({
  tenantId,
  environmentId,
  apiKey,
});

enableCustomMapping({
  salesforce: [
    {
      id: 'leads',
      sourceTable: {
        type: 'customSchema',
        tableName: 'Leads',
        customSchema: {
          first_name: { type: 'string' },
          last_name: { type: 'string' },
          email: { type: 'string', required: true },
        },
      },
      targetTable: {
        type: 'catalog',
        tableName: 'Contact',
        entity: { type: 'connector', id: 'salesforce' },
      },
    },
  ],
});

openWidget(tenantId);

Sample mapping output

After saving their mapping, the following field is added to the tenant’s tenant-config.

"hotglue_mapping": {
  "mapping": {
    "dynamics-bc": [
      {
        "source": "Supporters",
        "target": "Account",
        "fields": {
          "first_name": "FirstName",
          "last_name": "LastName",
          "email": "PersonEmail"
        }
      },
      {
        "source": "Contributions",
        "target": "GiftTransaction",
        "fields": {
          "sample_hgexid": "Demo_Gift_Transaction_ID__c",
          "contribution_number": "Name"
        }
      }
    ]
  }
}

source values match the configured source table names, and field keys in fields match the configured schema fields.

​Getting Started

​Parameters

​One source table to multiple target tables

​React example

​Sample mapping output

Getting Started

Parameters

One source table to multiple target tables

React example

Sample mapping output