OBJECTS.md

ScoreHub data schema

This section is meant to explain some key concepts related to data storage and relationships between sObjects in ScoreHub.

Updating data in sObjects

One key concept that needs explanation is that in ScoreHub all the data should be either changed from the UI (by ScoreHub admins), or indirectly by firing a specific platform event.

Measurement__c and UserMeasurement__c sObjects

Measurement__c sObjects stores metrics that are tracked for each individual user, like "Number of converted leads". Specific values per each user are stored in UserMeasurement__c sObject.

classDiagram
    Measurement__c <|-- UserMeasurement__c
    User <|-- UserMeasurement__c
    class Measurement__c{
        +UniqueIdentifier__c
        +Description__c
    }
    class UserMeasurement__c{
        +Key__c, formula: User__c + Measurement__c
        +Measurement__c, lookup(Measurement__c)
        +User__c, lookup(User)
        Value__c
    }
    class User{
        +Id
    }

Loading

Achievement__c sObject

Achievement__c sObject stores achievements that are related to specific measurements. Achievement is considered to be reached by the user once the value in a corresponding UserMeasurement__c record reaches or becomes greater than the value in Achievement.Goal__c sObject

classDiagram
    Measurement__c <|-- UserMeasurement__c
    Measurement__c <|-- Achievement__c
    class Measurement__c{
        +UniqueIdentifier__c
        +Description__c
    }
    class UserMeasurement__c{
        +Key__c, formula: User__c + Measurement__c
        +Measurement__c, lookup(Measurement__c)
        Value__c
    }
    class Achievement__c{
        +Measurement__c, master-detail(Measurement__c)
        +Goal__c
    }

Loading

This comparison is executed each time UserMeasurement__c is created or changed. AchievementReachedEventsManager does the comparison and checks if achievement was already reached by the user.