Class Connector
Abstract super class for Apptus\ESales\Connector\CloudConnector
and Apptus\ESales\Connector\OnPremConnector
.
Imports can be carried out using the import* methods such as Apptus\ESales\Connector\Connector::importConfiguration()
.
Exports can in a similar manner be done with the export* methods such as Apptus\ESales\Connector\Connector::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 Apptus\ESales\Connector\Connector::session()
method to get Apptus\ESales\Connector\Session
instances. These are used to notify eSales and query panels.
View the Apptus\ESales\Connector\Session
documentation for details.
Direct known subclasses
Apptus\ESales\Connector\CloudConnector, Apptus\ESales\Connector\OnPremConnectorNamespace: Apptus\ESales\Connector
See:
Apptus\ESales\Connector\CloudConnector
See:
Apptus\ESales\Connector\OnPremConnector
Located at Connector/Connector.php
final public
|
|
public
string
|
|
public
|
#
createRemoveCustomerDataJob( string $customerKey )
Start a GDPR job on the cluster to remove all data related to the given customer key. |
public
|
#
createExportCustomerDataJob( string $customerKey )
Start a GDPR job on the cluster to export all data related to the given customer key. |
public
|
|
public
An
|
#
downloadExportCustomerDataJobResult( string $jid )
Download the result of a GDPR export customer data job. |
public
integer
|
#
downloadExportCustomerDataJobResultToDestination( string $jid, destination $destination )
Download the result of a GDPR export customer data job. |
final public
|
#
importProducts( resource|string $importFile, string $name = null )
Imports products from the specified file or string to the eSales cluster. |
final public
|
#
importPanels( resource|string $importFile, string $name = null )
Imports panels from the specified file or string to the eSales cluster. |
final public
|
#
importConfiguration( resource|string $importFile, string $name = null )
Imports configuration from the specified file or string to the eSales cluster. |
final public
|
#
importSynonyms( resource|string $importFile, string $name = null )
Imports synonyms from the specified file to the eSales cluster. |
final public
|
|
final public
integer|string
|
#
exportProducts( resource|string|null $dest = null )
Exports everything from the eSales cluster as an update file. |
final public
integer|string
|
#
exportPanels( resource|string|null $dest = null )
Exports panels from the eSales cluster to a definition file. |
final public
integer|string
|
#
exportConfiguration( resource|string|null $dest = null )
Exports configuration from the eSales cluster to an update file. |
final public
integer|string
|
#
exportSynonyms( resource|string|null $dest = null )
Exports synonyms from the eSales cluster as an update file. |
final public
integer|string
|
|
public
array
|
#
availableMarkets( )
Returns a list of available markets from the eSales cluster. Never returns null. |
public
|
#
reporter( string $market,
Creates a reporter for a market during a specified time interval. |
public
|
#
reporterForUnknownMarket(
Creates a reporter for the unknown market (sessions without a market property), during a specified time interval. |
public
string
|
#
latestNotifications( string $type = null )
Return the last 100 notifications received by the eSales cluster. |
public
string
|
#
serverLog( integer $index, string $name )
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 |
public
array
|
|
public static
string
|