Skip to content

README.md

Latest commit

 

History

History
132 lines (100 loc) · 5.47 KB

README.md

File metadata and controls

132 lines (100 loc) · 5.47 KB

🌐 SearchSync Azure Function (HTTP Trigger) for Sitecore Search + OrderCloud

HTTP-triggered Azure Function for Demo & Proof-of-Concept Sync

⚠️ This Azure Function uses an HTTP trigger to sync product data from OrderCloud to Sitecore Search.
Best suited for demos or proofs of concept. For production environments, use an EventHub or Kafka based approach for improved resilience.

📌 Table of Contents

✨ Overview

This project hosts SearchSync as an Azure Function with an HTTP trigger, designed for:

Capability Description
🔁 Syncing Pushes product data from OrderCloud to Sitecore Search
🧪 Demo-Friendly Simple HTTP endpoint for quick testing
🛠️ Extensible Add custom mappings for XP and other properties

Important: The provided code syncs only the minimum properties required by OrderCloud’s search proxy. Extend the mappers in SearchSync.Common/Mappers to include additional fields or XP as needed for your Sitecore Search configuration.

⚙️ Requirements

  • Azure Subscription with:
    • Azure Functions
    • Azure Storage Account
  • OrderCloud Marketplace
  • Sitecore Search instance with Push API source

🗂️ Configuration

Create a local.settings.json at the project root:

⚠️ Do not commit secrets to source control.

{
  "IsEncrypted": false,
  "Values": {
    "AzureWebJobsStorage": "",
    "APPLICATIONINSIGHTS_CONNECTION_STRING": "",
    "SearchSettings__IngestionEndpointUrl": "",
    "SearchSettings__IngestionApiKey": "",
    "SearchSettings__DomainID": "",
    "SearchSettings__SourceID": "",
    "SearchSettings__EntityProduct": "",
    "FUNCTIONS_WORKER_RUNTIME": "dotnet-isolated"
  }
}

🔑 Setting Reference

Key Purpose Where To Find Example
AzureWebJobsStorage Connection string for Azure Storage Azure Portal → Storage Accounts → [Account] → Access Keys DefaultEndpointsProtocol=https;AccountName=youraccount;AccountKey=***;EndpointSuffix=core.windows.net
APPLICATIONINSIGHTS_CONNECTION_STRING (Optional) App Insights connection string Azure Portal → Application Insights → Overview InstrumentationKey=xxxx;IngestionEndpoint=https://yourregion.applicationinsights.azure.com/
SearchSettings__DomainID Sitecore Search domain ID CEC → Administration → Domain Settings 111111111
SearchSettings__SourceID ID of Push API source CEC → Sources → [Source] → Source Information 1111111
SearchSettings__IngestionEndpointUrl Ingestion endpoint URL CEC → Sources → [Source] → Endpoint URL https://discover.sitecorecloud.io/ingestion/v1
SearchSettings__IngestionApiKey API key for ingestion CEC → Sources → [Source] → API Key 01-xxxxxxxx...
SearchSettings__EntityProduct Name of product entity CEC → Administration → Domain Settings → Entities product
FUNCTIONS_WORKER_RUNTIME Azure Functions runtime identifier Not applicable dotnet-isolated

🚀 Running Locally

  1. Ensure local.settings.json exists at the project root and includes the configuration shown above.
  2. Run the project:
    • IDE: Use Run / Debug in Visual Studio or VS Code
    • Core Tools: From the project root, run: 
      func start

ℹ️ When using Azure Functions Core Tools, ensure local.settings.json exists and is not excluded from your local environment.

🔗 OrderCloud Setup

To send events to this HTTP-triggered function, configure Delivery Configurations and associate them with sync jobs:

1️⃣ Create a Delivery Configuration

POST /integrations/deliveryconfig

{
  "ID": "sitecore-search-http",
  "Name": "Sitecore Search HTTP",
  "Enabled": true,
  "DeliveryTargets": {
    "Http": {
      "Endpoint": "https://your-hosted-function/api/SearchSyncFunction",
      "CustomAuthHeaderName": "x-functions-key",
      "CustomAuthHeaderValue": "YOUR_AZURE_FUNCTIONS_KEY",
      "Secret": "super-secret-key"
    }
  }
}
  • CustomAuthHeaderValue is the key used to authorize calls to your Azure Function (find in the Azure Portal).
  • Secret is required by OrderCloud but is not used for validation by this project.

2️⃣ Associate with a Sync

PUT /integrations/productsync

{
  "SyncProductDeleted": true,
  "SyncProductChanged": true,
  "DeliveryConfigID": "sitecore-search-http"
}

This ensures product events are delivered to your HTTP endpoint for processing.