Difference between revisions of "Globalyzer API for Continuous Globalization"
(→Typical Workflow) |
(→Installation Components) |
||
| (12 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
= Introduction = |
= Introduction = |
||
| − | Globalyzer API allows |
+ | [[Terms_and_Definitions|Globalyzer API]] allows organizations to write their own logic in Java around [[Terms_and_Definitions|scanning]] code for [[Terms_and_Definitions|i18n]] issues detection; The wrapping program can then be deployed on a [[Terms_and_Definitions|Continuous Globalization]] system. It allows i18n scanning of source code with all the flexibility and power of Java. For instance, the Java wrapper logic can decide what is to be scanned, with what rule set, and how to consume the results. |
| + | |||
| + | This approach is more powerful than using either [[Terms_and_Definitions|Globalyzer Command Line Interface]] or [[Terms_and_Definitions|Globalyzer Lite]]. It does require writing Java code. |
||
| − | This approach is more powerful than using either Globalyzer Command Line Interface or Globalyzer Lite. It does require writing Java code. |
||
= Target User= |
= Target User= |
||
The wrapper application writer will decide who is the target user. |
The wrapper application writer will decide who is the target user. |
||
| − | The typical Globalyzer |
+ | The typical [[Terms_and_Definitions|Globalyzer API]] <code>actor</code> is a [[Terms_and_Definitions|Continuous Integration]] system which automates the tasks of [[Terms_and_Definitions|scanning]] source code. |
= Typical Deployment = |
= Typical Deployment = |
||
| − | The wrapper code on top of Globalyzer API will be deployed as per the Java application. |
+ | The wrapper code on top of [[Terms_and_Definitions|Globalyzer API]] will be deployed as per the Java application. |
[[File:API for CI.gif]] |
[[File:API for CI.gif]] |
||
| − | <b>Note</b>: If you add LRM to this picture, the Continuous Globalization system needs to be a Linux machine, preferably |
+ | <b>Note</b>: If you add [[Terms_and_Definitions|LRM]] to this picture, the [[Terms_and_Definitions|Continuous Globalization]] system needs to be a Linux machine, preferably CentOS. |
= Typical Workflow= |
= Typical Workflow= |
||
| − | The workflow will be determined by the Continuous Integration system and the written application on top of Globalyzer API. |
+ | The workflow will be determined by the [[Terms_and_Definitions|Continuous Integration]] system and the written application on top of [[Terms_and_Definitions|Globalyzer API]]. |
| + | |||
| + | This requires that the [[Terms_and_Definitions|rule sets]] used to [[Terms_and_Definitions|scan]] the code have been vetted. |
||
| + | = Installation Components = |
||
| − | This requires that the rule sets used to scan the code have been vetted. |
||
| + | * The '''Globalyzer Server''' (Server system) is hosted by Lingoport. If the Globalyzer Server is on site, a Linux machine is needed to be installed with Globalyzer Server software. |
||
| + | * The '''Continuous Globalization system''' uses the [[Terms_and_Definitions#GlobalyzerAIP|Globalzyer API]] client to analyze code. |
||
| + | * There is no '''Dashboard System''' in this scenario, although it could easily be included in this scenario. |
||
| + | * The '''Developer Machine''' is not shown in this diagram. The developer will push source code to the repositories and may not have any Lingoport Software on their machine. |
||
= Installation Notes = |
= Installation Notes = |
||
| − | To install the API, login to the Globalyzer |
+ | To install the API, login to the [[Terms_and_Definitions|Globalyzer Server]], download the [[Terms_and_Definitions|Globalyzer Client]] installer for the platform you are running on, and run the installer. |
| − | You will then write a Java program calling the API calls as described on the Globalyzer help pages under help/referenceAPI/toc.html . |
+ | You will then write a Java program calling the API calls as described on the Globalyzer API help pages under [https://www.globalyzer.com/gzserver/help/referenceAPI/toc.html Globalyzer API Reference] (login required). |
Latest revision as of 19:00, 30 December 2016
Contents
Introduction
Globalyzer API allows organizations to write their own logic in Java around scanning code for i18n issues detection; The wrapping program can then be deployed on a Continuous Globalization system. It allows i18n scanning of source code with all the flexibility and power of Java. For instance, the Java wrapper logic can decide what is to be scanned, with what rule set, and how to consume the results.
This approach is more powerful than using either Globalyzer Command Line Interface or Globalyzer Lite. It does require writing Java code.
Target User
The wrapper application writer will decide who is the target user.
The typical Globalyzer API actor is a Continuous Integration system which automates the tasks of scanning source code.
Typical Deployment
The wrapper code on top of Globalyzer API will be deployed as per the Java application.
Note: If you add LRM to this picture, the Continuous Globalization system needs to be a Linux machine, preferably CentOS.
Typical Workflow
The workflow will be determined by the Continuous Integration system and the written application on top of Globalyzer API.
This requires that the rule sets used to scan the code have been vetted.
Installation Components
- The Globalyzer Server (Server system) is hosted by Lingoport. If the Globalyzer Server is on site, a Linux machine is needed to be installed with Globalyzer Server software.
- The Continuous Globalization system uses the Globalzyer API client to analyze code.
- There is no Dashboard System in this scenario, although it could easily be included in this scenario.
- The Developer Machine is not shown in this diagram. The developer will push source code to the repositories and may not have any Lingoport Software on their machine.
Installation Notes
To install the API, login to the Globalyzer Server, download the Globalyzer Client installer for the platform you are running on, and run the installer. You will then write a Java program calling the API calls as described on the Globalyzer API help pages under Globalyzer API Reference (login required).
