Lingoport Wiki - User contributions [en]

MVN Plugin

2016-09-27T18:28:03Z

Mheilner:

Globalyzer has a number of clients: The Workbench, the command line interface, Lite, the Ant client, and the MVN 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 an Integrated Development Environments (IDEs).

The Globalyzer MVN plugin generates scan reports to a directory specified 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 that company.

The steps to use the Globalyzer MVN plugin are the same as any MVN plugin:
* Install the plugin
* Configure the pom.xml
* Run MVN

== Install the Globalyzer MVN Plugin ==

For those customers who require the MVN plugin, we make the globalyzer-maven-plugin-x.y.z-jar-with-dependencies.jar file available for downloadm where x.y.z is the version for the plugin, for instance 5.2.1. We ask that this jar file be installed in a private MVN repository at the customer's side.
You first need to get the file from a secure FTP location, which will be sent to customers who request it. Lingoport customers can request the MVN plugin by sending an email to <code>support at lingoport dot com</code>

For example, a developer who wants to install the plugin in their local .m2 repository can use the following installation command, provided for a version <code>5.2.1</code> of the MVN plugin. The same applies to other versions.t

C:\Users\Yourname>'''mvn install:install-file''' -Dfile="C:\Path\to\the\plugin\jarfile\'''globalyzer-maven-plugin-5.2.1-jar-with-dependencies.jar'''" -DgroupId='''com.lingoport.globalyzer.client.maven''' -DartifactId='''globalyzer-maven-plugin''' -Dversion='''5.2.1''' -Dpackaging='''maven-plugin'''
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- maven-install-plugin:2.4:install-file (default-cli) @ standalone-pom ---
[INFO] Installing C:\Linternal\Installers\install\globalyzer-maven-plugin-5.2.1.jar to C:\Users\Yourname\.m2\repository\com\lingoport\globalyzer\client\maven\globalyzer-maven-plugin\5.2.1\globalyzer-maven-plugin-5.2.1.jar
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 0.615 s
[INFO] Finished at: 2016-09-09T15:49:59-06:00
[INFO] Final Memory: 7M/123M
[INFO] ------------------------------------------------------------------------

== Configure the Globalyzer MVN Plugin ==
The <code><build><plugins></code> section of your module's pom.xml file must be configured. Here is how:

<plugin>
<groupId>com.lingoport.globalyzer.client.maven</groupId>
<artifactId>globalyzer-maven-plugin</artifactId>
<version>5.2.1</version>
<configuration>
'''-required - '''
'''- session level settings - '''
<username>joe@company.com</username>
<password>joespw</password>
'''- scan level settings - '''
<ruleSetName>Java Rule Set</ruleSetName>
'''-optional -'''
'''- session level settings -'''
<serverUrl></serverUrl> (default: https://www.globalyzer.com/gzserver)
<dataDictionaryDir></dataDictionaryDir> ( default: userhome/.globalyzer )
<scanTimeout></scanTimeout> ( default: 120 seconds )
<filterWithDictionary></filterWithDictionary> ( default: true )
<setLog4jProperties></setLog4jProperties> ( default: true )
<log4jPropertiesFileDir></log4jPropertiesFileDir> ( default: Globalyzer provided )
'''- scan level settings -'''
<projectName></projectName> ( default: project artifact )
<projectDir></projectDir> ( default: project src/main/java )
<ruleSetOwner></ruleSetOwner> ( default: username )
<scanName></scanName> ( default: auto-generate )






<reportType></reportType> ( default: ScanDetailedXML )
<reportPath></reportPath> ( default: target/i18n )
</configuration>
</plugin>

Notes:
* The session level settings are set once per MVN invocation. Whichever scan / project goal is executed first, its configuration will be set for all the subsequent scans
* The <code>log4jPropertiesFileDir</code> is precisely that: which log4j configuration file to use is the <code>setLog4jProperties/code> is set to true. For for example, if that setting points to <code>/path/to/log4j.properties</code> and in that configuration, the appender points to <code>/path/to/globalyzer/log</code>, that's where the logs will be written out.
* Best would be to have the exact same configuration for all Globalyzer goals to make sure one configuration is not taking over the other ones.

== Running Globalyzer MVN Plugin From The Command Prompt / Shell ==

Globalyzer MVN Plugin can be executed from a command prompt or shell via the following command:

<code>mvn com.lingoport.globalyzer.client.maven:globalyzer-maven-plugin:5.2.1:scan</code>

After MVN finishes each scan, a Globalyzer report per scan is created at the location specified in the pom.xml report path. The default location for the reports are target/i18n for each MVN module.

If you have configured the execution to be in the <code>validate</code> phase, you can run the simpler command:

<code>mvn validate</code>

(See the multi-scan example below)

== Multi-Threaded Support ==
The Globalyzer MVN plugin supports multi-threaded invocation. For instance, on multi-module projects, use the -T option. For instance:

<code>mvn com.lingoport.globalyzer.client.maven:globalyzer-maven-plugin:5.2.1:scan -Pglobalyzer -T1.0C</code>

If you have configured the execution to be in the <code>validate</code> phase, you can run the simpler command:

<code>mvn validate -T1.0C</code>

(See the multi-scan example below)

== Multi-Scan Projects ==

To execute more than one scan on a MVN project, use as many "execution" as you have rule sets to apply to scan the code. For instance, two scans will be performed with the following snippet, one using the <code>testjava</code> rule set, the other using the <code>testjavascript</code> rule set:

<plugin>
<groupId>com.lingoport.globalyzer.client.maven</groupId>
<artifactId>globalyzer-maven-plugin</artifactId>
<version>5.2.1</version>
<executions>
<execution>
'''<id>execution1</id>
<phase>validate</phase'''>
<configuration>
<username>bob@yourcompany.com</username>
<password>bobpassword</password>
'''<ruleSetName>testjava</ruleSetName>'''
<scanName>java-report</scanName>
</configuration>
<goals>
'''<goal>scan</goal>'''
</goals>
</execution>
<execution>
'''<id>execution2</id>
<phase>validate</phase>'''
<configuration>
<username>bob@yourcompany.com</username>
<password>bobpassword</password>
'''<ruleSetName>testjavascript</ruleSetName>'''
<scanName>javascript-report</scanName>
</configuration>
<goals>
'''<goal>scan</goal>'''
</goals>
</execution>
</executions>
</plugin>

== Sharing pom.xml Files Between IDEs and Build Systems ==

It is common to check in a single <code>pom.xml</code> per code repository. However, some configuration on a developer's laptop may be different from a build system.

A possibility to bridge the environment is to keep the most Globalyzer specific configuration only in the pom.xml file and to move the system side in the settings.xml file.

MVN Plugin

2016-09-27T18:27:35Z

Mheilner:

Globalyzer has a number of clients: The Workbench, the command line interface, Lite, the Ant client, and the MVN 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 an Integrated Development Environments (IDEs).

The Globalyzer MVN plugin generates scan reports to a directory specified 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 that company.

The steps to use the Globalyzer MVN plugin are the same as any MVN plugin:
* Install the plugin
* Configure the pom.xml
* Run MVN

== Install the Globalyzer MVN Plugin ==

For those customers who require the MVN plugin, we make the globalyzer-maven-plugin-x.y.z-jar-with-dependencies.jar file available for downloadm where x.y.z is the version for the plugin, for instance 5.2.1. We ask that this jar file be installed in a private MVN repository at the customer's side.
You first need to get the file from a secure FTP location, which will be sent to customers who request it. Lingoport customers can request the MVN plugin by sending an email to <code>support at lingoport dot com</code>

For example, a developer who wants to install the plugin in their local .m2 repository can use the following installation command, provided for a version <code>5.2.1</code> of the MVN plugin. The same applies to other versions.t

C:\Users\Yourname>'''mvn install:install-file''' -Dfile="C:\Path\to\the\plugin\jarfile\'''globalyzer-maven-plugin-5.2.1-jar-with-dependencies.jar'''" -DgroupId='''com.lingoport.globalyzer.client.maven''' -DartifactId='''globalyzer-maven-plugin''' -Dversion='''5.2.1''' -Dpackaging='''maven-plugin'''
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- maven-install-plugin:2.4:install-file (default-cli) @ standalone-pom ---
[INFO] Installing C:\Linternal\Installers\install\globalyzer-maven-plugin-5.2.1.jar to C:\Users\Yourname\.m2\repository\com\lingoport\globalyzer\client\maven\globalyzer-maven-plugin\5.2.1\globalyzer-maven-plugin-5.2.1.jar
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 0.615 s
[INFO] Finished at: 2016-09-09T15:49:59-06:00
[INFO] Final Memory: 7M/123M
[INFO] ------------------------------------------------------------------------

== Configure the Globalyzer MVN Plugin ==
The <code><build><plugins></code> section of your module's pom.xml file must be configured. Here is how:

<plugin>
<groupId>com.lingoport.globalyzer.client.maven</groupId>
<artifactId>globalyzer-maven-plugin</artifactId>
<version>5.2.1</version>
<configuration>
'''-required - '''
'''- session level settings - '''
<username>joe@company.com</username>
<password>joespw</password>
'''- scan level settings - '''
<ruleSetName>Java Rule Set</ruleSetName>
'''-optional -'''
'''- session level settings -'''
<serverUrl></serverUrl> (default: https://www.globalyzer.com/gzserver)
<dataDictionaryDir></dataDictionaryDir> ( default: userhome/.globalyzer )
<scanTimeout></scanTimeout> ( default: 120 seconds )
<filterWithDictionary></filterWithDictionary> ( default: true )
<setLog4jProperties></setLog4jProperties> ( default: true )
<log4jPropertiesFileDir></log4jPropertiesFileDir> ( default: Globalyzer provided )
'''- scan level settings -'''
<projectName></projectName> ( default: project artifact )
<projectDir></projectDir> ( default: project src/main/java )
<ruleSetOwner></ruleSetOwner> ( default: username )
<scanName></scanName> ( default: auto-generate )






<reportType></reportType> ( default: ScanDetailedXML )
<reportPath></reportPath> ( default: target/i18n )

</configuration>
</plugin>

Notes:
* The session level settings are set once per MVN invocation. Whichever scan / project goal is executed first, its configuration will be set for all the subsequent scans
* The <code>log4jPropertiesFileDir</code> is precisely that: which log4j configuration file to use is the <code>setLog4jProperties/code> is set to true. For for example, if that setting points to <code>/path/to/log4j.properties</code> and in that configuration, the appender points to <code>/path/to/globalyzer/log</code>, that's where the logs will be written out.
* Best would be to have the exact same configuration for all Globalyzer goals to make sure one configuration is not taking over the other ones.

== Running Globalyzer MVN Plugin From The Command Prompt / Shell ==

Globalyzer MVN Plugin can be executed from a command prompt or shell via the following command:

<code>mvn com.lingoport.globalyzer.client.maven:globalyzer-maven-plugin:5.2.1:scan</code>

After MVN finishes each scan, a Globalyzer report per scan is created at the location specified in the pom.xml report path. The default location for the reports are target/i18n for each MVN module.

If you have configured the execution to be in the <code>validate</code> phase, you can run the simpler command:

<code>mvn validate</code>

(See the multi-scan example below)

== Multi-Threaded Support ==
The Globalyzer MVN plugin supports multi-threaded invocation. For instance, on multi-module projects, use the -T option. For instance:

<code>mvn com.lingoport.globalyzer.client.maven:globalyzer-maven-plugin:5.2.1:scan -Pglobalyzer -T1.0C</code>

If you have configured the execution to be in the <code>validate</code> phase, you can run the simpler command:

<code>mvn validate -T1.0C</code>

(See the multi-scan example below)

== Multi-Scan Projects ==

To execute more than one scan on a MVN project, use as many "execution" as you have rule sets to apply to scan the code. For instance, two scans will be performed with the following snippet, one using the <code>testjava</code> rule set, the other using the <code>testjavascript</code> rule set:

<plugin>
<groupId>com.lingoport.globalyzer.client.maven</groupId>
<artifactId>globalyzer-maven-plugin</artifactId>
<version>5.2.1</version>
<executions>
<execution>
'''<id>execution1</id>
<phase>validate</phase'''>
<configuration>
<username>bob@yourcompany.com</username>
<password>bobpassword</password>
'''<ruleSetName>testjava</ruleSetName>'''
<scanName>java-report</scanName>
</configuration>
<goals>
'''<goal>scan</goal>'''
</goals>
</execution>
<execution>
'''<id>execution2</id>
<phase>validate</phase>'''
<configuration>
<username>bob@yourcompany.com</username>
<password>bobpassword</password>
'''<ruleSetName>testjavascript</ruleSetName>'''
<scanName>javascript-report</scanName>
</configuration>
<goals>
'''<goal>scan</goal>'''
</goals>
</execution>
</executions>
</plugin>

== Sharing pom.xml Files Between IDEs and Build Systems ==

It is common to check in a single <code>pom.xml</code> per code repository. However, some configuration on a developer's laptop may be different from a build system.

A possibility to bridge the environment is to keep the most Globalyzer specific configuration only in the pom.xml file and to move the system side in the settings.xml file.

MVN Plugin

2016-09-27T18:26:06Z

Mheilner:

Globalyzer has a number of clients: The Workbench, the command line interface, Lite, the Ant client, and the MVN 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 an Integrated Development Environments (IDEs).

The Globalyzer MVN plugin generates scan reports to a directory specified 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 that company.

The steps to use the Globalyzer MVN plugin are the same as any MVN plugin:
* Install the plugin
* Configure the pom.xml
* Run MVN

== Install the Globalyzer MVN Plugin ==

For those customers who require the MVN plugin, we make the globalyzer-maven-plugin-x.y.z-jar-with-dependencies.jar file available for downloadm where x.y.z is the version for the plugin, for instance 5.2.1. We ask that this jar file be installed in a private MVN repository at the customer's side.
You first need to get the file from a secure FTP location, which will be sent to customers who request it. Lingoport customers can request the MVN plugin by sending an email to <code>support at lingoport dot com</code>

For example, a developer who wants to install the plugin in their local .m2 repository can use the following installation command, provided for a version <code>5.2.1</code> of the MVN plugin. The same applies to other versions.t

C:\Users\Yourname>'''mvn install:install-file''' -Dfile="C:\Path\to\the\plugin\jarfile\'''globalyzer-maven-plugin-5.2.1-jar-with-dependencies.jar'''" -DgroupId='''com.lingoport.globalyzer.client.maven''' -DartifactId='''globalyzer-maven-plugin''' -Dversion='''5.2.1''' -Dpackaging='''maven-plugin'''
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- maven-install-plugin:2.4:install-file (default-cli) @ standalone-pom ---
[INFO] Installing C:\Linternal\Installers\install\globalyzer-maven-plugin-5.2.1.jar to C:\Users\Yourname\.m2\repository\com\lingoport\globalyzer\client\maven\globalyzer-maven-plugin\5.2.1\globalyzer-maven-plugin-5.2.1.jar
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 0.615 s
[INFO] Finished at: 2016-09-09T15:49:59-06:00
[INFO] Final Memory: 7M/123M
[INFO] ------------------------------------------------------------------------

== Configure the Globalyzer MVN Plugin ==
The <code><build><plugins></code> section of your module's pom.xml file must be configured. Here is how:

<plugin>
<groupId>com.lingoport.globalyzer.client.maven</groupId>
<artifactId>globalyzer-maven-plugin</artifactId>
<version>5.2.1</version>
<configuration>
'''-required - '''
'''- session level settings - '''
<username>joe@company.com</username>
<password>joespw</password>
'''- scan level settings - '''
<ruleSetName>Java Rule Set</ruleSetName>
'''-optional -'''
'''- session level settings -'''
<serverUrl></serverUrl> (default: https://www.globalyzer.com/gzserver)
<dataDictionaryDir></dataDictionaryDir> ( default: userhome/.globalyzer )
<scanTimeout></scanTimeout> ( default: 120 seconds )
<filterWithDictionary></filterWithDictionary> ( default: true )
<setLog4jProperties></setLog4jProperties> ( default: true )
<log4jPropertiesFileDir></log4jPropertiesFileDir> ( default: Globalyzer provided )
'''- scan level settings -'''
<projectName></projectName> ( default: project artifact )
<projectDir></projectDir> ( default: project src/main/java )
<ruleSetOwner></ruleSetOwner> ( default: username )
<scanName></scanName> ( default: auto-generate )






<reportType></reportType> ( default: ScanDetailedXML )
<reportPath></reportPath> ( default: target/i18n )

</configuration>
</plugin>

Notes:
* The configuration settings are set once per MVN invocation. Whichever scan / project goal is executed first, its configuration will be set for all the subsequent scans
* The <code>log4jPropertiesFileDir</code> is precisely that: which log4j configuration file to use is the <code>setLog4jProperties/code> is set to true. For for example, if that setting points to <code>/path/to/log4j.properties</code> and in that configuration, the appender points to <code>/path/to/globalyzer/log</code>, that's where the logs will be written out.
* Best would be to have the exact same configuration for all Globalyzer goals to make sure one configuration is not taking over the other ones.

== Running Globalyzer MVN Plugin From The Command Prompt / Shell ==

Globalyzer MVN Plugin can be executed from a command prompt or shell via the following command:

<code>mvn com.lingoport.globalyzer.client.maven:globalyzer-maven-plugin:5.2.1:scan</code>

After MVN finishes each scan, a Globalyzer report per scan is created at the location specified in the pom.xml report path. The default location for the reports are target/i18n for each MVN module.

If you have configured the execution to be in the <code>validate</code> phase, you can run the simpler command:

<code>mvn validate</code>

(See the multi-scan example below)

== Multi-Threaded Support ==
The Globalyzer MVN plugin supports multi-threaded invocation. For instance, on multi-module projects, use the -T option. For instance:

<code>mvn com.lingoport.globalyzer.client.maven:globalyzer-maven-plugin:5.2.1:scan -Pglobalyzer -T1.0C</code>

If you have configured the execution to be in the <code>validate</code> phase, you can run the simpler command:

<code>mvn validate -T1.0C</code>

(See the multi-scan example below)

== Multi-Scan Projects ==

To execute more than one scan on a MVN project, use as many "execution" as you have rule sets to apply to scan the code. For instance, two scans will be performed with the following snippet, one using the <code>testjava</code> rule set, the other using the <code>testjavascript</code> rule set:

<plugin>
<groupId>com.lingoport.globalyzer.client.maven</groupId>
<artifactId>globalyzer-maven-plugin</artifactId>
<version>5.2.1</version>
<executions>
<execution>
'''<id>execution1</id>
<phase>validate</phase'''>
<configuration>
<username>bob@yourcompany.com</username>
<password>bobpassword</password>
'''<ruleSetName>testjava</ruleSetName>'''
<scanName>java-report</scanName>
</configuration>
<goals>
'''<goal>scan</goal>'''
</goals>
</execution>
<execution>
'''<id>execution2</id>
<phase>validate</phase>'''
<configuration>
<username>bob@yourcompany.com</username>
<password>bobpassword</password>
'''<ruleSetName>testjavascript</ruleSetName>'''
<scanName>javascript-report</scanName>
</configuration>
<goals>
'''<goal>scan</goal>'''
</goals>
</execution>
</executions>
</plugin>

== Sharing pom.xml Files Between IDEs and Build Systems ==

It is common to check in a single <code>pom.xml</code> per code repository. However, some configuration on a developer's laptop may be different from a build system.

A possibility to bridge the environment is to keep the most Globalyzer specific configuration only in the pom.xml file and to move the system side in the settings.xml file.

MVN Plugin

2016-09-27T18:22:02Z

Mheilner:

Globalyzer has a number of clients: The Workbench, the command line interface, Lite, the Ant client, and the MVN 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 an Integrated Development Environments (IDEs).

The Globalyzer MVN plugin generates scan reports to a directory specified 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 that company.

The steps to use the Globalyzer MVN plugin are the same as any MVN plugin:
* Install the plugin
* Configure the pom.xml
* Run MVN

== Install the Globalyzer MVN Plugin ==

For those customers who require the MVN plugin, we make the globalyzer-maven-plugin-x.y.z-jar-with-dependencies.jar file available for downloadm where x.y.z is the version for the plugin, for instance 5.2.1. We ask that this jar file be installed in a private MVN repository at the customer's side.
You first need to get the file from a secure FTP location, which will be sent to customers who request it. Lingoport customers can request the MVN plugin by sending an email to <code>support at lingoport dot com</code>

For example, a developer who wants to install the plugin in their local .m2 repository can use the following installation command, provided for a version <code>5.2.1</code> of the MVN plugin. The same applies to other versions.t

C:\Users\Yourname>'''mvn install:install-file''' -Dfile="C:\Path\to\the\plugin\jarfile\'''globalyzer-maven-plugin-5.2.1-jar-with-dependencies.jar'''" -DgroupId='''com.lingoport.globalyzer.client.maven''' -DartifactId='''globalyzer-maven-plugin''' -Dversion='''5.2.1''' -Dpackaging='''maven-plugin'''
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- maven-install-plugin:2.4:install-file (default-cli) @ standalone-pom ---
[INFO] Installing C:\Linternal\Installers\install\globalyzer-maven-plugin-5.2.1.jar to C:\Users\Yourname\.m2\repository\com\lingoport\globalyzer\client\maven\globalyzer-maven-plugin\5.2.1\globalyzer-maven-plugin-5.2.1.jar
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 0.615 s
[INFO] Finished at: 2016-09-09T15:49:59-06:00
[INFO] Final Memory: 7M/123M
[INFO] ------------------------------------------------------------------------

== Configure the Globalyzer MVN Plugin ==
The <code><build><plugins></code> section of your module's pom.xml file must be configured. Here is how:

<plugin>
<groupId>com.lingoport.globalyzer.client.maven</groupId>
<artifactId>globalyzer-maven-plugin</artifactId>
<version>5.2.1</version>
<configuration>
'''-required - '''
'''- session level settings - '''
<username>joe@company.com</username>
<password>joespw</password>

'''- scan level settings - '''
<ruleSetName>Java Rule Set</ruleSetName>

'''-optional -'''
'''- session level settings -'''
<serverUrl></serverUrl> (default: https://www.globalyzer.com/gzserver)
<dataDictionaryDir></dataDictionaryDir> ( default: userhome/.globalyzer )
<scanTimeout></scanTimeout> ( default: 120 seconds )
<filterWithDictionary></filterWithDictionary> ( default: true )
<setLog4jProperties></setLog4jProperties> ( default: true )
<log4jPropertiesFileDir></log4jPropertiesFileDir> ( default: Globalyzer provided )

'''- scan level settings -'''
<projectName></projectName> ( default: project artifact )
<projectDir></projectDir> ( default: project src/main/java )
<ruleSetOwner></ruleSetOwner> ( default: username )
<scanName></scanName> ( default: auto-generate )






<reportType></reportType> ( default: ScanDetailedXML )
<reportPath></reportPath> ( default: target/i18n )

</configuration>
</plugin>

Notes:
* The configuration settings are set once per MVN invocation. Whichever scan / project goal is executed first, its configuration will be set for all the subsequent scans
* The <code>log4jPropertiesFileDir</code> is precisely that: which log4j configuration file to use is the <code>setLog4jProperties/code> is set to true. For for example, if that setting points to <code>/path/to/log4j.properties</code> and in that configuration, the appender points to <code>/path/to/globalyzer/log</code>, that's where the logs will be written out.
* Best would be to have the exact same configuration for all Globalyzer goals to make sure one configuration is not taking over the other ones.

== Running Globalyzer MVN Plugin From The Command Prompt / Shell ==

Globalyzer MVN Plugin can be executed from a command prompt or shell via the following command:

<code>mvn com.lingoport.globalyzer.client.maven:globalyzer-maven-plugin:5.2.1:scan</code>

After MVN finishes each scan, a Globalyzer report per scan is created at the location specified in the pom.xml report path. The default location for the reports are target/i18n for each MVN module.

If you have configured the execution to be in the <code>validate</code> phase, you can run the simpler command:

<code>mvn validate</code>

(See the multi-scan example below)

== Multi-Threaded Support ==
The Globalyzer MVN plugin supports multi-threaded invocation. For instance, on multi-module projects, use the -T option. For instance:

<code>mvn com.lingoport.globalyzer.client.maven:globalyzer-maven-plugin:5.2.1:scan -Pglobalyzer -T1.0C</code>

If you have configured the execution to be in the <code>validate</code> phase, you can run the simpler command:

<code>mvn validate -T1.0C</code>

(See the multi-scan example below)

== Multi-Scan Projects ==

To execute more than one scan on a MVN project, use as many "execution" as you have rule sets to apply to scan the code. For instance, two scans will be performed with the following snippet, one using the <code>testjava</code> rule set, the other using the <code>testjavascript</code> rule set:

<plugin>
<groupId>com.lingoport.globalyzer.client.maven</groupId>
<artifactId>globalyzer-maven-plugin</artifactId>
<version>5.2.1</version>
<executions>
<execution>
'''<id>execution1</id>
<phase>validate</phase'''>
<configuration>
<username>bob@yourcompany.com</username>
<password>bobpassword</password>
'''<ruleSetName>testjava</ruleSetName>'''
<scanName>java-report</scanName>
</configuration>
<goals>
'''<goal>scan</goal>'''
</goals>
</execution>
<execution>
'''<id>execution2</id>
<phase>validate</phase>'''
<configuration>
<username>bob@yourcompany.com</username>
<password>bobpassword</password>
'''<ruleSetName>testjavascript</ruleSetName>'''
<scanName>javascript-report</scanName>
</configuration>
<goals>
'''<goal>scan</goal>'''
</goals>
</execution>
</executions>
</plugin>

== Sharing pom.xml Files Between IDEs and Build Systems ==

It is common to check in a single <code>pom.xml</code> per code repository. However, some configuration on a developer's laptop may be different from a build system.

A possibility to bridge the environment is to keep the most Globalyzer specific configuration only in the pom.xml file and to move the system side in the settings.xml file.

MVN Plugin

2016-09-06T21:39:48Z

Mheilner:

MVN Plugin

2016-09-06T21:38:00Z

Mheilner:

Rule Sets FAQ

2012-06-11T20:53:24Z

Mheilner:

===Can I modify the Default Rule Sets?===

If you have a Globalyzer Team Server license, you will be hosting the Globalyzer Server, and as the Administrator, you can modify any of the Default Rule Sets.

If you are running from Lingoport's Globalyzer Server, you will not be able to modify the Default Rule Sets, but you can modify one of your own Rule Sets and then allow your team members to either use it (sharing) or copy it. This Rule Set can then be the starting point for their internationalization scanning and filtering process.

===Where can I find help on “General Pattern” issues found in C++ code scanning?===

If you login to the Globalyzer Server and look at the General Patterns for your rule set, it will often give information on why Globalyzer is scanning for this pattern. In addition, if you go to the Help system on the Globalyzer Server, there are various topics on C++ internationalization. In particular, click on '''Reference->Locale-Sensitive Methods->C++ Programming Language->C++ Rule Sets'''. This help page talks about Unicode support in the various C++ rule sets. For example, usually a C++ program will be compiled with single-byte character strings. These single-bytes cannot support Unicode characters, which require more than 1 byte. That is the main reason why our C++ General Patterns scan for character strings: You will have to make sure to modify them if they are to hold Unicode strings.

===Does Globalyzer fix JavaScript locale-sensitive method issues?===

Globalyzer detects methods that could be an issue when supporting multiple languages, but has no specific fixing built in. This is because it’s not always clear that the method is an actual issue and the fix may involve some reworking that requires manual decisions. However, for some programming languages, we have written internationalization (i18n) help for the method that explains the reason for the detection as well as suggestions on what change might need to be made. When we don’t provide specific i18n help, we provide links to external help on the method, which sometimes provide information about i18n considerations.

===What is the fix for the JavaScript locale-sensitive method charAt()?===

In this case, Globalyzer detected '''charAt''' because it is a method that indexes into a string. If that string contains a translation, then the location of the character may have changed or it may not be the same character. The fix is really dependent on the usage. If the string is locale-independent, then you can insert an '''Ignore This Line''' comment so that Globalyzer will no longer flag this issue.

===When will internationalization help be added for JavaScript locale-sensitive methods?===

We are always pressed to get more features into Globalyzer, but do try to spend as much time as possible adding to the help. In the meantime, if you have any specific questions, you should email support@lingoport.com and we’ll get an answer for you right away!

===How do I add new JavaScript locale-sensitive methods or modify the description and help for existing methods?===

If you have a Globalyzer Team Server license, you can add to or modify the default [[Rule Sets#Locale-Sensitive_Method_Scan_Rules|locale-sensitive methods]] for each programming language so that your users will also see your changes whenever they create a new Rule Set. If you’re using our hosted [http://www.globalyzer.com globalyzer.com] server, you can add to or modify the locale-sensitive methods of a specific [[Rule Sets#What_Are_Rule_Sets.3F|Rule Set]] that you create and then share with other Globalyzer users that are part of your team. That way, your team members will benefit from the work you have done in determining the resolution for locale-sensitive method issues. This approach applies to all Rule Set rules, such as General Patterns, Static File References, and all the many filters Globalyzer applies during code scanning.

===When you create your rule set, can you specify the file extensions you would like scanned?===
The default for a java rule set is to scan files with the following extensions: java, jsp, jspf, and jspx. If you are only interested in jsp files, you can disable the others. Steps to do this:

1) Log in to the server and select your java rule set

2) Select Configure Source File Extensions

3) Uncheck the file extensions you are not interested in

You can also configure the scan to look at only certain directories in your project. Steps to do this:

1) Log into the client.

2) Select your project in Project Explorer and select Scan->Manage Scans

3) Select the java scan and select Modify.

4) Select the specific directories to scan, not just the entire project, and Finish

You can run your scan by selecting Scan->Single Scan.

===How do I create a rule set for the 'C' language?===

For the C language, you should choose one of our C++ variants. The main ones are '''ANSI UTF-8''', '''ANSI UTF-16''', '''Cross Platform UTF-8''', '''Cross Platform UTF-16''', '''Windows Generic''', '''Windows MBCS''', and '''Windows Unicode'''. If you are using GNU C, you will want to use one of the ANSI rule sets. UTF-8 if that’s how you want to support Unicode; UTF-16 if you will be using wide-character calls to support UTF-16 Unicode. If you are just running on Windows, then you can choose a Windows variant. If you’ll be running on both, then you’ll need a cross-platform rule set. The difference between the variants is the list of locale-sensitive methods Globalyzer will scan for in your code. To get a better feel, you can create a few rule set with the different variants and look at the locale-sensitive methods defined.

Rule Sets FAQ

2012-06-11T20:45:18Z

Mheilner:

===Can I modify the Default Rule Sets?===

If you have a Globalyzer Team Server license, you will be hosting the Globalyzer Server, and as the Administrator, you can modify any of the Default Rule Sets.

If you are running from Lingoport's Globalyzer Server, you will not be able to modify the Default Rule Sets, but you can modify one of your own Rule Sets and then allow your team members to either use it (sharing) or copy it. This Rule Set can then be the starting point for their internationalization scanning and filtering process.

===Where can I find help on “General Pattern” issues found in C++ code scanning?===

If you login to the Globalyzer Server and look at the General Patterns for your rule set, it will often give information on why Globalyzer is scanning for this pattern. In addition, if you go to the Help system on the Globalyzer Server, there are various topics on C++ internationalization. In particular, click on '''Reference->Locale-Sensitive Methods->C++ Programming Language->C++ Rule Sets'''. This help page talks about Unicode support in the various C++ rule sets. For example, usually a C++ program will be compiled with single-byte character strings. These single-bytes cannot support Unicode characters, which require more than 1 byte. That is the main reason why our C++ General Patterns scan for character strings: You will have to make sure to modify them if they are to hold Unicode strings.

===Does Globalyzer fix JavaScript locale-sensitive method issues?===

Globalyzer detects methods that could be an issue when supporting multiple languages, but has no specific fixing built in. This is because it’s not always clear that the method is an actual issue and the fix may involve some reworking that requires manual decisions. However, for some programming languages, we have written internationalization (i18n) help for the method that explains the reason for the detection as well as suggestions on what change might need to be made. When we don’t provide specific i18n help, we provide links to external help on the method, which sometimes provide information about i18n considerations.

===What is the fix for the JavaScript locale-sensitive method charAt()?===

In this case, Globalyzer detected '''charAt''' because it is a method that indexes into a string. If that string contains a translation, then the location of the character may have changed or it may not be the same character. The fix is really dependent on the usage. If the string is locale-independent, then you can insert an '''Ignore This Line''' comment so that Globalyzer will no longer flag this issue.

===When will internationalization help be added for JavaScript locale-sensitive methods?===

We are always pressed to get more features into Globalyzer, but do try to spend as much time as possible adding to the help. In the meantime, if you have any specific questions, you should email support@lingoport.com and we’ll get an answer for you right away!

===How do I add new JavaScript locale-sensitive methods or modify the description and help for existing methods?===

If you have a Globalyzer Team Server license, you can add to or modify the default [[Rule Sets#Locale-Sensitive_Method_Scan_Rules|locale-sensitive methods]] for each programming language so that your users will also see your changes whenever they create a new Rule Set. If you’re using our hosted [http://www.globalyzer.com globalyzer.com] server, you can add to or modify the locale-sensitive methods of a specific [[Rule Sets#What_Are_Rule_Sets.3F|Rule Set]] that you create and then share with other Globalyzer users that are part of your team. That way, your team members will benefit from the work you have done in determining the resolution for locale-sensitive method issues. This approach applies to all Rule Set rules, such as General Patterns, Static File References, and all the many filters Globalyzer applies during code scanning.

===When you create your rule set, can you specify the file extensions you would like scanned?===
The default for a java rule set is to scan files with the following extensions: java, jsp, jspf, and jspx. If you are only interested in jsp files, you can disable the others. Steps to do this:

1) Log in to the server and select your java rule set

2) Select Configure Source File Extensions

3) Uncheck the file extensions you are not interested in

You can also configure the scan to look at only certain directories in your project. Steps to do this:

1) Log into the client.

2) Select your project in Project Explorer and select Scan->Manage Scans

3) Select the java scan and select Modify.

4) Select the specific directories to scan, not just the entire project, and Finish

You can run your scan by selecting Scan->Single Scan.

===How do I create a rule set for the 'C' language?===

For the C language, you should choose one of our C++ variants. The main ones are:
ANSI UTF-8
ANSI UTF-16
Cross Platform UTF-8
Cross Platform UTF-16
Windows Generic
Windows MBCS
Windows Unicode

If you are using GNU C, you will want to use one of the ANSI rule sets. UTF-8 if that’s how you want to support Unicode UTF-16 if you will be using wide-character calls to support UTF-16 Unicode
If you are just running on Windows, then you can choose a Windows variant.
If you’ll be running on both, then you’ll need a cross-platform rule set.

The difference between the variants is the list of locale-sensitive methods Globalyzer will scan for in your code. To get a better feel, you can create a few rule set with the different variants and look at the locale-sensitive methods defined.