View source for 5.8:Sfdc-integration-guide/Tutorials/CustomizingSFDCActivityObjects

= How to Customize an Activity Object = 
Salesforce.com (SFDC) activity history is a list of associated tasks or the history of activities that have been carried out on an object. For example, the activity history section on a contact record may contain a list of actions that the sales rep has taken in working that lead, such as emails sent, calls made, and so forth. In addition to the predefined activity history objects, these fields can be extended with customized activities to track against objects. 

== Procedure == 
The following instructions will show you how to create a custom activity field in SFDC, update the field using Bright Pattern's Attached Data scenario block, and update regular fields using Attached Data.

These steps are applicable to both the Salesforce Classic view and the Salesforce Lightning view.

=== Step 1: Create custom fields for an object === 


==== In Salesforce Classic ==== 
# In Salesforce.com, click '''Setup'''.<br><br>
# In the ''Build'' section, click '''Customize > Activities'''. Make sure you click just the “Activities” link--don’t click the drop-down beneath “Activities”.<br><br>[[File:SFDC-Build-Activities-53.PNG|thumb|800px|center]]<br><br>
# On the ''Activities'' page, click '''Add a custom field to activities'''.<br><br>
# On the ''Activity Fields'' page, you can see all the custom fields you already have. Click '''New''' to add a new one.<br><br>[[File:SFDC-Activity-Fields-b-53.png|thumb|800px|center]]<br><br> 

==== In Salesforce Lightning ==== 
# Navigate to '''Setup'''.<br><br>
# Select the '''Object Manager''' tab at the top of the screen, then click the '''Activity''' label.<br><br>[[File:Create-Activity-Object-Lightning-2-54.PNG|450px|thumb|center]]<br><br>
# From ''Activity'', click '''Fields & Relationships''', and then select the '''New''' button.<br><br>[[File:Create-Activity-Object-Lightning-3-54.PNG|800px|thumb|center]]<br><br>
# Finally, begin configuring your ''New Custom Field''.<br><br>

==== New Custom Field Configuration: Classic and Lightning ==== 
# On the ''New Custom Field'' page, select the data type of the custom field and then click '''Next'''. For this example, we select data type '''Text'''.<br><br>[[File:SFDC-Data-Type-53.PNG|thumb|800px|center]]<br><br>
# On the ''New Custom Field'' page, specify: <br><br>
## '''Field Label''' - The label for the field (e.g., “Priority”)<br><br>
## '''Length''' - The number of allowable characters (e.g., “20”)<br><br>
## '''Field Name''' - The name of the field in lowercase with underscores to separate words (e.g., “priority_status”; will be shown on the Activity fields page)<br><br> 
## '''The other settings are optional.<br><br>[[File:SFDC-Custom-Field-53.PNG|thumb|800px|center]]<br><br>
# Click '''Next''' and you will be asked to establish field-level security. This is optional. Click '''Next''' again.<br><br>
# You will be asked to add the custom field to page layouts. Select the layouts where you want the new custom field to appear. Later, you can go to ''Customize > Activities > Task Page Layouts'' to modify page layouts. Click '''Next''' again and '''Save'''.<br><br>[[File:SFDC-Add-Page-Layouts-53.PNG|thumb|800px|center]]<br><br>
# You will see that the custom field has been added to the ''Activity Custom Fields'' page. The '''API Name''' is the actual custom field name that you will put in the Attached Data scenario block (see steps below). Copy the '''API Name''' of your custom field.<br><br>[[File:SFDC-Activity-Custom-List-53.PNG|thumb|800px|center]]<br><br>

Now that you have a custom activity field, you are able to update that field using Bright Pattern Contact Center. Activity Field data may be updated via the [[scenario-builder-reference-guide/AttachedData|Attached Data]] block in a scenario.

=== Step 2: Update custom field data using Attached Data scenario block === 
Once you have a custom field in Salesforce, you can use the Attached Data block to update it.

# In the Contact Center Administrator application, locate your Salesforce scenario and click '''Edit''' to open it in the Scenario Builder application.<br /><br />
# For a voice scenario, add the Attached Data block at any point before the Connect Call block. For a chat scenario, add the Attached Data block at any point before the Connect Chat block. If you don’t know where to place it, put it at the very top of the scenario.<br /><br />[[File:SFDC-Attached-Data-add-53.PNG|thumb|800px|center]]<br /><br />
# Update properties and click '''add a data item''':<br /><br />
## '''Title text''' - The name of the block (e.g., “Update SFDC Activity”)<br /><br />
## '''Name''' - The “API Name” of your custom field that you created in Salesforce (e.g., "account_test__c"). Note that upon saving a new custom field, SFDC automatically adds suffix “__c” to it. In order to supply interaction data to this field, use the field name, including suffix “__c” in the [[scenario-builder-reference-guide/AttachedData|Attached Data]] scenario block. For example, to populate Custom Activity field '''account_test''', it is required to have the scenario block Attached Data specify key '''account_test__c'''.<br /><br />
## '''Value''' - The value (string or variable) of the field (e.g., “12345” or "$(varname.property)").<br /><br />[[File:Attached-Data-b-53.PNG|thumb|800px|center]]<br /><br />
# Note that multiple data items may be added. Save the scenario.<br /><br />
You can test whether it works by logging a call and viewing the case in Salesforce. You should see the custom field with the specified value.

=== Step 3: Update other activity field data using Attached Data (optional) === 
To populate regular (not custom) ''Activity Fields'' with any data from the scenario, simply follow step 2 instructions with one exception: use the field name without the “__c” suffix.

For example: "account_test", not "account_test__c".

=== Predefined Fields === 
The following is a list of predefined fields (''Label/Field Name = Parameter'') in SFDC:

* '''Due Date/ActivityDate''' - Interaction start time

* '''Call Object Identifier/CallObject''' - [[reporting-reference-guide/GlobalInteractionIdentifier|Global interaction identifier]]

* '''Call Type/CallType''' - Interaction type: ''Inbound'', ''Outbound'', or ''Internal''

* '''Call Duration/CallDurationInSeconds''' - Interaction duration (talk + hold time) in seconds

* '''Call Result/CallDisposition''' - Interaction [[contact-center-administrator-guide/DispositionsTab|disposition]], if available

* '''Comments/Description''' - Interaction [[agent-guide/HowtoEnterDispositionsandNotes|notes]] entered by the agent, if any

* '''Subject/Subject''' - [[contact-center-administrator-guide/ServicesandCampaignsOverview|Service]] associated with the interaction, in format: ''SFDC object type: service name''

* '''Status/Status''' - Status: ''Completed'', ''Delivery Pending'', ''Not Started'', etc.

* '''SPRecordingOrTranscriptURL__c''' (note that this is a custom field) - Interaction recording URL; clicking this URL will open the [[reporting-reference-guide/InteractionRecordsSearch|Interaction Records Search Results]] page of the Contact Center Administrator application with the record that has the recording/transcript of this interaction


=== Notes === 
Activity history is added to the last record that the agent had open on the Agent Desktop while finishing the call (or the related after-call work).