Babylon-Enterprise Administrator...

Babylon-Enterprise

Administrator Guide Version NG/10

Babylon-Enterprise Administrator Guide - 2 -

Babylon-Enterprise Administrator Guide

© 2014-2020 Babylon-Software Ltd.

The information in this manual is subject to change without prior notice and does not represent a commitment on the part of Babylon. Babylon assumes no responsibility or liability for any errors or inaccuracies that may appear in this manual.

The software described in this document is furnished under a license agreement. The software may be used or copied only in accordance with the terms and conditions of the license agreement. Except as permitted by such license, no part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means - electronic, mechanical, recording, or otherwise - without the prior written permission of Babylon.

http://www.babylon-enterprise.com

[email protected]

http://www.babylon-enterprise.com/

mailto:[email protected]?subject=%5bAdmin%20Guide%5d


Table of Contents

1 BABYLON-ENTERPRISE ................................................................ 9 1.1 System Overview ........................................................................................ 9 1.2 Babylon-Enterprise Architecture .............................................................. 10 1.3 Babylon-Enterprise Server ....................................................................... 10

1.3.1 Application Services ............................................................................. 11 1.3.2 Web Administration Interface ............................................................... 12 1.3.3 Command Line Administration Utility ..................................................... 12 1.3.4 Web Requester ................................................................................... 12 1.3.5 Glossary Extractor ............................................................................... 12 1.3.6 Babylon-Enterprise Packager ................................................................ 12

2 INSTALLATION ........................................................................... 13 2.1 Installation Overview ............................................................................... 13 2.2 System Requirements............................................................................... 13

2.2.1 Server Requirements ........................................................................... 13 2.2.2 Client Requirements ............................................................................ 13

2.3 Babylon-Enterprise Server Installation .................................................... 14 2.3.1 Setup Guide ........................................................................................ 14 2.3.2 Web Requester Configuration ............................................................... 19 2.3.3 Application Services Configuration ........................................................ 19 2.3.4 Installing an Application Service ........................................................... 20 2.3.5 Uninstalling an Application Service ........................................................ 20 2.3.6 Administration Service Configuration ..................................................... 20 2.3.7 Translation Service Configuration .......................................................... 21 2.3.8 Verifying Application Services State ....................................................... 23

2.4 Babylon-Enterprise Client Installation ..................................................... 24 2.4.1 Creating Client Installation Packages ..................................................... 24

Source Files ...................................................................................... 25 Activation Shortcuts .......................................................................... 25 Client Proxy Settings ......................................................................... 25 Online Actions .................................................................................. 25 Enterprise Server .............................................................................. 26 Client Installer Defaults ..................................................................... 26 Information Sources (Glossaries) ........................................................ 28 Licenses ........................................................................................... 28 Additional Client Customization Files ................................................... 29 Override Offline GUI .......................................................................... 29 MSI Upgrade URL ............................................................................. 29 Destination ....................................................................................... 29

2.4.2 Interactive Client Installation ................................................................ 29

3 SERVER ADMINISTRATION: WEB INTERFACE ........................... 32 3.1 Configuring the Administration Web Interface ........................................ 32 3.2 Administration Web Interface Overview .................................................. 32 3.3 Glossary Management .............................................................................. 33

3.3.1 Viewing Installed Glossaries ................................................................. 33 3.3.2 Installing Glossaries ............................................................................. 34 3.3.3 Removing Glossaries ........................................................................... 34 3.3.4 Viewing Glossary Details ...................................................................... 34 3.3.5 Setting Glossary Status ........................................................................ 35 3.3.6 Setting Online Glossary Permissions ...................................................... 35 3.3.7 Configuring Offline Glossary Distribution ................................................ 36 3.3.8 Configuring the Client’s Glossary List ..................................................... 37 3.3.9 Performing Operations on Multiple Glossaries ........................................ 37


3.4 License Management ................................................................................ 38 3.4.1 Viewing Installed Licenses .................................................................... 38 3.4.2 Installing Licenses ............................................................................... 38 3.4.3 Distributing Licenses ............................................................................ 38 3.4.4 Revoking Licenses ............................................................................... 39 3.4.5 Removing Licenses .............................................................................. 39

3.5 Client Configuration ................................................................................. 39 3.5.1 Configuration Files ............................................................................... 40 3.5.2 Distributing Configuration Files ............................................................. 40 3.5.3 Client Configuration ............................................................................. 40

3.6 Server Log ................................................................................................. 41 3.6.1 Log Cache .......................................................................................... 41 3.6.2 Log File .............................................................................................. 41

3.7 Server Settings ......................................................................................... 42 3.7.1 Proxy Server ....................................................................................... 42 3.7.2 Glossary and Currency Rates Updates ................................................... 42 3.7.3 Server Scalability ................................................................................. 43

4 SERVER ADMINISTRATION: COMMAND-LINE INTERFACE ........ 44 4.1 Configuring the Administration Command-Line Interface ....................... 44 4.2 Commands Overview ................................................................................ 44

4.2.1 Help ................................................................................................... 44 4.2.2 Server Version .................................................................................... 45

4.3 Glossary Management .............................................................................. 45 4.3.1 Viewing Installed Glossaries ................................................................. 45 4.3.2 Installing/Updating Glossaries .............................................................. 45 4.3.3 Removing Glossaries ........................................................................... 46 4.3.4 Configuring Installed Glossaries ............................................................ 46 4.3.5 Available Domains ............................................................................... 47 4.3.6 Available Entities ................................................................................. 47

4.4 License Management ................................................................................ 48 4.4.1 Installing a License .............................................................................. 48 4.4.2 Removing a License ............................................................................. 48 4.4.3 Modifying License Status ...................................................................... 48 4.4.4 Viewing Installed Licenses .................................................................... 48

4.5 Server Management ................................................................................. 49 4.5.1 Server Log .......................................................................................... 49 4.5.2 Server Scalability ................................................................................. 50 4.5.3 Flushing Permissions Cache .................................................................. 50 4.5.4 Glossary and Currency Rates Updates ................................................... 50 4.5.5 Proxy Server Settings .......................................................................... 51

4.6 Client Configuration ................................................................................. 51

5 MANAGE SERVER ACTIVITY LOG FILES ..................................... 52 5.1 Introduction ............................................................................................. 52 5.2 Understanding the Activity Log Files ........................................................ 52

5.2.1 Administration Service Activity Log file .................................................. 52 5.2.1 Translation Service Activity Log file ....................................................... 53

5.3 Querying the Log Files with the Glossary Extractor ................................. 53

6 GLOSSARY EXTRACTOR ............................................................. 54 6.1 Introduction ............................................................................................. 54 6.2 System Requirements............................................................................... 54 6.3 Creating a Glossary Using the Glossary Extractor .................................... 54 6.4 Glossary Extractor – Graphical Interface ................................................. 55 6.5 Glossary Extractor Express Mode ............................................................. 55 6.6 Glossary Extractor Wizard Mode .............................................................. 57

6.6.1 Select Data Source Window ................................................................. 57 6.6.2 MS-Office Parameters Window ............................................................. 58


6.6.3 MS SQL Server Parameters Window ...................................................... 59 6.6.4 Oracle Parameters Window .................................................................. 60 6.6.5 MySQL Server Parameters Window ....................................................... 61 6.6.6 ODBC Parameters Window ................................................................... 62 6.6.7 XML Parameters Window ..................................................................... 63 6.6.8 SharePoint Parameters Window ............................................................ 64 6.6.9 Active Directory/LDAP Parameters Window ............................................ 65 6.6.10 SalesForce Parameters Window ............................................................ 66 6.6.11 SQLite Parameters Window .................................................................. 67 6.6.12 SAP Parameters Window ...................................................................... 68 6.6.13 IBM DB/2 Parameters Window ............................................................. 70 6.6.14 Build Glossary Template Window .......................................................... 71 6.6.15 General Parameters Window ................................................................ 73

6.7 Utilities ..................................................................................................... 75 6.7.1 Create New Header ............................................................................. 75 6.7.2 Server Reports .................................................................................... 77 6.7.2.1 Report 1: Number of Installed Clients ............................................ 78 6.7.2.2 Report 2: Glossaries Usage-Glossary Hits per Day ........................... 78 6.7.2.3 Report 3: User Searches with No Answer ....................................... 78 6.7.2.4 Report 4: User Hits-per Glossary per Day ....................................... 80 6.7.2.5 Report 5: Daily Summary .............................................................. 80 6.7.2.6 Report 6: Concurrent Translation Requests ..................................... 80 6.7.2.7 Report 7: User Popular Searches ................................................... 81 6.7.2.8 Report 8: Enterprise/Translation Usage Analysis ............................. 81 6.7.2.9 Report 9: Requests per Hour ......................................................... 83 6.7.2.10 Report 10: Distribution of Answers and Users by Glossary ............... 83 6.7.2.11 Report 11: Non-Active Hosts and Users .......................................... 84 6.7.2.12 Report 12: Clients Versions Distribution .......................................... 84 6.7.2.13 Report 13: Search Method Distribution ........................................... 84 6.7.2.14 Report 14: Distribution of Glossaries Usage per Day ........................ 85 6.7.2.15 Report 15: Distribution of Users Usage per Day .............................. 85 6.7.2.16 Report 16: Last Usage Date per User ............................................. 86 6.7.3 Query Manager ................................................................................... 87

6.8 Glossary Extractor – Background Mode ................................................... 89 6.9 Glossary Extractor – Data sources ........................................................... 89

6.9.1 Microsoft Office Files – Excel and Access ............................................... 89 6.9.1.1 Excel ........................................................................................... 89 6.9.1.2 Access ......................................................................................... 89 6.9.2 Microsoft SQL Server ........................................................................... 91 6.9.3 Oracle Database Server ....................................................................... 92 6.9.4 MySQL Server ..................................................................................... 93 6.9.5 ODBC ................................................................................................. 94 6.9.6 IBM DB/2 Database ............................................................................. 95 6.9.7 XML ................................................................................................... 96 6.9.7.1 Introduction ................................................................................ 96 6.9.7.2 Parsing the XML into a table .......................................................... 98 6.9.7.3 XML with repetitive structures ....................................................... 99 6.9.7.4 XML Parameters ......................................................................... 100 6.9.8 Microsoft SharePoint .......................................................................... 103 6.9.8.1 Introduction .............................................................................. 103 6.9.8.2 MS SharePoint Parameters .......................................................... 103 6.9.9 Active Directory/LDAP ........................................................................ 105 6.9.9.1 Introduction .............................................................................. 105 6.9.9.2 Active Directory Parameters ........................................................ 105 6.9.9.4 Non .Net Supported LDAP Directories ........................................... 106 6.9.10 SalesForce ........................................................................................ 107 6.9.10.1 Introduction .............................................................................. 107 6.9.10.2 SalesForce Parameters ............................................................... 107 6.9.11 SQLite Database ............................................................................... 108 6.9.11.1 SQLite Parameters ..................................................................... 108


6.9.11.2 SQLite Customized Functions ...................................................... 108 6.9.11.2.1 INSTR Function ....................................................................... 108 6.9.11.2.2 SPLITSTR Function .................................................................. 108 6.9.11.2.3 BASE64 Function ..................................................................... 109 6.9.11.2.4 KILOFORMAT Function ............................................................. 109 6.9.11.2.5 HASHSTR Function ................................................................... 109 6.9.11.2.6 IPADDRESS Function ................................................................ 110 6.9.11.2.7 GETADPROPERTY Function ....................................................... 110 6.9.11.2.8 URLENCODE Function .............................................................. 110 6.9.11.2.9 GETSPPROPERTY Function ....................................................... 111 6.9.11.2.10 LOCINARRAY Function ............................................................ 111 6.9.12 SAP .................................................................................................. 112 6.9.12.1 Introduction .............................................................................. 112 6.9.12.2 SAP Parameters ......................................................................... 112 6.9.13 Microsoft Outlook Contacts................................................................. 114 6.9.14 File System (NTFS) ............................................................................ 115 6.9.15 Automatic Data Generation ................................................................ 116 6.9.16 Automatic Reports Generation ............................................................ 118

6.10 Glossary Extractor – General Settings ................................................. 119 6.11 Glossary Extractor – Web Source Inclusion Settings ........................... 121 6.12 Glossary Extractor – Administration Settings ...................................... 121 6.13 Glossary Extractor – Babylon Services Settings .................................. 122 6.14 Glossary Extractor - Glossary Template File ........................................ 123

6.14.1 Introduction ...................................................................................... 123 6.14.2 Basic Elements .................................................................................. 123 6.14.3 References between terms ................................................................. 123 6.14.4 Column Value Elements ..................................................................... 124 6.14.3 Alternate Forms Elements .................................................................. 127 6.14.4 Conditional Inclusion Element ............................................................. 130 6.14.5 Aggregation Template ....................................................................... 131 6.14.5.1 Introduction .............................................................................. 131 6.14.5.2 Aggregation Tags ....................................................................... 131 6.14.5.3 Aggregation Template Example ................................................... 132

6.15 Side Template – Extended Aggregation ............................................... 134 6.15.1.1 Introduction .............................................................................. 134 6.15.1.2 Side Template Parameters .......................................................... 134 6.15.1.3 Side Template Tags .................................................................... 134 6.15.1.4 Side Template Usage – Example .................................................. 135

6.16 Hybrid (Real-time) Glossary ................................................................ 137 6.16.1.1 Introduction .............................................................................. 137 6.16.1.2 Building Hybrid Glossary ............................................................. 137 6.16.1.3 Mechanism ................................................................................ 137 6.16.1.4 Example .................................................................................... 138 6.16.1.5 Special Considerations ................................................................ 138

6.17 Enhanced Alternate Forms ................................................................... 139 6.17.1.1 Introduction .............................................................................. 139 6.17.1.2 Solution ..................................................................................... 139 6.17.1.3 Example .................................................................................... 139

6.18 Creating Multiple Glossaries from a Data Source ................................ 140 6.18.1.1 Introduction .............................................................................. 140

Parameters ..................................................................................... 140 Removing Outdated Glossaries ......................................................... 141 MultipleGlossaries Usage – Example ................................................. 142

7 TEXT (UNSTRUCTURED) SEARCH ............................................. 143 7.1 Introduction ........................................................................................... 143 7.2 Prerequisites ........................................................................................... 143

7.2.1 Glossary Extractor ............................................................................. 143 7.2.2 ASP.Net on IIS .................................................................................. 144


7.3 Creating Index and Search Solution for Files or Web Site ..................... 144 7.3.1 Indexing ........................................................................................... 144 7.3.2 Searching ......................................................................................... 145 7.3.2.1 Installing the Search Application (ASP.Net) ................................... 145 7.3.2.2 Configuring the Search Application (ASP.Net) ............................... 146 7.3.2.3 Customizing the Search Application (ASP.Net) .............................. 146 7.3.2.4 Creating the Integrated Glossary ................................................. 147

7.4 Creating Index and Search Solution for Microsoft SharePoint Search Service .................................................................................................... 148

7.4.1 Indexing ........................................................................................... 148 7.4.2 Searching ......................................................................................... 148 7.4.2.1 Installing the Search Application (ASP.Net) ................................... 148 7.4.2.2 Configuring the Search Application (ASP.Net) ............................... 148 7.4.2.3 Customizing the Search Application (ASP.Net) .............................. 149 7.4.2.4 Creating the Integrated Glossary ................................................. 149

8 BABYLON-ENTERPRISE CLIENT ............................................... 150 8.1 Babylon-Enterprise Client Application .................................................... 150

8.1.1 Introduction to the Client ................................................................... 150 8.1.2 Activating Babylon-Enterprise ............................................................. 150

8.2 Babylon-Enterprise Window ................................................................... 151 8.2.1 Window Overview ............................................................................. 151 8.2.2 Toolbar ............................................................................................ 151 8.2.3 Term Box ......................................................................................... 152

Using the Term Box ........................................................................ 152 Browsing Terms Previously Queried .................................................. 152

8.2.4 Results Pane ..................................................................................... 152 8.2.5 Sidebar Pane .................................................................................... 153 8.2.6 Additional Interface Elements ............................................................. 153

8.3 Results .................................................................................................... 153 8.3.1 Results Menu .................................................................................... 153 8.3.2 Information Source Menu ................................................................... 154 8.3.3 Spelling Alternatives and More Results ................................................ 154

8.4 Information Sources ............................................................................... 155 8.4.1 Information Sources (Glossaries) ........................................................ 155 8.4.2 Managing Information Sources ........................................................... 155

Active Sources ................................................................................ 155 Show Results from Active Sources Only ............................................ 155 Status of Sources ............................................................................ 156 Order of Results ............................................................................. 156 Information Source Details .............................................................. 156 Removing an Installed Information Source ........................................ 156

8.4.3 Installing Information Sources ............................................................ 156 8.5 Translation Utility ................................................................................... 157

8.5.1 Term Translation ............................................................................... 157 8.5.2 Full Text Translation .......................................................................... 157 8.5.3 Document Translation: ...................................................................... 158 8.5.4 Web Page Translation ........................................................................ 158

8.6 Language Utilities ................................................................................... 159 8.6.1 Cross-Translation .............................................................................. 159 8.6.2 Conjugations .................................................................................... 159

8.7 Conversion Utility ................................................................................... 160 8.8 Customizing the User Interface .............................................................. 161

8.8.1 Shortcuts Settings ............................................................................. 161 8.8.2 Display Settings ................................................................................ 161

User Interface Language ................................................................. 162 Results Display ............................................................................... 162 Window Settings ............................................................................. 162

8.8.3 Connection Settings ........................................................................... 162 Connection ..................................................................................... 162


8.8.4 Licenses ........................................................................................... 164 8.9 Babylon-Enterprise Client Menu ............................................................. 165

9 BACKUP AND RESTORE ............................................................ 166 9.1 Babylon-Enterprise Server ..................................................................... 166

9.1.1 Backup Server ................................................................................... 166 9.1.2 Restore Server .................................................................................. 166

9.2 Development Environment ..................................................................... 166 9.2.1 Backup Development Environment ...................................................... 166 9.2.2 Restore Development Environment ..................................................... 166

APPENDIXES .................................................................................. 167

APPENDIX A: ENHANCED ALTERNATE FORMS-XSL TEMPLATE ...... 168


1 Babylon-Enterprise

1.1 System Overview

Babylon-Enterprise is an information delivery system that gives users instant, single-click access to information from enterprise applications, such as ERP and CRM, and data sources such as Microsoft SQL Server and Oracle, ODBC data sources, LDAP/Active directories, and XML, Excel and Access files.

Babylon-Enterprise is an integrated client and server system, comprising a desktop client and a web application server that communicate using industry standard protocols (XML/HTTP).

The Babylon-Enterprise server creates an indexed corpus of the enterprise data by means of built-in extraction tools or custom extraction programs, and then converts the data into a Babylon-Enterprise “glossary” format. Once created, the enterprise information sources (or enterprise glossaries) are deployed on the application server.

The Babylon-Enterprise client is installed on every user desktop and serves as a unified interface for displaying results. As soon as the user clicks on a word, term or number using a dedicated mouse button, key, or mouse key combination, the Babylon-Enterprise client application immediately opens a popup window and instantly delivers concise and relevant information from the appropriate information source. The Babylon-Enterprise client works on text displayed in any Windows applications.

At the core of the Babylon-Enterprise client technology are sophisticated algorithms for identifying the word clicked by the user. Babylon-Enterprise scans the characters and words to the right and left of the word, and recognizes the query in context.

The system supports standard Windows user and role based permissions to provide secure access to enterprise information. The system administrator assigns access rights to each of the enterprise information glossaries, and enables online access for each of the glossaries that are stored only on the server, and offline access for each of the glossaries that are distributed to desktops for offline use.

The application server ensures that the information delivered to the users is updated regularly and transparently.


1.2 Babylon-Enterprise Architecture

The following diagram outlines the Babylon-Enterprise architecture:

Babylon-Enterprise System Architecture

1.3 Babylon-Enterprise Server

The Babylon-Enterprise Server comprises several components:

• Application Services:

▪ Administration Service: The service responds to queries from Babylon clients and performs the administrative tasks such as periodical communication with the client, synchronization of offline content (glossaries), etc.

▪ Translation Service: The service responds to queries from Babylon clients, validates security credentials, and performs the information retrieval from the server glossaries.

• Web Administration Interface: A web browser interface provides access to the administration service, allowing system administrators to perform management and maintenance tasks from any location.

• Command Line Administration Utility: A command line utility to manage the services.

• Web Requester: An IIS ISAPI gateway between clients and the server-side services. The requester routes the requests from the client to one of the application services per the type of the request as defined by the client.

• Babylon-Enterprise Extractor: A tool for creating snapshots of enterprise data and for converting the information into enterprise glossaries to be used by the application services.

• Babylon-Enterprise Packager: A utility for creating client installers with customized defaults.


1.3.1 Application Services

The application services are scalable Windows services that provide secure access to enterprise information. The services are designed to work in a cluster mode. Each can be installed more than once, on the same server instance or on multiple instances, together or separately. The services use standard Windows user and role based permissions, commonly managed by system administrators, to safeguard access to sensitive information and to control software and glossary distribution.

Babylon-Enterprise Cluster Scheme

The translation service is in-charge of:

• Authenticating Babylon-Enterprise clients using existing Windows network user and group identifications, and validate access permissions for information sources (glossaries). Security credentials control both access to glossaries stored on the server and distribution of glossaries to client users’ workstations.

• Providing access to enterprise information stored as glossaries on the server. These glossaries are stored in a secure location on the server and provide results only to authenticated users.

The administration service is in-charge of:

• Distributing enterprise information glossaries client workstations to enable offline use. The service automatically distributes only differential updates of the glossaries to clients, thereby conserving network bandwidth and expediting updates even on slower communication lines. Distribution of glossaries for offline use is based on the same security credentials used for server-based glossaries, and enables distribution of different sets of glossaries for different groups of users in the organization. Periodically, each client queries the service for glossary updates. The service validates the client’s security credentials and provides differential updates only for glossaries the user is permitted to view.

• Distributing client software updates and configuration changes to all connected clients, regardless of their security credentials.

• Providing software interfaces for control and administration of the server and desktop clients. These interfaces are used by the web administration interface and by command line administration tools.


1.3.2 Web Administration Interface

The web administration interface enables system administrators to manage the server from any location using a standard web browser. System administrators use the interface to centrally control all clients installed in the organization, and to enable distribution of software updates and configuration changes. This interface also makes it possible to distribute updates for the enterprise information glossaries installed locally on client desktops. The simple interface allows administrators to implement changes, control licenses, define network topology settings (e.g., network proxy setup), deploy software maintenance releases, and manage all other aspects of client configuration.

Refer to Chapter 3, Server Administration: Web Interface.

1.3.3 Command Line Administration Utility

The command line administration utility provides a non-interactive interface for the Babylon-Enterprise application services and enables system administrators to automate common administration tasks in batch file and scripts.

Refer to Chapter 4, Server Administration: Command-Line

1.3.4 Web Requester

The web requester is an ISAPI module that is installed as an extension to the web server. It directs requests from clients arriving at the web server to the Babylon-Enterprise application services. The web requester (and IIS web server) can be deployed separately from the application services to provide greater security.

1.3.5 Glossary Extractor

The Babylon-Enterprise Extractor is a tool for creating, maintaining and updating enterprise information glossaries. The Extractor extracts data from enterprise data sources, such as Microsoft SQL Server and Oracle databases, ODBC data sources, XML files, LDAP/Active directories, and Microsoft Office files (Excel, Access), and creates snapshots of the information.

Refer to Chapter 5.

1.3.6 Babylon-Enterprise Packager

The Babylon-Enterprise Packager is used to create Babylon-Enterprise client installers with custom configuration options, before deploying them on desktop computers. The Packager can configure which glossaries and licenses are installed by default, and other default settings.

Refer to Section 2.4, Babylon-Enterprise Client Installation.


2 Installation

2.1 Installation Overview

The Babylon-Enterprise Server installation comprises the following steps:

1. Installation of Babylon-Enterprise Server components.

The server setup installs all or some of the server components, depending on your choice of setup.

2. Creation of Babylon-Enterprise Client installers.

Before the initial deployment of clients, you need to create a client installer. Babylon-Enterprise Packager allows you to prepare installers for your system’s users by customizing the basic client installer included in the server with specific glossaries, licenses and other default settings.

3. Installation of Babylon-Enterprise desktop clients.

The initial client installation should be performed using third-party tools or by the client users. Subsequent updates and upgrades will be performed automatically by the server.

2.2 System Requirements

2.2.1 Server Requirements

The minimum requirements for the Babylon-Enterprise Server are as follows:

• Windows 2012/2016 Server R2 64 bit with IIS

• Microsoft Internet Explorer Version 11

• Microsoft .Net Framework version 3.5 and 4 (extended)

• A local NTFS volume

• Local Administrator user rights are required to install the server

2.2.2 Client Requirements

The minimum requirements for the Babylon-Enterprise Client are as follows:

• Windows 7/10

• Microsoft Internet Explorer 11


2.3 Babylon-Enterprise Server Installation

2.3.1 Setup Guide

1. Login to the Windows server with a user that belongs to the local administrators group. Verify it by running "lusrmgr.msc", go to groups and double click the “administrators” group and make sure the user name is a mem

2. ber of the group.

3. Install Microsoft .Net 4 for Windows 64 bit. You can download it from Microsoft web site or from here.

4. Go to “Server Manager”, click on “Roles” in the left frame and select “Add Roles” on the right frame. From the roles list, check the option “Web server (IIS)” and continue. In “Select Role Services”, apply the following selection and continue until the installation is completed.

http://bes.babylon.com/ftp/Download/dotNetFx40_Full_x86_x64.exe


5. In “Server Manager”, click on “Features” in the left frame and select “Add Features” on the right frame. From the roles list, check the option “.NET Framework 3.5.1 Features” and continue until the installation is completed.

6. Start the server installation by running the file: Babylon-Enterprise Server 9.msi. The latest version of the installer can be downloaded here.

7. Read the Welcome message, and click Next to continue.

http://bes.babylon.com/ftp/babylon/Babylon-Enterprise%20Server%209.msi


8. Read the License Agreement. Select Accept and click Next to continue.

9. Click Browse to set the installation folder as “Babylon-Enterprise Server” in the root of the preferred volume. Click Next to start the installation.

10. Click Install to start the installation


11. Click Finish to exit the setup program.

12. After the Babylon-Enterprise Server is successfully installed, the following folders are created in the installation folder:

• Admin: include the command line administration utility

• Builder: include the server compiler files and the Glossary Extractor

• Common: include basic files shared by all product component and default configuration files

• Packager: include the Packager installation

• Service: include the files required to run the application services

• Site: include the web requester and the Web Administration Interfaces

• XSL: include the interface files for the translation service API, currently targeted for clients running on smartphones (BlackBerry, Android)

13. Download the most updated Extractor version from http://bes.babylon.com/ftp/babylon/x64/GLSExtractor64.exe and copy it to “\Babylon-Enterprise Server\Builder\Glossary Extractor\bin\”

14. Open the “IIS manager” and click on “Babylon Web Site” entry in the left frame and open the “Handler Mappings” in the right frame. In the action menu select “Add Module Mapping” and fill in the details below:

http://bes.babylon.com/ftp/babylon/x64/GLSExtractor64.exe


15. Click “Request Restrictions”, switch to the “Access” tab and select “Execution”.

16. Confirm all operations.

17. Stand on the handler you just created and select “Edit Feature Permissions” from the action menu. Check the “Execute” box and confirm.

18. Click on “BabylonAdmin2” application in Babylon Web Site entry in the left frame and open the “Authentication” in the right frame. Make sure the only entry in status “Enabled” is “Windows Authentication”.

19. The default installation creates the Babylon web site with binding to port 8080 as the HTTP listening port. To change it, please refer to the IIS manual.

20. Click on “Application Pools” entry in the left frame. Create a new pool called “BELocalUI” with the default values. Copy the folder “LocalUI” from the “Packager” folder of the server to the root folder of the IIS “Default Web Site” (by default it is “c:\inetpub\wwwroot\”). Refresh the view of “Default Web Site” and right mouse click on the “LocalUI” folder and select Convert to Application. Click Select and choose the application pool “BELocalUI” and confirm.

21. Download the predefined configuration file from here. Copy all the XML files from the zip file to the “Common” folder while you make sure you overwrite the file created by the installation. Open all XML files in folder “Common” in a text editor and perform the following changes:

a. Replace all occurrences of the string “golda” with the host name of the server (should be 16 replacements).

http://bes.babylon.com/ftp/babylon/config.zip


b. If you changed the default HTTP binding of “Babylon Web Site”, replace all occurrences of the string “8080” with the new HTTP port number you set for the binding.

c. In file “BabylonServicesTrans.Config.xml”, locate the XML node “<ServerURL>”. Replace the string “babylon-int.co.il” with the full DNS suffix of the server as it is identified by the client side.

22. Copy all the BAT files from the zip file to the “Service” folder. If the destination folder of the installation is other than “c:”, open the four BAT files in a text editor and change all occurrences of “c:” to the volume of your destination folder. Run As Administrator “Admin_SVC_Install.bat” and “Trans_SVC_Install.bat”.

23. Run “services.msc” and start service “BE-Admin” and after that “BE-Trans”.

24. Verify the product is installed and configured correctly by opening an internet browser and:

a. Go to http://<Server Name>:<HTTP Binding Port>/BabylonEnterpriseServer/Babylonserver.dll?Ping

The correct response should be Admin – Pong.

b. Go to http://<Server Name>:<HTTP Binding Port>/BabylonEnterpriseServer/Babylonserver.dll?transPing

The correct response should be Trans – Pong.

25. At this point you can access Administration console (http://<Server Name>:<HTTP Binding Port>/BabylonAdmin2)

and verify it is loaded correctly.

2.3.2 Web Requester Configuration

The installation place the web requester module, BabylonServer.dll, in the site folder of

the installation. The requester requires a configuration file to function. It reads the file during initialization: if the configuration is updated, the web site must be restarted to pick up the changes.

The requester configuration file is stored in the XML format. A default configuration file, BabylonServicesAdmin.Config.xml, is in the Common folder of the product

installation. You can set more than one requester on the same machine, in the same folder while renaming the requester file name or in a different folder. The requested will look for a configuration file named <Requester File Name without extension>.xml, in the

same folder of the requester file or otherwise, use the default in the common folder.

To examine the configuration of the web requester while it is running, issue an HTTP request from a browser with the URL of the requester, with the parameter Config. For example: http://MyServer:8080/BabylonEnterpriseServer/Babylonserver.dll?Config.

Requester Configuration Parameter Reference

• Server – Set to True.

• LogFile – Full path to the location of the requester log file.

• RequestorConfig – Definition of the TCP/IP locations (host name and port) of the Administration and Translation services. For example: <RequestorConfig> <AdminServer Port="24375">master</AdminServer> <TransServer Port="7891">master</TransServer> </RequestorConfig>

2.3.3 Application Services Configuration

To start using the product on the server, you need to deploy at least one administration service and one translation service on the same operation system instance. They would serve as master services where later, you could install more translation services and configure them to the master services to create a cluster. The Windows Service is running an instance of BabylonServices.exe as a process which monitors another instance of BabylonServices.exe

http://myserver:8080/BabylonEnterpriseServer/Babylonserver.dll?Config


running as a separate process. The “protection” instance is responsible for automatically invoking the second instance upon service startup, and for ensuring that it is always running. If the second process crashes, the “protector” will try to restart it.

2.3.4 Installing an Application Service

To install an application service as a Windows OS service, run the following command line:

<installation folder>\Service\BabylonServices.exe –Install –cfg [configuration file] –name [service name]

2.3.5 Uninstalling an Application Service

To uninstall an application service as a Windows OS service, run the following command line:

<installation folder>\Service\BabylonServices.exe –Uninstall –cfg [configuration file] –name [service name]

2.3.6 Administration Service Configuration

The service requires a configuration file to function. It reads the file during initialization: if the configuration is updated, the service must be restarted to pick up the changes.

The service configuration file is stored in the XML format. A default configuration file, BabylonServicesAdmin.Config.xml, is in the Common folder of the product

installation.

Administration Service Configuration Parameter Reference


• LogFile – Full path to the location of the service log file.

• Mode – Set to Admin.

• ServerName – Host name of the machine running the service. Use the DNS suffix in case the host name alone is not recognized in all network segments.

• Port – TCP/IP port on the service that would be used for the connection between the service and other components (like the ISAPI requestor).

• TransServers - List of all Translation services this Administration service need to synchronize. The first one in the list is the default translator and must be available or the Administration service will not be able to install glossaries. The server names can be in two formats: URL (Connecting using HTTP) or Server name and port (Connecting using TCP/IP). The default Translation service must be in server name/port format or the installation will not work properly. For example:

o HTTP format <TransServers> <URL>http://trans2:8080/BabylonEnterpriseServer/BabylonServer.dll</URL> </TransServers>

o TCP/IP format <TransServers> <Server Port="7891">master</Server> </TransServers>

• Locations –

o ServerData – Full path to the folder containing the service persistency data.

o GlossPath - Full path to the folder containing service content (glossaries).


o UploadPath - Full path to the folder containing the glossaries files that can be installed using the Administration Web Interface.

o LoggingPath - Full path to the folder containing the usage log files.

• Parameters –

o BabylonURL – URL for Babylon’s public content server. By default, set to http://Clients.babylon.com/bes/kms6.cgi.

o MaxMemSize – Size of an upper memory limit in MB that causes the service to automatically restart itself. Used as a safeguard against scenarios of memory overflow that might leave the system unstable.

o NoGlossDelete – If set to True, the server will not issue any glossary deletion for the client offline (local) glossaries storage.

o NoEntityPersistCheck – If set to True, the service avoids validating the Windows user/group when administrating the glossaries profile.

o LoggingTimer – Interval period in minutes between usage log file update

o UnsecuredServer – If set to True, the service works without authenticating clients’ access and glossaries access permissions.

• Monitoring –

o MemCheck - is responsible for monitoring the memory consumed by the service. Set the node value to Enabled to enable the monitoring. When the service exceeds the memory threshold it initiates a new process instead and gracefully stops the running one. The service listening port is available during processes replacement and all waiting requests are handled in a transparent way to the new process.

▪ RunEvery - the time interval in minutes between two checks.

▪ MaxMemSize - the maximum memory size Megabytes units the service is allowed to consume.

o ActivityTime – is responsible for a timely replacement of service processes to ensure the process is running with an optimized system overhead. Set the node value to Enabled to enable the replacement. The process replacement is identical to the above replacement due to memory threshold limit.

▪ RunEvery - the time interval in hours between two-time limit checks

▪ RunningPeriod – the minimal period for the process to run in hours. The maximum value is 24. The first check that finds the process running over this period initiates the replacement.

o The test runs every 2 hours. The maximum running period is set to 24 hours.

2.3.7 Translation Service Configuration

The service requires a configuration file to function. It reads the file during initialization: if the configuration is updated, the service must be restarted to pick up the changes.

The service configuration file is stored in the XML format. A default configuration file, BabylonServicesTrans.Config.xml, is in the Common folder of the product

installation.

Translation Service Configuration Parameter Reference


• LogFile – Full path to the location of the service log file.

• Mode – Set to Trans.

• ServerName – Host name of the machine running the service. Use the DNS suffix in case the host name alone is not recognized in all network segments.

http://clients.babylon.com/bes/kms6.cgi


• Port – TCP/IP port on the service that would be used for the connection between the service and other components (like the ISAPI requestor).

• AdminServers – The Administration service which this Translation service need to be synchronized with. The service can be defined as HTTP URL that directs to the ISAPI requester that is connected to the specific Administration service or as a TCP/IP host and port. For example:

o HTTP Format <AdminServers> <URL>http://master:8080/BabylonEnterpriseServer/BabylonServer.dll</URL> </AdminServers>

o TCP/IP Format <AdminServers> <Server Port=”23745”>Admin-SRV</Server> </AdminServers>

• SyncTimes – Interval period in minutes between synchronizations of the translation service with its attached administration service

• Locations –

o ServerData – Full path to the folder containing the service persistency data.

o GlossPath - Full path to the folder containing service content (glossaries).

o EmbeddedPath - Full path to the folder containing the images and other files embedded inside the glossaries.

o IconPath - Full path to the folder containing the icons files embedded inside the glossaries.

o LoggingPath - Full path to the folder containing the usage log files.

o XSLAPth - Full path to the folder containing the XSL templates for the response to the BlackBerry client request.

• Parameters –

o ServerURL – The URL that will be used for retrieving images/icons from the glossary. It must point to the ISAPI requester that connects to the current Translation service to allow the display of the embedded icons and images in the client and the Administration Web Interface.

o AllowedURIs – List of comma delimited glossaries URIs to be allowed to access by BlackBerry clients. If the list is set, the BlackBerry client can access only the defined glossaries. If the list is empty, the BlackBerry client could access glossaries only in “Allow All” online permission.

o MaxMemSize – Size of an upper memory limit in MB that causes the service to automatically restart itself. Used as a safeguard against scenarios of memory overflow that might leave the system unstable.

o NoEntityPersistCheck – If set to True, the service avoids validating the Windows user/group when updating glossaries from the Administration service.

o LoggingTimer – Interval period in minutes between usage log file update

o UnsecuredServer – If set to True, the service works without authenticating clients’ access and glossaries access permissions.

• Monitoring –

o MemCheck - is responsible for monitoring the memory consumed by the service. Set the node value to Enabled to enable the monitoring. When the service exceeds the memory threshold it initiates a new process instead and gracefully stops the running one. The service listening port is available during


processes replacement and all waiting requests are handled in a transparent way to the new process.

▪ RunEvery - the time interval in minutes between two checks.

▪ MaxMemSize - the maximum memory size Megabytes units the service is allowed to consume.

o ActivityTime – is responsible for a timely replacement of service processes to ensure the process is running with an optimized system overhead. Set the node value to Enabled to enable the replacement. The process replacement is identical to the above replacement due to memory threshold limit.

▪ RunEvery - the time interval in hours between two-time limit checks

▪ RunningPeriod – the minimal period for the process to run in hours. The maximum value is 24. The first check that finds the process running over this period initiates the replacement.

2.3.8 Verifying Application Services State

The web requester provides the following services to ensure that the application services are in running state:

• To check the administration service, issue an HTTP request from a browser or any monitoring tool with the URL of the requester, which the service is attached to, with the parameter Ping. For example: http://MyServer:8080/BabylonEnterpriseServer/Babylonserver.dll?Ping The correct response should be Admin – Pong.

• To check the translation service, issue an HTTP request from a browser or any monitoring tool with the URL of the requester, which the service is attached to, with the parameter transPing. For example: http://MyServer:8080/BabylonEnterpriseServer/Babylonserver.dll?transPing The correct response should be Trans – Pong.

http://myserver:8080/BabylonEnterpriseServer/Babylonserver.dll?Ping

http://myserver:8080/BabylonEnterpriseServer/Babylonserver.dll?transPing


2.4 Babylon-Enterprise Client Installation

After the Babylon-Enterprise Server is installed and configured, the Babylon-Enterprise Client must be installed on every desktop computer.

Use Babylon-Enterprise Packager to create client installers. The installers can then be deployed manually (by the administrator or user) or using a third-party software distribution tool.

2.4.1 Creating Client Installation Packages

Babylon-Enterprise Packager is used to create Babylon-Enterprise Client installers with custom configuration settings.

The Packager can define which glossaries and licenses will be included and other default configuration settings.

To start Babylon-Enterprise Packager, select Start | Programs | Babylon-Enterprise Services | Babylon Packager.

The first of two Babylon Packager dialog boxes is displayed:

In the dialog box, define the settings for the client configuration.


Source Files

• Source MSI: The source MSI file contains the original client installer, without any glossaries or customizations. It serves as the basis for the packaging process. The default defines the location of the client installer that was originally installed with the server.

• Saved configuration: A selection list of configuration XML files saved in previous Packager sessions. For first time configuration, leave this field blank.

Activation Shortcuts

When selected, all settings in this group will be included in the package.

If cleared, settings in this group will not be changed when the package is installed.

• Mouse button: Defines the default mouse button used to activate the Babylon-Enterprise client.

• Keyboard modifier: Defines the keyboard key that will be used in combination with the mouse button to activate the Babylon-Enterprise client.

• Keyboard activation: Defines the keyboard key used to activate the Babylon-Enterprise client.

• Allow user to change these settings: Select this option to give client users the ability to change the activation shortcuts. If cleared, users will not be ability to change these settings.

Client Proxy Settings



• Use automatic proxy settings: This is the default definition.

• Connect through the following proxy server: Select this option to define a specific proxy gate for the default Internet connection to be used by clients. Then complete the configuration options.

• Allow user to change these settings: Select this option to give users the ability to change the proxy settings.

• Babylon proxy: The URL of the proxy that connects to the babylon.com server.

Online Actions



• Enable results from babylon.com: Select this option to enable the client to communicate with Babylon’s public services such as online translations, full text translations, etc.

• Enable exchange rate: Select this option to set the client to display the “Units Converter” button on its footer banner and to enable the feature.

• Url translation: Select this option to set the client to display the “Web Translator” button on its footer banner and to enable the feature.

• Text translation: Select this option to set the client to display the “Text Translator” button on its footer banner and to enable the feature.


• Allow user to change these settings: Select this option to give users the ability to change the above settings.

• Web page open type: Select the type of getting the web page translation in your internet browser

Enterprise Server

When selected, the clients will establish a connection with the server. The URL defines the http address the clients will use to connect to the server. It is recommended that you do not change the default value.

When cleared, the clients will run without trying to connect to the server. Clear the option only when clients run without a server; other it should remain selected.

• URL: Host address of the enterprise server in the following format - http://<host name>:<http port>/. Click Validate URL to test the Babylon-Enterprise service. If the service is running and the URL is correct, a confirmation message will be displayed.

• Validate URL: Click to test the Enterprise server URL. If the URL is correct and the server is responding, a confirmation message will be displayed.

• Upgrade clients with generated package: All clients will be upgraded to the current package. The configuration XML file must be submitted to the server to initiate the upgrade.

• Allow user to change these settings. Select this option to give client users the ability to change the enterprise server settings. If cleared, users will not be ability to change these settings.

Client Installer Defaults

• Client version: Displays the client version number. This value is automatically displayed after you select the source MSI file.

• Default path: Defines the fixed client installation path. Leave blank to install the client in the default location %Program Files%\Babylon.

• Installation type: Defines how the installation will be performed on the clients.

• Interactive: Runs the client installer with all dialog boxes. Requires user input during installation.

• Passive: Runs the client installer with progress dialog boxes only. Requires user input only when an error occurs.

• Silent: Runs the client installer without any visible dialogs. Does not require any user input. In the event of failure, the installation will abort silently.

• User interface language: Defines the default user interface language that will be used by the clients. Select Use Windows Locale to enable automatic setting of the language on each client per the client’s operating system locale.

• Online GUI URL: URL for the web location of the file “wnd.html”. Use this option to define a corporate service for the client GUI. The service is based on coping the folder LocalUI from the Packager folder to a folder defined as a virtual directory/application in the web server where the default document being “wnd.html”.

• Run after setup: When selected, the clients start running after the setup is completed. Use this option only if the client installation will be run in a user context. If the installer will be run by a system process, this option should be cleared.


• Show ‘Getting Started’ on startup: When selected, the Getting Started message will be displayed on the client screen at startup.

Click More client installation defaults to access and set the following default options:

• Show results from active sources only: When selected, results will be delivered only from the information sources that have been activated on the client. Additional results will not be delivered from Babylon’s public server. If this option is cleared to allow additional results, you must also enable the client to connect to the Internet and the Babylon’s public server.

• Open Sidebar: When selected, the client window will open with the Sidebar displayed.

• Enable license modification: When selected, the user will be able to enter and alter license information on his workstation.

• Disable conversion utility: When selected, the conversion utility will not be an active information source and will not deliver results upon click.

• Let client set window size: When selected, the client window will automatically open at the optimal size for displaying results.

• Install Office Add-in: When selected, the Babylon-Enterprise query command will be included in the Office shortcut (right-click) menu on the client workstation.

• Install Internet Explorer Add-In: When selected, the Babylon-Enterprise query command will be included in the Internet Explorer shortcut (right-click) menu on the client workstation.

• Include Babylon’s Community: When selected, the client will activate the feature of linkage to Babylon’s translation community. Please notice that the service requires internet connection to Babylon’s public servers.


• Use Local Text Translation: When selected, the text translation service would be consumed from a local text translation service.

• Configuration file: select a configuration files which describes the settings of the local text translation services and the language pair deployed on each. Contact Babylon’s support desk for more information

Click Next to continue to the second Babylon-Enterprise Packager dialog box.

In the second dialog box, complete the settings for the client configuration.

Information Sources (Glossaries)

A list of information sources (glossaries) that will be included in the client installation package, and installed on the client workstation. File names for these sources have the extension BGL.

• Add: To add an information source to the installation package, click Add and browse to and select the sources.

• Remove: To remove an information source from the installation package, select the file name in the list and click Remove.

Licenses

Your organization may have received more than one license file. License filenames have the extension BOF.


• Add: Click Add and browse to and select all the client license files that were provided by Babylon-Enterprise

• Remove: To remove a license from the installation package, select the license name in the list and click Remove.

Additional Client Customization Files

Your organization may have received one of more binary files containing special configuration instructions. These files have the extension DAT. Add and remove DAT files only if instructed to do so by Babylon-Enterprise Support.

Override Offline GUI

A list of information sources (glossaries) that will be included in the client installation package, and installed on the client workstation. File names for these sources have the extension BGL.

• Add: To add an information source to the installation package, click Add and browse to and select the sources.

• Remove: To remove an information source from the installation package, select the file name in the list and click Remove.

MSI Upgrade URL

• URL for upgrading MSI: Base URL for the Windows Installer Service (MSI engine). The client installer might need to download MSI engine files if the MSI engine is not available on the desktop computer, or if it is a lower version than the one required by the client installer.

• ANSI: Relative path of the ANSI MSI engine for Windows 98/ME machines.

• Unicode: Relative path of the Unicode MSI engine for Windows 2000/Windows XP machines.

Destination

• Saved package: The target folder for client installer packages. Browse to and select the destination folder where the client installation package files will be copied. The Packager creates three files in the destination folder: An MSI file, an EXE file and an XML file.

• Create XML configuration file only: Instead of creating client packages, the Packager will create only the XML file with the configuration definitions.

• Apply XML configuration on Enterprise Server: The XML configuration will be applied on the Babylon-Enterprise server and the changes will be distributed to client computers.

Click Create to complete the client packaging process and save the current configuration. This configuration can be loaded later.

Click Exit to accept and save settings, and exit Babylon-Enterprise Packager.

2.4.2 Interactive Client Installation

When running an installer that requires inputs from the client user (that is, an interactive installation), perform the following steps to install a client package.

1. To start the interactive client installation, run the BabylonClient8.msi installation file created by the Packager on each user’s desktop.

Welcome.

Read the Welcome message, and click Next to continue.


2. License Agreement.

Read the License Agreement. Select Accept and click Next to continue.

3. Product License.

Use either of the following options to enter license information on the client’s desktop:

• Select Enter license information. Enter the registration name and license code supplied by Babylon-Enterprise to your organization.


• Select Open license file. Browse to the location where you saved the license file supplied by Babylon-Enterprise to your organization and select the license. License filenames have the extension BOF.

Click Next to continue.

4. Setup.

Select the components to be installed on the client’s desktop.

• Babylon: Babylon-Enterprise Client software.

• Added Glossary: The information sources (glossaries) that will be included in the client installation and installed on the client workstation.

Click Next to continue.

5. Complete the Setup.

Click Install to start the installation.

When done, the Setup Complete screen opens and displays an option to launch Babylon.


3 Server Administration: Web Interface

Most administrative tasks can be performed using the web administration interface. To perform one-time actions, the web interface provides a simple and intuitive way of installing glossaries and licenses. For more automated activities, the server also has a command-line administration interface that can be used in scripts and automated operations.

3.1 Configuring the Administration Web Interface

The interface requires a configuration file to function. It reads the file during initialization: if the configuration is updated, the browser must be restarted to pick up the changes.

The interface configuration file is stored in the XML format. A default configuration file, BAI.Config.xml, is in the Common folder of the product installation.

Administration Web Interface Configuration Parameter Reference


• LogFile – Full path to the location of the interface log file.

• ServerName – Host name of the machine running the administration or the translation service.

• Port – TCP/IP port of the service selected above.

3.2 Administration Web Interface Overview

To open the Babylon-Enterprise administration web interface, select Start | Programs | Babylon-Enterprise Services | Babylon-Enterprise Server Administration.

The Server Administration home page opens. The URL of the home page is: http://<server name>:<http port>/BabylonAdmin2/.

The menu on the left-hand side of the page has five links:

• Glossaries: For managing glossaries installed on the server.

• Licenses: For managing license distribution to clients.


• Client Configuration: For managing and distributing client configuration settings.

• Server Log: For viewing and managing the server log file.

• Server Settings: For configuring the server.

3.3 Glossary Management

The Glossaries page lets you manage and monitor the installation and distribution of glossaries.

3.3.1 Viewing Installed Glossaries

To view a list of the glossaries installed on the server, click on the Glossaries link. The Glossaries List page is displayed.

The Glossaries List page displays a list of all glossaries that are installed on the server and information about each glossary. For each glossary, the following information is displayed:

• Title: The name of the glossary

• Version: The version number of the glossary

• Updated: The date of the glossary’s last update

• Active status: Indicates whether a glossary is available to users.

• Online status: Indicates the users and/or groups allowed to view this glossary online. To see a list of the specific authorized users/groups, place the mouse cursor over the status definition.

• Offline status: Indicates the users and/or groups allowed to download this glossary for offline use. To see a list of the specific authorized users/groups, place the mouse cursor over the status definition.


3.3.2 Installing Glossaries

When first installed, glossaries are always inactive. Glossaries remain inaccessible to users until you activate them.

Installing a glossary updates any older version of the same glossary already residing on the server.

To install new glossaries, use the Glossaries List page.

Click on Install Glossary. A dialog box opens.

The dialog box allows you to select the glossary to install in one of the following ways:

1. Select from a list of the files residing in the File Upload folder that was defined during the service configuration.

2. Enter the full path of the glossary’s location.

3. Browse to and select the glossary file.

Click on Load File to install the glossary on the server.

3.3.3 Removing Glossaries

To remove a glossary, use the Glossaries List page.

Select the checkbox at the beginning of the line containing the glossary’s title.

Click on Remove Selected Glossaries to remove the selected glossary.

3.3.4 Viewing Glossary Details

To view glossary definitions, click on a glossary title hyperlink in the Glossaries List page. The Glossary Details page opens.

This page has three tabs:

• Online Permissions: Defines permissions for online viewing of the selected glossary.

• Offline Distribution: Defines distribution rules for the selected glossary.

• Glossary Information: Displays general details about the selected glossary. This information is retrieved from the glossary header.


This page also includes Prev and Next buttons that allow you to scroll through the information pages of all installed glossaries.

3.3.5 Setting Glossary Status

By default, a glossary is first installed with its status defined as inactive, and may remain on the server without being accessible to users.

To make a glossary available to users, change the status to active in the Glossary Information page: Select Glossary is active and click Apply Changes.

To block all user access to a glossary, change the status to inactive in the Glossary Information page: Clear Glossary is active and click Apply Changes.

3.3.6 Setting Online Glossary Permissions

To set online permissions, select the Online Permissions tab from the Glossary Details page.

Select the group of users that will be allowed online access to the selected glossary:

• No users are allowed online access to this glossary: This glossary will not provide online results.

• All users are allowed online access this glossary: All users will be allowed online results.


• Only the following users/groups are allowed online access to this glossary:

When you select this option, you must also specify which users and/or groups are allowed online access to this glossary.

Use one of the following methods:

• Enter the names of each user and group in full notation, including the domain name (e.g., mycompany\tom) and click left arrow.

• Alternately, click on the Browse (...) button. The Entities Selection dialog box opens.

You can limit the entity search to groups only or to users only by checking the required check box. You can also limit the entity search to s specific directory domain by selecting it from the combo box below From this location. You can find entities by typing only a substring from the beginning of the entity name. Once found, Select the users and/or groups authorized to access the glossary, and click Add Entity. The user or group name/s will be validated and added to the list of authorized users.

3.3.7 Configuring Offline Glossary Distribution

To configure offline distribution, select the Offline Permissions tab from the Glossary Details page.

Select the group of users that will be allowed offline access to the selected glossary:


• No users are allowed offline access to this glossary: This glossary will not be distributed to users. If a user installs this glossary, it will be removed upon connection to the server.

• All users are allowed offline access this glossary: This glossary will be distributed to all users. If updates are available, they will be distributed automatically.

• Only the following users/groups are allowed offline access to this glossary:

When you select this option, you must also specify which users and groups are allowed offline access to this glossary.

Use one of the following methods:

• Enter the names of each user and group in full notation, including the domain name (e.g., mycompany\tom) and click Add to List.

• Alternately, click on the Browse (...) button. From the Entities Selection dialog box select the user/s or group/s.

If a user installs a glossary for which he does not have offline permission, it will be removed when the user connects to the server.

3.3.8 Configuring the Client’s Glossary List

As administrator, you can define whether and how glossaries are glossaries are added to the client’s glossary list. The options are the same for both online and offline glossaries:

• Always add this glossary to users’ Glossary List (users cannot remove): The glossary is automatically added to the list of glossaries in the client interface. Users cannot remove the glossary, but can define the order of its appearance in the list.

• Allow users to add/remove this glossary: The glossary is not automatically added to the list of glossaries in the client interface. Users can add or remove the glossary using the Add Glossaries and Remove options in the client glossary list.

• Add this glossary to users' Glossary List on first connection (users may remove): The glossary is added once to the list of glossaries in the client interface. Users can remove the glossary using the Remove option in the client glossary list. Once the glossary has been removed from the client, it will not reappear in the client’s glossary list.

3.3.9 Performing Operations on Multiple Glossaries

You can define and change the settings of more than one glossary at a time.

In the Glossaries List page, select the checkbox at the beginning of each line containing a glossary whose settings you wish to alter. Click Update Selected Glossaries.

The Glossary Details page opens. Options displayed in red indicate different settings for different glossaries.

Make your changes to the glossary settings, and click Apply Changes.

The settings you have defined are now applied to all the selected glossaries.


3.4 License Management

The Licenses page lets you manage and monitor the installation and distribution of licenses.

3.4.1 Viewing Installed Licenses

To view a list of the licenses installed on the server, click on the Licenses link.

The Licenses page displays a list of all licenses that are installed on the server and information about each license. For each license, the following information is displayed:

• License Id: A unique ID for the license.

• File Name: The name of the original license file that was used to install this license.

• Status: The action to be performed on the license: either distribute to or revoke from all clients.

3.4.2 Installing Licenses

To install a new license on the server, click on Install License. A dialog box opens.

The dialog box allows you to select from a list of the files residing in the File Upload folder that was defined during the service installation.

Click on Install to install the license on the server.

Licenses are always installed without a defined status. You must define a distribute/revoke action.

3.4.3 Distributing Licenses

To distribute a license to all clients, click on the license’s ID in the licenses list.

In the license status dialog box, select Distribute and click on Apply Changes.


3.4.4 Revoking Licenses

Revoking a license removes it from clients, but keeps it on the server.

To revoke a license from all clients, click on the license’s ID in the licenses list.

In the license status dialog box, select Revoke and click on Apply Changes.

3.4.5 Removing Licenses

Removing a license deletes it from the server.

To remove licenses from the server, go to the licenses list and select each license you wish to remove.

Click on Remove Selected Licenses. A dialog box will prompt you to confirm the deletion.

The licenses will be permanently removed from the server.

Removing a license from the server does not affect the licenses on the client. Licenses are added to clients when they are marked distribute and removed when marked revoke. Licenses that are found on the client but not on the server are left unchanged on the client.

3.5 Client Configuration

The Client Configuration page lets you schedule client configurations and updates.


3.5.1 Configuration Files

Select Load Configuration File.

Enter the full name and path of the configuration file, or browse to and select the file. Click Load.

The file content is now displayed in the Client Configuration text box.

3.5.2 Distributing Configuration Files

Use the Client Configuration page to configure the scheduling of updates.

• Client checks server status every [5] minutes: By default, the clients check the server for updates every 5 minutes.

• Enable client configuration updates: By default, the server sends configuration updates to clients. If this option is cleared, the server does not send configuration updates to clients.

• Update Client configuration between 00:00 To 00:00

When client configuration updates are enabled, use this setting to define the time of day when the configuration updates will occur.

• Update Glossaries changes between 00:00 To 00:00

Use this setting to define the time of day when glossary updates will occur.

When specifying the start and end hours for the updates, the start time must be an earlier hour on the same day; for example, “08:00 to 20:00” is valid, but “20:00 to 02:00” is not valid.

Click Apply Changes to apply the settings.

3.5.3 Client Configuration

Client configuration files are created using Babylon-Enterprise Packager, and deployed by it on the server for distribution of the client. The main purpose of the feature is to enable an automatic client upgrade. Please notice that such a process requires local administrator permission on the desktop side.


3.6 Server Log

The Server Log page lets you view the server log cache and define log settings.

3.6.1 Log Cache

Use the Log Cache Size option to define the size of the server log cache.

The Log text box displays the contents of the server log cache.

3.6.2 Log File

The server log records all server operations, defined per three categories:

• Content Server: glossary installation and term retrieval operations.

• Security: security related operations.

• Server: all other operations.

Use the Log Level settings to define the level of detail recorded for each type of operation:

• Minimal: suitable for monitoring daily server operation.

• Medium: suitable for support purposes.

• Maximal: for debugging server


3.7 Server Settings

The Server Settings page lets you manipulate the server definitions.

3.7.1 Proxy Server

The proxy server configured in the Server Settings page is used by the enterprise server to get glossary updates and currency exchange rate updates from Babylon’s public Internet servers.

• Automatic Proxy Settings: The server will use the default proxy settings configured on the server machine. The server will use the settings configured for the SYSTEM user.

• Manual Proxy Settings: The server will use the proxy settings defined on this page. Enter the proxy server details: Host name/Port, Authentication, Username, Password, Exception list.

Click Apply Proxy Settings to apply the settings.

3.7.2 Glossary and Currency Rates Updates

The server can automatically check Babylon’s online information servers for updated glossaries and currency rates.

• Automatic update: The server automatically attempts to perform a daily update. Set the time of day for the update.

• Manual update: The server does not attempt to update automatically. To update the server manually, select this option and click on Get Glossary/Rates Updated Now.

Click Apply Glossary Rates Updates to apply the settings.


3.7.3 Server Scalability

The application services maintain a permission cache for each client that connects to the server. The number of permission cache entries can be defined to minimize server memory consumption.

• Cache Size: use this option to define the size of the server cache. To flush the permissions cache on the server, click on Flush Permissions Cache.

To enable service to a large number of clients, the server can limit the number of clients concurrently downloading information from the server.

• Cache Limit: use this option to define the maximum number of concurrent client connections.

Click Apply Scalability Settings to apply the server scalability settings.


4 Server Administration: Command-Line Interface

4.1 Configuring the Administration Command-Line Interface

The interface requires a configuration file to function. It reads the file during initialization: if the configuration is updated, the browser must be restarted to pick up the changes.

The interface configuration file is stored in the XML format. A default configuration file, BAdmin.Config.xml, is in the Common folder of the product installation.

Command-Line Interface Configuration Parameter Reference


• LogFile – Full path to the location of the interface log file.

• ServerName – The host name of the machine running the default administration service the interface should connect to.

• Port – TCP/IP port of the service above.

• TransServers – hostname and port of a translation service to manage by the command-line. The access to the translation service is available by adding the argument –trans to the command line.

4.2 Commands Overview

All administrative tasks on the Babylon-Enterprise service can be performed from the command prompt. This enables the combining of tasks in automation scripts or embedding in other operational systems.

In any command issued, adding the argument –trans would direct the command to the translation service defined in the configuration file. Running the command without the -trans argument would direct it to the default administration service.

The command-line syntax is as follows:

Syntax: full path\badmin64.exe [command-line switches]

Where: full path

Defines the location of the badmin64.exe application file.

Examples:

full path\badmin64.exe -removegloss title CRM_Daily_Data

This command removes the glossary named CRM_Daily_Data from the server. This particular glossary will no longer be available to users.

full path\badmin64.exe -flushcache

This command flushes the permissions cache on the server.

4.2.1 Help

To view a list of the command-line switches and a brief description of each, use the -help switch.

Syntax: full path\badmin64.exe -help

or full path\badmin64 ?

To view the parameters for a specific command-line switch, include the name of the switch.

Syntax: full path\badmin64 -help command-line_switch


4.2.2 Server Version

To view the version number of the various Babylon-Enterprise server components, use the -version switch.

Syntax: full path\badmin64.exe –version

4.3 Glossary Management

4.3.1 Viewing Installed Glossaries

To view the list of glossaries installed on the service and information about each glossary, use the -listgloss switch.

The following information can be displayed for each glossary: title, URI, active/inactive status, online status, and offline status.

Syntax: full path\badmin64.exe -listgloss [{title title|uri uri}] [details] [permissions]

Where: title|uri

Displays information only for the glossary whose title or URI is specified.

If neither a title nor a URI is specified, all installed glossaries will be displayed in the list.

details

Displays additional glossary details (header information) for each glossary.

permissions

Displays the online and offline permission lists for each glossary.

4.3.2 Installing/Updating Glossaries

To install/update glossaries on the service, use the -installgloss switch.

Installing a glossary updates any older version of the same glossary already residing on the server.

Syntax: full path\badmin64.exe -installgloss filename [activate] [{online|offline} [{all|none|list {add|remove} [domain\]entity ...}] [{mandatory|optional [force]}]

Where: filename

If the filename does not include a directory path, the application will attempt to install it from the File Upload folder that was defined during setup.

The filename may include wildcards (e.g., \\machine\Glossaries\bab*.bgl). However, wildcards cannot be used when glossaries are installed from the default Upload folder.

activate

Installs the glossary as active, rather than the default inactive.

online all

All users may use this glossary online.

online none

No one may use this glossary online.

online list {add|remove} [domain\]entity ...}

Only users specified as add in the permissions list may use this glossary online.


Users specified as remove in the permissions list will no longer be able to use this glossary online.

offline all

All users may use this glossary offline.

offline none

No one may use this glossary offline.

offline list {add|remove} [domain\]entity ...}

Only users specified as add in the permissions list may use this glossary offline.

Users specified as remove in the permissions list will no longer be able to use this glossary offline.

mandatory|optional [force]

• mandatory: The glossary is automatically added to the list of glossaries in the client interface. Users cannot remove the glossary, but can define the order of its appearance in the list.

• optional: The glossary is not automatically added to the list of glossaries in the client interface. Users can add or remove the glossary using the Add Glossaries and Remove options in the client glossary list.

• force: The glossary is added once to the list of glossaries in the client interface. Users can remove the glossary using the Remove option in the client glossary list. Once the glossary has been removed from the client, it will not reappear in the client’s glossary list.

4.3.3 Removing Glossaries

To remove a glossary from the service, use the -removegloss switch.

Syntax: full path\badmin64.exe -removegloss {title title|uri uri}

Where: title|uri

Deletes only the glossary whose title or URI is specified.

If the glossary file name includes spaces, enclose the name in quotation marks.

Examples: full path\badmin64.exe -removegloss uri !!CRM_Daily_Data

full path\badmin64.exe -removegloss title “HR daily data”

4.3.4 Configuring Installed Glossaries

To define offline distribution settings and online permissions, use the -distgloss switch.

Syntax: full path\badmin64.exe -distgloss {title title | uri uri} [{activate|deactivate}] [{online|offline} [{all|none|list {add|remove} [domain\]entity ...}] [{mandatory|(optional [force]}]

Where: title|uri

Distributes the glossary whose title or URI is specified.

activate|deactivate

Activates/deactivates the glossary.

online all

All users may use this glossary online.

online none


No one may use this glossary online.

online list {add|remove} [domain\]entity ...}

Only users specified as add in the permissions list may use this glossary online.

Users specified as remove in the permissions list will no longer be able to use this glossary online.

offline all

All users may use this glossary offline.

offline none

No one may use this glossary offline.

offline list {add|remove} [domain\]entity ...}

Only users specified as add in the permissions list may use this glossary offline.

Users specified as remove in the permissions list will no longer be able to use this glossary offline.

mandatory|optional [force]

• mandatory: The glossary is automatically added to the list of glossaries in the client interface. Users cannot remove the glossary, but can define the order of its appearance in the list.

• optional: The glossary is not automatically added to the list of glossaries in the client interface. Users can add or remove the glossary using the Add Glossaries and Remove options in the client glossary list.

• force: The glossary is added once to the list of glossaries in the client interface. Users can remove the glossary using the Remove option in the client glossary list. Once the glossary has been removed from the client, it will not reappear in the client’s glossary list.

4.3.5 Available Domains

To view a list of the available domains, use the -listdomains switch.

Syntax: full path\badmin64.exe -listdomains

4.3.6 Available Entities

To view a list of the available entities (users and/or groups) in a domain, use the -listentities switch.

Syntax: -listentities (users|groups|users groups} domain {domainname|all} [entity entityname]


4.4 License Management

4.4.1 Installing a License

To install a license on the server, use the -installlicense switch.

Syntax: full path\badmin64.exe -installlicense filename [status stat]

This command installs the license on the server.

If the filename does not include a directory path, the application will attempt to install it from the File Upload folder that was defined during setup.

The filename may include wildcards (e.g., \\machine\License\bab*.bof). However, wildcards cannot be used when licenses are installed from the default Upload folder.

Where: stat

Sets the status of the license. The status can be one of the following:

• distribute: add to clients

• revoke: remove from clients

• na: no action: do not distribute or remove

4.4.2 Removing a License

To remove a license from the server, use the -removelicense switch.

Syntax: full path\badmin64.exe -removelicense id

The license whose ID is specified will be removed from the server. The license is not removed from clients.

4.4.3 Modifying License Status

To alter the status of a license, use the -setlicensestatus switch.

Syntax: full path\badmin64.exe -setlicensestatus id stat

Where: id

A specific license ID. The status of this license will be altered.

stat

Sets the status of the license. The status can be one of the following:

• distribute: add to clients

• revoke: remove from clients

• na: no action: do not distribute or remove

4.4.4 Viewing Installed Licenses

To view a list of all licenses currently installed on the server, use the -listlicenses switch.

Syntax: full path\badmin64.exe -listlicenses

The command displays the ID, filename, and status of all the licenses currently maintained by the server.


4.5 Server Management

4.5.1 Server Log

The server maintains a log file. By default the file is stored in the folder \All Users\Application Data\Babylon Server. The folder can be defined during installation. In addition, the server caches the last lines of the log file.

The log file contains a list of all server operations according to log level settings defined by the system administrator.

Each server operation belongs to one of three categories:

• Content Server: glossary installation and term retrieval operations.

• Security: security-related operations.

• Server: all other operations.

To define the number of lines that the server caches, use the -setserverlogsize size switch.

Syntax: full path\badmin64.exe -setserverlogsize size

Where: size

Maximum number of lines to be stored in memory.

To view the defined number of lines in the cache, use the -getserverlogsize switch.

Syntax: full path\badmin64.exe -getserverlogsize

To view the contents of the server log cache, use the -getserverlog switch.

Syntax: full path\badmin64.exe -getserverlog

To define the level of detail of the server logs, use the -setloglevel switch.

Syntax: full path\badmin64.exe -setloglevel [contentserver level][security level][server level]

Where: level

Sets the level of detail to one of the following:

• min: for monitoring daily server operation

• med: for support purposes

• max: for debugging server

To view the defined levels of server log detail, use the -getloglevel switch.

Syntax: full path\badmin64.exe -getloglevel


4.5.2 Server Scalability

The server maintains a permission cache entry for each client that connects to the server. The number of permission cache entries can be defined to minimize server memory consumption.

To define the size of the server cache, use the -setscalability size switch.

Syntax: full path\badmin64.exe -setscalability size {none|size}

To enable service to a large number of clients, the server can limit the number of clients concurrently downloading information from the server.

To define the maximum number of concurrent client connections, use the -setscalability limit switch.

Syntax: full path\badmin64.exe -setscalability limit {none|lower upper}}

To view the current server scalability settings, use the -getscalability size switch.

Syntax: full path\badmin64.exe -getscalability

4.5.3 Flushing Permissions Cache

To clear the permission cache on the server, use the -flushcache switch.

This command should be run every time the administrator adds or deletes users or groups from the domain, or when users are added to or removed from groups.

Syntax: full path\badmin64.exe -flushcache

4.5.4 Glossary and Currency Rates Updates

To configure the schedule of updates, use the -setpercom (periodical communications) switch.

Syntax: full path\badmin64.exe -setpercom {manual | auto hh mm}

Where: manual | auto hh / mm

• manual: the server will not attempt to update automatically.

• auto: the server automatically attempts to perform a daily update at the specified time (hour/minute).

To view the current update schedule, use the -getpercom switch.

Syntax: full path\badmin64.exe -getpercom

To immediately initiate an update of glossaries and rates, use the -commitpercom switch.

Syntax: full path\badmin64.exe -commitpercom


4.5.5 Proxy Server Settings

To configure proxy server settings, use the -setproxy switch.

Syntax: full path\badmin64.exe -setproxy {auto|manual server [except ex_list] [{noauth|authenticate username [password] }}]

Where: auto|manual

• auto: the server will use the default proxy settings configured on the server machine. The server will use the settings configured for the SYSTEM user.

• manual: the server will use the specified settings. When setting to manual, a proxy server name must be specified. To specify a port, add it to the proxy server name using a colon; e.g., myproxy:8080.

except

Defines an exception list for manual proxy.

noauth|authenticate

Adds or removes authentication information for manual proxy server. When forcing authentication, a username (and an optional password) must be provided.

To view information about the PerCom proxy, use the -getproxy switch.

Syntax: full path\badmin64.exe -getproxy

4.6 Client Configuration

To update client configuration settings and/or distribute a new client configuration file, use the -setclientconfig switch.

Syntax: full path\badmin64.exe -setclientconfig {[enable|disable] | [percomtime time] | [glosstime {disable|enable H1 M1 H2 M2}] | [configtime {disable|enable H1 M1 H2 M2}] | [filename] }

Where: enable | disable

Defines whether or not the client configuration settings currently residing on the server are sent to clients. percomtime time

Defines how frequently, in minutes, the clients check the server for updates.

glosstime {disable|enable H1 M1 H2 M2}

Use this setting to define the time of day when glossary updates will occur.

When specifying the start and end hours for the updates, the start time must be an earlier hour on the same day; for example “8:00 20:00” is valid, but “20:00 02:00” is not valid.

configtime {disable|enable H1 M1 H2 M2}

When client configuration updates are enabled, use this setting to define the time of day when the configuration updates will occur.

filename

The file containing the client confirmation settings.

To view the current client configuration file, use the -getclientconfig switch.

Syntax: full path\badmin64.exe –getclientconfig


5 Manage Server Activity Log Files

5.1 Introduction

Babylon-Enterprise application services generate log files that record all types of user activity. Each of the application services generates a log file per day. The location of the log files and the refresh rate are set in the service configuration file. The name of a daily log file generated by the administration service is AdminLogging_<date>.log. Similarly, the log file name of the translation service is TransLogging_<date>.log. The structure of both files is tab delimited and they can easily process by any dedicated log parsing tool or imported to a database. Microsoft Log Parser ® (http://go.microsoft.com/?linkid=2352243) is a free tool, highly recommended for providing universal query access to the log files

5.2 Understanding the Activity Log Files

The administration log file records the automatic operations done by the client with the administration service, namely, the short periodical communication which is a basic hand shaking between the client and the service and long periodical communication, which is triggered when the short communication acknowledged there is a relevant update on the server.

The translation log file records the request for information issued by the clients. The log traces the actual server responses.

5.2.1 Administration Service Activity Log file

The administration service activity log file contains the following data item:

1. Date - the data of the operation in the format of DD/MM/YYYY.

2. Time - the time of the operation in the format of HH:MM:SS.

3. Host – The hostname of the machine running the Babylon-Enterprise client which issued the request.

4. MAC - The MAC address of the active network adapter on the client machine.

5. DriveID – The volume serial number of the disk on the client machine. This data item can be used to identify a unique desktop with an installation of Babylon-Enterprise client and count the number of actual clients installed in your site.

6. ClientVersion – The exact software version of the client.

7. UserName – The Windows user name which is running the client process. UserName will be empty for SP actions (see item 9 below).

8. ReqID - (Request ID) A number that identify a specific server response. In case a specific server response generates more than one log line, they all would carry the same request id.

9. ActionType – A two letters symbol representing the type of action. The possible values are:

a. SP – Short Percom (Periodical Communication). A short handshaking between the client and the server for checking if the server has new updated for the client.

b. LP – Long Percom. A synchronization process of server content and the client.

10. ClickedWord – empty.

11. URI – The glossary URI that was synced to the client. Empty for SP actions.

12. LineContext – empty

http://go.microsoft.com/?linkid=2352243


5.2.1 Translation Service Activity Log file

The translation service activity log file contains the following data item:

1. Date - the data of the operation in the format of DD/MM/YYYY.

2. Time - the time of the operation in the format of HH:MM:SS.

3. Host – The hostname of the machine running the Babylon-Enterprise client which issued the request.

4. MAC - The MAC address of the active network adapter on the client machine.

5. DriveID – The volume serial number of the disk on the client machine. This data item can be used to identify a unique desktop with an installation of Babylon-Enterprise client and count the number of actual clients installed in your site.

6. ClientVersion – The exact software version of the client.

7. UserName – The Windows user name which is running the client process. UserName will be empty for BB and NB actions (see item 9 below).

8. ReqID - (Request ID) A number that identify a specific server response. In case a specific server response generates more than one log line, they all would carry the same request id.

9. ActionType – A two letters symbol representing the type of action. The possible values are:

a. OL – Request with an answer. A translation request that got answers from one or more glossaries on the server. Each glossary taking part in the answer generates a separate log line.

b. NO – Request with no answer. A translation request that got no answer from any glossary. Usually, such scenario occurs if indeed no answer is found. However, NO action is also generated in case the user has no access to the glossaries containing the answer or if the request was answered by local glossaries only.

c. BB - Request with an answer from a BlackBerry device.

d. NB - Request with no answer from a BlackBerry device.

10. ClickedWord – The string that was looked within the request.

11. URI – The glossary URI that provided an answer to the request

12. LineContext – In case of actions NO and NB, the LineContext may include the full line context which includes the ClickedWord. This data item should assist the system manger to better understand the reason why no answer was provided to the request.

13. SearchMethod – The way the user requested the information:

a. 0 – The user typed the retrieval term into the client search text box

b. 1 – The user clicked on screen

5.3 Querying the Log Files with the Glossary Extractor

The Glossary Extractor can assist you in querying the log files produced by the server. The Extractor loads all available log files into a SQLite database and enables you to query them in two options:

1. Using a dedicated “Server Reports” feature which offers a predefined set of reports.

2. Running SQL queries directly on the SQLite database using the Query Manager.


6 Glossary Extractor

6.1 Introduction

The Babylon-Enterprise Extractor is a tool designed for creating, maintaining, updating enterprise glossaries, and deploying them on the Babylon-Enterprise Server.

The Extractor takes data from various enterprise data sources and indexes it as enterprise glossaries. A Babylon glossary is a simple database table of definitions. Each entry consists of the three main elements:

• Term: a string that is defined as the primary key (index) of the glossary.

• Alternate Forms: array of strings that share the same definition as the term.

• Definition: information about the selected term in HTML format.

The Extractor works as a scripting engine which created the glossary definitions and their indexes based on HTML template. Regardless of the actual data source, the Extractor always creates a data table based on the end user definition and uses the HTML template to create the definition. The actual data source and the HTML template are independent.

6.2 System Requirements

1. Microsoft .Net Framework version 4 full.

2. For accessing Oracle database – Oracle Client for Windows 2008 64 bit with Oracle Data Provider for .Net.

For accessing MySQL databases - MySQL Connector/Net or MySQL Connector/ODBC.

6.3 Creating a Glossary Using the Glossary Extractor

The Extractor can create Babylon-Enterprise glossaries from various data sources. The Extractor reads the selected source data, compiles a glossary file according to a layout scheme, and deploys it on the Babylon-Enterprise server.

The following diagram shows the process for creating glossaries using the Extractor:

Creating a Glossary Using the Glossary Extractor


• Extractor Tool: The Extractor uses various APIs to connect to data sources and create glossaries.

• Parameters (INI) file: A standard Windows INI file format containing all the settings and properties that define how the Extractor will extract data and create glossaries. The Extractor reads the parameter file and performs the operations according to the definitions in the file.

• Template (HTML) file: A file containing standard HTML and special tags for the Extractor that defines how the data will be displayed in the Babylon-Enterprise client window. It allows the glossary developer to design and format the presentation of content in the clients.

• Glossary (BGL) file: A compiled glossary file that can be deployed on the Babylon-Enterprise server or client workstation.

6.4 Glossary Extractor – Graphical Interface

Babylon-Enterprise includes a graphical interface in the form of a dialog box for basic glossary extraction and compilation. For advanced capabilities, you will need to use command line instructions.

To activate the Glossary Extractor graphical interface: select Start | All Programs | Babylon-Enterprise Services | Glossary Extractor.

The Glossary Extractor graphical interface two modes: Express and Wizard.

6.5 Glossary Extractor Express Mode

Glossaries created in Express mode are the simplest form of Babylon-Enterprise glossaries, and can be easily created in just minutes. Express glossaries can be generated from Excel files only. The Extractor uses default structure rules:

1. The first line in the Excel sheet uses as the column titles

2. The glossary term (primary index) will be based on values from column A

3. The definition will be based from the rest of the column as a 2 columns HTML table where the first columns is the title in bold and the second is the value.

The fields in row 1 and column A of the Excel file must contain data. If the Excel file contains blank columns or rows, delete them before beginning the extraction.


• Glossary name: Enter a name for your glossary.

• Overwrite existing glossary with this name:

• When enabled (default), only one glossary is generated and updated.

• When disabled, a new glossary will be generated each time you click Create Glossary, resulting in multiple glossaries with the same name.

• File name: Browse to and select the Excel file that contains the information you want to convert into a glossary.

• Worksheet: The Glossary Extractor displays a list of the worksheets in the selected Excel file from which you can create a glossary. The suffix $ is added to these worksheet names.

• Create Glossary: A progress indicator is displayed while the glossary is being generated.

The Glossary Extractor appends a date to the glossary title, which reflects the date of the data source file’s last update. It is not the glossary creation date.


6.6 Glossary Extractor Wizard Mode

The Extractor wizard lead you through the process of creating glossaries based on various types of information sources. In addition, the wizard creates for you the basic extraction process files that can later on be used for setting an automatic glossary update via the server tasks scheduler. To start the wizard, select from the menu bar Wizard Mode.

6.6.1 Select Data Source Window

The Wizard opens the first windows used for selecting the specific information source type for the glossary. Click on the image with the desired type of information source. The next screen to open is a dedicated screen per each type of information source where you will be asked to provide the specific connection details for the information retrieval.


6.6.2 MS-Office Parameters Window

Select this source for creating glossaries based on Microsoft Excel or Access files. The Extractor supports Excel/Access from Office versions older than 2010. For using this option, your server needs to have an installation of Microsoft Office Excel 2010 64-bit edition or Microsoft Access Database Engine 2010 64-bit edition. You may not be able to install the database engine if you have a current installation of a 32-bit edition of Microsoft Office, which will need to be uninstalled first.

Click on File Name to browse and select the Excel file or Access database file to work with. After the file is selected, the Data Object list will be filled. If an Excel file is selected, the list will contain the worksheets in the file. If an Access file is selected, the list will contain the tables and queries inside the database. If the relevant information for the glossary is in a single object, click on it. Selecting a single object will assume a SQL query of “select * from <object>”. If you wish to use a complex data structure, you may type an explicit SQL Query in the designated text box. If an explicit SQL Query is used, any single object selection is overlooked.

Click Next to move to the build glossary template window.


6.6.3 MS SQL Server Parameters Window

Select this source for creating glossaries based on data objects from Microsoft SQL Server (tables, views, procedures).

Fill in the connection details as follows:

• Server name - host name or the IP address of the database server

• Authentication - select the authentication method to use for connection the server: “Windows Authentication” or “SQL Server Authentication”.

• User name - user name for the connection

• Password – password for the connection

• Database name – the database to connect to

• Table Name – click on the hyper link to get the combo box filled with all the tables in the selected database within the user security profile. Select the data table to work with. Selecting a table is equal to using the SQL query: select * from <table name>

• SQL Query - type an explicit SQL Query in the designated text box, if you wish to use a complex data structure. If an explicit SQL Query is used, any single table selection is overlooked.



6.6.4 Oracle Parameters Window

Select this source for creating glossaries based on data objects from an Oracle database server (tables, views, procedures). For using this option, your server needs to have an installation of Oracle Database Client for Microsoft Windows (x64). The installation can be found at Oracle web site or from Babylon’s site. The Oracle net client must include Oracle Data Provider for .NET (ODP.NET) and configured with the appropriate TNSNames.ora settings.


• Service name – the logical name of the database server to connect as appears in the tnsnames.

• Authentication - select the authentication method to use for connection the server: “Oracle Server Authentication” or “Windows Authentication”.






http://bes.babylon.com/ftp/download/Oracle/Oracle_win64_11gR2_client.zip


6.6.5 MySQL Server Parameters Window

Select this source for creating glossaries based on data objects from MyS QL database Server (tables, views, procedures). For using this option, your server needs to have an installation of ADO.NET Driver for MySQL (Connector/NET). This driver does not support all versions of MySQL server. If you fail to access the server with it, install MySQL ODBC driver for Windows 64 bit and connect using the ODBC source window.



• Authentication - select the authentication method to use for connection the server: “Windows Authentication” or “SQL Server Authentication”.








6.6.6 ODBC Parameters Window

Select this source for creating glossaries based ODBC data source. For using this option, you need to have the ODBC driver designed for Windows 64 bit environments.


• Select ODBC DSN – select the ODBC data source name to use from the ones installed on the server







6.6.7 XML Parameters Window

Select this source for creating glossaries based on XML data. It is recommended to read first the chapter dealing with XML as a data source. The source of the XML data can be a file or a response from an HTTP request (URL). Click Select File to select the XML data file or type the URL of the XML source.

Click Parse XML to let the Extractor parse the XML files and fill the table below.

The table now includes all the unique nodes and properties inside the XML data. The Entry Name is the actual node/property name from the XML data, the Path is the XPath-like syntax for the location of the node/property and Type marks if it is Node or a Property. To complete the parsing rules, follow the steps below:

1. Check a single row as a Record Node.

2. For each Node/Property needed to be included in the data table, type in a functional name in Variable Name.

3. If the XML has an inner loop, check a single row, below the Record Node, as a Record Break.

4. If you need a full duplication of columns data to the inner loop, check Duplicate variables from outer to inner loop.

5. If the previous is checked, you may check the rows of the variables that will not be duplicated.

6. Type a name of SQLite table if you want the data table to be created in an in-memory SQLite database and SQL Query to get a specific data view from the table.


http://en.wikipedia.org/wiki/XPath


6.6.8 SharePoint Parameters Window

Select this source for creating glossaries based on Microsoft SharePoint list or document library. It is recommended to read first the chapter dealing with Microsoft SharePoint as a data source.

To complete the parsing rules, follow the steps below:

1. Type the host name or the IP address of the SharePoint server

2. Type the HTTP port of the server. The default value if not typed is 80.

3. Type the name of the SharePoint site as reflected in the site URL

4. The value for the URL of the web service is set automatically. Verify it and apply manual alterations if necessary.

5. Click on List and wait for the list of available SharePoint list to be filled. Select your desired list.

6. If the list has a specific view you need to use while querying it, lick on View and wait for the list of available SharePoint views to be filled. Select your desired view.

7. Click Get Data to get the table of the list data items filled.

8. Check the data items needed to be included in the data table. Clicking Select All will automatically check all the items in the table.




6.6.9 Active Directory/LDAP Parameters Window

Select this source for creating glossaries based on Microsoft Active Directory or any LDAP directory (which .Net technology can access). It is recommended to read first the chapter dealing with Active Directory/LDAP as a data source.


1. Type the host name or the IP address of the LDAP server.

2. Type the LDAP server port. The default value if not typed is 389.

3. Select the Service Type to use.

4. Optionally - Type the Base DN value.

5. Type the Search Filter value.

6. Select the Search Scope.


8. Click Connect to get the table of the LDAP attributes filled.

9. Check the attributes needed to be included in the data table.



6.6.10 SalesForce Parameters Window

Select this source for creating glossaries based on information managed by SalesForce application (www.salesforce.com). It is recommended to read first the chapter dealing with SalesForce as a data source.


1. Type the user name for, password and token for login in to Salesforce.

2. Click Login to SalesForce to get the table of the Objects Name filled.

3. Check the specific objects to extract or click Select All to choose all at once.

4. Click Get SalesForce Objects to get the table of Date Items filled.

5. Check the specific objects to extract or click Select All to choose all at once.

6. Type SQL Query to get a specific data view.


http://www.salesforce.com/


6.6.11 SQLite Parameters Window

Select this source for creating glossaries based on SQLite database file (version 3).

Click Select SQLite DB to browse and select the database file to open for querying. Type the SQL Query to use in the designated text box.



6.6.12 SAP Parameters Window

Select this source for creating glossaries based on tables of a SAP system. This feature is based on a third-party connector called "ERPConnect". For more information see the vendor web site (www.theobald-software.com). The connector has an official SAP certification. The preliminary requirements for using this option are:

1. The connector file “ERPConnect40.dll” should reside in the Extractor bin folder. You

can download it here.

2. The SAP RFC library “librfc32.dll” should reside in the Extractor bin folder. You can

download it here.

3. Availability of a SAP user with the following permissions:

a. RFC authorization for function group SDTX.

b. RFC authorization for function group SDIFRUNTIME.

c. RFC authorization for function RFC_READ_TABE.

d. Authorization to transactions se16 and se37.


1. Type the necessary connection parameters for the SAP system. There are two different ways to log on to the SAP system when using “ERPConnect”. A connection to a single application server can be established, or a connection can be made via Load Balancing. Either way, the following parameters must be provided:

a. User name

b. Password

c. Language

d. Client

http://www.theobald-software.com/

http://www.sap.com/ecosystem/customers/directories/SoftwareISVPartnerDetails.epx?context=21B87D61C0F646A22B2A6DB254A010CA8C9C141B7529F029910FE6FF9EEEC5A701BF20EED61AC07159D98BAA068EBE1B8C5C7665EA2226374E942CF1D2A49D202711A97F135182CC%7c4267CEB40FB0099052C2DE47B56E0483

http://bes.babylon.com/ftp/ERPConnect/ERPConnect40.dll

http://bes.babylon.com/ftp/ERPConnect/librfc32.dll


If you want to use the direct login to an application server, two further properties must be set:

a. Host – Name/IP address of the application server

b. System number between 0 and 99

If you want to log on via Load Balancing, three properties are necessary:

a. Message Server

b. Logon Group

c. System ID

2. Type a number in Rows Limit if you need to limit the total number of records sent from SAP.

3. Type a number in Packet Size to specify the amount of records transferred per communication packet. It is recommended to use the default value.

4. Click Connect to open a connection to the SAP system. In case the connection is successful, a “Connection Successful” message will appear on screen. Otherwise, a relevant error message will be presented instead.

5. Type a name of a SAP table in 1st Table Name and click on the link 1st Columns to get the selection list filled with the table’s columns. You may to the same with another table in 2nd Table Name and click on the link 2nd Columns.

6. Select the columns for each table by holding the <ctrl> key while selecting using the left mouse key.

7. Type in SQL Query to define the data view as any selected table and its columns are replicated to an in-memory SQLite database.



6.6.13 IBM DB/2 Parameters Window

Select this source for creating glossaries based on data objects from IBM DB/2 database (tables, views, procedures). For using this option, your server needs to have an installation of IBM Data Server Provider for .NET. The installation can be found at IBM web site or from Babylon’s site.







http://bes.babylon.com/ftp/download/IBM/iAccessforWindows/64-bit.zip


6.6.14 Build Glossary Template Window

This window enables you to shorten the time to create a glossary template. It is recommended to read first the chapter dealing with Glossary Extractor - Glossary Template File. Upon first entering to the window, it is presented empty.

The Windows is divided to the following areas:

• Data Area – the area where the actual data from the corporate data source is presented. The data retrieval parameters are automatically taken from the preceding window. The data is presented as a table that the template will relate to.

• Data Columns – list of all the data items included in the source. They can be used as logical references inside the template. A combination of a data items and a tag can be included in the template code.

• Tags – list of popular template tags to use in combination with a data item and include them in the template source. Detailed information about each tag can be found in the chapter dealing with Glossary Extractor - Glossary Template File.

• HTML Code – the area where the actual HTML code of the template is presented. This is the only area where you can edit its source to update the template.

• HTML View – the area where an actual view of the template code (browser view) is presented and updated with any change in the HTML code.

Click “Run Query Manager” to open the query manager with your current connection context.

Click “Get Data” to fill all areas with the relevant data following your selection in the preceding windows.


Now you can edit the HTML code freely. You can use the following action buttons as follows:

Open Template File: load an existing HTML file into the HTML code area.

Save Template File: save the HTML code as a file.

Insert HTML Tag: insert a specific HTML tag or text into the HTML code. The tag is inserted to the caret location in the HTML code area and is combined based on the selected tag with or without a matching item from the data columns list. The tags marked in red below requires a selected data column:

• Label – insert data column name • Regular – insert <!$bab_f_DataColumn> tag • Alternate – insert <!$bab_alt_break_DataColumn> tag • If – insert <!$babIF_rule_ DataColumn,neq,null> tag • End If – insert <!$babENDIF> • Aggregation Start Header – insert <!$babBREAKPREFIX> • Aggregation End Header – insert <!$babENDBREAKPREFIX> • Aggregation Start Footer – insert <!$babBREAKSUFFIX> • Aggregation End Header – insert <!$babENDBREAKSUFFIX>

Insert Bold Tag – insert <b></b>. If a text in the HTML code is selected, the selection is wrapped with the HTML start bold and close bold.

Insert BWORD Tag – insert <A href="bword://" glossuri=""></A>. If a text in the HTML code is selected, the selection is wrapped with the HTML start anchor and close bold.

Insert Java Script – insert <script language="javascript" defer="true"></script>. If a text in the HTML code is selected, the selection is wrapped with the HTML start script and close script.

When you are done with the template, make sure you save it as a file. Click Reset to reset the content of the HTML code area and fill it again with the default template. When clicking Reset, if Template For Aggregation is checked, the default template will be ready for an aggregative glossary template, where one or more records in the data creating one glossary entry. Click Previous to return to the previous wizard window. Click Next to continue to the General Parameters window.


6.6.15 General Parameters Window

This window finishes the process to create an extraction process files.

Enter a project name. Select the project folder where all the process files will be created. Select the header file of the glossary. You may click Create New Header to run the windows for creating one. Select the template file to use. Fill the value of the necessary

parameters. Detailed information on each parameter can be found in the chapter 6.10 -

Glossary Extractor – General Settings.


Use the table below to refer its name on screen to the name as it appears in the parameters file.

No Glossary Creation NoGloss

Handle Main Data HandleMainRS

SQL Query SQLQuery

First Preliminary SQL Query PreSQLQuery

Second Preliminary SQL Query PreSQLQuery1

Glossary BGL File BGLDataFile

Glossary GLS File GlossaryDataFile

Glossary Title GlossaryTitle

Compile Glossary UseAdvancedBuilder

Aggregation Mode HandleBreakLevel

Progress Indicator Step LogPrintingProgress

Following Process FollowingProcessParametersFile

Avoid Path Parsing SkipPathParsing

Avoid File Embedding SkipFileEmbed

Addition to Connection String ConStrSupp

Connection TimeOut ConnectionTimeOut

Install the glossary locally InstallBGLLocal

Install on Server DistributeFullGlossaryOnline

SMTP Server for Error Messages SMTPServer

Error Message Sender Sender

Error Message Recipients Receiver

Click Previous to return to the previous wizard window. To continue, click Save and Run to finish the wizard process. The parameters file (INI file) will be created in the project folder together with a command (batch) file to run the process in background mode. After that, the Extractor enables you to run the process for testing purposes. Click Exit to exit the wizard.


6.7 Utilities

6.7.1 Create New Header

Before creating an enterprise glossary, you need to create a glossary header file (GLS) which serves as the glossary meta-data description. You need to create a header only once for a glossary. When you update a glossary, use its original GLS header file.

From the menu bar, select Create New Header. A dialog box opens:

• Browsing Enabled: Defines whether users can scroll through glossary entries.

• Title: (optional). The displayed name of the glossary.

• Author: (optional). The name of the glossary author.

• Icon: (optional). The file name of the icon that will be displayed together with the glossary title in the client. Browse to and select an icon that will be associated with the glossary.

• Copyright Message (optional): A copyright message that is displayed at the end of each glossary entry.

• Description (optional): A brief description of the glossary.

• URI (optional): unique value identifying the glossary on the server. If left empty, the server will automatically generate a URI for the glossary upon its first installation. The Extractor automatically updates the header file with the generated value. It is recommended to select your own URI value for an easier recognition of the glossaries entries in the server log


files. When you type your own URI, make sure its value starts with two exclamation marks (!!) and that it is unique across all glossaries installed on the server.

• Minimal Substring Match Length (optional): A positive integer number that indicates the length (in number of characters) of the shortest substring of a glossary term and alternates and of Babylon’s click context for a match. Defining this attribute changes the way Babylon Content Server looks up a term in this glossary: if no term is found using the standard morphology-based search algorithm, a different approach is selected – finding terms/alternates in the glossary that have a common sequence of characters with the input search context.

• Hybrid Glossary (Web service based): Check to define the glossary as a web service based glossary. The created header file will contain parameters for defining the web service details. For further details, see Hybrid (Real-time) Glossary

• Site protected: Check to have the glossary signed by a server token. Its contents cannot be viewed on clients that are not authorized by the server that issued the signature.

• File Name: Browse to and select the folder where you want to save the glossary source (GLS) file. Enter a name for the glossary file, and save the file.

• XSL Template (optional): Select XSL file to serve as the customized XSL transformation for the glossary.

• Create. Click the button to create the glossary header file in the selected location.


6.7.2 Server Reports

The Server Reports is a feature that enables you to process the activity log of the product. It is based on loading all the available log files from a folder of your selection into a SQLite database and offers a set of predefined report outputted as HTML files and launched into the default browser.

The Log DB Date indicates the last update date of time of the SQLite database, if it exists.

Fill in the following parameters to refresh the database or to run a specific report:

• Server – host name or IP address of the server with an administration service

• Port – the TCP/IP port of the administration service on the server

• Log Path – full path to a folder containing activity log file

To refresh the database, select Refresh Log DB from the menu bar. If you click on Run Report when the database does not exist, it will be first refreshed automatically.

To save time with the screen parameters, you may store them in an INI filed named BesLog.ini in the Extractor bin folder. Its structure is as follows:

The database file is named BesLogDB.db and is stored in the Extractor bin folder.

It can also be queried directly using the Query Manager. The database included three tables:


• Admin – Collection of all lines from the Administration activity log file. The columns are identical to the log data items.

• Trans – Collection of all lines from the Translation activity log file. The columns are identical to the log data items.

• Glossaries – Collection of all glossaries exist on the Administration service. The table is used as a lookup to the glossary name from its URI. The table columns are: URI and GlossName.

You may choose one of the reports to run and click Run Report. Each report will be saved on disk in two formats: HTML for easy reading and CSV for loading to Excel or any related matter. Following are detailed information about the reports.

6.7.2.1 Report 1: Number of Installed Clients

(File: ClientInstallations.htm/csv) This report presents the number of installed clients based on the administrative activity log. It scans all the admin records in the log database and count the unique appearances of desktop installations based on three physical desktop parameters: host name, MAC address and disk drive identification. The most reliable number is the host name count.

The report time period is calculated by the minimal and maximal date in the data.

6.7.2.2 Report 2: Glossaries Usage-Glossary Hits per Day

(File: GlossariesUsage.htm/csv) This report counts the number of times each glossary appeared inside a search result per day and the number of unique users which contribute it.

Glossary Hits represents the number of appearances this glossary had in client results in a specific day. Unique Users represents the number of unique user names which got an answer from the specific glossary in the specific day. “Avg Clicks per User” is the rounded division of Glossary Hits by Unique Users.

6.7.2.3 Report 3: User Searches with No Answer

(File: HitsNoResponse.htm/csv). This report lists the requests the server got which resulted with no match from any glossary deployed on the server. The list displays the request date, the user who made it, the "clicked word" as interpreted by the client and the line context which surrounded the clicked word if the user clicked on screen rather than typing directly to Babylon. Requests which appear in


this report could rise from a request that was answered by an offline glossary or that the specific user had no permission to any of the glossaries holding the answer.


6.7.2.4 Report 4: User Hits-per Glossary per Day

(File: UsersUsage.htm/csv). This report counts per each user the number of times each glossary appeared in a search results per day.

User Hits represents the number of appearances this glossary had in client results in a specific day for a specific user.

6.7.2.5 Report 5: Daily Summary

(File: DailySummary.htm/csv). This report provides an overall statistic view on the product usage in term of active users and searches.

The report presents the following information per each day in the log database and for all the period in total:

• Active Users – the number of unique users which performed at least one search.

• Searches – the number of information searches made by the server.

• Avg Clicks/User - the rounded division of Searches by Active Users.

• Top User – the user who performed the largest number of searches.

• Top User Searches – the number of searches made by the Top User.

• Top Glossary – the glossary which appeared the most in search results.

• Top Glossary Searches – the number of times the Top Glossary participated in search results.

6.7.2.6 Report 6: Concurrent Translation Requests

(File: ConcurrentRequests.htm/csv). The report presents the top 200 dates and times where the server experienced the top load of requests handles concurrently from more than one client.


6.7.2.7 Report 7: User Popular Searches

(File: Popular Searches.htm/csv). The report presents the top 500 popular searches sent to the server.

6.7.2.8 Report 8: Enterprise/Translation Usage Analysis

(File: Enterprise_Usage.htm/csv). The reports present the distribution of the answers given by the server between two categories of glossaries: enterprise glossaries and dictionaries. Prior to running the report, you need to classify at least once your glossaries. To do that, select Classify Glossaries from the menu. The window opened, presents the list of all available glossaries in the system. You need to mark only the ones which are defined as Enterprise glossaries while the rest will be categorized as dictionaries. To select multiple glossaries, hold the <ctrl> key while selecting using the left mouse key. Upon completion select the Confirm button. Your selection will be stored on the server for future use. Avery time you open the classify glossaries window your latest selection will be displayed.

Once the selection is completed and confirmed, you can now run the report.


The report presents the following columns:

• Period – the specific day or all the time period of the report.

• Answers – total answers provided by the server. A single answer includes a reference to one or more Enterprise glossaries and/or dictionaries.

• ENT – number of answers which included only Enterprise glossaries.

• %ENT – proportion of ENT to Answers in percentage.

• DICT - answers which did not include Enterprise glossaries at all.

• %DICT - proportion of DICT to Answers in percentage.

• MIX - answers which included glossaries from both categories.

• %MIX – proportion of MIX to Answers in percentage.

• MIXMoreENT – number of answers which included both glossaries categories but with higher of Enterprise glossaries.

• %MIXMoreENT – proportion of MIXMoreENT to MIX in percentage.

• MIXMoreDICT – number of answers which included both glossaries categories but with higher number of dictionaries.

• %MIXMoreDICT – proportion of MIXMoreDICT to MIX in percentage.

• MIXSame – number of answers which included same number of Enterprise glossaries and dictionaries.

• %MIXSAME – proportion of MIXSame to MIX in percentage.


6.7.2.9 Report 9: Requests per Hour

(File: RequestsPerHour.htm/csv). The report presents the distribution of the requests during the hours of the day.

The report scans all the requests in the log database and counts the number of requests done in any round hour during the day.

6.7.2.10 Report 10: Distribution of Answers and Users by Glossary

(File: GlossariesAnswers.htm/csv). The report scans all the glossaries appearances in server answers and presents for each the number of its appearances and the number of unique users who contributed to that.


6.7.2.11 Report 11: Non-Active Hosts and Users

(File: NonActiveHostsUsers.htm/csv). The report lists the hosts and users which were not active at all during the report period.

6.7.2.12 Report 12: Clients Versions Distribution

(File: ClientVersionDist.htm/csv). The report presents the distribution of number of clients by the client software version.

6.7.2.13 Report 13: Search Method Distribution

(File: SearchMethods.htm/csv). The report presents the percentage distribution between the two methods to activate search in the client: user manual type OR user clicks on screen (OCR).


6.7.2.14 Report 14: Distribution of Glossaries Usage per Day

(File: Date-Gloss-Req.htm/csv). The report presents the number of answers per glossary per day.

6.7.2.15 Report 15: Distribution of Users Usage per Day

(File: Date-User-Req.htm/csv). The report presents the number of answers per user per day.


6.7.2.16 Report 16: Last Usage Date per User

(File: User_Last_Usages.htm/csv). The report presents the last product usage date and time per user.


6.7.3 Query Manager

The Query Manager is a tool that enables you to run SQL queries against any database supported by the Extractor. To run the tool, select Query Manager from the menu bar. From the main screen of the tool, you can run queries directly on a 64-bit ODBC data source or SQLite database file. To query all other databased, you need first to select its wizard, fill in all connection details, continue to the template wizard screen and run the Query Manager from there.

In this screen, unless you already have a connection, you need to select first the SQLite database file to query or to select an ODBC data source and providing its user name and password when necessary. After that, you simply need to enter an SQL query and click “Execute” to run it. When the data source is SQLite database, check the “Limit Display” checkbox to limit the results to maximum of 5,000 records.

Further options in this screen:

• Click “Clear” to erase text from the SQL query area.

• Click “Print” to save the query result as an HTML page.

• Click “Export” to save the query result as a comma delimited file.

• Click “Exit” to exit the Query Manager tool.

• In the “File” menu:

o Select “Open File…” to browse to a file containing an SQL query.

o Select “Save” to save changes made to the query to the loaded file.

o Select “Save File As…” to save the current query to a file.

• In the “Utilities” menu:

o Select “View Master Table” to view the tables and indexes existing in the SQLite database.


o Select “Shrink Database” to run a cleaning procedure on the SQLite database. The procedure will keep any data intact while shrinking the actual file side of the database.


6.8 Glossary Extractor – Background Mode

The Extractor Advanced mode is activated through the command line with the following syntax:

Syntax: full path\GLSExtractor64 -build parameters_filename

Where: full path

Defines the location of the GLSExtractor64.exe executable file.

parameters_filename

Defines the location of the parameter file to use for creating the glossary.

The Extractor returns an error level code that can be used when running in a batch file. If the Extractor execution is successful, the returned error level code is zero; otherwise, it returns the error number.

The Extractor writes a log file named Extractor_Log.txt that is stored in the working folder of the process who launched Extractor.

The Extractor parameter file is a standard Windows INI file. It is built from sections of parameters. Each section has a unique name which appears on the beginning of the section at a text wrapped with square parentheses. Each parameter appears in a separate line in the following format:

<Parameter name> = <Parameter value>

To mark a parameter so it won’t be considered, add a semi-column (;) left to its name.

The parameter file usually includes one section for the data source and other sections that define other extraction actions.

6.9 Glossary Extractor – Data sources

6.9.1 Microsoft Office Files – Excel and Access

To use Microsoft Office files as data source for glossaries, you need to install the 64-bit version of “Microsoft Access Database Engine 2010”. It can be freely downloaded from Microsoft’s web site or from Babylon’s site.

The Extractor supports the following Office file types as sources:

• Excel 97-2003 (.xls)

• Excel 2007-2010 (.xlsx)

• Access 97-2003 (.mdb)

• Access 2007-2010 (.accdb)

6.9.1.1 Excel

The Extractor is configured to access a specific worksheet in an Excel file. The worksheet needs to be built as a straight forward data table where the first line holds the column names and the following lines the data. The table must start in cell “A1” and spread in a continuous way.

6.9.1.2 Access

The Extractor is configured to access a single table or query object within an Access database file or to use a SQL query to define the data required for the glossary. Access can be useful in case the data source is structured text files like comma delimited or tab delimited. Using Access, you can link the file to an Access table and use the Extractor to access it like a regular table.

http://bes.babylon.com/ftp/Download/accessdatabaseengine_x64.exe


The following parameters are used when Microsoft Office is the data source. The name of the section is [MS Office].

Parameter Description

FileName Full path to the Excel/Access file. The path can also be an HTTP or FTP URL.

ObjectName A specific object (Excel sheet or Access table) to access within the data source. For Excel, specifies the name of the worksheet that contains the data. Using this parameter is equivalent to using the following SQL query: Select * from [<tablename>$]


6.9.2 Microsoft SQL Server

To use Microsoft SQL Server as data source for glossaries you need to have a read-only credential to access the specific database and to its relevant data objects: tables, views or stored procedures. The user credentials can be either a Windows (Active Directory) user or a SQL Server user.

The following parameters are used when Microsoft SQL Server is the data source. The name of the section is [MS SQL Server].


WindowsAuthentication =Y: Defines the user authentication as Windows user account (SSPI). Otherwise, authentication mode is set to SQL Server account (default).

ServerName Host Name or IP Address of the SQL server to access. In some cases, the name of the specific server instance should be added to the host name or IP address.

UserName User name for logging in to the server. Leave empty in case you are using Windows Authentication.

Password Password for logging in to the server. Leave empty in case you are using Windows Authentication.

DatabaseName Name of database to access.

TableName Database table or view name to access. Using this parameter is equivalent to using the following SQL query: Select * from <tablename>


6.9.3 Oracle Database Server

To use Oracle database server as data source for glossaries you need to have an installation of Oracle client 64-bit version. The installation can be found at Oracle web site or from Babylon’s site. The Oracle net client must include Oracle Data Provider for .NET (ODP.NET) and configured with the appropriate TNSNames.ora settings.

You need to have a read-only credential to access the specific database and to its relevant data objects: tables, views or stored procedures. The user credentials can be either a Windows (Active Directory) user or an Oracle user.

The following parameters are used when Oracle database server is the data source. The name of the section is [Oracle].


WindowsAuthentication =Y: Defines the user authentication as Windows user account (SSPI). Otherwise, authentication mode is set to SQL Server account (default).

ServiceName Name of the Oracle service to access. This service name should already be defined in the Oracle client tnsnames.ora file.

UserName User name for logging in to the server.

Password Password for logging in to the server.


http://bes.babylon.com/ftp/download/Oracle/Oracle_win64_11gR2_client.zip


6.9.4 MySQL Server

To use MySQL database as data source for glossaries you need to have a read-only credential to access the specific database and to its relevant data objects: tables, views or stored procedures.

The following parameters are used when MySQL is the data source. The name of the section is [MySQL].


ServerName Host Name or IP Address of the MySQL server to access.

Port The server port to use. If omitted, the server default port is used.



DatabaseName Name of database to access.



6.9.5 ODBC

Any 64-bit ODBC driver can be used as a data source for glossaries. A specific system DSN (data source name) must be configured in Windows ODBC Data Source Administrator with its 64-bit version.

The following parameters are used when ODBC is the data source. The name of the section is [ODBC]


Dsn Name of the ODBC data source to access.

dsnUID User name for logging in to the data source.

dsnPWD Password for logging in to the data source.

dsnTable Database table or view name to access. Using this parameter is equivalent to using the following SQL query: Select * from <tablename>


6.9.6 IBM DB/2 Database

To use IBM DB/2 database as data source for glossaries, your server needs to have an installation of IBM Data Server Provider for .NET. The installation can be found at IBM web site or from Babylon’s site. You also need to have credentials to access the specific database and to its relevant data objects: tables, views or stored procedures.

The following parameters are used when Microsoft SQL Server is the data source. The name of the section is [DB2].


ServerName Host Name or IP Address of the SQL server to access.



http://bes.babylon.com/ftp/download/IBM/iAccessforWindows/64-bit.zip


6.9.7 XML

6.9.7.1 Introduction

The Extractor can use XML data as data source for glossaries. The Extractor is designed to parse the XML data into a representation of a data table. The Extractor can handle two types of XML structures:

1. XML with one data loop - repetition of a subset of XML nodes where each subset represents a record in a table. For Example:

XML Example 1

In this example, the XML is represented in the following table:


2. XML with two data loops, one outer and one inner – like the first structure but with a second repetition of a subset of XML nodes (inner loop) within each of the subsets of the first repetition (outer loop). In such structure the Extractor create a record from each step of the inner loop and incorporates to it the data from the outer loop. All the records yielded from one step in of the outer loop will have the same column values for the data taken from the outer loop nodes. For Example:

XML Example 2

In this example, the XML is represented in the following table:


6.9.7.2 Parsing the XML into a table

The XML source is parsed into a table using specific parameters grouped into the XML section. Follow the steps below to properly define the parsing logic:

1. Define the XML node that marks the records. It is a repetitive node which all the records columns are its children properties and/or nodes. The parameter holding it is called “RecordNode” and is defined with the exact name of the node (case sensitive). In XML Example 1, the “RecordNode” would be “CD” and in XML Example 2, the “RecordNode” would be “Requisition”.

2. If the XML has two data loops, the second (internal) loop would also have a records node, in a similar way to the RecordNode. The parameter holding it is called “RecordBreak” and defined with the exact name of the node (case sensitive). In XML Example 2, the “RecordBreak” would be “item”.

3. Define the nodes and/or properties that serves and columns of the table. The parameter holding them is called “ColumnString” and is defined with a comma delimited string, where every organ in the array is a targeted to be a specific column in the table. The node or property is always defined with relation to the “RecordNode” being the root node. The definition is based on the hierarchy location of the specific node or property related to the root. Slash character (/) is used to symbolize going one level down in the node hierarchy or going down from a node to one of its properties. To define a property value, use “prop:” before the property name. Nodes and/or properties names are case sensitive and always relates to the “RecordNode” even if they are a part on the second (inner) loop.

4. Define the variables. The parameter holding them is called “Variables” and is defined with a comma delimited string, with the exact organs number as “ColumnString”. Every organ in the array relates to its exact ordinal match in “ColumnString” and serves as its logical name for easier use within the glossary template or when converting the data table to SQLite database.

In the case of XML Example 1, the data table presented above as an output of the parsing is achieved with the following parameters:

• RecordNode=CD

• ColumnString=TITLE,ARTIST,COUNTRY,COMPANY,PRICE,YEAR

• Variables= TITLE,ARTIST,COUNTRY,COMPANY,PRICE,YEAR

In the case of XML Example 2, the data table presented above as an output of the parsing is achieved with the following parameters:

• RecordNode=Requisition

• RecordBreak=Item

• ColumnString=ReqNo,RequesterID,RequestDate,DeliveryLocation, RequestItems/Item/Seq,RequestItems/Item/Product, RequestItems/Item/Product/prop:category,RequestItems/Item/Qty

• Variables=ReqNo,ReqID,ReqDate,Location,ItemSeq,ProductName, ProductCategory,Qty


6.9.7.3 XML with repetitive structures

XML data may contain repetition of nodes structures at the same level in the XML hierarchy.

XML Example 3

As displayed in XML Example 3, the XML nodes <languageGRP> and <description> are repetitive and for each occurrence, each of the nodes with matching names share the same hierarchy level: <description> is always a one level below <languageGRP>which is always one level below <Entry>.

Defining the parsing rules in the trivial way, it would like the following:

• RecordNode=Entry

• ColumnString= languageGRP/prop:type,languageGRP/description, languageGRP/description/prop:type

• Variables=Language,Description,DescriptionType

Since the Extractor cannot differentiate nodes with the exact same name and hierarchy, it will append all the values of the identical nodes into the same variable and use a comma by default to separate between values. To use an alternative separation between nodes values, use the parameter “RepetitionString” to define the string to be used as separator. This trivial parsing creates the following table:

To get a more comprehensive parsing that would create a differentiation between the values of the identical nodes/properties, use the special syntax of setting a logical name to the node/property within the “Variables” parameter. The syntax will define a logical name for a node/property based on its value with a corresponding condition on one of the other variable derived from the same XML level (hierarchy) or an upper one, currently held by the Extractor.

For example, in XML Example 3, there are six logical variables: term, meaning and definition; one in English and in Spanish. All six values derived from the same node value (languageGRP/description). The matching of any of the six nodes’ value to the specific logical variable is dependent on the value of the description type property (languageGRP/description/prop:type) and the language type (languageGRP/prop:type).

In the trivial parsing above, there is already a logical variable for each of the values that determine the nature of each description: Language and DescriptionType. To complete the full parsing, we need to add six organs to the “ColumnString” for each of the six repeating nodes. By definition, all the six would have the same value as an organ: languageGRP/description. Their matching values in the “Variables” parameter will include the proper condition rules. For example, for the Spanish term, the organ will look like: termSPANISH:cond: Language|eq|Spanish:cond1:DescriptionType|eq|Term The parts marked in blue are the reserved strings and the parts marked in red are the data-based parts. The syntax defines that the actual variable name is termSpanish and its value is based on the actual languageGRP/description node value only if the latest value of property languageGRP/prop:type parsed is “Spanish” and the latest value of property languageGRP/description/prop:type parsed is “Term”. In a similar manner, the organ value of “Variables” for the definition in English would be:


definitionEng:cond: Language|eq|English:cond1:DescriptionType|eq|Definition The revised parsing rules for the parsing would be:

• RecordNode=Entry

• ColumnString= languageGRP/prop:type,languageGRP/description/prop:type, languageGRP/description,languageGRP/description,languageGRP/description, languageGRP/description,languageGRP/description,languageGRP/description

• Variables=Language,DescriptionType,termEng:cond:Language|eq|English:cond1:DescriptionType|eq|Term,meaningEng:cond:Language|eq|English:cond1:DescriptionType|eq|Meaning,definitionEng:cond:Language|eq|English:cond1:DescriptionType|eq|Definition,termSpanish:cond:Language|eq|Spanish:cond1:DescriptionType|eq|Term,meaningSpanish:cond:Language|eq|Spanish:cond1:DescriptionType|eq|Meaning,definitionSpanish:cond:Language|eq|Spanish:cond1:DescriptionType|eq|Definition

The revised table for the parsing would look like:

6.9.7.4 XML Parameters

The following parameters are used when XML is the data source. The name of the section is [XML].


DataFile Full path and name of the XML file to be used as the data source. May also be a URL in case the XML data is provided by a web services.

LocalDataFile If the data file is a URL, use this parameter to define the full path and name of the local XML file that will be used to store the XML data retrieved from the URL.

DataFolder Name of a folder with XML files. The Extractor assumes all files in this folder have the same schema and handles them as a single data source.

RecordNode Name of the XML node (case sensitive) that marks the start of a new logical record, equivalent to a database row.

ColumnString A comma delimited string of XML node names (case sensitive) that will be used as the values for columns in the table representation. Each node is defined with its XPath syntax while omitting the appearance of the node defined as RecordNode. For example, a node called “Phone” which is a child of RecordNode, will be written as is. If “Phone” is the children of “Contact” node, it will be written as Contact/Phone. To use the values of an XML node property instead of the XML node value, use the following syntax: node_name/prop:property_name If the attribute belongs to the RecordNode the syntax would be: /prop:property_name The parameter value can be saved in a text file with the following syntax: ColumnString = file://<full path to the file>

http://en.wikipedia.org/wiki/XPath



Variables A comma delimited strings to use as the column names for the table representation of the XML. The number of entries in this list must be identical to the number of entries in ColumnString. To create more than one variable from a single node depending on an expression, use the following syntax:

<variable_name>:cond:<variable_name_to_check>| <logical_operator*> |<value>

logical_operator can be: eq (=), lt (<), gt (>), ge (>=), le (<=), neq (<>) For example:

<Data> <Entry lang='DE'> <term>Nacht</term> </Entry> <Entry lang='EN'> <term>Night</term> </Entry> </Data>

To transform the German and English nodes into two separate columns, use the following parameters:

RecordNode = Data ColumnString = Entry/term, Entry/term, Entry/term/prop:lang Variables = termEN:cond:termLang|eq|EN,termDE:cond1: termLang|eq|DE,termLang

To create more than one variable from a single node depending on two expressions, use the following syntax:

<variable_name>:cond:<variable_name_to_check>| <logical_operator*>|<value>: cond1:<variable_name_to_check>|<logical_operator*>|<value>

The parameter value can be saved in a text file with the following syntax:

Variables = file://<full path to the file>

Filter A definition for filtering the rows in a .Net DataView, based on an expression. For more information search the web for “DataView.RowFilter Property”

Sort Indicates one or more field names on which the data table is sorted, and whether each field is sorted in ascending or descending order. For more information search the web for “DataView.Sort Property”

RepetitionString If one of the nodes defined in the ColumnString parameter is a repetitive node, the Extractor will concatenate all its occurrences in one table column while adding this string as a separator between the repetitive node values. Default value is comma.

RecordBreak Defines the name of the XML node that marks the beginning of a new logical record in a second (internal) loop inside the XML

DuplicatePreviousRecord =Y: If RecordBreak is defined, the table will include for each record created in the inner loop, the columns data of all the variables that were defined in the ColumnString and that are located above the RecordBreak node. =N: Only the first variable defined in ColumnString will be added to the table columns.



SkipRecordToDuplicate A comma delimited strings representing a list of variables. When RecordBreak is defined and DuplicatePreviousRecord is set to Y, the Extractor will prevent the duplication of the variables in the list from the outer loop into records created in the inner loop.

User Defines the user name when the data source is a web service that requires user authentication.

Password Defines the password when the data source is a web service that requires user authentication.

TableName The Extractor will convert the data table retrieved from the XML data into a table with this name in a SQLite database stored in memory. The database remains in memory and available for use throughout the entire extraction process and all subsequent processes.

ConvertUnix2PC =Y: convert the XML source file from a UNIX format to a common Windows format by replacing all Line Feeds with a combination of Carriage Return and Line Feed.


6.9.8 Microsoft SharePoint


Microsoft SharePoint is one of the most popular platforms for implementing a company portal. A SharePoint Site is a collection of pages, lists, and libraries configured for achieving an express goal. A site may contain sub-sites, and those sites may contain further sub-sites. Typically, sites need to be created from scratch, but sites can also be created per pre-defined templates that provide packaged functionality.

Lists and libraries are stored in SharePoint Sites. A List can be thought of as a collection of pieces of information — all of which (typically) have the same properties. This could be considered like a database table. For instance, you can have a list of links called "my links", where each item has a URL, a name, and a description.

Lists have many features such as workflows, item-level or list-level permission, version history tracking, multiple content-types, external data sources, and many more features. Some of these features depend on the version of SharePoint that is installed.

A Library is a list where each item in the list refers to a file that is stored in SharePoint. Libraries have all the same behaviors as lists, but because libraries contain files, they have extra features. One of these is the ability to be opened and modified through a compatible WebDAV client (e.g. Windows Explorer).

The Extractor can use SharePoint lists and libraries as data source for glossaries. The Extractor is designed to use SharePoint Web Services, convert the content of the list or library into an XML file and that create a glossary based on it.

The XML structure layout is identical for all lists:

• A <z:row> node for each record of the list

• All the list items are properties of the node

To process the list into a glossary, the parameter file should include [MS SharePoint] section to create the XML file and a [XML] section to process it into a glossary.

6.9.8.2 MS SharePoint Parameters

The following parameters are used when SharePoint list is the data source. The name of the section is [MS SharePoint].


SiteDataURL The URL for the SharePoint lists web service discovery module. The URL format is: http://<site>/_vti_bin/Lists.asmx where <site> will include the SharePoint host name or IP address, its HTTP port and direction to the site location. For example: http://MyCompanyPortal:8081/Sales/_vti_bin/Lists.asmx

ListName The list identifier. The identifier could be the list GUID in the format of {xxxxxxxx-xxxx-xxxx-xxx-xxxxxxxxxxxx}.

ViewName Optional. The identifier of the view which is attached to the list to use when querying SharePoint. The identifier is the view GUID in the format of {xxxxxxxx-xxxx-xxxx-xxx-xxxxxxxxxxxx}.

http://en.wikipedia.org/wiki/Uniform_Resource_Locator

http://en.wikipedia.org/wiki/WebDAV

http://mycompanyportal:8081/Sales/_vti_bin/Lists.asmx



QueryOptions An XML fragment that contains separate nodes for the various properties of the SharePoint query object (SPQuery). More information can be found in SharePoint documentation. When the list is a library, it is mandatory to use the following value to ensure that all the content of the library be scanned in a recursive way: <ViewAttributes Scope='Recursive' />

View A ViewFields element that specifies which fields to return in the query and in what order as in the following example. <ViewFields> <FieldRef Name="ID" /> <FieldRef Name="Title" /> </ViewFields> More information can be found in SharePoint documentation.

RSFile Full path and name of the XML file to be used as the holder of the list data. Since the layout of the XML file is constant, the [XML] section that follows should always define RecordNode as z:row and ColumnString as properties of z:row node. For example:

[xml] DataFile=data.xml RecordNode=z:row ColumnString=/prop:ows_EmpID,/prop:ows_FirstName,/prop:ows_LastName variables=EmpID,FirstName,LastName

http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spquery(v=office.12).aspx

http://msdn.microsoft.com/en-us/library/ms442073(v=office.12).aspx


6.9.9 Active Directory/LDAP


The Extractor can use LDAP based directory, such as Microsoft Active Directory, as data source for glossaries.

6.9.9.2 Active Directory Parameters

The following parameters are used when Microsoft Active Directory or LDAP server is the data source. The name of the section is [Active Directory]


ServerName Name or IP address of the Microsoft Active Directory or LDAP server to access.

ServerPort TCP/IP port number of the LDAP server. If the parameter is not supplied, the default port 389 is used.

ServiceType Alternative service to access, for example GC (for Global Catalog). If the parameter is not supplied, the default service LDAP is used.

BaseDN Optional parameter. The name of the base object entry (or possibly the

root) to access. For example: ou=people,dc=rutgers,dc=edu

SearchScope Specifies the scope of a directory search. Possible Values are: =Base: Limits the search to the base object. The result contains not more than one object. =Onelevel: Searches only immediate children of the base object, excluding the base object. =Subtree: Default. Searches base object and all children.

SearchFilter A valid LDAP search filter. For example: (&(objectCategory=person)(objectClass=user)(mail=*)) For more information about the LDAP search string format, see "Search

Filter Syntax" in the MSDN Library at http://msdn.microsoft.com/library.

Variables A comma delimited string of the LDAP attributes to be used as data table columns. The Extractor uses the variables to issue the basic LDAP query and then per each retrieved record, issue a request to each specific variable set here. For example: DisplayName,Surname,GivenName,Title,Company,Department,TelephoneNumber,Mail

TableName The Extractor will convert the data table retrieved from the LDAP data into a table with this name in a SQLite database stored in memory. The database remains in memory and available for use throughout the entire extraction process and all subsequent processes.

ImageVariable A name of a variable from the “Variables” parameter which holds a photo as a binary object. When the parameter is defined, the Extractor will extract the photo to a folder on the disk. The folder should be defined as parameter “BlobFolder” in the [Settings] section.

ImageNameVariable A name of a variable from the “Variables” parameter which will hold the file name of the photo. The variable should have unique values so each photo could be easily identified.

ImageExtension A name of a variable from the “Variables” parameter which will hold the file extension of the photo.

http://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol

http://msdn.microsoft.com/library


6.9.9.4 Non .Net Supported LDAP Directories

There are cases where the Extractor will fail to access LDAP directories in the above way. In such case, the alternative would be to use a PERL script to extract the information from the LDAP server to XML file and then parse it into a glossary.

To implement this alternative, install a PERL engine for Windows 2008 64 bit. The recommended product is “ActivePerl for Windows (x64)” of “ActiveState Software Inc”. The Community Edition is free to use for development projects and internal deployments.

After installing the base engine, you may need to add a few common libraries to enable access to LDAP directories.

An example for a PERL script that produces XML file from LDAP directory can be downloaded from here.

http://en.wikipedia.org/wiki/Perl

http://bes.babylon.com/ftp/download/LDAP/LDAP_Extract.pl


6.9.10 SalesForce


The Extractor can use information managed by SalesForce application as data source for glossaries. SalesForce is a cloud based CRM solution. The Extractor uses SalesForce Apex Web Services API to retrieve the information from the application. The pre-requisites for enabling the extraction are to have HTTP connection from the Extractor to SalesForce server to have a set of user, password and security token to access the relevant application instance. The security token is required for accessing salesforce.com from outside of your company’s trusted networks. New security tokens are automatically sent to you when your salesforce.com password is changed or when you request to reset your security token.

The Extraction is based on extracting one or more Salesforce objects. For a view of the standard Salesforce objects and the important relationships between them, visit Salesforce data model page.

As an alternative to extracting the complete data of a Salesforce object, it is possible to use specific queries with Salesforce Object Query Language (SOQL) to get specific data extraction.

6.9.10.2 SalesForce Parameters

The following parameters are used when SalesForce is the data source. The name of the section is [SalesForce.com]


UserName User name for logging in to the Salesforce system

Password Password for logging in to the Salesforce system

Token Salesforce security token

Objects A comma delimited list of Salesforce objects to retrieve. Each object is saved inside a SQLite database, in a separate table named as the object name. The SQLite database can be manipulated to produce the data source for the process. The available objects list can be found in Salesforce data model page. When this parameter is used, the following parameter (Queries) is ignored.

Queries A pipe (|) delimited list of Salesforce queries to retrieve. Each object is saved inside a SQLite database, in a separate table named as the object name in the query. The SQLite database can be manipulated to produce the data source for the process. For example: select AccountId,Id,FirstName,LastName,Title,Email,Phone, MobilePhone from contact|select Name,Phone,personmobilephone,Fax,WebSite,BillingStreet, BillingCity,BillingState,BillingPostalCode,BillingCountry from account Queries with select all (select *) are not supported. More information about the query syntax can be found in Salesforce Object Query Language page. When this parameter is used, the previous parameter (Objects) is ignored.

http://www.salesforce.com/

http://www.salesforce.com/us/developer/docs/apexcode/Content/apex_intro_what_is_apex.htm

http://www.salesforce.com/us/developer/docs/api/Content/data_model.htm


http://www.salesforce.com/us/developer/docs/officetoolkit/Content/sforce_api_calls_soql.htm


http://www.salesforce.com/us/developer/docs/officetoolkit/Content/sforce_api_calls_soql.htm


6.9.11 SQLite Database

6.9.11.1 SQLite Parameters

SQLite database (version 3) can be used as data source for glossaries.

The following parameters are used when SQLite is the data source. The name of the section is [SQLite].


UseCurrentDB Full path and name of an SQLite database file to be loaded to memory =Y: uses the SQLite database currently in memory (from previous process)

6.9.11.2 SQLite Customized Functions

The SQLite version used by the Extractor is customized and contains the following special functions.

6.9.11.2.1 INSTR Function

The function returns the location of a substring in a string. If substring is not found in string, then the INSTR function will return 0

Syntax INSTR(start_position, string, substring)

Parameters or Arguments start_position

The position in string where the search will start. The first position in the string is 1.

string

The string to search.

substring

The substring to search for in string

Example INSTR(1, 'Tech on the net', 'e')

Result: 2 (the first occurrence of 'e')

INSTR(5, 'Tech on the net', 'e')

Result: 11 (the first occurrence of 'e' starting from the 11th character of ‘Tech on the net')

6.9.11.2.2 SPLITSTR Function

The function parses a single string containing delimited values into an array and returned the value of a specific organ per its location.

Syntax SPLITSTR(string, delimiter, location)

Parameters or Arguments string

The string to parse.

delimiter

The character used to delimit the substrings in string

location

The ordinal location of the array organ to retrieve where is first organ position is 1.

http://www.sqlite.org/


Example SPLITSTR('100.101.102.104.105', '.', 3)

Result: 102 (the third organ of the array created by splitting the string by the dot character)

6.9.11.2.3 BASE64 Function

The function converts a string to its equivalent string representation that is encoded with base-64 digits. The base-64 digits in ascending order from zero are the uppercase characters "A" to "Z", the lowercase characters "a" to "z", the numerals "0" to "9", and the symbols "+" and "/". The valueless character, "=", is used for trailing padding.

Syntax BASE64(string)


The string to convert.

Example BASE64('Babylon Software')

Result: QgBhAGIAeQBsAG8AbgAgAFMAbwBmAHQAdwBhAHIAZQA=

6.9.11.2.4 KILOFORMAT Function

The function converts a number or its string representation to its equivalent string with comma as thousand separators.

Syntax KILOFORMAT(number or string)

Parameters or Arguments number or string

The number/string to convert.

Example KILOFORMAT(150475698.89)

Result: 150,475,698.89

6.9.11.2.5 HASHSTR Function

The function computes the MD5 hash value of a string and returns the hash as a 32-character, hexadecimal-formatted string. The hash string created by this code example is compatible with any MD5 hash function (on any platform) that creates a 32-character, hexadecimal-formatted hash string.

Syntax HASHSTR(string)


The string to compute.

Example HASHSTR('State of the Art')

Result: d783b08a8b6fc8af92c9fd46da7e18e4

https://en.wikipedia.org/wiki/MD5


6.9.11.2.6 IPADDRESS Function

The function returns the IP addresses of a given host name as a string delimited with the vertical bar (|).

Syntax IPADDRESS(string)


The host name.

Example IPADDRESS('www.babylon-software.com')

Result: 107.6.141.14|198.20.106.254

6.9.11.2.7 GETADPROPERTY Function

The function returns the value of a specific Active Directory (LDAP) property for s specific user identified by its windows user name (SAMACCOUNTNAME).

Syntax IPADDRESS(server_name, user_name, property_name)

Parameters or Arguments server_name

The Active Direcory or LDAP server name.

user_name

The windows user name as appears in property “samaccountname” of the directory.

property_name

The property name of the directory to retrieve.

Example GETADPROPERTY('babsoft.co.il','Zohar','co')

Result: Israel

6.9.11.2.8 URLENCODE Function

The function converts a string to a standard format that can be transmitted over the Internet.

Syntax URLENCODE(string)


The string to encode.

Example URLENCODE('Gerhard Schröder')

Result: Gerhard+Schr%c3%b6der


6.9.11.2.9 GETSPPROPERTY Function

The function returns the value of a SharePoint user profile property for s specific user identified by its windows user name.

Syntax getspproperty(SharePoint_Site_User_Profile_Service_WSDL_URL, user_name, property_name)

Parameters or Arguments server_name

URL for the User Profile web service description file (UserProfileService.asmx).

user_name

The windows user name – usually domain\username.

property_name

The property name of the user profile to retrieve.

Example GETSPPROPERTY('http://spserver/Rnd/_vti_bin/UserProfileService.asmx','windomaon\zoharb','workemail')

Result: [email protected]

6.9.11.2.10 LOCINARRAY Function

The function parses a single string containing delimited values into an array and returned the location of a sub-string value as a specific organ in the array.

Syntax LOCINARRAY(string, delimiter, sub-string to match, start)


The string to parse.

delimiter

The character used to delimit the substrings in string.

sub-string to match

Sub-string to match as one of the array organs.

start

From which organ in the array to start the match. First organ is 1.

Example LOCINARRAY(type,'|','form',1) Result: SYNONYM


6.9.12 SAP


The Extractor can use information from tables in a SAP system as data source for glossaries. The Extractor will automatically convert the SAP data to SQLite database which can be used for the creation of the glossary.

6.9.12.2 SAP Parameters

The following parameters are used when SAP is the data source. The name of the section is [SAP]


Host The host name or IP address of the SAP application server.

MessageServer The host name or IP address of SAP messaging server. Use this value when connecting to SAP via load balancer.

LogonGroup The SAP logon group for connecting via load balancer.

SystemNR The SAP system number to connect to.

SystemID The SAP system ID to connect to.

Client The SAP client number to connect to.

User User name for logging in to the SAP system.

Password Password for logging in to the SAP system.

Language Two characters’ representation of the connection language.

Trace Y: increase SAP log verbose level.

RowsLimit A number for setting the total number of records to read from SAP. For no limit, omit the parameter.

PacketSize A number for setting the number of records per communication package. For no limit, omit the parameter. Default value is 5000.

Table1 The first SAP table to access.

Cols1 A pipe (|) delimited list of columns from Table1 to retrieve.

Criteria1 A string representing a Where Clause which is executed by the SAP Application Server on Table1. Use it for narrow down the number of records to retrieve from SAP. For example: DOKAR in ('ASI','ASD') and DOKTL='DE' and dokst = 'FR'

Table2 The second SAP table to access.



Table3 The third SAP table to access.



Table4 The fourth SAP table to access.




Table5 The fifth SAP table to access.



Table6 The sixth SAP table to access.



Table7 The seventh SAP table to access.



Table8 The eighth SAP table to access.



Table9 The ninth SAP table to access.




6.9.13 Microsoft Outlook Contacts

The Extractor can convert Microsoft Outlook contacts into an enterprise glossary. For that, Microsoft Outlook needs to be installed on the machine running the Extractor. To speed up the process, the Extractor skips the following folders while scanning for contacts:

• Junk E-mail

• Spam Mail

• Deleted Items

The following parameters are used when Outlook (contacts) is the data source. The name of the section is [Specials].

The following are the data items taken for each contact and can be used while designing the glossary template:

• ContactID • HomeAddress • Notes

• LastName • BusinessTelephoneNumber • FolderName

• FirstName • BusinessTelephoneNumber2 • FolderPath

• MiddleName • MobileTelephoneNumber •

• NickName • BusinessFaxNumber •

• CompanyName • HomeTelephoneNumber •

• JobTitle • Home2TelephoneNumber •

• ManagerName • OtherTelephoneNumber •

• AssistantName • Email1Address •

• Categories • Email2Address •

• BusinessAddress • Email3Address •


CaseType =outlook contacts: uses the Contacts information on the Extractor machine as the data source.

ExcludeFolders A list of Outlook folders, written as a comma delimited string, which the Extractor skips while scanning for contacts. For example: Personal,Public Folders - [email protected]

TableName The Extractor will convert the data table retrieved from Outlook into a table with this name in a SQLite database stored in memory. The database remains in memory and available for use throughout the entire extraction process and all subsequent processes.


6.9.14 File System (NTFS)

Any Windows NTFS volume is a source for an enterprise glossary using the files properties.

The following parameters are used when Outlook (contacts) is the data source. The name of the section is [Specials].

By default, the following common file properties, are scanned by the Extractor and can be used while designing the glossary template:

• FileName • Modified (date)

• CleanFileName (no extension) • Size

• Extension • FilePath

• FileType • FileURL

• Created (date)

If you set the parameter activating the OLE Properties, then for Microsoft Office file you can also use the data items below derived from the document properties set in the Office application itself

• Title • Category

• Author • Company

• Comments • Keywords

• Application • Manager

• Version • Template

• Subject


CaseType =file finder: uses the files on the NTFS volume as the data source.

RootFolder The location (root folder) where the Extractor starts to scan files.

ExtensionstoInclude =<filename extension>. The types of files that will be scanned by the Extractor. Comma delimited. For example: txt, doc, ppt, pdf, exe, msi, dll

UseOleProperties

=Y: uses the “Microsoft Developer Support OLE File Property Reader” to get extended file properties from Microsoft Office documents. Before using it, make sure the file “dsofile.dll” is located in the Extractor “bin” folder. Make sure it is registered by running the following from the command prompt: Regsvr32 <full path>dsofile.dll

TableName The Extractor will convert the data table retrieved from the files system into a table with this name in a SQLite database stored in memory. The database remains in memory and available for use throughout the entire extraction process and all subsequent processes.


6.9.15 Automatic Data Generation

In some scenarios of creating glossaries, the terms need to be setup as a sequential series of values. An example for such a scenario is building hybrid glossary from a corporate data source where the ability to scan the terms for the glossaries cannot be achieved in timely manner due to the size of the data. In such cases where the actual indexes cannot be extracted, you can try to automatically create the sequence of the indexes in an artificial way.

The automatic data generation is set to create a data table with up to three data items: Term1, Term2 and Term3. The data is created in three loops where the outer loop is of Term1. The loop of Term2 is inside Term1 and the loop of Term3 is inside Term2. Each loop of values can be a standard numeric progression or character-based progression according to a specific pattern.

A numeric progression loop starts from a starting number, stepping up in units of 1 until a target number is reached. A character-based progression loop is based on a scale which is represented by a string of character. The first step is the first character in the scale; the second step is the second character and so on. In the step right after the last character in the scale is fetch, the combination of the second character and the first character, after that the combination of twice the second character, after that a combination of the second character and third and so on.

The following parameters are used for automatic generated data source. The name of the section is [AutoGeneration].

For example, if the parameters are as follows: [AutoGeneration] 1stType = 0 1stStart = 1 1stend = 2 2ndType = 0 2ndstart = 1 2ndend = 3 3rdType = 1 3rdStart = 1 3rdend = 10 3rdCharBase = ABX#


1stType =0: numeric loop for Term1 values =1: character loop for Term1 values

1stStart Starting value for the loop of Term1

1stend Target value for the loop of Term1

1stCharBase A string representing the scale for the character loop of Term1

2ndType =0: numeric loop for Term2 values =1: character loop for Term2 values

2ndStart Starting value for the loop of Term2

2ndend Target value for the loop of Term2

2ndCharBase A string representing the scale for the character loop of Term2

3rdType =0: numeric loop for Term3 values =1: character loop for Term3 values

3rdStart Starting value for the loop of Term3

3rdend Target value for the loop of Term3

3rdCharBase A string representing the scale for the character loop of Term3

TableName The Extractor will convert the automatic data table into a table with this name in a SQLite database stored in memory. The database remains in memory and available for use throughout the entire extraction process and all subsequent processes.


The automatic data generated table looks like the following:

Term1 Term2 Term3

1 1 A

1 1 B

1 1 X

1 1 #

1 1 BA

1 1 BB

1 1 BX

1 1 B#

1 1 XA

1 1 XB

1 2 A

1 2 B

1 2 X

1 2 #

1 2 BA

1 2 BB

1 2 BX

1 2 B#

1 2 XA

1 2 XB

1 3 A

1 3 B

1 3 X

1 3 #

1 3 BA

1 3 BB

1 3 BX

1 3 B#

1 3 XA

1 3 XB

2 1 A

2 1 B

2 1 X

2 1 #

2 1 BA

2 1 BB

2 1 BX

2 1 B#

2 1 XA

Term1 Term2 Term3

2 1 XB

2 2 A

2 2 B

2 2 X

2 2 #

2 2 BA

2 2 BB

2 2 BX

2 2 B#

2 2 XA

2 2 XB

2 3 A

2 3 B

2 3 X

2 3 #

2 3 BA

2 3 BB

2 3 BX

2 3 B#

2 3 XA

2 3 XB


6.9.16 Automatic Reports Generation

The automatic reports generation is set to an automatic (background mode) production of the reports described in section 6.7.2 – Server Reports.

The following parameters are used for automatic reports generation. The name of the section is [Reports].

For example, the following parameters are used to produce all the available reports using all default values:

[Reports] List=1,2,3,4,5,6,7,8,9,10,11,12


List Comma delimited string representing the reports to be produced. The report is identified by its number as described in section 6.7.2 – Server Reports or as presented in the reports selection list in the Extractor utilities. Each report selected will be produced in two formats: HTML for easy reading and CSV for loading to Excel or any related matter.

Server Optional. The server hostname or IP address which manages the glossaries. Default value is the current server hostname.

Port Optional. The TCP/IP port of the translation service of the managing server. Default value is 7891.

LogPath Optional. Full path to a folder containing activity log file. Default value is “C:\Babylon-Enterprise Server\Server\LogFiles”.

DBFile Optional. Full path to the location of the SQLite DB file. Default value is <WorkingFolder> + "BesLogDB.db".

DoNotRefreshDB Optional. Set to Y to avoid the refresh of the SQLite DB. Default value is FALSE.

OutputFolder Optional. Full path to the folder where the reports output file should be stored. Default value is the Working Folder.

EnterpriseGlossariesList Relevant only for running report number 8. A comma delimited string of the glossaries URI which are classified as enterprise glossaries. If the parameter is omitted, the Extractor will try to take the value from the following registry entry “Current User\Babylon-Enterprise\EnterpriseGlossariesList”.

Email Optional. Set to Y to send the reports files to designated email addresses. For email settings, see Glossary Extractor – Administration Settings.

LogDaysBack Optional. Set an integer to limit the log files that will be processed for the report. The integer indicated the number of days before today’s date to process.


6.10 Glossary Extractor – General Settings

The general settings are parameters that are common to all data sources. The following parameters are used as general settings. The name of the section is [Settings].


NoGloss =Y: The Extractor will only execute the data preparation stage without producing a glossary. Use this parameter in case you need to convert the data to SQLite database table.

HandleMainRS The parameter is relevant only if NoGloss is set to Y. =save: When the Extractor completes the data preparation, it is saved to disk in XML format in file “<GlossaryTitle>temp.xml”. =sqlite: When the Extractor completes the data preparation, the data is converted to SQLite table named “<GlossaryTitle>”.

PreSQLQuery An SQL query string. This query will run prior to the main one (see SQLQuery) on the selected data source. This query can be used to prepare temporary DB structures before the main SQL query is run. To use an external SQL query file (.SQL) use the following syntax: PreSQLQuery = file://<full path to the sql query file>

PreSQLQuery1 An SQL query string. This query will run prior to the main one (see SQLQuery) and after PreSQLQuery on the selected data source. This query can be used to prepare temporary DB structures or create indexes before the main SQL query is run. To use an external SQL query file (.SQL) use the following syntax: PreSQLQuery1 = file://<full path to the sql query file>

SQLQuery An SQL query string. This query defines the scope of the extraction. To use an external SQL query file (.SQL) use the following syntax: SQLQuery = file://<full path to the sql query file>

TemplateFile Full path and name of the template file (HTML) that defines the glossary layout design.

GlossaryHeaderFile Full path and name of the glossary header file.

GlossaryTitle When set, overwrites the glossary title defined in the glossary header. The actual title is the parameter value concatenated with the glossary update date.

ShowGlossLastUpdateTime Used with GlossaryTitle parameter. =Y. The glossary title will be appended with the update time (on addition to the date).

ExtDataFile Full path and name of the file actually used as data source. For example, a text file linked in a Microsoft Access database. Used with GlossaryTitle to append the update date when the actual data source is described by a mediator file. The update date will be taken from the last update date of the actual data file.

ExportRecordSetColumns =Y: Exports the data source column names to the Extractor log file (Extractor_log.txt).

BlobFolder A folder for saving temporary image files. Used in case the data source contains BLOB (Binary Large OBject) columns and the glossary template include a tag to convert them to image files.



UseAdvancedBuilder =Y: Compiles a glossary in its binary (BGL) format for installation on a server or a client. =N: Outputs a glossary file in its textual format for debug purposes.

HandleBreakLevel =Y: Run the Extractor in aggregation mode.

SkipPathParsing During compilation, the Extractor scans the glossary content for UNC paths of files. For each UNC encountered the Extractor verifies the existence of the defined file. If found, the file is embedded in the glossary. If not found, the Extractor will stop the process and produce an error. =Y: Will not halt the compiling process if the file defined by a URL or UNC cannot be found.

SkipFileEmbed =Y: The Extractor will not parse the glossary content for UNC paths and will not embed files if found.

GlossaryDataFile Full path and name of the glossary textual format. Relevant only when UseAdvancedBuilder is set to N.

BGLDataFile Full path and name of the glossary binary (BGL) format. Relevant only when UseAdvancedBuilder is set to Y.

FollowingProcessParametersFile

Full path and name of the next parameter file to be processed within the same glossary.

LogPrintingProgress =Numeric value: used to print a progress indication in the Extractor log file per processing specific number of data records.

ConnectionTimeOut The number of seconds the Extractor waits for results from the data source before initiating an error. Default is 30 seconds.

InstallBGLLocal =Y: Installs the BGL file on the local client after the extraction is completed. This parameter can be used only when creating a BGL file and when the Babylon-Enterprise client is installed on the machine running the Extractor.

SaveAsDelimitedFile Export the extraction data into a text file with a fixed delimiter. Use this parameter to define the full path and name of the export file.

DelimitedSeparator Used with SaveAsDelimitedFile parameter. Define the string that will be used as a column delimiter in the Export file. When not assigned specifically, the default would be a comma.

ConStrSupp

Use this parameter to manually add text to the connection string used by the Extractor when connecting to data sources that requires connection string. The value of the parameter will we appended as is to the end of the connection string created by the Extractor.

TermSizeToSlice

=Numeric value: used to issue an indication on the log file when the size of the term definition in bytes exceeds this value. Default value is 500000.


6.11 Glossary Extractor – Web Source Inclusion Settings

These parameters are used when the glossary template uses the tags for including a web source inside the definition (<babINCLUDE>url</babINCLUDE>). These parameters enable a basic manipulation on the included source after it is downloaded and before implemented inside the definition. The name of the section is [Included Source].


IncludeFilterStart A string indicating the starting point of the actual part of the downloaded source that will be included in the definition. Any text before the first occurrence of this string is overlooked.

IncludeFilterEnd A string indicating the ending point of the actual part of the downloaded source that will be included in the definition. Any text after the first occurrence of this string is overlooked.

IncludeFind1 All the exact occurrences of IncludeFind1 are replaced with IncludeReplace1 in the downloaded source.

IncludeReplace1

IncludeFind2 All the exact occurrences of IncludeFind1 are replaced with IncludeReplace1 in the downloaded source.

IncludeReplace2

Parameters are used when the glossary template uses the tags for including a web source

6.12 Glossary Extractor – Administration Settings

These parameters are used to send error notifications by email if the extraction process fails. To enable this functionality, the machine running the Extractor needs to have access and permission to the relevant SMTP relay service. The name of the section is [Administration].


SMTPServer The name or IP address of the SMTP server to use for sending the email

Sender The email address to use as the sender of the notifications

Receiver A comma delimited string of email addresses to send the notifications to.

To set these parameters once for all Extractor processes on the server, enter them into the server registry using a registry script as follows:

Windows Registry Editor Version 5.00

[HKEY_LOCAL_MACHINE\SOFTWARE\Babylon Server\Babylon Enterprise Server]

"SMTPServer"="mail.server.com"

"Sender"="[email protected]"

"Receiver"="[email protected]"


6.13 Glossary Extractor – Babylon Services Settings

These parameters enable installation of the glossary on the Babylon-Enterprise server at the end of the extraction process. For more information on the glossary access and distribution parameters, refer to the section Installing/Updating Glossaries. The name of the section is [Babylon Services].


DistributeFullGlossaryOnline =Y: Deploys the glossary on the server.

Active =Y: Comparable to the administration command:

badmin64 -installgloss filename activate

AllowAllOffline =Y: Comparable to the administration command:

badmin64 -installgloss filename offline all

AllowAllOnline =Y: Comparable to the administration command:

badmin64 -installgloss filename online all

AllowNoneOffline =Y: Comparable to the administration command:

badmin64 -installgloss filename offline none

AllowNoneOnline =Y: Comparable to the administration command:

badmin64 -installgloss filename online none

MandatoryOffline =Y: Comparable to the administration command:

badmin64 -installgloss filename offline …

mandatory

MandatoryOnline =Y: Comparable to the administration command:

badmin64 -installgloss filename online …

mandatory

ForcedOptionalOffline =Y: Comparable to the administration command:

badmin64 -installgloss filename offline …

optional force

ForcedOptionalOnline =Y: Comparable to the administration command:

badmin64 -installgloss filename online …

optional force

OfflinePermissions Specifies the list of users or groups that will be allowed offline access to the selected glossary. Comparable to the administration command:

badmin64 -installgloss filename offline … list

domain\entity…

OnlinePermissions Specifies the list of users or groups that will be allowed online access to the selected glossary. Comparable to the administration command:

badmin64 -installgloss filename online … list

domain\entity…


6.14 Glossary Extractor - Glossary Template File

6.14.1 Introduction

The glossary template is a file which controls the layout of the terms inserted into a glossary. The template defines the indexes which would be related to each term and the definition visually in the client. The template file is based on standard HTML with additional special Extractor tags. The template can also include client side Java Script for enriching the definition display.

The template is independent of the actual data source used by the Extractor. The template always related to a logical data table and defines how a single glossary record should look like. The Extractor loops through the records of the data table and for each one (standard template) or more (aggregation template) records, creates a single term record. The HTML text defines the layout of a single definition of the glossary: term, alternate forms and definition.

The Extractor process the template as a scripting engine. For any single record in the data table or a group of records (in case of an aggregation template), the Extractor loads the template and makes the necessary text replacements between template tags and actual data from the table. The output is always a piece of clean HTML which represents the definition, its unique index and its alternative forms (indexes).

6.14.2 Basic Elements

The following are the basic template that must be included in any templates. It identified to the Extractor the boundaries of each of the term component.

<term>term</term>

Description Marks the beginning and end of a term.

Parameters term = the term text Each term text must be unique.

<alt>alternate</alt>

Description Marks the beginning and end of an alternate form of a term.

Parameters alternate = a list of alternate forms for a term, separated by a vertical bar (|). The alternate forms tags can appear multiple times inside the template if they are not nested.

<def>definition</def>

Description Marks the beginning and end of a term.

Parameters definition = the definition HTML.

6.14.3 References between terms

To create a reference between two terms, use a standard HTML hyperlink with a reserved service name - BWORD.

To create a link to a specific term in a specific glossary, use the following format: <A href=”bword://<term to reference>” glossuri=”<glossary URI to reference>”>Display text</A>

To create a link to a specific term in all the glossaries, use the following format: <A href=”bword://<term to reference>”>Display text</A>


6.14.4 Column Value Elements

The following are the column based template tags. They can be included freely in any position in the template. The tags are replaced by actual data from the data table, as is or after a value transformation. Notice that the elements names are case sensitive. The element parameters are not case sensitive.

<!$bab_f_column>

Description The value of a column in the current row in the data table.

Parameters column = the column name

<!$babDECIMAL_column>

Description The value of a column with its mantissa reduced to 4 digits.


Example For <!$babDECIMAL_NetPrice> where NetPrice = 22.4532534543543 the element will be replaced by 22.4532

<!$babISN>

Description Returns the number of the current record in the data table where the first one is 1

<!$babISN0>

Description Returns the number of the current row in the data table where the first is o (zero).

<!$babISA>

Description Returns a sequential alphabetical string for the order of the current row in the data table.

<!$bab_blob_image type_column>

Description Converts images stored as BLOB columns (binary large objects) into file references. The Extractor saves the images as files on disk, and replaces the element with the file name reference.

Parameters image type = the type of image stored in the column. Can be one of the following: jpg, bmp, ico, png, emf, wmf column = the column name

<!$babCUTPREFIX_column, prefix>

Description Removes all occurrences of a prefix from the value of a column.

Parameters column = the column name prefix = string

Example For <!$babCUTPREFIX_EmployeeID,0> where EmployeeID = 00006498764 the element will be replaced by 6498764.


<!$babCONTROLDIGIT_column>

Description Calculates the control digit from the value of a column using the modulus 10 (LUHN-10) method.


Example For <!$babCONTROLDIGIT_EmployeeID> where EmployeeID = 54370042 the element will be replaced by 1.

<!$babREGEXP_column,pattern,match,submatch>

Description Calculates a regular expression from the value of a column using a pattern. Returns submatch from the main match number.

Parameters column = the column name pattern = string match = number submatch = number

Example For <!$babREGEXP_descr,f(\d*)[a-z]).*, 0,0> where descr = f989908a - installing win XP the element will be replaced by 989908

<babINCLUDE>url</babINCLUDE>

Description Embeds the contents of an external text/HTML document.

Parameters url = a web URL

Example <babINCLUDE>http://google.com/ig/api?stock=msft </babINCLUDE> For better control in the included source, see Glossary Extractor – Web Source Inclusion Settings

<bab_URLEncode>text</bab_URLEncode>

Description Encodes a string for reliable HTTP transmission.

Parameters text = HTML text

Examples Enzyklopädie (German) encoded as Enzyklop%C3%A4die Categoría:Matemáticas (Spanish) encoded as Categor%C3%ADa:Matem%C3%A1ticas

<bab_escaping>text</bab_escaping>

Description Converts special characters into DHTML entities. The following conversions will be performed:

Quotation mark (") becomes " Apostrophe (') becomes ' Less than (<) becomes < Greater than (>) becomes > Ampersand (&) becomes &

Parameters text = HTML text


<!$babXML_column,Type,XPath expression,Attribute name>

Description Performs XML parsing on the value of a column using the XPath expression

Parameters column = the column name Type = NODE or ATTRIB. Select NODE to retrieve node value or ATTRIB to retrieve a value of a node attribute XPath expression = Xpath expression defining a single node in the column data assuming it is a valid XML Attribute name = In case the Type is ATTRIB, define the attribute name. In case of a NODE, leave empty

Example When MD_CLOB = <?xml version='1.0'?> <authors> <author period="modern"> <name>Eva Corets</name> <nationality>British</nationality> </author> </authors> The element <!$babXML_MD_CLOB,NODE,//name,> will be replaced by Eva Cortes and the element <!$babXML_MD_CLOB,ATTRIB,//author,period> will be replaced by modern

<!$babConvNum_column,conversion type>

Description Converts the numerical value of the column

Parameters column = the column name conversion type =dec2hex (decimal to hexadecimal) or hex2dec hexadecimal to decimal)

Example For <!$babConvNum_BDR,conversion type> where BDR = 11 and conversion type = dec2hex the value of the column will be B

<!$babLINING_column,Side,mask size,fill character >

Description Repeatedly inserts the specified character/s to the column value until the defined mask size is reached.

Parameters column = the column name Side: adds characters to the left or right side of the column value. Mask size = total number of characters after filling has been applied. Fill character = character/s to be used for the filling. To use a comma as a defined character, write “comma”.

Example When Column value = 83-33 <!$babLINING_column,L,7,-> ==> --83-33 <!$babLINING_column,R,6,0> ==> 83-330 <!$babLINING_column,R,3,0> ==> 83-33 (no change to original value)

<WI_NoInstr>term and/or alternates</WI_NoInstr>

Description In case the glossary header includes parameter Minimal Substring Match Length, use this tag to exclude the listed terms or alternates from the substring matching search. To add more than one value, use | as separating character. The tag is used as informative instructions and does not appear inside the definition.


6.14.3 Alternate Forms Elements

The following are the alternative forms based template tags. They can be included freely in any position in the template. The tags are designed to be replaced with a string of alternate forms and to be included with in <alt>…</alt>tags. Notice that the elements names are case sensitive. The element parameters are not case sensitive.

<!$bab_alt_break_column>

Description Breaks the value of a column into words at spaces, hyphens and commas, and returns the list of words delimited by a vertical bar (|).


Example For <!$bab_alt_break_name> where name = Secretary-General Kofi Annan, Nigeria the element will be replaced by Secretary|General|Kofi|Annan|Nigeria

<!$bab_alt_split$_column,delimiter,ordinal>

Description Breaks the value of a column into an array of elements using delimiter, and returns the array element at the ordinal position.

Parameters column = the column name delimiter = string To use a comma (,) as the delimiter, use the value comma; for example: <!$bab_alt_split$_Address,comma,1> ordinal = number

Example For <!$bab_alt_split$_mail,@,0> where [email protected] the element will be replaced by steve

<!$bab_alt_right$_column,length>

Description Returns the characters at the end of a value of a column.

Parameters column = the column name length = number of characters

Example For <!$bab_alt_right$_phone,3> where phone=5552116 the element will be replaced by 116

<!$bab_alt_left$_column,length>

Description Returns the characters at the beginning of a value of a column.

Parameters column = the column name length = number of character

Example For <!$bab_alt_left$_organization,5> where organization=United Nations the element will be replaced by United


<!$bab_alt_replace$_column,find,replacewith>

Description Breaks the value of a column after all occurrences of the find substring has been replaced with the replacewith substring. In order use the comma character in either the find or replacewith, literally use the string “comma”. For Example:

Parameters column = the column name find = the origin substring to replace replacewith = the target substring to replace with

Example For <!$bab_alt_replace$_objects,comma,|> where objects=customers,orders,contacts the element will be replaced by customers|orders|contacts

<!$bab_alt_removechars_column>

Description Removes all occurrences of the following characters: , | . / \ _ ! # ~ ; * ( ) + “ - [space]


Example For <!$bab_alt_removechars_serial> where serial=#VN-1153-B123;15!2 the element will be replaced by VN1153B123152

<!$bab_alt_removecharsandhyphen_column>

Description Removes all occurrences of the following characters: , | . / \ _ ! # ~ ; * ( ) + “ - [space] and replaces all instances of the hyphen (-) with a vertical bar (|)


Example For <!$bab_alt_removecharsandhyphen_serial> where serial=#VN-1153-B123;15!2 the element will be replaced by VN|1153|B123152

<!$bab_alt_chop_column>

Description Removes all occurrences of the following characters: , | . / \ _ ! # ~ ; * ( ) + “ - [space] Then breaks the result into three words: one without English characters at the beginning; one without English characters at the end; one without English characters at either the beginning or the end. Returns the three words delimited by the character |.


Example For <!$bab_alt_chop_serial> where serial=ups12345na the element will be replaced by 12345na|ups12345|12345

<!$bab_alt_term-1_column>

Description Removes all occurrences of the following characters: , | . / \ _ ! # ~ ; * ( ) + “ - [space] and removes the first character.


Example For <!$bab_alt_term-1_serial> where serial=C153-1251A the element will be replaced by C1531251


<!$bab_alt_left_column>

Description Repeatedly truncates characters from the end, and adds each result to a string delimited by (|). Stops truncating when 4 characters remain.


Example For <!$bab_alt_left_serial> where serial=C153-1251A the element will be replaced by C153-1251|C153-125|C153-12|C153-1|C153-|C153

<!$bab_alt_instr_column name>

Description Repeatedly locates all possible substrings, and adds each result to a string delimited by (|). Does not locate substrings of less than 4 characters.


Example For <!$bab_alt_instr_serial> where serial=abcdefg the element will be replaced by abcdef|abcde|abcd|bcdefg|bcdef|bcde|cdefg|cdef|defg

<!$bab_alt_instr2_column name>

Description Repeatedly locates all possible substrings, and adds each result to a string delimited by (|). Locate substrings of 2 characters and above.


Example For <!$bab_alt_instr2_serial> where serial=abcd the element will be replaced by |abc|ab|bcd|bc|cd|

<!$bab_alt_permute_column>

Description Locates all possible word combinations (delimited by spaces), and adds each result to a string delimited by (|). Maintains original word order.


Example For <!$bab_alt_permute_name> where name=Fernando Antonio Spreafico Braga the element will be replaced by: Fernando Antonio Spreafico|Fernando Antonio|Antonio Spreafico Braga|Antonio Spreafico|Spreafico Braga

<!$bab_alt_permutefull_column>

Description Locates all possible word combinations (delimited by spaces), and adds each result to a string delimited by (|).


Example For <!$bab_alt_permutefull_name> where name=John Fitzgerald Kennedy the element will be replaced by: |John Fitzgerald Kennedy|John Kennedy Fitzgerald|Fitzgerald John Kennedy|Fitzgerald Kennedy John|Kennedy John Fitzgerald|Kennedy Fitzgerald John|Fitzgerald Kennedy|Kennedy Fitzgerald


6.14.4 Conditional Inclusion Element

The following template tag enables conditional inclusion of a section in the template based on logical operators. Nested conditional elements are not supported. Notice that the elements names are case sensitive. The element parameters are not case sensitive.

<!$babIF_rule_column, operator, value>text<!$babENDIF>

Description Returns text based on a conditional expression comparing the value of the column and value using operator.

Parameters column = the column name operator = one of the following logical operators:

gt greater then (>) lt lower then (<) ge greater equal (>=) le lower equal (<=) eq equal (=) neq not equal (<>)

value = A value of the same type as the column. To use NULL as a value, use the word null; for example: <!$babIF_rule_AdditionalName,neq,null> text = HTML text

Example For <!$babIF_rule_country,eq, USA>New York<!$babENDIF> where country=USA the element will be replaced by New York.

<!$babIF_objt_column>text<!$babENDIF>

Description Returns text if the value of a column is a filename that exists on disk.

Parameters column = the column name text = HTML text


6.14.5 Aggregation Template


The Glossary Extractor enables aggregation of different data records into a single term so that all data records sharing a common term (unique index) are displayed within a single definition. This is a classical case to a data source which is built as a join between two database tables which has 1:N relationship between them.

Consider, for example, the following table of purchase orders:

OrderID PurchaseDate Customer Product Qty

551550 1/1/2003 Tom Charts Laptop 1

551551 22/1/2003 Zoe Birch Printer 1

551552 5/2/2003 Rafi & Sons Keyboard 2

551552 5/2/2003 Rafi & Sons Mouse 3

551552 5/2/2003 Rafi & Sons Printer cartridge 5

551552 5/2/2003 Rafi & Sons Paper block 10

551554 19/2/2003 Bob Baumer TV Card 1

Converting such a table into a Babylon-Enterprise glossary, using a standard template, reveals a challenge. The orders’ records have no unique index. Using the OrderID as the term of the template will result in multiple definitions with redundant information for each order search (PurchaseDate and Customer). This challenge is best addressed using an aggregation template. An aggregation template is designed to include a group of data records, one or more, into one glossary term record. To ensure the aggregation is processed correctly, the following requirements must be met:

1. The parameters file of the process has HandleBreakLevel set to Y in the Settings section.

2. The data table must be sorted according to the value set as the term in the template.

3. The template must include all the aggregation tags (see below).

When the example table above is converted into a glossary using an aggregation template, each order has a single glossary term which displays the OrderID, PurchaseDate and Customer once and a table of the products and quantities which are included in the order.

6.14.5.2 Aggregation Tags

Processing an aggregation template assumes that the data table is sorted according to the template term. Therefore, the Extractor is set to automatically identify groups of data records which share the same term value and insert one glossary record per group. The tags in the aggregation template are used to divide the template into three areas:

• Break Prefix –an area which is processed once per group of records, right after the new record with a new term value is introduced. The area starts with the tag <!$babBREAKPREFIX>, which should be placed just before the <def> tag, and ends with the tag<!$babENDBREAKPREFIX>.

• Record Level –an area between the Break Prefix and the Break Suffix which as no boundaries tags. It is processed for any data record.

• Break Suffix – an area which is processed once per group of records, right after the last record in a group is introduced. The area starts with the tag <!$babBREAKSUFFIX> and ends with the tag<!$babENDBREAKSUFFIX> which should be placed just after the </def> tag.

The sequence of the aggregation tags is illustrated below based on the example purchase orders table:


In general, the structure of the definition area in an aggregation template is as follows:

<!$babBREAKPREFIX><def>prefix text<!$babENDBREAKPREFIX>

repeated text

<!$babBREAKSUFFIX>suffix text</def><!$babENDBREAKSUFFIX>

Parameters prefix text = will be included only once in the definition, before repeated text, for all records sharing the same term.

suffix text = will be included only once in the definition, after repeated text for all records sharing the same term.

repeated text = will be repeated for each record sharing the same term

6.14.5.3 Aggregation Template Example

Template File

<term><!$bab_f_OrderID></term><alt></alt> <!$babBREAKPREFIX> <def> <table> <tr><td colspan=2><b><!$bab_f_Customer></td></tr> <tr><td><b>Country:</b></td><td><!$bab_f_Country></td></tr> <tr><td><b>Agent:</b></td><td><!$bab_f_agent></td></tr> <tr><td><b>Distributor:</b></td><td><!$bab_f_distributor></td></tr> <tr><td><b>Re-seller:</b></td><td><!$bab_f_reseller></td></tr>\ <tr><td><b>Complete date:</b></td><td><!$bab_f_CompleteDate></td></tr> </table> <table border=1> <tr><td><b>Product</b></td><td><b>License</b></td><td><b>Qty</b></td></tr> <!$babENDBREAKPREFIX> <tr><td><!$bab_f_Product></td><td><!$bab_f_License></td><td><!$bab_f_qty></td></tr> <!$babBREAKSUFFIX> <tr><td colspan=3><A href="https://server/order.php?id=<!$bab_f_OrderId>">Go to BOS</A></td></tr> </table> </def> <!$babENDBREAKSUFFIX>


Result Definition


6.15 Side Template – Extended Aggregation


An aggregation template is the perfect solution for aggregating information which is built on join of two tables with 1:N relationship. Side template is a solution for including up to additional two aggregations, with two other data tables which have similar 1:N relationship. While the aggregation template gives a solution to processing two joined tables, the side template adds the ability to process a third and fourth data tables, each connected to the main table of the aggregation. The side template is based on designated area within the aggregation template which relates to the records from the third and fourth tables. The definitions for creating the third and fourth data tables are implemented as a standard parameters files (INI) which are hooked into the main parameters file of the process.

6.15.1.2 Side Template Parameters

The name of the section for that is [Side Template].


ParametersFile Full path and name of a parameter file that defines the data table for the first side template.

MainIndex Column name from the main data table to be used as an index for joining with the first side data table.

SideIndex Column name from the first side data table to be used as an index for joining with the main data table.

Sort Column name by which to sort the side data table.

ParametersFile1 Full path and name of a parameter file that defines the data table for the secondary side template.

MainIndex1 Column name from the main data table to be used as an index for joining with the secondary side data table.

SideIndex1 Column name from the secondary side data table to be used as an index for joining with the main data table.

Sort1 Column name by which to sort the secondary side data table.

6.15.1.3 Side Template Tags

The side template tags are placed in an aggregation template, in the prefix or suffix areas of the aggregation. The side template area is processed in a similar way to an aggregation template. For each record in the side template data table that matches the current record of the main template, the entire area is replicated per side record and then columns tags from the side data table are replaced with their actual values.

<bab_SideTemplate>text</bab_SideTemplate>

Description Text = HTML text that includes columns from the side data table defined by the ParametersFile in the [Side Template] section.

<bab_SideTemplate1>text</bab_SideTemplate1>

Description Text = HTML text that includes columns from the side data table defined by the ParametersFile1 in the [Side Template] section.

<!$babSIDE_f_column>

Description The value of a column in the current row in the first side data table. column = the column name.

<!$babSIDE1_f_column>

Description The value of a column in the current row in the second side data table. column = the column name.


6.15.1.4 Side Template Usage – Example

This example shows how to create a single aggregated glossary that includes data from three different data sources.

Table 1

Comp_name IP

Jupiter 123.31.31.123

Earth 651.31.321.321

Venus 55.321.111.111

Table 2

Name Contact

Jupiter Tom

Jupiter Bob

Earth Tom

Venus Zoe

Venus Bob

Table 3

Computer Users

Jupiter David

Jupiter Dave

Jupiter Dov

Earth Man

Earth Woman

Venus Alien

Main INI

[<Connection Type>] … [Settings] SQLQuery = SELECT Table1.*,Table2.* FROM Table1 as d1 LEFT JOIN Table2 as d2 on d1.comp_name=d2.name order by d1.comp_name TemplateFile = template.htm … [Side Template] ParametersFile = side.ini MainIndex = comp_name SideIndex = computer sort = comp_name

Side INI

[connection type] … [Settings] SQLQuery = SELECT * FROM Table3 ORDER BY computer


Execution Sequence

1. The main parameters.ini file connects and runs the 'JOIN' SQL query. The result is the following data table:

Comp_name IP Name Contact

Jupiter 123.31.31.123 Jupiter Tom

Jupiter 123.31.31.123 Jupiter Bob

Earth 651.31.321.321 Earth Tom

Venus 55.321.111.111 Venus Zoe

Venus 55.321.111.111 Venus Bob

2. Break levels are set on the "comp_name" field from the main data table.

3. The side parameter file connects and runs the SQL query to extract information from Table 3.

4. The side data table is merged with the main data table only by the aggregated column ("comp_name").

The result is the following data table:

Template File

<term><!$bab_f_Comp_name></term><alt></alt> <!$babBREAKPREFIX> <def> <table> <tr><td colspan=2><b>><!$bab_f_Comp_name></td></tr> <tr><td><b>IP Address:</b></td><td><!$bab_f_IP></td></tr> </table> <table> <tr><td><b>Contacts</b></td></tr> <!$babENDBREAKPREFIX> <tr><td><!$bab_f_Contact></td></tr> <!$babBREAKSUFFIX> </table> <table> <tr><td><b>Users</b></td></tr> <bab_SideTemplate><tr><td><!$babSIDE_f_Users></td></tr></bab_SideTemplate> </table> </def> <!$babENDBREAKSUFFIX>

Comp_name IP Computer Users

Earth 651.31.321.321 Earth Man

Earth 651.31.321.321 Earth Woman

Jupiter 123.31.31.123 Jupiter David

Jupiter 123.31.31.123 Jupiter Dave

Jupiter 123.31.31.123 Jupiter Dov

Venus 55.321.111.111 Venus Alien


6.16 Hybrid (Real-time) Glossary


Hybrid glossary is a standard glossary with one exception – the definition part of the term is based on a real time access to a web application accessed via HTTP GET URL. The hybrid glossary is mainly used in the following scenarios:

1. The standard glossaries security model which is based on Active Directory controlled access to the entire glossary is not sufficient. With a hybrid glossary, a tighter permission control may be assigned on any part of the definition, or the appearance of the entire term, based on any corporate system and not just the Active Directory.

2. The volume of the data required for building a standard glossary does not allow to snapshot the entire data in a reasonable extraction process. With a hybrid solution, no definition is snapshot in advanced and is accessed in real time via the client.

6.16.1.2 Building Hybrid Glossary

To create a hybrid glossary, follow the steps below:

1. Using the Extractor Standard mode, create a new glossary header. In the Create New Glossary Header dialog box, enable the Hybrid option.

2. Fill in the following elements according to your deployment scenario:

• URL: A constant representing the URL of the web application or a fixed part of it.

• Start Tag: A markup tag in the glossary template that marks the start node of the dynamic part of the URL.

• End Tag: A markup tag in the glossary template that marks the end node of the dynamic part of the URL. The response of the web application will be inserted within the start and end tags, while deleting both tags.

• No-Response String: A string value that determines whether the specific term and its content will be included in the results. When the definition delivered from the web service includes this parameter value, the term will be suppressed and not displayed in the client. Note: the parameter value is case sensitive.

6.16.1.3 Mechanism

A hybrid glossary is a standard glossary with respect to the core functionality of the product. It is built with terms and alternate forms and is being search like a regular glossary. The main difference is that one or more records from the glossary returned to the client for display, are practically without a normal definition. When a hybrid definition reaches the client, it performs the following:

1. Pulls out from the glossary header the values of Start Tag and End Tag. Locate all the area occurrences inside the definition which starts with the start-string and ends with the end-string.

2. For each section, extract the string in between the tags and concatenate it right at the end of the value of URL.

3. Issue an asynchronous HTTP request (AJAX) with the value serves as the URL and awaits a response.

4. If the response includes the value No-Response String the client suppresses the appearance of this glossary in the client results set. If not, it replaces the original start-value and end-value and the string in between them with the correlated response received from the web application.


6.16.1.4 Example

A real-time glossary can serve to present the information from customer support calls in a help desk system. The web service receives an input of a specific ticket number, and returns an HTML view of the ticket details.

If the web application is unable to provide data due to an error, for example due to a lack of permission to view the specific ticket, the web application returns the string value: error4202.

The glossary header file includes the following lines:

### EXT-DIC-URL: http://eService.sample.com/Servlets/ShowTicket.jsp?ticketid= ### EXT-DIC-start-string: [a] ### EXT-DIC-end-string: [b] ### EXT-DIC-no-definition-string: error4202

The glossary template is:

<term><!$bab_f_ticket_id></term> <def>[a]<!$bab_f_ticket_id>[b]</def>

6.16.1.5 Special Considerations

The result from the web application does not go through the regular definition parser of the client. Therefor the following issues should be addressed when building a template for a hybrid glossary or when verifying the response content of the web application that should be displayed in the client:

1. To insert a bword link within the web application response or in the glossary template, in definition area but outside the web application sections, define the BWORD action in a link using Java Script. See following example:

<span style="text-decoration:underline; color:blue; cursor: hand" x="bword:// [NOBOOST,] uri,term" onClick=document.location=this.x>Text to click on</span>

Where the general syntax for the BWORD in such cases is: bword://[NOBOOST,]URI,Term

Where: * Term is the term to be queried. * URI is the URI of the glossary to be searched. * NOBOOST when appears signify that only the specified URI (glossary) will be searched; if omitted, all active glossaries will be searched.

2. All the special characters in the response of the web application which are element contents (&, <, >, “”, etc.) must be presented in escaping mode. For example, in order to use the HTML convention of blank, , it should be presented as  


6.17 Enhanced Alternate Forms


The alternate forms are Babylon-Enterprise way to create indexes on the glossary terms mainly for multi terms retrieval. In a standard scenario, a glossary template is built as a table. When multiple records are retrieved for display, the display tends to be long and requires from the user to use the slider for navigating in the definition. The time to load the display by the client could be delayed due to sizable HTML content. This challenge is becoming more obtrusive when large scale indexes are deployed inside the glossary and an average search with Babylon-Enterprise yields many glossary records. Example for that would be indexing document metadata records and we want to create a wild card type of index on the document name. To overcome this challenge, use a special glossary XSL template which is tied up with the glossary template which from the visual point of view, join all the glossary terms for display into a single table.

6.17.1.2 Solution

The solution is based on two components:

1. Glossary XSL Template

The glossary XSL template, which is defined in the glossary header file, is in charge of the XSL transformation used for this glossary to convert the XML sent by Babylon-Enterprise server to the HTML view of this specific glossary in the results set. A Basic version of the XSL to use in this case is included in appendix A. Please notice the following:

• The XSL should be a separate text file, UTF-8 encoded, referenced in the glossary header

• You need to edit all the parts marked in blue to match the specific content and the glossary template

• The XSL has a single loop for all the glossaries records that matches the search. The loop is inside xsl:value-of select="bab:Meaning". The loop allows you to define a maximal number of glossary records to send to the client and to set a proper notice in case the limit is reached.

• The span element is the table header is set to present the searched word. It is presented instead of the term since the result set is combined from all the glossary records which one of their indexes matched the search terms and the search word is the only data item that can describe the results as a group.

• The Java Script is used to allow the display of the search word when the user returned back in the client searches history

2. Glossary Template

The glossary template should include the proper alternate forms settings. In such cases the use of Minimal Substring Match Length in the glossary header is recommended for applying a wild card search effect. The definition area of the template should include only the table data line that matches the layout of the table defined in the XSL template. To set a BWORD link, use Java Script format as in the case of a hybrid glossary

6.17.1.3 Example

For example, let’s take a data table that contains a bug ID number and the bug description (subject). In order to apply the solution see discussed, see the example XSL template and the glossary template.

http://bes.babylon.com/ftp/Download/BabyTemplate8_Alternates.xsl

view-source:http://bes.babylon.com/ftp/download/bugs_search.htm


6.18 Creating Multiple Glossaries from a Data Source


An organizational information source commonly contains data that needs to be distributed to different users or groups in the organization, but due to security issues, different users or groups should see different rows from the data source.

Instead of creating separate parameter files and performing different extraction processes for each group of users, you can create a set of glossaries from the same data source in which each glossary is targeted for use by specific users or groups.

To perform the MultipleGlossaries process, you need to create a special RecordSet (table) that contains the extraction settings for each glossary. The table must contain a row for each glossary you want to create. The column names in this table must be the names of parameters in the parameter file. Each row contains the specific values of the parameters for each glossary.

Table for the MultipleGlossaries Process

In this example, the MultipleGlossaries RecordSet is based on a simple Excel worksheet:

The glossaries are created from a subset of the main RecordSet using a filter defined by the RecordSetFilter parameter. Glossaries ERP-ABT and ERP-ADU are updated on the server with restricted user access.

Parameters

To activate the MultipleGlossaries process, the MultipleGlossaries parameter must be defined in the [Settings] section in the main parameter file:


[Settings]

MultipleGlossaries Full path and name of a parameter file that defines the MultipleGlossaries data source and RecordSet.

All other parameters definitions in the main parameter file apply to all the glossaries created in this process.

The MultipleGlossaries RecordSet must include definitions for the following parameters:

GlossaryHeaderFile Full path and name of the glossary header file. Before initiating the MultipleGlossaries process, you must first create a glossary header for each planned glossary.

GlossaryTitle Used with GlossaryHeaderFile parameter. Required for appending the update date to the glossary title.

BGLDataFile Full path and name of the BGL file.


The MultipleGlossaries RecordSet can also contain the following parameters:

Defined in the [Settings] section: • UseMainRS • RecordSetFilter • RecordSetOrderBy • TemplateFile • SQLQuery • HandleMainRS • NoGloss • NoExitOnBESError

Defined in the [Babylon Services] section: • DistributeFullGlossaryOffline • Active • AllowAllOffline • AllowAllOnline • AllowNoneOffline • AllowNoneOnline • MandatoryOffline • MandatoryOnline • ForcedOptionalOffline • ForcedOptionalOnline • OfflinePermissions • OnlinePermissions


[Settings]

UseMainRS =Y: The Extractor will use the main RecordSet as the data source of the current glossary.

NoGloss =Y: The Extractor will manipulate the data only, but not produce a glossary.

NoExitOnBESError =Y: The Extractor will not terminate if an error occurs during the deployment of the glossary on the server.

Removing Outdated Glossaries

When creating glossaries based on RecordSet filters, the process sometimes produces no results.

For example, an enterprise database might contain records of technical support calls, and the multiple MultipleGlossaries RecordSet is created from all unique instances of the ID of the employee who opened the support call. If no calls are recorded for one of the employee IDs, no glossary will be created. However, the Babylon-Enterprise server might still maintain an older, outdated glossary.

To over overcome this problem, include the RemoveGlossariesByTitle parameter in the [Babylon Services] section of the main parameter file.


[Babylon Services]

RemoveGlossariesByTitle Defines a substring from the glossary title that is common to all the glossaries to be produced by the MultipleGlossaries process. When this parameter is defined, the Extractor will delete all glossaries with the common title substring that reside on the server but were not created during the process due to lack of data.


MultipleGlossaries Usage – Example

The main parameter file defines a RecordSet that contains catalog records from an enterprise database. The main parameter file does not create an actual glossary, and saves this RecordSet for later use.

The MultipleGlossaries RecordSet table shown above defines the creation of multiple glossaries by applying a RecordSet filter on the manufacture ID column ("mfg").

Main Parameter File

[MS Office] FileName=erp.mdb [Settings] SQLQuery=select * from master order by pn HandleMainRS=save MultipleGlossaries=permissions.ini NoGloss=y NoExitOnBESError=y [Babylon Services] RemoveGlossariesByTitle=Lab 8 –

Multiple Glossaries Parameter File

[MS Office] FileName=permissions.xls ObjectIndex=1


7 Text (Unstructured) Search

7.1 Introduction

This version introduces for the first time a new feature to enable indexing and searching in unstructured text. The feature is based on an integration of a Lucene.Net engine with the Glossary Extractor and an ASP.Net application, integrated via a Babylon-Enterprise glossary, for indexing and searching. The system supports the following sources for indexing and searching:

• Windows files system – the feature supports any file format which has a matching “iFilter” installed on the Babylon-Enterprise Server. The following formats are supported out of the box:

➢ Microsoft Office Files ➢ Acrobat (pdf) files ➢ Textual files ➢ HTML files ➢ Archives: zip and rar ➢ Tiff files

• Web site with the ability to automatically crawl the site through its reference map.

• Integration with SharePoint/FAST search engine and Documentum without the need to re-index the text corpus.

• Free text in databases instances which cannot be handled using Babylon-Enterprise glossaries.

The actual indexing is performed within a simple Extractor process and can run in full scan or incremental indexing (when applicable). The search is done via Babylon-Enterprise client using a special glossary, using the same user experience of a regular glossary, and connected to ASP.Net application which performs the actual search and returns the search results to the client.

7.2 Prerequisites

7.2.1 Glossary Extractor

Make sure the following files are located in the “bin” folder of the Glossary Extractor (download them in cased they are missing):

• Abot.dll

• AutoMapper.dll

• BE.IndexingService.dll

• CsQuery.dll

• HtmlAgilityPack.dll

• Lucene.Net.dll

For indexing files, you need to have a matching iFilter installation per each of the file formats you want to index. The following are the basic free ones:

• Microsoft Office files

• Adobe Acrobat PDF files. An alternative faster PDF iFilfer is a product of Foxit. For more details see http://www.foxitsoftware.com/products/ifilter/

http://lucenenet.apache.org/

http://en.wikipedia.org/wiki/IFilter

http://bes.babylon.com/ftp/babylon/x64/Abot.dll

http://bes.babylon.com/ftp/babylon/x64/AutoMapper.dll

http://bes.babylon.com/ftp/babylon/x64/BE.IndexingService.dll

http://bes.babylon.com/ftp/babylon/x64/CsQuery.dll

http://bes.babylon.com/ftp/babylon/x64/HtmlAgilityPack.dll

http://bes.babylon.com/ftp/babylon/x64/Lucene.Net.dll

http://bes.babylon.com/ftp/Download/iFilter/FilterPack64bit.exe

http://bes.babylon.com/ftp/Download/iFilter/PDFFilter64installer.msi

http://www.foxitsoftware.com/products/ifilter/


• Zip files

• Cab files

• Rar files

• OpenOffice files

• TIFF files – included in Windows server. For installation on Windows 2008 R2 see here.

7.2.2 ASP.Net on IIS

Open the “Server Manager” and verify that ASP.NET is installed as shown in the figure below.

7.3 Creating Index and Search Solution for Files or Web Site

7.3.1 Indexing

Indexing is performed using a standard Extractor process using a specific section in the parameters file. For each file, the Extractor attempts to extract its text content and to create an index for it. If the file is already indexed, the Extractor will update its current index based on its current content. The name of the section is [Nabu] and following are its parameters.


IndexLocation Folder path for storing the indexes files.

RootFolder The location (root folder) where the Extractor starts to scan files. The Extractor will index all files in all sub folders of the root folder. When value includes “http://” or “ftp://”, the Extractor will scan the URL from the starting page set here and through all page links in each of the scanned pages.

ExtractionThreads The number of system threads to use for indexing the files. Make sure you are not overloading the system with number of threads higher than the available CPU cores. For a four CPU cores server, use up to two threads. The default value is 1.

http://bes.babylon.com/ftp/Download/iFilter/Citeknet.ZIP.IFilter.x64.Setup-2.1.msi

http://bes.babylon.com/ftp/Download/iFilter/Citeknet.CAB.IFilter.Setup-1.5.3.msi

http://bes.babylon.com/ftp/Download/iFilter/Citeknet.RAR.IFilter.Setup-1.5.3.msi

http://bes.babylon.com/ftp/Download/iFilter/IFilterShop_OpenOfficeFilter_NCE_1_6.exe

http://technet.microsoft.com/en-us/library/dd834685.aspx



IndexWriterMergeFactor When new documents are added to the index, they are initially stored in memory instead of being immediately written to the disk. This is done for performance reasons. To improve indexing performance, adjust the value of the parameter. Its value tells the Extractor how many documents to store in memory before writing them to the disk, as well as how often to merge multiple segments together. The default value is 10.

RAMBufferSizeMB Determines the amount of RAM (in MB) that may be used for buffering added index documents and deletions before they are flushed to the index location. Use as large a RAM buffer as you can. Make sure not to overload the system with buffer larger the average free RAM. The default value is 16.

MaxTextSizeinMB Set a filter for indexing files with size of their extracted text lower than the value of the parameter (in MB).

HoursBackToScan Set a limit for indexing files based on their last update date. When value is set, only files which have been updated in the number of hours set in the parameter before the current time, will be indexed.

ExtensionstoInclude Set a limit for indexing files with specific file extensions only. Define the extensions as a comma delimited string. For example: doc,docx,pdf,xls,xlsx,ppt,pptx,txt,htm,html,xml

HTTPBase When the root folder is set to a network or local path, the file is identified with its actual full path which is also the way it will be presented to the end user while searching the index. In case the actual path based on the root folder is not accessible to end user, you can set a matching URL to the root folder for identifying the file using URL. For example, root folder is set to “\\server\share\documents” and HTTPBase to “http://server/documents”. Indexed file “\\server\share\documents\2015\manuals\Howto.docx” will be identified for retrieval as “http://server/documents/2015/manuals/Howto.docx”.

UseOleProperties

=Y: For Microsoft Office documents, the meta data “Author” will be added to the index information for use in the search application.

When creating the parameters file with a [Nabu] section, make sure to add a [Settings] section as well with NoGloss=y.

7.3.2 Searching

7.3.2.1 Installing the Search Application (ASP.Net)

Download the application from Babylon’s web site. Extract the archive to a new folder, preferably under the root of your IIS (Web Server). In IIS –

1. Create a new application pool with .net CLR Version set to version 4.

2. Convert the created folder to an application using the new application pool.

3. Recommended to configure the application authentication without Anonymous access and with Windows Authentication enabled.

http://bes.babylon.com/ftp/babylon/Nabu.zip


7.3.2.2 Configuring the Search Application (ASP.Net)

The application configuration file is “Nabu.Config.xml” located in the application folder. Edit the following nodes in the file while leaving all others in remark mode:

1. IndexFolder – location of the index files (output of the Extractor process)

2. LoggingFolder – location of a folder with write permission to the application pool user (IIS AppPool\<application pool name>) for creating the application daily log files.

3. SortBy – set “LuceneRanking” for sorting the search result according to a descending order of Lucene scoring algorithm (see here). Set “date” for sorting the search result according to a descending order of the document last update date.

4. CheckFilePermission – set “True” in order to include in the result set an indication if the searching user, assuming Windows Authentication is implemented, has a read permission to each file in the result set. This mode enables you to customize the displayed result to filter out documents which are not permitted to the user.

7.3.2.3 Customizing the Search Application (ASP.Net)

The application is based on “search.aspx” module with its supported binaries in the “bin” sub folder. The module is a standard ASP.Net application which can be customized according to your needs and functionality. However, please notice the following basic information items:

1. The module expect to receive one request parameter in GET method (parameter and value are part of the URL). Parameter name is “W” and its value is the search query. The request URL in general is: http://<server>:<port>/<application folder>/Search.aspx?W=<search query>

2. To run a fuzzy type search add another parameter named "fuzzy" with value “1” (http://<server>:<port>/<application folder>/Search.aspx?W=<search query>&fuzzy=1”). The fuzzy search expands the search beyond the exact search query and matches a general wildcard to bring usually more results matching a less exact appearance of the search query inside the document content.

3. For Debug purposes, add another parameter named “Debug” with value “1111”.

4. Each search request returns to the page a Data Table named “resDT” which contains the following columns:

a. path – full path of the indexed document. If the indexing process was using “HTTPBase” then the path would be based on it.

b. filename – the name of the document.

c. rank – Lucene scoring value for this document, in percentage, ranked with respect to the highest scored document in the Data Table. For more information see here.

d. timestamp – the value of the document last updated date in FileTimeUtc units.

e. size – size of the document in bytes.

f. author – name of the document author. For MS-Office documents only and assuming the indexing process was using “UseOleProperties”.

g. ReadPermission – Boolean indication (True or False) whether the searching user has read permission to the document.

h. sample – a short sample from the document content where the relevant part of the search query was found and is marked as bold text.

i. url – file path (for non HTTP based values) converted to the standards of Java Script (double the backslashes).

http://lucene.apache.org/core/3_6_0/scoring.html

http://lucene.apache.org/core/4_0_0/core/org/apache/lucene/search/package-summary.html#scoring


5. In case the returned Data Table is empty, the module returns a default string “No Documents Found”. This string has to be matched with the no return string of the glossary connected to the application (see next section).

7.3.2.4 Creating the Integrated Glossary

The search application is integrated into a special type of glossary acting as query agent. It is a glossary without terms and definitions. It can be installed on the Babylon-Enterprise server as offline glossary only. When it is installed and active on the Babylon-Enterprise Client, it is issuing HTTP request for each user search (click or type) with the clicked word and awaits the response. When the response arrives, if it contains a predefined no response string the client ignores the response. If not, it displays it as an answer from that glossary.

Follow the steps below to create the glossary and install it on the server:

1. Open the basic glossary header file “nabu.gls” located in the application folder.

2. Edit the value of “EXT-DIC-no-definition-string” to match the HTTP URL directing to the “search.aspx” module. The value of parameter “W” in the URL is mandatory and cannot be changed. You may add additional parameters.

3. Edit the value of “EXT-DIC-no-definition-string” only if you changed the matching no response string in “search.aspx”.

4. You may add/change the values of “Author”, “Author E-mail”, “Icon” (full path to an icon file (32x32 bit, 256 colors max.), “Glossary title“ and “URI” (valid URI value starting with 2 exclamation signs mandatory).

5. Save the updated file.

6. Open command prompt and move to folder “Builder” of the Babylon-Enterprise server program folder. Run the following command to compile the glossary and create a BGL file:

glossarycompiler.exe -source GLS <GLS File Name> -target BGLEngine <BGL File Name>

7. Open command prompt and move to folder “Admin” of the Babylon-Enterprise server program folder. Run the following command to install the glossary on the server in “Not Active” status:

badmin64.exe -installgloss <BGL File Name>

8. Open the server console, make the glossary active and set its Offline permissions only.


7.4 Creating Index and Search Solution for Microsoft SharePoint Search Service

7.4.1 Indexing

When SharePoint is in the picture, no indexing is required by Babylon-Enterprise server. The actual indexing and all search definitions are set and managed via SharePoint. The solution is based on SharePoint Web Services and specifically on the search service. In order to verify it, you need to open an internet browser and run the URL for the SharePoint search web service discovery module. The URL format is: http://<site>/_vti_bin/search.asmx where <site> will include the SharePoint host name or IP address, its HTTP port and direction to the site location. For example: http://MyCompanyPortal:8081/Sales/_vti_bin/search.asmx

A valid response look like the following:

7.4.2 Searching

7.4.2.1 Installing the Search Application (ASP.Net)

Download the application from Babylon’s web site. Extract the archive to a new folder, preferably under the root of your IIS (Web Server). In IIS –

1. Create a new application pool with .net CLR Version set to version 4.

2. Convert the created folder to an application using the new application pool.

3. Recommended to configure the application authentication without Anonymous access and with Windows Authentication enabled.

7.4.2.2 Configuring the Search Application (ASP.Net)

The application configuration file is “Nabu.Config.xml” located in the application folder. Edit the following nodes in the file while leaving all others in remark mode:

1. IndexFolder – location of the index files (output of the Extractor process)

2. LoggingFolder – location of a folder with write permission to the application pool user (IIS AppPool\<application pool name>) for creating the application daily log files.

3. SharePointSearchWSURL – set the URL for the SharePoint search web service discovery module.

http://bes.babylon.com/ftp/babylon/Nabu.zip


4. SharePointSearchProperties (optional) – set a string representing property restrictions and operators to be annexed to the query string. For more information see here.

5. SharePointResultProperties (optional) – set a comma delimited string representing additional data items to be included in the results set. Be default, the following properties are returned: Rank, Title, HitHighlightedSummary, Path.

7.4.2.3 Customizing the Search Application (ASP.Net)

The application is based on “search.aspx” (copy the example file “Search_in_SP.aspx” to “search.aspx”) module with its supported binaries in the “bin” sub folder. The module is a standard ASP.Net application which can be customized according to your needs and functionality. However, please notice the following basic information items:

1. The module expect to receive one request parameter in GET method (parameter and value are part of the URL). Parameter name is “W” and its value is the search query. The request URL in general is: http://<server>:<port>/<application folder>/Search.aspx?W=<search query>

2. For Debug purposes, add another parameter named “Debug” with value “1111”.

3. Each search request returns to the page a Data Table named “resDT” which contains the following columns:

a. path – full path of SharePoint item.

b. title – the title of SharePoint item.

c. rank – A calculated value for the quality of an item is the search result. For more information – see here.

d. HitHighlightedSummary – a short sample from the document content where the relevant part of the search query was found and is marked as bold text.

e. Any additional items set as SharePointResultProperties in the configuration file.

4. In case the returned Data Table is empty, the module returns a default string “No Documents Found”. This string has to be matched with the no return string of the glossary connected to the application (see next section).

7.4.2.4 Creating the Integrated Glossary

See section 7.3.2.4

https://msdn.microsoft.com/en-us/library/office/ee558911.aspx

ttps://technet.microsoft.com/en-us/library/dn169065.aspx


8 Babylon-Enterprise Client

Note to System Administrator: This chapter of the Administrator Guide is intended for users of the Babylon-Enterprise client. You may freely copy and distribute it for training and reference.

8.1 Babylon-Enterprise Client Application

8.1.1 Introduction to the Client

The Babylon-Enterprise client application is installed on every user workstation and provides an interface for the unified display of results from all information sources.

As soon as you click on any text in any Windows application using the defined mouse or keyboard action, Babylon-Enterprise instantly identifies the clicked term, opens a popup window and displays concise and relevant information about the selected term.

Babylon-Enterprise document translation feature allows you to upload any Microsoft Office document, and have the file automatically translated for you – in its original format.

In addition to enterprise information, Babylon Enterprise supports all Babylon translation dictionaries, premium content dictionaries, and free glossaries and encyclopedias.

Once installed, the Babylon-Enterprise icon is displayed in the notification area of the taskbar.

8.1.2 Activating Babylon-Enterprise

Whenever you click on a term using the defined mouse or keyboard action, the Babylon-Enterprise window opens and automatically displays relevant information for the selected term.

You can also open the Babylon-Enterprise window by doing any of the following:

• Click on any screen region without a word or term, such as the Windows desktop, using the defined mouse action. The default is <Ctrl>+<Right Mouse Button>.

• Click the Babylon-Enterprise icon on the taskbar or application title bar.

• Press the activation hotkey, if it has been defined. Typically the hotkey is <F10>.

To set the mouse or key action that will activate Babylon-Enterprise, go to the Settings menu and use the Shortcuts tab, click on and chose your mouse combination.


8.2 Babylon-Enterprise Window

8.2.1 Window Overview

The Babylon-Enterprise window has several functional areas:

• Toolbar: The Babylon window frame contains all the controls for

working with the Babylon-Enterprise window, terms and results. It also contains the query term box.

• Sidebar pane: Lists the sources currently returning results, and includes a link to the Manage Information Sources dialog box. This pane can be opened and closed.

• Results Sources: Displays the information results.

8.2.2 Toolbar

The Babylon-Enterprise toolbar buttons perform common Windows operations. It also contains a button to open the Babylon-Enterprise menu.

Menu: Opens the Babylon-Enterprise client menu.

Minimize: Minimizes the Babylon-Enterprise window.

Fit: Resizes the Babylon-Enterprise window according to the size

of its contents.

Exit: Closes the Babylon-Enterprise application.

Show/Hide sidebar: Toggles the display of the Result Sources

sidebar.


8.2.3 Term Box

The term box contains the queried term and related functions.

Term box: Field for displaying and entering the query term or value.

Search: Initiates a query on the term displayed in the term box.

Back: Returns to the previous page in the terms history. Forward: Displays the next page in the terms history.

History: Opens the list of terms previously queried.

Using the Term Box

Whenever you click on a term, the Babylon-Enterprise window opens with the selected term displayed in the term box.

You can also open the Babylon-Enterprise window, and then type your query in the Term box.

To get results, press Enter or the Search button on the toolbar.

Browsing Terms Previously Queried

Babylon-Enterprise stores the last 50 terms entered in the term box. You can view previous results by scrolling through the term box’s pull-down list. To open the list, click the blue History arrow on the right side of the term box.

Alternately, use the Back and Forward buttons on the left side of the term box to scroll through the history list.

To clear the list of terms searched, click Clear History.

8.2.4 Results Pane

The Results pane displays all the results of an information query.

Information Source Title Bar: The name of the information source that is delivering the displayed result. The green down arrow on the title bar opens the Results menu.

Say It: Pronounces the term using the currently configured TTS engine.

Browse: Scroll alphabetically through the entries in the information source


Find Spelling Alternatives: Jumps to the Did you mean? Section at the end of the results listings, where you can see a list of other terms that you may have intended to look up.

Progress indicator: If a particularly heavy set of results is being delivered, this progress indicator appears for several moments.

8.2.5 Sidebar Pane

The Sidebar pane displays a list of all information sources currently delivering results, and options for activating various functions.

8.2.6 Additional Interface Elements

Term: Default tab. Typically, Babylon-Enterprise delivers a translation or definition of a single term. Text: Use this tab to translate the paragraph of text in which the selected term is located.

Connected. A status indicator that shows you are connected to the Babylon-Enterprise server.

Document Translation: By clicking on the document translation icon, you can upload your document, and have the file automatically translated for you – in its original format.

8.3 Results

8.3.1 Results Menu

Text in the results pane can be selected using the mouse as in any Windows application. Simply click and drag the mouse to select text.

To perform actions on selected text, right click to open the Results menu.

The menu has the following options:

• Copy: Copies the selected text to the clipboard. The text can then be pasted into any other application. If no text is selected, this option is disabled. If any images are selected along with the text, the images are also copied.


• Say It: Pronounces the selected text using the configured TTS engine. If no text is selected, this option is disabled.

• Find: Displays information results for the selected text. If no text is selected, Babylon-Enterprise gets information for the term currently under the cursor

• Select all: Selects the complete text of a definition.

• Print: Prints the results currently delivered.

8.3.2 Information Source Menu

When you click on the title (name) of the information source in the Results pane, the Information Source menu opens.

Alternately, click the green arrow on the information source title bar to open the menu.

• About: Displays a description of the selected information source, such as

author, description and version.

• Install: Downloads and installs the information source for offline use. If the information source cannot be downloaded, typically due to security reasons, a message will appear.

• Disable: Disables the selected information source. A disabled information source will not return results until it is enabled again from the Manage Information Sources dialog box.

• Set as top result: Moves the selected information source to the top of the list in the Manage Information Sources dialog box.

8.3.3 Spelling Alternatives and More Results

If no results are delivered for a term, possibly due to a misspelling or a typographical error, you will receive the result “Did you mean?” with a list of potentially correct terms. These terms are extracted from all your active information sources that have been downloaded to your computer.

The Find Spellings Alternatives icon is displayed in the results pane. Clicking on the icon jumps to the end of the result listings, where you will see a list of a list of alternative terms.

If you have an Internet connection and are connected to Babylon public servers, you will also see the prompt: “Didn't get the results? Look up in Babylon website”.


8.4 Information Sources

8.4.1 Information Sources (Glossaries)

An information source (also known as a Babylon-Enterprise glossary) is a database table of terms and information relevant to your work processes and tasks. Information sources are generated from the systems used in your enterprise, such as CRM and ERP applications.

Babylon-Enterprise also supports the various types of Babylon glossaries, such as monolingual dictionaries, translation dictionaries and encyclopedias.

The upper section of the sidebar displays a list of the information sources currently delivering results. Clicking the name of an information source in the sidebar list scrolls the results pane to show the information being delivered from the selected source.

8.4.2 Managing Information Sources

The Manage Information Sources dialog box presents a list of all sources that have been installed on the client workstation. Whenever you query a term, Babylon-Enterprise retrieves information from all the active sources listed in the Manage Information Sources dialog box.

The Manage Information Sources dialog box allows you to add, remove and configure sources for use.

Active Sources

• When the Active checkbox of an information source is selected, the source is enabled and will be queried for results.

• When the Active checkbox of an information source is cleared, the source remains in the list of installed information sources, but will not be queried/return results.

Show Results from Active Sources Only

• When this checkbox is selected, only the Active sources will return results.

• When cleared, additional relevant results from the Babylon information server will also be delivered if the client is enabled for Internet connectivity and is connected to the Babylon public servers.


Status of Sources

• On Workstation. The information source has been downloaded to the client workstation, and will deliver results even when the client is not connected to the server.

• On Server. The information source has not been downloaded to the client workstation, and will deliver results only when the client is connected to the Babylon-Enterprise server.

Order of Results

Babylon-Enterprise performs queries and displays results according to the listed order of the sources in the Manage Information Sources dialog box.

Information sources that have been downloaded to the client workstation are always listed before those that are on the server.

Use the Move Up and Move Down buttons in the toolbar to change the order of the information sources in the list.

Information Source Details

You can click on the + button and shows a description of the information source currently highlighted in the list. Details include author information, number of entries, description, and last update.

Removing an Installed Information Source

The Remove button deletes information sources from the list.

You can also delete an information source by selecting its title and pressing Delete.

8.4.3 Installing Information Sources

The Add Information Sources button lets you install glossaries. It opens a window that presents a list of the information sources on the Babylon-Enterprise Server that are available to you, based on your security profile. To access an information source not listed, contact your system administrator.


• Workstation. The information source will be installed as a

downloaded source on the client workstation. Results from this source will be available even when the client is not connected to the server.

• Server. The information source will be installed as an online source, and will not be downloaded to the client workstation. Results from this source will be available only when the client is connected to the server.

Once installed, information sources are automatically updated by the Babylon-Enterprise Server.

8.5 Translation Utility

8.5.1 Term Translation

Term is the default tab. Typically, Babylon-Enterprise delivers a translation or definition of a single term.

8.5.2 Full Text Translation

Full Text: Use this tab for translation of complete texts. The translation utility will translate:

• The paragraph in which the Babylon-click occurred. • Text copied and pasted into the source text field. • You can translate 5000 characters of text can be translated at a time.

This option requires the Babylon-Enterprise client to have Internet access. If needed, contact your system administrator to enable.

Whenever you Babylon-click a word, its surrounding text is also captured, and automatically loaded into the Text Translation utility. Click the Text tab to begin the translation process. You can also open the Text tab at any time, and paste or type text into the source text field.


You can modify or correct the source text before it is translated. Babylon-Enterprise automatically detects the language of the original text, which you can change. Select the target (translation) language. Babylon-Enterprise maintains and uses the language pair until you change them again.

Click the Translate button to translate the source text.

The translation appears in the lower text field.

8.5.3 Document Translation:

Babylon Enterprise document translation feature allows you to upload Word, Excel and PowerPoint documents up to 5MB and have the file automatically translated for you – in its original format. You can choose between uploading your document to your desktop translator

by clicking on the document translation icon , or you can open this feature from Babylon menu.

8.5.4 Web Page Translation

Babylon-Enterprise can perform translations of web pages.

To activate the utility, go to the Babylon-Enterprise menu, and select Web Page Translation.

Enter the URL of the page you want to translate. Select the source and target languages, and click Translate.

This option requires the Babylon-Enterprise client to have Internet access. If needed, contact your system administrator.


8.6 Language Utilities

8.6.1 Cross-Translation

Cross-translation is a special type of result, optimized for users who need help writing in a language other than their own. Cross-translation is available only when both Babylon dictionaries of a language pair are installed. For example English-to-German and German-to-English:

Whenever you enter a translation query, Babylon-Enterprise normally delivers a definition in the defined target language, as indicated by the language pair in the information source title bar.

In the cross-translation result, indicated by a language triplet in the information source title, Babylon-Enterprise displays translations in the target language as well as reverse translations in the source language.

8.6.2 Conjugations

Babylon-Enterprise can display a list of all possible conjugations and inflections (e.g. Future, present progressive form, plural, etc.).

Whenever a term has conjugations/inflections, a down arrow is displayed next to the part of speech notation. Clicking the button opens the conjugations/inflections list.

The Conjugations button may appear when the mouse hovers over a term in a cross-translation display. Clicking the button opens the conjugations list for the selected term.

Click on any of the conjugations/inflections in the list to perform a copy/paste function.


• Copy: Copies the term to the Windows clipboard.

• Paste to [application name]: Pastes the term directly into the application you are currently using, at the text cursor position. Babylon-Enterprise uses the standard Windows paste mechanism, so that copied text is formatted according

• To the target application

8.7 Conversion Utility

Babylon-Enterprise includes a conversion utility that performs several types of conversions.

• Currency: Converts currencies according to monetary exchange rates that are updated daily. Currencies can be found by their abbreviation (USD = US Dollar), country names (United States = Dollar), or name (Dollar, US).

• Time: Determines the equivalent time at different global locations according to time zones (GMT, PST), or localities (United Kingdom, Los Angeles).

• Measurements: Calculates equivalents for common units such as angles, area, data storage, density, energy, force, kitchen measures, length, power, pressure, temperature, time, torque, velocity, volume and weight.

• To activate the Conversions utility, select Convert from the Babylon-Enterprise menu.

The Calculator button in the Conversions title bar opens the Windows Calculator.


8.8 Customizing the User Interface

8.8.1 Shortcuts Settings

• Mouse Activation: Allows you to select the mouse or keyboard action

that will activate Babylon-Enterprise on your workstation.

• Keyboard Activation: Allows you to select the keyboard shortcut that will activate Babylon-Enterprise on your workstation.

• Run Babylon-Enterprise when Windows starts: Default setting. Clearing this option prevents Babylon-Enterprise from starting automatically whenever the computer is turned on or restarted.

• Advanced OCR Optimization setting. To recognize terms on the screen, Babylon-Enterprise runs an optimization mechanism for “learning” your computer’s system. If the optimization target level is set to Low, Babylon-Enterprise will not perform the optimization, and may not recognize a selected term. If the level is set to High, Babylon-Enterprise will perform all possible optimizations, but will take longer and use CPU resources while “learning” the system once after client setup.

8.8.2 Display Settings


User Interface Language

This option allows you to select the language in which Babylon-Enterprise displays messages and dialog boxes. The default language is the one selected and used during the installation process.

Results Display

• Font Name and Font Size: These options allow you to select the font style and size of the text displayed in the Results pane. The default font style is set according to your system configuration. The default font size is Medium; you can choose one of 7 preset font sizes.

Some interface elements, such as the menus and sidebar, are a fixed size and cannot be configured.

• The number of online dictionaries per request: When results are not restricted to Active Sources only, this setting limits the number of online information sources that will deliver results. Default is 5. Can be set from 2 to 10.

• Display pronunciation of terms (where applicable). When selected, the phonetic transcription of the queried term will be displayed in the results.

Window Settings

These options allow you to modify settings that define how the Babylon-Enterprise window is displayed.

• Let Babylon-Enterprise decide on window position: When selected, the Babylon-Enterprise window automatically opens in the best position on screen for displaying results.

• Let Babylon-Enterprise decide on window size: When selected, the Babylon-Enterprise window automatically opens in the best size for displaying results.

• Show the Babylon-Enterprise window on top of other application: When selected, the Babylon-Enterprise window remains visible, even when another program window is active.

• When the mouse is moved away, hide window by: When selected, the Babylon-Enterprise window will automatically minimize or close when you moves the mouse off the Babylon-Enterprise window.

8.8.3 Connection Settings

Connection

Use this menu to define proxy settings and update schedules.

Proxy Settings

These options are applicable only when using a proxy server or a firewall to connect to the Internet.

• Run Babylon-Enterprise when Windows starts: Default setting. Clearing this option prevents Babylon-Enterprise from starting automatically whenever the computer is turned on or restarted.

• Connect through Proxy/Firewall server: Allows you to configure the server address and port to be used for communicating with Babylon-Enterprise online. Babylon-Enterprise uses the standard HTTP port (80) to connect to Babylon-Enterprise servers, and there is no need to enable other ports on your server.


• Remember password for authentication proxy: This option must be selected if your proxy servers require a username and password when connecting.


8.8.4 Licenses

• Enter License: Allows you to enter the registration information and license code, making the information source active. This option is available only if it has been enabled by your system administrator.

View Licenses

• View Licenses you can see which license you enter inside Babylon:

• Product Type: if it’s a license for Babylon or a dictionary.

• Status: active licenses are usable. Other statuses might signify an error situation


8.9 Babylon-Enterprise Client Menu

The Babylon-Enterprise menu provides access to customization options as well as frequently used functions. The menu can be opened by clicking the Babylon-Enterprise icon on the taskbar or the Menu button on the title bar.

• Settings: Opens the Configuration dialog box.

• Information Sources: Opens the Manage Information Sources dialog box.

• Document Translation: Upload any Microsoft Office document, and have the file automatically translated for you – in its original format.

• Text Translation: Opens the Full Text dialog box.

• Web Page Translation: Opens the Web Page translation dialog box.

• Convert: Opens the Conversions utility.

• Enter License: Opens the Babylon-Enterprise Configuration menu > License tab. The Enter License option appears in the tab only if it has been enabled by your system administrator.

Help: User Manual: A concise guide to Babylon-Enterprise

• User Manual: A concise guide to Babylon-Enterprise

• Babylon-Enterprise Help: Launch the full Babylon-Enterprise guide

• Disable/Enable: Disables/enables the Babylon-Enterprise mouse click button and the keyboard activation shortcut. When disabled, the Babylon-Enterprise icon in the system tray is dimmed.

• Exit: Closes the Babylon-Enterprise application, and removes the Babylon-Enterprise icon from the system tray. Babylon-Enterprise can be restarted from the Windows Programs menu.


9 Backup and Restore

Babylon-Enterprise backup and restore procedures are performed separately for the server and for the development environment.

9.1 Babylon-Enterprise Server

9.1.1 Backup Server

Backup the Babylon-Enterprise Server at least once a day.

Backup the following folders, subfolders and files:

• \Babylon-Enterprise Server\Server\Gloss\

• \Babylon-Enterprise Server\Server\Upload\

• \Babylon-Enterprise Server\Service\ServerData.dat

These are the default Babylon-Enterprise paths. Refer to the system paths in the registry: <HKEY_LOCAL_MACHINE\SOFTWARE\Babylon Server\Babylon Enterprise Server>.

9.1.2 Restore Server

To restore the server, perform a normal installation on an empty server machine according to the installation instructions. Refer to Chapter 2, Installation.

After you have completed the installation, do the following:

6. Stop the Babylon-Enterprise Server process. Use the command: net stop bessrv.

7. Copy the backup files back to their relative locations. If prompted, click Replace All.

8. Start the Babylon-Enterprise Server process. Use the command: net start bessrv.

9.2 Development Environment

9.2.1 Backup Development Environment

The Babylon-Enterprise development environment comprises the scheduled processes that retrieve database information and create glossary files for distribution and access.

Backup the development environment at least once a day.

Backup the following files from the development environment at least once a day:

• Header files (.gls, .xml)

• Template files (.htm)

• Parameter files (.ini)

• Batch files, scripts, command files (.cmd, .bat, .vbs)

• System scheduled tasks (.job)

9.2.2 Restore Development Environment

To restore the development environment, copy the backup files to same location from which they were backed up.

If the environment has changed, edit the parameter and command files to modify the paths according to the new environment.


Appendixes


Appendix A: Enhanced Alternate Forms-XSL Template

<?xml version="1.0" ?>

<xsl:stylesheet xmlns:xsl='http://www.w3.org/1999/XSL/Transform' xmlns:msxsl='urn:schemas-microsoft-com:xslt'

xmlns:bab='urn:schemas-babylon-com:bab' xmlns:babex='urn:schemas-babylon-com:babex' version='1.0'>

<xsl:output method="html" indent="yes" />

<xsl:template match="/bab:Glossary">

<xsl:variable name='copyright' select="babex:GetCopyright()" />

<HTML>

<BODY>

<table>

<tr><td colspan="2"><b><xsl:value-of select="bab:Terms/bab:Term/@bab:TransText"/></b> </td></tr>

Table columns layout <xsl:for-each select="bab:Terms/bab:Term/bab:Definition">

<xsl:if test="position()<Maximal_number_of_records_to_display">

<xsl:value-of select="bab:Meaning" disable-output-escaping="yes" />

</xsl:if>

<xsl:if test="position()=Maximal_number_of_records_to_display">

Table footer in case the maximal number of records is reached </xsl:if>

</xsl:for-each>

Table footer </table>

</BODY>

</HTML>

<xsl:if test='$copyright'>

<div class='BAB_CPCopyrightStyle'>

<br />

<xsl:value-of select="$copyright" disable-output-escaping="yes" />

</div>

</xsl:if>

</xsl:template>

<xsl:template match="bab:Headers" />

<xsl:template name="add-browse-buttons">

<xsl:if test="babex:IsBrowsingEnabled()=1">

<div dir="ltr">

<xsl:attribute name="style">

float:

<xsl:choose>

<xsl:when test="string(@bab:Align)='right'">

left

</xsl:when>

<xsl:otherwise>

right

</xsl:otherwise>

</xsl:choose>

</xsl:attribute>

<img class='BAB_ImageBtn' bab_name='BTN_BrowsePrevious' hspace='2' baburi='' behaveType='3ImageState' tabIndex='0'/>

<img class='BAB_ImageBtn' bab_name='BTN_BrowseNext' hspace='2' baburi='' behaveType='3ImageState' tabIndex='0'/>

</div>

</xsl:if>

</xsl:template>

</xsl:stylesheet>

Babylon-Enterprise Administrator...

Documents

Transcript of Babylon-Enterprise Administrator...