Subscription Fields

Here is a description of the fields that make up a subscription.

Tip:

We recommend that you manage relationships and mappings from the Message Type page. For details of the fields and actions available, see Messaging Relationship Fields.

Key: * – Mandatory field. The number indicates the number of characters that are allowed in this text field, where appropriate.

Subscription

Subscription Fields
Field     Description
Description     Description of the subscription.
Documentation URL   255 An optional link to detailed documentation about the subscription.
Enabled     Indicates whether the subscription is enabled.
Identifier     The subscription identifier derived from the target object name.
Message Type *   Lookup to the message type to which this subscription relates.
Obsolete    

Indicates whether the subscription is no longer in use. If selected, the subscription does not appear on the Foundations Setup tab. You cannot enable an Obsolete subscription.
Proxy *   Lookup to the product proxy.
Subscriber *   The name of the registered product to which this subscription relates. This is automatically populated with the registered product from which the subscription was created.
Subscription Name * 80 Unique name of the subscription.

Routing Details

Routing Details Fields
Field     Description
Delivery Sequence Number     Foundations attempts to deliver messages in ascending order of this field.
Deliver Using Background Process     Determines whether messages are delivered using a background process when the sender specifies that they are to be delivered now rather than later. If messages are scheduled for delivery later, the messages are delivered using a background process and this setting has no effect. When Capacity is selected, messages are delivered using a background process if the number of messages to be delivered exceeds the value set in the Synchronous Delivery Capacity field. This can be set to Never, Always or Capacity. The default value is Never.
Synchronous Delivery Capacity     Determines the maximum number of messages that can be delivered without using a background process when Deliver Using Background Process is set to Capacity.
Exclude Own Messages     Indicates whether a product which publishes and subscribes to a message type is notified about the messages that it publishes.
Handler Class * 128 The class that determines how messages are handled.
Capacity     When running a scheduled message delivery job, determines the number of messages the subscription can process simultaneously.

Implementation Details

Implementation Details Fields
Field     Description
Exclude Own Messages     Indicates whether a product which publishes and subscribes to a message type is notified about the messages that it publishes.
Handler Class * 128 The class that determines how messages are handled.
Capacity     When running a scheduled message delivery job, determines the number of messages the subscription can process simultaneously.
Return Data Developer Name    

Custom identifier used when enabling return data. Return data fields are identified by their API names, which include this developer name. We recommend that you do not update the developer name after enabling return data.

For more information about return data, see Enabling Return Data.
Return Data For     For return data subscriptions only. Automatically populated lookup to the publication that this return data subscription relates to. Do not update this field manually.

Description Section

The Description section enables you to set the target object for the subscription and manage its mappings.

Description Section Fields
Field     Description
Target Object     The target that the source object is to be mapped to.
Correlation Field     A field that matches a message received by the subscription with the target object.

Additional Fields

The following fields are not displayed on the page layout, but are used when managing a relationship from the message type.

Additional Fields
Field     Description
Subscription Type    

The subscription process type, either: 

  • Standard for subscriptions that use a dingle field to identify a target record.
  • Multiple Identifier References on Target for subscriptions that use many fields to identify a target record.
Child Record Count Field Maximum     The field on the target object that contains the number of child records associated with a target record.
Child Records on Target     The maximum number of child records each target record can store before a new target record is created.

Filters

The Filters section enables you to add filters to your subscriptions so that they only receive information when the criteria you enter is met.

Buttons

Subscription Buttons
Button Description
Folder icon used to represent a relationship node. A relationship mapping included in the subscription. This can contain one or more mappings as part of a tree.
document icon used to represent a field or static node in the publication. A field mapping or static mapping included in the subscription. If the mapping contains static information, its label is shown in Italic in the Key column. If the mapping is shown in gray, this indicates that it is overridden by another mapping on the subscription.
Tick icon used to indicate that the node is managed. Indicates that the mapping is managed and you cannot edit or delete it.
Full Clone Enables you to create a deep clone of the subscription including its mappings and return data publications.
Add node icon. White plus symbol inside green circle Add Enables you to add a mapping to the subscription.
plus symbol within circle Add Enables you to add mappings to the subscription.
Delete Node icon. Gray cross. Delete Enables you to remove the mapping from the subscription.
Edit Node Icon. Grey crayon Edit Enables you to edit the mapping in the subscription.
Export Subscription Displays the Export Publications and Subscriptions page, which enables you to export the subscription to a JSONClosed JavaScript Object Notation. A lightweight format based on a subset of JavaScript Programming Language, Standard ECMA-262 3rd Edition - December 1999. This is a text based format that is easy for both humans and computers to read and write. file for import to another Salesforce orgClosed Salesforce organization.
Eye icon with line through it. Icon that represents hiding the field properties. Hide Properties Hides the Mapping Properties popup if it is displayed.
Import Subscription Displays the Import Publications and Subscriptions page, which enables you to import a subscription in a JSON file.
Eye icon. Icon that represents showing the field properties. Show Properties Shows Mapping Properties popup that lists the properties of the selected mapping.