1. Sitecore Content SDK

Troubleshooting

Version:

This topic describes the most common errors in the console or terminal, and solutions when using the Sitecore Content SDK.

IE errors

IE errors are related to initialization. You must resolve these errors for the Content SDK to function properly.

Code

Description

Solution

IE-001

A required plugin dependency is missing.

Review the plugins passed to initContentSdk() and ensure all required dependencies for the plugin are included in the plugins array.

IE-002

An SDK feature was invoked before initialization.

Ensure that initContentSdk() is executed before calling any SDK functionality that depends on initialization. Confirm that proper configuration and plugins are provided.

IE-003

Timeout exceeded. The server did not respond within the allotted time.

This error occurs when you call a function with the timeout attribute in one of the function parameters, then the function makes a network request to the server, but the server doesn't respond in time. When you use timeout, use try-catch blocks to handle errors.

IE-004

A feature requiring a specific plugin was used, but the plugin is not registered.

Check the initContentSdk() call and verify that the plugin is included in the plugins array.

IE-005

Unable to set the sc_cid cookie because the client ID could not be retrieved from the server.

Verify the values for contextId and siteName. If the issue persists, try again later or use try-catch blocks to handle this error.

IE-006

Unable to set the sc_cid_personalize cookie because the visitor ID could not be retrieved from the server.

Verify the values for contextId and siteName. If the issue persists, try again later or use try-catch blocks to handle this error.

IE-007

The system failed to resolve a site configuration for the provided host name.

Review site resolution settings in Sitecore AI and ensure that the correct host name mapping is configured.

IV errors

IV errors are related to incorrect values and wrongly formatted objects.

Code

Description

Solution

IV-001

The provided edgeUrl is missing or not a valid absolute URL.

Verify the Sitecore Edge URL configured via environment variables or in sitecore.config. Ensure it is a valid URL

IV-002

The provided timeout value is invalid.

Verify the value for timeout. Set the value to an integer greater than or equal to 0.

IV-003

The provided value for dob is invalid.

Verify the value for dob. Format the value according to ISO 8601.

IV-004

The provided value for email is invalid.

Verify the value for email. Set it to a valid email address.

IV-005

The provided value for expiryDate is invalid.

Verify the value for expiryDate. Format the value according to ISO 8601.

IV-006

The number of attributes provided to extensionData exceeds the maximum allowed value.

Verify the number of attributes on extensionData. Reduce the number of attributes.

IV-007

The specified site cannot be found or its root item tree is not available.

Verify that the site name is correctly defined in environment variables. Confirm that the site exists and is properly configured in SitecoreAI. If the configuration appears correct and the issue persists, contact Sitecore Support.

MV errors

MV errors are related to missing values.

Code

Description

Solution

MV-001

A required contextId value was not provided.

Ensure that contextId is defined via environment variables or in sitecore.config.

MV-002

The siteName parameter was not provided or could not be resolved.

Verify that the site name is correctly resolved and passed to the relevant service or configuration.

MV-003

identifiers is required.

Ensure site visitors have valid identifiers. See IdentityData.

MV-004

friendlyId is required.

Friendly ID is the unique identifier of the live interactive experience or experiment to run. Ensure it's a valid friendly ID. See PersonalizeData.

MV-005

The sitecore.cli.config file is missing a required property.

Review the sitecore.cli.config documentation and ensure all mandatory properties are defined.

MV-006

The clientContextId was not provided, which may impact certain client-side features.

Set the Sitecore client context ID if using client-side features that require it (for example, Forms, Events).

MV-007

Required API configuration is incomplete. Provide either contextId or both apiHost and apiKey.

Ensure that either: contextId is configured, or both apiHost and apiKey are provided. Review environment variables or sitecore.config to confirm one valid configuration path is defined.

MV-008

The sitecore.config reference is missing or not properly imported.

Ensure that sitecore.config is defined, correctly imported, and passed to the relevant initialization or service layer.

MV-009

The required language parameter was not provided.

Verify that the language is correctly resolved (for example, from route, context, or configuration) and passed to the related services.

If you have suggestions for improving this article, let us know!