Installing Language I/O Chat in OSC BUI
The purpose of this article is to guide Oracle Service Cloud administrators through the installation and configuration of the Language I/O extension for Chat translation in the Oracle BUI (Browser User Interface).
In this article
- Before you begin
- Installing the Language I/O Extension Zip
- Creating the Language I/O Status Custom Field
- (Optional) Creating a Custom Language Field
- Deploying the Language I/O Custom Object
- Adding the Extension to Interaction Workspaces
- Server Configuration Settings
Before you begin
The Language IO BUI Chat add-in is only compatible with OSC version 21A or above.
Check your OSC (Oracle Service Cloud) site version before you try to install the Language IO BUI Chat add-in. The following screenshots show how to check the version (Go to File > Help > About). The OSC version in this case is 21A, which is compatible with the Language IO BUI Chat add-in:
If your OSC version is lower than 21A, contact your Oracle representative to generate a new site for you that runs the latest version.
Installing the Language I/O Extension Zip
- Download the "LanguageIO_BUI_Chat.zip" file attached at the bottom of this article.
- Go to Configuration > Site Configuration > Add-In Manager.
- In the Ribbon, click New.
- Click Agent Browser UI Extension and open the ZIP file that you downloaded in Step 1.
- As "Extension Type", select "Workspace".
- Set the Init File to "init.html", and the Configuration file to "configs.json".
- If you do not see the option to set the configuration file, this means that you are on an older version of OSC. Follow this article to install the legacy version of the extension.
- In the "Profile Access" tab, enable the extension for all admins who will be editing extension configurations or workspaces, and for all profiles that will use the extension.
- In the Ribbon, click Save & Close.
Creating the Language I/O Status Custom Field
This is a required field. This field stores the status of the most recent translation attempt.
- Go to Configuration > Database > Custom Fields.
- Create a new "text field" type incident field (1).
- Choose a relevant name for your field. This is only visible to agents.
- Set the "Column Name" to
ln_status(2) (spelled with lowercase 'L').
- Enter "Data Details" (3) as shown in the screenshot.
- Set the field to be visible to "Admin" only (4).
- Save the custom field.
(Optional) Creating a Custom Language Field
- Give the Custom Field a relevant name (1). This is visible to agents, and optionally to your end-users. Write down this value. You need it to set the server configuration properties.
- Create a new "Menu" type incident field (2).
- Add all desired languages under "Menu Item".
- Hover with your mouse over each language and write down their IDs (3).
- Language I/O will request the list of all languages & their numeric IDs.
- You need the Language IDs to set the server configuration properties.
- (Optional) You can display this value to your end-users (4). If you check this box, the UI for end-users contains a drop-down menu that lets them select their preferred language themselves.
Deploying the Language I/O Custom Object
LNThreadcustom object. This object holds translation information.
- Download the "LNThread.zip" file attached at the bottom of this article.
- Go to Configuration > Database > Object Designer.
- In the Ribbon, click Import and import the ZIP file (Answer "Next" to all prompts).
- In the Ribbon, click Save, then Deploy. Select Deploy Immediately.
- Depending on site usage, deployment may take between a few minutes and a day. You can continue to work on the installation while this occurs, but you cannot use the extension until the custom objects are deployed.
- After the objects are deployed, go to "Extra Options" in the Ribbon and enable all LNThread permissions for all agents who will use the extension.
Adding the Extension to Interaction Workspaces
- Log out of OSC completely, then log back in. This gives you access to the extension.
- Go to Configuration > Application Appearance > Workspaces/Workflows and open the workspace you want to edit.
Add the Required Fields and Custom Fields
- Create a new tab and give it a relevant name, for example "Language I/O".
- In the Ribbon select the Insert Field tab.
- Drag your language field (Language, or the name of your Custom Language field from chapter 4) into the top row of the Language I/O tab.
Add the Extension
- In the Ribbon, select the Insert Control tab.
- Drag the "LanguageIO_BUI_Chat" extension from the Agent Browser UI Extensions group into the Language I/O tab.
- Select the extension within the tab and open the Design tab of the Ribbon.
- Click Table Cell > Increase Column Span and Position > Stretch Across Top. The size of the visible space when you perform this step determines the minimum size of the extension.
Set the Chat Options
- In the Ribbon, go to Home > Workspace Properties > Options.
- Make sure that the option "Create/associate related incident at the beginning of a chat (if one does not exist)?" is set to "Yes".
Server Configuration Settings
- Go to Configuration > Site Configuration > Add-In Manager > Agent Browser UI Extensions > LanguageIO_BUI_Chat.zip > Profile Access.
- Set the appropriate values for each relevant profile.
- If all profiles use the same configuration, you can set the values for just one and then select Configuration > Apply > Apply this configuration to all profiles and interfaces. This applies the configuration for the current profile and interface to any rofile & interface that is already enabled.
- agentLanguage: This is the numeric ID of the language that agents use. The default is 1, which represents English for default Language field users. If you use Custom Language field, use the ID of the languages that you defined in chapter 4.
- languageField: This is the name of the field that Language I/O uses to determine agent and customer languages. The default is default, which pulls from the Oracle Language field. If you use Custom Language field, enter the name that you defined in chapter 4.
- languageioLogin: This value is typically set by your Language I/O Customer Success Manager. If not, they will let you know what value to use.
- languageioUrl: Leave this value as
https://golinguist.comunless otherwise instructed.
- qualityRatingType: Indicates whether or not agents are allowed to provide quality rating feedback on translated messages they receive from the end-user. Set to 1 to enable a flag rating mechanism, or 0 to disable.