installationmagento

07/25/2016Magentoplugin2.
0manual107/25/2016Magentoplugin2.
0manual21Contents1Contents22Introduction33ConnecttheplugintoaTripolisDialogueclient43.
1Pluginsettings43.
2ConnectionwithTripolisDialogue44Databasesmappingsandcontactsynchronization54.
1ContactSynchronization54.
1.
1Enabling/disablingofcontactsynchronizing54.
1.
2Statuspage54.
2Mapping54.
2.
1Databasemapping54.
2.
2Contactgroupmapping64.
2.
3Contactfieldmapping64.
3InitialSynchronization74.
3.
1Subscribingandunsubscribingofcontacts75Transactionalemails85.
1Transactionalfieldmapping85.
2EmailMapping96Useproductfeedsinemails116.
1Security116.
1.
1IPrestrictionoffeeds116.
1.
2Feeduserrestriction116.
2URLGenerator/Feedtypes116.
2.
1Customerfeed126.
2.
2Productfeed126.
2.
3Quotefeed136.
3Singleorderfeed146.
3.
1Invoicefeed146.
3.
2Shipmentfeed146.
3.
3Creditmemofeed146.
3.
4Sendtoafriendfeed156.
3.
5Sendwishlistfeed156.
3.
6Abandonedcart157Appendix177.
1Loglevel177.
2EmailObjectEncryptionsettings1707/25/2016Magentoplugin2.
0manual32IntroductionInthisdocumentwedescribeindetailhowtousetheMagentoPluginforTripolisDialoguetosynchronizecontactsandsendemailstoMagentocustomers.
Themainstepsinthisprocessare:1.
ConnecttheplugintoaTripolisDialogueclient(Section3).
2.
CreatemappingsforContactSynchronization(Section4).
3.
Setuptransactionalemails(Section5).
4.
Useproductfeedsinemails(Section6).
ForcontactsynchronisationyoucanconnectaMagentostoreviewtoaTripolisDialoguedatabase.
Thisdatabasewillcontaincontactrecordsandasauseryoucanmapanystorefieldwithcustomerdata,toadatabasefieldinTripolisDialogue.
Youcanalsosetuponegroupforsubscribersandoneforunsubscribersthatthepluginwillusebasedonthecustomerprofilesettings.
ContactswillbeupdatedautomaticallyinTripolisDialoguewhenchangesoccurinthewebshop.
Inthissynchronizationthewebshopisalwaysleading.
Whenfirsttakingtheplugininproductionitisnecessarytodoaninitialsynchronization.
ForsendingtransactionalemailsthepluginusesaseparatedatabaseinTripolisDialogue(ormultipledatabasesiftherearemultiplestoreviews).
Thisdatabasewillnotcontaincontacts,buttransactionalrecords.
Fortheserecordsyoucancreateadatabasemappingoftype"transactions"alongwiththenecessaryfieldmappingsforthisdatabasemap.
IntheWorkspaceconnectedtothisdatabaseyoucanmaptransactionalemailstothedefaultmailsinMagento.
Foreachtransactionalevent,thepluginwillcreateatransactionalrecordandwillsendouttheemailmappedtothisevent.
Detailsforeachtransactioncanbefoundinthevarioustransactionfeeds(Section6.
2).
Forcommercialemailstoyourcontactsthepluginprovidesanumberofproductfeeds.
TherearevariousfeedtypessuchasLatestAdditions,Bestsellers,etc.
andtheURLforeachfeedcanbegeneratedbasedontype,numberofproductsandproductcategory.
ThesefeedscanbeusedinNewslettersorDirectEmailsinTripolisDialogue.
ThefeedURL'shaveaclearstructurethatmakesthemeasytouseincombinationwithplaceholdersforarticlefieldsinnewsletters.
07/25/2016Magentoplugin2.
0manual43ConnecttheplugintoaTripolisDialogueclientTosynchronizecustomersinMagentotocontactsinTripolisDialogueyouneedtoconfiguretheplugin.
3.
1PluginsettingsAfterinstallingtheplugin(seemagento_installation_manual)makesurethatyouenableditandthatyouprovidedan(administrator)email-addressfornotifications.
Leavedisabledduringsetup.
Enablerightbeforeinitialsynchronization.
Thesesettingscanbefoundunder:Maintab:Tripolis>Configuration>SettingsIfyouhavemultiplestoresrunningonyourMagentoinstallation,keepinmindthatthisconfiguration,bydefault,issetupforallstoreviews,orforeachstoreviewindividually.
ConfigurationofthescopeDefaultConfigmeansthatyoursettingswillapplyforallstoreviewsforwhichnoconfigurationhasbeenset.
ToconfigureaspecificstoreviewselectthatstoreviewinthedropdownoftheCurrentConfigurationScopeselectionbox.
3.
2ConnectionwithTripolisDialogueToestablishaconnectionwithTripolisDialogueyouprovideyourcredentialsintheDialogueInstancesection(makesuretouseadedicatedAPIaccountwithadvancedAPIrights).
YoucantesttheconnectionbyusingRunTest.
Maintab:Tripolis>Configuration>SettingsLoggingThepluginprovidesextensiveloggingoptions;pleasechecktheappendixformoredetails.
URLObjectEncryptionInformationusedinURL'scanbeencryptedwithAESencryption,seeappendixforfurtherdetails.
07/25/2016Magentoplugin2.
0manual54Databasesmappingsandcontactsynchronization4.
1ContactSynchronizationInthissynchronizationthewebshopisalwaysleading.
EmailiskeyinDialogueforcontactsynchronization(tohandlebothsubscribersandcustomers)Guesttransactionsareexcludedfromsynchronization.
4.
1.
1Enabling/disablingofcontactsynchronizingThecontactsynchronizationbetweenMagentoandTripolisDialoguecanbeenabledordisabledatalltimes.
ThisismanagedintheContactsynchronizationsection.
Maintab:Tripolis>Configuration>Settings4.
1.
2StatuspageBeforeinitialmapping,checktheConnectionstatusonthestatuspage.
Maintab:Tripolis>Status4.
2MappingForMagentotocommunicatewithTripolisDialogue,itisnecessarytocreatemappingsforcontact-databases,contact-groupsandcontact-fields.
4.
2.
1DatabasemappingStartwithcreatingadatabasemapbyclickingAddDatabaseMapinthetoprightcorner.
Maintab:Tripolis>Mapping>DatabasemappingThiswillopenfollowingpage:1.
Magentostore:selectthestoreviewforthismapping,donotuseAdmin2.
Mapname:chooseadescriptivenameforthismapping,e.
g.
"Englishshopcontactdatabasemap"3.
TripolisContactDatabase:selectacontactdatabase(ifdropdownisempty,checkconnectionstatus)4.
TripolisWorkspace:selectaWorkspace,necessaryformappingemails5.
Usedfor:2types,contactsortransactions07/25/2016Magentoplugin2.
0manual6Databasemappingscanbeusedforeithercontactsortransactions.
Inthissectionwefocusonthecontactsmapping.
Fortransactions,pleaselookatsection5.
AmappingforcontactswillcreatecontactrecordsinamappedTripolisDialoguedatabase,thiscontactdatabasecanbeusedfore-mailscampaigns.
Eachstoreviewcanbemappedtoit'sowncontactdatabase.
4.
2.
2ContactgroupmappingGroupmappingisnecessarytomapMagento'snewslettersubscribersandunsubscriberstoTripolisDialogue,It'scurrentlytheonlysupportedgrouptype.
Thismappingallowsyoutomanageyournewslettersubscribersandunsubscribers,makesuretomapbothgroupsbeforestartinganinitialsync.
Maintab:Tripolis>Mapping>Groupmapping:1.
Magentosourcetype:SelectNewsletter(whichistheonlyoption).
2.
Magentosource:skipthisoption.
3.
Databasemap:selectdatabasemapping.
4.
TripolisGroup:selectagroupinTripolisDialogue.
5.
Usedfor:eithernewslettersubscribersornewsletterunsubscribers.
4.
2.
3ContactfieldmappingContactfieldmappingsareusedtomapfieldsinMagentowithcontactfieldsinTripolisDialogue.
YoucanmapallstandardcustomerfieldsinMagento.
Theonlymandatoryfieldforcontactsmappingisemailbutwerecommendtoalsomap:firstname,lastname.
Maintab:Tripolis>Mapping>Fieldmapping1.
DatabaseMap:selectdatabasemapping.
2.
TripolisField:afterselectingadatabasemapping,thelistofavailableTripolisfieldswillrefresh.
MakesurethattheDialoguecontactdoesnothaveaminimumlength(Min.
lengthshouldbe0orempty).
3.
MagentoSourceType:selectaMagentofieldcategory.
4.
Magentosource:selectasourcefieldtomatchtheselectedTripolisfield.
07/25/2016Magentoplugin2.
0manual74.
3InitialSynchronizationMagentocustomersaresynchronizedtotheTripolisDialoguecontactdatabaseinreal-timeaftercreationorupdateinMagento.
Beforetakingthepluginintoproduction,youneedtorunaninitialsynchronization.
Aftersettingupyourmappings(=database,group,contactfields)youcanclickSynchronizecontactstostartyourinitialsynchronization.
Maintab:Tripolis>StatusAsimilarpromptappears:MakesureNOTtoclosethispromptuntilyouarenotifiedthatthesyncisdone.
Ifforsomereasonanewinitialsyncisrequired,thiscaneasilybedonebyclearingtheclientdataResetallclientdata(mappingswillremainintact).
Andinitiating/clickingSynchronizecontactsagain.
4.
3.
1SubscribingandunsubscribingofcontactsMagentoisleadinginthesubscriptionandunsubscriptionofyournewslettersubscribers.
NewslettersubscriptionsaredoneviatheMagentofrontend.
Whenunsubscribingthroughnewsletters,yourunsubscribelinkshouldlooksimilarto(withoutaesEncrypt):http://MYMAGENTOHOST.
COM/index.
php/tripolis/subscriber/unsubscribe/email=${contact.
email}.
WewouldrecommendyouhowevertoencryptyourcontactdetailswithaesEncrypt(Section7.
2),similarto:http://MYMAGENTOHOST.
COM/index.
php/tripolis/subscriber/unsubscribe/email=${contact.
emailaesEncrypt(%278KNamWenYUeXpNOj%27,%27ziHV1baRH9ooTOCw%27)}.
07/25/2016Magentoplugin2.
0manual85TransactionalemailsForsendingtransactionalemailsthepluginusesaseparatedatabaseinTripolisDialogue(ormultipledatabasesiftherearemultiplestoreviews).
Thisdatabasewillnotcontaincontacts,buttransactionalrecords.
Forthisyoucanmakeadatabasemappingoftype"transactions"(Section4.
2.
1)andthedesiredfieldmappingsforthisdatabasemap(Section5.
1).
Touseallsortsoftransactionalinformationinyouremails,youcancreatefeedsfromMagento(Section6.
2)InaWorkspaceconnectedtothisdatabaseyoucancreatetransactionalemailsandmapthesetoexistingemailsinthewebshop(Section5.
2).
Foreachtransactionalevent,thepluginwillcreateatransactionalrecordandsendtheemailmappedtothisevent.
5.
1TransactionalfieldmappingMakesureyouhaveacreatedatransactionaldatabasemappingbeforecreatingtransactionalfieldmappings.
Tripolis>Mapping>TransactionalmappingIfyouuseatransactionaldatabase,thefollowingMagentoSourceattributesarerequiredtoenablethesynchronizationoftransactionalrecords:-TransactionId(type:String).
-Transaction(type:String).
-MagentoObjectId(type:String).
-Email(type:Email).
Ifyouaremakinguseofupdateemails(e.
g.
OrderUpdate,ShipmentUpdate,InvoiceUpdate)youshouldalsomaptheCommentattribute(toaStringfieldInTripolisDialogue),thisfieldisforcomment(s)thatwilltriggerupdateemails.
TimestampattributeshouldbemappedwithadatetimetypefieldinTripolisDialogueforadditionalloggingoftransactionalrecords.
07/25/2016Magentoplugin2.
0manual95.
2EmailMappingTohaveTripolisDialoguesendemailsinsteadofMagentoyouneedtomapMagento'sdefaultemailswith(direct)emaileditionsinDialogue.
Amappingfortransactionswillcreatetransactionalrecordsinamappeddatabase.
Theserecordscanbeusedforallsortsoftransactionalemails.
Atransactionrecordcanbeaninvoice,aconfirmation,anordermail,etc.
Itisonlypossibletocreateonemappingfortransactionsforeachstoreview.
Defaultmail-templates:1.
AbandonedCart2.
CreditMemoupdate3.
CreditMemoupdateforGuest4.
Invoiceupdate5.
InvoiceupdateforGuest6.
NewCreditMemo7.
NewCreditMemoforGuest8.
Newinvoice9.
NewinvoiceforGuest10.
NewShipment11.
NewShipmentforGuest12.
Newaccount13.
Newaccountconfirmationkey14.
Newaccountconfirmed15.
Newslettersubscriptionconfirmation16.
Newslettersubscriptionsuccess17.
Newsletterunsubscriptionsuccess18.
Orderupdate19.
OrderupdateforGuest20.
Sendproducttoafriend21.
ShareWishlist22.
Shipmentupdate23.
ShipmentupdateforGuestLikegroupandfieldmappings,emailmappingsarealsobasedonadatabasemapping,aworkspaceneedstobedefinedhowever,inordertomapdirectemaileditions(newslettersarenotmappable).
Passwordreset,notificationandreportemailsforinternalusecannotbesentthroughTripolisDialogue.
07/25/2016Magentoplugin2.
0manual10Maintab:Tripolis>Mapping>Emailmapping1.
Magentostore:selectastoreviewforwhichyouwanttomapatransactionalemail.
2.
MagentoEmailTemplate:selecttheMagentoemailtemplateyouwouldliketomap.
3.
DatabaseMap:selectthedatabasemap,whichcontainstheworkspacewithyourdirectemailtemplates4.
DirectEmailType:selecttheTripolisDialoguedirectemailtypeofthedirectemailedition.
5.
DirectEmail:selecttheTripolisDialoguedirectemailedition6.
EnableTripolisEmail:bydefaultsetto'Yes'.
7.
DisableMagentoEmail:bydefaultsetto'Yes'07/25/2016Magentoplugin2.
0manual116UseoffeedsandconfigurationsettingsThepluginisabletocreatexmlfeedsofcustomer,productandtransactionalinformation.
WiththesefeedsTripolisDialoguecancreatepersonalizedemailswithreal-timeinformationfromtheMagentowebshop.
KeepinmindthatusingfeedsforlargemailingsresultsinanincreasedloadforyourMagentoserver.
6.
1SecurityThepluginofferstwolevelsofsecuritytopreventunauthorizedaccesstothefeed'scontent.
6.
1.
1IPrestrictionoffeedsInyourconfigurationsettingsyoucanenteracomma-separatedlistofIPaddressesthatwillhaveexclusiveaccesstothefeeds.
TripolisSupportcanprovidetheIPaddressesusedbyyourTripolisDialogueinstance.
AdditionallyyoucouldaddyourownIPaddressfortestingpurposes.
Maintab:Configuration>Tripolis(leftmenuitem:Symfony|Modules)>FeedsettingsUsingtheIPrestrictionisnotrequired,howeverwestronglyrecommenddoingso.
6.
1.
2FeeduserrestrictionFeedscanonlybeaccessediftheURLofthefeedcontainsavalidsecuritykey.
Tocreateakeyyouneedtoregisteratleastonefeeduser.
Maintab:Tripolis>Feeds>UsersOpens:6.
2URLGenerator/FeedtypesTheplugincontainsaURLGeneratorthatcreatesaURLforacertainfeedtype.
Whenselectingdetailsforthefeed,theURLwillbuildupaccordingly.
AvailableFeeds:1.
Customer2.
Product(Singleproduct,Lastaddedproducts,Specialprice,Bestsellingproducts,Mostviewedproducts,Relatedtocustomerpurchases,Randomproducts)3.
Quote4.
Singleorder5.
Invoice6.
Shipment7.
Creditmemo8.
Sendtofriend9.
Sendwishlist07/25/2016Magentoplugin2.
0manual12TouseanxmlURLinaTripolisDialogueemailitispossibletoreplacecertainelementswithcontactmergefields,articlefieldsorotherFreeMarkervariablescomingfromcontactfieldsinyourdatabase.
Tripolis>Feeds>URLGeneratorFirst,selectaFeeduser.
Ifyouhaven'tcreatedoneyouwillbedirectedtotheNewFeedUserpage.
Next,selectaFeedtype:Whileselectingoptionsandenteringvalues,theExampleURLwillinstantbuildupaccordingly.
6.
2.
1CustomerfeedWiththisfeedyoucanaccessMagentocustomerdetails.
Thesesettingswillcreateafeedforcustomer139,like:http://MYMAGENTOHOST.
COM/index.
php/tripolis/feed/create/key/7e455b42794996a03c164df9039b4b50/type/customer/customerid/139/Customerid'scanbefoundintwolocations:-Customers>ManageCustomers:inthecolumnIDyoucanfindyourMagentocustomerid-InDialogueinthetransactionaldatabase,thefieldthathasbeenmatchedwithMagentoObjectIdAURLexampleforusingfeedinTripolisDialogue:http://MYMAGENTOHOST.
COM/index.
php/tripolis/feed/create/key/1691ddbcaf5b877545c485cff63d513b/type/customer/customerid/${contact.
customer_id}07/25/2016Magentoplugin2.
0manual136.
2.
2ProductfeedTheproductfeedcanbeusedtoloadproductsfromtheMagentodatabase.
Thereareafewlimitationshowever:-OnlyproductswithvisibilitysettoCatalog,Search,orCatalog&Searchcanbeloaded.
-OnlyproductsthataresettoEnabledandareinstockcanbeloaded.
Genericsettings:Theproductfeedisawrapperforalltheproductrelatedfeeds.
-Storeview:foreachfeedyouwillneedtoselectastoreview,asproductnamesanddescriptionsmayvary.
-Specifyamaximumnumberofproductstobeincluded,setthevalueof'Howmanyproducts'.
-Allproductfeedscanbefilteredbycategory.
Productselection:-Singleproduct:feedofonesingleproduct,youcanuseeitherSKUorproductIdtospecifywhichproduct.
-Lastaddedproducts:thisfeedwillprovidethemostrecentaddedproducts.
-Bestsellingproducts:thisfeedwillcontainthebestsellingproducts.
Currentlythisselectionisbasedonalltimesales.
-Mostviewedproducts:thisfeedwillcontainthemostviewedproducts.
Currentlythisselectionisbasedonalltimeviews.
-Relatedtocustomerpurchases:thisfeedalsorequiresacustomerId.
Productsrelatedtoproductswhichthecustomerhasboughtwillbeincludedinthisfeed.
-Randomproducts:asthenamesuggests,thisfeedwillcontainrandomproductsfortheselectedstoreviewandifspecifiedtheselectedcategory.
6.
2.
3QuotefeedThisfeedcanbeusedtofetchtheitemsofanabandonedshoppingcart.
QuoteidcanbefoundinthecontactfieldthatismappedwithMagento'sMagentoObjectId.
07/25/2016Magentoplugin2.
0manual146.
2.
4SingleorderfeedTheorderfeedrequireseithertheorder'sMagentoIdortheorder'sincrementid.
TheincrementidistheiddisplayedontheorderoverviewpageinMagento.
However,theorderidistheidintheDialoguefield(inthetransactionaldatabase)thathasbeenmatchedwithMagentoObjectId.
Itisalsopossibletomaptheincrementidtoyourtransactionalcontactdatabase,thereforetheorderfeedhasbeenconfiguredtoacceptboth.
6.
2.
5InvoicefeedTheInvoicefeedonlyrequiresaninvoiceid.
ThisIdcanbefetchedfromDialogueinthetransactionaldatabase:thesamefieldthathasbeenmatchedwithMagentoObjectId.
6.
2.
6ShipmentfeedTheshipmentfeedonlyrequiresashipmentid.
ThisIdcanbefetchedfromDialogueinthetransactionaldatabase:thesamefieldthathasbeenmatchedwithMagentoObjectId.
6.
2.
7CreditmemofeedTheCreditmemofeedonlyrequiresacreditmemoId.
ThisIdcanbefetchedfromDialogueinthetransactionaldatabase:thesamefieldthathasbeenmatchedwithMagentoObjectId.
07/25/2016Magentoplugin2.
0manual156.
2.
8SendtoafriendfeedUsuallywhenMagentosendsasendtofriendemailthecontentforthatemailisdirectlywrittenintotheemailtemplate.
Sincewearenotabletodosowestorethiscontentintoadatabase.
Thisfeedcanbeusedtoaccessthatcontent.
ThesendtofriendidcanbefetchedfromDialogueinthetransactionaldatabase:thesamefieldthathasbeenmatchedwithMagentoObjectId.
6.
2.
9SendwishlistfeedTheSendwishlistfeedissimilartothesendtofriendfeedtypeandmakesuseofthesametypeofid.
Thedifferenceisthatinsteadofsendingaproductacustomerissendinghisorherwishlisttoafriend.
6.
3Abandonedcartfeed/functionalityTheabandonedcartfeatureenablesyoutosendareminderemailtocustomerswhohaveaddeditemstotheirshoppingcartbuthaven'tcompletedtheorderprocess.
ThisfunctionalitycanbeenabledthroughtheAbandonedcartsettings:System>Configuration>Tripolis(leftmenuitem:Symfony|Modules)>AbandonedcartSetSendabandonedcartmailingstoYestoenabletheAbandonedcartfeature.
Schedulestandsfortheexpirationtimeofashoppingcart(consideredas'abandoned')Cronspeed:frequency/speedofyourcronjob(ScheduledTask),oftheserverMagentorunson.
07/25/2016Magentoplugin2.
0manual16MappingofAbandonedcartemailtemplate:Tripolis>Mapping>EmailmappingYouwillneedtomapthiscustomtemplatetoaTripolisDirectEmailtemplate.
07/25/2016Magentoplugin2.
0manual177Appendix7.
1LoglevelChoosebetweenErrorsonly,Errorsandnoticesonly,andEverything.
Errorsonlyiscustom.
7.
2EmailObjectEncryptionsettingsAllvaluesinURL'scanbeencryptedwithaesEncrypt('',')Anunsubscribeexample:http://MYMAGENTOHOST.
COM/index.
php/subscriber/unsubscribe/email=${contact.
emailaesEncrypt('8KNamWenYUeXpNOj','ziHV1baRH9ooTOCw')}EnterthesamevaluesyouusedaskeyandsaltinTripolisDialoguetoencryptanemailaddressheresothatthemodulecandecryptthevalue.
TheRunTestbuttonwillcheckifbothvalueshavealengthofexactly16characters.
Tripolis>Configuration>Settings