Skip to main content

Report - Client Portal URL Links

Updated

Introduction

This article will describe the usage of the client portal URL link report.

Before you start 

To access this report, please add the following employee permissions to the suitable employee roles in PGM -> Clubs -> Employee permissions.

  • Reports
    • Custom
      • Client Portal URL Links

If this report is not available, please contact support to get access.

Instruction

To access the report, go to PGM -> Reports -> All.

You can use the search filter and find Client Portal URL Links or select Clubs tab and find the report.

In the report filters, the below filters are present.

  • Clubs - Select which club this report will generate. If left blank this will generate a report for all clubs your employee profile can view.

Report Extract

The Client Portal URL Link report will open with multiple tabs, each tab displaying a list of different URLs

This report will only display links where a club, product or payment plan is active and available to be sold on the client portal through the registration process.

ClubSelectionURL

This tab will provide a link to skip the club selection screen on the client portal registration process.

If you site only has one club, this process in the registration process is automatically selected as there is no need to select one of multiple clubs.

  • Club - Club Name
  • IsClubHidden - If the club is hidden to gym members in PGM->Clubs->List of Clubs, this will prevent the club being shown in the client portal. therefore any URL's will not be visible for this club in this report.
  • ClientPortalDirectURL - This is the URL that can be used to automatically select the option in the club selection screen. This will take the club member to the next phase of the registration process (Payment plan / product category selection (if used), or the Payment plan or product selection screen).

FreeOfferSelectionURL

This selection will automatically select the club, however will take the member straight into the personal details selection.  This will create a guest account for the club member with no payment plan or product being added to the registration process.

This is the same as the 'Create Account' option during the registration process.

  • Club - Club Name
  • IsClubHidden - If the club is hidden to gym members in PGM->Clubs->List of Clubs, this will prevent the club being shown in the client portal. therefore any URL's will not be visible for this club in this report.
  • ClientPortalDirectURL - This is the URL that can be used to automatically select the option in the club selection screen as well as the Create Account option in the payment plan selection screen.

CitySelectionURL

This tab will provide a link to skip the city selection screen on the client portal registration process. If there are more then one club in the city, this will display a club selection screen for any clubs in that city.

If you site only has one club, this process in the registration process is automatically selected as there is no need to select one of multiple clubs.

  • Club - Club Name
  • IsClubHidden - If the club is hidden to gym members in PGM->Clubs->List of Clubs, this will prevent the club being shown in the client portal. therefore any URL's will not be visible for this club in this report.
  • CityEnglishName - This is the name of the city that is used in PGM->Clubs->List of Clubs.
  • ClientPortalDirectURL - This is the URL that can be used to automatically select the option in the club selection screen. This will take the club member to the next phase of the registration process (Club Selection screen if more the one club is in the city, Payment plan / product category selection (if used), or the Payment plan or product selection screen).

PaymentPlan

This tab will provide a link to automatically select the payment plan on the client portal registration process.

If more then one club is selected on the report generation, this will separate each club into their own tables in the report.

  • Club - Name of the club
  • Source - Location of the payment plan
  • IsPaymentPlanActive - Is the payment plan active or not, Inactive plans cannot be sold.
  • PaymentPlanId - The unique Id of this payment plan.
  • Payment Plan Name - The name of the payment plan that is used internally.
  • DisplayName - The display name of the payment plan, if this field is blank then it will use the Payment Plan Name. More information can be found here under the header "Name and description for clients"
  • FeatureName - The feature name of the payment plan. More information can be found here under the header "Name and description for clients"
  • Content - The content name of the payment plan. More information can be found here under the header "Name and description for clients"
  • PaymentPlanFeatures - Features used on the payment plan, for more information about this please refer to the following KB article here.
  • CurrentMembershipFee - The current membership fee of the payment plan.
  • Payment interval - The frequency of the payment intervals.
  • Joining fee - The Joining fee of the payment plan (note. In client portal, this combines both joining fee and Administration fee into 'additional fees')
  • Administration fee - The Administration fee of the payment plan (note. In client portal, this combines both joining fee and Administration fee into 'additional fees')
  • MinimumCommitmentPeriod - The minimum commitment period of the payment.
  • Payment plan type - The plan type used on the payment plan.
  • AccessRule - The access rule associated with the payment plan.
  • Payment Source - The allowed payment sources that can be used with the payment plan.
  • MembershipAddOn - The membership add ons which are automatically added to the payment plan.
  • AdditionalPaymentPlanAvailable - The names of the additional payment plans (secondary contracts) which are available to be purchased with the payment plan.
  • AdditionalPaymentPlanAutoAssigned - The names of the additional payment plans (secondary contracts) which are automatically added when this payment plan is used.
  • VisibilityToEmployeeRole - Which employee roles can sell this.
  • ClubOpenDate - The club open date, this is set in PGM->Clubs->List of clubs.
  • SaleStartDate - The start date set on the payment plan that this can be sold from.
  • SaleEndDate - The end date set on the payment plan that this plan can be sold until.
  • IsUpfront - If the payment plan set as an upfront/paid in full/lump sum. This will be set to TRUE, else this is treated as a regular interval contract.
  • IsAutomaticallyEnded - If the payment plan is set to automatically end at the commitment period, it will be set to TRUE here.
  • StopChargingAfterMinPeriod - If the payment plan is set to prevent any future charges from generating after the commitment date of the contract as passed.
  • IsInitialFeeRequiredDuringOnlineRegistration - If payment is required during the online registration, this will be set to TRUE.
  • ClientPortalDirectURL - The URL that will directly link to the client portal.
  • PGMInternalURL - The internal URL which will connect to PGM and to the payment plan to edit the plan. Please do not use this URL to give to club members to sign up. 

Product

This tab will provide a link to automatically select the product on the client portal registration process.

If more then one club is selected on the report generation, this will separate each club into their own tables in the report.

  • Club - Name of the club
  • IsClubHidden - If the club is hidden to gym members in PGM->Clubs->List of Clubs, this will prevent the club being shown in the client portal. therefore any URL's will not be visible for this club in this report.
  • Product Id - The unique Id of the product.
  • Product Name - Name of the product.
  • Quantity - Quantity of product in bundle (or 1 if a single product)
  • ProductCategoryName - Name of the product category the product is connected to.
  • ProductDescription - Full description of the product.
  • ProductExpiry - Expiry date of the product, and how the expiry date triggeres.
  • AvailableForUser - Where and who can purchase this product, for this report only 'Everyone' and 'During registration' will be visible as the other options cannot be sold during the registration process.
  • ClubServiceType - The type of service this product is connected to, this allows interactions with other modules on PGM such as class bookings (BookingEvent) or access control (ClubEntrance) 
  • ProductSellPrice - The price of the product.
  • PriceLocation - Where the price is used - 'PriceSetOnProduct' - This is stored in PGM->Sale->Product on the product itself, its the default location.  'PriceSetByClub' - This is stored in PGM->Sale->List Of Clubs, this acts as an override to the product sell price and set up per club.
  • ClientPortalDirectURL - The URL that will directly link to the client portal.

 

PersonalTraining

This tab will provide a link to display the calendar for personal training by club, activity category and employee. Only if the Deep Link feature is available on your site.  This tab will be hidden if its not available.

If more then one club is selected on the report generation, this will separate each club into their own tables in the report.

  • Club - Name of the club
  • IsClubHidden - If the club is hidden to gym members in PGM->Clubs->List of Clubs, this will prevent the club being shown in the client portal. therefore any URL's will not be visible for this club in this report.
  • EmployeeId - The unique Id of the product.
  • Employee Name - Name of the employee (First Name, Last Name).
  • CP2MarketingDescriptionUsed - If there is an entry in PGM->Marketing->Employee Description, CP2 will use the details located there to fill out information on CP2
  • CP2DisplayName - Employee Name used on client portal that has been set in Employee Description.
  • CP2TrainerInformation - Content set in Employee Description
  • CP2Image - If the employee has an image set in Employee Description.
  • ActivityCategoryId - The unique ID of the Activity Category, this is used on the URL.
  • ActivityCategoryName - The name of the activity category.
  • TrainerLevels - The levels the trainer has, separated by a vertical line.
  • ClientPortalDirectURL - The URL that will directly link to the client portal.

For more information about the employee descriptions, please refer to this article.

For more information about PT Deep Links, please refer to this article.

Related articles