Click or drag to resize
IntegrationHelper Class
Class covering functionality shared across the integration module.
Inheritance Hierarchy
SystemObject
  CMS.SynchronizationIntegrationHelper

Namespace: CMS.Synchronization
Assembly: CMS.Synchronization (in CMS.Synchronization.dll) Version: 12.0.0
Syntax
C#
public static class IntegrationHelper

The IntegrationHelper type exposes the following members.

Properties
  NameDescription
Public propertyStatic memberConnectors
List of enabled (and initialized) connectors
Public propertyStatic memberIntegrationEnabled
Indicates if system integration is enabled.
Public propertyStatic memberIntegrationLogExternal
Indicates if logging of integration tasks for inbound direction is enabled. Reflects also IntegrationEnabled setting.
Public propertyStatic memberIntegrationLogInternal
Indicates if logging of integration tasks for outbound direction is enabled. Reflects also IntegrationEnabled setting.
Public propertyStatic memberIntegrationProcessExternal
Indicates if processing of integration tasks for inbound direction is enabled. Reflects also IntegrationEnabled setting.
Public propertyStatic memberIntegrationProcessInternal
Indicates if processing of integration tasks for outbound direction is enabled. Reflects also IntegrationEnabled setting.
Public propertyStatic memberTouchedConnectorNames
List of connector names for which the task was logged
Top
Methods
  NameDescription
Public methodStatic memberFilterAsyncConnectors
Filters given set of connectors.
Public methodStatic memberFilterConnectors
Filters given set of connectors by task process type.
Public methodStatic memberGetConnector(Int32)
Gets connector by ID
Public methodStatic memberGetConnector(String)
Gets connector by name
Public methodStatic memberGetIntegrationProcessResultEnum
Returns the process result enumeration value.
Public methodStatic memberGetIntegrationProcessResultString
Returns the process result as a string.
Public methodStatic memberGetIntegrationProcessTypeEnum
Returns the process type enumeration value.
Public methodStatic memberGetIntegrationProcessTypeString
Returns the process type as a string.
Public methodStatic memberGetMatchingConnectors
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 methodStatic memberGetTaskDataTypeEnum(String)
Returns the task data type enumeration value.
Public methodStatic memberGetTaskDataTypeEnum(TaskProcessTypeEnum)
Returns the task data type enumeration value based on task process type.
Public methodStatic memberGetTaskDataTypeString
Returns the task data type as a string.
Public methodStatic memberInit
Initializes integration bus
Public methodStatic memberInvalidateConnectors
Invalidates collections with connectors and subscriptions
Public methodStatic memberInvalidateSubscriptions
Invalidates collection with subscriptions
Public methodStatic memberLoadConnectors
Loads connectors
Public methodStatic memberLoadConnectors(Boolean)
Loads connectors
Public methodStatic memberLogIntegration
Logs integration task (only asynchronous process types).
Public methodStatic memberLogSynchronizationError
Logs the integration synchronization error.
Public methodStatic memberProcessExternalTask
Processes incoming task.
Public methodStatic memberProcessExternalTasksAsync
Ensures separate threads for connectors to process the pending logged external tasks. Thread won't be started if processing is already running.
Public methodStatic memberProcessExternalTasksAsync(Int32)
Processes external tasks of connector specified by ID
Public methodStatic memberProcessExternalTasksAsync(String)
Processes external tasks of connector specified by name
Public methodStatic memberProcessInternalTasksAsync
Ensures separate threads for connectors to process the logged internal tasks. Thread won't be started if processing is already running.
Public methodStatic memberProcessSyncTasks
Processes synchronous task subscriptions.
Public methodStatic memberProcessTasks(Int32, Boolean)
Processes pending internal or external tasks for specified connector.
Public methodStatic memberProcessTasks(String, Boolean)
Processes pending internal or external tasks for specified connector.
Public methodStatic memberSubscribeTo
Adds subscription to collection of subscriptions
Public methodStatic memberTouchAsyncConnectors
Adds connectors to collection to be processed.
Top
See Also