Content Targeting Report Template

In this article, you’ll learn how to create a Liferay Content Targeting Report application as a Liferay module. To create a Content Targeting Report via the command line using Blade CLI or Maven, use one of the commands with the following parameters:

blade create -t content-targeting-report -p [package name] -c [class name] [project name]


mvn archetype:generate \
    -DarchetypeGroupId=com.liferay \ \
    -DartifactId=[projectName] \
    -Dpackage=[packageName] \
    -DclassName=[className] \

You can also insert the -b maven parameter in the Blade command to generate a Maven project using Blade CLI.

The template for this kind of project is content-targeting-report. To create a report project called hits-by-country with a package prefix of com.liferay and a class name of HitsByCountryReport, use this command:

blade create -t content-targeting-report -p com.liferay -c HitsByCountry hits-by-country


mvn archetype:generate \
    -DarchetypeGroupId=com.liferay \ \
    -DgroupId=com.liferay \
    -DartifactId=hits-by-country \
    -Dpackage=com.liferay \
    -Dversion=1.0 \
    -DclassName=HitsByCountry \
    -Dauthor=Joe Bloggs \

The command above creates a Content Targeting Rule project named hits-by-country in the current folder. In the class, you’re creating a service of type com.liferay.content.targeting.api.model.Report and extending the com.liferay.content.targeting.api.model.BaseJSPReport class. Here, service means an OSGi service, not a Liferay API. Another way to say service type is to say component type.

After running the command above, your project’s folder structure looks like this:

  • hits-by-country
    • gradle
      • wrapper
        • gradle-wrapper.jar
    • src
      • main
        • java
          • com/liferay/content/targeting/report
        • resources
          • content
          • META-INF
            • resources
              • edit.jsp
              • view.jsp
    • bnd.bnd
    • build.gradle
    • gradlew

The Maven-generated project includes a pom.xml file and does not include the Gradle-specific files, but otherwise, appears exactly the same.

The generated module is a working application and is deployable to a Liferay DXP instance. To build upon the generated app, modify the project by adding logic and additional files to the folders outlined above.

« API TemplateContent Targeting Rule Template »
Was this article helpful?
0 out of 0 found this helpful