Tenant - Regions

To use, navigate to ORGANIZATION->TENANT->REGIONS

The grouping of individual locations into regions is the process of organizing distinct places (such as stores, offices, or sites) into larger geographic or logical clusters called regions.

This concept may be taken even further; by grouping smaller regions into one or more larger regions, even more efficient organization is possible.  

CruzControl is proud to introduce regions, or "regioning", with the release of version 3.1!

First, some terms need to be explained

Tenant and Site

CruzControl refers to "tenant"s and "site"s.  It is important to understand this organizational structure before proceeding.  A tenant is the top level of your CruzControl experience.  If you are a single site operator, you'll have a tenant assigned to you and named as per your request while working with Motor City Wash Works Client Success. Within your tenant you'll have access to your new location.  If you're a multi site operator, you'll have access to all your locations within your tenant.  If you're a distributor or representative authorized and requiring access to multiple tenants, you'll be permitted to select which tenant and then within the tenant, you'll have access to those sites you've been authorized to view.

Region relationship, or Depth

Regions are organized by a "Parent->Child" relationship. All regions and sites are "children" of Global, the "parent" region. Global Admin users are assigned to the Global region by default, thus allowing them immediate access to all sites.

CruzControl supports up to five (5) layers of depth (zero through four). For example, Global (depth 0) → United States (depth 1) → West Coast (depth 2) → California (depth 3) → Los Angeles County (depth 4). The site "Los Angeles Car Wash" may be assigned to Los Angeles County, the fifth layer down. All layers with the exception of Global are user definable.  Please note that the depth of a region is entirely up to you.  We'll understand this better as we explore examples later in this article.

Assigning a site to a region at any depth allows for auto provisioning of employees when said employee has been "subscribed" to that region.  To learn more about subscribing employees to regions, please see articles Users - Registering (adding) a New User and Users - Editing an Existing User.

 

Understanding via example

To better understand how regions work and how to use them, lets examine an example.  Consider the the following:

This tenant has three regions.

Global

Global is the system default region all new sites are assigned to.  Global is defined by CruzControl and may not be edited.  As indicated by the red arrows, Global exists at the top level, or "Depth 0".  This ensures as new sites are added, users assigned the Global Admin permission set may immediately 'see' the new site and organize it as they see fit.

If you do not intend to use regions, there is no need to proceed any further.  As all new sites are automatically assigned to the Global region, you're already all set with no further configuration required.

"Other Region" and "Southeastern U.S."

Here we also see two other regions; Other Region and Southeastern U.S..  Both of these regions are at depth 1; we take this to mean they're direct children of the Global parent.  Or in other words, these two regions are subregions of Global.  We'll be focusing on Southeastern U.S. as we proceed through our examples (indicated by the green arrows).

Clicking our Southeastern U.S. region brings up the following Region details window

Here several things about this region are shown.  Note that in all cases in which you can make changes, clicking SUBMIT will apply the changes and clicking CANCEL will discard any changes you've made here.  In both cases, clicking either will close this window and return you to the main Region list.

Name

The name you've previously given this region.  You may edit this name here.  

Description 

The description you've previously given this region.  You may edit this description here.  

Parent Region

To whom does this region belong?  In other words, who's its parent?  In our example above, this region is a child of Global, our top level (depth zero) region and therefore we know this region is at depth 1.  This is confirmed by the system; Depth (Number of Parent Regions) is shown to be 1.

Child Regions

Is this region the parent to any regions?  Currently as we can see, no this region has no children.  We will change this as we move forward through our example.

Sites

What sites belong to this region?  In our example above, currently one site, "The Car Wash Show - Cruz Lite" belongs to this region.  We can remove this site (clicking the X to the right of the site name) and/or we can add more sites (clicking the plus button within the list of sites).  As currently shown, we know this region contains one site.  This is confirmed by the system; Total Child Sites (Including Subregions) is shown to be 1.

For example purposes, let's return to the main Region list and add a new Region.  Later, we'll come back to this region and demonstrate several aspects of region organization.

Add Region

From the main Region list, we may add a new region by clicking ADD REGION.  This results in the ADD REGION wizard presenting itself.

Let's do this twice.  The first time, we'll add a Northwest Region and assign it to the parent region Global and click SUBMIT.

 

The system will add the region, confirm the region has been added, and display the next step.  Very similar to editing an existing region, here we're presented with a configuration window.  In this case, we've chosen to assign site "The Car Wash Show" to this region.  Clicking SUBMIT will apply our settings, Success! will again be confirmed and Xing out of this window returns us to the Region list.  We've just added a region and assigned it a site!

Let's now return to our previous example of Southeastern U.S.  Lets assume we've built a new site in Florida, that site has been added to CruzControl and is named "Northville Training Center".  We've got big plans for future expansion and so we've decided we'd like to start breaking up our Southeastern U.S. region by state.  This means we need to (1) create a new region named Florida, make our new Florida region a subregion, or child of our Southeastern U.S. region and (3) assign our new "Northville Training Center" site to our Florida region.

Well start by clicking ADD REGION on our main Region List.  This time, instead of assigning our new region to Global, we'll select Southeastern U.S..  The system tells us that Southeastern U.S. is currently under Global, so we know we're on the right track.  Clicking SUBMIT takes us to the next step.

The next step's windows tells us many things regarding what's about to happen.

Here we see that we are indeed adding this new Florida subregion (a child) to our already existing Southeastern U.S. region (a parent).  We've also specified that the site Northville Training Center is to belong to our Florida region.  Now note; as previously mentioned, when CruzControl ads a new site to our tenant, CruzControl adds the site to the Global top level parent.  This window is indicating that here we're moving this site from Global to our new Florida region.  

What's more, we see that Jane Doe, an example user created elsewhere within these articles, will also be added to our new Northville Training Center site, complete with her assigned permission set!  Why?  Because (1) Jane is subscribed to our Southeastern U.S. region, (2) we've made Florida a child of Southeastern U.S., (3) all children inherit the properties of their parent, and (4) our Northville Training Center site belongs to our Florida subregion, Jane needs to be added to Northville Training Center!  

To learn more about Jane's example, her permission set and how she was subscribed to a region, please see articles Users - Registering (adding) a New User and Users - Editing an Existing User.

To finish our example, after clicking SUBMIT to apply/accept these changes and closing the window, we're returned to our Regions main list.

As we can see, Florida now exists and at a depth of 2, under Southeastern U.S. (at a depth of 1).  Success!

More

Search

Typing within this box will automatically adjust the displayed list to only include those results that match or include your search criteria.

Count

Should you have many regions, the default list display of 10 may not be enough.  You may change this value to whatever you choose, and the list below will display your specified number of regions per page.

Filters

Should you have many sites and regions, the Filters menu may allow faster navigation of the Regions page.  Here you may sort by Depth from Low->High (depth 0 to depth 4) or High->Low (depth 4 to depth 0).  You may further refine your list by sorting by Name from A->Z or Z-A.