Implementer Documentation
Introduction
Welcome to the Implementer Documentation for Digital Retailing Suite. If you are needing help getting started with your new Suite implementation or just have some questions about how the code works, this will be a great resource. This documentation will be continually updated as Suite evolves. Below is a description of each implementation method currently available for Suite. On the left are links to the implementation details and code examples for each method.
Using Custom Button Widgets
You can launch your licensed Suite workflow by adding a Custom Button Widget to your existing site. When
clicked, it will open a modal window over the top of the host page and display Suite starting with your
licensed workflow. This page will show you how to set up your own Custom Buttons to open Suite.
Using PaymentDriver Widgets
If you are implementing either the PaymentDriver or the PaymentDriver > FinanceDriver workflow, we recommend that you embed the Suite's PaymentDriver Widget in your site to quickly launch the desired workflow (for a selected vehicle). The workflow continues in modal windows that open and overlay your host page. Currently, only a limited number of these should be used per page and they should NOT be used for search results. However, check back regularly as this functionality will be coming soon.
Widget Z-Index
Suite loads modal windows that use a Z-Index setting to display properly over the rest of your site content. This page will help you make sure your site has its Z-Indexes properly set up to accommodate any Suite modal windows.
Embedding Full Suite
As an alternative to using a widget to launch your licensed Suite workflow, you can frame-in the Suite Plug-in(s) to your site simply by telling Suite to embed itself in an element. Several height policies can be used to tell Suite how you would like it to manage its height. This page will demonstrate and show you how to set this configuration up.
Async Loading
Learn how to use Suite with dynamically loaded custom buttons and elements and asynchronously adjust to these changes.
Suite Query Strings & URL Parameters
Suite QueryStrings or URL parameters are used to change how Suite starts up and operates. Some of these parameters are required and others are optional depending on the workflows you have chosen. Follow the link to learn more about these parameters and how they affect your implementation.
Analytics Common Session
Learn how to pass a google analytics session from a website into the suite application
More Examples
Here we have provided several examples of the typical Suite setups. These should give you some ideas of how you can implement Suite on your website.
Digital Retailing Consumer Video
Educate shoppers on their online journey. A short video clip (mp4 format) is available to Digital Retailing plug-in licensees who wish to educate their shoppers on the Digital Retailing experience.
API Documentation
Developer resource for digital retailing API documentation.
Support
To contact Tech Support for Digital Retailing Solutions: