Beebox-Sitecore Connector is the name of the Sitecore module distributed as a .zip and contains Sitecore following packages.
- Beebox Sitecore Connector Files– contains assemblies and UI artifacts
- Beebox Sitecore Connector Items– contains Sitecore item definition for various settings for core & master database
- Beebox Sitecore Connector Optional Entity Framework DLLs– contains optional Entity framework assemblies to run Beebox-Sitecore Connector, only required to install if Entity framework assemblies are already not part of the Sitecore instance.
These components are installed together. Please connect Wordbee sales to obtain the Beebox Sitecore Connector package. Beebox-Sitecore Connector supports Sitecore XP 7.0, 7.1, 7.2 and 7.5, 8.0, 8.1 and 8.2.
Creating the Translation DB
We need to create a translation database required by Beebox-Sitecore Connector having two tables as described below.
You will need the following scripts to complete the process.
- Create Translation Table
- Create Jobs Table
Launch SQL Server instance with admin credentials.
- Create Database: Create a new database named “Beebox_Sitecore_Translation”.
- Create Tables: With “Beebox_Sitecore_Translation”database selected run SQL scripts “Create Translation Table” and “Create Jobs Table”.
Installing the packages
Login to Sitecore as admin and: Launch Sitecore Installation Wizard, upload and install the packages as described.
- Mandatory: Beebox Sitecore Connector Items.zip & Beebox Sitecore Connector Files.zip
Upload and install Beebox Sitecore Connector Items.zip, followed by Beebox Sitecore Connector Files.zip. Restart the Sitecore client, once promoted to do so.
- Optional:Beebox Sitecore Connector Optional Entity Framework DLLs
Only install optional package, if the solution already does not has a reference to Entity Framework. You should look into the bin folder of the solution for EntityFramework.dll
and EntityFramework.SqlServer.dll, if they are already present, skip installation of optional package.
Setting the SQL connection string
The Beebox-Sitecore Connector will make use of the “Beebox_Sitecore_Translation” database and we need to setup the connection string appropriately so that it may access the database.
- Inside the ………..\Website\App_Config\Include\Beebox folder, locate Beebox.Sitecore.config.
- Copy the sample connection string:as displayed provided at the bottom of the Beebox.Sitecore.config or copy from the below sample.
<add
name="Beebox_Sitecore_TranslationEntities"
connectionString="metadata=res://*/Beebox_Sitecore_Translation.csdl|
res://*/Beebox_Sitecore_Translation.ssdl|res://*/Beebox_Sitecore_Translation.msl;
provider=System.Data.SqlClient;
provider connection string="
data source=SQL Server Instance Name;
initial catalog=Beebox_Sitecore_Translation;
user id=Username;
password=password;
MultipleActiveResultSets=True;
App=EntityFramework""
providerName="System.Data.EntityClient" />
Locate connectionStrings.config, usually placed at…./Website/App_Config/ConnectionStrings.config and paste the new connectionString at the bottom of existing connection strings as given below.
<connectionStrings>
<!--
Sitecore connection strings.
All database connections for Sitecore are configured here.
-->
<addname="core"connectionString="user id=XX;password=XXXX;Data Source=XXXXX;Database=XXXXXXXSitecore_Core"/>
<addname="master"connectionString="user id=XX;password=XXXX;Data Source=XXXXX;Database=Beebox71Sitecore_Master"/>
<addname="web"connectionString="user id=XX;password=XXXX;Data Source=XXXXX;Database=Beebox71Sitecore_Web"/>
<addname="Beebox_Sitecore_TranslationEntities"
connectionString="metadata=res://*/Beebox_Sitecore_Translation.csdl|res://*/Beebox_Sitecore_Translation.ssdl|res://*/Beebox_Sitecore_Translation.msl;
provider=System.Data.SqlClient;
provider connection string="
data source=SQL Server Instance Name;
initial catalog=Beebox_Sitecore_Translation;
user id=username;
password=password;
MultipleActiveResultSets=True;
App=EntityFramework""
providerName="System.Data.EntityClient" />
</connectionStrings>
Modify the highlighted values suitably: You will need to provide the name of SQL Server instance where we created Beebox_Sitecore_Translation database and corresponding username and password.
Verify the installation of Beebox-Sitecore connector
Once the above steps are performed successfully, we will have a visual clue of success in the form of a few Beebox Applications, tabs on ribbons and context menu on items.
Beebox Applications: Login as admin to Sitecore Desktop and click Sitecore Start button.
Beebox Tab: In your Content Editor ribbon, you should observer a new Tab called “Beebox” as given in the screenshot below.
Beebox Item Content Menu: Select any item from the content tree, right click to find new Beebox Translate Item commands as given in the screenshot below
Inherit Beebox Field Translation Setting Template
IMPORTANT This step is required and skeping it will prevent items to be added to the Content Selector.
The Beebox Field Translation Settings template has fields to enable and disable translation of the fields or template, thus providing an opportunity to developer and administrators to configure what is translatable.
By default, all the non-Sitecore templates are translatable, Launch Sitecore Content Editor and navigate to templates node:
- Beebox Field Translation Setting: You will observe a Beebox template folder, drill down to the template and notice “Beebox Field Translation Setting” template.
- Inherit into Template and Template Field template: Inherit the “Beebox Field Translation Setting” template into “Template” and “Template Field” as shown in the screenshot below.
Creating a Beebox Connection
This section describes how to create a Beebox connection. The steps assume that you have already set up a Beebox project on your Beebox server. Open Beebox Setting application as described below.
- Open Beebox Setting application: Login as Admin to Sitecore Desktop, click Start button, Select Beebox and choose Beebox –Settings applications as shown in the screenshot below.
Create a New Connection: The Beebox – Setting application lets you create new and update existing Beebox connection. Click “Add New” Command on the top left to create a new Beebox connection;following screen would be shown and provide the suitable values. You can use any memorable name for connection name.
The connection page shows these fields:
Field | Description |
Beebox Connection name | Give this connection any name. For example the name of your translation service provider. |
Beebox Project Source language | The source language that is configured in your Sitecore site. |
Beebox Url | A URL pointing to the Beebox server. Supplied by the Beebox manager: /wiki/spaces/JOOMLA/pages/698140 |
Beebox Project Key | A key identifying a Beebox project. Supplied by the Beebox manager. |
Beebox Login | A login to access the Beebox. Supplied by the Beebox manager. |
Beebox Password | A password to access the Beebox. Supplied by the Beebox manager. |
Login Timeout(Seconds) | Connector connection timeout with Beebox. |
Default Connection | Setting default connection in case of many Beebox connections. |
Test & Save the Beebox Connection: We need to test the newly created/updated settings to ensure that it works as per our expectations. Click on the heart icon i.e. Test command, our heartbeat command. It should display a success message "Yes, it works!". You may check the “Set as default connection” checkbox to make it your default connection. Click Update connection to save the connection.
Add More Languages to Sitecore
Please ensure that your Sitecore instance is configured to have multiple languages. You will need to go to Sitecore System item and find the language list. In case, you have English as the only language configured, you are advised to add a few more languages before moving to next step.
Next step-:Upgrading the plugin