Installing optional modules for a Tridion Sites web application (Java)

DXA provides a number of optional modules that you can you can add to your Java web application. You typically would do this when you initially install your web application, but you can also do it at a later time.

About this task

To install one or more optional modules during the installation process, include their Java profile names as installation parameters.

The format for installing the web application with one or more modules is as follows:
prepare.bat prepare -P<module-name>[,<module-name>]*

The following table lists the modules that you can install with DXA:

[/task/taskbody/context/table/tgroup/tbody/row/entry {"col1"})

Audience Manager module

(entry]
[/task/taskbody/context/table/tgroup/tbody/row/entry {"col2"})

audience-manager

(entry]
[/task/taskbody/context/table/tgroup/tbody/row/entry {"col2"})

The DXA Audience Manager module offers integration with Contacts stored in the Tridion Sites Audience Manager database, allowing visitors to log in as one of those Contacts.

(entry]
DXA moduleJava module nameDescription

51Degrees module

51degrees

The DXA 51Degrees module provides device detection functionality to improve the user experience when accessing your DXA website across different device types, such as smartphones and tablets in addition to full desktop and laptop screens.

Context Expressions module

context-expressions

The DXA Context Expressions module makes it possible to include or exclude Entities based on Context Expression Target Group conditions defined in the Tridion Sites Content Manager.

Contextual Image Delivery module

cid

The DXA Contextual Image Delivery (CID) module provides the ability to change page layout and resize images in your DXA webpages.

DXA Core module (see note)

core

The DXA Core module contains basic (but optional) Views and View Models that are used in the sample implementation of DXA.

Experience Optimization module (formerly SmartTarget)

smarttarget

The DXA Experience Optimization module provides integration and support for the Experience Optimization feature in Tridion Sites, which enables you to deliver targeted and personalized content to website visitors by creating set of rules (Promotions) governing when, where, and for whom your material is displayed.

Google Analytics module

googleanalytics

The DXA Google Analytics module adds a Google Analytics tracking code your DXA website. It includes all Pages of the website.

Media Manager module

mediamanager

The DXA Media Manager module enables you to use RWS Media Manager distributions on a Tridion Sites Page like any other media Item.

Search module

search

The DXA Search module provides website search functionality for your DXA web applications, including both .NET and Java-based websites for Tridion Sites. Note that this module is not for use with Java-based Tridion Docs websites. Rather, these websites should use the Tridion Docs Search module.

Tridion Docs Mashup module

tridion-docs-mashup

The DXA Tridion Docs Mashup module enables you to present structured content (in the DITA standard) together with Tridion Sites content from the same DXA web application, including mixed content on the same webpage.

User Generated Content module

ugc

The User-Generated Content (UGC) module provides the ability to create and retrieve user-generated content, such as comments, that are associated with your DXA webpages.

The following shows the command to reinstall the web application with several modules, including the core, which is needed by other modules:

prepare.bat prepare -Pcore,search,51degrees,mediamanager

Be sure to include the core module, which is needed for all other modules.

You can also install modules at a later time, but it is important to note that any time you run the prepare.bat (or prepare.sh) installation tool, you must specify ALL modules that you want installed, not just the new one you are adding. Failure to do so will remove the other modules.