Skip to main content

How to use custom platforms

In this article, you will find how to create your own custom platform such as TikTok, where it will appear across the app.​

What custom platforms do​

  • Custom platforms let you create your own platform/source names such as TikTok
  • Once created, they can be used in royalties and expenses
  • They can also appear in platform filters, platform tables and platform graphs
  • You can also assign a custom color so they display consistently in graph breakdowns

How to create a custom platform​

  1. Go to the Platforms page

  2. Find the Custom Platforms section
    Custom Platforms section on the Platforms page

  3. Enter the platform name you want to create, for example TikTok

  4. Choose the color you want this platform to use in graph breakdowns
    Create a custom platform with name and color

  5. Save the platform

Important rules​

  • Platform names must be unique
  • Duplicate names are blocked case-insensitively
  • A custom platform cannot use the same name as an existing built-in platform
  • A platform can only be deleted if there are no royalties or expenses using it

Where custom platforms appear​

After a custom platform is created, it can appear in the following places:

  • royalty creation forms
  • expense creation forms
  • platform filters
  • platform breakdown tables
  • platform tooltips
  • Platform vs Total Royalties graphs

Example flow​

Let's take TikTok as an example.

  1. Create TikTok in the Platforms page
    TikTok created in Custom Platforms section

  2. Go to the Ext. Royalties/Expenses page

  3. Select TikTok as the platform/source when creating a new entry
    Custom royalty form with TikTok selected as platform

  4. Save the royalty or expense

  5. Open pages such as Book Stats or Dashboard Lite

  6. Use the platform filter and select TikTok
    Platform filter with TikTok selected

  7. The data will now be filtered accordingly and TikTok can appear in platform-based tables and graphs
    Platform graph tooltip showing TikTok

Editing a custom platform​

  • You can edit the platform name
  • You can edit the platform color
  • After editing, the updated platform should continue to appear in platform filters and graph breakdowns

Edit custom platform name and color

Deleting a custom platform​

  • A custom platform can only be deleted if no royalties or expenses are using it
  • If it is still being used, deletion should be blocked

Delete blocked because the platform is still in use

Suggested screenshots to attach before publishing​

Use the following screenshot set:

  1. Platforms page showing the Custom Platforms section
  2. Create form with platform name + color picker
  3. Saved custom platform row such as TikTok
  4. Custom royalty or custom expense form with TikTok selected
  5. Platform filter with TikTok selected
  6. Book Stats Platform vs Total Royalties graph showing TikTok
  7. Dashboard or Dashboard Lite platform tooltip / platform graph showing TikTok
  8. Delete restriction example when the platform is still in use