Is this really the version you are looking for? Kentico Xperience 11 Documentation is no longer updated. Use the switcher in the header to choose your product version.
The default installation of Kentico provides a sample integration connector. The connector implements two subscriptions for outgoing tasks:
The connector's purpose is purely demonstrative – it only logs events in the Event log application for each creation, modification or deletion of a user or page.
Information for web application projects
If your Kentico project was installed as a web application, copy the sample file into the Old_App_Code folder instead.
You must also manually include the sample class files into the project:
To see how the sample connector is implemented:
public class SampleIntegrationConnector : BaseIntegrationConnector
{
#region "Initialization (subscribing)"
/// <summary>
/// Initializes the connector name and registers subscriptions.
/// </summary>
public override void Init()
{
// Initializes the connector name (must match the code name of the connector object in the system)
ConnectorName = GetType().Name;
// Creates subscription for all user objects (predefined method)
SubscribeToObjects(TaskProcessTypeEnum.AsyncSnapshot, UserInfo.OBJECT_TYPE);
// Create subscription for all pages on all sites (predefined method)
SubscribeToAllDocuments(TaskProcessTypeEnum.AsyncSimpleSnapshot, TaskTypeEnum.All);
// Demonstrates how to create subscriptions manually
// ObjectIntegrationSubscription objSubscription = new ObjectIntegrationSubscription(ConnectorName, TaskProcessTypeEnum.AsyncSnapshot, TaskTypeEnum.All, null, PredefinedObjectType.USER, null);
// SubscribeTo(objSubscription);
// DocumentIntegrationSubscription pageSubscription = new DocumentIntegrationSubscription(ConnectorName, TaskProcessTypeEnum.AsyncSimpleSnapshot, TaskTypeEnum.All, null, null, null, null);
// SubscribeTo(pageSubscription);
}
...To be functional, every connector must have the ConnectorName property initialized in the Init() method. The value must match the code name of the connector object registered in the system. The sample connector uses the name of the ConnectorName – SampleIntegrationConnector.
The sample connector is defined in the App_Code folder, so the file contains code that allows the system to load the class when working with the connector — the RegisterCustomClass assembly attribute declared above the SampleIntegrationConnector class. See Loading custom classes from App_Code for more information.
[assembly: RegisterCustomClass("SampleIntegrationConnector", typeof(SampleIntegrationConnector))]The RegisterCustomClass attribute accepts two parameters:
Open the Integration bus application in the Kentico administration interface.
Select the Connectors tab.
Click New connector.
Fill in the following properties:
Click Save.
Open the Settings application.
Select the Integration -> Integration bus category.
Adjust the settings as follows:
The sample connector only generates outgoing tasks, so you can leave the handling of incoming tasks disabled. Disabling processing of outgoing tasks allows you to see the integration tasks in the user interface. If you enable processing, the system executes the tasks immediately, and you only see the results in the event log.
Click Save.
Try creating and modifying some pages and user accounts.
Open the Integration bus application. On the Outgoing tasks tab, you can see a list of tasks logged for your actions. The Synchronize () action is grayed out since processing of tasks is disabled in the system settings.
Go back to Settings -> Integration -> Integration bus, check Enable processing of outgoing tasks and click Save.
Return to Integration bus -> Outgoing tasks. The Synchronize () action is now enabled.
To execute all tasks:
You can see the events logged by the integration tasks in the Event log application.