¶ Replicated Site Plugin
The Replicated Plugin for WordPress allows site managers to setup custom sites on WordPress that can be integrated with the ByDesign Replicated Sites API, and offers a configuration screen on the Admin backend where the API parameters can be configured.
After installing the plugin, the Rep URL structure will be in one of the following formats:
- repID.yoursite.com
Example: 1000.adapture.net - URLtext.yoursite.com
Example: grant.adapture.net
DOWNLOAD THE SUBDOMAIN REPLICATED PLUGIN (version 2.5.1)
The plugin option provided is for WordPress use only. If you are not using WordPress, please see the Replicated Site API for details on setting up Replicated Sites via API.
The following requirements must be met before proceeding with the installation to ensure that the Replicated Sites will work:
- PHP extensions php_openssl and php_curl must be enabled
- PHP version 7.0 or higher must be running on the host web server
- Latest version of WordPress is recommended
- A wildcard A record in your DNS provider
- Server has to respond to any request for the wildcard subdomains.
- The server must be configured to accept any subdomain for the selected site domain
- A basic understanding of how to configure WordPress and the use of Short Codes in WordPress
Once the requirements have been met and the WordPress plugin has been installed, proceed with the following installation steps:
- Configure a Replicated Site API User with access only to the Replicated Site API
- Download the Replicated Site WordPress plugin
- In WordPress, install the Replicated Site Plugin by dragging the downloaded zip file into the Plugin Installation page
In WordPress, navigate to Plugins > Add Plugin > select Upload Plugin)
- Once the Replicated Site Plugin has been installed, update the required fields on the Essential Addons
- Username (Required)
- Password (Required)
- Freedom WebFolder (Required)
- About Me Slug (Only used for the Rep Search Plugin)
- Consultant Alias (Only used for the Rep Search Plugin)
- Consultant Alias (Only used for the Rep Search Plugin)
In WordPress, navigate to Essential Addons > ByDesign Replicated
- After filling in the required fields, test the Replicated Site to ensure that a bdtreplicated_cookie is created when attempting to access a Replicate Site, as shown in the image below.
If the cookie has been created, please proceed with short codes.
¶ Using with existing pluging and themes
Short Codes are used in any area of the Replicated Site where a Rep's information must be displayed. The Short Code will then be replaced with the information from the bdtreplicated_cookie generated on the site.
Below is an exmaple of how the _BDT_RepDID_BDT_ Short Code is being utlized for the URL of an action button. When this URL is accessed.
¶ Link Examples
-
To replicate to the All Products Shopping Cart page:
- https://shop.bydesign.com/CLIENTNAME/#/shop/from/_BDT_RepDID_BDT_
- Replace CLIENTNAME with your site name Freedom Back Office site name.
- Example:
-
To replicate to a Shopping Cart category:
- https://shop.bydesign.com/CLIENTNAME/#/shop/from/_BDT_REPDID_BDT_?categoryID=YOURID
- Replace CLIENTNAME with your site name Freedom Back Office site name and YOURID with the id of your shopping category
- Example:
-
To replicate to a Shopping Cart Product:
- https://shop.bydesign.com/CLIENTNAME/#/shop/detail/PRODUCTNUMBER/from/_BDT_REPDID_BDT_
- Replace CLIENTNAME with your site name Freedom Back Office site name and PRODUCTNUMBER with the number from your productID.
- Example:
IMPORTANT: If you have purchased the Customer Experience Package, you will replace https://shop.bydesign.com/CLIENTNAME/ with your custom Shop URL.
Interested in customizing your links? Learn More
- To connect replication from your WordPress website to your Rep enrollment form, use the following structure:
-https://extranet.bydesign.com/[CLIENTNAME]/signup/enrollnew.asp?RepDID=BDT_REPDID_BDT
-Replace [CLIENTNAME] with your Freedom Back Office site name. For example, if your Freedom Back Office URL is https://admin.bydesign.com/Adapture, you will replace CLIENTNAME with Adapture
IMPORTANT: If you have purchased the Customer Experience Package, you will replace https://extranet.bydesign.com with your custom Enrollment URL.
Interested in customizing your links? Learn More
¶ Text Replacement Examples
Example 1:
To display a line that contains Name and email, use the following:
Hello BDT_FirstName_BDT BDT_LastName_BDT, this is your email BDT_Email_BDT.
When the page is rendered, this will show as:
Hello George Grant, this is your email wr@buccaneers.com.
Example 2:
Using PictureFilename to get the Reps uploaded profile picture.
Format the link around an tag and replace CLIENT with the installation name for your Freedom Back Office.
https://extranet.securefreedom.com/CLIENT/Personal/PersonalImages/BDT_PictureFilename_BDT
¶ Creating your own theme
Themecodes allow you to pull a Rep's information for the Replicated Site outside of using WordPress and Short Codes.
For example, to pull in your Rep's name and image, you can use our Sample PHP Code and Sample CSS Code as a starting point to add to the theme's header.php file.
Based on your theme, you may need to tweak some of the code, but this provides a base for you to get started. We recommend creating a child theme before implementing these code changes.
The values for Short Codes will match the fields from the Replicated Site API, GetRepInfo_v3.
https://api.bydesign.com/[CLIENTNAME]/webservice/replicatedsiteapi.asmx?op=GetRepInfo_v3
Replace [CLIENTNAME] with your company name. For example:
https://api.bydesign.com/AdaptureDemo/webservice/replicatedsiteapi.asmx?op=GetRepInfo_v3
The default return level for many of these fields can be set in the Replicated Info Types. You can also allow Reps to override the return of certain fields or to override the returned value in Revolution through Replicated Site Overrides.
Department > Administration > Tools > Replicated Info Types
- _BDT_RepDID_BDT_
- _BDT_RepID_BDT_
- _BDT_Name_BDT_
- _BDT_FirstName_BDT_
- _BDT_LastName_BDT_
- _BDT_Company_BDT_
- _BDT_Email_BDT_
- _BDT_Locale_BDT_
- _BDT_BillStreet1_BDT_
- _BDT_BillStreet2_BDT_
- _BDT_BillCity_BDT_
- _BDT_BillState_BDT_
- _BDT_BillPostalCode_BDT_
- _BDT_BillStreet1_BDT_
- _BDT_BillStreet1_BDT_
- _BDT_BillStreet1_BDT_
- _BDT_BillStreet1_BDT_
- _BDT_BillStreet1_BDT_
- _BDT_BillStreet1_BDT_
- _BDT_BillStreet1_BDT_
- information on how to achieve this
- dyanmics links need to be used so wordpress doesnt take domain and changes it during replication
- commonly found in menus of pages
The bdtreplicated_cookie is base64 encoded with JSON encoded fields with values of the API results from ReplciatedSiteAPI::GetReInfo_V3
To validate that the Replicated Sites are working, confirm that a bdtreplicated_cookie is being generated when a Replicated Site is accessed, or directly test the Replicated Site API, GetRepInfo_v3.
https://api.bydesign.com/[CLIENTNAME]/webservice/replicatedsiteapi.asmx?op=GetRepInfo_v3
¶ No Rep Information Displaying
If you find that that the Replicated Sites are missing Rep details, it's important to ensure that your WordPress site is using the Supported Tags for displaying Rep details.
¶ WordPress Redirect
If WordPress is incorrectly redirecting to a different page, ensure to add the following to the theme’s functions.php file:
remove_filter('template_redirect', 'redirect_canonical');
Please ensure that a Child theme is used and do not add this to the Parent theme to avoid your changes to the functions.php file from being overwritten.
¶ 404 redirect or Permalinks
Some plugins that take over the 404 redirect or Permalinks also have cause conflicts. As it is impossible for us to review all 3rd party plugins, we ask if you run into problems first try disabling all other plugins that use this type of functionality. As a last resort, attempt a clean install with our plugin first before installing any others to help determine what may be causing the conflict.
¶ Caching
The replicated plugin does not work with many caching plugins and services that cache.
¶ Hosting Providers that Require Internal Changes
WPX.net (hosting service) - must disable XDN (aka CDN)
¶ Hosting Providers with Potential Caching Conflicts
- WPEngine (hosting service)
- WordPress.com
- Flywheel
¶ 3rd Party Addons
Clients have reported success with the following 3rd Party Addons:
- Greck Multipurpose WordPress Theme
- WP Bakery Page Builder
- Divi Page Builder
- Elementor Page Builder
- Astra WordPress Theme
- Gtranslate
- Weglot
Clients have also reported issues when utilizing with the WPML Multi-Lingual Plugin.
Once all is successfully installed and configured, you may continue with the following additional plugins.
Before proceeding, the first requirement that the Replicated Site is confirmed working.
¶ Subfolder to Subdomain Redirect Plugin
This is an older Plugin that allows support for legacy URLs, and should only be used if your previous system you are migrating from used Subfolder as an addition to the main Replicated Site Plugin successfully configured.
Example: adapture.net/1000 will redirect to 1000.adapture.net
DOWNLOAD THE SUBFOLDER TO SUBDOMAIN REDIRECT REPLICATED PLUGIN (version 1.2.1)
Please see the Subfolder to Subdomain Addon article for additional information.
¶ Social Media Links Plugin
Please see the Social Media Link Plugin article for additional information.
¶ Rep Search Plugin
Please see the Rep Search Plugin article for additional information.