YRI CHAMPS Alignment Tool Reference Manual

Overview/Introductionpage 2

Getting Startedpage 3

The Main Application Screenpage 4

The Navigation Treepage 6

The Stores By Coach Folderpage 7

The Stores By Ownershippage 8

The Coaches Table Folderspage 10

The Coaches ByOrganization Folderspage 11

Using the Coaches Table Edit Panepage 12

Deleting aCoachpage 12

Adding a new Coachpage 13

Editing Coach Informationpage 13

Using the Coach Edit Panepage 14

Viewing coach change historypage 16

Using the Organization Edit Panepage 17

The Organization Details panelpage 18

Viewing Organization changehistorypage 19

Using the Store Edit Panepage 20

Viewing Store change historypage 24

Using theBMU Edit Panepage 24

The Coaches configuration screenpage 25

The File Menupage 26

Save

Save To File

Refresh

Change Password

Logoff

Exit

The Edit Menupage 27

Adding a new store to the BMUpage 27

Removing a store from the BMUpage 28

Adding an organization to the BMUpage 28

Removing an organization from the BMUpage 29

The Search Menupage 30

Store Searchpage 30

Organization Searchpage 31

Person Searchpage 32

Program Requirementspage 33

Installationpage 33

Overview/Introduction

The CHAMPS YRI Alignment tool is a Java web application used to maintain the information necessary to ensure the CHAMPS reports are delivered properly. It has been designed to make it simple for you to:

Maintain the name and email information of the various coaches that manage the stores of a BMU.
Assign stores to a coach and coaches to a store.
Maintain basic information of the restaurants of a BMU
Maintain basic information of the companies/franchisees/licensees of a BMU
Maintain name and email information for the Franchisee/Licensee Owners of a BMU.

The web site for the CHAMPS YRI Alignment application is located at The main page of the web site has links to pages for:

Starting the alignment tool.
Installation instructions.
Program requirements
Downloading this user manual.
Downloading the Import template file.

To run the CHAMPS Alignment Tool you need have a working Internet connection, two software programs installed on your computer and have a CHAMPS Alignment Tool user account. The two software programs are called the Java Runtime Environment and Java WebStart. The Java Runtime Environment enables computers to run Java web applications. The Java WebStart program enables computers to run Java web applications like a normal desktop application. This means the CHAMPS Alignment Tool will run in its own program window and you will be able to open it by double clicking a desktop icon or picking it from your computer’s “Programs” menu.

When you open the CHAMPS Alignment Tool, Java WebStart will start first and check the CHAMPS Alignment Tool web site for program updates. It will automatically download any application components that we updated so you are always running the latest version of the program. It will then start the CHAMPS Alignment Tool in its own program window.

When the CHAMPS YRI Alignment tool starts up, it asks you to login. When you login, it connects to a server here in Dallas, and that server connects to the database. If the user id and password you logged in with are correct, the rest of the application will display, allowing you to start using it. It will download the CHAMPS Alignment data from the database server so you can view and edit it. The changes you make to the data are sent back to the database when you save them, just like changes you make when editing a document are written to file when you save it.

Getting Started

Step 1 – Submit a “New User Request Form”

Send an email to Barb Stage at to request a user account for the YRI CHAMPS Alignment Tool. We will notify you by email when your user account has been setup. We normally process the “New User Account” requests within 2 days of when we receive them.

Step 2 – Verify system requirements

Verify that your computer meets the minimum hardware and software requirements listed in the program requirements section of this document.

Step 3 – Install the Java Runtime Environment and Java WebStart software components.

Instructions for installing these components are located at You can also see the installation section of this document for further details.

Step 4 – Start the application

The first two times you run the CHAMPS Alignment Tool you will need to start it from the web site. Open Internet Explorer and go to the YRI CHAMPS Alignment tool web site located at Click on the link labeled “Start the CHAMPS Alignment Tool”. This will start the Java WebStart application.

The first time you run the CHAMPS Alignment Tool, Java WebStart will download and install it onto your computer. This may take a few minutes depending on the speed of your Internet connection. Once Java WebStart has completed the installation, the CHAMPS Alignment Tool will start in its own program window.

The second time you run the CHAMPS Alignment Tool, Java WebStart will install program shortcuts to your computer’s “Programs” menu and desktop for the CHAMPS Alignment Tool. The next time you want to run the program, you can start it by using either picking it from your “Programs” menu or by double clicking on its desktop icon instead of going to the web site.

When the CHAMPS Alignment Tool starts up, it will first ask you to login.

Type in the user ID and password that your user account has been setup with and click the “OK” button. The application will connect to the server and submit your login. If the login passes validation, the application will finish building. As it builds, it will display a status dialog that displays what it is being built and a progress bar to let you know how far along it is.

Once the application has completed the login process, the main application screen will display.

Main Screen

The main application screen consists of:

A Menu bar
A “Save” tool button – used to save data changes you have made to the database.
The BMU dropdown list control – used to select the BMU whose data you wish to edit
The Navigation Tree – used to view the data for a coach, organization or store
Two buttons that can be used to fully expand or collapse the Navigation tree
The Edit Pane – used to edit the data associated with the selected item in the Navigation Tree.
A splitter bar – used to resize the visible widths of the Navigation Tree and the Edit Pane.
A Status Bar – used to indicate that you have made a data change.

You start working with the application by using the “BMU Dropdown List” control to select the BMU whose data you wish to view and/or edit. When a BMU is selected, the data for the previously selected BMU is unloaded and the data for the selected BMU is loaded into the application. If you have access to just one BMU, that BMU will be automatically selected and its data loaded into the application as part of the login process.

The data that gets loaded when a BMU is loaded are:

Coaches

There are 9 types of coaches: Division, Region, Market, Area, FB Coach, CHAMPS Coach (CER), CHAMPS Specialists (CER), Key Operators, and Other Recipients.

The information that is tracked for each Coach is the coach’s name, email address and the stores that have been assigned to that coach.

The Key Operator and Other Recipient coaches are associated with a franchisee or licensee and can only be assigned to stores that belong to that franchisee/licensee.

Company/Franchisee/Licensee Organizations

The information that is tracked for an organization is the organization name, some identifier information, ownership type, owner name and email address, and the organization’s address.

Stores

The information that is tracked for a store is some identification information, the store’s name, ownership type, Brand, Concept/Channel and CHAMPS Category, general manager, phone number and email address, language, access mode options, hours of operation, call center details, store configuration exceptions, open status, the company/franchisee/licensee it belongs to, the coaches the store has been assigned to and address information.

BMU level configuration

The configuration information that is loaded for the BMU falls into three categories. There is coach configuration information that configures which types of coaches the BMU uses. The Operations Leaders of the BMU (COO, Region Coach…) are loaded, and there is the reports detail settings that coaches and Operations Leaders are to receive.

The Navigation Tree is used to provide quick access to the data you want to work with. When a BMU is selected, the Navigation tree builds nodes in the tree for the coaches, organizations and stores of the BMU. When you select a node in the Navigation Tree, the data associated with that node will display in the Edit Pane located to the right of the splitter bar.

For Example, when you select a node that represents a particular Division Coach, the Edit Pane will display the data for that Division coach. In this case that would be the Division coach’s email address, first and last names, and the stores that have been assigned to that coach. For further details on the Navigation Tree and the Edit Pane see the Navigation Tree section of this document.

When you make a change to data in the application, the application will be marked as updated. The color of the Status Bar changes to a red color and the Save tool button and menu item become enabled to indicate to you that you have made changes that need to be saved to the database.

Navigation Tree

The Navigation Tree builds several folders to represent the data of the BMU. It builds a folder for each type of coach the BMU is configured to use. In addition to folders for each coach type, it builds a folder to view the stores organized by ownership type and a folder to view the stores organized by coach.

The tree organizes the data those folders represent hierarchically so that it is simple for you to drill down to the particular Store, Coach, or Organization you want to work with. For further details on each folder, please see the following sections in the document

Stores By Coach Folder section

Store By Ownership Type Folder section

Coaches Table Folders section

Coaches By Organization Folders section

An edit pane is associated with each item in the tree that has information that can be viewed and edited. When you select an item in the tree, the area to the right of the splitter bar will update its display so you can edit the information specific to that item. For Example, if you select an item in the tree that represents a particular Area Coach, the Edit Pane will display a screen that allows you to edit that coach’s name and email address and to set which stores that coach is assigned to. For further details on each Edit Pane type, please see the following sections

Store Edit Pane section

Organization Edit Pane section

Coach Edit Pane section

Coach Table Edit Pane section

Stores By Coach folder

The Stores By Coach folder takes all the stores in the BMU and hierarchically organizes them by Division Coach, Region Coach, Market Coach, Area Coach and Store.

Expanding the Stores by Coach folder displays folders for each of the Division coaches in the BMU that have stores assigned to them.

Expanding a Division Coach folder will display folders for the Region Coaches of the stores that have been assigned to that Division coach

Expanding a Region Coach folder will display folders for the Market Coaches of the stores that have been assigned to that Region coach and Division Coach

Expanding a Market Coach folder will display folders for the Area Coaches of the stores that have been assigned to that Market coach, Region Coach, and Division Coach

If a BMU does not use a particular type of coach then that level is removed from the hierarchy.

When you select a folder in the tree that represents a coach, the Coach Edit Pane will display in the area to the right of the Navigation Tree, allowing you to edit the coach’s name and email information. The Coach Edit Pane also enables you to set the stores assigned to that coach.

When you select an item in the tree that represents a store, the Store Edit Pane will display allowing you to edit that store’s information as well as the information of the owner and company/franchisee/licensee the store belongs to.

There is no edit pane associated with the Stores By Coach folder so and empty panel displays to the right of the Navigation Tree when you select that folder.
Stores By Ownership Type folder

The Stores By Ownership Type folder takes all the stores in the BMU and hierarchically organizes them by Ownership Type, Organization, and Store.

Expanding the Stores by Ownership Type folder displays folders for each of the Ownership types the BMU has organizations and stores for. The possible Ownership Types are Company, Franchisee and Licensee.

Expanding an Ownership Type folder will display folders for the organizations for that ownership type.

Expanding an Organization folder will display items for the Stores that belong to that particular Company, Franchisee or Licensee.

There is no edit pane associated with the "Stores By Ownership Type" folder so an empty panel displays to the right of the Navigation Tree when you select that folder.

When you select an item in the tree that represents a company, franchisee or licensee, the Organization Edit Pane will display allowing you to edit that organization’s information as well as maintain the Key Operators and Other Recipients that belong to the organization.

Coaches Table Folders

A folder is built for each coach type the BMU is configured to use. These are used to access the coaches of a particular type and the stores that have been assigned to them. These folders are:

Division Coaches

Region Coaches

Market Coaches

Area Coaches

FB Coaches

CHAMPS Coaches

CHAMPS Specialists (CER)

You might have noticed that the Key Operators and Other Recipients are not included in this list. They are treated a little differently from the other types of coaches. Further details for the Key Operators and Other Recipients can be found in the Coaches by Organization Folder section.

When you expand a coaches table folder you will see a sub-folder for each coach of that type that has been added to the BMU. In addition to the coaches there is a folder labeled “Unassigned Stores” that contains the stores in the BMU that have not been assigned to a coach of that type. That folder is displayed after the coach folders.

When you expand a coach folder, you will see the stores that have been assigned to that coach.

When you select a coaches table folder, the Coaches Table Edit Pane displays to the right of the Navigation Tree. Using the Coaches Table Edit Pane you can add or delete coaches of that particular type to the BMU. It also allows you to edit the name and email information of individual coaches. See the Coaches Table Edit Pane section for further details concerning that edit pane.

When you select an “Unassigned Stores” folder, an edit pane similar to the Coach Edit Pane will display that you can use to assign the unassigned stores to one of the other coaches.

Coaches by Organization folders

Key Operators and Other Recipients belong to a single company, franchisee or licensee and can be assigned only to the stores that belong to that particular organization. A folder is built for both those coach types. These folders are labeled as “Key Operators by Organization” and “Other Recipients by Organization” and are collectively referred to in this document as the “coaches by organization” folders.

When you expand a “coaches by organization” folder you will see a sub-folder for each organization in the BMU.

When you expand one of those organization folders, you will see a sub-folder for each Key Operator or Other Recipient that has been setup for that particular organization.