Articles in this section

Inner Range Integriti set-up and configuration

Karl Hawthorne
  • Updated

Overview

This article guides you through the process of connecting Clubware to Inner Range's Integriti Access control Software (ACS)
The article is divided into the following eight topics:

Prerequisites
   Role
Use case
Terminology
Configure organisation
Configure branches
Configure members
Configure staff members

 

Prerequisites

Role

You must have an Admin Role in all Branches or Branch groups you want to integrate Clubware with Inner Range's Integriti Access control Software.

You must have Admin access to Inner Range's Integriti System Designer

 

Use case

Access control Software (ACS) is used to provide gym Members access to the gym via an Access card or key FOB. Integriti is one of several ACSs that Clubware can be integrated with.

Before Clubware can establish a connection with Inner Range's Integriti ACS, both Clubware and Integriti Access levels must be configured correctly.

 

Terminology

The following is a list of key objects used to communicate Access levels between Clubware and Inner Range's Integriti ACS, and the different naming conventions in each software:

Clubware Integriti
Organisation Default Site
Branch Site
Member User
Staff member User
Membership plan Permission Group
 

Configure organisation

Integriti Default Site credentials must be added to the Clubware Organisation.

Clubware Integriti
Organisation Default Site

Integriti Default Site credentials are:

  • the organisation name (the gym/franchise name)
  • the remote host computer name (where Integriti software is installed)
  • the remote host URL
  • the remote host port number (default is 11000)
  • the remote host timeout (default is 60 seconds)
  • the username Clubware uses to log into Integriti software (default is Clubware)
  • the password Clubware uses to log into Integriti software
Configure branches 

Clubware Branches correspond to Integriti Sites.

Clubware Integriti
Branch Site

To map Clubware Branches to Integriti Sites, ensure the branch names match exactly. If the names match, the mapping will be accomplished.

Note: Both Clubware Branch names and Integriti Site names are case-sensitive

 

Identify branch names in Clubware

 
 1

In organisation view (grey menu), click Branches

Branches.png
 
  2

Check the spelling of each branch

Branche_list.png
 
 

Identify site names in Integriti

 
 1

Open Inner Range Integriti System Designer

Integriti_system_designer.png
 
  2

Check the spelling of each Site name listed in the Navigation panel

Navigation.png
 

Configure members

Clubware Members and Staff members correspond to Users in Integriti.

Clubware Integriti
Member User
Staff member User
 

Configure users in Integriti

To map Clubware Members and Staff members to Integriti Users, a custom field must be created in Integriti against the User entity:

 
 1

Open Inner Range Integriti System Designer

Integriti_system_designer.png
 
  2

Select Administration tab

Menu_-_administration.png
 
  3

Select Custom Fields

Custom_fields.png
 
  4

Add a new Custom Field

Add_custom_field.png
 
  5

Configure the following settings:

Site: Default Site
Name: ClubwareMemberId
Key Name: cf_ClubwareMemberId
Item Type: User
Field Type: Text

ClubwareMemberId.png
 

Map users to permission groups

In Integriti, Users are allocated Permission Groups to grant or deny access.
In Clubware, Members are allocated Memberships that derive from Membership Plans.

Clubware Integriti
Membership plan Permission Group

Each Membership plan contains an Access type:

Membership_plan__select__24_7.png

Both the Branch a Membership is purchased from, and the Access type of the Membership Plan determines the Permission Group a User is given in Integriti.

To identify which Permission Group should be granted to a User when their membership becomes active, a custom field must be created in Integriti against the Permission Group entity:

 
 1

Open the Inner Range Integriti System Designer

Integriti_system_designer.png
 
  2

Select the Administration tab

Menu_-_administration.png
 
  3

Select Custom Fields

Custom_fields.png
 
  4

Add a new Custom Field

Add_custom_field.png
 
  5

Configure the following settings:

Site: Default Site
Name: ClubwareAccessType
Key Name: cf_ClubwareAccessType
Item Type: Permission Group
Field Type: Text

ClubwareAccessType.png
 

How permission group mapping works

The following logic is used to find the appropriate Permission Group, based on the Membership Plan's Access type:

  1. If there is a Permission Group with a matching ClubwareAccessType value within the Site (Branch) that the membership was sold, this Permission Group is allocated to the User (Member).

  2. Otherwise, if there is a Permission Group with a matching ClubwareAccessType value within the Default Site (Organisation), this Permission Group is allocated to the User (Member).

  3. Otherwise, no Permission Group is allocated.

 

Example

A popular gym organisation with three branches (Albany, Birkenhead and CBD) wants to offer two types of memberships:

  1. A general 24 / 7 membership that allows members access to all their branches

  2. A low priced Off-Peak membership that only allows members access to the branch they purchase the membership from and only during their quiet periods

They create two membership plans in Clubware:

  1. A General Membership available for sale at all branches with an access type of 24 / 7 access

  2. An Off-Peak Membership available for sale at all branches with an access type of Branch off-peak

They get their Integriti security specialist to create permission groups in Inner Range:

  1. An All Branches 24 / 7 permission group on the default site that allows entry to all branches 24 / 7 with the ClubwareAccessType set to 24 / 7 access

  2. An Off-Peak permission group for each of the three branches (sites) that allows entry to that branch during their quiet periods with the ClubwareAccessType set to Branch off-peak. They are called Albany off-peak, Birkenhead off-peak and CBD off-peak.

They then sell the following memberships:

  1. Rowan purchases a general membership at the CBD branch, the membership plan has an access type of 24 / 7 access.
    There is no permission group for CBD marked 24 / 7 access but there is one for the default site marked 24 / 7 access so Rowan is assigned the All Branches 24/7 permission group.
    Rowan can access all the branches.

  2. Alexis purchases an off-peak membership at the CBD branch, the membership plan has an access type of Branch off-peak.
    There is a permission group for CBD marked Branch off-peak so Rowan is assigned the CBD off-peak permission group.
    Alexis can only access the CBD branch.

  3. Ripley purchases an off-peak membership at the Albany branch, the membership plan has an access type of Branch off-peak.
    There is a permission group for Albany marked Branch off-peak so Ripley is assigned the Albany off-peak permission group.
    Ripley can only access the Albany branch.

 

Group the Access types

All Permission Groups in Integriti need to have a value in the ClubwareAccessType custom field that maps back to the Membership plan's Access type.

To configure the ClubwareAccessType values in Integriti:

 
 1

Open the Inner Range Integriti System Designer

Integriti_system_designer.png
 
  2

Select the Access Control tab

Menu_-_access_control.png
 
  3

Select Permission Groups

Permision_groups.png
 
  4

Use CTRL key to multi-select the Permission Groups that will share the same ClubwareAccessType value

Permission_groups.png

In this example, we are going to assign both the CareTrack and Fitness passport Permissions Groups in Integriti to the 24 / 7 Access Access type within Clubware Membership plans.
 
  5

Right-click and select Edit

Permision_groups_-_edit.png
 
  6

Enter the Access type's name related to the selected Permission Plans

PermissionGroups__set_.png

If you selected an individual Permission Group you will see a different screen
Enter the Access type's name related to the selected Permission Plan

Customise_layout_tool__set_.png
 
  7

Save your changes

PermissionGroups__save_.png
 

Configure staff members

Clubware Members and Staff members correspond to Users in Integriti.

Clubware Integriti
Member User
Staff member User
 

Map staff members to permission groups

Clubware members will be allocated appropriate Permission Groups based on their Membership.
Staff members however do not use Memberships, therefore an additional custom field must be created against the Permission Group entity.

This custom field will be used to assign Permission Groups to a staff member based on the Branch(es) their Role(s) grant them access to.

Note: Currently all Roles grant the same Permission Groups, therefore there is no way to distinguish between Roles

 
 1

Open the Inner Range Integriti System Designer

Integriti_system_designer.png
 
  2

Select the Administration tab

Menu_-_administration.png
 
  3

Select Custom Fields

Custom_fields.png
 
  4

Add a new Custom Field

Add_custom_field.png
 
  5

Configure the following settings:

Site: Default Site
Name: ClubwareStaffAccess
Key Name: cf_ClubwareStaffAccess
Item Type: Permission Group
Field Type: Check Box

ClubwareStaffAccess.png
 
Was this article helpful?
0 out of 0 found this helpful
Return to top

Related articles