Messaging Relationship Fields

Here is a description of the fields and buttons that are displayed on a messaging relationship, including mappings.

The number indicates the number of characters that are allowed in this text field, where appropriate.

Note:

When viewing a return data messaging relationship from the Message Types tab, some details are not available. We recommend that you view return data information from the relationship it was enabled for.

This section contains information about the message type, as well as links to view publications, subscriptions, and messages relating to this message type.

For information about the message type fields and buttons, see Message Type Fields.

The following fields and columns are displayed in the Relationship and Mapping Details section of the message type.

Field Description
Publication The publication for the selected relationship.
Source Object The source object for the selected publication.
Subscription The subscription for the selected relationship.
Target Object The target object for the selected publication.
Key The identifier for the message data. This is unique in each level of the messaging hierarchy.
Source The data source.
Target The target for the data.
Target Child Type For child mappings only. The category for the child mapping.

The following buttons are available in the Relationship and Mapping Details section of the message type.

Button Description
Add Mapping Create a new mapping for the relationship.
Manage Relationship Update details of the current relationship, view a different relationship, or create new publications and subscriptions.

The following actions are available for rows in the table.

Button Description
Edit Edit the details of the mapping.
Reuse Key Use the key to send the source information to another target.
Delete Delete the mapping. If the key is used for other relationships on this message type, the key is still visible.
Add Child Mapping Create a new child mapping for this child relationship.

The following fields are available when you click Manage Relationship.

Key: N – Visible when creating new publications or subscriptions.

Field     Description
Publication     The details of the data source.
Publishing Product N   The registered product that publishes the source data.
Source Object     The object to publish data from.
Unique Identifier on Source    

The field on the source object that contains the record's unique identifier. We recommend that you use the record ID.

In some circumstances, for example, if you have not selected a publication, you can select an available message key from the Source Identifier Key field. This enables you to provide an identifier for the target mapping when the Unique Identifier on Source field is not present.
Publication Enabled     Indicates whether this publication is enabled to send messages.
Subscription     The details of the recipient of the data.
Subscribing Product N   The registered product that subscribes to the source data.
Target Object     The object to send data to.
Identifier Reference on Target     The field on the target object in which to store the source record's unique identifier. The unique identifier is compared when updating records.
Return Data    

The return data status, indicating whether to send back data to the source record:

  • Enabled
    Displayed when return data is active for the relationship.
  • Disabled
    Displayed when return data has not been enabled or has been disabled for the relationship.
  • Partially Enabled
    Displayed when a change to the relationship has been made that requires you to re-enable return data. See Updating Messaging Relationships.

  • Managed
    Displayed when return data is managed by the product that provides the messaging relationship.

You can enable return data on declarative relationships with a standard subscription type.

Subscription Enabled     Indicates whether this subscription is enabled to send messages.

The following fields are available when you click Manage Activation.

Key: D – Default activation method; F – Flow activation method; L – Lookup; CM – Child mapping; AL – Advanced lookup.

Field     Description
Activation Method    

The details of how you want to send Foundations messages for this relationship:

  • Default automated trigger created by Foundations for synchronous or asynchronous delivery
  • Salesforce process or flow that you have manually created
  • Custom code that you have manually implemented
  • Managed actions provided by the application that created the managed publication (available for managed publications only)
  • None indicates that no activation method has been specified yep, but does not deactivate the messaging relationship
Delivery Method D  

The intended method of delivery for activations that use the default automated trigger created by Foundations. You can select one of the following options:

  • Immediate
    Send messages as soon as source records are created or updated.
  • Scheduled Job
    Send messages for new and updated source records when the message delivery scheduled job runs.
    Tip: If specifying you want to send messages using a scheduled job, check the details of the scheduled job.
Delivery Filter    

[Optional] If specified, indicates that you want to conditionally deliver messages based on specific information on the source record. You can select any checkbox or formula field that exists on the source object to determine whether messages are sent for a particular record. For records to be sent, the value in the field must evaluate to true. For example, if you select a filter field that relates to an Active checkbox on the source record, the record details are only sent via messaging if the checkbox is selected.
Flow F  

[Optional] The name of the Salesforce flow or process that relates to this relationship. This information is for reference only and does not impact messaging activation. You must ensure that the relevant associated actions have been set up for messages to be sent. This information is stored on the Publication object in the Activation Method Data field.

The following fields are available when you click Add Mapping. Depending on your selections, different combinations of fields are visible.

Key: F – Field; CR – Child relationship; S – Static source; L – Lookup; CM – Child mapping; AL – Advanced lookup.

Field   Description
Message Key   The identifier for the mapping on the message type.
Source Type   The type of data being sent, such as a value from a field, a static value, or a child relationship.
Source Field Path F The field on the source object or a related object that contains the source data.
Source Description S The description of the fixed data to send in the message.
Source Data S The exact value to send in the message.
Source Lookup L The lookup field on the source object.
Source Child Relationship CR The related object that provides child source data.
Parent Field CM The parent field that contains the source data.
Target Type   The type of target, such as a field, child record, or a lookup that contains a non-unique name.
Target Field   The field in which to store the data from the source.
Target Child Relationship CR The related target object for which you want to create records.
Child Filter Key CR The message key that determines whether to create or update child records. If a key is specified, records are created or updated when the value in the message evaluates to true.
Child Filter Field CR The checkbox or formula field that determines whether to create or update child records. If specified, records are created or updated when the field equals true.
Record Creation Method CR

The way you want to create and maintain linked records:

  • Always Add
  • Always Replace
  • Update Matching
  • Update Matching and Delete
Target Lookup AL The field that stores the data from the advanced lookup.
Additional Source Identifier Field AL The additional source field to compare to identify a unique record. In some circumstances, for example, if you have not selected a publication, you can specify an additional source identifier key.
Data Transformation Table   The data transformation table to apply to the target field.
Additional Transformation Source Field   The additional source field for mappings that use a data transformation table that requires two source values. In some circumstances, for example, if you have not selected a publication, you can specify an additional transformation source key.
Target Child Type CM The category for the child mapping. Target child types enable you to create multiple target records from a single source record.
Condition Field   The source field that determines whether a mapping is conditionally applied to a target. If specified, the message value must evaluate to true for the mapping to be applied.
Tip:

If you want to add a mapping to a subscription when no publication is selected, you can do so and a new mapping will be created on the message type that contains a key and target. However, no data can be added to the specified target via messaging unless a publication and source are specified.

The following fields are available when you click Manage Relationship and select a relationship where return data is enabled.

Field     Description
Source Object     The object that publishes return data. This is the target object from the main relationship.
Target Object     The object that receives return data. This is the source object from the main relationship.