1 Introduction
- 1.1 Overview
- 1.2 Target Audience
2 Container Image Details
3 Deployment Instructions

Introduction

Overview

In our continuous effort to support our clients' needs, Wordbee has expanded its support for AKS-based Sitecore installations.

This page provides details about the latest container image release for Wordbee Beebox Connector For Sitecore software, version v10.x.x.

Target Audience

This document is intended for use by Client IT and Wordbee teams as a reference for functional specifications, to be adhered to while testing the Wordbee Beebox Connector For Sitecore software.

Container Image Details

The container image is available in the Azure Container Registry. The image is pulled using Entity Framework Libraries. Please get in touch with the Wordbee team to pull the image.

Deployment Instructions

It is assumed that the container image will be deployed using the client's DevOps scripts or standard installation steps as outlined in the Sitecore documentation.

Deployment Validations

Please log in as an administrator to the Sitecore Desktop and verify the installation using the instructions below.

Database Deployment Validation

Verify that the database 'Beebox_Sitecore_Translation' has been added to the DB server.

Beebox Module Installation Validation

To validate the successful installation of items and binaries, follow these steps:

Open the Sitecore Desktop console window.
Open the start bar and check if the Beebox Menu option is present.

Open the Sitecore Content Editor window. Verify that the Beebox Menu is available at the top.

Refer to the content tree. In the tree, right-click on any item. You will see that the Beebox command is listed in the right menu.

Add Connection String For Beebox DB

The Wordbee Beebox Connector For Sitecore module will make use of the “Beebox_Sitecore_Translation” database and we need to set up the connection string appropriately so that it may access the database.
Refer to the following sample connection string. Modify the highlighted values suitably: You will need to provide the name of the SQL Server instance where we added the Beebox_Sitecore_Translation database and the corresponding username and password.

<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=SQL Server Username;
password=SQL Server Password;
MultipleActiveResultSets=True;
App=EntityFramework""
providerName="System.Data.EntityClient" />

Inherit Beebox Field Translation Setting Into Templates

The Beebox Field Translation Settings template has fields to enable and disable translation of the fields or template, thus providing an opportunity for developers and administrators to configure what is translatable.

Inherit the “Beebox Field Translation Setting” template into “Template” and “Template Field” as shown in the screenshot below:

Paths:

Template - /sitecore/templates/System/Templates/Template
Template field - /sitecore/templates/System/Templates/Template field

Manage Beebox Connections

Please refer to the online documentation using this link.

Scheduler Configuration

To avoid manually checking the status of jobs, you can set up the connector to automatically retrieve job statuses in the background. To do this, simply configure a System Task using an Administrator account. For more details, please see the online documentation at the following link.

Advanced Permissions (Optional Step)

By default, only administrators have access to the Beebox extension. If you want non-administrator users to be able to send and/or manage Beebox items, you can grant them access using the default Sitecore security. For more detailed instructions, please refer to the online documentation at this link.

As part of the Beebox Connector, the Wordbee Team introduces the exclusive item permission entity called "Beebox Translate Permission”.

If a non-admin user does not have the "Beebox Translate Permission" granted, they will not be able to initiate a translation request. When such a restricted permission user tries to initiate a translation, they will receive a message about insufficient permission. Users with the "Beebox Translate Permission" will be able to initiate translation requests.

Translate Custom Fields (Optional Step)

By default, the Wordbee Beebox Connector For Sitecore module supports translation for out-of-the-box (OOTB) template fields. If you have developed a custom Sitecore field, please refer to the instructions at this link to enable translation for custom fields.

Support For Display Name Translation (Optional Step)

To activate this option, please refer to the online documentation at this link.

Container image installation