Merge pull request #552 from segmentio/repo-sync

bot-docsteam · web-flow · commit 9a2842e59233 · 2022-09-06T09:03:31.000-07:00
repo sync
diff --git a/.github/styles/Vocab/Docs/accept.txt b/.github/styles/Vocab/Docs/accept.txt
@@ -92,6 +92,7 @@ param(:?s)
 Pardot
 performant
 Preact
+Qualtrics
 Rokt
 Selligent
 Shopify
diff --git a/src/_data/catalog/destinations_private.yml b/src/_data/catalog/destinations_private.yml
@@ -1,5 +1,5 @@
 # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
-# destination data last updated 2022-08-25 with Pardot (Actions) 
+# destination data last updated 2022-09-06 with Qualtrics 
 items:
   - id: 54521fd525e721e32a72ee8e
     name: AdRoll
@@ -2215,3 +2215,239 @@ items:
             dynamic: false
             allowNull: false
     presets: []
+  - id: 62e17e6f687e4a3d32d0f875
+    display_name: Qualtrics
+    name: Qualtrics
+    slug: actions-qualtrics
+    previous_names:
+      - Qualtrics
+    website: http://www.segment.com
+    status: PRIVATE_BETA
+    logo:
+      url: https://cdn.filepicker.io/api/file/jrbUXsZDQ708akn3cVyZ
+    mark:
+      url: https://cdn.filepicker.io/api/file/jrbUXsZDQ708akn3cVyZ
+    methods:
+      track: true
+      pageview: true
+      identify: true
+      group: true
+      alias: true
+    platforms:
+      browser: true
+      mobile: false
+      server: true
+    components: []
+    browserUnbundlingSupported: false
+    browserUnbundlingPublic: false
+    replay: false
+    settings:
+      - name: apiToken
+        type: string
+        defaultValue: ''
+        description: >-
+          Qualtrics API token found in your Qualtrics account under "Account
+          settings" -> "Qualtrics IDs."
+        required: true
+        label: API Token
+      - name: datacenter
+        type: string
+        defaultValue: ''
+        description: >-
+          Qualtrics datacenter id that identifies where your qualtrics instance
+          is located. Found under "Account settings" -> "Qualtrics IDs".
+        required: true
+        label: Datacenter ID
+    actions:
+      - id: rMsycYYBB1vzGZv3ATE8ks
+        name: Add / Update Contact in XMD
+        slug: addContactToXmd
+        description: Add or update contact in XMD
+        platform: CLOUD
+        hidden: false
+        defaultTrigger: type = "identify"
+        fields:
+          - id: gzXtk2s9vPxuFjymeyeCmr
+            sortOrder: 0
+            fieldKey: directoryId
+            label: Directory ID
+            type: STRING
+            description: Directory id. Also known as the Pool ID. POOL_XXX
+            placeholder: ''
+            defaultValue:
+              '@path': $.traits.directoryId
+            required: true
+            multiple: false
+            choices: null
+            dynamic: false
+            allowNull: false
+          - id: ssmexAbNCQ3xuxr5B7n2DN
+            sortOrder: 1
+            fieldKey: extRef
+            label: External Data Reference
+            type: STRING
+            description: >-
+              The external data reference which is a unique identifier for the
+              user
+            placeholder: ''
+            defaultValue:
+              '@path': $.userId
+            required: false
+            multiple: false
+            choices: null
+            dynamic: false
+            allowNull: false
+          - id: mEgJZ5LVvDmdHYwrm1BjMQ
+            sortOrder: 2
+            fieldKey: email
+            label: Email
+            type: STRING
+            description: Email of contact
+            placeholder: ''
+            defaultValue:
+              '@if':
+                exists:
+                  '@path': $.email
+                then:
+                  '@path': $.email
+                else:
+                  '@path': $.traits.email
+            required: false
+            multiple: false
+            choices: null
+            dynamic: false
+            allowNull: false
+          - id: 5AwF7aTcLs7qLzKQYXiYcS
+            sortOrder: 3
+            fieldKey: phone
+            label: Phone number
+            type: STRING
+            description: Phone number of contact
+            placeholder: ''
+            defaultValue:
+              '@path': $.traits.phone
+            required: false
+            multiple: false
+            choices: null
+            dynamic: false
+            allowNull: false
+          - id: bGxcFVRe2ZHXHAqXWb9jFj
+            sortOrder: 4
+            fieldKey: firstName
+            label: First Name
+            type: STRING
+            description: First name of contact
+            placeholder: ''
+            defaultValue:
+              '@path': $.traits.firstName
+            required: false
+            multiple: false
+            choices: null
+            dynamic: false
+            allowNull: false
+          - id: agkd786Quy8ovJCVe2QYzL
+            sortOrder: 5
+            fieldKey: lastName
+            label: Last Name
+            type: STRING
+            description: Last name of contact
+            placeholder: ''
+            defaultValue:
+              '@path': $.traits.lastName
+            required: false
+            multiple: false
+            choices: null
+            dynamic: false
+            allowNull: false
+          - id: eXvgHoRMcQG8u4wofVgAaA
+            sortOrder: 6
+            fieldKey: language
+            label: Language
+            type: STRING
+            description: Language code of the contact
+            placeholder: ''
+            defaultValue:
+              '@if':
+                exists:
+                  '@path': $.traits.language
+                then:
+                  '@path': $.traits.language
+                else: EN
+            required: false
+            multiple: false
+            choices: null
+            dynamic: false
+            allowNull: false
+          - id: t6u7Jrncd2yGaj69WHiiHV
+            sortOrder: 7
+            fieldKey: unsubscribed
+            label: Contact is unsubscribed
+            type: BOOLEAN
+            description: Should the contact be unsubscribed from correspondence
+            placeholder: ''
+            defaultValue: false
+            required: false
+            multiple: false
+            choices: null
+            dynamic: false
+            allowNull: false
+          - id: kj2kShh6ZdchL29q3y7Wp9
+            sortOrder: 8
+            fieldKey: embeddedData
+            label: Contact embedded data
+            type: OBJECT
+            description: Contact embedded data (properties of the contact)
+            placeholder: ''
+            required: false
+            multiple: false
+            choices: null
+            dynamic: false
+            allowNull: false
+      - id: u3JwUn6SECofbhY2y7FThX
+        name: Trigger workflow in xflow
+        slug: triggerXflowWorkflow
+        description: This action triggers a workflow in Qualtrics xflow
+        platform: CLOUD
+        hidden: false
+        defaultTrigger: null
+        fields:
+          - id: 4Kb3t8a8Tte1hLR1p6fdc6
+            sortOrder: 0
+            fieldKey: workflowUrl
+            label: Workflow URL
+            type: STRING
+            description: >-
+              Enter the full URL as you see in your Xflow trigger. See more
+              details on setting up an xflow trigger and getting the URL here.
+            placeholder: ''
+            required: true
+            multiple: false
+            choices: null
+            dynamic: false
+            allowNull: false
+          - id: eTBjVC88eeFDtT7nUjW5Fu
+            sortOrder: 1
+            fieldKey: eventPayload
+            label: Event payload
+            type: OBJECT
+            description: A mapping of key values to send to Qualtrics xflow.
+            placeholder: ''
+            defaultValue:
+              event:
+                '@path': $.event
+              type:
+                '@path': $.type
+              userId:
+                '@path': $.userId
+              properties:
+                '@path': $.properties
+              traits:
+                '@path': $.traits
+              context:
+                '@path': $.context
+            required: false
+            multiple: false
+            choices: null
+            dynamic: false
+            allowNull: false
+    presets: []
diff --git a/src/connections/destinations/catalog/actions-qualtrics/index.md b/src/connections/destinations/catalog/actions-qualtrics/index.md
@@ -0,0 +1,48 @@
+---
+title: Qualtrics Destination
+hide-boilerplate: true
+hide-dossier: true
+id: 62e17e6f687e4a3d32d0f875
+private: true
+---
+
+<!-- This template is meant for Actions-based destinations that do not have an existing Classic or non-Actions-based version. For Actions Destinations that are a new version of a classic destination, see the doc-template-update.md template. -->
+
+{% include content/plan-grid.md name="actions" %}
+
+<!-- Include a brief description of the destination here, along with a link to your website. -->
+
+[Qualtrics](https://qualtrics.com) is an Experience Management platform that allows companies to design and improve customer and employee experiences through listening, analysis and action. Power richer Qualtrics insights or perform action based on your event data using the Qualtrics destination
+
+<!-- This include describes the requirement of A.js 2.0 or higher for Actions compatibility, and is required if your destination has a web component. -->
+
+{% include content/ajs-upgrade.md %}
+
+<!-- In the section below, explain the value of this actions-based destination. If you don't have a classic version of the destination, remove this section. -->
+
+## Benefits of Qualtrics (Actions)
+
+Qualtrics (Actions) provides the following benefits:
+
+- **Keeping your contact data in sync**. The Qualtrics destination provides actions to sync your contact data from your system of record up to date with Qualtrics XiD
+- **Streamlined configuration**. Qualtrics destination maps your event data to the Qualtrics API & Qualtrics xflow (workflows) out of the box
+
+<!-- The section below explains how to enable and configure the destination. Include any configuration steps not captured below. For example, obtaining an API key from your platform and any configuration steps required to connect to the destination. -->
+
+## Getting started
+
+1. From the Segment web app, click **Catalog**, then click **Destinations**.
+2. Find the Destinations Actions item in the left navigation, and click it.
+3. Click **Configure Qualtrics**.
+4. Select an existing Source to connect to Qualtrics (Actions).
+5. To authenticate, enter your API key & Datacenter ID. To locate your API key & Datacenter ID, follow in the instructions found [here](https://api.qualtrics.com/ZG9jOjg3NjYzNQ-finding-your-qualtrics-i-ds)
+
+<!-- The line below renders a table of connection settings (if applicable), Pre-built Mappings, and available actions. -->
+
+{% include components/actions-fields.html %}
+
+<!--
+Additional Context
+
+Include additional information that you think will be useful to the user here. For information that is specific to an individual mapping, please add that as a comment so that the Segment docs team can include it in the auto-generated content for that mapping.
+-->
diff --git a/src/engage/audiences/index.md b/src/engage/audiences/index.md
@@ -83,6 +83,12 @@ Because most marketing tools are still based at the user level, it is often impo
 > info ""
 > When you connect a new Destination to an existing Audience, Personas will backfill historical data for that Audience to the new Destination.
 
+## Understanding compute times
+
+Because a number of factors (like system load, backfills, or user bases) determine the complexity of an Audience, some compute times take longer than others.
+
+As a result, **Segment recommends waiting at least 24 hours for an Audience to finish computing** before you resume working with the Audience.
+
 ## Real-time compute compared to batch
 
 Real-time Compute allows you to update traits and Audiences as Segment receives new events. Real-time Compute unlocks exciting use cases:
diff --git a/src/engage/profiles/computed-traits.md b/src/engage/profiles/computed-traits.md
@@ -158,14 +158,20 @@ Learn more about [Computed trait generated events here](/docs/personas/using-per
 
 For account-level computed traits, you have the option to send either a [group](/docs/connections/spec/group/) call and/or [identify](/docs/connections/spec/identify/) call. Group calls will send one event per account, whereas identify calls will send an identify call for each user in the account. This means that even if a user hasn't performed an event, Segment will still set the account-level computed trait on that user. Because most marketing tools are still based at the user level, it is often important to map this account-level trait onto each user within an account. See [Account-level Audiences](/docs/personas/audiences/account-audiences) for more information.
 
-## Editing Realtime Traits
+## Understanding compute times
 
-Personas supports the editing of realtime Traits, which allows you to make nuanced changes to existing Traits in situations where cloning or building from scratch may not suit your use case.
+Because a number of factors (like system load, backfills, or user bases) determine the complexity of a Computed Trait, some compute times take longer than others.
 
-To edit a realtime Trait, follow these steps:
+As a result, **Segment recommends waiting at least 24 hours for a Trait to finish computing** before you resume working with the Trait.
+
+## Editing Real-time Traits
+
+Personas supports the editing of real-time Traits, which allows you to make nuanced changes to existing Traits in situations where cloning or building from scratch may not suit your use case.
+
+To edit a real-time Trait, follow these steps:
 
 1. In your Personas Space, select the **Computed Traits** tab.
-2. Select the realtime Trait you want to edit.
+2. Select the real-time Trait you want to edit.
 3. Select the **Builder** tab and make your edits.
 4. Select **Save Computed Trait** to confirm your edits.
 
diff --git a/src/personas/audiences/index.md b/src/personas/audiences/index.md
@@ -4,7 +4,7 @@ title: Personas Audiences Overview
 
 Audiences let you group users or accounts based on event behavior and traits that Segment tracks.
 
-You can build Audiences from core **tracking events**, **traits**, and **computed traits**. You can then sync Audiences to hundreds of [Destinations](/docs/connections/destinations/) or access them with the [Profile API](/docs/personas/profile-api).
+You can build Audiences from core **tracking events**, **traits**, and [**computed traits**](/docs/personas/computed-traits/). You can then sync Audiences to hundreds of [Destinations](/docs/connections/destinations/) or access them with the [Profile API](/docs/personas/profile-api).
 
 ## Building an Audience
 
@@ -80,6 +80,12 @@ Because most marketing tools are still based at the user level, it is often impo
 > info ""
 > When you connect a new Destination to an existing Audience, Personas will backfill historical data for that Audience to the new Destination.
 
+## Understanding compute times
+
+Because a number of factors (like system load, backfills, or user bases) determine the complexity of an Audience, some compute times take longer than others.
+
+As a result, **Segment recommends waiting at least 24 hours for an Audience to finish computing** before you resume working with the Audience.
+
 ## Real-time compute compared to batch
 
 Real-time Compute allows you to update traits and Audiences as Segment receives new events. Real-time Compute unlocks exciting use cases:
diff --git a/src/personas/computed-traits.md b/src/personas/computed-traits.md
@@ -4,7 +4,9 @@ title: Personas Computed Traits
 
 
 
-Computed Traits allow you to quickly create user or account-level calculations that Segment keeps up-to-date over time. These can be computations like the `total_num_orders` a customer has completed, the `lifetime_revenue` of a customer, the `most_frequent_user` to determine which user is most active in an account, or the `unique_visitors_count` to assess how many visitors from a single domain. These computations are based on your events and event properties that you are sending through Segment on the [page](/docs/connections/spec/page/) and [track](/docs/connections/spec/track) calls.
+Computed Traits allow you to quickly create user or account-level calculations that Segment keeps up-to-date over time.
+
+These can be computations like the `total_num_orders` a customer has completed, the `lifetime_revenue` of a customer, the `most_frequent_user` to determine which user is most active in an account, or the `unique_visitors_count` to assess how many visitors from a single domain. These computations are based on your events and event properties that you send through Segment on the [Page](/docs/connections/spec/page/) and [Track](/docs/connections/spec/track) calls.
 
 ## Types of Computed Traits
 
@@ -156,14 +158,20 @@ Learn more about [Computed trait generated events here](/docs/personas/using-per
 
 For account-level computed traits, you have the option to send either a [group](/docs/connections/spec/group/) call and/or [identify](/docs/connections/spec/identify/) call. Group calls will send one event per account, whereas identify calls will send an identify call for each user in the account. This means that even if a user hasn't performed an event, Segment will still set the account-level computed trait on that user. Because most marketing tools are still based at the user level, it is often important to map this account-level trait onto each user within an account. See [Account-level Audiences](/docs/personas/audiences/account-audiences) for more information.
 
-## Editing Realtime Traits
+## Understanding compute times
+
+Because a number of factors (like system load, backfills, or user bases) determine the complexity of a Computed Trait, some compute times take longer than others.
+
+As a result, **Segment recommends waiting at least 24 hours for a Trait to finish computing** before you resume working with the Trait.
+
+## Editing Real-time Traits
 
-Personas supports the editing of realtime Traits, which allows you to make nuanced changes to existing Traits in situations where cloning or building from scratch may not suit your use case.
+Personas supports the editing of real-time Traits, which allows you to make nuanced changes to existing Traits in situations where cloning or building from scratch may not suit your use case.
 
-To edit a realtime Trait, follow these steps:
+To edit a real-time Trait, follow these steps:
 
 1. In your Personas Space, select the **Computed Traits** tab.
-2. Select the realtime Trait you want to edit.
+2. Select the real-time Trait you want to edit.
 3. Select the **Builder** tab and make your edits.
 4. Select **Save Computed Trait** to confirm your edits.
 
