Iridize Setup Instructions

General Setup

To install iridize in your application the following javascript code must be added to all pages in your application where iridize should be enabled. Normally this would require pasting the code below to the footer template of your application immediately before the closing </body> tag.

<script type="text/javascript">
/* Iridize.com*/window.iridize=window.iridize||function(e,t,n){return iridize.api.call(e,t,n);};iridize.api=iridize.api||{q:[],call:function(e,t,n){iridize.api.q.push({method:e,data:t,callback:n});}};
iridize.appId="XXXXXXXXXXXXXXXXXXX";
/*FOR YOUR DEV OR STAGING ENVIRONMENTS PLEASE MODIFY THE NEXT LINE TO READ iridize.env="dev";*/
iridize.env="prod";
/*FOR PER USER ACTIVATION RULES AND GOAL TRACKING - UNCOMMENT THE FOLLOWING LINE AND SET user_id*/
/*iridize("api.fields.set",{user_id:"USER_ID_GOES_HERE"});*/
(function(){var e=document.createElement("script");var t=document.getElementsByTagName("script")[0];e.src=("https:"==document.location.protocol?"https:":"http:")+"//d2p93rcsj9dwm5.cloudfront.net/player/latest/static/js/iridizeLoader.min.js";e.type="text/javascript";e.async=true;t.parentNode.insertBefore(e,t)})();
</script>

iridize.appId

iridize groups guides together into applications. An application is simply a logical grouping of guides; On any given application only guides from the same application can be shown. In the iridize dashboard you can administrate and configure each application independently.

If you need to setup iridize on multiple applications in your organization or on multiple versions of the same application it is recommended that you use separate iridize applications.

To see what is your appId simply visit the account setup page

 

iridize.env

iridize supports deploying in both your staging and production environments. In your production environment iridize will only serve published revisions of your guides. In staging, on the other hand, iridize will also display draft revisions of your guides.

Using this paradigm will allow you to create walk-through guides in your staging environment before a new feature is released to production without having to worry about affecting your production environment. You will then be able to publish these new guides only after they were tested and the feature was rolled out to production.

To enable iridize in your staging environment use the following code

iridize.env = “dev”;

If iridize.env is defined to any value other than “dev” or not defined at all, iridize will assume that this is a production environment.

On Premise Runtime Installation (Hybrid Setup)

Iridize fully supports on-premise runtime installations. To install iridize in an environment without access to the internet you will need to do 2 things.

1) export your guides from your iridize account. This will provide you with a ZIP archive with all the necessary files in the proper directory structure. Unzip the contents of this archive into a web server of your choice.

2) amend your javascript embed code. Change the domain d2p93rcsj9dwm5.cloudfront.net to the location where you have extracted the contents of the ZIP archive.

NOTE: your web server must be configured to serve files with the name index.json when a request is made to a directory. For example, in apache this can be achieved by adding the following line to your conf file.

DirectoryIndex index.json

Configuration Options

iridize.reportPrefix

The default iridize behavior is to send guide usage and error reports to the iridize cloud servers at https://iridize.com. This behavior may be overridden by adding the iridize.reportPrefix property override to the iridize embed code. For example, if the following line is added to the embed code, the reports will be sent to the base url https://foo.com/bar/

iridize.reportPrefix = 'https://foo.com/bar';

When this property is used it is common to setup a webserver that simply logs all requests to the base url or its nested paths into log files which can later be used for counting guide activations, step activation and checking for guide error reports.

iridize.enableReport

Some times it is desired to disable usage and error reporting altogether, for example when deploying iridize runtime on-premise installations to environments without internet connectivity. In such cases it is possible to do so by setting the iridize.enableReport property to boolean false in the iridize emebed code.

iridize.enableReport = false;

iridize.useSessionStorage

Normally iridize uses the browser's local storage to store information about which walk-through guides are active. Users may wish to open several views of your application in multiple browser tabs. Potentially a different guide/s may be open in each tab. For this reason iridize scopes the local storage per browser tab.

However, some web applications use multiple tabs as part of the navigation scheme. In order to permit a walk-through guide to be continued in another browser tab you should use the useSessionStorage setting. This tells iridize to store state information in the browser's session storage. As a result this copies the user's state from one tab to the next.

iridize.lang

Set the preferred language for the Iridize guides. This should be set dynamically based on the currently logged in user.

The value of this setting should be the language code of the relevant language as provided by this standard.

for example, to set the language to French,

iridize.lang='fr';

iridize.showStartPanel

Use this setting to disable the help widget on certain pages. This is sometimes required if your application uses popups or iframes.

iridize.showStartPanel = false;

iridize.apiOnly

Use this setting to disable all activation conditions. This will only allow you to activate guides using the Javascript API (see section below).

iridize.apiOnly=true; 

 

 

The iridize JS API

The iridize Javascript API (JS API) can be used to customize and personalize your end-users' experience. The API makes it possible to set end-user fields which can be used for setting complex activation rules for your guides. Additionally, you may use the API for personalize and dynamically set the content of iridize guides.

The API can also be used to attain granular control over the activation of iridize guides within your web application. Using the API you can start or stop guides based on your custom business logic, as well as monitor the progress of a specific customer through your guides, by binding to guide-level or step-level events.

To read more about our API visit this knowledge-base article

Compatibility

iridize on-page guidance solution is compatible with any application that can be used with a standard web browser.

Iridize technology can offer instructions on any element in the DOM tree.

Iridize can be used to provide instructions on embedded objects such as java applets, Flash and Silverlight. However, iridize cannot inspect elements within these embedded objects.

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.