Getting started
Overview
After installation, an assistant takes you to your first sent quote in at most seven steps. It starts by itself when the administrator signs in for the first time. Every step can be skipped, and progress is stored on the server — across sign-outs and devices.
If you leave the assistant (“Continue later” or a click into the menu), a band above the content shows your progress with “Continue”. Once everything is done, “Done” closes the assistant; under Plugins, “First steps” opens it again at any time — completed steps stay completed.
Existing installations do not see the assistant by themselves: after an update it counts as completed. The same applies to an installation with sample data (showcase or test system, the “sample/demo data set” checkbox in the installer or app:install --with-demo): it starts on the overview with all functions (Pro), without the assistant and without the banner.
Core tasks
- Company and brand — name, address, VAT ID and logo, as they appear on quotes, invoices and mails. If
there is no brand yet, the step creates it; the logo can be uploaded after the first save.
- Starter package — Agency, Service provider, Trade, Support or Everything. Only the package's modules
are on afterwards; everything else stays installed and can be switched on with one click under “Unlock more”, where the modules that fit your package come first. The choice in the assistant also makes new colleagues start in the Basic level and administrators in Pro.
- Invite your team — e-mail and role per person; the role is suggested to match the package. The
invitation arrives by mail.
- Connect mailbox — leads to the setup of your personal mailbox or the company's sending mailbox. The
band then brings you back to the assistant.
- Numbers and payment terms — shows the number ranges with the next number (or the template while no
document exists yet) and the payment terms with the default. “Continue” confirms, “Change” opens the maintenance page.
- First quote — create a customer (a name is enough; with e-mail and address, sending takes one click), then
one line with a price. Sending mails the quote to the customer's address; alternatively download it as a PDF. If quotes are off in the chosen package, the step points to “Unlock more”.
- Sample data or your own data — sample data fills every view with a fictitious agency. Next to it are
all ways to bring your own data.
Load sample data and remove it again
“Load sample data” creates the sample set across all modules (about a minute). The system records exactly which records belong to it.
“Remove sample data” deletes these records again — without leftovers: including the history, search entries and files of the samples. Existing records that loading had filled in are back to their previous state. This only works as long as no own data has been created since loading (e.g. your own customer or quote). Otherwise the button stays locked and names the reason — so nothing of yours is lost. Whatever existed before loading is never touched.
Bring your own data
- CSV import (customers, contacts, products and further targets) under Settings → Data import
- awork via the awork migration in the settings (module “awork import”)
- HubSpot via the HubSpot import module — see HubSpot import
Fields in detail
| Field | Meaning |
|---|---|
| Name (company) | Required. Appears in the letterhead and as sender. |
| Address, country | Letterhead and payee. Country as ISO code, e.g. DE. |
| VAT ID | Printed on invoices; needed for intra-community supplies. |
| E-mail / role (team) | Empty rows do not count; without an entry the step counts as skipped. |
| Customer: name, e-mail, address | Name is required. To send, the customer needs an e-mail and a billing address (street, city; country as the company) — then the quote goes out with one click. |
| Service, price | One quote line; the tax rate comes from the tax catalog. |
Settings & permissions
- Assistant, band and sample data require the permission
platform.setup.manage(role GF/Admin). - The individual steps write through the usual paths and need their permissions: maintain brands, manage
users, create customers, create and send quotes.
- API:
GET/POST /api/v1/setup/erste-schritte(state, mark a step, pause, continue, complete, restart);
GET /api/v1/setup/beispieldaten, POST /api/v1/setup/beispieldaten (load), POST /api/v1/setup/beispieldaten/entfernen. Loading and removing are recorded in the audit log.
- Console (operations):
bin/console app:seed:demo-dataloads,bin/console app:seed:demo-data --entfernenremoves —
with the same rules.
FAQ & troubleshooting
The assistant does not start. It only starts by itself on a new installation without sample data. Under Plugins, “First steps” opens it at any time.
“Sample data cannot be removed: own data has been created since loading”. This is intentional: deleting samples between real data could damage your own. The named areas show where own data was created; sample records can be deleted there one by one.
“… loaded before this version”. Sample data loaded before this version carries no loading record; which records belong to it is unknown. It stays.
“To send, the customer needs a billing address …”. Street, city and country belong on every quote. Add them in the customer record or download the quote as a PDF.
The band is in the way. “Hide” hides it for the current session; “Done” in the assistant ends it for good.