Splashtip Use in ROES Web

ROES Support Knowledgebase

Using Splashtip in ROES Web

Use this article to configure a Splashtip in ROES Web as a welcome page, information center, or guided landing page for your customers.

Product: ROES Web / Template Tool Category: Splashtip Audience: Lab / Support Article ID: 85
Common need
A lab wants a splash page in ROES Web that welcomes customers, highlights current specials, explains holiday hours, or guides users directly to product groups and templates.

Overview

New in ROES Web, the Splashtip can be used as a welcome page, information center, and guide to your ROES app. Splashtip pages can be as decorative as you like, using tables, images, and ROES URLs embedded in the page to help guide customers to product groups, display current sales, indicate closings, or show holiday hours.

The Splashtip element is added off the root of the templates file in Template Tool. As in ROES Desktop, the text attribute should be set to a full https:// URL that points to the desired HTML file.

Example splashtip page in ROES Web
Example splashtip page used as a welcome and information center in ROES Web.
If this image does not display, open it directly: splashlatest.PNG
Initial splash display in ROES Web
Another example of a splashtip page shown when ROES Web loads.
If this image does not display, open it directly: splash-initial.PNG

Splashtip Setup in ROES Web

1

Add the Splashtip element at the root of the templates file

In Template Tool, add the Splashtip element off the root of the templates file.

2

Set the label attribute

Use the label attribute to set the button name users can click to reopen the splash page later, similar to returning to the Home screen in ROES Desktop.

3

Set the text attribute to the splash page URL

In the text attribute, enter a full https:// URL to the HTML file you want to display. Any images or links referenced by that HTML should also use secure https:// URLs.

Splashtip label button in ROES Web
Use the label attribute to give users a button they can click to reopen the splash page.
If this image does not display, open it directly: splash-label.PNG

ROES URL Support in Splash Pages

ROES URLs are supported in ROES Web splash pages, but the splash page HTML must include the ROES URL emitter script in the page body.

<body> <script type="module" src="https://www.roesweb.com/roesUrlEmitter.js"></script>

ROES URLs

ROES URLs are links added into the page using roes:// followed by a path made from u_id values to the desired location in the templates collection.

For example, if your catalog u_id is Canvas and the group to jump to has a u_id of wrappedcanvas, the ROES URL would be:

roes://Canvas/wrappedcanvas

If the first template has a u_id of f6yhe3r, the URL would be:

roes://Canvas/wrappedcanvas/f6yhe3r

ROES Web-Specific URL Attributes

view

Use either products or workspace. Using view="products" keeps the customer in the product browser and works well for catalogs or groups. Using view="workspace" is required to jump directly to a specific template and can also be used for catalogs or groups.

keep-open

This can be set to true or false. When set to true, the splash remains open, which can be useful when opening a secondary splash page. When set to false, the splash closes after the selection is made.

ROES URL Examples Preserved from Source HTML

Jump to a Fine Art catalog, keep the splash open, and stay in the product browser:

<a href="roes://FineArt" keep-splash-open="true" view="products">Fine Art Cat, Keep Open</a><br><br>

Jump straight to a cards group in the workspace and close the splash:

<a href="roes://RUG2017/Cards/4x8" keep-splash-open="false" view="workspace">Greet Cards group in workspace, close splash</a><br><br>

Jump directly to the first card in the group:

<a href="roes://RUG2017/Cards/4x8/126b4c2dd75:-7ba9" keep-splash-open="false" view="workspace">Greet Card 1 workspace, close splash</a><br><br>

Compatibility Note

If you use both ROES Web and ROES Desktop, these extra ROES Web values do not affect ROES Desktop, so the same splash can be used if the templates collection is essentially the same for both platforms.

Expected Result

ROES Web should display the configured splash page on load, allow users to reopen it using the label button, and support ROES URL navigation from within the splash page when the emitter script is included.

Escalation Notes

  • Confirm the Splashtip element is added at the root of the templates file.
  • Confirm the text attribute points to a valid https:// URL.
  • Confirm all images and links used by the splash page also use https:// URLs.
  • Confirm the label attribute is set if users should be able to reopen the splash page from a button.
  • For ROES URLs, confirm the u_id path is correct.
  • For ROES URLs, confirm the page body includes the RoesUrlemitter script.
Suggested keywords: Splashtip, ROES Web, splash page, Template Tool, label attribute, text attribute, ROES URLs, roesUrlEmitter, welcome page, home screen

Article Details

Article ID:
85
Category:
Views:
1,153