Skip to content

Minor updates on how to implement external profile data. #7487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 10, 2025
Merged

Minor updates on how to implement external profile data. #7487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9b1df2
Update implement-your-own-segment-parameters.md
dtng95 Oct 10, 2025
1d2435b
Update external-profile-data.md
dtng95 Oct 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified 16/umbraco-engage/.gitbook/assets/External-profile-data-tab-v16.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 12 additions & 5 deletions 16/umbraco-engage/developers/profiling/external-profile-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ If you want to use external data in a custom segment you have to write the data

## Visualization

It is possible to visualize this external data alongside the Umbraco Engage profile in the backoffice by providing a custom `AngularJS` component for this purpose.
It is possible to visualize this external data alongside the Umbraco Engage profile in the backoffice by providing a custom Web component for this purpose.

When this component is registered a new tab will be rendered in the Profiles section when viewing profile details. This will render the custom component that was provided and get passed the Umbraco Engage visitor ID.

![External profile data tab.](../../.gitbook/assets/External-profile-data-tab-v16.png)

### Register custom components

To render this External Profile Tab with a custom component, create your component and register it with Umbraco Engage. The following code demonstrates both steps. Add the below code in a TypeScript file:
To render this External Data Demo tab with a custom component, create your component and register it with Umbraco Engage. The following code demonstrates both steps. Add the below code in a TypeScript file:

```typescript
export class EngageProfileInsightElement extends UmbLitElement {
Expand All @@ -38,8 +38,15 @@ export class EngageProfileInsightElement extends UmbLitElement {
}
render() {
return html`
<h1>This is a custom external profile data element</h1>
<p>Current profile id: ${this.#profileId}</p>`;
<table>
<tr>
<td>This is a custom profile insight element</td>
</tr>
<tr>
<td>Current profile id: ${this.#profileId}</td>
</tr>
</table>
`;
}
}
export { EngageProfileInsightElement as element }
Expand All @@ -52,7 +59,7 @@ Then, load your component using a `manifest.ts` file. The extension type must be
{
"type": "engageExternalDataComponent",
"alias": "EngageDemo.ExternalProfileData",
"name": "External Profile Data Demo",
"name": "External Data Demo",
"weight": 100,
"js": "/path/to/my-javascript.js"
}
Expand Down