For Developers

Transformations Overview

A Shared Transformation applies automated data transformations to educational records during materialization. This enables formatting student email addresses, normalizing course identifiers, or calculating composite usernames.

Properties

PropertyTypeDescription
idUUIDUnique identifier for the transformation.
created_dateDateDate when the transformation was created.
updated_dateDateLast modification timestamp.
nameStringHuman-readable name for the transformation.
typeStringTransformation type (e.g. string_replace, regex, format_email).
targetStringTarget entity property (e.g. people.email, classes.name).
configurationObjectParameters and execution rules for the transformation.

JSON Example

{
    "id": "18492019-4819-4bb4-8172-401928472910",
    "name": "Standardize Student Email Domain",
    "type": "format_email",
    "target": "people.email",
    "configuration": {
        "domain": "students.oakridge.k12.org"
    }
}