Connector ClassA Sandcastle Documented Class Library

Abstract super type for CloudConnector and OnPremConnector. Shared operations are declared here to allow for code reuse for session-based operations and some common operations.

Imports can be carried out using the import* methods such as ImportConfiguration(Stream, String).
Exports can in a similar manner be done with the export* methods such as ExportConfiguration.

The XML data formats are documented in the section Importing data on Apptus Zone (http://zone.apptus.com). The format for configuration and panels isn't documented publicly. They are generated by eSales Manager and these exports and imports should be used for backup and migration only. Manually editing these files isn't supported and should not be done.

The procedure for imports can be found in the eSales tutorial on Apptus Zone (http://zone.apptus.com).

Use the Session(String, String, String) method to get Session instances. These are used to notify eSales and query panels. View the Session documentation for details.

Inheritance Hierarchy

SystemObject
  Apptus.ESales.ConnectorConnector
    Apptus.ESales.ConnectorCloudConnector
    Apptus.ESales.ConnectorOnPremConnector

Namespace:  Apptus.ESales.Connector
Assembly:  Apptus.Esales.ConnectorApi (in Apptus.Esales.ConnectorApi.dll) Version: 4.2.1
Syntax

C#
public abstract class Connector

The Connector type exposes the following members.

Methods

  NameDescription
Public methodAvailableMarkets
Returns a list of available markets from the eSales cluster. Never returns null.
Public methodCheckCustomerDataJobStatus
Check the status of a GDPR customer data job.
Public methodCreateExportCustomerDataJob
Start a GDPR job on the cluster to export all data related to the given customer key. "Linked" customer keys will also be exported(i.e.customer keys that have been notified in the same session). Status of the job can be checked with {@link #checkCustomerDataJobStatus(String)} and when the status is , the resulting zip file can be downloaded using
Public methodCreateRemoveCustomerDataJob
Start a GDPR job on the cluster to remove all data related to the given customer key. Data will be removed both from memory and disk. "Linked" customer keys will also be removed(i.e.customer keys that have been notified in the same session).
Public methodDownloadExportCustomerDataJobResult(String)
Download the result of a GDPR export customer data job.
Public methodDownloadExportCustomerDataJobResult(String, String)
Download the result of a GDPR export customer data job.
Public methodEquals (Inherited from Object.)
Public methodExportAds
Exports ad data from the eSales cluster by returning a stream to the caller.
Public methodExportAds(String)
Exports ad data from the eSales cluster to the specified destinationFile.
Public methodExportConfiguration
Exports esales configuration from the eSales cluster by returning a stream to the caller.
Public methodExportConfiguration(String)
Exports esales configuration from the eSales cluster to the specified destinationFile.
Public methodExportPanels
Exports panel configuration from the eSales cluster by returning a stream to the caller.
Public methodExportPanels(String)
Exports panel configuration from the eSales cluster to the specified destinationFile.
Public methodExportProducts
Exports product data from the eSales cluster by returning a stream to the caller.
Public methodExportProducts(String)
Exports product data from the eSales cluster to the specified destinationFile.
Public methodExportProducts(String, String)

Returns an IEnumerable ProductStreamer that allows you to do filtered product exports, conveniently parsed into ResultProduct items. Every new iteration on this class will result in a new request to eSales. Note that the IEnumerator returned by its GetEnumerator method must be disposed when done, but this is done automatically when using foreach iteration.

Note that while iterating, imports will be blocked from completing on a selected eSales server. Imports will not fail but will wait for the iteration to finish. This means that if you fail to close the ProductStreamer you might block imports indefinitely!

Public methodExportSynonyms
Exports synonym data from the eSales cluster by returning a stream to the caller.
Public methodExportSynonyms(String)
Exports synonym data from the eSales cluster to the specified destinationFile.
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodStatic memberGetVersion
Returns connector version.
Protected methodImport
Public methodImportAds(Stream, String)
Imports ads from the specified stream to the eSales cluster.
Public methodImportAds(String, String)
Imports ads from the specified importFile to the eSales cluster.
Public methodImportConfiguration(Stream, String)
Imports configuration from the specified stream to the eSales cluster.
Public methodImportConfiguration(String, String)
Imports configuration from the specified importFile to the eSales cluster.
Public methodImportPanels(Stream, String)
Imports panels from the specified stream to the eSales cluster.
Public methodImportPanels(String, String)
Imports panels from the specified importFile to the eSales cluster.
Public methodImportProducts(Stream, String)
Imports products from the specified stream to the eSales cluster.
Public methodImportProducts(String, String)
Imports products from the specified importFile to the eSales cluster.
Public methodImportStream
Public methodImportSynonyms(Stream, String)
Imports synonyms from the specified stream to the eSales cluster.
Public methodImportSynonyms(String, String)
Imports synonyms from the specified importFile to the eSales cluster.
Public methodLatestNotifications
Returns the last 100 notifications received by the eSales cluster.
Public methodLatestNotifications(String)
Returns the last 100 notifications received by the eSales cluster.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodReporter
Creates a reporter for a market during a specified time interval. The reporter can be used to fetch reports from the eSales cluster.
Public methodReporterForUnknownMarket
Creates a reporter for the unknown market (sessions without a market property), during a specified time interval. The reporter can be used to fetch reports from the eSales cluster.
Protected methodStatic memberSave
Public methodServerLog
Gets a log from a server. Server index should be an index in the range [0, number_of_servers - 1]. The servers are indexed in the same order as they appear in the cluster string. The server indexes can also be retrieved from the status command. Name is the name of a log. Available log names can be retrieved from ServerLogNames.
Public methodServerLogNames
Gets a list of available log names.
Public methodSession(String) Obsolete.
Gets a session for the specified sessionKey.
Public methodSession(String, String, String)
Creates a session for the specified session key with the specified customer key and market. Calling this method does not affect the session in the eSales server. A notification or panel query, on the object created by this method, is necessary for the properties to stick to the session. When calling this method with null in place of customerKey and/or market, the server will keep the current values of these properties for this session.
Public methodStatus
Returns a status report from the eSales cluster as an XML document.
Public methodToString (Inherited from Object.)
Top
See Also

Reference