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

Package DE_EPAGES::FactFinder::API::WS::Client

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

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

Functions

buildMatrix
createChannel
createUser
deleteChannel
deleteUser
getAllChannels
getAllUsers
getRecommendation
logInformation
suggest
updateUser
uploadProducts

buildMatrix

rebuilds recommendation matrix

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

createChannel

Syntax
$Object->createChannel( $Channel );
Input
$Channel (string)
channel name

createUser

creates FACT-Finder user via SOAP

Syntax
$Object->createUser( $Username, $PasswordMD5);
Input
$Username (string)
username
$PasswordMD5 (string)
password | md5-encrypted password

deleteChannel

Removes a FACT-Finder channel

Syntax
$Object->deleteChannel( $Channel, $Input2);
Input
$Channel (string)
channelname

deleteUser

deletes FACT-Finder user

Syntax
deleteUser( $Username );
Input
$Username (string)
user name

getAllChannels

Retrieves Channel list

Syntax
getAllChannels( $Input1 );
Return
$Channels (ref.hash)
channel list

getAllUsers

fetches FACT-Finder user list

Syntax
getAllUsers( );
Return
$Result (ref.hash)
parsed soap document

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

logInformation

logs event information

Syntax
logInformation( $hEventData );
Input
$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)

suggest

calls FACT-Finder suggest service

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

updateUser

updates channel rights on user

Syntax
updateUser( $ChannelNames );
Input
$ChannelNames (ref.array)
list of channel names

uploadProducts

upload product export file to fact-finder

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