Skip to main content

Integration with external systems - filters and data

Updated

Introduction

This article will describe all available tabs and filters for an external Integration.

  • This article will be helpful to PG Champion, Club Manager, and Club Owner, as well as any employees actively using modules connected to the MyWellness integration.

Before you start 

To access the integration with external systems setting, please add the following employee permissions to the suitable employee roles in PGM->Clubs->System permissions.

  • Administrator
    • Integration with external systems
      • View
      • Edit

Feature description

To access the setting, go to PGM->Settings->Integration with external systems

Detail Integration Tabs

In the External Integration setting, there are multiple tabs present.  A member synchronization tab that lists all users that will appear in the external program, Message queue that lists all users in the queue to be synced to the external program, and System sync which shows the filters that can be chosen on what users to send to the external program.

System Sync filters are available in R88

Member Synchronization

  • User number - User number of the club member/guest in Perfect Gym.
  • Name - First name of the club member/guest in Perfect Gym.
  • Last name - Last name of the club member/guest in Perfect Gym.
  • Email - Email of the club member/guest in Perfect Gym.
  • System - External integration program (E.g. MyWellness).
  • Created - Date and time club member/guest was sent to the external integration program.
  • External data - Perfect Gym internal purposes only.

Message queue

  • Club - Home club of the club member/guest.
  • Action - Reason the club member/user is syncing to the external integration program.
    • AddUser  - New club member/guest being created in the external integration program.
    • UpdateUser - Current club member/guest personal information updating in the external integration program.
    • AddEmployee - Not applicable.
    • UpdateEmployee - Not applicable.
    • AddContract - Current club member/guest new contract adding to the external integration program.
    • UpdateContract - Current club member contract updating in the external integration program (E.g. End date changed).
    • AddMemberCard - Current club member/guest member card adding to the external integration program (E.g. RFID card).
    • RemoveMemberCard - Current club member/guest member card removed from the external integration program (E.g. RFID card).
    • ProductPurchase - Not applicable.
    • ClubVisit - Not applicable.
    • AddUserPresence - Current club member/guest visit is recorded in the external integration program.
    • AddProduct - Not applicable.
  • ObjectId - Userid for a club member and memberid for a guest user.
  • Status - Status of the club member/guest in the queue relating to the action above.
    • ToSend - Task is in the queue to send the club member/guest'action to the external integration program (task runs periodically throughout the day).
    • Processing - Task is currently running and sending the club member/guest's action to the external integration program.
    • Sent - Task has been run and the club member/guest's action has been sent to the external integration program.
    • Error - Task has been run, however, an error occurred when sending the club member/guest's action to the external integration program.
    • Failure - Task has failed to run.
    • ToResend - Task is in the queue to resend the club member/guest's action to the external integration program (task runs periodically throughout the day).
  • Message - API response that comes from the external integration program back into Perfect Gym.
  • System - External integration program (E.g. MyWellness).
  • Created - Date and time club member/guest was added to the queue to be sent to the external integration program.

Multiple systems mode

This tab allows to enable multiple external integrations. Please remember that not all integrations will work correctly with each other. This tab will be visible only when setting Domain.Policy.ExternalSystemSynchronizationPolicy have value Multiple. Click Enable button to turn on selected integration or Disable to turn off integration.

System Sync

This tab shows the filters that can be used to sync members to MyWellness. This tab is hidden from view.  If you wish to use any of the below filters, please contact Perfect Gym Support to assist in enabling the specific filters prior to your integration.

These filters work only during the initial sync, ie. when you click the orange button "external system sync". Afterwards all members are synced when changes are made. The only things you can control is if guests and leads are synced through settings Integrations.MyWellness.IsSyncingGuestsEnabled and  Integrations.MyWellness.IsSyncingLeadsEnabled

  • Allow create active members - Syncs members who are currently active.
  • Allow create frozen members - Syncs members whose main contract is currently on freeze.
  • Allow create future members - Syncs members who have a contract with a start date in the future.
  • Allow create cancelled members - Syncs members whose main contract has set 'CancelDate' - the contract has been cancelled.
  • Allow create courses members - Syncs members who are currently enrolled in a group.
  • Allow create members' parents - Syncs members parents where a parent does not have a contract.
  • Allow create guests with bundle - Syncs guests who have purchased a bundle and the bundles is currently active.
  • Only members with given payment plans - From all users selected in the above filters, syncs only club members who have the selected payment plans from the drop down menu.

The word 'create' in filter headings means sync

Scenario:

If you select  "Active members", "Future members", "members' parents" and select a number of payment plans, below is how the filtering will work:
1. Select all active members
2. Select all future members
3. Select all parents of above selected members
4. From all above selected members + parents, select only those users with selected payment plans
The system will take only those who have not been synced yet - this is not a 'visible' filter - it's rather a final filter

Related articles