ePages 6.13.2 - DE_EPAGES/FactFinder/API/Object/RemoteFactFinder.pm

Package DE_EPAGES::FactFinder::API::Object::RemoteFactFinder

This represents the client part of the functions communicating with with FactFinder WebServices.

Functions

account
adminPasswordMD5
adminUser
backOfficeURL
baseURL
buildMatrix
channelMmtURL
createChannel
createUser
currentTime
deleteChannel
deleteUser
downloadProductExport
factory
getAllChannels
getAllUsers
getRecommendation
importURL
isLogCommunication
isLogStatistics
isPremium
logInformation
new
passwordMD5
recommendationURL
refreshDatabase
refreshDbURL
refreshSuggestDatabase
scicURL
search
searchURL
shopAlias
ssoPostfix
ssoPrefix
startImport
startSuggestImport
suggest
suggestURL
updateUser
uploadProducts
userMmtURL

$SOAP_UPDATE_TIMEOUT (integer)

timeout for soap calls updating the FactFinder database (seconds) default: 300

$SOAP_SUGGEST_TIMEOUT (integer)

timeout for soap calls to the suggest API (seconds). default: 5

account

getter/setter for 'account'

Syntax
my $account = $Object->account;
$Object->account('value');
Input
$account (any)
value of account
Return
$account (any)
value of account

adminPasswordMD5

getter/setter for 'adminPasswordMD5'

Syntax
my $adminPasswordMD5 = $Object->adminPasswordMD5;
$Object->adminPasswordMD5('value');
Input
$adminPasswordMD5 (any)
value of adminPasswordMD5
Return
$adminPasswordMD5 (any)
value of adminPasswordMD5

adminUser

getter/setter for 'adminUser'

Syntax
my $adminUser = $Object->adminUser;
$Object->adminUser('value');
Input
$adminUser (any)
value of adminUser
Return
$adminUser (any)
value of adminUser

backOfficeURL

getter/setter for 'backOfficeURL'

Syntax
my $backOfficeURL = $Object->backOfficeURL;
$Object->backOfficeURL('value');
Input
$backOfficeURL (any)
value of backOfficeURL
Return
$backOfficeURL (any)
value of backOfficeURL

baseURL

getter/setter for 'baseURL'

Syntax
my $baseURL = $Object->baseURL;
$Object->baseURL('value');
Input
$baseURL (any)
value of baseURL
Return
$baseURL (any)
value of baseURL

buildMatrix

rebuilds recommendation matrix

Syntax
buildMatrix( $Channel );
Input
$Channel (string)
channel alias
Return
$hRet (hash.ref)
soap return

channelMmtURL

getter/setter for 'channelMmtURL'

Syntax
my $channelMmtURL = $Object->channelMmtURL;
$Object->channelMmtURL('value');
Input
$channelMmtURL (any)
value of channelMmtURL
Return
$channelMmtURL (any)
value of channelMmtURL

createChannel

invokes createChannel SOAP call

Syntax
$Object->createChannel( $Channel );
Input
$Channel (string)
channel name
Return
$Result (SOAP::SOM)
parsed soap response

createUser

creates FACT-Finder user via SOAP

Syntax
$Object->createUser( $Username, $PasswordMD5);
Input
$Username (string)
username
$PasswordMD5 (string)
password | md5-encrypted password
$aChannels (ref.array.string)
channels controlled by user
Return
$Result (SOAP::SOM)
parsed soap response

currentTime

getter/setter for 'currentTime'

Syntax
my $currentTime = $Object->currentTime;
$Object->currentTime('value');
Input
$currentTime (any)
value of currentTime
Return
$currentTime (any)
value of currentTime

deleteChannel

Removes a FACT-Finder channel

Syntax
$Object->deleteChannel( $Channel, $Input2);
Input
$Channel (string)
channelname
Return
$Result (SOAP::SOM)
parsed soap response

deleteUser

deletes FACT-Finder user

Syntax
deleteUser( $Username );
Input
$Username (string)
user name
Return
$Result (SOAP::SOM)
parsed soap response

downloadProductExport

calls downloadProductExport via SOAP

Syntax
$Object->downloadProductExport( $Channel, $File);
Input
$Channel (string)
channel name
$FileURL (string)
file url
Return
$Result (SOAP::SOM)
parsed soap response

factory

creates a RemoteFactFinder instance with settings from the Shop

Syntax
my $Object = DE_EPAGES::FactFinder::API::Object::RemoteFactFinder->factory( $Shop );
Input
$Shop (DE_EPAGES::Shop::API::Object::Shop)
shop
Return
$Object (DE_EPAGES::FactFinder::API::Object::RemoteFactFinder)
object

getAllChannels

Retrieves Channel list

Syntax
getAllChannels( $Input1 );
Return
$Result (SOAP::SOM)
parsed soap response

getAllUsers

fetches FACT-Finder user list

Syntax
getAllUsers( );
Return
$Result (SOAP::SOM)
parsed soap response

getRecommendation

gets results from FACT-Finder recommendation engine

Syntax
getRecommendation( $Channel, $Product, $Limit );
Input
$Channel (string)
channel alias
$Product (string)
product alias
$Limit (int)
limit return count
Return
$hRet (hash.ref)
soap result

importURL

getter/setter for 'importURL'

Syntax
my $importURL = $Object->importURL;
$Object->importURL('value');
Input
$importURL (any)
value of importURL
Return
$importURL (any)
value of importURL

isLogCommunication

getter/setter for 'isLogCommunication'

Syntax
my $isLogCommunication = $Object->isLogCommunication;
$Object->isLogCommunication('value');
Input
$isLogCommunication (any)
value of isLogCommunication
Return
$isLogCommunication (any)
value of isLogCommunication

isLogStatistics

getter/setter for 'isLogStatistics'

Syntax
my $isLogStatistics = $Object->isLogStatistics;
$Object->isLogStatistics('value');
Input
$isLogStatistics (any)
value of isLogStatistics
Return
$isLogStatistics (any)
value of isLogStatistics

isPremium

getter/setter for 'isPremium'

Syntax
my $isPremium = $Object->isPremium;
$Object->isPremium('value');
Input
$isPremium (any)
value of isPremium
Return
$isPremium (any)
value of isPremium

logInformation

logs event information

Syntax
logInformation( $hEventData );
Input
$Channel (string)
FactFinder channel name
$hEventData (hash.ref)
hash with log information. possible keys.
  • channel - channel name
  • query - query used for this event
  • id - product alias
  • pos - position of product in search (absolute position:
    (page-1)*entriesPerPage + posInPage) (optional)
  • origPos - original position of product (__ORIG_POSITION__)
  • page - results page (first page = 1)
  • simi - similarity (optional)
  • userId - customer id, should be anonymized (hash) ( optional)
  • sid - session id, should be anonymized (hash)
  • title - name of product (optional)
  • event - event: click, cart, checkout, recommendationClick
  • pageSize - entries per page (optional)
  • origPageSize - default entries per page
  • count - quantity of sold product
  • price - price of one sold product (optional)
Return
$Result (SOAP::SOM)
parsed soap response

new

creates a RemoteFactFinder instance. Use factory method to get an object with initialized values.

Syntax
my $Object = DE_EPAGES::FactFinder::API::Object::RemoteFactFinder->new( %options );
Input
%options (hash)
options hash
Return
$Object (DE_EPAGES::FactFinder::API::Object::RemoteFactFinder)
object

passwordMD5

getter/setter for 'passwordMD5'

Syntax
my $passwordMD5 = $Object->passwordMD5;
$Object->passwordMD5('value');
Input
$passwordMD5 (any)
value of passwordMD5
Return
$passwordMD5 (any)
value of passwordMD5

recommendationURL

getter/setter for 'recommendationURL'

Syntax
my $recommendationURL = $Object->recommendationURL;
$Object->recommendationURL('value');
Input
$recommendationURL (any)
value of recommendationURL
Return
$recommendationURL (any)
value of recommendationURL

refreshDatabase

calls refreshDatabase via SOAP

Syntax
$Object->refreshDatabase( $Channel);
Input
$Channel (string)
channel name
Return
$Result (SOAP::SOM)
parsed soap response

refreshDbURL

getter/setter for 'refreshDbURL'

Syntax
my $refreshDbURL = $Object->refreshDbURL;
$Object->refreshDbURL('value');
Input
$refreshDbURL (any)
value of refreshDbURL
Return
$refreshDbURL (any)
value of refreshDbURL

refreshSuggestDatabase

calls refreshSuggestDatabase via SOAP

Syntax
$Object->refreshSuggestDatabase( $Channel);
Input
$Channel (string)
channel name
Return
$Result (SOAP::SOM)
parsed soap response

scicURL

getter/setter for 'scicURL'

Syntax
my $scicURL = $Object->scicURL;
$Object->scicURL('value');
Input
$scicURL (any)
value of scicURL
Return
$scicURL (any)
value of scicURL

search

gets ready the params and parses/adapts the result for/from the SOAP-request

Syntax
search($Channel, $Query, $Page, $ResultsPerPage, $Filters, $Sorts);
Input
$Channel (string)
FactFinder channel name
$Query (string)
query string
$Page (int)
page to be fetched (optional)
$ResultsPerPage (int)
results per page (optional)
$hFilters (hash.ref)
used filters
$hSorts (hash.ref)
used sorts
Return
$SOM (SOAP::SOM)
parsed soap response

searchURL

getter/setter for 'searchURL'

Syntax
my $searchURL = $Object->searchURL;
$Object->searchURL('value');
Input
$searchURL (any)
value of searchURL
Return
$searchURL (any)
value of searchURL

shopAlias

getter/setter for 'shopAlias'

Syntax
my $shopAlias = $Object->shopAlias;
$Object->shopAlias('value');
Input
$shopAlias (any)
value of shopAlias
Return
$shopAlias (any)
value of shopAlias

ssoPostfix

getter/setter for 'ssoPostfix'

Syntax
my $ssoPostfix = $Object->ssoPostfix;
$Object->ssoPostfix('value');
Input
$ssoPostfix (any)
value of ssoPostfix
Return
$ssoPostfix (any)
value of ssoPostfix

ssoPrefix

getter/setter for 'ssoPrefix'

Syntax
my $ssoPrefix = $Object->ssoPrefix;
$Object->ssoPrefix('value');
Input
$ssoPrefix (any)
value of ssoPrefix
Return
$ssoPrefix (any)
value of ssoPrefix

startImport

calls startImport via SOAP

Syntax
$Object->startImport( $Channel);
Input
$Channel (string)
channel name
Return
$Result (SOAP::SOM)
parsed soap response

startSuggestImport

calls startSuggestImport via SOAP

Syntax
$Object->startSuggestImport( $Channel);
Input
$Channel (string)
channel name
Return
$Result (SOAP::SOM)
parsed soap response

suggest

calls FACT-Finder suggest service

Syntax
$Object->suggest( $Channel, $Query, $Language);
Input
$Channel (string)
channel name
$Query (string)
query string
$Language (string)
language code (iso-2) (optional)
Return
$Response (string)
suggest response

suggestURL

getter/setter for 'suggestURL'

Syntax
my $suggestURL = $Object->suggestURL;
$Object->suggestURL('value');
Input
$suggestURL (any)
value of suggestURL
Return
$suggestURL (any)
value of suggestURL

updateUser

updates channel rights on user

Syntax
updateUser( $ChannelNames );
Input
$ChannelNames (ref.array)
list of channel names
Return
$Result (SOAP::SOM)
parsed soap response

uploadProducts

upload product export file to fact-finder by calling all necessary SOAP actions: downloadProductExport, startImport, refreshDatabase, startSuggestImport, refreshSuggestDatabase

Syntax
$Object->uploadProducts( $Channel, $File);
Input
$Channel (string)
channel name
$FileURL (string)
file url

userMmtURL

getter/setter for 'userMmtURL'

Syntax
my $userMmtURL = $Object->userMmtURL;
$Object->userMmtURL('value');
Input
$userMmtURL (any)
value of userMmtURL
Return
$userMmtURL (any)
value of userMmtURL