51
Shop Manager Manual ConfigBox 2.6 for Joomla www.rovexo.com

ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

  • Upload
    others

  • View
    1

  • Download
    0

Embed Size (px)

Citation preview

Page 1: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

ShopManagerManual

ConfigBox2.6forJoomla

www.rovexo.com

Page 2: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page2

TableofContents

1 INTRODUCTION..............................................................................................................5

2 INSTALLATION/UPGRADE...............................................................................................6

2.1 HowtocheckifionCubeLoaderisinstalled....................................................................................................62.1.1 WhattodoifionCubeLoaderisnotinstalled......................................................................................................................62.1.2 InwhichfoldersdoIneedionCubeloadertobeactive?.................................................................................................6

2.2 Installation/upgradeprocedure..........................................................................................................................62.2.1 UpgradingforPHP7.xcompatibility.......................................................................................................................................7

2.3 Stepsafterinstallation............................................................................................................................................72.3.1 ActivationofJoomlaplugins........................................................................................................................................................72.3.2 Customergroupsetup....................................................................................................................................................................72.3.3 Setupofusergrouppermissions...............................................................................................................................................72.3.4 Allowuserregistration..................................................................................................................................................................82.3.5 Enteryourbusinessinformation...............................................................................................................................................92.3.6 Enteranemailaddressfornotificationsaboutreviews..................................................................................................92.3.7 Checktaxsettingsforyourcountry.........................................................................................................................................9

2.4 IntegrationofConfigBoxinJoomla.....................................................................................................................92.4.1 ConfigBoxMenuItemTypes........................................................................................................................................................92.4.2 NativeSEFURLs.............................................................................................................................................................................10

3 CONFIGURATOR...........................................................................................................11

3.1 Basics...........................................................................................................................................................................113.1.1 Languages.........................................................................................................................................................................................113.1.2 ProductListings.............................................................................................................................................................................113.1.3 Products.............................................................................................................................................................................................113.1.4 ConfiguratorPages.......................................................................................................................................................................143.1.5 Elements............................................................................................................................................................................................153.1.6 Optionsandtheirassignmenttoelements.........................................................................................................................16

3.2 CompatibilityRules................................................................................................................................................18

3.3 Calculations...............................................................................................................................................................193.3.1 CalculationusingMatrices........................................................................................................................................................193.3.2 CalculationusingaFormula.....................................................................................................................................................213.3.3 CalculationsusingtheCalculationEditor...........................................................................................................................22

3.4 One-timePricesandRecurringPrices.............................................................................................................22

3.5 ProductVisualization............................................................................................................................................26

4 ORDERMANAGEMENT.................................................................................................27

4.1 Cartpage.....................................................................................................................................................................274.1.1 Controlwhatacustomercandoonthecartpage...........................................................................................................27

Page 3: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page3

4.1.2 SettheContinueShoppinglisting..........................................................................................................................................27

4.2 CustomerData..........................................................................................................................................................28

4.3 CustomerGroups.....................................................................................................................................................284.3.1 Associatedplatformgroup........................................................................................................................................................294.3.2 Taxdisplaymode...........................................................................................................................................................................294.3.3 Controldisplayofprices.............................................................................................................................................................294.3.4 Discountlevels................................................................................................................................................................................29

4.4 ShippingManagement...........................................................................................................................................29

4.5 PaymentMethods....................................................................................................................................................304.5.1 Bundledconnectorstoonlinepaymentserviceproviders.........................................................................................30

4.6 EmailNotifications..................................................................................................................................................314.6.1 NotificationSnippets....................................................................................................................................................................32

4.7 Invoices.......................................................................................................................................................................324.7.1 Invoicelayoutandcontent........................................................................................................................................................324.7.2 ConfigurationofInvoicing.........................................................................................................................................................32

4.8 GoogleAnalyticsTrackingandReporting......................................................................................................344.8.1 Prerequisites...................................................................................................................................................................................344.8.2 GoogleAnalyticsE-commerceTracking..............................................................................................................................354.8.3 UseofGoogleAnalyticsgoals...................................................................................................................................................36

4.9 Reviews.......................................................................................................................................................................37

4.10 CountriesandShipping.........................................................................................................................................374.10.1 TaxHandlingforCitiesandStates.........................................................................................................................................374.10.2 PredefinedCities............................................................................................................................................................................37

4.11 UsingIPGeolocationtoprefillcustomerdataandotherpurposes.......................................................37

5 CUSTOMIZINGCONFIGBOX..........................................................................................38

5.1 CustomQuotationPDFs........................................................................................................................................38

5.2 CustomWordingandTranslations...................................................................................................................395.2.1 Understandingtheconceptoflanguagefiles....................................................................................................................395.2.2 Workflowtofindandcustomizeaphrase..........................................................................................................................40

5.3 CustomBehaviorofElements.............................................................................................................................40

5.4 CustomFields...........................................................................................................................................................41

5.5 CustomCSSstyling..................................................................................................................................................41

5.6 CustomJavaScript...................................................................................................................................................42

5.7 CustomTemplates..................................................................................................................................................42

5.8 CustomTemplatesforSpecificListings,Products,PagesandElements..............................................44

5.9 CustomConnectors.................................................................................................................................................45

Page 4: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page4

5.10 CustomNotificationsnippets..............................................................................................................................47

6 NOTESFORCONFIGBOXUPGRADES.............................................................................48

6.1 UpgradefromConfigBoxversionspriorversion2.2...................................................................................48

7 TROUBLESHOOTING.....................................................................................................48

7.1 PricingandProductVisualizationdoesnotupdate....................................................................................48

7.2 Theinstallationfailedanduninstallationisnotpossible.........................................................................49

7.3 Paymentmethodchangesarenoteffective...................................................................................................49

7.4 IssueswithSH404SEF............................................................................................................................................49

7.5 Anerrormessageoccurredafteruploadingapackage.............................................................................50

8 EXTENSIONS.................................................................................................................51

8.1 VirtueMartConnector............................................................................................................................................51

Page 5: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page5

1 Introduction

ConfigBoxisamulti-functionalProductConfiguratorintegratedinJoomlawithorderandcustomermanagementandimplementsacompleteorderandRFQprocess.

ConfigBoxisaflexiblesystemcapableofconfiguringawidescopeofproductsandservicesandisdesignedforcompaniesseekingawaytopresentcomplexproductswithauser-friendlyandtransparentexperience.

TypesofproductsthatarehandledwithConfigBox(non-exhaustive)

• Carsandcarequipment• Printingproducts• Phonecarriercontracts• Blindsandshades• Computersystems• Furniture• Promotionequipment• Analyticalinstruments• Boats

Shopadministrationanddatamaintenance

Thegraphicinterfacesforshopadministrationanddatamaintenancearedesignedforeasylearnabilityanduser-friendlinessandsuitablefortypicalbackofficestaff.Thismanualdescribeseverythingthatisneededforrunningthesoftware.

Page 6: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page6

2 Installation/Upgrade

IMPORTANTNOTE:PLEASEMAKESURETHATTHEPHPEXTENSIONIONCUBELOADERISINSTALLEDONYOURSERVERBEFOREYOUINSTALLCONFIGBOX.

2.1 HowtocheckifionCubeLoaderisinstalled

OnJoomla1.5:Intheadminarea,gotoHelp->SystemInfo->PHPInformationOnJoomla2.5:Intheadminarea,gotoSite->SystemInformation->PHPInformationOnJoomla3.x:Intheadminarea,gotoSystem->SystemInformation->PHPInformation

Inthefirstsectionofthepage,youseeaninformationblocksimilartothisscreenshot(theactuallogoandexacttextdiffersbetweenwebservers):

Ifyouseetheline‘withtheionCubePHPLoader[…]’,yourwebserverhasionCubeloaderinstalled.

2.1.1 WhattodoifionCubeLoaderisnotinstalled

PleaserefertoyourhostingproviderinordertogetionCubeLoaderinstalled.

2.1.2 InwhichfoldersdoIneedionCubeloadertobeactive?

SomehostingprovidershaveionCubeloaderenabledonlyincertainfolders.Ifthat’syourcase,askyourhostingproviderorsystemadmintomaketheloaderenabledforthesefolders:

/(Joomlarootfolder)/administrator//components/com_configbox/

2.2 Installation/upgradeprocedure

Weimploreyoutocreateabackupofyourwebsite’sfilesanddatabasebeforeinstallation/upgrade!Wetestourinstallationpackagesproperly,butwecannotmaketheinstallercheckforeverythingthatcouldgowrong-pleasefarewithcaution.

1) Picktherightinstallerpackagesfromyourdownload:FromtheConfigBoxwebsite,yougotazipfilewithinstallationpackagefiles.UnzipitandfindinstallationpackagesforspecificPHPversions.StartingwithConfigBox2.6.31youhavesetofuniversalpackagesthatworkonPHP5.4to7.2(requiresionCubeLoaderversion10.2).IncaseyoucannotupgradeionCubeLoaderusethepackagesspecifictoyourPHPversion.

2) Installallpackages:GotoExtensions->Manage->Installandinstallthecomponentsfirstthenthemodulesandpluginslast.Ifyoudoanupdate,itisthesame(nevermindthewordinginJoomla,onthe“Install”pageyoualsoupgrade).

3) Activatetheplugins:See2.3.1fordetails.

Page 7: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page7

2.2.1 UpgradingforPHP7.xcompatibility

WerecommendupgradingionCubeLoadertoversion10.2orhigheranduseConfigBox’universalinstallationpackages.WiththeseyoucanswitchbetweenanyPHPversionfrom5.4to7.2.

2.3 Stepsafterinstallation

2.3.1 ActivationofJoomlaplugins

Whenyouinstallaplugin,itwillbedisabledbydefault.EnablethemusingthePluginManageratExtensions.Searchfor‘ConfigBox’tofindthemeasily.Clickonboththeredsymbolsandyou’redone.

2.3.2 Customergroupsetup

ThisisnotneededforJoomla1.5

GotoSettings->CustomerGroups->DefaultGroupandsetaJoomlausergroupatPlatformGroup(saveonceifalreadyfilledout).Whencustomersgetacustomeraccount,CBcreatesaJoomlauseraccount.ThegroupyoupickwillbetheirJoomlagroup.Pickagroupwiththerightpermission(usePublicorRegisteredifyouarenotsure).

MakesurethatthisgrouphaspermissiontologintothesiteatJoomla->System->GlobalConfiguration->Permissions.See2.3.3fordetails.

2.3.3 Setupofusergrouppermissions

ThisisnotneededforJoomla1.5

Whenacustomerrequestsaquotationorbuyssomethinginthestore,ConfigBoxcreatesacustomeraccountandaJoomlauseraccount(and‘connects’those).CustomerswillbeabletologinusingJoomlaloginformsorConfigBoxloginforms.

SinceJoomla2.5afewsettingsarenecessarytomakeallthatwork:

Page 8: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page8

AllowSiteLoginfortheJoomlaguestusergroup

OnJoomla2.5

OnJoomla3.x

AtSystem->GlobalConfiguration->Permissionsyouneedtoallowtheguestusergroup(bydefaultcalled‘Public’tologintothesite.ThisenablesConfigBoxtoautomaticallyloginusersafterarequestforquotationorcustomerdataentry.

AllowSiteLoginforusergroupsassociatedwithcustomergroups

IfyoucreatemultipleConfigBoxcustomergroups,besuretodothesamefortheassociatedJoomlausergroup.

2.3.4 Allowuserregistration

GotoSystem->GlobalConfiguration->Usersandset“AllowUserRegistration”to“Yes”and“NewUserAccountActivation”to“None”.

Page 9: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page9

2.3.5 Enteryourbusinessinformation

AtStoreInformationyouneedtoenterinformationrelatedtoyourbusiness.Thisinformationisusedforquotationheaders,invoices,paymentserviceprovidersetc.

2.3.6 Enteranemailaddressfornotificationsaboutreviews

Toreceivenotificationwhenacustomermadeaproductreview,enteranemailaddressatSettings->Reviews.

2.3.7 Checktaxsettingsforyourcountry

Bydefault,Austriaisassumedtobethestore’scountry.VATischargedforcustomersinAustriaandcustomersfromotherEUcountriesareVATfree(unlesstheyprovideaVATIN).Youcanchangethistoworkforyourcountry,todoitgotoCountriesandDelivery->CountriesandchangethesettingsforAustriaandyourcountry.

2.4 IntegrationofConfigBoxinJoomla

TodisplayConfigBoxpagesonyourwebsite,youusemenuitemsjustasanyothercomponent.

Goto“Menus–YourMenu”andclick“New”,thenchoosethemenutype.ConfigBoxoffersmultiplemenuitemtypeswithparameters.Themostimportantoneisthetype“ConfigBox–ProductListing”whichwillshowallyourproductsoralistingofcertainproducts(groupedbyproductlistings).

2.4.1 ConfigBoxMenuItemTypes• ConfigBox–ConfiguratorPage

Alinktoaconfiguratorpageofaproduct.• ConfigBox–Cart

LinktotheConfigBoxshoppingcart.• ConfigBox–ProductDetails

Linktoadefinedproductdetailspage.• ConfigBox–ProductListing

Linktoapagethatshowsallyourproductsorproductsofacertainlistingifdefined.• OrderManagement–RefundPolicyPage

LinktotheRPasdefinedintheShopDataofConfigBoxOrderManagement.• OrderManagement–TermsandConditions

LinktotheTOCasdefinedintheShopData.

Page 10: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page10

• OrderManagement–CustomerProfilePage• OrderManagement–EditProfilePage• OrderManagement–LoginForm(youcanalsouseastandardJoomlaloginform)• OrderManagement–RegisterForm(youcanalsouseastandardJoomlaregistrationform)

2.4.2 NativeSEFURLs

ConfigBoxusestheJoomlaframeworktocreateSEFURLs.TheuseofthirdpartytoolstomanipulateURLsisnotsupportedandwerecommenddisablingthemforConfigBoxandOrderManagementpages.

Importantnote:YouneedtoenableSearchEngineFriendlyURLsintheJoomlaGlobalConfigurationtobenefitfromConfigBoxSEFURLs.

HowConfigBoxSEF-URLsarebuilt

ConfigBoxanalysesthemenuitemstructureanddeterminestheoptimalSEF-URLforpages.Ingeneralitusesthemostspecificmenuitem.Whentwoequallyspecificmenuitemsarefound,parentmenuitemsofthecurrentpageareprioritized.Inthefollowingyouseetheorderinwhichpagesarechecked.

Productlistings:

• Menuitemoftype‘ProductListing’withamatchinglistingid• Menuitemoftype‘ProductListing’withnodefinedlistingid

ProductPage:

• Menuitemoftype‘ProductPage’withamatchingproductid• Menuitemoftype‘ProductListing’thatcontainstheproduct(productaliasisappended)• Menuitemoftype‘ProductListing’withnodefinedlistingid(productaliasisappended)

Configuratorpage:

• Menuitemoftype‘ConfiguratorPage’withamatchingpageid• Menuitemoftype‘ConfiguratorPage’withamatchingproductid(pagealiasisappended)• Menuitemoftype‘ProductPage’withamatchingproductid(pagealiasisappended)• Menuitemoftype‘ProductListing’thatcontainstheproduct(productandpagealiasisappended)• Menuitemoftype‘ProductListing’withnodefinedlistingid(productandpagealiasisappended)

Page 11: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page11

3 Configurator

3.1 Basics

3.1.1 Languages

Tousemultiplelanguagesintheconfigurator,youneedtohavesetcontentlanguagesinJoomla(SeeExtensions->LanguageManager->TabContent.YouthenchoosethelanguagestouseintheconfiguratoratConfigBox->Settings->Languages.

Stepbystep:

• InstallthelanguagepackintheJoomlalanguagemanager(Extensions->LanguageManager)• Addthecontentlanguageforthislanguage(Extensions->LanguageManager>Content)• ActivatethelanguageinConfigBox(ConfigBox->Settings->ActiveLanguages).

Important:MakesureyouhavesetthelanguagetagcorrectlythefirsttimeintheJoomlalanguagemanager.Changingthelanguagetag(e.g.en-GB,de-DEetc.)laterwillmakealltranslationsinConfigBoxdisappearsincethetagconnectstheJoomlalanguagewiththeConfigBoxlanguage.

ConfigBoxhasthelanguagesGermanandEnglishbuiltin.Youcanaddtranslationsyourself;youfinddetailedinformationonhowtodoitinthechapter6.2.3‘Addingalanguage’.

3.1.2 ProductListings

Productlistingsareusedtodisplayproductstogetheronoverviewpages(likehouseholdgoods,powertoolsoraccessories).Youcanassignproductstolistingsandyoucanassignaproducttomultiplelistings.

Toaddalisting,goto“ConfigBox-ProductListings”andclick“Add”.Setanameandsave.YoucanthenaddamenuitemwiththeJoomlaMenuManagertoshowthelistingonyourwebsite.

3.1.3 Products

Youcansetupproductsthatareconfigurableornon-configurable.Tohaveanon-configurableproduct,additanddonotaddanyconfigurationpagestoit.

Youaddoreditproductsintheproducttreeviewonthelefthandsideoftheadminarea.Youcanexpandeachentryandyouseelinkstoaddproducts,pages,elementsandoptions.

Youcandragpagesandelementstoadjustordering.

Page 12: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page12

3.1.3.1 Display->ProductAlias

TheproductaliasisusedforSEFURLs(seesection‘HowConfigBoxgeneratesSEFURLs’)andhastoconsistofcharactersthatarevalidforURLs(ifyouareunsure,usea-z,0-9andminusonly).

3.1.3.2 BasepriceandBasepricerecurring

Atthissectionyoucanassignabasepriceonwhichallextrasduringconfigurationareaddedto.

Withapricelabelyoucandecorateyourprice,especiallyusefulifyouusesetupandrecurringcostsinparallel.Withacustompricetext,youcanpresentapricewithyourownwordingandinsertthepricevalueusingtheplaceholder%s.Thisenablesyoutodisplayyourpriceas‘Startingfrom€100’.

3.1.3.3 ProductDescription

Productdescriptionsareshownintheproductlistinganddetailspage.Youhaveseparateproductlistingdescriptionandproductdetailsdescription.Ifyouset‘Useproductdetailsdescriptionastemplate`,allyourenteredHTMLwillbeusedas-isintheproductdetailsgivingyoufullcontroloverthelayout.Youcanthenuseplaceholdersfordynamicfieldslikepriceand‘addtocart’or‘configure’buttons.Seethefield’stooltipfortheplaceholdernames.

3.1.3.4 Productdetailpanes

Withproductdetailpanesyoushowproductdetailssegmentedinatabbedinterface.Youcanchoosetodisplaytheproductdetailsinproductpagesandconfiguratorpages.

Page 13: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page13

Exampleproductdetailpanes

Theseareexampleproductdetailpanes.Actualfont-sizes,colorsandboxwidthsmayvaryandmaybeinfluencedbythewebsite´sstyling.

Listingofproductdetailpanesinproductdataentryform

Importantnote:Ifyoujustaddedanewproduct,saveoncebeforeyouaddproductdetailpanes.

Youcanenterheading,anoptionalicon,CSSclassesandHTMLcontent.CSSclassesenablewebdesignerstosetspecificstylingforheadingsandpanecontents.

Customizationofproductdetailslocation

Tochangetheareawhereproductdetailsaredisplayed,create/edityourcustomproductorconfiguratorpagetemplateandadd/movethissnippet:

<?php if ($this->showProductDetailPanes) { ?> <div class="product-detail-panes-wrapper"><?php echo $this->productDetailPanes; ?></div> <?php } ?>

Page 14: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page14

3.1.3.5 ProductVisualization

Ifyouliketoshowaproductvisualizationinconfiguratorpages,thecart,thePDF-quotationandorderconfirmation,setupthedimensionsofthevisualization.Visualizationimagesofoneproductshouldhavethesamedimensions.

Displayofthevisualizationinconfiguratorpages:InJoomlayouusethemodulecalled‘ConfigBoxProductVisualization’(mod_configboximages)andpositionitattheJoomlatemplatepositionofyourchoice.Alternativelyyoucanusethissnippetinconfiguratorpagetemplates:

<?php $view = KenedoView::getView('ConfigboxViewBlockVisualization'); $view->display(); ?>

ImportantNote:Youneedtosetthedimensionsoftheproductvisualizationintheproducteditscreen(sectionProductVisualization).Otherwiseitwillnotbevisible.

3.1.3.6 Selectionoverviewonconfiguratorpages

Theselectionoverviewisthepricemodulethatyoucanshowonconfiguratorpages.Itsummarizestheconfiguration,showspricingandtaxesandcanhavecartandquotationrequestbuttons.

Theoverviewisconfigurable.Youhaveglobalsettingsinthesettingspage,andsettingsspecifictoaproductintheproducteditscreen.

Displayoftheselectionoverviewinconfiguratorpages:InJoomlayouusethemodulecalled‘ConfigBoxSelectionOverview’(mod_configboxprices)andpositionitintheJoomlatemplatepositionofyourchoice.Alternativelyyoucanusethissnippetincustomtemplatesforconfiguratorpages(seeCustomTemplatesforreference).

<?php $view = KenedoView::getView('ConfigboxViewBlockPricing'); $view->display(); ?>

3.1.4 ConfiguratorPages

Note:Configuratorpageswerecalled‘Categories’inpreviousversionsofConfigBox.

Configurationpagesenableyoutocreateaconfiguratorwithmultiplesteps.Ifyouonlyneedonestep,youjustcreateonepage.

3.1.4.1 VisualizationViewKeyword

InVisualizationViewKeywordyouenterakeyword,thesamefieldispresentattheoptionassignmentandenablesyoutoshowdifferentproductvisualizationsoneachpage.Onlyvisualizationimagesthatmatchthevisualizationviewtextoftheconfiguratorpageareshown.

Ifthefieldisempty,onlythevisualizationimageswithemptyfieldsareshown.InpageslikethecartorPDFquotation,theimageswithanemptyvisualizationviewareused.

Page 15: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page15

3.1.4.2 Othersettings

Ifyouliketoblockthecustomerfromgoingtothenextstepifmandatoryelementshavenoselection,check‘Blockcontinuingifmissingelements’.Yousetelementstobemandatoryattheelementscreenlater.

Bydefault,the‘FinishConfiguration’buttonisdisplayedoneachpage,tochangethatactivatetheoption‘Finishbuttononlastpageonly’.

3.1.5 Elements

Yousetupanelementforeachchoicethecustomershallmakeintheconfigurator.

Ifthecustomershouldmakeachoicefromasetofpredefinedoptions,youassignoptionstotheelement(seebottomoftheeditscreenforreference).

Ifthecustomerissupposedtomakeayes/nochoice,youcanassignasingleoptiontodisplayacheckboxorsimplyhave2optionswithyesandnoasyouseefit.

Otherwiseyoucanletthecustomermakeafreeentry.Youcanchooseabetweenvariouswidgetstomakecustomerentriesmorepractical(seeSettingsforCustomEntriesfordetails)andsetvalidationrulestorestrictentries.

3.1.5.1 Settingsforcustomentries

Thesesettingsonlyapplyifyourelementhasnoassignedoptions.Youcanthenuseawidgetforeasiercustomerentryandsetrestrictionsonwhatcanbeenteredforthiselement.

Ifyouliketoallownumbersonly(e.g.formeasuremententries),set‘Allowintegervaluesonly’andoptionallysetaminimumandmaximumvalueanddefaultvalue.

CalculatedMinimumandMaximumValuesallowyoutomaketherestrictionsdynamic,basedonthecurrentconfiguration.CalculationsaredescribedindetailinthemanualsectionCalculations.

3.1.5.2 Widgetsforcustomentries

Therearemultiplewidgetsthatreplacetheregulartextfieldwithamorepracticalinput,dependingonyouruseoftheelement:

• Regulartextfieldortextarea• Calendarfordateentries• Sliderfornumberentries• Fileuploadfieldwithfilevalidation• PopupPickerThePopupPickerisadvanced–YouenteranHTMLtableandInthecellsyouputinatextinsidea<span>Element,whenthecustomerclicksonthetablecell,thevalueinthe<span>willbeenteredinthetextfield

Page 16: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page16

3.1.5.3 PriceCalculationonElements

Importantnote:Youcannotassignoptionstoanelementwithassignedpricecalculations.

Ifyouneedanelementthatonlycalculatesapricewithoutactingasachoiceforthecustomer,thenyoudisable‘Displayelementinconfigurator’.Theelementwillnotbedisplayedasatypicalchoice,butit’stitleandpricewillbedisplayedinoverviews.

Settingupcalculationmodelsisdescribedinthemanualsection‘Calculations.Thepricemultiplicatorisusedtomultiplytheresultofthepricecalculation.

Usingelementpricecalculationisonlyonewaytocalculatepricing.Youcanalsosetpricecalculationsforeachtheassignedoptionifitismorepracticalforyourapplication.

3.1.6 Optionsandtheirassignmenttoelements

Optionsarethechoicesthatthecustomerhasinanelement.

Anoptioncanbeassignedtomultipleelementsinordertoaccommodatestoreswhereoptionsstandforspecificstockitemsandredundantdataentryshouldbeavoided.

Thereforewhenyouassignanoptiontoanelement,youseeacombinededitformforthedataspecifictothisassignment(leftside)andtheoptionitself(rightside).

Page 17: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page17

Aboutusingpricecalculationsinoptionassignments

Withoutapricecalculation,thepricesetintheoptionisused.Ifyouassignapricecalculation,theoption´spricewillbeignored.

AboutVisualizationsettingsintheoptionassignment

TheimageyouuploadatVisualization->VisualizationImagewillbeaddedtotheproductvisualizationifthecustomerselectstheoption.Tocontrolthepositioninthevisualizationstack,enteranumberatthefieldVisualizationStackingOrder(highernumbersmaketheimagestackedhigherup).SeesectionProductVisualizationforreference

WithVisualizationViewKeywordyoudefinewhichvisualizationimagesshouldbeshownonaconfiguratorpage.Thisenablesyoutodisplaymultipleviewsintheconfigurator.Thefieldispresentintheconfiguratorpageandtheoptionassignmentdata.Onlyimageswithmatchingkeywordswillbeshowninthevisualization.Inthecart,PDFquotationandorderpagestheimageswithnokeywordareshown.

CompatibilityRules

Page 18: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page18

Compatibilityrulesenableyoutosetconditionsthathavetobemettoshowtheoption.SeesectionCompatibilityRulesforreference.

3.2 CompatibilityRules

Compatibilityrulesenableyoutosetconditionsforelementsandoptionstobevisibletothecustomer.Thesystemevaluatestheconditionseachtimethecustomermakesaselectionandshows/hidesimmediately.

YousetoreditruleforanelementoroptionbyclickingonthebuttonOpenRuleEditorinRuleintheirrespectiveeditscreens.

YoucanchooseiftheelementsandoptionsshouldbecomehiddenorjustgreyedoutwiththeelementsettingRule->Hideifnotapplying.

Standardoptionscanbeauto-selectedoncetheelementbecomesactiveifyouactivateRule->AutomaticPre-selectionand/orRule->PreselectanyOption.

Youcanchooseifautomaticchanges(becauseofelements/options)needtobeconfirmedbythecustomerwiththesettingRule->Confirmautomaticchanges.

Yousettheconditionsofyourrulewithavisualdraganddropeditor.

Ruleeditor:

Page 19: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page19

1)Pickanelementonthelowerleftsidetoseeallavailableconditionsregardingit.2)Dragtheconditionyouneeduptotheruleareaontop3)Mostconditionshavesettings.Youcanclickonthetext“is”tochangeittoIsnotorenteravalue4)DragcombinatorslikeANDorORtocombineconditions5)Shift-SelectconditionsintheruleareaandclickPutinBracketstocombinethemasonecondition(inordertoimproveclaritywhenconditionsarecombinedwithamixofORsandANDs).

3.3 Calculations

Withcalculationmodelsyoucanimplementcomplexpricingstructureswithnoneedforprogramming.Dependingonthepricinglogicofyourproductsyouseeifpricematrices,formulas,staticoptionpricesoracombinationofallofthemismostsuitable.

Calculationsarealsousedfordynamicweightcalculationofoptionsandfordynamicvalidationofcustomerentriesinelements.

YoucanaddandsetcalculationforeachelementoroptionassignmentinthesectionCalculationsandyoucandisplayalistofallcalculationswiththelinkCalculationsinthesidemenu.

Therearedifferenttypesofcalculationsthatyoucanuseasyouseefitforyourapplication:

• Matrix• FormulaEditor• Formula

Matricesisaclassicpricetableandusefulforcalculatingapricewhenitdependsonthecombinationoftwocustomerchoicesorentries.

TheFormulaEditorenablesyoutocreateformulaswithcustomerentriescustomfielddataofselectedoptions.Italsoenablesyoutoincorporateresultsofothercalculations.

Formulaisatext-basedtoolthatenablesyoutocreateformulasthattheeditorcannotcreate.Itisatoolthatistoughtolearnandmanage,butmayhelpyoutopushtheenvelopewhenyouneedit.

3.3.1 CalculationusingMatrices

Withacalculationmatrix,youchoose2elementsorcalculationsastheaxisparameters.Thecustomer’sselectionforeachoftheelements(ortheresultofthecalculations)willbeusedtolookupthevaluesinthematrixandreturnedastheresultofthecalculation.

Page 20: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page20

Typicalworkflow:

• Addacalculation• ChooseMatrixastype• Chooseanelementforcolumnsandoneforrows(orcalculations)• Pickthevaluesforcolumnandrowsinthegreyfields• Enterthedesiredprices• Addrowsorcolumnsifneeded• Savethemodelandassignittotheoptionassignmentorelementofyourchoice

Advancedsettings:

LookupValue:Typicallyyouwon’thaveapriceforeachpossiblecustomerinput,butscaledprices.ForthisyoucanchangethesettingLookupValue.Usenexthigherornextlowertolookuptheappropriatepriceinthetable.

RoundValues:Ifyouliketohavetheuserinputvaluesroundedyoucandoitwiththissetting.Roundto1meansroundtointegers.Roundto10wouldmeanroundingtofull10s(e.g.15->20).

Multiplicator:Youcanprovideafactortomultiplytheresultofthecalculation.Thisisusefultoaddmarginstosupplierpricesorsimilar.

ElementValueMultiplicator:Hereyoucanchooseanelementwhosevalue(thevalueprovidedbythecustomer)multipliestheresultofthecalculation.

CalculatedMultiplicator:Thisisthesameastheothermultiplicator,buttheresultofanothercalculationisused.

Note:Ifyousetuptextfieldelementsmeantfornumbers,makesureyousetupvalidationoftheuserinputattheelementundersection‘Textfieldsettings’.Thismakessurethepricecalculationwon’tbreakwhencustomersenternon-numericvalues.ConfigBoxautomaticallydealswithdecimalsymbolsfromdifferentlanguages.

Page 21: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page21

3.3.2 CalculationusingaFormula

Calculationformulasfollowasimilarpatternlikethecalculationtables,buthereyoucanuseamathematicalformulawithplaceholdersforcustomerinputandspecifickeywordstoincludemanysettingsfromelementsandoptionsintheformula.

Afteraddinganewcalculationmodel,selectthetype‘Formula’totoggle.Youcanaddupto4placeholdersthatwillbeusedintheformulawiththelettersAtoD.Theplaceholdersgetreplacedwiththevalueenteredbythecustomerforthatelement(orzeroifnoinputisthere).

Importantnote:Alwayspadaplaceholderwithaspace(beforeandafter),sothattheformulacanbeparsedproperly.

Exampleformulas:

(A*B)+C

ElementAttribute(95.selectedOption.assignment_custom_1,0)

Page 22: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page22

3.3.2.1 FormulaKeywords

Youcanusekeywordstousevaluesotherthanuserinputforyourformula(e.g.Totalforthepricetotalofthecurrentproduct).Alistofkeywordsisfoundintheon-screennotesattheformulaeditor.

WiththekeywordElementAttributeyoucanusemetadataofanelementanditsassignedoptions.E.g.useElementAttribute(10.selectionPrice)togetthecurrentpricefortheelementwithID10.YoucanlookupelementIDsattheelementlistscreenorattheplaceholderdropdowns.

YoucanalsoenterPHPcodetomakemorecomplexcalculationshere.AlsothereisanelementclassAPIthatletsyouwriteyourownelementPHPclassesthatoverridethebuilt-inpriceenginetomakeevenmoresophisticatedpricecalculation.Seechapter‘CustomizingConfigBoxandOrderManagement’formoreinfo.

3.3.3 CalculationsusingtheCalculationEditor

Settingupacalculationwiththeeditorworkssimilartotheruleeditor.

Youhaveoperators,numbers,elementvalues,calculationsandassortedfunctionstodragintothecalculationarea.Theentriesinthetextfieldsafteror(e.g.EntryinHeightor..)arefall-backvaluesthatareusedifnoentrywasprovided.Makesureyouusethefall-backwheneveradivisionbyzerocouldoccur.

3.4 One-timePricesandRecurringPrices

ConfigBoxsupportstwosetsofpricesenablingyoutoofferproductsthathaveaone-timefeeandarecurringfee(oreitheroneofthem).Thisenablesyoutoofferproductsthatforinstancehaveamonthlypriceandasetupprice.

Page 23: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page23

Typicalusecases

• Rentaloffers• Webhostingproducts• Phonecontracts

Settingsforone-timepricingandrecurringpricing

Youcanlabeleachpricetypeindividuallyonaper-productbasisanddefineanintervalfortherecurringpayments.

Productpageexampleusingone-timeandrecurringprices

Pricingisdisplayedaccording

Page 24: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page24

Configuratorpagedisplayexample

Page 25: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page25

Selectionoverviewusingone-timeandrecurringpricesandsettings

YoucanconfiguretheselectionoverviewforeachproductindividuallyandsetglobaldefaultsintheConfigBoxconfiguration.

Page 26: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page26

Cartpageshowingone-timeandrecurringprices

3.5 ProductVisualization

Youcanshowavisualrepresentationoftheproductwhicheverwayyourcustomerconfiguresit.Youdisplayitontheconfiguratorpage(andinlaterstepstheimagewillshowuponthecart,checkout,yourbackendandotherplaces).

Basically,ConfigBoxstacksimages(withtransparentbackgrounds)togethertoformtheimage.Wecallthatacompositeproductimage.

Howtomanageyourimages

Productsettings:

Firstyougotoyourproducteditscreenandscrolltothesection‘Productvisualization’.Youuploadabaseimage(optional)anddefinethedimensionsofyourvisualization.Mindthatyoushoulduploadimagesinexactlythosedimensions.

Note:Bestuse24bitPNGimages

Optionsettings:

Ineachoptionofyourelementsyoufindasectioncalled‘Productvisualization’ontheleftsideoftheeditscreen.Uploadanimagethere,itwillbedisplayedonceyourcustomerselectsthegivenoption.

WithVisualizationstackingorderyoucanchooseinwhatordertheimagesshouldbestackedtogether.Highernumbersstackhigherontop.

DisplayoftheConfigurationpage

Usethemodule‘ConfigBox–ProductVisualization’(mod_configboximages)fordisplay.

Page 27: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page27

4 OrderManagement

4.1 Cartpage

4.1.1 Controlwhatacustomercandoonthecartpage

Acustomercanperformthefollowingtasksonthecart

• Requestaquotation• Saveanorder• Checkoutanorder• Requestassistance

Youcancontrolwhichtasksareavailabletothecustomerforeachcustomergroup.YoufindthesettingsinSettings->CustomerGroups.

4.1.2 SettheContinueShoppinglisting

Atthecartandthankyoupagethecustomerseesa‘ContinueShopping’button,leadingtoaproductlistingofyourchoice.YoucansettheproductlistingatSettings->Checkout.

Page 28: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page28

4.2 CustomerData

Youcancontrolwhatdatacanbeenteredandwhichshallbemandatoryinthevariouscustomerdataentryforms.Theseare

• Customerprofiledata• Formforquotationrequests• Formforstoringcartcontents• Formforassistancerequests• Formforecommercecheckouts

AtCustomerFieldsyousetthefieldsthatshallbedisplayedorbeingmandatory.

ImportantNote:Thebillingfields‘FirstName’,‘LastName’,‘Email’,‘Salutation’and‘Country’arerequiredbythesystemandcannotbemadeoptionalorhidden.

4.3 CustomerGroups

YoucanmanagecustomergroupsasSettings->CustomerGroupsandsetadefaultgroupfornewcustomersatSettings->Checkout.

Withcustomergroupsyoucandothefollowing:

• Controlwhatacustomercanseeordointheshopsystem• Setvolumediscountlevels• Setwhichplatformusergroupthegroupisassociatedwith(thatistheusergroupofyourCMSor

ecommercesystem,soJoomlaifyouuseConfigBoxforJoomla).

Page 29: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page29

4.3.1 Associatedplatformgroup

(NotavailableinJoomla1.5)

Youalsoassociatethecustomergroupwithaplatformusergroup.Whenanewcustomeraccountiscreated,aplatformuseriscreatedaswellandwillbeassignedtothatgroup.

Benefits

Youcanusetheplatform´spermissionsystemtosetpermissionsforactionsintheCMSandotherextensionsthatsupportACL.

Importantnote:OnJoomla,youneedtoallowSiteLoginforanyassociatedgroupatSite->Configuration->Permissions.

4.3.2 Taxdisplaymode

Youcancontrolthewaytaxesarehandledthroughoutthesystem.Thereare2modes

B2C–Businesstocustomer

• Intheconfigurator,itempricesaredisplayednet• Inorderoverviews,itempricesaredisplayednetandtaxesarestatedbeforethetotal(PlusX%tax)

B2B–Businesstobusiness

• Intheconfigurator,itempricesaredisplayednet• Inorderoverviews,itempricesaredisplayednetandtaxesarestatedafterthetotal(includingX%tax)

4.3.3 Controldisplayofprices

Youcanhidepricesintheconfiguratorandcartpage.Priceswillstillshowinquotations,emailnotifications(iforderoverviewsareincluded)andcheckoutpages.

4.3.4 Discountlevels

Foreachgroupyoucansetdiscountlevelsfortheproducts.Youhave5levels,eachwithaminimumordervalueandadiscountpercentageorfixedamounttosubtractfromtheproductvalue.Ifadiscountapplies,itwillbeshowninorderoverviewpages.

Importantnote:Thediscountrateneedstobeanegativenumber.

4.4 ShippingManagement

ConfigBoxautomaticallycalculatesshippingcostsfromthetotalweightoftheorder,shippingcountryandchosenshipper.

Setupofzones

AtCountriesandShipping->ShippingZonesyoudefinezonesandassigncountriestothese.Youusethesezonesinshippingratestoenableyoubeabletouseasingleshippingrateformultiplecountriesthathavethesameshippingcosts.

Page 30: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page30

4.5 PaymentMethods

ConfigBoxshipswithvariousconnectorstoonlinepaymentserviceproviders(PSPs)andsupportsofflinebanktransaction(showingathank-you-pagewithbankinformation)andorderswithnoimmediatepayment.InConfigBoxyouaddpaymentmethodswithvarioussettings,choosetheregardingPSP,click‘save’,andconfiguretheconnectoratthesettingsontheright.

4.5.1 Bundledconnectorstoonlinepaymentserviceproviders• Autorize.NetSIM(USAandCanadaonly)• BillSAFEInvoice(Germanyonly)• mPAY24Classic(Autriaonly)• MultiSafepayConnect(Netherlandsandinternational)• PaymillRESTAPI(International)• PayPalPaymentsStandard(International)• PostFinanceBasic,StartupandProfessional(Switzerlandonly)• QuickPay(International)• SagePayServerIntegration(International)• SOFORTÜberweisungClassic(International)• VRPAYVirtuell(Germanyonly)

Page 31: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page31

• WirecardCheckoutPage(International)• WorldPayBusinessGateway(UKandinternational)

SincethewebsiteURLsoftheprovidersareliabletochange,pleaseuseasearchengineforinfoabouttheregardingPSP.IfyouarenotsureyougottherightPSPorproduct,pleaserefertocustomersupport.

WearestrivingtoextendourselectionofPSPintegrations.IfyourequireaspecificPSPintegration,pleasecontactcustomersupportwiththecompanyandproductnameofthePSP.Thishelpsusprioritizing.

4.6 EmailNotifications

Emailnotificationsareautomaticallysentwhenthestatusofanorderchanges.Youdefinewhichnotificationsaresenttothecustomerand/ortotheshopmanagerandwhichsubjectandcontenttheemailshouldcontain.

StoremanageremailsgototheaddressyousetupatStoreInformation->EmailSales.

Enteraninternalnameandchoosetheorderstatusonwhichtheemailshouldbesent.

Page 32: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page32

SubjectandemailHTMListhecontentofyouremail.Youfindalistofavailableplaceholdersontherightsideoftheeditform.

Youfindthesamefunctionalityfortheshop-managernotificationbeneaththeCustomerEmailsettings.

SinceConfigBox2.4.0:Withtheplaceholder{element_order_overview}youcandisplayanoverviewoftheorder.

4.6.1 NotificationSnippets

Withnotificationsnippets,youcaninsertprecompileddatainyournotificationtext.YouaddtheplaceholdersincurlybracketsintheemailHTML.See{element_order_overview}or{element_store_information}forreference.

Importantnote:Toavoidlayoutproblemsinemailclients,placesnippetplaceholdersina<div>element.SelecttheplaceholderandclickFormats->Blocks->Div(seescreenshotbelow).

4.7 Invoices

4.7.1 Invoicelayoutandcontent

AtStoreInformationyoucanchoosetodefineacustominvoicetemplate(otherwiseatemplate-baseddefaultinvoice).Youcaninsertcustomerandorderdatalikeinemailnotifications.Withtheplaceholder{orderitems}youinsertthetablewiththeorderdata.

4.7.2 ConfigurationofInvoicing

Page 33: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page33

InSettings->Invoicingyoucanconfigurethewayinvoicesshallbehandled.

With‘Sendinvoice’activated,yourcustomersgettheirPDFinvoiceperemailassoonastheinvoiceisreleased.

Invoicegeneration

If‘Automaticafterclearance’isactivated,youreleasetheinvoiceintheorderdetailpageatOrderManagement->Orders.Theinvoicewillbeavailableanddownloadablebythecustomerinthecustomerprofilepage.

If‘Automatic’isactivated,invoicesaregeneratedautomaticallyoncethestatusoftheorderissetto‘paid’(manualstatuschangeorstatuschangebyautomatictransactionfeedback).

If‘Aftermanualdownload’isactivated,youuploadaPDFintheorderdetailpage.

Page 34: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page34

Exampleoftheorderdetailpageusing`Aftermanualdownload’

Invoicedownloadlinkincustomerprofilepage

4.8 GoogleAnalyticsTrackingandReporting

4.8.1 Prerequisites

TousetheGoogleAnalyticsintegrationfeaturesofConfigBox,youneedtohaveregularGoogleAnalyticstrackingcodeintegratedinyourwebsiteusingtheasynchronoussyntaxor(sinceConfigBox2.6.26)UniversalAnalytics.

• ForConfigBox2.6.25andearlier:SetupAsynchronousGoogleAnalyticsWebTrackinghttps://developers.google.com/analytics/devguides/collection/gajs/

• ForConfigBox2.6.26andlater:SetupUniversalAnalyticshttps://developers.google.com/analytics/devguides/collection/analyticsjs/

IfyouswitchfromAsynchronoustoUniversalAnalyticstracking,youdonotneedtochangesettingsinConfigBox.

Importantnote:WesupportE-commerceTracking,butNOTEnhancedEcommerceTracking.EnableonlyEcommerceTracking.

Page 35: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page35

4.8.2 GoogleAnalyticsE-commerceTracking

GAE-commerceTrackingisintegratedbydefault.YouneedtoenableE-commerceTrackinginyourGoogleAnalyticsprofileSetting.

• SetupGoogleAnalyticsE-commerceTrackingonyourwebproperty’sprofilehttps://support.google.com/analytics/answer/1009612?hl=en

Important:DonotenableEnhancedE-commerce.Itisnotsupported.

Whendoestrackingtakeplace?

SinceGAE-commercetrackingreliesonthecustomertoreturntotheshopafterpaymentthereisnoguaranteethatthetrackingwilltakeplace.ConfigBoxraisestheprobabilitybyschedulingthetrackingforthenextvisittoaConfigBoxshoppage(giventhecustomerlogsin).

Thereare2scenarios:

• Customerreturnstotheorderpageafterpayment:Trackingtakesplaceimmediately.

Page 36: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page36

• Customerdoesnotreturnafterpaymentortherightorderstatusissetmanually:Trackingwillbescheduledforthenexttimethecustomervisitsandlogsin.Caveat:Thedateofpurchasewillbethetrackingdate(GAE-commerceTrackinglimitation),distortingstatisticstosomeextend.

4.8.3 UseofGoogleAnalyticsgoals

IfyousetupagoalforanalyzingconversioninGoogleAnalytics,youcanuseeventtrackingasgoaltype.Thegoalvalueisthetotalpayableamount(includingmerchandiseprice,shipping,paymentfeeandtaxes;incaseofdepositpaymentonlythedepositpaymentisused).

Importantnotes:Pleasenotethatonlypaidordersaretracked;e.g.orderswithstatuschangeto‘ordered’arenottracked.Weplantoextendthegoalintegrationtootherorderstatusesinthefuture.AlsotheeventistrackedonthesameconditionsasE-commerceTracking(seeGoogleAnalyticsE-commerceTracking).

SetupinGoogleAnalyticsProfile:

GoalType:

Event

Category:

configbox_goals

Action:

order_payment

Label:

leaveempty

Value:

leaveempty

GoalValue:

Usetheactualeventvalue

Alwaysuse‘thatisequalto’

Page 37: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page37

4.9 Reviews

Customerscanwritereviewsandsetratingsonproductsandoptions.YouenableordisablereviewsgloballyatConfigBox->Configuration->Reviewsorenableordisablethemforspecificproductsoroptionsattheproductoroptionsettings.

Newreviewsareinactiveinitiallyandneedtobeapproved.Anotificationemailonnewreviewsisdispatchedtoalertstaff.

AtSettings->Reviewsyouenterthenotificationemailaddress.

AtReviewsyouhavealistofallreviewswhereyoucanfilter,approveandeditreviews.

4.10 CountriesandShipping

Besidesshippingmanagement,inthescreensforCountriesandShippingyousetupallavailablecountries,states,countiesandcities.CountriesandStatesarepre-filledoutofthebox,ifyouwanttomakethecustomerchoosehiscountyorhavehimselectacityinsteadofenteringthecityname,youcanaddthisinformation.

4.10.1 TaxHandlingforCitiesandStatesForeachcountry(orstate)youcandefineifVAThastobecharged(forcountriesyoualsodefineifitshallbechargedonlyifaVAT-INwassupplied).IncountriesandstatesyoucanalsoOVERRIDEthetaxrateforeachtaxclassyouhavesetup.IncountiesandcitiesyoucanenterapercentagethatwillbeADDEDtothecountry/statetaxrate.ThisaccommodatesthetaxsystemfortheUnitedStates,Canadaandothercountries.Pleasenotethattheindividualtaxesarenotdisplayedseparately,butasonecompoundtaxrate.

4.10.2 PredefinedCitiesAddingcitiesatCountriesandShipping->Citiesforcesthecustomertoselectacityfromasearchabledrop-downlistinsteadoflettinghimenterthecitynameinatextfield.Citiesareconnectedtocounties,soyouneedtoentercountiesandtheircities.Pleasenotethatyouneedtohaveacompletecitylistforacounty,otherwisecustomersfromothercitiescannotorderorrequestquotes.Youcanhaveamixofcountieswithandwithoutpredefinedcities.Theformswillshowtheappropriateformfieldasthecustomerselectsthecounty.

PleasenotethatIPGeolocationcannotdeterminethecountyinanycaseandcannotdeterminethecityifyouusepredefinedcities.

4.11 UsingIPGeolocationtoprefillcustomerdataandotherpurposes

ConfigBoxenablesyoutohavecustomerformsprefilledtothebestextendpossible.ThisfeaturecoversRFQforms,saveorderformsandthecheckout.YouneedanaccountandacontingentforGeoIP2Precision:CitywithMaxMind(https://www.maxmind.com/),atrustedandindustry-leadingproviderofIP-Geolocationdata.

Asof2015-02-26thelinktothepurchasepageis:

https://www.maxmind.com/en/geoip2-precision-city-service

Yougetalicensekey(informofatext-code)byMaxMind.YouenteritatConfigBox->Settings->IPGeolocationTracking->MaxMindLicenseKey,thenactivatethefeature.

Page 38: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page38

5 CustomizingConfigBox

CustomizationofConfigBoxisstraightforward,wellorganized,requiresnomodificationofthebasesoftwareandenablesyoutomakeprofoundextensionsandmodificationstofunctionalityofthesoftware:

• Designofproductsandconfigurators• Individualconfiguratordesignsforeachproduct• Outputofcustom,non-standardproductdata• Modificationandextensionofthebasefunctionality• Customizationofwordingusedintheapplication• Translationinnon-bundledlanguages• Integrationwiththirdpartysoftware

Important:

Anycustomizationyoumakeordelegateneedstobecheckedforcompatibilityonsoftwareupdatesandrevisedifnecessary.Onminorsoftwareupdateswemakeanefforttominimizebreakingchangesandifneedbeprovidedetailedinformationaboutthemonourwebsite(onthedownloadpageforeachversion).

Formajorsoftwareupdates(e.g.2.6to2.7)youneedtobepreparedforacompleterewriteasworst-casescenario.

5.1 CustomQuotationPDFs

NoteforcustomersusingcustomquotePDFsinversionsbefore2.6:AsopposedtoearlierreleasesofConfigBox,itisnolongernecessarytooverridebothPDFdownloadandPDFattachment.

YoucanoverridetheoutputofquotationPDFsinthesamewayasothertemplates(seeCustomTemplatesforreference).However,templatesusedforPDFgenerationaremoredelicate:

• TheproducedHTMLandCSSneedstoadherestrictlytoHTML1.1strictandCSSlevel3.• UsingCSSfloatisnotsupported• Nestedtables(<table>withina<table>)needtobeavoidedbecauseyougetbadresultsiftheeither

tablespansovermultiplepages.• IncaseyourcustomizationshaveledtoasizablecustomCSSfile,considercreatingaseparate

stylesheetforthequotationPDFforperformancereasons(settheURLtothatstylesheetinthe<head>block).

• SinceConfigBox2.6.26wemovedtheheader/footerPHPtoaseparatetemplatefile(header_footer)foreasiercustomization.Ifyouoverridesomethinganddon’tneedchangestotheheader/footer,simplydon’tcopytheheader_footer.phptemplatetoyourcustomizationfolder.Thesystemwillloadtheoriginaltemplatethen.

• Mindthatifyouwanttoadjustpagemargins,setmarginsonthe<body>tag.ThisisthereliablewaytohavemarginssetoneachPDFpage.Since2.6.26thereareCSSclassesonthe<body>tag(body-pdfandaclassforeachtype–body-pdf-quotation,body-pdf-invoiceandbody-pdf-orderslip).Domarginstylingontheseclassestoavoidchanging<body>stylingonnormalwebsitepages.

Locationoftheoriginaltemplate:/components/com_cbcheckout/views/quotation/tmpl/default.php

Page 39: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page39

Locationofthecustomtemplate:/components/com_configbox/data/customization/templates/quotation/default.php

Thetemplateusesoutputofotherviews

Thetemplateusestheoutputofotherviews(namely‘record’and‘positions’fromcom_cbcheckout.Ifyouneedtoalterthispartofthequotation,youcanmakeoverridesofthesetemplates,butbemindfulaboutthefactthattheseviewsareusedelsewhere(adminorderpage,userorderpage,checkoutpageandpossiblemoreinthefuture).

5.2 CustomWordingandTranslations

Customizingwordingisrathereasy.Youneedtocomepreparedwithknowledgeoneditingfilesonyourwebserverandoneditingplaintextfileswithaspecificencoding(UTF-8).Thelatterisexplainedlaterinthissection.

5.2.1 Understandingtheconceptoflanguagefiles

HowwordingandtranslationishandledinConfigBox

TextsyouseeonthepageshandledbyConfigBoxarecustomizable.Toaccomplishthis,thesoftwareusesplaintextfilescalledsystemlanguagefilestofindandoutputtherightphraseintherightlanguage.

Ontopofsystemlanguagefiles,thesystemlooksforcustomlanguagefilesthatyoucanusetocustomizespecificphrases.

ThesefilescanalsobeusedtoaddanewtranslationofConfigBoxortotranslatetextsthatyouhaveincustomtemplates.

Howdoesalanguagefilelooklike?

LanguagefilesarethesameastheJoomlaframework(.inifiles)Atypicallineinalanguagefilelookslikethis:

REQUEST QUOTATION="Angebot anfordern"

Ontheleftinuppercaseyouseethekeywordofthephrasethesystemlooksfor.Ontherightwithindoublequotesyouseethephrasethatthesystemwilldisplay.

Youwillseecodelikethisinthebuilt-intemplatesandothersourcecodefiles:

<?php echo KText::_("Request Quotation");?>

Nevermindthattheparameterinthecodeexampleisn’tuppercase.Whilethekeywordinthe.inifilemustbeuppercase,theparameterforKText::_()canbemixedcase.

Locationsofsystemlanguagefiles

/components/com_configbox/language/en-GB/configbox_frontend.ini/components/com_configbox/language/en-GB/configbox_backend.ini/components/com_cbcheckout/language/en-GB/cbcheckout_frontend.ini/components/com_cbcheckout/language/en-GB/cbcheckout_backend.ini

Note:Thereareadditionallanguagefiles.Youcanignorethembecausetheyarenotrelevantforunderstandingtheconcept.

Page 40: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page40

Locationsofcustomlanguagefiles

/components/com_configbox/data/customization/language_overrides/en-GB/configbox_frontend.ini/components/com_configbox/data/customization/language_overrides/en-GB/configbox_backend.ini/components/com_configbox/data/customization/language_overrides/en-GB/cbcheckout_frontend.ini/components/com_configbox/data/customization/language_overrides/en-GB/cbcheckout_backend.ini

Note:Customlanguagefilesarestoredtogetherintheonefolder.

HowtofigureoutwhichlanguagefilecontainsthephraseIsearchfor?

Youmayhavetroublefiguringoutifyouneedthecbcheckout_frontendortheconfigbox_frontendoverridefile.

• Ifthephraseisonthecartpageorapagebeforethat,expectittobeinconfigbox_frontend.ini• Otherwiseexpectthephrasetobeincbcheckout_frontend.ini.Exception:Phrasesonthe

RFQ/save/loginformsbelongtoitaswell.

WhicheditorshouldIusetoeditcustomlanguagefiles?

FilesneedtobesavedasplaintextwithUTF-8encoding(noBOM)andonlyuseregulardoublequotes(likethis:")forwrappingphrases.

Ifyouarenotsurewhatthatmeans,takethesaferouteanduseoneoftheseeditorswithdefaultsettings:

• Windows:Notepad++(www.notepad-plus-plus.org)• MacOSX:TextWrangler(www.barebones.com/products/textwrangler)

5.2.2 Workflowtofindandcustomizeaphrase

• Searchforthephraseinthesystemlanguagefilesoftherightlanguage• Copythelinetothecorrespondingcustomlanguagefileandchangethephrase(aphrasemayappear

inmultiplefiles,inthatcase,copyeachofthemtoavoidcomplicatedsituations)

Notes:

• Thekeywordmustremainunalteredandmakesuretohaveyourphrasewrappedindoublequotes.• Donotputlinebreaksinyourphrases,ifyouneedone,add\nor<br/>• Ifyouneeddoublequotesinyourphrase,writethemas\"• WhenchangingphrasesinEnglish,youmaynotalwaysfindthephraseinthesystemlanguagefiles.

ThatisbecausetheEnglishlanguagefilesonlycontainphrasesifthekeyworddiffersfromthephrase.Inthatcaseyoucanexpectthekeywordtobetheuppercaseformofthephrase.Example:Thephrase“SelectProduct”isdonelikethis:SELECTPRODUCT="Yourownwording"

• Phrasesmaychangeinmajorsoftwareupdateswithoutnotice.Itisuptoyoutocheckandreviseyourcustomizationsifnecessary.

5.3 CustomBehaviorofElements

WorkingwithcustomelementclassesrequiresaseasonedPHPdeveloperandaproperlocaldevelopmentsiteisrecommended.Weofferworkshopstogetyourdevelopmentteamuptospeed.Pleasecontactcustomersupportforpricingandscheduling.

UsingtheelementclassAPIyoucanimplementspecificfunctionalityinyourconfigurator.Forinstance:

• DeterminepricingwithyourownPHPcode;e.g.fetchpricingfromexternaldatasources• Storeconfigurationelementvaluesinothersystems

Page 41: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page41

HowistheelementclassAPIused?

YouaddPHPfileswithclassesthatextendtheoriginalConfigBoxelementclassConfigBoxElement(thesourcecodefileislocatedincomponents/com_configbox/classes/element.php).Themethodsofthatclassreturnpricing,theelement’sHTMLoutputonconfiguratorpages,selectionoverviewblocksandthecartpageandstoreselectionsmadebythecustomer.

Afteryouaddedaclassfile,youcanselecttheelementclassintheelement’sedit-screen.

TheelementclassfilenameandthePHPclassnamefollowanamingconvention.ThefilesarestoredinConfigBox’datafoldertoavoidoverwritingonupdates.

Filefolderandnamingconvention:

Basefolder:components/com_configbox/data/customization/element_classes

Eachelementclasshasasub-folder.InityouputthePHPclassfilewiththesamename.

Exampleforelementclassname‘upload’:

PHPclassname:ConfigboxElementUploadFilesystempath:components/com_configbox/data/customization/element_classes/upload/upload.php

Methodsyoucanextend:

getPrice($getNetPrice,$getInBaseCurrency)

Thismethodreturnsthepriceinthebasecurrency,eithergrossornet(dependingonthe2parameters).Themethodmustreturnanumberoftypefloat.Ifparameter1isnotentered,thecurrentsystemdefaulthastobeused(usethevalueofconstantCONFIGBOX_SHOW_NET_PRICES),ifparameter2ismissing,thenfalseisassumed.

getPriceRecurring($getNetPrice,$getInBaseCurrency)

AnaloguetogetPrice(),butusedfortherecurringprice.

loadTemplate()

UsethismethodtooutputyourownHTMLinsteadofthedefaultHTMLoutputoftheelementinconfiguratorpages.TheimplementationofthismethodwritesthefrontendHTMLoutputoftheelementintheconfiguratorintotheoutputbuffer.

5.4 CustomFields

Products,elements,optionsandoptionassignmentshave4to6customfieldsyoucanusetoenteranykindofadditional.Thepurposeofthesefieldsisnotspecific.Typicalusefulapplicationsare:

• Usageinpricecalculations(seeonscreen-helpfordetailedinfo)• Usageincompatibilityrules• Usageincustomtemplatesorelementclassesforoutputorapplyingcustomlogic• Usageinconnectorsforintegrationwiththirdpartysoftware

Forpracticalreasons,youcansetyourownlabelsofthesefieldsinSettings->CustomFields.

5.5 CustomCSSstyling

CustomizingCSSstylingrequiresbasictomoderateHTMLandCSSskills.Customstylingcaneitherbesufficienttoamendstylingoftheshoporbeusedincombinationwithcustomizedtemplates.

Page 42: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page42

ConfigBoxcomeswithastylesheetspecificallymadeforstylingcustomizations.Asallfilesinthecustomizationfolder,itisnotoverwrittenduringsoftwareupdates.

Location:

/components/com_configbox/data/customization/style_overrides/css/style_overrides.css

Tips:

Useconventionsforruleselectors

Whenlookingatoneofthestylesheets,youseethatmostCSSselectorsstartwith#com_configbox#view-xor#com_cbcheckout#view-xwithxstandingfortheview’sname.Whilebarelyavoidableanyways,werecommendyouadoptthatconventionforyourcustomizations.Itmakesitimmediatelyclearwhatyouintendtochangeanditavoidsunwantedchangesonotherpagetypes.

5.6 CustomJavaScript

CustomJavaScriptrequiresbasictomoderateHTML/JSskills.CustomJavaScriptcanbeusefulincombinationwithcustomtemplates.

Location:

/components/com_configbox/data/customization/style_overrides/javascript/extra_functionality.js

Tips:

YouhavejQueryavailable

YoucanusejQuerywithcbjintheglobalscope.MindthatthejQueryversionmaychangewithanysoftwareupdate.

5.7 CustomTemplates

CustomizingtemplatesrequiresmoderatePHPprogrammingskillsandrelatedskillslikeHTML/JS/CSS(plus/minusdependingonthekindofcustomizationyouneed).

ConfigBoxisorganizedinpagetypes(e.g.productlisting,cart,checkout,adminorderpageetc.)andeachpagetypemakesuseofaview(ormultipleviews).Eachviewhasatemplatefile(ormultipleones)responsibleforoutputinthebrowserandthesetemplatefilescanbecustomized.

Important:Aswithanycustomization,customtemplatesmayneedtobecheckedandchangedforcompatibilityonsoftwareupdates.Onthedownloadpageyoufinddetailedinformationonbreakingchangesforeachsoftwareupdate.

NotesifyouarefamiliarwithJoomla’sMVCandtemplateoverridesystem:

OurconceptissimilarandpracticallytransparenttothewayJoomlahandlesviewsandtemplates.ThedifferenceisthatoverridesarenotsearchedforintheJoomlatemplatefolder,butinConfigBox’sdatafolder(locationseelaterinthissection)andthatviewfunctions(likeClass::loadTemplate())arenamedandbehavedifferently.

Understandingtheconceptoftemplatecustomization

In/components/com_configbox/viewsyoufindsub-foldersforeachviewthatConfigBoxusesfordisplayingpages.Thisiscalledaviewfolder.EachviewfoldercontainsaPHPfilecalledview.html.php(orview.raw.phpinsomecases)thathandlespreparationofthedatathatisusedfordisplayingcontent.

Page 43: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page43

Eachviewfolderalsocontainsasub-foldercalledtmplthatcontainsatemplatefilethatistypicallynameddefault.php.TheHTMLproducedinthistemplatefileiswhatyouaregoingtoseeascontentonyourpage.

Someviewssplitthecontentintomultipletemplatefileswhenitismorepracticalandusetheoutputofotherviewswithintheirtemplatefileswhenitmakessense.Anexampleofthisisthequotationviewwhereorderrecordinformationandpositiondetailscomefromtheviews‘record’and‘positions’.

Workflowforoverridingatemplatefile

1)Firstyoulocatetheviewforwhichyouwanttomakeacustomization.Takethecartasexample:

/components/com_configbox/views/cart

Thecartviewusesasingletemplatefile,nameddefault.php(Futurereleasesmayhaveitsplitinmultipletemplatefiles).Downloadorcopythetemplatefile,youtypicallywanttouseitasbaseofyourcustomization.

2)Navigatetothefolderforcustomizedtemplates.Thelocationis:

/components/com_configbox/data/customization/templates/

3)Inthisfolderyoucreateafolderwiththenameoftheviewyouliketooverride:

/components/com_configbox/data/customization/templates/cart

4)Inthisfolder,youplacethetemplatefileyouliketooverride.Mindthatyoudonotcreatethesub-foldertmpllikeyouhaveitintheviewfolder.

/components/com_configbox/data/customization/templates/cart/default.php

5)Youthenmakeyourcustomizationstothatfileasyouseefit.

Tips:

ConfigBoxconsistsoftwocomponents(com_configboxandcom_cbcheckout)

Thismeansthatyoufindviewsin/components/com_cbcheckout/viewsaswell.Thesystemforoverridingisthesame.Butthecustomtemplatesareinthesamefolderasforcom_configbox.

Inviewswithmultipletemplatefiles,youcanchoosewhichonestocustomize

Ifyouoverrideonlycertaintemplatefiles,theotherswillbeloadedfromtheoriginalviewfolder.Thishelpsminimizingyoureffortsincaseofbreakingchangesinsoftwareupdates.

AvoidCSSstyling,addingimagesinplacesotherthanthecustomizationfolder

HavealookatthechapteroncustomCSSstyling.Youalsohaveanimagefolderinyourcustomizationfolder.Thishelpskeepingyourworkwellorganizedandquicktocomprehendforcolleaguesandserviceproviders.

Makeuseofcustomfields

Seesectiononcustomfieldsforreference.Youcanaccessthedataofthesefieldsintheappropriatetemplatesandusethemforoutput,calculationsorotherlogic.Seetiponinvestigatingtemplatedataforthebestwaytoseewherethedataisstored.

Formultilingualsites,checkthechapteroncustomwording

Thesoftwarehasanenginetomaketranslatedtextsstraightforward.Managingtranslatedphrasesisexplainedinthatchapter.Tomakeuseofitforyourownwording,youhaveastaticPHPclassmethodtooutputyourtranslatedphrases.

Page 44: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page44

Example:(Obviously,thiscodesnippetneedstobeplacedwithinPHPtags).

echo KText::_('Your phrase');

Thephraseyouuseheremustmatchthekeywordusedinyourcustomlanguagefile.Sothelineinyourlanguagefilewouldlooklikethis:

YOUR PHRASE="Your translation of the phrase"

Investigatingdataprovidedinthetemplatefiles

ThereisaveryusefulJoomlaextensionthatletsyououtputthedataofanyvariableinabrowserpopup.ItiscalledJDumpandcanbefoundintheJED:

http://extensions.joomla.org/extensions/miscellaneous/development/1509

Example(ObviouslythevariableusedheremustexistandthecallbeplacedinPHPtags):

dump($this->elements);

Makeuseofthelogfilesfordebugging

ConfigBoxlogserrorsandotherthingsextensively.Thelogfilescanbeusefulincaseyouworkdirectlyonawebserveranddonothaveaccesstotheserver’serrorlog.Logsarelocatedinyourwebsite’slogfolderinasub-foldercalled‘configbox’.

Youmayseeplentyofmessagesinsomeerrorlogfiles.

5.8 CustomTemplatesforSpecificListings,Products,PagesandElements

Thissectionisaboutthetemplateeditorthatisessentiallyagraphicinterfaceforcreatingcustomtemplatefileswithsomeextras.

• Convenientlyaddormodifytemplatefilesintheadminarea• Createtemplatefilesforspecificproducts,configuratorpagesorelements.

Intheeditformsofthecorrespondingtypesyoucanassignthetemplateusingthefield‘Template’.

Page 45: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page45

Editformfortemplates

Youedittemplatesusingcodecoloringandformattingandyoucanalsoeditthesefilesonthefilesystem.

5.9 CustomConnectors

Whatareconnectorsfor?

ConnectorsareusedtointegratethirdpartysoftwarewithConfigBoxtoextendorreplacefunctionality.

Exampletasks:

• Processanorderanbringthecustomertoacustomcartpage• Checkoutacart• Createaquotationfile• Performactionsonorderstatuschanges

Whatareconnectorstechnically?

AconnectorisbasicallyaPHPfilecontainingaPHPclasswithasetofmethods.ConfigBoxcallsthesemethods(iftheyexist)andprovidestandardizeddataasparametertoperformvariousprocesses.Thisisdoneusingtheobserverpattern.Dependingonthenatureofthetaskthesystemcallsonlythefirstconnectororallconnectors.

Exampleconnector:

/components/com_configbox/observers/Cbcheckout.php

Howtomanageconnectors

Page 46: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page46

ConfigBox->Settings->Connectors:

Hereyoucanenableordisableconnectorsandaddorremovethem.

Addingaconnector

Afterclickingaddyouenternameoftheconnector,thesettingsandprovidethefile.Entertheformasperinstallationinstructionsoftheconnectorprovider.

Howtodevelopaconnector

• Firstyoupickanameforyourconnector.Inthisexampleweuseecomsystem.• CreateaPHPfilewithaPHPclasscalledObserverEcomsystem.

<?php class ObserverEcomsystem { }

• Savethefileandadditasconnector(see6.8.3).

Customconnectorsarestoredinthispath:

/components/com_configbox/data/customization/custom_observers

Connectortoplaceaconfiguredproductinathirdpartyecommercecart

AddthemethodonConfigBoxAddToCartwithoneparameter(passedbyreference).

function onConfigBoxAddToCart(&$grandOrderDetails) { // Code to add product to shop system $grandOrderDetails->redirectURL = 'URL TO THIRD PARTY CART'; return true; }

Page 47: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page47

About$grandOrderDetails

Theparameter$grandOrderDetailsisaPHPobjectcontainingtheinformationofthecurrentcartandallpositionsinit.Usevar_dump(),print_r()ordump()(installJDumpfromtheJED)toseethestructureanddataoftheobject.

About$grandOrderDetails->redirectURL

SetthememberredirectURLtotheURLofyourecommercesystem’scartpage.ConfigBoxreadsthismemberandredirectsthecustomertothegivenURL(canbeacompleteURLorarelative/absoluteURI).

ConnectortoplaceConfigBoxcartcontentsinathirdpartyecommercecheckoutpage

ThesameprocedureappliesasforonConfigBoxAddToCart,themethodnameforthisisonConfigBoxCheckout.

function onConfigBoxCheckout(&$orderDetails) { // Code to add product to shop system $orderDetails->redirectURL = 'URL TO THIRD PARTY CHECKOUT PAGE'; return true; }

5.10 CustomNotificationsnippets

Youcanaddcustomnotificationsnippetstooutputcustomdatainyouremailnotifications.AsnippetisasimplePHPfilethatisincludedandthebufferoutputgeneratedwillbeinsertedwheretheplaceholderisset.

Locationofthecustomsnippetfolder

/components/com_configbox/data/customization/notification_snippets

InConfigBox2.6.16andearlier:/components/com_cbcheckout/data/notification_elements/

Snippetandfilenameconvention

Sayyoucallyoursnippet‘customsnippet’.Thefilenamehastobecalledcustomsnippet.html.php,theplaceholder{element_customsnippet}.

Dataavailableinthesnippetfile

$orderRecord–Objectholdingallorderdata(see$orderRecord->orderAddressforordercustomerdata)

$shopData–Objectholdingtheshopdata

Helpfultips

Seethecodefortheorderoverviewforreferencein

/components/com_configbox/observers/notifications/elements/order_overview.html.php

ThereisaveryusefulJoomlaextensionthatletsyououtputthedataofanyvariableinatreestructureinapopup.ItiscalledJDumpandcanbefoundintheJED:

http://extensions.joomla.org/extensions/miscellaneous/development/1509

Examplecall:

Page 48: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page48

dump($orderRecord);

6 NotesforConfigBoxupgrades

Pleasecheckthecompatibilitynotesatthedownloadpagesonwww.configbox.atfornotesoncompatibilityoncustomtemplates.

6.1 UpgradefromConfigBoxversionspriorversion2.2

CalculationFormulas

TheplaceholdersA,B,C,Dnowneedtobewrittenwithaprependedandappendedspaceandincapitalletters.SoA*BisnotpossibleanymoreandhastobewrittenA*B.ThisisnecessarybecauseofclasheswithkeywordslikeElementAttribute,wheretheAwouldgetreplacedincasetheplaceholderAisdefined.

Pleasecheckyourformulasbeforeupdating.

NewSEFURLrouting

ConfigBoxhasanewrouterforSEFlinks,finallyremovingthe/configurationpartfromtheURLanddroppingtherequirementtohaveaproductlistingmenuitemwithnoproductlistingparameterset.Alsoitisnowpossibletohavedifferentmoduleassignmentsforeachproductoreachconfiguratorpagebycreatinga"Configuratorpage"menuitemwithfittingparametersforproductandconfiguratorpage.Ifyoudonotneedthisfine-grainedcontroloveryourmoduledisplay,youcanstilluseamenuitemwithproductandconfiguratorpageunset.

Thisisaone-timechangeofURLroutingandwillnotbechangedagaininthemid-future.Wefoundthatthisstepwasabsolutelynecessarytomakelinksmoreflexibleandeasiertohandle.

7 Troubleshooting

AlwayscheckifyoureadandfollowedtheinstructionsinthesectionInstallationandthesectionConfigBoxupgrades.

7.1 PricingandProductVisualizationdoesnotupdate

Checklist:

PageCachingpluginsareactiveonconfiguratorpages

PagecachingpluginslikeYot-CacheorJoomlArtT3TemplateCachesandotherspreventConfigBoxfrompreparingconfigurationsbeforedisplayingtheconfiguratorpage.

Solution:Deactivatethecachingingeneralordisableitforthecomponentscom_configboxandcom_cbcheckout.

Page 49: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page49

Linksandbuttonsdonotredirecttotheintendedpage

ThirdpartySEF-URLslikeAceSEF,SH404SEFandothersmanipulateURLsthatcanleadtoincorrectredirections.

Solution:FinetunetheSEFtoolordisablethesetoolsforthecomponentscom_configboxandcom_cbcheckout.

AdminToolsdonotallowdirectaccesstocomponents/com_configbox/configbox.php

ThereisanextensioncalledAdminToolsthatcreatesrestrictionsforimprovedsecurity.Youneedtosetupanexceptionthatallowsdirectaccesstothementionedfile(ConfiguratorupdatestodirectlytothecomponentinsteadofthroughJoomlabecauseofsignificantperformanceimprovement).

Solution:GotoComponents->AdminTools->.htaccessMaker->Exceptionsandaddthislinetothefield‘Allowdirectaccess,including.phpfiles,tothesedirectories’:components/com_configbox

IonCubeLoaderisonlyactiveforcertaindirectories

Solution:SeethechapteronInstallation->IonCubeLoaderonhowtosetupionCubeLoadercorrectly.

7.2 Theinstallationfailedanduninstallationisnotpossible

IftheinstallationfailedthereisaknownissuewithJoomla2.5leavingdatabasetablerowsabouttheextensionbehind,makinguninstallation,launchandreinstallationsimpossible.

Solution

• LaunchphpMyAdmininyourserverhostingpanel• Gotothetablejos_assets• Searchforrowswithname‘com_configbox’andremovetherows• Searchforrowswithname‘com_cbcheckout’andremovetherows• Gotothetablejos_extensions• Searchforrowswithname‘com_configbox’andremovetherows• Searchforrowswithname‘com_cbcheckout’andremovetherows

7.3 Paymentmethodchangesarenoteffective

Whenanorderischeckedout,ConfigBoxcreatesacopyofallpaymentmethodsettingsforthatorder.Ifyoumakechangestothepaymentmethodsyouwon’tseethosechangesinanalreadycheckedoutorder.Checkoutanewordertoseethecurrentsetup.

7.4 IssueswithSH404SEF

IfyougotissueswithSEFURLsonConfigBoxandOrderManagementpages,configureSH404SEFlikethis:

• GotoComponents->SH404SEF->Configuration(toprightcorner)->General->Bycomponent

Page 50: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page50

• Forcbcheckoutandconfigbox,usethesettings‘UseJoomlarouter’,‘TranslateURL’,‘Insertlanguagecode’,‘UseJoomlarouter’,‘DisableshURL’(seescreenshotforreference)

InordertouseSEFURLsforConfigBoxpages,usetheJoomlanativeSEFtechniques.Createmenuitemsforproductlistings,cartpageetc.

7.5 Anerrormessageoccurredafteruploadingapackage

Checkthefollowingthings:

• Makesureyourfolderfortemporaryfilesiscorrectandwritable(Joomlaglobalconfiguration)• Makesurethetargetfoldersarewritable(e.g.components,modules,plugins/*,

administrator/components)• Makesureyourwebserverallowsuploadofbiggerfiles(seephp.inisettingspost_max_sizeand

upload_max_filesize).Useasettingbiggerthantheregardingpackagesize.• CheckforanywarningsontheJoomlaextensionmanagerpage.

Page 51: ConfigBox 2.6 for Joomla · Extensions. Search for ‘ConfigBox’ to find them easily. Click on both the red symbols and you’re done. 2.3.2 Customer group setup This is not needed

__________________________________________________________________________________________

ConfigBox–ShopManagerManual

Rovexo(formerlyElovarisApplications)Version2.6.31–Lastupdate:November13,2018 Page51

8 Extensions

8.1 VirtueMartConnector

PleasenotethatwediscontinuedthesaleoftheVirtueMartConnector.Customersthatalreadyhavepurchasedtheconnectorgetsupportandtechnicalassistanceonincompatibilities.

Compatibility

• VirtueMart2.0.20b–2.0.22a

Installation

AtComponents->ConfigBox->ConfigurationinsectionConnectors:

• Clickthebutton‘add‘• Set“Virtuemart”astitle,‘yes’at‘Executeaftersystemconnectors’anduploadtheprovidedfile

“Virtuemart.php”andsavetheconnector.ThesystemwillnowaddConfigBoxproductstotheVMcartinsteadoftheConfigBoxcart.

Setupprocedure

InVirtueMart

AddtaxcalculationsforeachofyourConfigBoxtaxclassesinVirtueMartatTax&CalculationRulesandnotetheIDsofthecreatedcalculations(farrightsideofthetable).

InConfigBox

AtComponents->ConfigBox->TaxClasses,entertheIDoftherespectivecalculationinthefieldExternalID.