xConnect Collection Search service

Abstract

Overview of Sitecore xConnect Collection Search supported infrastructure, references, scaling, and privacy and security.

The xConnect Collection Search service allows you to search contacts and interactions using the xConnect Client API or another API that consumes the oData service. This role can also collect data.

Supported infrastructure

You can host the xConnect Collection Search service on:

Refer to the Sitecore compatibility table for compatible versions.

Reference structure

The xConnect Collection Search service has its place in the Sitecore reference structure. It can be referenced by other roles, and it can also reference other roles.

Illustration showing the xConnect Collection Search service's place in the Sitecore reference structure.

Referenced by

The xConnect Collection Search service is referenced by the following roles:

References

The xConnect Collection Search service role references the following roles:

Storage roles

Role name

Connection string name

Port

Type

Notes

xDB Collection database

collection

1433

SQL

The port number depends on your SQL Server configuration.

Marketing Automation database

xdb.marketingautomation

1433

SQL

The port number depends on your SQL Server configuration.

xDB Processing Pools database

xdb.processing.pools

1433

SQL

The port number depends on your SQL Server configuration.

Message Bus

messaging

1433

SQL

The port number depends on your SQL Server configuration. If you install Sitecore using SIF, SQL is the default provider.

Search indexes

The xConnect Search provider determines how the xConnect Collection Search service connects to the xDB index.

Index

Port, Solr

Port, Azure Search

Type

Notes

xDB index

8983

443

HTTPS

Defined by the SolrCore or collection.search (Azure) connection strings in the indexer’s App_Config\ConnectionStrings.config file.

For more information, see:

  • Configure Azure provider

  • Configure Solr provider

Privacy and security

The xConnect Collection Search service handles personal data in the following ways:

  • Reads and writes contact and interaction data from and to the xDB Collection database (this role is capable of collection as well as search).

  • Sends and receives contact and interaction data over the network to authorized clients such as Content Management.

  • Reads contact and interaction IDs from the xDB index, and uses IDs to retrieve additional search result data from the xDB Collection database. If indexing of personal data has been disabled, data is still returned with search results from the xDB Collection database.

Note

Any client application with access to xConnect has access to personal data, even if the application does not access or use personal data.

Assumptions

  • All personal data written to and returned from the xConnect Collection service has valid and active data subject consent.

  • If required, client applications reading or writing data have explicit consent to do so.