Import-pipeline table provider that creates or updates Profile records and their group memberships as an import pipeline runs. Registered under the provider id "profile". Rows are matched by userId or, failing that, by email; when no existing profile is found and a group is specified a new profile is created within the pipeline's organisation. When a group is supplied the profile is given a membership of that group, within the organisation identified by orgId if given, otherwise the pipeline's own organisation. Deleting a row removes the profile's memberships within the pipeline's organisation rather than deleting the profile itself.

Implements: DatabaseTableProvider


Properties

PropertyReturnsDescription
providerIdStringProvider id this class is registered under. Used to select it from a DatabaseUpdateStep or DatabaseSourceStep configuration.
queryParametersList<TableParameter>Query parameters this provider accepts when building its source criteria.
tableFieldsList<TableParameter>Describes the row columns this provider accepts for insert, update and updateOrInsert: userId, firstName, surName, email, nickName, phone, group (the group to give the profile a membership of), orgId (the organisation the membership is created within), birthDate, password and enabled (which toggles the profile's account status).

Methods

getProviderId()

Returns: String

Provider id this class is registered under. Used to select it from a DatabaseUpdateStep or DatabaseSourceStep configuration.

getQueryParameters()

Returns: List<TableParameter>

Query parameters this provider accepts when building its source criteria.

getTableFields()

Returns: List<TableParameter>

Describes the row columns this provider accepts for insert, update and updateOrInsert: userId, firstName, surName, email, nickName, phone, group (the group to give the profile a membership of), orgId (the organisation the membership is created within), birthDate, password and enabled (which toggles the profile's account status).

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.