Call Reports Deep Linking

Client Center supports launching call reports with different layouts and pre-populated data through URL so that you can deeplink into Tier1 from other applications or from Salesforce. This article covers the expected URL format and the supporting parameters.

Please note that there is a maximum URL length limit applicable in browsers.
It’s essential to avoid using special or reserved characters in parameter values to prevent parsing errors.

URL FORMAT

The general URL format for launching Call Reports is as follows:

<Namespace Org Domain>/apex/T1C_Base__ACEActivityReport?layoutPath=<layoutPath>&<parameter1=parmeter1Value>&<parameter2=parmeter2Value>

Example to launch a new Call Report with a specific layout:

<Namespace Org Domain>/apex/T1C_Base__ACEActivityReport?layoutPath=ACE.ActivityReport.Layouts.CallReport

Example to launch an existing Call Report with a specific layout:

<Namespace Org Domain>/apex/T1C_Base__ACEActivityReport?layoutPath=ACE.ActivityReport.Layouts.CallReport&callReportId=a0m79000001SuyQ

URL PARAMETERS

layoutPath (string)

• The AFR path which contains the layout of the call report.

• Sample value: layoutPath=ACE.ActivityReport.Layouts.CallReport

entityIds (string)

• Pre-populated list of contact Id(s) or account Id(s) for new call reports. Use comma delimited list of Ids when multiple Ids are passed in. Only one type of Ids are accepted, either all contact Ids or all account Ids.

• Sample value: entityIds=003R000001AMYBY,003R000000nJXlF

topicIds (string)

• Pre-populated list of topic Id(s), also referred as interest subject Id for new call reports. Use comma delimited list of Ids when multiple Ids are passed in.

• Sample value: topicIds=a1SR0000001pY2mMAE,a1SR0000001rfRhMAI

attendeeIds (string)

• Pre-populated list of employee Id(s) as internal attendees for new call reports. Use comma delimited list of Ids when multiple Ids are passed in.

• Sample value: attendeeIds=a0Q30000000AdDY,a0Q30000000AdE1

accountId (string)

• Pre-populated client field on new call reports (T1C_Base__Client__c on call report object). This applies to contact type call report only.

• Sample value: accountId=0013000000JY7K6

relatedToType (string)

• The related to object type

• Related to field must be enabled on the call report and when relatedToType parameter and value is passed in, the relatedToId parameter and value must also be specified in the URL.

• The corresponding related to object configured must match the Data attribute defined under the AFR feature ACE.ActivityReport.DefaultSettings.RelatedObjects.<ObjectType>

• Sample value: relatedToType=Opportunity__c&relatedToId=0064u00001GL2QV

relatedToId (string)

• The related to object record Id

• Related to field must be enabled on the call report and when relatedToId is passed in as a parameter, the relatedToType parameter and value must also be specified in the URL.

• The corresponding related to object configured must match and defined under the AFR feature: ACE.ActivityReport.DefaultSettings.RelatedObjects.<ObjectType>

• Sample value: relatedToType=Opportunity__c&relatedToId=0064u00001GL2QV

callReportId (string)

• The call report Id to retrieve. When using this parameter, other URL parameters are not supported except for layoutPath and viewOnly.

• Sample value: callReportId=a0m79000001SuyQ

viewOnly (string)

• When retrieving an existing call report, appending this parameter viewOnly=true in the URL enables the read only mode.

• In read only mode, the save buttons of the call report are disabled. Users can interact with the form, but cannot save the changes.

accountMode (string)

• Supported in version 2022.3 and later

• When launching a new call report without specifying the entityIds parameter and value, call report defaults to contact mode. Contact mode assumes the external attendees of the call report are contacts.

• By appending this parameter as: accountMode=true without specifying the entityIds parameter enables call report to account mode. Account mode assumes the external attendees of the call report are accounts.

defaultDataSet (string)

• This is an optional parameter to provide static initial values to the state. The value is referenced through an AFR attribute setup under feature ACE.ActivityReport.DefaultSettings.DefaultDataSet, attribute DataSetName

• The AFR attribute should contain a valid JSON formatted string which defines the required state property value pair. This parameter has not been associated to any officially released function. The character limitation applies here.

RESERVED PARAMETERS

Besides the parameters listed in this article, the following URL parameters are reserved for other types of integrations. Avoid using these parameters when trying to applying customization:

• relatedAceListId

• readOnly

• transactionId

• telephonyMode

• childApplicationId

• cacheId

• isCloned