Providers in the Xperience API are classes that allow the system to manipulate objects and perform various actions. The following list presents the providers that the system uses and their purpose:
- Info providers contain methods for working with specific types of objects stored in the database, such as users, contacts, custom table records, etc.
- Data provider handles low-level database operations. The Info providers are built on top of the Data provider and use it to store and fetch data.
- Email provider manages the email queue and sends emails.
- File system providers allow you to access various file systems. They extend the CMS.IO namespace. See Working with physical files using the API to learn how to write a custom file system provider.
By developing custom providers and using them instead of the standard ones, you can modify the behavior of the application (or a specific feature) according to your exact requirements.
Customizations of provider classes automatically apply to the corresponding provider interfaces (services).
For example, if you develop and register a custom OrderInfoProvider, and override its Set method, your customization applies when the Set method of the IOrderInfoProvider service is called.
Adding your custom code files
When developing custom functionality, we recommend that you place your code files into a separate Class Library project (assembly), which you can then reference from your live site or administration web projects.
Deploying customizations to the live site
Consider whether you need to deploy the assembly containing custom provider classes to your live site (MVC) application, in addition to the Xperience administration project. This is required if you are customizing any provider that affects functionality on the live site (registration of users, e-commerce activity, automatic sending of emails based on the actions of visitors, etc.).
For additional information, see Applying customizations in the Xperience environment.
Writing the custom code
Custom provide classes must inherit from the original class. This allows you to implement your modifications or additions by overriding the members of the given class. When creating overrides for existing methods, it is recommended to call the original base method within your custom code.
Registering custom providers
After you write the code, you must register your custom classes to ensure that the system uses them instead of the default providers. You can choose between two options of registering custom provider classes:
- Using assembly attributes – the most straightforward way to register providers.
- Using the web.config file – allows you to switch between different providers (custom or default) without having to edit the application code.
Other customization options
In addition to providers, you can also customize the following helper and manager classes:
|Helper class name||Namespace||Description|
|Provides marketing automation support for common actions related to Salesforce integration.|
|CacheHelper||CMS.Helpers||Handles operations with cache items.|
|ClassHelper||CMS.Base||Takes care of dynamically loaded classes and assemblies.|
|CookieHelper||CMS.Helpers||Contains methods for managing cookies.|
|DirectoryHelper||CMS.IO||Manages directories in the file system.|
|LeadReplicationHelper||CMS.SalesForce||Replicates contacts into SalesForce leads.|
|LocalizationHelper||CMS.Localization||Retrieves localized text from resource strings.|
|MFAuthenticationHelper||CMS.Membership||Contains methods and properties that implement and configure multi-factor authentication.|
|TriggerHelper||CMS.Automation||Manages marketing automation triggers.|
|Manager class name||Namespace||Description|
|AutomationManager||CMS.Automation||Handles the marketing automation process.|
|SyncManager||CMS.Synchronization||Synchronizes page and object data to other instances of the application when using Content staging.|
|VersionManager||CMS.DocumentEngine||Provides page versioning functionality.|
|Handles the workflow process.|
You can also use global event handlers to customize the behavior of the system. Handlers allow you to execute custom code whenever a specific event occurs in the system, such as page or object changes, various parts of the user authentication process, etc.
- Custom Info provider example demonstrates how to customize standard Info providers.
- Custom Email provider example shows a sample customization of the email provider.
- Custom Data provider example describes the specific steps that you need to take to customize the Data provider.
- Customizing e-commerce data for Google Analytics demonstrates how to customize helper classes that the system uses to create product and order JSON data for the purposes of Google Analytics.