Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Show Page Sections

Rich Media Components

IogoBox

OVERVIEW

A logoBox contains a brand image and can redirect to a URL.



ATTRIBUTES DETAILS

SUB -ELTS ATTRIBUTES VALUE
mode: logoBox visible or not on / off
widthPercent: percentage of occupancy in the total width of the container/page #IMPLIED
heightPercent: percentage of occupancy in the total height of the container/page #IMPLIED
autoSize: (Cf. Appendix C – UI brick positioning)
hzAlignment: gives the horizontal alignment of the box in its container/page left / right / center / justified
vtAlignment: gives the vertical alignment of the box in its container/page up / down / middle / distributed
keyBoardNav: keyboard Navigation activated or not on / off
SUB -ELTS ATTRIBUTES VALUE
url: url (path) of the redirection #IMPLIED
resourceName: identifier of the graphical resource #IMPLIED
translationName: label that can be associated to the logoBox #IMPLIED
Warning: If a URL has been defined, a click on the image generates the display of this page in another browser window.

Example:

XML Sample

<logoBox mode="on" cssName="logoBox1" url="" widthPercent="100"

heightPercent="25" resourceName="eHomeLogoTop" translationName="logoMsg" hzAlignment="left"

vtAlignment="middle" autosize="off" />

VISUAL IDENTITY

The logoBox is associated to a main CSS class. The image contained in the logobox is declared in the declared in the XML Layout file.

Mapping between CSS Classes and component structure



RMOFlyer

OVERVIEW

A RMOFlyer displays (on configuration and summary pages) multimedia content attached to the object it is linked to. For example, a RMOFlyer can be opened when clicking on a button attached to a FormProperty box.



ATTRIBUTES DETAILS

SUB-ELTS ATTRIBUTES VALUE
mode: RMOFlyer visible or not on / off
name: identifier of the Flyer. This name is used as a parameter of the OPEN_FLYER action. #IMPLIED
resizable: flyer resizable or not on / off
cpeObject: specifies which RMO objects will be displayed. If this attribute is not present, the RMO of the object from which the RMOFlyer has been called is taken into account. CPE.currentValue / CPE.currentFP / CPE.currentForm[current] / CPE.currentForm / CPE.currentCP[current] / CPE.currentCP / CPE.rootCP /
SUB-ELTS ATTRIBUTES VALUE
titleTranslationName: identifier of the translation used to give the title of the box #IMPLIED
titleResourceName: identifier of the resource to be displayed in the title of the box. #IMPLIED
vtPosition: gives the vertical position of the flyer in the screen up / middle / down / auto
hzPosition: gives the horizontal position of the flyer in the screen left / center / right / auto
vtSize: gives in pixel the vertical size of the flyer #IMPLIED
hzSize: gives in pixel the horizontal size of the flyer #IMPLIED
RMOBox combinedBox Several RMOBoxes can be inserted in the RMOFLyer and organized via combinedBoxes #REQUIRED

VISUAL IDENTITY

Tip:

The translation associated to the RMOFlyer title is dynamically built following the associated localized message:

<translation name="MyTitleID">Info : {0} </translation>

{0} will be replaced on the fly at runtime by the description of the object whose RMO is being displayed.

The RMOFlyer is associated to a main CSS class. The resource associated to the header part of the RMOFlyer is declared in the XML Layout file.

Mapping between CSS Classes and component structure



RMOBox

OVERVIEW

The RMO box renders any rich media information attached to an object. It can be directly associated to an action to allow the end-user to click on the image/text and:

  • be redirected to the product/collection/needAnalysis page (depending on the RMOBox context).
  • open a RMO Flyer whose content depends on the context of the RMOBox.

ATTRIBUTES DETAILS

SUB -ELTS ATTRIBUTES VALUE
mode: RMOBox visible or not on / off
widthPercent: percentage of occupancy in the total width of the container #IMPLIED
heightPercent: percentage of occupancy in the total height of the container/flyer #IMPLIED
autoSize: (Cf. Appendix C – UI brick positioning) on / off
SUB -ELTS ATTRIBUTES VALUE
hzAlignment: gives the horizontal alignment of the box in its container left / right / center / justified
vtAlignment: gives the vertical alignment of the box in its container up / down / middle / distributed
titleTranslationName: identifier of the translation used to give the title of the box #IMPLIED
titleResourceName: identifier of the resource to be displayed in the title of the box. #IMPLIED
rmoUserType: user type of the RMO information to be displayed #IMPLIED “*” means ‘any’ userType
content: list of the RMO types displayed in the RMOBox file / image / text / plugin / description
contentPosition: gives the alignment of elements contained in the box vertical / horizontal
linkedAction The linkedAction is launched when the end user clicks on the RMO Image and RMOText (unless a URL has been associated to the RMO on model side). Reference: Learn more about linkedAction in Customizing/Structure and Behavior.

Authorized linked actions:

  • ACTIVATE_CURRENT: on Click, the end user is redirected to:
    • productPage
      • If a SI RMO or a RMO of a Teaser pointing to a SI or a CP is displayed
    • collectionPage
      • If a Collection RMO or a RMO of a Teaser pointing to a collection is displayed
    • expanded needAnalysisBox of a collectionPage
      • If a RMO of a Teaser pointing to a NA (scope=currentCollet ion) is displayed
    • needAnalysisPage
      • If a RMO of a Teaser pointing to a NA (scope=currrentSub Tree) is displayed
  • OPEN_FLYER: on Click, the end user can open:
    • productFlyer
      • If a product RMO is displayed
    • rmoFlyer
      • If a product or a collection RMO is displayed
  • COMPARE: on Click, the end user can add a product to the CompareList if a product RMO is displayed

    Warning:

    When a URL is specified on model side on a RMO image/text, the URL is used and any other action declared on UI side is ignored.

    e.g.: in a RMOBox containing a Text and an Image:

    If an ACTIVATE_CURRENT action is declared in the XML Layout but a URL already exists on the image, then a click on the Image will redirect to the URL whereas a click on the Text will launch the ACTIVATE_CURRENT.

    Tip: A CSS file determines how the different types of information are positioned in the Box.

    Warning:

    The RMO to be displayed in the RMOBox is the RMO of the object:

    -either associated to the cpeObject value of the RMOFlyer - or associated to the action button that

    opens the RMOFlyer:

    Example:

    XML Sample:

    RMOBoxes in a RMOFlyer

    <RMOBox mode="on" cssName="rmoBox" autosize="off" widthPercent="50"

    heightPercent="100" hzAlignment="left" vtAlignment="up" rmoUserType="*"

    titleResourceName="" titleTranslationName=""

    content="image text"

    contentPosition="vertical"/>



VISUAL IDENTITY

Each RMOBox can be associated to a main CSS class that controls in particular the background and font of the RMO displayed data

Mapping between CSS Classes and component structure Example with 3 RMO Boxes in a RMOFlyer



imageViewer

OVERVIEW

The imageViewer can be inserted in a productBox to display the RMOImages of the currentProduct.

It allows the end-user to select one of the RMOImages attached to the product and then zoom on the image.

The ‘On’ images are used to display the imageViewer thumbnails. The ‘Current’ one is used to display the currently selected image in the main part of the viewer. The ‘Current’ image is replaced by the ‘Zoom’ image by clicking on the currentImage.

If a 3D file is defined on the current product, the '3D' image will replace the 'Current' one. The 3D file will be displayed in a viewer and the user will be able to interact with the object (zoom, rotate

...).



Tip:

By default the imageViewer displays the first attached RMOImage.

If only one RMO image is attached to the product, the bar containing the thumbnails is not

displayed.

If no RMO image is attached to the product, the bar containing the thumbnails is not displayed and a default image is displayed in the viewer.

<resource name="imageViewer.noImageFound"> … </resource>

If the current product has only a '3D' image defined, a generic 3D logo will be displayed as 'On' image.

<resource name="3dViewer.logo"> … </resource>

Warning:

Use of 3D resources (Catalog)

  • The supported formats are the following:
    • .obj files are supported. See notes below.
    • .wrl files (VRML) are supported for version VRML 2.0+. See notes below.
    • .3ds files are not supported as is. As a workaround, a common workflow is to export file from 3DSMax as .obj file, or go through a converter
  • When uploading a model in the RMO Gallery, you can either upload a model only, in the 3D image column. In that case, the model will be rendered, if compatible, at runtime with a default texture applied automatically. You can also deploy your model in a ZIP archive containing the model and a texture file. By doing so, the content of the ZIP file will be automatically extracted, storing the model in the 3D image column, and the texture to apply, if any, in the 3D texture column.
  • If no texture is provided in the Gallery, 3D models uploaded in the Designer have to be formatted in a way that supports the automated appliance of a default texture.
  • The 3D viewer is a WebGL technology. It might not be supported by your browser if it’s not

    recent enough.

ATTRIBUTES DETAILS

SUB-ELTS ATTRIBUTES VALUE
cssName #IMPLIED
mode: sticker bar visible or not on / off
framedBox: generates the panel header and footer of the box on / off
widthPercent: percentage of occupancy in the total width of the container/page #IMPLIED
heightPercent: percentage of occupancy in the total height of the container/page #IMPLIED
autoSize on / off
hzAlignment: gives the horizontal alignment of the box in its container/ page left / right / center / justified
vtAlignment: gives the vertical alignment of the box in its container/ page up / down / middle / distributed
rmoUserType : userType to be used for the RMO display #IMPLIED “*” means any userType

Example:

XML Sample

<imageViewer mode="on" cssName="imageViewer" autosize="on" widthPercent="50" heightPercent="50" hzAlignment="left" vtAlignment="up" rmoUserType="productPage" framedBox="off" titleTranslationName="imageViewer.title"/>:

VISUAL IDENTITY

Tip:

The following translation is associated to the component:

<translation name="imageViewer.reset.label">Reset</translation>

Mapping between CSS Classes and component structure



galleryViewer

OVERVIEW

The galleryViewer organizes the RMO gallery and allows the end-user to browse the Images, Plugins and Files/Reports attached to:

  • the current product if integrated in a productBox or in a productTab.
  • the current collection if integrated in a collectionPage.
  • the currently selected element (if a rollingSelector is used within the galleryViewer)

The user can browse the gallery by clicking on the thumbnails or click on the arrows in the viewer part of the component.

If a 3D file is defined on the current product, the '3D' image will replace the 'Current' one. The 3D file will be displayed in a viewer and the user will be able to interact with the object (zoom, rotate

...).

If the current product has only a '3D' image defined, a generic 3D logo will be displayed as 'On' image.

By default the first RMO element is selected and displayed in the viewer part.

Warning:

Use of 3D resources

  • The supported formats are the following:
    • .obj files are supported. See notes below.
    • .wrl files (VRML) are supported for version VRML 2.0+. See notes below.
    • .3ds files are not supported as is. As a workaround, a common workflow is to export file from 3DSMax as .obj file, or go through a converter
  • When uploading a model in the RMO Gallery, you can either upload a model only, in the 3D image column. In that case, the model will be rendered, if compatible, at runtime with a default texture applied automatically. You can also deploy your model in a ZIP archive containing the

    model and a texture file. By doing so, the content of the ZIP file will be automatically extracted, storing the model in the 3D image column, and the texture to apply, if any, in the 3D texture column.

  • If no texture is provided in the Gallery, 3D models uploaded in the Designer have to be formatted in a way that supports the automated appliance of a default texture.
  • The 3D viewer is a WebGL technology. It might not be supported by your browser if it’s not recent enough.



    Tip:

    Images:

    The galleryViewer is compatible with any image format.

    Like for the imageViewer, the ‘On’ images are used to display the thumbnails in the left part. The ‘Current’ one is used to display the currently selected image in the main part of the viewer. The ‘Current’ image is replaced by the ‘Zoom’ image thanks when the user clicks on the ‘Current’ image.

    Files:

    The galleryViewer is compatible with any file format, provided that the end-user browser supports the corresponding file plugin (example PDF, Word etc.)

    When the user clicks on a file, then the file is either displayed via a frame in the right part of the component or sent to the web browser to allow the download.

    Plugins:

    The galleryViewer is compatible with SWF plugin files::

    either the RMO plugin only references the SWF file. In that case, the SWF is displayed in the viewer part

  • or the RMO plugin references a file and a portion of HTML code related to the file. In that case, the HTML portion is directly inserted into the rendered page, in the right part of the galleryViewer.

ATTRIBUTES DETAILS

SUB-ELTS ATTRIBUTES VALUE
cssName #IMPLIED
mode: galleryViewer visible or not on / off
framedBox: generates the panel header and footer of the box on / off
widthPercent: percentage of occupancy in the total width of the container/page #IMPLIED
heightPercent: percentage of occupancy in the total height of the container/page #IMPLIED
autoSize on / off
hzAlignment: gives the horizontal alignment of the box in its container/ page left / right / center / justified
SUB-ELTS ATTRIBUTES VALUE
vtAlignment: gives the vertical alignment of the box in its container/ page up / down / middle / distributed
content: type of the items to be displayed [- Not yet implemented -] file / image / plugin The attribute can be multivalued and ordered e.g. ‘file,plugin’
rmoUserType : userType to be used for the RMOs #IMPLIED “*” means any userType
rollingSelector When the gallery is inserted in a collectionPage, it allows to select which subCollection or product RMO will be displayed in the viewer. rollingSelector

Example:

XML Sample

<galleryViewer mode="on" cssName="galleryViewer" autosize="on" widthPercent="100" heightPercent="100" hzAlignment="left" vtAlignment="up" titleResourceName="" titleTranslationName="rollingSelectorCL.title" rmoUserType="productPage" framedBox="on" >

<!-- with rolling selector -->

<rollingSelector ... />

</galleryViewer>

VISUAL IDENTITY

Tip:

The following translations are associated to the component:

<translation name="galleryViewer.image.label"> Gallery</translation>:

<translation name="galleryViewer.file.label"> Attached Files</translation>

<translation name="galleryViewer.plugin.label"> Videos</translation>

Mapping between CSS Classes and component structure