Use Cases

Connect+ use cases show you how to build end-to-end dataflows for common integration scenarios. Each use case covers the full block sequence, configuration values, and any data transformations involved.

Use case 1: Bulk add customer

Use this dataflow to register customer profiles in bulk. The dataflow reads customer data from a source CSV file, groups records into batches, transforms each batch into the format required by the Capillary V2 API, and posts them to the /v2/customers/bulk endpoint.

Scenario

A brand conducting an in-store registration drive collects customer data in CSV format. The file includes names, mobile numbers, registration source, and loyalty type for each customer. Connect+ reads the file, groups records into batches of 10, transforms each batch into the nested API payload, and posts them to the Capillary platform in a single scheduled operation.

Sample CSV input

Block sequence

Connect-to-source → Convert-CSV-to-JSON → Transform-data → Connect-to-destination

Block configuration

The following table lists the blocks in this dataflow, describes what each block does, and provides the configured values for each field.

Connect-to-source

Connect-to-source connects to the SFTP server, polls for CSV files matching the specified filename pattern, and passes them to the Convert-CSV-to-JSON block.

Convert-CSV-to-JSON

Convert-CSV-to-JSON reads the source CSV and converts each row into a flat JSON object. A group size of 10 batches records before Transform-data processes them.

JSLT transformation

Connect+ converts each CSV row into a JSON object and passes the full array to the jslt_transform block before sending the data to the destination.

The Transform Data block uses the following JSLT expression to reshape each flat JSON record into the nested structure required by the /v2/customers/bulk API. The for (.) loop iterates over each record in the batch.

Input row (as JSON after CSV conversion)

{
  "firstname": "John",
  "lastname": "Doe",
  "value": "919812345678",
  "source": "INSTORE",
  "loyaltyType": "loyalty",
  "identifierType": "mobile"
}

JSLT expression

[
  for (.)
  {
    "profiles": [
      {
        "firstName": .firstname,
        "lastName": .lastname,
        "source": .source,
        "identifiers": [
          {
            "type": .identifierType,
            "value": .value
          }
        ]
      }
    ],
    "loyaltyInfo": {
      "loyaltyType": .loyaltyType
    }
  }
]

Output JSON

[
  {
    "profiles": [
      {
        "firstName": "John",
        "lastName": "Doe",
        "source": "INSTORE",
        "identifiers": [
          {
            "type": "mobile",
            "value": "919812345678"
          }
        ]
      }
    ],
    "loyaltyInfo": {
      "loyaltyType": "loyalty"
    }
  },
  {
    "profiles": [
      {
        "firstName": "Ravi",
        "lastName": "Kumar",
        "source": "INSTORE",
        "identifiers": [
          {
            "type": "mobile",
            "value": "919812340814"
          }
        ]
      }
    ],
    "loyaltyInfo": {
      "loyaltyType": "loyalty"
    }
  },
  {
    "profiles": [
      {
        "firstName": "Jane",
        "lastName": "Smith",
        "source": "INSTORE",
        "identifiers": [
          {
            "type": "mobile",
            "value": "919812349864"
          }
        ]
      }
    ],
    "loyaltyInfo": {
      "loyaltyType": "loyalty"
    }
  }
]

How the expression works:

The following table describes each field mapping.

Connect-to-destination

Connect-to-destination receives the transformed JSON from Transform-data and posts each batch to the /v2/customers/bulk API endpoint. It handles OAuth authentication, retries recoverable errors, and applies rate limiting.

Use case 2: Add a single customer

Use this dataflow to register one customer record at a time. The dataflow reads customer data from a source CSV file, processes each row individually, transforms the record into the format required by the Capillary V2 API, and posts it to the /v2/customers endpoint.

Scenario

A brand collects individual customer registrations from an in-store system in CSV format, with each record containing the customer's name, mobile number or email address, and registration source. Connect+ reads the file, processes each row one at a time, transforms the flat record into the nested API payload, and posts it to the Capillary platform.

Sample CSV input

Block sequence

Connect-to-source → Convert-CSV-to-JSON → Transform-data → Connect-to-destination

Block configuration

The following table lists the blocks in this dataflow, describes what each block does, and provides the configured values for each field.

Connect-to-source

Connect-to-source connects to the source SFTP server, polls for CSV files matching the specified filename pattern, and passes them to the Convert-CSV-to-JSON block.

Convert-CSV-to-JSON

Convert-CSV-to-JSON reads the source CSV and converts each row into a flat JSON object. A group size of 1 ensures each record passes to the Transform-data block individually before Connect-to-destination posts it to the API.

JSLT transformation

Connect+ converts each CSV row into a JSON object and passes it—one record at a time—to the Transform-data block.

Step 1: Input

The Convert-CSV-to-JSON block converts each CSV row into a flat JSON object before it reaches Transform-data.

{
  "firstname": "John",
  "lastname": "Smith",
  "value": "918298526106",
  "source": "INSTORE",
  "identifierType": "mobile"
}

Step 2: JSLT expression

Unlike the bulk add use case, this expression does not use a for (.) loop. It maps a single flat JSON object directly to the nested structure required by the /v2/customers API.

{
  "profiles": [
    {
      "firstName": .firstname,
      "lastName": .lastname,
      "source": .source,
      "identifiers": [
        {
          "type": .identifierType,
          "value": .value
        }
      ]
    }
  ]
}

Step 3: Output

The expression produces a single JSON object with a nested profiles array.

{
  "profiles": [
    {
      "firstName": "John",
      "lastName": "Smith",
      "source": "INSTORE",
      "identifiers": [
        {
          "type": "mobile",
          "value": "918298526106"
        }
      ]
    }
  ]
}

How the expression works

Field mapping

Connect-to-destination

Connect-to-destination receives the transformed JSON from Transform-data and posts each record to the /v2/customers API endpoint, handling OAuth authentication, retrying recoverable errors, and applying rate limiting.