IntegrationHelper Class

Class covering functionality shared across the integration module.

Inheritance Hierarchy

System.Object
  CMS.Synchronization.IntegrationHelper

Namespace: CMS.Synchronization
Assembly: CMS.Synchronization (in CMS.Synchronization.dll) Version: 11.0.0

Syntax

public static class IntegrationHelper

The IntegrationHelper type exposes the following members.

Properties

	Name	Description
Public property Static member	Connectors	List of enabled (and initialized) connectors
Public property Static member	IntegrationEnabled	Indicates if system integration is enabled.
Public property Static member	IntegrationLogExternal	Indicates if logging of integration tasks for inbound direction is enabled. Reflects also IntegrationEnabled setting.
Public property Static member	IntegrationLogInternal	Indicates if logging of integration tasks for outbound direction is enabled. Reflects also IntegrationEnabled setting.
Public property Static member	IntegrationProcessExternal	Indicates if processing of integration tasks for inbound direction is enabled. Reflects also IntegrationEnabled setting.
Public property Static member	IntegrationProcessInternal	Indicates if processing of integration tasks for outbound direction is enabled. Reflects also IntegrationEnabled setting.
Public property Static member	TouchedConnectorNames	List of connector names for which the task was logged

Methods

	Name	Description
Public method Static member	FilterAsyncConnectors	Filters given set of connectors.
Public method Static member	FilterConnectors	Filters given set of connectors by task process type.
Public method Static member	GetConnector(Int32)	Gets connector by ID
Public method Static member	GetConnector(String)	Gets connector by name
Public method Static member	GetIntegrationProcessResultEnum	Returns the process result enumeration value.
Public method Static member	GetIntegrationProcessResultString	Returns the process result as a string.
Public method Static member	GetIntegrationProcessTypeEnum	Returns the process type enumeration value.
Public method Static member	GetIntegrationProcessTypeString	Returns the process type as a string.
Public method Static member	GetMatchingConnectors	Gets dictionary of connector names whose subscriptions match given CMS object and task type. The type of task processing is stored as dictionary value.
Public method Static member	GetTaskDataTypeEnum(String)	Returns the task data type enumeration value.
Public method Static member	GetTaskDataTypeEnum(TaskProcessTypeEnum)	Returns the task data type enumeration value based on task process type.
Public method Static member	GetTaskDataTypeString	Returns the task data type as a string.
Public method Static member	Init	Initializes integration bus
Public method Static member	InvalidateConnectors	Invalidates collections with connectors and subscriptions
Public method Static member	InvalidateSubscriptions	Invalidates collection with subscriptions
Public method Static member	LoadConnectors()	Loads connectors
Public method Static member	LoadConnectors(Boolean)	Loads connectors
Public method Static member	LogIntegration	Logs integration task (only asynchronous process types).
Public method Static member	LogSynchronizationError	Logs the integration synchronization error.
Public method Static member	ProcessExternalTask	Processes incoming task.
Public method Static member	ProcessExternalTasksAsync()	Ensures separate threads for connectors to process the pending logged external tasks. Thread won't be started if processing is already running.
Public method Static member	ProcessExternalTasksAsync(Int32)	Processes external tasks of connector specified by ID
Public method Static member	ProcessExternalTasksAsync(String)	Processes external tasks of connector specified by name
Public method Static member	ProcessInternalTasksAsync	Ensures separate threads for connectors to process the logged internal tasks. Thread won't be started if processing is already running.
Public method Static member	ProcessSyncTasks	Processes synchronous task subscriptions.
Public method Static member	ProcessTasks(Int32, Boolean)	Processes pending internal or external tasks for specified connector.
Public method Static member	ProcessTasks(String, Boolean)	Processes pending internal or external tasks for specified connector.
Public method Static member	SubscribeTo	Adds subscription to collection of subscriptions
Public method Static member	TouchAsyncConnectors	Adds connectors to collection to be processed.