Journey Orchestrator Module Objects
Some of the most important MDA objects used in the Journey Orchestrator module are described here. For more information on other SFDC and MDA Objects used in different modules, refer to Gainsight Object Glossary.
Note: The Gainsight feature 'Advanced Outreaches' or 'AO' is renamed to 'Programs' in the application but the application object and field names for Advanced Outreaches feature will have the term 'Advanced Outreaches' (Ex: 'AO Emails' is an object name but is not renamed to Program Emails).
Email Logs Object
Email Log contains an aggregated entry for a single recipient email. There will be only one entry in the Email Log for a recipient email irrespective of the number of events that occur for that email.
This object is used in Journey Orchestrator, Advanced Outreaches (Programs), Email Assist. For example; Rules/Reports based on success of email campaigns, number of Email Assist tasks sent, types of error messages being returned by systems, etc.
The following table lists the data fields available in this object:
Field Name | Description |
---|---|
Associated Field | Field from the associated object. |
Associated Object | Object name to which an email log is associated. |
Associated Value | The value stored in associated field from associated object. |
Batch Name | The name of the Batch. |
Contact Name or User Name | Recipient of the email - if sent internally, User Name is populated, if sent externally, Contact Name is populated. |
Event Message | An error message returned by the receiving email system. |
Opened | Binary value, 1 = the email was opened, 0 = the email was not opened. |
Open Count | Number of times the email was opened. |
Template Name | The name of the template. |
Triggered Date | Date/time at which the email was scheduled to go out. |
Triggered On | Actual date/time that the email was sent. |
Use Case |
The options are:
|
Variant Name | The name of the variant used (Default = no variant or default variant triggered). |
Email Logs V2
Email Log V2 object contains an aggregated entry for a single recipient email as well as for analytics information. This object is used in Journey Orchestrator Programs and Email Assist. The following table lists the data fields available in this object:
The name of the email template version.
Fields | Description |
Address Type | This field stores the type of influencer, either within your Organization (any Company Person) or within the Company (any Gainsight User). |
Bounce Type | The type of an automated message from an email system, either Hard or Soft bounce. |
Bounced | A bounced email is an automated message from an email system, informing the sender of a previous message that the message has not been delivered. |
Bounced Date | The date on which the email was bounced. |
Bounced Reason | The actual reason why the email has bounced. |
Category Ids | IDs of an opt-out page category. |
Company Id | Unique GSID of the Company. |
Company Person Id | A unique Id from the Company Person object, details of a participant associated with a Company. |
Created Date | The date on which the email logs are created. |
Email Content Id | A unique identifier of the email. |
Email Id | Email address of the participants. |
Email Id in Lower Case | Indicates whether the email address of a sender is in lower case. |
Email Template Id | A unique identifier of the email template. |
Email Template Name | The name of the email template. |
Email Template Version Id | A unique identifier of the email template version. |
Email Template Version Name | |
External Company Id | The external Id of a company. |
External Company Person Id | A unique Id of a person from the external company. |
External Relationship Id | A unique relationship identifier in an external system. It identifies a relationship uniquely apart from Email and Name. |
External Relationship Person Id | A unique relationship identifier in a person in an external system. |
External Relationship Type Id | An external GSID field in the Relationship Type object. |
External User Id | The unique identifier of the external user. |
First Opened Date | The date on which the email was first opened. |
From Email Id | An email id of a sender. |
From Name | The name of a sender. |
GSID | A unique GSID. |
Latest Open Date | The date on which the email was last opened. |
Link Click Date | The date on which the link was last opened. |
Link Clicked Count | The total number of clicks used to open the link. |
Link Clicked JSON | The linked clicked date in JSON format. |
Modified Date | The date on which the email was last modified. |
Name | The name of the email recipient. |
Number of Opens | The total number of opens recorded for the email. |
Opened | Indicates whether the email was opened or not. |
Page Id | A unique Id of the page. |
Parent Recipient Id | The unique Identifier of the parent user. |
Person Id | A unique Id from a Person object. |
Person Type | This field helps to join the AO Participants object with either Person object or Person Avatar (User, etc) object. |
Recipient Id | A unique Id of a person who received the email. |
Record External Id | A unique company identifier record in an external system. It identifies a company uniquely apart from Email and Name. |
Record External Name | The name of the external record. |
Record Id | A unique Id of the record. |
Rejected | A flag that indicates whether an email is rejected due to an incorrect recipient address. |
Rejected Date | The date on which an email is rejected by a participant. |
Relationship Id | GS Relationship Id from Gainsight. |
Relationship Person Id | A unique identifier of the Relationship person. |
Relationship Type Id | A unique Relationship Type Id of a participant. |
Reply-to Email Id | A unique email Id of a reply-to email address. |
Reply-to Name | The name of the person to whom the email was replied. |
Request Id | The unique identifier helps to probe the Sumologic logs to figure out what has happened as a part of that request. |
Sent | Indicates whether the email is sent. |
Sent Date | The date on which the email was sent. |
Source | The source from which the CS task is created. Manual = created by a user, Activity = created from a timeline entry, from Rules, Survey, etc. |
Source Id | This field helps to join the AO Participants object with a specific record in the MDA standard object. This helps to build reports on the AO Participants object and join the selected fields from the MDA standard object. |
Source Name | Name of the participant source. |
Spam | Indicates whether the email was spammed. |
Spam Marked Date | The date on which the email was marked as spammed. |
Triggered Date | The date on which the email was last triggered. |
Unsubscribed | A flag that indicates whether an email address is unsubscribed from outreaches/programs. |
Unsubscribed Date | Date and Time on which an email address is unsubscribed from a program. |
User Id | A unique Id that helps to fetch user information (User Name, Email, Company Name, etc.) from the Gainsight object User. |
GS Asset Usage Tracking
GS Asset Usage Tracking object contains information around reports and dashboards usage. When a dashboard or report is visited by a user or is created, we create a row in this object with information on who is accessing what asset. This object only has usage of Horizon Analytics. The following table lists the data fields available in this object:
Field Name | Description |
API Version | Internal version of assets. |
Asset Id | This differentiates between assets with the same name created by cloning etc. |
Asset Name | The name of the asset. |
Asset Type | The type of asset. |
Event Count | This is the rolling aggregate of times you have accessed a particular asset in a particular manner (see below). |
Event Type | How an asset is being accessed. We have basic Create, Run, Update, and Delete along with clone and share. |
Last Used Timestamp | The date and time on which the asset was last used. |
Request Source | This informs users about how the asset was accessed during a session. |
Source Type | The type of source that is based on field values. |
User Id | A unique Id that helps to fetch user information (User Name, Email, Company Name, etc.) from the Gainsight object User. |
Advanced Outreach (Programs) Object
This object is used to store important information about Programs. For example; create reports on important parameters of Programs.
The following table lists the data fields available in this object:
Field Name | Description |
---|---|
Advanced Outreach Id | An unique Program Id. |
Advanced Outreach Code | A code used for unique identification of Programs in Reporting. |
Advanced Outreach Model Name | Model name of a Program (NPS® Survey/CSAT Survey/Generic Survey/Email Chain). |
Advanced Outreach Model Type | Transactional (CSAT)/Non-Transactional (NPS®, Generic, Email Chain, etc.) |
Advanced Outreach Name | An unique name of a Program. |
Advanced Outreach Start Date | Published date of a Program. |
Advanced Outreach Status | Draft (NEW in Reports)/Active (PROCESSING in Reports)/Pause/Scheduled/Stop. |
Advanced Outreach Type | Customer/Relationship |
Default Account Name | Optional. The Account name which is a record in SFDC Account object but is not a Gainsight customer. |
Log Emails To Salesforce | Flag that indicates whether emails sent as part of programs are stored in SFDC. |
Relationship Type Id | Relationship Type Id associated with a program. This field helps fetch information of a Relationship type from the MDA object Relationship Type. |
Relationship Type Name | The name of the Relationship Type associated with a program. |
Survey Closed Date | Closed date of the Survey attached to the Program. |
Survey Name | The name of the Survey sent through Programs. |
Advanced Outreach Participants (Program Participants) Object
This object is used to store information about the Participants in Programs. For example; to retrieve information about the participants in a Program through Report Builder.
The following table lists the data fields available in this object:
Field Name | Description |
---|---|
Account Name | Name of an account that a participant is associated with. |
Advanced Outreach Id | A Unique Program Id. |
First Name | First name of a Participant. |
Last Name | Last name of a Participant. |
Full Name | Full name of a Participant. |
Context Id | A unique ID that can be configured to tie a participant's response back to a specific activity/service offered. For example, the Context ID could be a support ticket number or a webinar code. |
Last Email Link Clicked | The last instance of a clicked link displayed in email. |
Last Email Sent | (DateTime) The last instance of an email sent from a program. |
Last Email Status | Delivered/Not Delivered to the Participant. |
Manager First Name | First name of participant’s manager. |
Manager Last Name | Last name of participant’s manager. |
Manager Full Name | Full name of participant’s manager. |
Manager Email Address | Email address of a participant’s manager. |
Participant State | Indicates the state of a Participant in the journey of a Program: Review/Active/Completed/Drop (by system due to token mismatch, incorrect email address, etc.)/Knocked-off (Manual removal of participants from a Program). |
Participant Id | Unique Id of a participant. |
Recipient Email Address | Email address of a Participant. |
Relationship Contact Name | Name of the Relationship Contact. |
Relationship Name | Name of a Relationship. |
Relationship Status | Status of a Relationship. |
Relationship Type Name | Name of the Relationship type. |
Sender First Name | First name of the organizer/Administrator who sends a Program. |
Sender Last Name | Last name of the organizer/Administrator. |
Sender Full Name | Full name of the organizer/Administrator. |
Sender Email Address | Email address of the organizer/Administrator. |
SFDC Account Id | SFDC Account Id for which a participant is associated with. |
SFDC Contact Id | SFDC contact Id of a participant. |
SFDC User Id | SFDC user Id of a participant. |
Survey Page Open Count | The survey page count open of the participant. |
Survey Page Opened | Flag that indicates whether a specific survey page is opened by the participant. |
Survey Responded | Flag that indicates whether a specific survey is responded to by the participant. |
Survey Responded Date | The date on which a specific survey is responded to by the participant. |
Survey Response Status | Submit/Partial Submit (Responded to a survey but not submitted) of a survey by the participant. |
Survey Score | NPS® score (0-10) of a survey submitted by the participant. |
Survey Send Date | The date on which a survey is sent by Program to the participant. |
Total Email Sent | Total number of emails sent to a participant during a Program journey. |
Person Type (Who ID) | This field helps to join the AO Participants object with either Person object or Person Avatar (User, etc) object. This helps to build reports on the AO Participant object and join the selected fields from the Person or Person Avatar object. |
GS Person Id (Who ID) | This field helps to join with a specific record in either Person object or Person Avatar (User, etc) object. This helps to build reports on the AO Participant object and join the selected fields from the Person or Person Avatar object. |
Source Type (What ID) | This field helps to join the AO Participants object with the MDA standard object. This helps to build reports on the AO Participants object and join selected fields from the MDA standard object. |
GS Source Id (What ID) | This field helps to join the AO Participants object with a specific record in the MDA standard object. This helps to build reports on the AO Participants object and join the selected fields from the MDA standard object. |
AO Emails (Program Emails) Object
This object is used to store information about emails in Programs. For example; to create a report on the information about emails sent by Programs.
The following table lists the data fields available in this object:
Field Name | Description |
---|---|
Advanced Outreach Id | A Unique Program Id. |
Bounce Date | The date on which a specific email is bounced. |
Bounce Type | Hard/Soft. For more information on these bounce types, refer Journey Orchestrator Analytics. |
Email Clicked | Flag that indicates whether a specific email is clicked by the participant. |
Email Clicked Date | Date on which a specific email is clicked by the participant. |
Email Id | Email address of the participants. |
Email Open Count | The total number of instances a specific email is opened by the original recipient. |
Email Opened | Flag that indicates whether a specific email is opened. |
Email Send | Flag that indicates whether a specific email is sent to the participants in a Program or not. If the flag is True then the email is sent successfully to the participant and vice versa. |
Email Template Id | Id of the email template. |
Email Template Name | Name of the template. |
From Address | Sender’s email address. |
Last Email Opened Date | (DateTime) The last instance of an email opened by a participant. |
Link Clicked Count | The number of instances that a link shared by an email is clicked by the participants. |
Page Open Count | The number of instances that a Survey Page is opened by the participants. |
Participant Id | Unique Id of a participant. |
Rejected | Flag that indicates whether an email is rejected due to incorrect recipient address. |
Rejected Date | The date on which an email is rejected by a participant. |
Spam | Flag that indicates whether an email is marked as spam by a participant. |
Spam Date | The date on which a participant is marked an email as spam. |
To Address | Recipient (Participant) email address. |
Undelivered | Flag that indicates whether an email is not delivered to the participants in a Program. |
Undelivered Reason | Email delivery failure reason. |
Unsubscribed | Flag that indicates whether an email address is unsubscribed from outreaches/programs. |
Unsubscribed Date | (DateTime) Date & Time on which an email address is unsubscribed from a program. |
AO Link Clicked Analytics (Program Analytics) Object
This object is used in Analytics on Programs. For example; to retrieve the analytics on URLs clicked in the Programs through Report Builder.
The following table lists the data fields available in this object:
Field Name | Description |
---|---|
Advance Outreach Id | A Unique Program Id. |
Linkclickedcount | The number of times an individual Link is clicked attached in an email. |
Url | The URL for which the clicked count is tracked. |
AO Participant Activity Analytics (Program Analytics) Object
This object is used in Analytics on Programs. For example; to retrieve analytics on Program Participant Activities through Report Builder.
The following table lists the data fields available in this object:
Field Name | Description |
---|---|
Advance Outreach Id | A Unique Program Id. |
Current Step Name | where the participant is in the journey of a Program. |
Distinct Count of Participants | The total number of participants who executed a specific step. |
AO Analytics (Program Analytics) Object
This object is used in Analytics on Programs. For example; to retrieve analytics on Programs through Report Builder.
The following table lists the data fields available in this object:
Field Name | Description |
---|---|
Advanced Outreach Id | A Unique Program Id. |
Advanced Outreach Name | Name of a Program. |
Open Rate | Ratio of emails opened by the participants to the emails sent in the journey of a program. |
Survey Clicked Through Rate | Ratio of the number of survey links clicked to the number of Survey links sent through a program. |
Survey Conversion Rate | Ratio of the number of Surveys submitted to the number of Surveys Opened. |
Total Active Participants | The total number of participants that are active in a specific Program. |
Total Email Bounced | In a specific Program. |
Total Email Opened | In a specific Program. |
Total Email Send | Emails sent as part of a specific Program. |
Total Number of Participants | In a specific Program. |
Total Participant Responded To Survey | The total number of participants who submitted the Survey in a Program. |
Total Participants Opened Survey Page | The total number of participants who opened the survey page in a Program. |
AO Participant Activity (Program Participant Activity) Object
This object is used to store activities of the Participants in the Programs. For example; to create reports on tracking the journey of participants.
The following table lists the data fields available in this object:
Field Name | Description |
---|---|
Advanced Outreach Id | A unique Program Id. |
Current Step Name | Current step of the participant in the journey of a Program. |
Participant Id | Unique Id of a participant. |
Previous Step Name | With respect to the current step of the participant in the journey of a Program. |
AO Participant Source Configuration (Program Participant Source Configuration) Object
This object is used to store information about the source of participants in a Program. For example; to fetch the Program participant list based on its source of ingestion in the Reports.
The following table lists the data fields available in this object:
Field Name | Description |
---|---|
Advanced Outreach Id | A unique Program Id. |
Event Name | Name of the Event used to collect the participants. |
Participant Operation Type | One-time (Add All Participant in Power list in Reports)/Scheduled (Add All Participant in Power list and any in Future in Reports). Indicates whether all the Participants are added into Powerlist now or it’s scheduled. |
Participant Source Name | Name of the Power List. |
Participant Source Type | CSV/Power List/Query Builder/Event. |
AO Predefined Advanced Outreach Model (Program Model) Object
This object is used to store Model information of a Program. For example; to create model information in the Reports.
The following table lists the data fields available in this object:
Field Name | Description |
---|---|
Advanced Outreach Model Name | Model Name of a Program (NPS® Survey/CSAT Survey/Generic Survey/Email Chain). |
Advanced Outreach Model Type | Transactional (CSAT)/Non-Transactional (NPS®, Generic, etc). |
AO CTA (Program CTA) Object
This object is used in Journey Orchestrator module. For example; stores information about CTAs Triggering from Programs.
The following table lists the data fields available in this object:
Field Name | Description |
---|---|
Account | Account Name. It fetches Account details through lookup from Account. |
Action Type | Upsert (Create) or Close CTA. |
Area Name | The product in which a CTA is triggered, either CTA in Salesforce Edition or CTA in Standard Edition. |
CTA Id | Unique GSID of a CTA created or closed. |
CTA Name | Name of the CTA created or closed. |
CTA Status | Status of a CTA. |
Entity Type | Account (Company) or Relationship. |
Is Name Identifier | True/False. While creating CTA, when you click ‘include in identifiers’ checkbox to trigger a CTA with unique identifier, CTA is recorded as True in this field. |
Relationship Id | GS Relationship Id from SFDC for Relationship CTAs in Salesforce Edition. Relationship Id from MDA for Relationship CTAs in Standard Edition. |
Source Step Id | A unique GSID from AO Participant Activity object to fetch details of a step from which a CTA is triggered from a Program. |
AO CTA Mapping (Program CTA Mapping) Object
This object is used in Journey Orchestrator module. For example; stores information about CTAs triggered against the respective source Programs.
The following table lists the data fields available in this object:
Field Name | Description |
---|---|
GS Advanced Outreach Id | A unique GSID from AO Advance Outreach object to fetch details of a JO Program. |
GS CTA Id | Unique GSID of a AO CTA record that fetches details of this record. |
GS Participant Id | A unique GSID from AO Participant object to fetch details of a Participant. |
Step Id | A unique GSID from AO Participant Activity object to fetch details of a step from which a CTA is triggered from a Program. |
NPS, Net Promoter, and Net Promoter Score are registered trademarks of Satmetrix Systems, Inc., Bain & Company and Fred Reichheld |