Skip navigation

Developer Community

2 Posts authored by: Jaime Honaker Employee

Embedded Help and Guided Tours are getting a boost in the Jakarta release to assist users. While both have been available since the Helsinki release, with Jakarta comes the introduction of the Embedded Help app, allowing administrators to create customized versions of both Embedded Help and Guided Tours. As you might expect, we are as excited about this as you are!




The new application, called Embedded Help, includes the following modules: Help Content, Role Priority, and includes the Guided Tour Designer, allowing you to create guided tours and list existing ones.

embedded help modules.png


What is Embedded Help?

Embedded Help provides focused help to a user in a UI page based on their role. When you click the help icon, Embedded Help content appears in the right sidebar. If there is embedded help for the current UI page, the help icon has this indicator, showing there is embedded help available:

Embedded help indicator on help icon

Organizations now have the ability to add or replace custom embedded help content to suit their business needs.

If embedded help is not available for a topic, the User Guide and documentation site search is available in the sidebar.



If you click the Search Documentation link, a documentation search is performed for the page you started from. For example, if you click Search Documentation from the Catalog Tasks list view, the search term becomes Catalog Task, and any matching information is listed.


What are the benefits of Embedded Help?

Embedded Help provides help for custom applications, focused instructions aligned with specific business purposes, embedded help content where it currently does not exist, and different content based on different roles.


Additional information available for administrators:


What is a Guided Tour?

Guided Tours demonstrate how to use a feature, using different elements to provide steps, instruction, and how to move along within the guided tour. They show you how to do something within the instance, such as how to perform a task.


Using the Guided Tour Designer, administrators can now create customized guided tours. An administrator creates a guided tour within the instance. If the guided tour shows you how to insert a record, at the end of the tour the record now exists in the database. For example, if a manager completes a guided tour to create a department report, that report becomes available to everyone in that department.


Parts of a Guided Tour include: steps which provide definition or instruction, callouts to indicate current steps and how to proceed with additional instruction, and triggers to move the tour along, like clicking Enter or Next.

guided tour complete.png

In the above example, each of these elements exist. The step is the action. For example, the Delegates list opens, with the new record added. The callout is the box with the upward pointing arrow box explaining what has just been accomplished, or the action that has just been completed. The trigger is the Done button, concluding the tour.


Each callout should be selected based on the direction it is pointing; it must touch the element it is assigned to.


To access an existing guided tour, navigate to a page with a guided tour. If your role is assigned to the tour, the Help panel opens and the Take a Tour button is available at the bottom. If there is more than one tour available to choose from, like the image below, just select the correct tour from the list. Tours might also be available to various roles for access and availability.


guided tour.png


Additional Information available for administrators:


Customizing Embedded Help and Guided Tours allow administrators to help employees perform their jobs better and more efficiently. Updating and modifying embedded help provides targeted assistance to a user. Creating customized guided tours let administrators demonstrate step-by-step walkthroughs, navigating through the details of what the user is doing.


Looking for more information? Check out the Embedded Help Release notes for Jakarta, or watch a Guided Tour unfold with josh.nerius' Getting Started with the Guided Tour Designer in Jakarta.

With the Jakarta release, we have made accessibility updates throughout the platform in relation to 508 compliance and WCAG 2.0 A and AA standards. While basic accessibility is included as part of the platform, these enhancements are meant to make the system more available and understandable to all users.



What is Section 508 and WCAG?

Before jumping into the accessibility enhancements in Jakarta, here's a little background on why we have them in place. Section 508 was signed into law in 1998, allowing for equal access to electronic and information technology. This means that a system is operated in a variety of different ways, not relying on a particular sense or ability of the operator. This expanded the previous Rehabilitation Act of 1973, as a result of the invention of the Internet, ensuring accessibility to web content. The Web Content Accessibility Guidelines (WCAG) 2.0 are a set of guidelines organized under four principles: websites must be perceivable, operable, understandable, and robust. Our goal in following these guidelines and principles is to make sure the interface is accessible to users with disabilities.


What accessibility enhancements were made in Jakarta?

We made several changes to accessibility throughout the platform. Here is a quick overview of each, but you can find more information for feature-specific changes in the corresponding documentation.


Contrast UI theme

New in the Jakarta release, the Contrast UI theme provides more options and accessibility for those who have a hard time distinguishing colors with low contrast levels. You can even make these changes yourself. The theme is one of the system settings for the user interface that you can easily customize. I'll show you how to enable the Contrast UI theme in the next section.


Color and style accessibility improvements

In addition to the Contrast UI theme, these color and style changes make the platform more accessible:

  • Improvements to alert color and font styles to make them more visible.
  • Switch any color-heavy graphics, such as charts or graphs, to use patterns in addition to colors.

Accessibility enabled charts.png


Keyboard accessibility improvements

These keyboard accessibility features allow users to navigate the platform using a keyboard:

  • Tab order is consistent with expectations.
  • Button labeling.
  • Improved access to different UI elements.
  • Consistency for fields and UI elements that have hints (or tooltips).
  • Tab-through and arrow keys move items around in a slushbucket.
  • When focused on tabs, right and left arrow keys switch between tabs.
  • Arrow keys work within menus to navigate between entries.


Improvements for screen readers

These screen reader accessibility improvements make the platform accessible to screen readers:

  • Screen readers announce when a page reloads.
  • Add alternative text to styles. For example, you can add alternative text to the VIP style icon so that screen readers can call it out.
  • In Connect, screen readers inform users when a member leaves a conversation, when a user is added or removed from a chat, and when uploads complete or fail.


For a full list of features in Jakarta that support WCAG to make the interface accessible to users, view the product documentation here: Accessibility features


How to enable accessibility in the platform

For accessibility within the platform, no additional configuration is needed and users just need to enable a user preference to make it more accessible. This turns on tabbing for each page, including every item, with the option to skip to different places on a page.


Use the gear icon, which is located within the banner frame, to display the system settings pop-up window (shown below), and the system settings are organized by tab. Those users with an admin role see the Switch to UI15 button if UI16 is activated.


To enable accessibility:

  • Users can enable this option from the system settings menu > General tab
  • Admins can do this on behalf of users by navigating to User Administration > User preferences, and searching for the preference glide.ui.accessibility


This is just a small sample as to what is available with the release of Jakarta. Stay tuned for more articles and updates coming your way soon!

Filter Blog

By date: By tag: