Join

Overview

Use the join transform to join two or more string values with a specified separator into a combined output. The join transform often joins elements such as first and last name into a full display name, but it has many other uses.

Transform structure

The join transform requires an array list of values that need to be joined. These values can be static strings or the return values of other nested transforms.

{
  "attributes": {
    "values": ["John", "Smith"],
    "separator": "|"
  },
  "type": "join",
  "name": "Join transform"
}

Top-level properties (required)

• type string (required)
  Must be set to join.

• name string (required)
  The name of the transform as it will appear in the UI's dropdown menus.

• requiresPeriodicRefresh boolean (optional)
  Whether the transform logic should be reevaluated every evening as part of the identity refresh process. Default is false.

Attributes

The join transform uses the following structure:

{
  "type": "join",
  "name": "Transform Name",
  "attributes": {
    "values": ["string1", "string2", ...],
    "separator": "|"
  }
}

---

attributes (required)

The attributes object contains the values to join.

Required

• values array (required)
  An array of items to join. Items can be static strings or the return values of other nested transforms.

Optional

• separator string (optional)
  The separator to use between each value in the array. Default is "," (comma).

Examples

This transform joins the user's first name and last name from the "HR Source" with a space separator.

Transform request body:

{
  "attributes": {
    "values": [
      {
        "attributes": {
          "sourceName": "HR Source",
          "attributeName": "FirstName"
        },
        "type": "accountAttribute"
      },
      {
        "attributes": {
          "sourceName": "HR Source",
          "attributeName": "LastName"
        },
        "type": "accountAttribute"
      }
    ],
    "separator": " "
  },
  "type": "join",
  "name": "Join Transform"
}

---

 

This transform joins the user's job title with his/her job code value using a hyphen as the separator.

Transform request body:

{
  "attributes": {
    "values": [
      {
        "attributes": {
          "sourceName": "HR Source",
          "attributeName": "JobTitle"
        },
        "type": "accountAttribute"
      },
      {
        "attributes": {
          "sourceName": "HR Source",
          "attributeName": "JobCode"
        },
        "type": "accountAttribute"
      }
    ],
    "separator": "-"
  },
  "type": "join",
  "name": "Join Transform"
}