Difference between revisions of "Globalyzer Installation and Configuration"
(→Globalyzer Client: The Workbench) |
|||
| (35 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | Globalyzer consists of a Globalyzer |
+ | Globalyzer consists of a <b>Globalyzer Server</b> and <b>Globalyzer Clients</b>. |
| + | == Globalyzer Server == |
||
| − | The Server manages user accounts and rule sets created within those accounts. |
||
| + | The Globalyzer Server manages user accounts and rule sets. Lingoport provides a (hosted) Globalyzer Server at <b>www.globalyzer.com</b>. 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 on premises server) and log in with your account credentials. |
||
| − | The Client creates projects and scans, accessing the rule sets on the server to run the scans looking for internationalization issues. |
||
| + | == On Premises Globalyzer Server: LDAP Configuration == |
||
| − | Lingoport provides a Globalyzer Server at www.globalyzer.com (hosted); alternatively, companies can purchase and install their own server (enterprise) to run on their site. To access a server, you must already have an account created; simply browse to the server URL (either our hosted server or your enterprise server) and log in with your account credentials. |
||
| + | An on premises Globalyzer Server can be configured to use your company's LDAP system. When users log in to Globalyzer, they will enter their LDAP username and LDAP password. If they are authenticated (exist in the LDAP system) and are authorized to use Globalyzer (belong to a Globalyzer group as configured in LDAP), then a Globalyzer account is created with information gathered from LDAP. Click [[Globalyzer_Server_LDAP_Installation|<b>here</b>]] for detailed information. |
||
| + | == On Premises Globalyzer Server: SSO Configuration == |
||
| − | The Globalyzer Client comes in several flavors. |
||
| + | An on premises Globalyzer Server can be configured to use SAML SSO with your company's chosen Identity Provider. When users log in to the Globalyzer Server, they will click the SSO button which will authenticate the user |
||
| + | for the Globalyzer application. On initial login, a Globalyzer account will be created. Click [[Globalyzer_Server_SSO_Installation|<b>here</b>]] for detailed information. |
||
| + | == Globalyzer Client == |
||
| − | * The Workbench |
||
| + | 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 <b>download the Globalyzer Client here</b> link. This displays the Client Download page with several Globalyzer Client options, detailed below. |
||
| − | * CLI |
||
| − | * Lite |
||
| − | * Maven Plugin |
||
| − | * API |
||
| + | == 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. <b>Note: The Workbench requires the Java JDK (not just JRE) to be installed.</b> See [[Lingoport_Suite_Installation#Supported_Versions|Versions]] for the appropriate version. |
||
| − | == Lite vs the Globalyzer API == |
||
| + | == Globalyzer Client: Lite == |
||
| − | Globalyzer Lite utilizes the Globalyzer API. Using the API directly is more powerful, but also requires writing a custom java application. |
||
| + | 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. |
||
| − | == Lite vs the Globalyzer Workbench == |
||
| + | To download, select the globalyzer-lite.zip file from the Client Download page, unzip, and follow instructions in the README. |
||
| − | In comparison to the Globalyzer Workbench, Globalyzer Lite is smaller, faster to install and does not require a database. Lite supports direct integration with IDEs, while the Workbench is its own standalone program. Additionally, unlike the workbench, multiple instances of Lite may be run concurrently. This allows Continuous Integration systems to use Lite to provision the scanning of multiple projects. |
||
| + | Click [https://www.globalyzer.com/gzserver/help/referenceLite/globalyzer-lite-overview.html 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 [https://www.globalyzer.com/gzserver/help/referenceCommandLine/cmd-line-client.html here] for more information on CLI. |
||
| + | |||
| + | == 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 [https://www.globalyzer.com/gzserver/help/referenceAPI/globalyzer-api-overview.html here] for instructions on writing your Java program. |
||
Latest revision as of 18:47, 25 August 2022
Globalyzer consists of a Globalyzer Server and Globalyzer Clients.
Contents
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 on premises server) and log in with your account credentials.
On Premises Globalyzer Server: LDAP Configuration
An on premises Globalyzer Server can be configured to use your company's LDAP system. When users log in to Globalyzer, they will enter their LDAP username and LDAP password. If they are authenticated (exist in the LDAP system) and are authorized to use Globalyzer (belong to a Globalyzer group as configured in LDAP), then a Globalyzer account is created with information gathered from LDAP. Click here for detailed information.
On Premises Globalyzer Server: SSO Configuration
An on premises Globalyzer Server can be configured to use SAML SSO with your company's chosen Identity Provider. When users log in to the Globalyzer Server, they will click the SSO button which will authenticate the user for the Globalyzer application. On initial login, a Globalyzer account will be created. Click here for detailed information.
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. Note: The Workbench requires the Java JDK (not just JRE) to be installed. See Versions for the appropriate version.
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: 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.
