Oracle® Custom Guided Learning Service Frequently Asked ... · Oracle Custom Guided Learning Service FAQ 8 Introduction & Overview of Oracle Custom Guided Learning Service Note:

Oracle Custom Guided Learning Service FAQ 1

Oracle® Custom Guided Learning Service

Frequently Asked Questions

Release 1.0

F19512-03

February 2020


Copyright © 2019, 2020, Oracle and/or its affiliates.

This software and related documentation are provided under a license agreement containing

restrictions on use and disclosure and are protected by intellectual property laws. Except as

expressly permitted in your license agreement or allowed by law, you may not use, copy,

reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or

display any part, in anyform, or by any means. Reverse engineering, disassembly, or

decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be

errorfree. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone

licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system,

integrated software, any programs installed on the hardware, and/or documentation, delivered to

U.S. Government end users are "commercial computer software" pursuant to the applicable

Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use,

duplication, disclosure, modification, and adaptation of the programs, including any operating

system, integrated software, any programs installed on the hardware, and/or documentation, shall

be subject to license terms and license restrictions applicable to the programs. No other rights are

granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management

applications. It is not developed or intended for use in any inherently dangerous applications,

including applications that may create a risk of personal injury. If you use this software or

hardware in dangerous applications, then you shall be responsible to take all appropriate fail-

safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its

affiliates disclaim any liability for any damages caused by use of this software or hardware in

dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be

trademarks of their respective owners.

This software or hardware and documentation may provide access to or information about

content, products, and services from third parties. Oracle Corporation and its affiliates are not

responsible for and expressly disclaim all warranties of any kind with respect to third-party

content, products, and services unless otherwise set forth in an applicable agreement between

you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs,

or damages incurred due to your access to or use of third-party content, products, or services,

except as set forth in an applicable agreement between you and Oracle.


.............................................................................................................. 1

Oracle® Custom Guided Learning Service .................................................................................... 1

Frequently Asked Questions ........................................................................................................... 1

Introduction & Overview of Oracle Custom Guided Learning Service ......................................... 8

What are Branches and Filling Forms .......................................................................................... 10

Changing the flow based on a user’s choice ................................................................................. 11

Cloning a Tooltip .......................................................................................................................... 13

Context Sensitive Help (CSH) using Oracle Guided Learning .................................................... 15

Contextual Help Links .................................................................................................................. 15

Contextual Page Level Help ......................................................................................................... 29

Create a customer help widget ...................................................................................................... 31

Customization and Personalization Methods ................................................................................ 32

Deployment Best Practices ........................................................................................................... 34

Editing Step Branches ................................................................................................................... 34

Editor Manual ............................................................................................................................... 39

Embedding an iframe in a Guided Learning Step ......................................................................... 47

Expanded Content Editor Reference ............................................................................................. 51

Exporting and Importing Guided Content .................................................................................... 54

Goals – Measuring Product Training ............................................................................................ 57

Guide Activation Conditions ........................................................................................................ 58

Help Widget Explained ................................................................................................................. 63

How to Launch a Guide Based on User Interaction – Create a “Launcher Guide” ...................... 65

Integrating Oracle Guided Learning with your Learning Management System (LMS) ............... 66

Oracle Guided Learning Setup Instructions .................................................................................. 66

JavaScript API .............................................................................................................................. 71

Release notes with Oracle Guided Learning ................................................................................. 80

Setup Oracle Guided Learning in a Single Page Application (SPA) ............................................ 82

Step Conditions and Page Conditions ........................................................................................... 84

Step conditions explained ............................................................................................................. 85

Task List/Onboarding Widget....................................................................................................... 86

Understanding Guide Options....................................................................................................... 93


URL configuration for a guide ...................................................................................................... 94

User Feedback ............................................................................................................................... 95

User Report ................................................................................................................................... 97

Using Branches for Form Validation ............................................................................................ 99

Add a background image to a tip ................................................................................................ 101

Advance on click does not work ................................................................................................. 101

Assigning multiple roles to guides .............................................................................................. 102

Autoload a closed guide .............................................................................................................. 102

Blocked:CSP error when trying to load Guided Learning .......................................................... 102

Can ‘show tip on hover’ and ‘disable element’ be used together? ............................................. 103

Can a guide be launched automatically from an email campaign or a knowledge-base article? 104

Can a guide work across multiple domains?............................................................................... 105

Can I change the element selection algorithm? .......................................................................... 106

Can I change the order of the guides in the start panel? ............................................................. 107

Can I embed a MP4 or AVI movie in a tooltip? ......................................................................... 107

Can I get the screen to scroll so we can actually see the section where the tip is pointing? ...... 107

Can I hide a tooltip if another tooltip is displayed? .................................................................... 107

Can I hide the help widget? ........................................................................................................ 108

Can I highlight the Help Widget (the Guide tab on the right hand side) in a guide? ................. 109

Can I launch a guide based if a user field contains a certain value? ........................................... 109

Can I launch a guide when a user is stuck ? ............................................................................... 110

Can I launch two guides simultaneously? ................................................................................... 111

Can I link one guide to another? ................................................................................................. 111

Can I open more than one tooltip at once? ................................................................................. 113

Can I remove the Powered by footer?......................................................................................... 113

Can I start a guide on a particular step using the public api ....................................................... 114

Can I target a guide to a list of users? ......................................................................................... 114

Can I use Guided Learning even if a user is not logged in? ....................................................... 115

Can you have a guide with only one step, and not show the step counter? ................................ 116

Can you set a condition for a guide to only show once? ............................................................ 116

Conceptually, is it better to design a tour guide, use steps to actually show the sequence of clicks

OR a combination of both? ......................................................................................................... 116

Does Guided Learning provide functionality for selecting elements within an iframe? ............ 117

Embedding an IFrame in a Guided Learning Step...................................................................... 117

Filtering guide in the guides page ............................................................................................... 121


Guide does not scroll .................................................................................................................. 122

Guide feedback widget does not display .................................................................................... 122

Guide Report ............................................................................................................................... 123

Help widget does not load........................................................................................................... 124

Highlight an item from the help widget ...................................................................................... 125

How can I embed a video in a guide? ......................................................................................... 126

How do I make an image a session variable? ............................................................................. 128

How do I select a column? .......................................................................................................... 129

How do I skip the navigation steps if I'm already on the right page? ......................................... 131

How to change the help icon ....................................................................................................... 132

How to launch a guide from another guide? ............................................................................... 133

How to prevent a tooltip from hiding a drop down menu? ......................................................... 134

How to setup a remind me later button? ..................................................................................... 136

I cannot preview a guide that my colleague created. .................................................................. 137

If I want a guide to only show when referenced/linked from another guide but I do not want it to

be in the help guide list how do I set the guide activation? ........................................................ 137

I have made some changes to a guide and saved them accidentally, can this be reverted? ........ 137

I have successfully setup Guided Learning but the Help Widget does not appear ..................... 138

I need to create a guide on a page with a dynamic URL, what are the best practices? .............. 138

Invisible Steps - React to User Interactions ................................................................................ 139

I receive the message "A tip is waiting for the page to refresh". What does that mean exactly? 140

I setup Guided Learning and none of my guides are showing, what's missing? ........................ 141

Is it possible to change the font to an option not available within the dropdown list? We would

like to add a font called "Proxima Nova" if possible. ................................................................. 141

Is it possible to change the text on the buttons in the interactive tour? Either by having the same

language shown for all users, or making the button text dependent on a user setting? .............. 141

Is it possible to display multiple tooltips at the same time? ....................................................... 142

Is it possible to make the overlay to make the overlay a little lighter? ....................................... 142

Is it possible to segment tooltips based on conditions connected to user data, such as the

user_role field we'd be passing on? ............................................................................................ 143

Is there a way to search for guides by keyword through the Guided Learning JS API? ............ 143

I want a guide to show on 2 different pages with different URLs. How should I set up the

conditions? .................................................................................................................................. 144

I want to create a new guide that is based on another guide I have already created. Is this

possible? ...................................................................................................................................... 144

I want to enable user to proceed upon clicking the spacebar ...................................................... 144


I would like guide to launch only on the root "/" path of my website. ....................................... 145

Multi-Language Support ............................................................................................................. 145

My application uses popup windows/multiple browser tabs, what is the best way to create

guides? ........................................................................................................................................ 146

My guide does not load on the right URL .................................................................................. 146

No checkboxes were selected ..................................................................................................... 146

Our product is internal, behind a firewall, can we still create Guided Learning guides for them?

..................................................................................................................................................... 147

Scroll parent container - Handling internal scrollbars ................................................................ 147

So if my application has a form and the user clicks on close instead of submit, I would like for

the guide to end then. Is that possible? ....................................................................................... 148

Switching language in runtime ................................................................................................... 148

Unable to edit guide options ....................................................................................................... 149

Use an image map to launch a guide .......................................................................................... 150

Video does not show in center screen ......................................................................................... 150

Video not showing in a tip .......................................................................................................... 151

We have clients who use different terminology such as "Intake" instead of "Class". Is there any

way to have two different terminologies depending on the viewer? .......................................... 152

We use a different subdomain (sub-domain) for each customer; can the same set of guides be

used on all domains by all customers? ........................................................................................ 153

We use angularJS, do we have to use the SPA API for every call to notify Guided Learning what

page has been loaded? ................................................................................................................. 153

What does 'Active', 'Testing' and 'Offline' mean? ....................................................................... 153

What if I want the guide to advance when user clicks on ANY element in a list? ..................... 154

What is a beacon? ....................................................................................................................... 156

What is Advanced visibility check? ............................................................................................ 157

What is an API name?................................................................................................................. 157

What is fieldsNotSet error? ......................................................................................................... 158

What is routeNotSet error? ......................................................................................................... 158

What is the best way to embed a simple audio file into a step?.................................................. 158

What is the best way to guide a user while filling out a form? ................................................... 159

What is the difference between the two Oracle Guided Learning deployments? ....................... 159

What is the difference between Viewer, Editor and Owner? ...................................................... 159

What is the help icon? ................................................................................................................. 160

What is the start panel? ............................................................................................................... 160


When I copy the URL of the page I want the guide to start from, it does not load correctly in the

browser ........................................................................................................................................ 161

When I see the statics on the use of the guides, I have been able to see three indicators:

Satisfaction, completion and engagement. How do you calculate them? ................................... 161

When I use two or more activation options in a guide, do they work like OR or like AND

conditions? .................................................................................................................................. 162

Why doesn't my guide show up? ................................................................................................ 162


Introduction & Overview of Oracle Custom

Guided Learning Service

Note: Oracle acquired Iridize in 2018 and the rebranding is not yet complete. Iridize will be

rebranded Oracle Custom Guided Learning Service, referred to herein as Guided Learning. You

might come across the Iridize name in this document and in the application until the rebranding

is complete.

Oracle Custom Guided Learning Service is an Enterprise cloud platform that supports the

creation of personalized, guided and contextual user on-boarding visualizations - to simplify and

accelerate your adoption of Oracle Cloud applications or other HTML applications. With guided

learning you can create in-application guidance to simplify and accelerate your adoption of the

Oracle Cloud applications or other HTML applications.

Guided Learning offers the following features:

• Interactive Guides - Guides allow you to visually walk users through a process, step-by-

step to help them complete a task. For example, you could step users through the process

of submitting an expense form, and enforce that the correct fields are filled out as they

complete the process.

• Smart Pop-Ups - Used for broadcast messaging, broadcast messaging to announce new

features and functions, welcome new users, or let your users know about upcoming

events. You can configure Smart Pop-ups to appear automatically, to specific users, for a

given duration. For example, a pop-up could tells users about a new application and

provide a video that they can watch to learn more about

• Smart Tips - Allow you to add context-sensitive help, hover text, or supplemental

information to buttons, labels, and other screen elements.

• Task Lists - Allow you to group your process guides together into clear task lists that

inform users in what order they need to complete processes. For example on-boarding

new users - including getting started, forms needing submitting, benefits, etc.

• And More - Guided learning also supports the creation of product tours, rich media

guides, beacons, invisible smart tips, and linking to additional content.

The Guided Learning application is composed of two primary parts

• Dashboard - View all guides that you have in place, or initiate the creation or editing of

a guide.

• Editor - Allows for detailed capture and settings to support the needs of your guide.


What are Branches and Filling Forms

Branching is one of the most powerful features in the Guided Learning editor. It can be used to create very

complex flows.

Still, its most common use-case isn't all that complex. The most common use-case for using branches is to

control the flow of the guide based on user choices in forms.

Real Life Example - Linkedin Job Search

Below is an image of the Linkedin job search form,

Now, for the sake of this example, let's say that if the user selects United States we want to recommend that

he/she also enters a Postal Code. If a different country is selected we'll point the user directly to the search

button.

So, our guide will look like this:

1. Select a country 2. It is recommended to enter a postal code for searches inside the US.

(this will only display if US was selected)

3. Click Search

The 'natural' flow of a Guided Learning guide is to go from one step to the next; so 1 than 2 than 3. In our case

we want Guided Learning to jump directly from step #1 to step #3 if the user did NOT select US.

In step #1, under the 'advanced settings' click to add a branch.


Select Jump to Step, choose step #3 from the drop down menu.

Now we need to make sure this branch is activated only if the user did NOT select US. So let's click on Add

Conditions.

Last step, choose the form field - drop down condition and hover over the drop down to select it. Guided

Learning will automatically fill the selected value (e.g. US) for you.

Changing the flow based on a user’s choice

Sometimes you need to ask the user a question and change the flow of the guide based on the

answer that the user provides. The answer does not necessary have to be something in the UI of

the application it can be something specific to what the user wants to do now.

A good example of this is creating a troubleshooting guide or as some call it a diagnostics' guide.

You have probably already been on one of these phone calls with a customer support representative

(CSR). You explain the problem to the CSR and in return s/he asks you a list of questions. Each

question depends on the answer you gave to the one before it. In the end of these questions,

hopefully, your problem is solved.

A troubleshooting/diagnostics' guide can be of tremendous help to either party here:

1. If you didn't have to call anyone to ask these questions you'd be happy to service yourself!

2. If the CSR did NOT have to read this list of questions from a printed document or worse her/his

torn notebook, the service would be much quicker and less prone to error.

Actual Use Case

Let's see this in action with an real life scenario - "smartphone battery does not charge"


This would be the document your CSR will be reading from:

1. CSR: Is the wall socket providing power? Try connecting the charger to a another socket that you

know for certain works. For example, a socket you have a working lamp connected to.

2. You (option 1): I changed the socket and it works! --> FINISH

3. You (option 2): Still nothing --> GOTO 4

4. CSR: Are you charging from a USB port on a computer?

5. You (option 1): No --> GOTO 7

6. You (option 2): Yes --> GOTO 8

7. CSR: Contact your service provider. The phone may be damaged.

8. CSR: ensure that the computer is turned on. Some computers provide no USB power when they’re

turned off.

9. You (option 1): I turned on my computer and it works! --> FINISH

10. You (option 2): Still nothing --> GOTO 8

The Guided Learning Way - Session Variables

Guided Learning allows you to ask the user a question inside a tooltip; It saves the user's answer and

allows you to change the flow of the guide accordingly using Branches.

The tooltip above consolidates the 3 steps in our list into a single tooltip. To configure the possible

answers we will need to click on the session variables button and configure each answer as can be

seen in the image below.


Notice that all answers should have the same value (e.g. q1) set as the Variable Name.

What we need to do next is to alter the guide flow based on the answer that the user clicks on. To do

this we will setup a branch to jump to the relevant step. In our example, if the user click Yes! we

should end the guide; Guided Learning will default to going to the following question hence we do

not need to creating any additional settings for the case that the user selected Still Nothing

[The above outlines the condition that needs to be added to the branch]

Cloning a Tooltip

Cloning a tooltip is useful when


1. You have created a beautiful tooltip, with customized settings and styles. And you want to create

another one just like it

2. You have created a step with multiple tooltips and you want to move one of those tooltips to a

new step

3. You want to move a tooltip, you have created, into an existing step (e.g. to branch the guide)

Cloning will create an identical copy with all the text, styling, conditions, branches and any other

setting.

To clone a tooltip, in the editor, you will need to select it first.

Once selected, click on the clone icon:

The clone dialog will appear,

1. Choose whether you want to clone only the selected tip (default) or all tooltips


2. In the drop-down select where you want to clone to. This can be the same step (default), a new

step (the new step will be created immediately after the selected step), or any other step in your

guide.

3. Click the Clone button

Context Sensitive Help (CSH) using Oracle

Guided Learning

"Context-sensitive help is a kind of online help that is obtained from a specific point in the state of

the software, providing help for the situation that is associated with that state."

This definition is taken from this wikipedia article. Also from this article, "Context-sensitive help can

be implemented using tooltips" which is exactly where Oracle Guided Learning comes in.

While you can use Guided Learning to create flows to guide users through complex procedures,

sometimes, some extra information that appears when you put your mouse cursor over a button or a

form field can do a world of good.

In Guided Learning we call these on-hover tooltips. To add them to any page in your application

please do the following:

1. In the display settings of each tooltip, remember to:

• check 'Hide Next button'

• check 'Hide Close button'

• uncheck 'Show Back button'

• check 'Hide step count footer'

2. In the activation settings of each tooltip, remember to set 'Show on hover'

3. In the step settings section uncheck 'Highlight Target Element'

Contextual Help Links

Process Overview

Contextual help links appear in the Help Widget as set up with Oracle Guided Learning.

Links can be created in two methods:

1. Using the Guided Learning user interface to build/edit guides which are just links.

2. Using a bulk upload method that requires loading the links into a spreadsheet and using that

Guided Learning’s import function to load them.

This document explains this second method.

https://en.wikipedia.org/wiki/Online_helphttps://en.wikipedia.org/wiki/Context-sensitive_help


1. Creating/Editing the Spreadsheet

File Format

The Guided Learning web site accepts any Comma-Separated Values (CSV) file. One can use a

standard Excel spreadsheet, and convert to CSV prior to upload.

Guided Learning requires that the first line of the spreadsheet contain the column names. All

subsequent lines consist of data.

Columns

The following displays, at the time of this writing, the spreadsheet column names, that must appear

in the order shown.

But see the note following the list of columns.


Guided Learning has built some flexibility into the columns. In particular, no conditions are strictly

required and also you may add an arbitrary number of conditions as required.

When you want to add another condition, add the following column names:

conditionn_code

conditionn_summary

conditionn_tags

where n represents the next higher integer after the last that has appeared.

Place these columns to follow the existing pattern. For example, if you were to add a fourth condition

to the above,


add condition4_code and condition4_summary after condition3_code and condition4_summary.

Then add condition4_tags after condition3_tags.

Cell contents

Format individual cells as follows.


3. Preliminary Upload

You could just upload your spreadsheet and be done, but it’s a safer plan to first test it in the

development environment and once you have verified that everything looks okay, go ahead and

make it live in the production environment.

By the way, there can be about a five-minute delay before your new links become live as Guided

Learning sends them to web service. So if you don’t see your links right away, be patient as they may

yet appear. Unfortunately there is no notification that the links are ready.

Procedure:

1. When you finish preparing the spreadsheet, navigate to https://iridize.com/account/settings

2. Scroll down to find EXPORT / IMPORT LINKS:

3. Choose Choose File.

• Guided Learning displays a file chooser dialog.

1. Choose your spreadsheet and Open.

2. Check the Delete box if you want to remove any existing links.

3. Do not check the Publish all box.

4. Choose Import.

• Guided Learning begins installation of your links.

4. Testing

1. Testing is recommended.

5. Troubleshooting

Note that there can be about a five-minute delay before your new links become live as Guided

Learning sends them our web service. So if you don’t see your links right away, be patient as they

may yet appear. Unfortunately there is no notification that the links are ready.

1. Actual Upload

When you have tested the links and are ready to upload to the live product, the process is nearly the

same as described in the Preliminary Upload above. The only change is to now check the Publish

all box. Here are the details to make it explicit:

https://iridize.com/account/settings


1. When you finish preparing the spreadsheet, navigate to https://iridize.com/account/settings


3. Choose Choose File.


4. Choose your spreadsheet and Open.

5. Check the Delete box if you want to remove any existing links.

6. Check the Publish all box.

7. Choose Import.

• Guided Learning begins installation of your links.

Remember that there can be about a five-minute delay before your new links become live as Guided

Learning sends them to web services. So if you don’t see your links right away, be patient as they

may yet appear. Unfortunately there is no notification that the links are ready.

2. Download

You may also download the Guided Learning link data and save it as a CSV that you can examine

using spreadsheet software. This might be useful if, for example your copy is lost or corrupted, or for

debugging purposes. (Another way to debug is to use the Guides user interface at iridize.com.)

Download procedure:

1. Navigate to https://iridize.com/account/settings

2. Login if necessary.


4. Choose Export.


5. Choose the file name and location for saving.

3. Hints and Tips

A good way to make a link is to copy and customize an existing one of similar type.

One way to copy an entire row is to start at one end, hold down shift and then press the arrow key

until reaching the other end. Then copy-paste.

Things to check if new links do not appear:

• Have you given Guided Learning enough time – about five minutes – to get the links uploaded

to web services?

https://iridize.com/account/settingshttp://iridize.com/https://iridize.com/account/settings


• Is the publish column set to 1 (or TRUE) or did you check the Publish All box when importing?

• If you created your link by copying another one and modifying that, did you leave

the api_namecolumn blank for the new one?

If you’re really unable to figure out what has gone wrong you can always go to the Guided Learning

site and check the guides manually. Just search for significant keywords in your label.

Contextual Page Level Help

Let's say that a new feature has been added to your application and you've written a detailed article

about how to use this feature and have added this article to your knowledge-base/help-center/wiki.

How do I get the users who use this feature to read the article and to see the full power of the

feature?

What if you could:

1. Open a splash window for the first 3 times the user lands on the feature page

2. Embed a 30 seconds overview video of this feature

3. Write the key benefits of using this feature

4. Link to your detailed article for more information

Actually, you can do this! We call this Contextual Page Level Help.

Here is how Guided Learning can help you look like a pro:

• Create a new walk-through guide on your guides page

• Make the first step a splash.

• Use the display settings to change the placement of the tip to be inside-top-right

https://iridize.com/account/manage/


• Now open the extended text editor and write/embed the desired content.

• Be sure to remove the Back button and consider using remind me later

• Remove the Highlight; this would allow the user to interact with the page as he sees fit while

reading your content.

• Under the Advanced Settings, set Fixed Position; this will make the tip stay in view as the user

scrolls the page up or down.

Here's the result:


Create a customer help widget


Sometimes the built in left/right positioning of the help widget do not work well with the hosting

application. For example, they might overlay on top of an important part of the some pages.

To that end, we provide a service for customizing the help widget.

The process of creating a custom help widget involves the following 3 steps:

1. You need to place the following empty DIV element into the application

2. Go to the help widget setup page and check the Custom Widget setting.

3. Once the container is populated, you will need to style it using our design kit.

Customization and Personalization Methods

With Guided Learning you can set complex activation rules for your guides, based on individual end-

user fields. For example, you may wish to automatically start an introductory guide for every new

user once. Or you may want to make a guide available for a user two days after she have viewed a

different guide. In order to be able to use such rules, you need to set some fields for your end-users,

using the API.

api.fields.set

Set fields for the current end-user. This method expects a dictionary of one or more fields as the

second argument. For example, the Guided Learning embed code includes the following call

(commented out) by default:

iridize("api.fields.set", {

user_id:"USER_ID_GOES_HERE",

joined_at:UNIXEPOCH_TIMESTAMP

});

where we set the reserved-name field "user_id", which can be any string uniquely identifying your

end-users, such as a username, user ID or an email address. Here the field joined_at is a date field,

set as a numeric unix epoch timestamp (in seconds) giving the time the user signed-up to the

application.

NOTE: You must set the user_id in the very first call to api.fields.set on a page. Subsequent calls may

omit this field, but it is considered best practice to always include it.

Setting user group/role: you may want to user this method to customize the experience of users

based on group participation or user roles. This information could then be used to set up activation

rules, such that members of different groups will have different guides available. An example for such

call could be:


user_id:"[email protected]",

https://iridize.com/account/panel/https://iridize.com/account/theme/


joined_at:629848800,

role:"admin"

});

Time fields: to set a time field, simply name the field with an "_at" suffix. The time value should be

provided using a unix epoch timestamp (in seconds). For example, to set the date a user joined the

application, we could call:


user_id:"[email protected]",

joined_at:629848800,

});

Personalization and Dynamic Content

api.vars.set

Dynamically set page variables which can be used in guides content.

For example, you may want to address your end-users in your guides using their names. In such a

case the call to api.vars.set could be:

iridize("api.vars.set", {"new user":"F. Bar"});

The variable can then be used in any guide that will be running on the page by enclosing the variable

name ("new user") within double curly brackets ({{new user}}). When the guide is run and the step is

displayed, the part enclosed within curly brackets will be replaced with the value of the page variable

if it is set. If it is not set, the variable name will be used instead (without the curly brackets). A default

value different than the variable name can be set using the pipe, "|", symbol. For example, the text of

a welcoming step could be set to:

Hi {{user_name|there friend}}, thanks for signing up to fooBar. Let us show you around.

With the variable was set as described above, the text of this step will read "Welcome F. Bar, thanks

for signing up to fooBar, let us show you around.". If the variable was not set, the text will open with

"Hi there friend,..."

Another use case for this API call is for including dynamically generated hyperlinks in your guides

text. For example, you may have in your application paths such as "/foo/username/bar/". If you

would like to add a hyperlink to such a path within a guide you could simply set the link target to

"/foo/{{username}}/bar/", and run "api.vars.set" as follows:

iridize("api.vars.set", {"username":"007"});

This will yield a hyperlink with the target "/foo/007/bar/".

If the var is not set, but a user field with the same name was set in an api.fields.set call, the value

from the user field will be used. If both a var and a field with the same name are set the value of the

var will be used.


Deployment Best Practices

Guided Learning support two deployment modes out of the box: development mode and production

mode.

You can determine whether Guided Learning will work in production mode or

in development mode by setting the env variable in the embed code. Refer to our FAQ

about setting up Guided Learning.

Production mode

Production mode should be used in your live application; this is where your users engage with

the guides that you have published.

In production mode Guided Learning:

• Displays only published versions of your guides. That is, if a guide is not published it will not be

available.

• Uses the our CDN to cache your guides for better latency and high availability.

• Uses your internal browser cache to store recently used guides.

Development mode

Development mode is where you create, edit and test your guides before publishing them.

In development mode Guided Learning:

• Displays the newest versions of your guides even if they are not published yet.

• Does not use any type of caching so that changes that you make are immediately propagated

without any delay.

It is highly recommended to embed Guided Learning in development mode in your staging

environment that is the environment where you run all your tests before you release to production.

This enables the training professionals to create and test the guides on the newest features and

improvements before they are released to production.

Editing Step Branches

One of the strong points of the Guided Learning solution is how simple it is to create and manage

guides for the most complex processes. At the heart of this lies the Step Branches editing page the

Guide Editor. The Step Branches editing page empowers you to control the flow of the guide based

on various page conditions, setting multiple branches all from the a single place.

If you have any questions about these guidelines, please contact us.

http://www.iridize.com/contact/


How Branches Work

You can set one or more branches for each step in the guide. For each branch you can optionally set

one or more page conditions to limit when that branch could be chosen. When the guide advances

from a step which has branches, the first branch that can be chosen (considering each branch's

conditions) is selected and the guide continues along that branch. Thus, the order in which branches

are set in the Edit Branches page is important. Additionally, adding a branch after a branch without

conditions will have no effect (see Keep Current Guide Open below for an important exception). If no

branch is chosen, the guide will continue to the default next step, just as if no branches were set.

NOTE: If you have multiple Tips in parallel within a Step, the branches are set for each Tip separately.

The Edit Branches Page

The Edit Branches page lists the branches for the current step, you can add and archive branches as

well as edit branch settings. To open the page click the "Step Branches: Add" setting in the

Advanced Settings Panel of the current step in the Guide Editor.

A step with two branches. The first branch is a Jump to Step branch with conditions and the second

is a Launch Guide branch.

1. Done/Cancel

Click Done to save the step branches or click Cancel to discard your changes.

2. Action Buttons

The action buttons (Activate/Deactivate/Delete) allow you to perform an action on all selected

branches. You can select all branches by checking “Select all branches” box (labeled 3 in the image

above) or by manually selecting each branch using the selection checkbox at its top right corner.

• Activate – Click to activate all selected branches. Only active branches are evaluated.

• Deactivate – Click to deactivate all selected branches. Inactive branchesare not evaluated and will

not affect the flow of the guide.

• Archive– Delete all selected branches. This action cannot be reversed once Done is clicked.

3. Check to select all Branches

Check this box to select all the branches in the Edit Branches page. Helpful if you would like to

perform a mass action.

4. Branch Editing Area

See below for more details on editing branches . The image above displays 2 branches.

https://iridize.zendesk.com/hc/en-us/articles/203491171-Editing-Step-Branches#keep_current_guide_open


5. Edit Branch

Click to edit the branch.

6. Show/Hide Advanced Settings

Click to toggle whether advanced branch settings are visible. This option is visible for Launch a Guide

type branches only.

7. Reorder Branches

Drag the up & down arrow to drag and drop a branch and change the order of branches.

8. Add Branch

Click to add a new branch.

Jump to Step Branch Type

Jump to another step within the same guide.

Editing a Jump To Step branch. This branch is set to Jump to Step with step API Id "3" when the set

Conditions are fulfilled.

1. Select Branch Type

Branch type select box.

2. Step API id

The API id of the step to jump to. The step API id may be found in the Step Settings Panel of the

Guide Editor.

3. Add/Edit Conditions

Click to open the conditions editor, where you can add/edit Conditions to the branch.

4. Done/Cancel

Click on Done to finish editing the branch and keep your changes. Click on Cancel to discard the

changes made to the branch.

https://iridize.zendesk.com/hc/en-us/articles/208548455


Launch a Guide Branch Type

Choose the Launch a Guide branch type to launch another guide from within the current guide.

When used without branch conditions, this is often used to string together several guides into a

unified guide. When branch conditions are used this is often used for forking a guide based on user

choices or application state.

Editing a Launch a Guide branch with advanced settings. This branch is set to Launch a Guide with

apiName "98j68vyj".

1. Select Branch Type

Branch type select box.

2. Guide apiName

The apiName of the guide to launch. The apiName of a guide can be found in the guide's listing on

the Guides page of the Guided Learning dashboard.

3. Step API Id

By default the launched guide is started from its first step. When this textbox is not empty, the

launched guide will start from the step with the API id in the textbox. The step API id may be found

in the Step Settings Panel of the Guide Editor.

4. Keep Current Guide Open

The Launch a Guide type of branch normally launches the guide and then closes the current guide.

When the Keep Current Guide Open checkbox is checked the current guide is kept open.

Additionally, the branch choosing process continues on to the following branches (if any) and to the

default next step if no other branch is chosen. This is often useful when launching a guide which is

run in a popup window (see Popup Window Name setting below), where the current guide stays

open waiting for the user to get back from following the launched guide on the popup window.

5. Add/Edit Conditions

Click to open the conditions editor, where you can add/edit Conditions to the branch.

6. Show/Hide Advanced Settings

Click to toggle whether advanced branch settings (items 7-11 below) are visible.

https://iridize.zendesk.com/hc/en-us/articles/203436102-Guide-Activation-Conditions#page_condition_types


7. Wait for Page to Load

When this checkbox is checked the launched guide will not start until a page load takes place (either

a full page load or a SPA route load on a properly integrated SPA). This is almost always necessary

when launching a guide in a popup window (see Popup Window Name setting below). Another use

for this setting is when combined with the Redirect to Page or Reload Page settings.

8. Redirect to Page

When the textbox is not empty, the user will be redirected to the URL specified in the textbox when

launching the guide. Please note that it is almost always a good idea to also set the Wait for Page to

Load setting when using Redirect to Page.

9. Reload Page

When this checkbox is checked, the page will be reloaded when launching the guide. Please note

that it is almost always a good idea to also set the Wait for Page to Load setting when using Redirect

to Page.

10. Popup Window Name

By default the launched guide starts in the current browser tab/window. When this textbox is not

empty the guide will be launched in a tab/window with the Javascript window.name property

matching the text in the textbox. This is useful for launching guides within a popup window or

another tab. For use with a popup window, this setting almost always requires also setting the Wait

for Page to Load setting to work properly.

If you don't know the name of the popup window, refer to this video

11. On Close Return-Here/Launch-a-Guide

This setting sets an action to take place when the launched guide is closed (either by the user or by

finishing the guide).

• Return Here - with this setting the launcher guide is suspended upon launching the guide. When

the launched guide is closed the launcher guide resumes from the same step it was when

suspended.

• Launch a Guide - with this setting the launcher guide is closed as usual. When the launched guide

is closed, the guide with the apiName set in the textbox is launched.

12. Done/Cancel

Click on Done to finish editing the branch and keep your changes. Click on Cancel to discard the

changes made to the branch.

http://window.name/https://youtu.be/UD6_8kk-5Mk


Editor Manual

Terminology

Tip - also called tooltip, callout, help balloon, popover; this is the UI element that provides additional

information and/or instructions about something on the web page

Target element - the element on the page to which the tip is pointing.

Splash - a special type of tip that does not have a target element, it is simply a modal dialog that is

displayed at the center of the web page.

Selector - a unique identifier of an element on the web page.

Step - a set of tips that are run in parallel.

Guide - an interactive tutorial; an ordered set of steps used to provide the end user with relevant

information as he is using the application.

Player - the Guided Learning piece of software embedded in the hosting web application which

is responsible for launching all guides.

Guided Learning editor components: Red - Content Editor, Green - Top Panel, Purple - Flow Panel,

Yellow - Step Settings Panel and Cyan - Tip Preview

Tip Preview

Shows a live preview of the currently selected tip as it would be shown as part of the guide. The

Next, Back and Close (x) buttons are all functional.

Content Editor

The content editor allows you to define the contents of the tip. The content editor has two modes -

Minimal and Expanded. The minimal mode supports the most important commands used in the

majority of Guides. The Expanded mode empowers you to create rich content tips and splash screens

which can include media.

The commands of the minimal mode are detailed below.

The Top Button Bar

• - Click the button and start entering content to make it bold. You can also highlight part of

the tip's content and click this button.

• - Click on the button and start entering content to make it italic. You can also highlight a part

of the tip's content and click this button.


• - Click on the button and start entering content to underline it. You can also highlight a part

of the tip's content and click this button.

• - Click to add a bullet item list to your tip's content

• - Select a part of the tip's content and click this button to convert it into a link.

• - Click to add an Guided Learning Session Variable button. Session Variable buttons can be

used to create rich guide flows based on user choices. Clicking on a Session Variable Button

dynamically sets a Variable which can be used in Step and Branch conditions to control step

activation and guide flow. The Variable can also be persisted as a User Field, which can be used

in Guide Activation Conditions.

The Bottom Button Bar

• - Click to change the target element

• - Click to change to placement of the tip relative to the target element

• - Click to expand the content editor into Expanded mode

• - Click to discard the changes you have made to the tip

• - Click to save your changes and create another tip.

Top Panel

1. "My Guide" - this is your guide’s name, click to edit it in place. For a new guide this will be

"Untitled".

2. Done - click to save your changes and return to the manage page.

3. Preview - click to preview the guide in a new browser tab as it would display in the live site. If you

have already opened the preview, click this again will refresh the preview tab and relaunch the

guide with your recent changes.

4. Publish changes - An Guided Learning guide has multiple revisions. Each time you edit a guide a

new revision of that guide is stored in our database. A revision can either be a published revision

or a draft revision. To complement this, Guided Learning supports a dual deployment mode.

While you can only see published revisions in your production environment, Guided Learning

allows you to see draft revisions in your staging environment. This is very useful if you want to

create a guide for new feature that is not yet live in production. Check this checkbox to make this

revision published.

Flow Panel

Here you can view a list of all steps in your guide. You can click on any step to view it. You can drag

and drop steps to reorder them.


Use the _ button to delete a step

Use the _ button to toggle the step settings panel.

Click on the green + button at the bottom of the panel to append a new step to the guide.

+/- Symbol:

A step can display more than one tip simultaneously. To add or remove tips from a step use the +/-

icons.

Display settings

Highlight Target Element

Setting this option tells Guided Learning to highlight the target element and mask the rest of the

page. Except for the target element all other elements will be visible but inaccessible to your end

user. This setting allows you to focus your user’s attention on a specific element or section on the

page and help him avoid mistakes.

Hide Next button

By default, every Guided Learning tip has a Next and a Back button which allows your users to

navigate back and forth within a guide. However, sometimes it is considered best practice to remove

the Next button. To remove the Next button, check the Hide Next box in Settings.

For example: when you want to make a button mandatory, add a tip that reads “Click this button”

and use the Hide Next setting to drive the user to complete the guide without skipping any steps.

Change Next Button Text

Use this to change the text of the Next button.

For example: on the first tip of guide consider changing the text to something more engaging like

“Let’s Go” or “Show Me”. For the last tip, try “That’s It”.

Hide Close Button

This will remove the ‘X’ from the top right corner of the tip, compelling the user to read the tip

content and act on it.

Best practice: use this setting when launching a guide for first time users.

Show Back button


By default, every Guided Learning tip has Next and Back buttons which allow users to navigate back

and forth within a guide. However, sometimes it is considered best practice to remove the back

button, to do so - Uncheck the Show Back box in Settings.

Show Remind Me Later button

Use this setting to show a “Remind me Later” button for the tip. If clicked, Guided Learning will

launch the tip again for the same user at a later time. To define that later time you will need to define

Guide Activation Conditions.

Hide steps count footer

Use this to toggle the display of the step counter at the bottom right corner of your tooltip.

Tip Width

Use this to determine the width of the tip. This field's value is measured in pixels.

Tip offset

Offset the tip from it's center position. Use a negative number in the top setting to place the tip

further on top. Use a negative value for left to take the tip further to the left.

Tip Placement

Use this setting to define the position of the tip in relation to the target element. This is similar to the

function of [button] in the tip editor.

Disable Element

Blocks the user from interacting with the highlighted element. For example, if you want to highlight a

button and explain it while making sure the user will not click it.

Change Highlight Element

While the tip will always point at the target element you can choose to highlight a different element

on the screen. Normally this is used to highlight a container of the target element. for example, while

the tip can point at the submit button of a form you could opt to highlight the entire form.

Activation Settings

Invisible Step


Consider the following use case, you want to show a tip as soon as the user clicks on a certain

button. To do this set an “invisible step” on the button. This will tell the player to wait until that

button is clicked before advancing to the next step thus showing the first tip.

Advance On Event

By default the player advances from one step to the next as soon as the user clicks on the next

button. However the make the guide flow more smoothly you can tell the player to advance based

on user interaction like clicking a button or enter text in a form field. Guided Learning support all

these events.

Best practice: use this when guiding users to fill out forms. Use Keypress and select events to

advance the guide to the next step automatically.

Manually setting the event to and empty value (while keeping the checkbox checked) will set the

guide to advance as soon as the target element appears on the page and all the step conditions set

for this tip are true.

You can get some inspiration from the most commonly used events:

• Mouse Events

• click - use this to advance when the user clicks on the selected element

• dblclick - use this to advance when the user double clicks on the selected element

• mouseover - use this to advance when the mouse pointer enters the selected element

• mousedown - use this to advance when the user starts to click on the selected element. This

is most commonly used as a substitute for when the click event cannot be used.

• Keyboard Events

• keypress - use this to advance when a character key (or enter) is pressed. Note: use this to

handle a user filling out a form field.

• ir-enter - a custom Guided Learning event used to advance when the user clicks on the Enter

key.

• ir-tab - a custom Guided Learning event used to advance when the user clicks on the Tab key.

• ir-esc - a custom Guided Learning event used to advance when the user clicks on the ESC key.

• ir-backspace - a custom Guided Learning event used to advance when the user clicks on

Backspace key.

• ir-space - a custom Guided Learning event used to advance when the user clicks on the Space

key.

• Form Events

• blur - use this to advance when the selected element has lost focus.

• change - use this to advance when the user has made a selection a drop down list, clicked on

a radio button or a checkbox.

• focus - use this to advance when the selected element has received focus.

Delay Advance by


This will tell the player to wait x milliseconds before advancing to the next step. If the step has an

Advance on event set the delay period starts after that event occurs. If there is no Advance on event

set the delay period starts as soon as the target element is found.

Best practice: use this in conjunction with the advance on Keypress. The next tip will appear

automatically x milliseconds after the user has started typing text.

Note: with this setting the guide does not advance to the next step before the delay period is over.

Thus, a page refresh or navigation during the delay period will cancel the advancement to the next

step. Use the "Delay showing this tip" setting above to set the delay on the next tip directly for such

use cases.

Change Advance on Event Target

On occasion, you may want the tip to point to one target element and at the same time wait for the

user to interact with another element.

Best practice: If you want to highlight an entire form section & set the “advance on” selector to be

the “Submit” button so that the guide will advance when the Submit button is clicked)

Show Tip after page refresh

If the next tip’s element selector exists in the current page, then the tip will flash twice. This prevents

that flashing tip. We consider this better UX.

Show tip after

This will tell the player to wait x milliseconds before showing the current tip.

Best practice: use this as an alternative for Show Tip after page refresh if you need to prevent a tip

from "flashing" but there is not page refresh or navigation when advancing between the steps. This

can sometime happen when parts of the page (or Dialog modals) are dynamically rendered.

Note: this setting only delays the showing of the tip. If the tip has an Advanced on event set it would

wait for the event even while the tip is still waiting to show.

Show tip on hover

Only show this tip when the user moves their mouse over the target element.

Best practice: use this to provide additional information about a form field.

Skip if element not found

Knowing that web pages are dynamic in nature, the Guided Learning software embedded in your

website continuously looks for elements, even if they are not currently visible. Guided Learning will


show the tip as soon as they become visible. You can tell Guided Learning not to wait for an element

by setting the Step as Optional.

For example: If you want to create a guide on the Settings page of your application, your first tip

should probably be: "Click on Settings”. But what if the user launched the guide from the Settings

page? The solution: set that first step to be optional.

Step Conditions

There are cases where you want to condition the showing of a specific tip in a step on the state of

the page the guide is running on. For example, whether a page element, other than the target

element of the tip, exists or is visible on the page. Another example can be to only show a tip on a

specific page based on the page URL (and maybe skip the step on other pages). Use this setting to

add/edit a list of page conditions to the tip. The tip will only be shown when all the conditions

are fulfilled and will be hidden as soon as any of the conditions becomes false.

Best practice: This setting is very useful in cases where you have multiple tips in a step. It is especially

useful for conditional branching of a guide, where the different tips in a step have different

conditions and are set to launch different guides (or continue with the current guide). Another

common use case is for optional navigation steps, that should only show if the user is not already on

the page where the guide is built to run.

Advanced Settings

Fixed Position

When using a splash tip you can use this setting so that the tip will remain visible even if the user

scrolls up or down the page.

Allow changing number of targets

Use this setting when attaching a tip to multiple targets, where the number of targets may

dynamically change while the tips are showing.

Track target position

If the element’s position moves dynamically (fixed positioning), this will ensure that the tip stays on

the target element. (E.g.: virtual customer service agent that can be on different areas of the page.)

No Scroll

By default, Guided Learning will scroll the page so that the tip and the highlighted element will be

visible. This setting allows you to disable this behavior.

Advanced visibility check


On some applications, Guided Learning might think that an element is visible while it is not. This can

happen if the web application uses multiple layers and an element could be hidden behind another

on that was added on top of it.

This setting tells Guided Learning to run some extra checks against the element.

Scroll Parent Container

If the target element is within an internal element with an internal scroll, this will enable us to scroll

down to the target element.

Limit the wait on target to 3000 ms

Our guide tips wait for the target element to appear indefinitely. This setting sends Guided Learning

an error message if the current target element does not appear within x ms so that we can notify you

and fix the problem.

Step Branches: add/edit

This setting allows you to set one or more branches to the step, either jumping to another step on

the current guide or launching a different guide.

Target selector

This enables you to use the developer tools & select selectors (often complex elements) via

jquery/css selector. Use the up-arrow to go up the DOM tree and automatically select the container

of the existing target element.

Next URL

Navigates the user to a new page when clicking on the next button. This is very useful if you want to

create a site tour.

Change Highlight Stretch

make the highlighted section of the screen smaller or bigger using pixel precision. This is very useful

if the section you want to highlight does not have a corresponding HTML container.

Note that this setting is not responsive.

Only display one tooltip

This setting is on by default.


When you select an element Guided Learning tries to find a unique identification for this element.

Sometimes that identification is not strong enough and could result in multiple tooltips appearing on

the screen at once. Un-check this setting to allow for the display of duplicate tips. This could be very

useful if you want identical tooltips to appear next to each item in a list.

Embedding an iframe in a Guided Learning

Step

One of the ways of using Guided Learning is embedding external content into a Guided Learning

“bubble.”

You can use this feature to, for example -

• Provide your users with a survey that you’ve created (in SurveyMonkey or in Google Sheets for

example) directly over the interface of your product.

• Give you users direct access to relevant information in your FAQ or Knowledgebase while they are

using the product

• Sharing information from an external source or website in a contextually relevant

This features utilizes Guided Learning’s ability to embed iframes (or Inline Frame) in our bubbles.

These iframe-bubbles can appear as single-step guides or as part of a longer guide (one of the

steps), based on your requirements and the process.

And, of course, these guides and bubbles can be made to appear according to pre-

set conditions (Only once, only on certain pages, only to certain people, etc.), just as any other guide.

In addition, Guided Learning collects all usage data and lets you know that your users have actually

seen this content (even though it is outside of your product).

https://en.wikipedia.org/wiki/HTML_element#Frameshttps://iridize.com/account/stats/


Embedding an iframe

The mechanism of embedding an iframe into a bubble is similar to embedding a video or an audio

link and uses the same process. Guided Learning has a generic algorithm that recognizes the type of

content that is provided in the URL and automatically deploys it correctly in the bubble.

Just as with video and audio, there are two ways you can embed iframes into Guided Learning

bubbles. In both cases the process is easy and quick.

From the Editor

• Launch the Guided Learning Editor

• In the Expanded Content Editor choose the Embed Media Console Box (see Image)


• In the console box enter the URL for your iframe and click “ok”

• The external website will now appear in your Guided Learning bubble


• You can minimize the Expanded Editor and either continue to the next Step or click “Done” and

continue to the Guide Activation Conditions.

From the Dashboard

• Click the New button for creating a guide and choose “Video” from the options in the green bar

(1).

• In the URL box (2) enter the URL of the page you wish to embed

• Don’t forget to give the new guide a name (3)

• Now click CREATE

• A new guide has been added to your Video Guide list

• You can now choose the URL you wish this guide to appear on


Please note! Some products do not allow you to embed them inside of an iframe. We suggest you

test each page to see that it works before launching it to your users.

Expanded Content Editor Reference

The expanded view of the content editor includes many options for creating, styling and embeding

rich content into your Guided Learning guides and walkthroughs. Below is a quick reference for the


most important options and their application.

-

View Source: view and edit the HTML source of the step's content directly.

-

Advanced Paste: when pasting rich text content into the editor you may want to use these buttons to

paste as plain text (without styling) or to paste from Word and keep the content styles intact.

-


Undo/Redo: undo changes to the content or redo changes which were previously undone.

-

Clear Styling: remove all content styling, such as text color, background color, font size and type etc.

-

Quote: turn selected text into a Quote element with its custom styling.

-

Text Direction: Set the direction of the currently selected paragraph to Right or Left.

-

Link/Unlink: turn selected text into a link (anchor) or insert link at the current cursor position. The

Link Dialog allows you to set the type of the link, its URL and its target window (open in same/new

tab or window).

-

Table: add or modify a Table element. The Table Dialog lets you set table properties such as the

number of rows and columns, table headers, border, width and more.

NOTE: you can also right-click a table in the content to open the table properties as well as cell and

row level options.

-

Special Symbols: add a special symbol to the current cursor position. This is especially useful for

adding currency symbols, such as Euro or Pound or Yen.

-

Image: add or modify and Image element. The Image Dialog allows you to set image properties such

as its URL, size, alignment and whether it is a Captioned Image.

NOTE: you can change the Image's size both from the Image Dialog or by the in-content drag-to-

resize controls. For Captioned Images, the caption can be edited directly in the content.

-

Embed Video (and media): add or modify a Video or Slideshow from and external source such as

Youtube, Vimeo and Slideshare. While the main use of this option is to embed Videos in guides and

messages the full list of supported services also includes Audio, Photo and Rich Content sources

such as Soundcloud, Bandcamp, flickr, instagram and wikipedia. Here you may find the full list of

currently supported sources.

-

Text Style: set or modify the selected text's Style (Heading 1-6, Paragraph), Font type and Font Size

using these drop-downs.

-

http://ckeditor.com/addon/oembedhttp://ckeditor.com/addon/oembed


Emphasis: set or unset Bold, Italic and Underline emphasis on the currently selected text.

-

Text Alignment: set the alignment for the currently selected paragraph to Left, Center, Right or

Justify.

-

List: add numbered or bullet list. Right click the list elements to open up the list properties dialog,

where you may choose numbered list type (Decimal, Latin numerals, Alpha etc.) or bullet list type

(Circle, Disc or Square).

-

Indentation: increase and decrease text indentation level. Increasing the indentation level of a list

item creates a nested.

-

Text Colors: set the text and background colors of the currently selected text. The color selection

dialog lets you choose a color from a list of preset colors or enter your own custom colors.

-

Session Variable Button: add a Session Variable Button. Session Variable Buttons can be used to

create rich guide flows based on user choices. Clicking on a Session Variable Button dynamically sets

a Variable which can be used in Step and Branch conditions to control step activation and guide

flow. The Variable can also be persisted as a User Field, which can be used in Guide Activation

Conditions.

Exporting and Importing Guided Content

This section explains the process for exporting and importing Guided Learning guides for translation

purposes. Translation of guides allows you to dynamically control which language of the guide will

be displayed to the end user. Once the guides are exported you can translate the relevant text in the

provided files and import them back to Guided Learning with the new language.

Export

To Export the guides content you will need to access the Customize page in your Guided Learning

account.

Look for the Multi-Language section and click on the Export button. This will prompt you to save

the exported guides to your local disk.

https://iridize.com/account/settings/


Guided Learning guides will be saved as a ZIP file with all the exported content in the target

directory.

Extract and save the information in the ZIP file to a directory of choice. If your operating systems

does not support ZIP files you can use one of the following software providers: Winzip, Winrar, izip.

Your export folder should include the following directories:

• active - This directory contains all published/active revisions of your guides; it should match

what you see in your production environment. The directory will contain a list of directories,

one for each language. In each such language directory you will find a list of files named

according to your guides’ api-names. The directory names ‘--’ denotes the native language

you used to create your guides originally; this will be english in most cases.

• testing - This directory contains all draft revisions of your guides; it should match what you

see in your staging/test environment. The structure of this directory is identical to the active

directory.

• import - This directory has no real content. It is where you will need to place your

translated guides before importing them back to Guided Learning. For more information

about the import process please read the section below.

• README.txt - this is the file you are reading now :)

Import

In order to import the translated guides back to Guided Learning you will need to populate

the import directory with the translated content.

The import directory should include directory for each language you support. The name of each

directory signifies the language it contains and should follow this naming convention. For your

convenience, during the export process we have generated in the import directory a directory for

each language you currently have guides for in the Guided Learning servers.

To import the translated content you will need to ZIP the contents of this directory only and upload

it using the “Import” button in the Customize page of that product in your account.

http://www.science.co.il/Language/Locale-codes.asp


Export Guide Format

The content of your guides will be saved in a tab-separated values file. This should allow you to

double click and open it in any spreadsheet software (e.g. Microsoft Excel).

Header Section

This section contains meta-data related to the guide.

rev_key djebjwtsi7p9rqe

display_name display name

Use this section to translate the name of your guide to multiple languages. This name will be

displayed in your Guided Learning dashboard and in the help widget for your end users.

Notice: please leave everything else untouched.

Content Section

This section contains the actual content of the guide.

id uid type next contents

1 tip voila hello world - fr

The is a marker used during the import process.

The line after provides column headers. Each tooltip in your guide should have a corresponding line.

id, uid, type - are internal Guided Learning fields. They are used in the import process.

next - The text that will be displayed in the Guided Learning next button. This field will normally be

empty unless you have changed it from the default value ‘Next’. To translate the default text for

the Next button to a language please read the Tiplate section below.


contents - The contents of the tooltip.

Notice: do not change the order of the lines, it might break the import process.

Export Tiplate Format

The Guided Learning tiplate is a template of what your tooltip looks like. It defines the default look of

the tooltips in your application.

This is important because through the tiplate you can define the texts of the following defaults:

• Next - this is the default text for the next button. Simply search and replace the word Next in the

tiplate.

• Back - this is the default text for the back button. Simply search and replace the word Back in the

tiplate.

• Remind me later - change the default text of the remind me later button. search for Remind me

later

• Step counter - by default the step counter looks like this ‘Step 1/n”. Search for Step to replace.

The tiplate file will be named tiplate.csv in your export directory.

Goals – Measuring Product Training

Even if you achieve the impossible and finish writing all the technical communication content you

ever wanted. Or if you have created THE perfect product training course and uploaded it to your

LMS. Something is still missing!

If you can not measure the effectiveness of your training you are not done.

Measuring is crucial because it allows you to:

1. Improve your training based on real data

2. It's a highly effective way to share your results with high level executives. Some would say it's the

only way to do so.

Whether or not you use Guided Learning to train your users and help them master key procedures;

Guided Learning lets you track and measure which users complete these procedures.

Documents

Oracle® Custom Guided Learning Service Frequently Asked ... · Oracle Custom Guided Learning Service FAQ 8 Introduction & Overview of Oracle Custom Guided Learning Service Note: