Sample content for a view model-based, dynamic Content Mashup

DXA provides sample SDL Tridion Sites Content Manager assets for use in a dynamic content mashup implementation.In a dynamic content mashup, a Tridion Sites Page View automatically determines what product is used on the Page and then retrieves the appropriate technical content from Tridion Docs.

The following diagram shows the various sample items that DXA provides for a dynamic content mashup:

The following table describes each of the illustrated Content Manager items and its function in a dynamic content mashup scenario:

Publication and locationSample items
100 Master

\ 100 Master \ Categories and Keywords \

Predefined Categories and Keywords that can be used to drive a Content Mashup. DXA provides the following sample default Categories:
Product Release Name
Category that contains Keywords to indicate a particular release of a product.
DXA provides one example Keyword value: Model 2018
When used for content mashup, the Keyword maps to a publication-level metadata field in Tridion Docs.
Product Family Name
Category that contains Keywords to indicate a product family (a logical grouping of products).
DXA provides three example Keyword values: City Bicycle, Red Bicycle and White Bicycle
When used for content mashup, the Keyword maps to a publication-level metadata field in Tridion Docs.

\ 100 Master \ Building Blocks \ Modules \ TridionDocsMashup \ Admin \

TridionDocsMashup
Component that defines general configuration for content mashups (both static and dynamic)
As installed, the Component includes links to the following:
  • Schema: Module Configuration
  • URL configuration Component: TridionDocsMashup URL Configuration Configuration
  • HTML Design configuration Component: \100 Master\Building Blocks\Settings\TridionDocsMashup\Site Manager\TridionDocsMashup HTML Design Configuration
TridionDocsMashup HTML Design

ZIP file containing the HTML design files that are used by the TridionDocsMashup Configuration.

TridionDocsMashup URL Configuration
Component that configures the URLs that are used for requesting SDL Tridion Docs content.
Enables you to independently configure URL prefixes for the following:
  • Binaries – A prefix added to the URLs for binary resources (such as PDFs and images) that appear within topics when the topics are embedded and shown on the Page.

    The default prefix is: /docsmashup

    The URL resolves to the following format: http://DXAWEBSITEURL/docmashup/BINARYURL

    Where:

    • DXAWEBSITEURL is the host and URL of your DXA website.
    • BINARYURL is the URL of the binary resource.
  • Topics – A prefix added to the URLs for topics that appear as links on a Page.

    The default is an empty value, which means that your SDL Tridion Docs website is configured on the same host and with the same URL as the DXA website.

    If the SDL Tridion Docs website is installed on different host and using different URL, then specify that URL here, using the format //mydocs.website.com.

\ 100 Master \ Building Blocks \ Modules \ TridionDocsMashup \ Admin \ Schemas

TridionDocsMashup URL Configuration
Schema for the Component with the same name
This Schema defines the fields that the Component uses to specify URL prefixes.

\ 100 Master \ Building Blocks \ Modules \ TridionDocsMashup \ Editor \ Schemas \

Bicycle
Component Schema for a sample product, a bicycle.
Both the dynamic and static content mashup models use this same sample Schema.
The Schema includes fields that map to publication-level or topic-level metadata fields in Tridion Docs. These fields apply only to the dynamic mashup model. The fields are not relevant to how the static mashup works, and so they are simply ignored.
\ Page Schemas
Subfolder containing Page schemas for the content mashup
\ Region Schemas
Subfolder containing Region schemas for the content mashup

\ 100 Master \ Building Blocks \ Modules \ TridionDocsMashup \ Editor \ Templates \

Bicycle
Component Template for a sample product, linked to:
  • Component Schema: Bicycle
  • Entity View Model: TridionDocsMashup:Bicycle

\ 100 Master \ Building Blocks \ Modules \ TridionDocsMashup \ Site Manager \ Schemas \

Tridion Docs Dynamic Widget
A sample Schema that enables authorized users to select a Product View Model that will dynamically determine the technical content to be retrieved based on matching metadata
The Schema includes the following field definitions:
ProductViewModel
Defines a field that enables authorized users to identify the View Model to be used for the Component
Keywords
Defines a drop-down list field that gives authorized users a choice of Keywords to select the product family
DXA defines these Keywords in the Category "Product Family Name."
This field maps to a metadata field in SDL Tridion Docs.
DisplayContentAs
Defines a radio button that enables authorized users to select whether the technical content will be included on the Page as inline text or as one more links to the content (rendered in a separate web application)
MaxNumberOfItemsToShow
Defines a numeric field that enables authorized users to limit the number of topics (or links) that should appear on the page in the event there are multiple matching topics

\ 100 Master \ Building Blocks \ Modules \ TridionDocsMashup \ Site Manager \ Templates \

Tridion Docs Dynamic Widget

A sample Component Template that is linked to the Schema of the same name.

  • Controller = TridionDocsMashup:TridionDocsMashup
  • Entity View Name = TridionDocsMashup:DynamicWidget
  • HTML Classes = tridiondocsmashup

\ 100 Master \ Building Blocks \ Settings \ TridionDocsMashup \ Site Manager \

TridionDocsMashup HTML Design Configuration
Component that provides resources for the HTML design, which in this case is by linking to a Multimedia Component \100 Master\Building Blocks\Modules\TridionDocsMashup\Admin (packaged in a ZIP file).
110 DXA Site Type

\ 110 DXA Site Type \ Building Blocks \ Modules \ TridionDocsMashup \ Editor \ Templates \

Bicycle
A Page Template for the dynamic content mashup scenario with an include Page that provides the configuration for your dynamic content mashup
  • Page Schema:Bicycle Page
  • Include Pages: TridionDocsMashup:Topics

\ 110 DXA Site Type \ Building Blocks \ Modules \ TridionDocsMashup \ Site Manager \ Templates \

Include Page (Tridion Docs Dynamic Widget)
A Page Template used for the include page.

\ 110 DXA Site Type \ Building Blocks \ Modules Content \ TridionDocsMashup \ Content \ _Cloneable Content \

Bicycle
An example Component that is used on the Bicycle Page to demonstrate a dynamic content mashup

\ 110 DXA Site Type \ Building Blocks \ Modules Content \ TridionDocsMashup \ Content \ Products \ Bicycles \

Bicycle Widget Configuration
The configuration Component determines the fields used as keywords for the content mashup, as well as how the content is rendered on the webpage, including whether users see embedded topics or a list of links.
The sample configuration Component is based on the "Tridion Docs Dynamic Widget" schema, and defines the following content settings:
Product View Model
Name of the View Model used to display the Component
Keywords
Names of the metadata fields available for Tridion Docs content, which will be used as selection criteria for the content mashup
The field names are mapped to (and match) metadata fields that exist in Tridion Docs.
The field names also correspond to Categories defined in Tridion Sites.
The sample Bicycle Widget Configuration includes two Keywords:
  • FMBPRODUCTFAMILYNAME is a publication-level metadata field that indicates a product family (a logical grouping of products).
  • FMBPRODUCTRELEASENAME is a publication-level metadata field that indicates a particular release of a product.
Display Content As
Determines how the content is to be made available on the webpage, either:
  • Embedded Content displays the actual topic content on the webpage.
  • Link displays a hyperlink rather that the content itself. The link will take the user to the published topic in the Tridion Docs web application.
Max Number Of Items To Show
For instances where there may be multiple topics from Tridion Docs that match the selection criteria, enter the maximum number of topics to be displayed. If the content is embedded, then the embedded topics will be rendered one after the other. If displaying links to topics, then users will see a list of topic links.

\ 110 DXA Site Type \ Home \ _System \ include \

TridionDocsMashup:Topics
A Page that functions exclusively as an include page of your dynamic content mashup Pages, and which provides the configuration Component for your dynamic content mashup
In the example items provided for the dynamic mashup, these are Pages you create based on the Page Template named "Bicycle."
200 Example Content

\ 200 Example Content \ Building Blocks \ Modules Content \ TridionDocsMashup \ Content \ Products \ Bicycles \

White Bicycle Product
An example Component that demonstrate a view-based, dynamic content mashup scenario
400 Example Site

\ 400 Example Site \ Home \ 030 Products \

002 White Bicycle
An example Page that demonstrate a view-based, dynamic content mashup scenario
Contains one Region: Bicycle with Component White Bicycle
000 Product Catalogue
An sample top-level Page for the example Product catalogue, displayed when the user select PRODUCTS from the main navigation.

\ 400 Example Site \ Home \ _Page Types \

Bicycle Page
An example Page that DXA uses to demonstrate a view-based, dynamic content mashup scenario.