Around the studio
What the studio does on every page: the version it shows, its help, what happens when your sign-in ends, and which pages you see.
The version, and About
The studio shows "Frontforge Report Server 0.10.0" under the sidebar of every page but the designer. In the designer it is at the top of the More menu's last group. A build made from a commit shows the commit too: "Frontforge Report Server 0.10.0-dev · 6dd2c99".
Click it, or pick About Frontforge Report Server… in the More menu or the command palette, to open the About dialog. It lists:
- the version, and the build when the version has one;
- the engine that lays reports out, and the RFML version it reads;
- the licence's edition;
- a newer release, when the version check found one (operations/updates.md).
Copy details copies them as text, for a support request. The Account and Licence dialogs show the version too. The sign-in page doesn't, so a visitor can't tell which version a server runs. GET /v1/info gives the same versions to a program.
Help: the documentation for this version
F1, on any page and in a text field too, opens this documentation in a new tab, at the version the server runs. So do the ? button beside your name at the foot of the sidebar, Documentation in the designer's More menu (over About), and Documentation in the command palette.
- A release opens its line's docs: a server on 0.10.0, or on 0.10.0-rc.1, opens
https://docs.frontforge.com/0.10/. A pre-release's pages say so in a banner. - A build made from a commit ("0.10.0-dev · 6dd2c99") opens the newest stable release's docs, at
https://docs.frontforge.com/. Its own changes may not be documented yet.
The docs are on the internet, so a server without internet access can't show them. The version picker at the top of every page of the docs moves to another release's.
When your sign-in is about to end
A sign-in lasts a set time, and the server can also end one that hasn't been used for a while (operations/state.md). Working in the studio counts as use, and so does saving, so the idle limit doesn't end the sign-in of someone at work.
Five minutes before the end, a card in the corner of the page says so; the page stays usable under it.
- When you haven't used the studio for a while, the card says when your sign-in ends. Stay signed in extends it, and Not now closes the card.
- When the sign-in reaches its time limit, it can't be extended. The card says when it ends and how many changes aren't saved yet, and asks you to finish and apply what you're editing. Got it closes it.
Sign in to continue
When a sign-in ends while the studio is open, because it ran out, someone signed it out, or an administrator ended it, the page is covered by Sign in to continue. It shows at the first thing the server refuses, or within 25 seconds of the end.
- What the page hasn't saved yet stays in it. Sign in again as the same user, in the card or in another tab of the same browser, and it is saved, and you carry on where you were.
- If someone else signs in there, nothing is saved as them. The card says whose changes they are, and offers Sign in as you instead, or Continue as them without them, which leaves those changes.
While a page holds changes that aren't saved yet, reloading or closing the tab asks first, in the browser's own dialog. That holds whether you are signed in or not.
Leaving the report's designer for another page of the studio (Back, the breadcrumb, another report) saves what it holds. When saving is failing, has stopped, or waits for the connection, the studio asks first in Leave without saving?, which says how many changes aren't saved and why. Stay (or Escape) keeps the page and the changes. Leave and lose them leaves, and a message says what was lost.
The pages you see
The sidebar lists the pages your roles let you open, and signing in opens the first of them. Someone without template.read, such as a data administrator, sees neither the Catalog nor Libraries, and starts on Data sources (operations/admin.md).
Locale and currency
A report's locale sets how dates, numbers and amounts look, which translations T() shows, and the PDF's language. Its currency is the one a plain currency format shows. Both are in the Output panel, under Document, and each is Fixed or From data:
- Fixed is a value written in the report, such as
en-AUorAUD. Every reader sees the report the same way. A locale left empty follows each reader's own. - From data is a formula between
{{ }}that gives the value for each render, after the data and parameters are read: a parameter (params.lang) or a field of the data (data.invoice.currency). The panel offers the report's text parameters and fields, those named like a locale or currency first, and the formula editor (ƒ) completes the names. The formula can read the parameters, the data,now, and the reader'slocaleandtimezone, but notvars. Under the field, the value the canvas is using with the preview's data: "Nowde-DE".
One invoice template can then bill a French customer in euros and an Australian one in dollars, from each bill's own data.
- When the data gives none (null or empty), the report acts as if it had no setting: a linked library's value, else the reader's locale. Without any currency, a plain
currencyformat can't show. - A value that isn't a locale or currency (
"English","€") is an error at the field. A published report's render stops on it, as on any error, so a bill isn't sent out formatted wrongly. A locale it has no formats for (mi-NZ, Māori) is used with a warning, as a fixed one is. - The first binding makes the report RFML 0.3, in the same undo step. Back to Fixed keeps the value in use, so nothing changes until you edit it.
- A node's own language (Language in the Inspector) stays a fixed value. For a different locale per row, put a sub-report in the row and give it its own locale from a parameter, or use
Format's locale argument:Format(row.amount, 'currency:' + row.currency, row.locale).