Object Reference for Salesforce and Force.com

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

PartnerNetworkRecordConnection

Represents a record shared between Salesforce organizations using Salesforce to Salesforce.

Supported Calls

create(), delete(), query(), retrieve()

Fields

Field Details
ConnectionId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
Required. ID of the connection a record is shared with.
EndDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Date that sharing of the record was stopped.
LocalRecordId
Type
reference
Properties
Create, Filter, Group, Sort
Description
Required. ID of the shared record.
ParentRecordId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
ID of the parent record of the shared record.
PartnerRecordId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the shared record in the connection's organization.
RelatedRecords
Type
string
Properties
Create, Filter, Nillable, Sort
Description
A comma-separated list of API names for child records to be shared with a parent record.
SendClosedTasks
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort
Description
Forwards closed tasks related to the shared record.
SendEmails
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort
Description
Sends an email notifying the connection's representative that you have forwarded the record to them. Only new recipients of a record will receive a notification email.
SendOpenTasks
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort
Description
Forwards open tasks related to the shared record.
StartDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Date that the shared record was accepted.
Status
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The status of the shared record. One of the following values:
  • Active (received)
  • Active (sent)
  • Connected
  • Inactive
  • Inactive (converted)
  • Inactive (deleted)
  • Pending (sent)

Usage

When you create a PartnerNetworkRecordConnection, you forward a record to a connection.

Attempting to forward a record from an object to which the connection is not subscribed results in an Invalid Partner Network Status error.

Don’t forward a record to the connection that originally shared it. Doing so causes errors when Apex triggers run.

Note

When you delete a PartnerNetworkRecordConnection, you stop sharing a record with a connection.
  • To share a record, use the following fields: LocalRecordID and ConnectionId
  • To share a child of a parent record, use the following fields: LocalRecordID, ConnectionId, and ParentRecordID
  • To share a child of a parent record and its child records, use the following fields: LocalRecordID, ConnectionId, ParentRecordID, and RelatedRecords

If the organization does not have Salesforce to Salesforce enabled, the PartnerNetworkRecordConnection object is not available, and you can’t access it using the API.

Sample Code—Apex

The following example shows how to forward a record.

1List<PartnerNetworkConnection)> connMap = new List<PartnerNetworkConnection>(
2    [select Id, ConnectionStatus, ConnectionName from PartnerNetworkConnection
3        where ConnectionStatus = 'Accepted']
4);
5for(PartnerNetworkConnection network : connMap) {    
6     PartnerNetworkRecordConnection newrecord = new PartnerNetworkRecordConnection();
7
8    newrecord.ConnectionId = network.Id;
9    newrecord.LocalRecordId = accountId;  
10    newrecord.RelatedRecords = 'Contact,Opportunity,Orders__c';
11    newrecord.SendClosedTasks = true;
12    newrecord.SendOpenTasks = true;
13    newrecord.SendEmails = true;   
14
15    insert newrecord;   
16}

The following example shows how to stop sharing a record.

1List<PartnerNetworkRecordConnection> recordConns = new List<PartnerNetworkRecordConnection>(
2    [select Id, Status, ConnectionId, LocalRecordId from PartnerNetworkRecordConnection
3        where LocalRecordId in :accounts]
4);
5
6   for(PartnerNetworkRecordConnection recordConn : recordConns) {
7        if(recordConn.Status.equalsignorecase('Sent')){ //account is connected - outbound
8            delete nets;
9        } 
10   }