Managing Clients

Overview

Client feature allows Rooms to be associated to specific clients.  A Room must be assigned to a Client when it is created and can only be associated to one Client.  

The following guide will show you how to create and manage Clients within a Site.  The application does allow Site Administrators to configure the site in order to allow Clients to be associated with and available only from within specific Environments.  This is called "Multi-Tenant Mode".  Further information about Multi-Tenant Mode is available in the Multi-Tenant Mode article and in the section below titled "Multi-Tenant Mode Clients".

 

Creating New Clients 

Using Manage Clients page (available only to Site Admins)

• Click the Site Admin dropdown menu from the header menu bar and click Clients to access the Manage Clients page.

• From the Manage Clients page, click the New Client Button

 

• New Client window will appear.  Enter the new Client Name (required), a Client ID and click OK.  

The Client ID is usually a billing or accounting number.  This field can be optional or required depending on the value of SiteSettingKeyEnum 53.  Please refer to Configuring Site Settings article for additional information.

 

The combination Client Name - Client ID must be unique. An error message will be shown when trying to create a new client with a  Name  - ID that already exists.

• The new Client will appear in the list of Clients and may be associated to new or existing Rooms.

Note: when in Multi-Tenant Mode, Clients created this way are considered "Site Clients" and are visible and available to all Room Creators in all Environments.

 

Using the New Room Wizard (available to Room Creators)

New Clients may also be created on-the-fly when creating New Rooms.   

• Navigate to My Rooms and click the Room Actions dropdown menu and click on the Create New Room menu item.
• Select an Environment, type a Room Name and click the   sign next to Select a Client.

• Add Client window will appear.  Enter the new Client Name (required), a Client ID and click OK.

The Client ID is usually a billing or accounting number.  This field can be optional or required depending on the value of SiteSettingKeyEnum 53.  Please refer to Configuring Site Settings article for additional information.

The Add Client will be available to choose in the Select a Client dropdown selection menu.

Note: when in Multi-Tenant Mode, Clients created this way are by default only available from within the Environment where the Room is being created.  Site Administrators will have an additional option to choose from this menu in order to designate the new Client as a Site Client.  See the Multi-Tenant Mode section in this article for more information on this option.

 

Changing Client Name and Client ID

Only Site Administrators may change an existing Client's Name and Client ID.

• Click the Site Admin dropdown menu from the header menu bar and click Clients to access the Manage Clients page.
• Click the Edit icon to the left of the Client row that you wish to change.

 

• Using the Update Client window change the Client Name (required) and Client ID as desired and click OK. 
• When updating a Client, the combination Client Name - Client ID must be unique.

 

Deleting a Client

Only Site Administrators may delete a Client that is not assigned to any Room.

• Click the Site Admin dropdown menu from the header menu bar and click Clients to access the Manage Clients page.
• Click the Delete icon (X) to the left of the Client you wish to delete.  On confirmation message, click OK. 

 

 

Multi-Tenant Mode Clients

Multi-Tenant Mode is a configuration option for a Site that allows Clients to be created and available in only the Environment that the Client was created in.  The Client will not be available at the Site level, nor will it be available in other Environments.   Please refer to the Multi-Tenant Mode article for additional information about this feature.

 

Site Clients

When in Multi-Tenant mode it is still possible for Site Administrators to create and edit Site Clients using the methods described above.  Site Clients are visible and can be used from within all Environments in the Site.

 

Creating a Client within a Specific Environment

In order to create a Client within a specific Environment, you must either be a Site Administrator, or have Environment Administrator or Room Creator privileges within the Environment that you wish to create the new Client in.

 

From the Environment page

• Click the Site Admin dropdown menu and choose the Environments menu item.
• In the My Environments page, right-click on the Environment that you wish to create the new Client in.  The Manage Clients page for that Environment will appear in a new browser tab.

 

Using the Environment Manage Clients page

The Manage Clients page for the Environment looks very similar to the Site Manage Client page except that the Environment name will appear in the breadcrumbs in the top title bar and the rows will have two icons displayed:

 

	The globe icon indicates that this is a Site or Global Client and cannot be edited, except by Site Admins using the Site Admin > Clients page.
	The pencil icon indicates that this is an Environment Client that is editable from this page. This Client is available and visible only from within this Environment.

 

Creating a New Environment Client

From this page, click the New Client button in the title bar.  Using the New Client window, enter the Client Name (required), Client ID and click OK.

The new Environment Client will appear in the list and will be visible and available for use within this Environment.

Changing an Existing Environment Client

Click the Edit icon to the left of the Environment Client row that you wish to change.

Using the Update Client window change the Client Name (required) and Client ID as desired and click OK.

Deleting an Existing Environment Client

Click on Delete icon (X) to the left of the Environment Client row that you wish to delete. On Confirmation message click OK.  Only Clients which are not assigned to any room can be deleted.

 

From the New Room Wizard

New Clients may also be created on-the-fly when creating New Rooms.   

• Navigate to My Rooms and click the Room Actions dropdown menu and click on the Create New Room menu item.
• On New Room Wizard, click the   sign next to Select a Client.
• The Add Client window will appear.  Enter the new Client name (required), a Client ID (optional) and click OK. 

Note:  Site Administrators have the option in this dialogue to create a new Site Client rather than an Environment Client.  Checking the Save to All Environments checkbox will create a new Site Client.  This option is not visible to non-Site Administrators.  

The new Client will be available to choose in the Select a Client dropdown selection menu.