Platform administration and architecture

xConnect Collection Search service

Abstract

Introduction to Sitecore xConnect Collection Search references, scaling and privacy and security.

The xConnect Collection Search service role 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

The xConnect Collection Search service role can be hosted on:

Refer to the Sitecore compatibility table for compatible versions.

References

The xConnect Collection Search service role references the following application roles, storage roles, and indexes.

xconnect-search.png

Storage roles

Role name

Connection string name

Port

Type

Notes

xDB Collection database

collection

443

SQL

Marketing Automation database

xdb.marketingautomation

443

SQL

xDB Processing Pools database

xdb.processing.pools

443

SQL

Message Bus

messaging

443

SQL

If you install Sitecore using SIF, SQL is the default provider.

Search indexes

The xConnect Search provider determines how the xConnect Search service role 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

Referenced by

The role is referenced by:

Scaling

Supported combinations

The xConnect Collection Search role can be combined with any other Experience Platform Service role. Common combinations include:

Note

In a developer environment, all XP service roles can be combined into a single instance. This setup is not recommended in production.

Privacy and security

The xConnect Collection Search service role 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 role has valid and active data subject consent.

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