Setup packages
The separate desktop application and the dimescheduler-setup command line tool are no longer offered. Packages are composed, exported and applied from the Configuration packages page inside Dime.Scheduler. The file format below is unchanged, so packages built with the old tools still apply.
Most administration work is point-and-click inside a single tenant: create the users, lay out the profilesProfileA saved snapshot of a user’s planning board configuration, including the chosen layout and view options., configure the components. That is fine for one tenant, painful for ten. The moment you need to ship the same configuration to a sandboxSandboxThe separate Dime.Scheduler environment where upcoming features arrive before the production release. It has its own API host, sandbox.api.dimescheduler.com, so API clients target it explicitly., replicate a customer setup in a fresh environment, or commit a setup to source control so a change goes through review, the manual approach falls apart.
Setup packages are the answer to that. A setup packageSetup packageA portable JSON5 file describing a tenant’s configuration: profiles, layouts, users and settings. Also called a configuration package; it is composed, exported and applied from the Configuration packages page. is a portable, human-readable JSON5 file that describes a Dime.Scheduler configuration - profiles, layoutsLayoutA saved arrangement of the planning board - visible resources, columns, and settings - that can be reused., users, application settings - in a way you can version, diff, copy, and apply. Use them to replicate a tenant, share a configuration between instances, or hold a reusable template under git. No code required.
Choosing what goes into a package
What's in a package
The following entities can be packaged:
- Profiles: UI structure using columns, rows, stacks, and components
- Layouts: column layouts, sorting, filtering, and contextual settings per component
- Users: accounts, roles, profile assignments, categories, time markers, filter values
- Configuration: system-wide application settings as key/value pairs
In this section
Two pages cover the rest. The first is where you work: the Configuration packages page, and the quick start wizardQuick start wizardThe wizard that gives a new tenant a working setup by applying a ready-made profile template or a setup package, then walking through application setup, connectors and users. that gives a new tenant something to start from. The second is the reference for the file itself, for when you edit a package by hand or keep one under version control.
Configuration packages & quick start
Compose, export and apply configuration packages in the browser, and give a new tenant a working setup with the quick start wizard.
Format reference
The JSON5 structure of a setup package - bundles, document types, profiles, layouts, users and configuration.