realtyna inc.for example, if you map the mls bedrooms field to a wrong field, the properties...

13
| 1 MLS add-on (For WPL) Realtyna Inc. Contents of this manual are applicable to WPL MLS addon. Details of this manual may be different based on customizations you may have or your software.

Upload: others

Post on 19-Aug-2020

3 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Realtyna Inc.For example, if you map the MLS bedrooms field to a wrong field, the properties won't be able to find the bedrooms through WPL search widget. If a visitor looks for 2

| 1

MLSadd-on(ForWPL)RealtynaInc.

ContentsofthismanualareapplicabletoWPLMLSaddon.Detailsofthismanualmaybedifferentbasedoncustomizationsyoumayhaveoryoursoftware.

Page 2: Realtyna Inc.For example, if you map the MLS bedrooms field to a wrong field, the properties won't be able to find the bedrooms through WPL search widget. If a visitor looks for 2

| 2

IntroductionThismanualcontainsinformationabouttheMLSadd-on,anextensionforWPLplugin.MLSadd-onisapowerfulextensionthatenablesrealestateWordPresswebsitestoimportproperties,agents,imagesetc.fromtheMLSserverdirectlyintotheirwebsites.ByusingtheMLSaddonofWPL,youcansyncyourwebsitewiththeMLSserverproperties.Thismeansifa new property is added on the MLS server, it will be imported into your websiteautomatically.AlsoifapropertydatawasupdatedordeletedontheMLSserver,itwillbeupdatedordeletedonyourwebsiteaswell.

SystemRequirementsTousetheMLSaddonyouwillneedthefollowing:

1- WPLPRO.(Don'tinstallanyaddononWPLbasic)2- AtleastoneMLSserveraccess.(MLSusername,passwordandloginURL)

Installation

IfyouhavetheinstallationpackageoftheMLSaddon,youcaneasilyuploaditfromthefollowingpath:WordPress->WPLdashboard->InstallAddonform.

Glossary

Belowisalistoftermsusedthroughoutthismanualandtheirmeanings.MLSServer:Awebserverusedforstoringpropertydata,propertyimagesandperhapsagentinformation.MLSaddonneedsthelogincredentialstoconnecttoMLSserverforcommunicating.MLS/RETS/IDX/VOW:Thesetermsallmean"MLSserver"asmentionedabove.NormallyyoucanusetheMLSaddonforallofthesedataservers.RETSVersion:UsedinWPLRETSlibrary.Itiscommonlyknownas"RETS/1.5".MLSResource:MLSserverscategorizethedataintoadifferentsectioncalledaresourcesection.Forsyncing/importingthepropertiestheresourceisusuallycalled"Property".Mapping:Forimporting/syncingPropertydatafromtheMLSservertoWPL,youneedtosynctheMLSdatafieldstoWPLdatafields.Thisiscalledmapping.Sampledata:HavingsampledataoftheMLSfieldscanhelpyoutounderstandwhattheMLSfieldis,andyoucanmapittothecorrectfieldofWPL.

Page 3: Realtyna Inc.For example, if you map the MLS bedrooms field to a wrong field, the properties won't be able to find the bedrooms through WPL search widget. If a visitor looks for 2

| 3

MLSClass:TheMLSpropertiesarecategorizedinsomesectionscalledMLSclass(Residential,Commercial,LotsandLand,Multifamilyetc.).SyncPeriod:Thedurationtimebetweeneachupdaterequest.TheMLSAddoncallsarequesttotheMLSserverforaddingnewpropertiesormodifyingexistingproperties.Youcansetitsdurationbasedondays.Query:Youcancreatevarioustypesofqueriesforimporting/syncingtheMLSpropertiestoWPL.Forexample,ifyourbrokeragespecializingincommerciallistingsorrentalproperties,youcanimport/syncthesetypesofpropertiestoyourWPL.ThereisalsoanamazinginterfaceforcreatingadvancedqueriesonthequerywizardofMLSAddonaswell.

RunningMLSAddon

Aftertheinstallation,youshouldconfiguretheMLSAddon.

AddingMLSserversToaddMLSserverspleasegotoWPL->MLSAddonmenuandclickon"+"buttonontopofpage.

- Name:Youcanaddyourdesiredname.- URL:EnterloginURLofMLSserver.- Username:YourMLSserverusername- Password:YourMLSserverpassword- AgentUsername:YourMLSAgentUsername.(IftheMLSProviderneedstothisfieldto

connectintotheirserver)- AgentPassword:YourMLSAgentPassword.(IftheMLSProviderneedstothisfieldto

connectintotheirserver)

Page 4: Realtyna Inc.For example, if you map the MLS bedrooms field to a wrong field, the properties won't be able to find the bedrooms through WPL search widget. If a visitor looks for 2

| 4

- UniqueField:EverypropertyonMLSserverhasauniqueid,youshouldfindthenameofuniqueidfieldinMLSfieldsandthenplaceithere.Normallyitis"ListingID".

- SampleQuery:BasedonMLSserverstructuresitcanbedifferent.

#AdvancedTab

- RETSVersion:Usuallyit’sRETS/1.5,RETS/1.7.2orRETS/1.8.TheMLSprovidermentionsthat

intheRETSinformation.- Resource:TheListingresourceintheMLSdata,that95%is“Property”.Itmeansyouwantto

receivejustlistingfromMLSdata.- ImageResource:TheImageobjectoftheMLSdata,someMLSproviderhasHighPhotoor

anotherrelevantphotoobject.TogetthehigherresolutionphotosfromtheMLS.- ExternalImage:SomeoftheproviderssupporttheCDNlinkforphotos(asExternalimage).

Itmeansthephotoswon’tdownloadonyourwebsite/host.- DownloadExternalImage:YoucandownloadthephotosfromCDNlinksinyour

host/server,ifyouselectthe‘Yes’valueofthisoption.ItisfortheMLSprovidersthatreturntheHigh-resolutionphotojustinExternalimages.

- GoogleGEOCoordinates:Ifit’senabled(Yes),itwillgeneratetheGoogleGeocodingfromtheGoogledirectly,usingthepropertyaddress.

- MLSPhotosupdate:IfIt’senabled(Yes),itwillupdatethelistingphotosineachMLSupdateprocess.

Afterfillingouttheformandclickonthesavebutton,thepagewillrefreshautomaticallytoseetheaddedMLSserver.Note:YoucanaddmanyMLSserversasmuchasyoulike.

Page 5: Realtyna Inc.For example, if you map the MLS bedrooms field to a wrong field, the properties won't be able to find the bedrooms through WPL search widget. If a visitor looks for 2

| 5

AfterthatyoumustchecktheconnectionandimportMLSclassesandMLSfieldsinordertomapwithWPLfields.Forthisyoucansimplyclickon"Importfields"button.

YoucanalsoupdateMLSclassesandfieldslaterifneededbyclickingon"UpdateFields"button.Note:IftheMLSAddonshowsaconnectionerrorinthisstep,checkyourlogincredentialsandinsertcorrectinformationinordertoproceedtothenextstep.WhentheMLSconnectionhasbeensuccessfullysetup,Youwillseean(i)iconintheActionscolumn.Byclickingonthat,alltheMLSobjecttypesandMLSclasseswillbeshown.

MapwithWPLClickonthe"MapwithWPL"linkorGototheWPL->MLSmappingtoseetheMappinginterfaceofWPL.SelectMLSserverandMLSclasstoseetheMLSfields.

Page 6: Realtyna Inc.For example, if you map the MLS bedrooms field to a wrong field, the properties won't be able to find the bedrooms through WPL search widget. If a visitor looks for 2

| 6

TheMappingfunctionalityisdesignedinawaythathelpsyoumapallthefieldseasily.NormallytherearealotoffieldsinMLSservers,thereforemappingthemonebyoneisatime-consumingprocess.So,ifyoumapanMLSfieldinaspecificMLSclass,theMLSAddonwillmapthesamefieldsontheotherMLSclassesautomatically.Thereisalsoamassautocreatefieldinthebottomofthemappingtable.Youcanselectsomefieldsandthenclickon"CreateAll"button.IfyouwanttointegratemultipleMLSServersinthewebsite,youcouldusevaluemappingfeaturebyclickingontherespectivecheckboxatthebottomofMLSMappingpopup.ItwillmapafieldforalltheMLSservers.Moreover,MLSadd-onhasafeaturetocreateMLSimportqueryautomatically.Byclickingonthat,youwillseeanewrecordintheMLSquerypagewhichcouldbemodified.ThedefaultquerywillretrievealltheactivelistingsoftherespectiveMLScategory.Importantnote:Themappingprocessisveryimportant.Wrongorincompletemappingcancreateseriousnumerousissuesonyourwebsite.Forexample,ifyoumaptheMLSbedroomsfieldtoawrongfield,thepropertieswon'tbeabletofindthebedroomsthroughWPLsearchwidget.Ifavisitorlooksfor2bedroomproperties,theWPLsearchwidgetwillsearchintheWPLbedroomsfield.Itwon'tfindtheinformationitislookingforbecausethebedroominformationofMLSpropertiesisonanotherfield.Thesameissuewillhappenforpropertylisting/propertyshowpage.Dependingonyourtheme,therearesomefixedpositionsforshowingsomebasicinformationofthepropertysuchaslisting,propertytype,price,bedrooms,rooms,bathrooms,parkingspaces,propertylocationetc.SoifyoumappedthefieldswronglyWPLwillshow0,nullorwronginformationonyourtheme.Soyoumustdothemappingverycarefully.Notethefollowingitemsduringmapping:

- MaptheMLSfieldstoexistingWPLfields.- Avoidcreatingnewfieldsusing"AutoCreate"buttonunlessreallythereisnorelatedfieldon

WPLforthosefields.- It'sbetterifyoudon'tmapthefieldswhichdon'thaveanydataonsampledata.Itcanmake

yourwebsitemessywithunnecessaryinformation.- WPL'smostimportantfieldsare:listingtype,propertytype,price,priceunit,pricetype(for

rentalproperties),listingID,bedrooms,bathrooms,rooms,view,propertydescription,builtuparea,lotarea,images,locationinformation,propertytitle(ifexists).Mapthesefieldswithcarefully.

- Selectaproperfieldtypeifyouwanttouseautocreatefeature.Forexample,youshoulduseURLfieldtypeforVirtualTourfield.

- MappingsomefieldsmayneedtobemanuallytailoredbasedoncustomizationsyoumayhaveonyourWPL,otherAddons,orthedatastructureofyourMLSserver.

ValuetoValuemappingfeatureSincewesavevaluesofaMLSfield(usingMLSLookup)inthenewversionofMLSadd-on.Youmightwanttosaveavalueonyourwebsitewithanothername.

Page 7: Realtyna Inc.For example, if you map the MLS bedrooms field to a wrong field, the properties won't be able to find the bedrooms through WPL search widget. If a visitor looks for 2

| 7

So,youcandefinedesiredvaluesforafieldaftermappingthat(MLSfield)tooneWPLfield(TheWPLfieldshouldbeaSelect/Featuretype).Forexample,youcanfindamappedMLSfieldinWPLFlexpage;andclickonitsEditbuttontoaddnewvalues.Nowthereisasamplefieldcalled‘AppliancesIncluded’thatisaddedasaFeaturefieldinWPL.

Asyouseeinthescreenshotabove,weadded3valuesforthisfield.NowyoucanfindtheMLSfieldthatyoualreadymappedittothisfield(Forexample:‘AppliancesIncluded’),andclickthe‘Modifymapping’linktoopentheMappingbox.

TheMappingbox:

Page 8: Realtyna Inc.For example, if you map the MLS bedrooms field to a wrong field, the properties won't be able to find the bedrooms through WPL search widget. If a visitor looks for 2

| 8

Youcanadddesiredvaluesforthemnow.Itmeansifyousavethismappingwiththissamplestructure,itsaves'BuiltinOven'as'Value1'toyourwebsite,orsaves'Compactor'as'Value2'.

MLSQuery(Querywizard)Afterthemappingprocess,youshouldusethe"MLSQuery"menuforimportingpropertiestoyourwebsite.YoucouldalsosyncthemtoWPLbyusingtheMLSautosyncfeature.

Page 9: Realtyna Inc.For example, if you map the MLS bedrooms field to a wrong field, the properties won't be able to find the bedrooms through WPL search widget. If a visitor looks for 2

| 9

Ifyouclickon"+"buttonforaddingqueryorclickonediticonofeachQuery,youwillseethebelowinterfaces.

- DefaultUser:Thepropertieswillbeassignedtothecurrentuserbydefault.Youcanselectanyuser/agentyouwantbyusingthedropdownmenu.

- Images:YoucanspecifyhowmanyimagesyouwouldliketohavedownloadedfromtheMLSserverandimportedtoWPL.Dependingonyourserverspaceandresources,youcanincreasethisparameter.Donotsetittounlimited(-1)ifyoudon'thaveastrongserver.

Page 10: Realtyna Inc.For example, if you map the MLS bedrooms field to a wrong field, the properties won't be able to find the bedrooms through WPL search widget. If a visitor looks for 2

| 10

- Limit:ConnectingtotheMLSserver,fetchingthedataanddownloadingimagesarearesourcetakingprocess.Onsomeserversitcancreateinternalservererrors.Wehavecreatedanoptiontodotheimport/syncactionsstepbysteptoreduceserverload.Pleasedon'tsettoahighnumber.ThisisanotherreasonwhyyoushouldhaveadedicatedserverforutilizingMLSintegrations.

- SyncPeriod:Youcansetthesyncperiodifneeded.SetittoahighernumberifyourMLSserverwon'tupdatedaily,oryou'renotsureaboutyourserverresources.Youcansetitto5days(forexample).

- Query:MLSAddonhasanamazingQueryWizard,soyoucansetthecredentialsfortheimportorsyncprocessifneeded.Pleaseleavethisemptyifyou'reuncertain.

EnablingtheQueryforsyncprocessAfteraddingthequeriesyoushouldenable/disableitforsyncprocessifneededbyclickingon"x"ortickiconon"Actions"column.

ImportYoucanclickonthe"Import"linkaftercreatingthequeryformanuallyimportingtheproperties.Afterclickingonthe"Import"link,youwillberedirecttoanewpage.Clickonthe"Start"linkforstartingtheimportprocess.Itmaytakesaseveralminutesbasedonyourserverload.

Don'trefreshthepageornavigatetootherpageswhileit'simportingthelistings.

MLSAddonsettings(SomeotherMLSfeatures)YoucanfindtheseoptionsfromWPLBackend->Settingsmenu->Globaltab->MLSAddonsection.Youwillseethefollowingfields.

Page 11: Realtyna Inc.For example, if you map the MLS bedrooms field to a wrong field, the properties won't be able to find the bedrooms through WPL search widget. If a visitor looks for 2

| 11

- MLSautosync:It’sanoutdatedfieldinthenewversionofMLSadd-on(since3.5.0),soitdoesn’tworkanymore.

- Clearthumbnailsafterupdating:Itremovesthumbnailimagesofalistingwheneveritupdatesonyourwebsite.

- ListTracIntegration:YouneedtoimplementListTrac(http://www.listtrac.com/)rulesonyourwebsiteforsomeMLSproviderslike(UtahMLS).So,youcanintegratethatsimplybyaddinganAPIKey/CodeprovidedbytheListTracwebsiteinthe‘ListTracCode’field.

- ImageWhiteSpaces:SometimestheMLSimageshaveawhitespaceinaroundit.Youcansetthisfieldto‘Trim’valuetoremovethewhitespaceofthat.

(WPL)MLSDisclaimerMLShasaspecificwidgetforaddingMLSDisclaimertextinListingorDetailspages.

Page 12: Realtyna Inc.For example, if you map the MLS bedrooms field to a wrong field, the properties won't be able to find the bedrooms through WPL search widget. If a visitor looks for 2

| 12

YoucanShow/HidetheCopyrightandLastUpdatetexts(thatareimportantitemsinMLSCompliances/Rules)inthiswidgetaswell.

MLSadd-onautosync

Aftercreatingthequeries,youneedtoaddtherelevantCommandsinyourcron-jobsystemtoruntheMLSimportprocessautomatically.Wesuggestmakingthembyatechnicalperson,youalsocanaskourteamtohelpyouinthisregard.Thefollowingcommandsarerequiredforcron-jobssystem:1.wget-O/dev/null'http://your-website.com/?rets_cron_job=1&rets_cron_job_type=offline'

Page 13: Realtyna Inc.For example, if you map the MLS bedrooms field to a wrong field, the properties won't be able to find the bedrooms through WPL search widget. If a visitor looks for 2

| 13

ItwillfetchalltheMLSRAWdataandstorethemintothelocaldatabase.Itcouldberuntwiceaday,andtakecareof[']thatweaddedtothiscommandforURL,itshouldbeaddedlikeImentionedabove.2.wget-O/dev/nullhttp://your-website.com/?rets_import_cron_job=1ItwilltranslateallthestoredRAWdataanddisplaytheminthewebsite.Itcouldberunevery10-15minutes.3.wget-O/dev/nullhttp://your-website.com/?rets_purge_cron_job=1Itwillpurgealltheexpiredlistings.Itshouldberunevery15minutes.