Skip to content
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.

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

Rainfocus Destination Connector Docs #392

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
157 changes: 157 additions & 0 deletions help/destinations/catalog/marketing-automation/rainfocus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
---
title: RainFocus
description: Learn how to use the RainFocus Destination Connector to syncronize audience profiles with the RainFocus Global Attendee Profile .
---

# RainFocus {#rainfocus-destination}

## Overview {#overview}

The RainFocus destination connector allows organizations to stream customer profiles from the Adobe Experience Platform into the RainFocus platform in order to create/update Attendee Profiles.
mgmilcher marked this conversation as resolved.
Show resolved Hide resolved

>[!IMPORTANT]
>
>The destination connector and documentation page are created and maintained by the RainFocus team. For any inquiries or update requests, please contact them directly at [email protected] or visit the RainFocus [Help Center](https://help.rainfocus.com/hc/en-us).

## Use cases {#use-cases}

To help you better understand how and when you should use the RainFocus destination, here are sample use cases that Adobe Experience Platform customers can solve by using this destination.

### Use case #1 {#use-case-1}

A large enterprise technology company is due to open registration for its upcoming global expo and would like to push customer profiles to RainFocus in order to streamline the registration process.

### Use case #2 {#use-case-2}

A financial services brand is due to host a series of roadshows targeting new and existing customers. They have a series of audience segments with target customers in Adobe Experience Platform. Using the RainFocus Destination Connector they are able to easily send those profiles to RainFocus for activation.
mgmilcher marked this conversation as resolved.
Show resolved Hide resolved

## Prerequisites {#prerequisites}

mgmilcher marked this conversation as resolved.
Show resolved Hide resolved
* RainFocus API Profile with OAuth (Global)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For all these requirements, is there associated documentation on the RainFocus side to link to?

* **Attendee Store** endpoint enabled
mgmilcher marked this conversation as resolved.
Show resolved Hide resolved
* Client Id
* Client Secret

* Event Code for the desired event to push profiles into.

## Supported identities {#supported-identities}

RainFocus supports the activation of identities described in the table below. Learn more about [identities](/help/identity-service/namespaces.md).

|Target Identity|Description|Considerations|
|---|---|---|
|email_lc_sha256|Email addresses hashed with the SHA256 algorithm|Both plain text and SHA256 hashed email addresses are supported by Adobe Experience Platform. When your source field contains unhashed attributes, check the **[!UICONTROL Apply transformation]** option, to have [!DNL Platform] automatically hash the data on activation.|

{style="table-layout:auto"}

## Supported audiences {#supported-audiences}

This section describes which type of audiences you can export to this destination.

| Audience origin | Supported | Description |
---------|----------|----------|
| [!DNL Segmentation Service] | ✓ | Audiences generated through the Experience Platform [Segmentation Service](../../../segmentation/home.md).|
| Custom uploads | ✓ | Audiences [imported](../../../segmentation/ui/overview.md#import-audience) into Experience Platform from CSV files. |

{style="table-layout:auto"}

## Export type and frequency {#export-type-frequency}

Refer to the table below for information about the destination export type and frequency.

| Item | Type | Notes |
---------|----------|---------|
| Export type | **[!UICONTROL Profile-based]** | You are exporting all members of a segment, together with the desired schema fields (for example: email address, phone number, last name), as chosen in the select profile attributes screen of the [destination activation workflow](/help/destinations/ui/activate-batch-profile-destinations.md#select-attributes).|
| Export frequency | **[!UICONTROL Streaming]** | Streaming destinations are "always on" API-based connections. As soon as a profile is updated in Experience Platform based on segment evaluation, the connector sends the update downstream to the destination platform. Read more about [streaming destinations](/help/destinations/destination-types.md#streaming-destinations).|

{style="table-layout:auto"}

## Connect to the destination {#connect}

>[!IMPORTANT]
>
>To connect to the destination, you need the **[!UICONTROL View Destinations]** and **[!UICONTROL Manage Destinations]** [access control permission](/help/access-control/home.md#permissions). Read the [access control overview](/help/access-control/ui/overview.md) or contact your product administrator to obtain the required permissions.

To connect to this destination, follow the steps described in the [destination configuration tutorial](../../ui/connect-destination.md). In the configure destination workflow, fill in the fields listed in the two sections below.

### Authenticate to destination {#authenticate}

To authenticate to the destination, fill in the required fields and select **[!UICONTROL Connect to destination]**.

![](/help/destinations/assets/catalog/events-management/rainfocus/rainfocus-destination-authentication.png)

* **[!UICONTROL Client ID]**: Fill in the Client ID provided by RainFocus
mgmilcher marked this conversation as resolved.
Show resolved Hide resolved
* **[!UICONTROL Client Secret]**: Fill in the Client Secret provided by RainFocus
* **[!UICONTROL Environment]**: Specify which RainFocus environment you are connecting to e.g `dev`, `prod`
mgmilcher marked this conversation as resolved.
Show resolved Hide resolved
* **[!UICONTROL Org ID]**: Provide the unique `orgid` for your instance of RainFocus
mgmilcher marked this conversation as resolved.
Show resolved Hide resolved

### Fill in destination details {#destination-details}

To configure details for the destination, fill in the required and optional fields below. An asterisk next to a field in the UI indicates that the field is required.

![](/help/destinations/assets/catalog/events-management/rainfocus/rainfocus-configure-destination-details.png)

* **[!UICONTROL Name]**: A name by which you will recognize this destination in the future.
* **[!UICONTROL Description]**: A description that will help you identify this destination in the future.
* **[!UICONTROL Event ID]**: Your RainFocus event code, for which you would let to send profiles to.
mgmilcher marked this conversation as resolved.
Show resolved Hide resolved

### Enable alerts {#enable-alerts}

You can enable alerts to receive notifications on the status of the dataflow to your destination. Select an alert from the list to subscribe to receive notifications on the status of your dataflow. For more information on alerts, see the guide on [subscribing to destinations alerts using the UI](../../ui/alerts.md).

When you are finished providing details for your destination connection, select **[!UICONTROL Next]**.

## Activate segments to this destination {#activate}

>[!IMPORTANT]
>
>* To activate data, you need the **[!UICONTROL View Destinations]**, **[!UICONTROL Activate Destinations]**, **[!UICONTROL View Profiles]**, and **[!UICONTROL View Segments]** [access control permissions](/help/access-control/home.md#permissions). Read the [access control overview](/help/access-control/ui/overview.md) or contact your product administrator to obtain the required permissions.

Read [Activate profiles and segments to streaming segment export destinations](/help/destinations/ui/activate-segment-streaming-destinations.md) for instructions on activating audience segments to this destination.

### Map attributes and identities {#map}

The following target identity namespace(s) must be mapped depending on the use case:

* **Email** must be mapped as a target field using **Target field > Select identity namespace > email**

![](/help/destinations/assets/catalog/events-management/rainfocus/rainfocus-destination-mapping.png)
mgmilcher marked this conversation as resolved.
Show resolved Hide resolved

It is also strongly recommended to map additional fields, the following target fields are available from RainFocus
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

first, please use punctuation at the end of the sentence.
next, why is is strongly recommended? something like:

Rainfocus strongly recommends that you map additional fields, as this will [describe reason]. The following target fields are available from RainFocus.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've refactored the wording. Let us know if that works.


| Target Field | Description |
|------------|-------------|
| address1 | The first line of the street address |
| address2 | The second line of the street address (if applicable) |
| city | The city name |
| companyname| The name of the company |
| countryid | An ISO 3166-1 alpha-2 country code identifier for the country |
| email | The email address |
| firstname | The person's first name |
| lastname | The person's last name |
| jobtitle | The person's job title |
| phone | The phone number |
| state | The FIPS state alpha code for the state or province |
| zip | The postal code or ZIP code |

## Exported data / Validate data export {#exported-data}

A sample JSON of the exported data is provided below, which uses the example mapping from the screenshot above in the Map attributes and identities section:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case, the purpose is rather to show users what to expect on the RainFocus side. Can we instead of this snippet show a screenshot or information about how data looks like once it's available in RainFocus?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've added screenshots of how to validate in our platform. Let us know if that works.


```
{
"firstname": "John",
"phone": "+1 (555) 123-4567",
"email": "[email protected]",
"countryId": "US",
"lastname": "Doe"
}
```

## Data usage and governance {#data-usage-governance}

All [!DNL Adobe Experience Platform] destinations are compliant with data usage policies when handling your data. For detailed information on how [!DNL Adobe Experience Platform] enforces data governance, read the [Data Governance overview](/help/data-governance/home.md).

## Additional resources {#additional-resources}

* [RainFocus Streaming Source Connector](https://experienceleague.adobe.com/en/docs/experience-platform/sources/connectors/analytics/rainfocus)