How to :: switch from the “old home” to the “new home”

Warning

Don’t do this to an app in production! This process can be time consuming, so make sure you plan ahead before doing this.

Before you start

Have we mentioned you shouldn’t do this to a live/in production app?

Why switch?

We recommend you switch to the new home for a few reasons:

  • it’s much easier to use
  • no more complicated report/dashboard shenanigans
  • no more populate report/dashboard
  • further product developments will be made in “studio mode”
  • trust us, it’s better 🤩
  • and we are here for you if you need us

Why not switch?

Do not switch to the new home if:

  • your app is in prod and do not need any further adjustment
  • you don’t have time to do the switch
  • if you have more than 500 reports (lazy load is coming!)
  • you have some custom css on your tiles
  • you want a specific dashboard for each of your report (visibility/multiple dashboards)

Do the switch!

Dupplicate your app

This operation can be tricky so make sure you don’t destroy your beautifull work.

Dupplicate the app you wish to switch, and work on the dupplicate app before merging your changes.

Activate new home

You simply need to add a few lines within your front config to use the new home.

Open your front_config.cson and add this at the top, same level as Glossary for example.

home:
  skipToReport: 0
  title: 'Name of the home page'
  categories: []

Drop your new front_config.cson file in the Files interface.

Go back to your app, refresh and … 🔥🔥🔥 the studio 🙌🙌🙌

Don’t worry your tiles configurations are still available in your dashboard.cson file 😀

Customize your new home

From the studio you can now easily

And much more, find all the details here.

Update report and date requesters in your stories

From the file menu, download the updated front_config.cson file.

You should see a home block now.

⚠️ If you are using templating from the report or date (so something like <%= report.entityName %> or <%= requestersManager.date %>), this syntax has changed.

We have done some renaming, as these requesters are common to the whole app we have name them appRequesters.

To make sure your stories are still connected to these requesters, you have to manually do the update in your front_config.cson file.

You can do a ctr+f and replace all, or you can check story by story in a much safer way.

📝 For example, let say you have a report selector with a list of countries.

Your report dataset look like this:

countries zones
France Europe
UK Europe
Brazil America

📝 For example, let say you have a date selector with a list of dates.

Your report dataset look like this:

date groups
2018 month
2019 month
2018 Quarter

In your stories’ queries you may have done some templating, to make sure the chart will display data based on your user selection (in the report, or date selector).

So if you had something like this:

countries: "<%= report.entityName %>" or date: "<%= requestersManager.date %>"

It should become

countries: "<%= appRequesters.report %>" or date: "<%= appRequesters.date %>"

Once you have done all the changes, drop your new front_config.cson file in the Files interface.

completeObjectMode

If you have turned on the completeObjectMode to true to be able to use multiple columns from your report dataset, just like before, add the name of the column to your templating.

So it should become something like:

countries: <%= appRequesters.report.countries %> or zones: <%= appRequesters.report.zones %> or date: "<%= appRequesters.date.groups %>"

📖 Learn More about the completeObjectMode options here.

Migrate tiles

Unfortunately there is no easy way for this 😢

We couldn’t automate the switch for several reasons:

  • tiles didn’t have the dataset and charts new configuration blocks
  • some tiles had a chartOptions block and some no
  • some tiles configuration have changed a lot and options have been deprecated (but no deleted! you can still do it but in a much easier way)

What we recommend is to re-do all your tiles…

It’s long but see the bright size, you get a good studio training session! And do tiles with the studio is sooooo easy.

Check here how to do it.

Time to check

Once you have done all the changes you’re almost done!

Open the original app you diplicated and the new one you created with the studio home page.

And start doing checks. Change reports, date and see if all the numbers match between the apps.

Check your home page the same way.

If you’re ok with numbers and all, move on to the last step.

Ready for production

Copy your new front_config.cson file into your app. Tada!!! You’re all done.

Only available from the code mode

For now a few options are only available from the code mode. From the studio switch to the code mode to edit:

  • LinkTo, naviguate from your tiles to your stories. 📖 Learn More about the linkTo configuration here.
  • Staring, user stars to display a KPI 📖 Learn More about the staring configuration here.