Import-pipeline table provider that creates or updates child organisations of the current account as an import pipeline runs. Registered under the provider id "organisation". A row is matched to an existing organisation by orgId, scoped to the pipeline's own organisation and its descendants. When inserting, parentOrgId selects which existing organisation the new one is created under, defaulting to the pipeline's own organisation; the new org id must differ from its parent's. Supported columns also cover address and contact details, the org's timezone, its org type (or a comma-separated tags list of org types), and any custom fields defined by those org types. Deleting a row deletes the matched organisation.
Implements: DatabaseTableProvider
Properties
| Property | Returns | Description |
|---|---|---|
| providerId | String | Provider id this class is registered under. Used to select it from a DatabaseUpdateStep or DatabaseSourceStep configuration. |
| queryParameters | List<TableParameter> | Query parameters this provider accepts when building its source criteria. |
| tableFields | List<TableParameter> | Describes the row columns this provider accepts for insert, update and updateOrInsert: orgId (required, the organisation's unique identifier), title, phone, address, addressLine2, city, state, postcode, email, timezone and parentOrgId (the organisation the new organisation is created under). orgType, tags and any custom fields defined by the organisation's org types are also accepted but are not listed here. |
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: orgId (required, the organisation's unique identifier), title, phone, address, addressLine2, city, state, postcode, email, timezone and parentOrgId (the organisation the new organisation is created under). orgType, tags and any custom fields defined by the organisation's org types are also accepted but are not listed here.