Globalyzer Installation and Configuration

From Lingoport Wiki
Jump to: navigation, search

Globalyzer consists of a Globalyzer Server and Globalyzer Clients.

Globalyzer Server

The Globalyzer Server manages user accounts and rule sets. Lingoport provides a (hosted) Globalyzer Server at www.globalyzer.com. Alternatively, companies can purchase and install their own on premises Globalyzer Server to run on their site. To access a server, you must already have an account; simply browse to the server URL (either our hosted server or your enterprise server) and log in with your account credentials.

Globalyzer Client

The Globalyzer Client manages projects and scans, accessing the rule sets on the Globalyzer Server to execute the scans, resulting in internationalization issues. The Globalyzer Client comes in several flavors and is downloaded by each individual user. To download a Client, login to the Server, scroll to the bottom of your home page, and click on the download the Globalyzer Client here link. This displays the Client Download page with several Globalyzer Client options, detailed below.

Globalyzer Client: The Workbench

The Globalyzer Workbench is a standalone development environment designed for i18n work. This can include refactoring code for the purpose of fixing i18n issues, externalizing embedded strings, and refining rule sets for detecting i18n issues. It is well suited for i18n experts. The Globalyzer Workbench is a full Eclipse-based i18n IDE which may not be appropriate for non-i18n specialists.

To download, select the appropriate jar file for your OS platform from the Client Download page. Then run the jar to install the Workbench.

Globalyzer Client: Lite

Globalyzer Lite forgoes the interactivity of Globalyzer Workbench. Instead, it focuses on being lightweight, fast, parallelizable, and friendly towards typical developers. All configuration necessary for running multiple project scans with Globalyzer Lite is contained within Project Definition files, which can be distributed to an entire team. Globalyzer Lite can be run from IDEs with the click of a button and has been tested with Visual Studio, Eclipse, and Intellij IDEA.

To download, select the globalyzer-lite.zip file from the Client Download page, unzip, and follow instructions in the README. Click here for more information on Globalyzer Lite.

Globalyzer Client: Command Line Interface

The Command Line Interface (CLI) allows you to run much of the Globalyzer Workbench from a command line, such as listing project and scan information, scanning, exporting and importing. In addition, it supports calculating and reporting on the differences in scans. It is useful for running nightly scans.

Note: Not all Globalyzer functionality is available from the command line; you will still need either the Workbench or Lite to create projects and scans. Also, the Workbench is the only client that supports code fixing, such as string externalization.

To download CLI, download and install the Workbench, which installs the globalyzer-cli.jar file. Click here for more information on CLI.

Globalyzer Client: Maven Plugin

When using a MVN project, you can add code scanning with Globalyzer using our MVN plugin. It is well suited for use within automation routines and Continuous Integration (CI) systems as well as within a typical developer environment, for instance within Integrated Development Environments (IDEs).

The Globalyzer MVN plugin generates scan reports to a directory specified in the pom.xml file. Scan reports are available in a variety of formats. We ask our MVN customers to install the MVN plugin in a private MVN repository for their company.

To download the Globalyzer Maven Plugin, select the globalyzer-maven-plugin.jar file from the Client Download page. Click here for more information on the MVN plugin.

Globalyzer Client: API

The Globalyzer API allows you to create Globalyzer projects and scans, execute scans, and generate reports from a Java program. Globalyzer Lite makes use of the API, and most users prefer using Lite instead of writing their own Java program.

Note: Not all Globalyzer functionality is available from the Globalyzer API; you will still need the Globalyzer Workbench to create customized projects and scans (the API relies on defaults, though the rule sets can be customized), and the Workbench is required for string externalization.

If you want to use the API with an in-memory database, download and install Lite. If you want to use the API with a physical database, download and install the Workbench. Click here for instructions on writing your Java program.