Order Templates
Manage reusable order templates: create, edit, validate and delete templates and use them for order entry.
Order templates make it possible to define recurring order content once and reuse it when entering new orders. On this page, dispatchers and administrators manage the available templates: they create new templates, maintain their designation and content, check their validity and remove templates that are no longer needed.
Note: The management of order templates is available exclusively to users with the Administrator or Dispatcher role. Some functions are additionally restricted to superadministrators (Xplanis AG) (marked accordingly).
1. Navigation
The order templates can be reached via the main menu under Dispatch › Order Templates.
2. Order Templates Overview (Table)
The overview shows all order templates accessible to you in a sortable, paginated table. One template is displayed per row.
Columns
| Column | Description |
|---|---|
| Group | Group to which the template is assigned |
| Name | Designation of the template |
| Notes | Freely enterable remarks about the template |
| Private | Indicator (checkmark) whether the template belongs only to the creating user |
| Recurring Order Template | Indicator (checkmark) whether the template serves as the basis for a recurring order |
Only templates of those groups to which you have access are displayed. Recurring order templates whose associated recurring orders have all been deleted are hidden.
Sorting
Clicking on a column header sorts the list in ascending or descending order by that column.
Open / Select a Template
Clicking on a row selects the template. Many toolbar actions (e.g. Edit or Edit Content) require that exactly one template is selected.
3. Group Filter
The visibility of the templates can be deliberately narrowed down via the collapsible filter bar.
| Filter | Description |
|---|---|
| Group | Restricts the list to a specific group. The field offers a search function for quick selection. |
| Current Group Only | Restricts the display to templates of the currently selected group. If the option is deactivated, templates of associated groups are also displayed. |
After adjusting a filter, the list updates automatically.
4. Create a New Order Template
A new, empty order template is created with the «Add» button.
- Click the «Add» button in the toolbar.
- An empty template form opens. The current group and the entering user are already pre-filled.
- Fill in the fields (see Section 5).
- Save.
After saving, a confirmation appears that the template has been created, and the new template appears in the overview.
5. Edit Template Metadata
The descriptive details of a template are maintained via the Edit dialog.
Procedure
- Select a template in the list and open the Edit function (or create a new template).
- Adjust the desired fields in the dialog.
- Save.
Fields
| Field | Description |
|---|---|
| Name | Designation of the template. Mandatory field – without a name it cannot be saved. |
| Notes | Freely enterable remarks about the template. |
| Template Content (JSON) | Technical raw definition of the order content. This field is visible and editable only for superadministrators. For all other users the content remains hidden and is adopted unchanged. |
Caution: If the template content is edited directly in the JSON field, the system checks the data on saving. If the content cannot be read correctly, saving is aborted with an error message. Where possible, edit the order content via the order editor (see Section 6).
After saving, a confirmation appears that the template has been created or updated.
6. Edit Template Content in the Order Editor
With the «Edit Template» function you open the full order editor for the selected template. Here you design the actual order content – addresses, article items, time windows and further planning details – conveniently via the familiar entry mask, without having to edit the technical JSON content by hand.
Procedure
- Select exactly one template in the list.
- Click the «Edit Template» button in the toolbar.
- The order editor opens in its own window and loads the current content of the template.
- Enter or adjust the desired details.
- Save.
Notes and Restrictions
- The button is only active when exactly one row is selected.
- As long as a calculation of the goods units is still running in the background, saving is temporarily locked. In this case, wait until the calculation is complete.
- A maximum of two order editor windows can be open simultaneously.
7. Validate All Templates
Note: This function is available exclusively to superadministrators.
With «Validate Templates», the system checks the stored content of all order templates for its technical readability.
- Click the «Validate Templates» button in the toolbar.
- The system checks each template individually.
- Afterwards the result is displayed: either a success message or a listing of the templates whose content could not be read correctly.
This function is suitable as a diagnostic tool for detecting faulty templates early and correcting them specifically.
8. Delete Order Templates
Templates that are no longer needed can be deleted directly from the overview.
- Select one or more templates in the list.
- Click the «Delete» button in the toolbar.
- Confirm the safety prompt.
Deleting several templates at once (batch operation) is supported.
Caution: When deleting a template that serves as a recurring order template, the dependent recurring orders are automatically deleted along with it. Therefore, before deleting, check whether any running recurring orders still access the template.
9. Toolbar (General Functions)
The overview has a toolbar with the following standard functions:
| Function | Description |
|---|---|
| Select All / Clear Selection | Selects all templates in the list or clears the selection. |
| Refresh | Reloads the list to show the current status. |
| Search | Searches the templates by free text. The search takes into account Name, Notes and the ID of the template. |
10. Table Layout and Views
Saved Views (Templates)
Users can save their current table configuration as a view and restore it later with a click. Saved views appear as separate buttons in the toolbar; a click applies the stored configuration.
Layout Functions and State Retention
The column arrangement, sorting and filters can be adjusted via the general layout functions. The table configuration (column layout, sorting and filters) is saved user-specifically and is retained after logging out.
11. Using Order Templates in Other Areas
Order templates that have been created are available not only on this management page but can also be selected directly at other points in the application:
- Order creation: When entering a new order, a template can be selected via a selection field with a search function (autocomplete). The stored content is then adopted into the new order.
- Demand generation: Order templates can also be selected as a starting basis when generating demands (Trading Platform module required).
In both cases, you are only offered templates of those groups to which you have access. The search takes into account the name and the ID of the template.
12. Summary: Available Actions
| Action | Description | Requirement |
|---|---|---|
| Add | Create a new order template | Superadministrator |
| Edit | Edit name, notes (and JSON content) of the template | Template selected; JSON field only for superadministrator |
| Edit Template | Design the template content in the order editor | Exactly 1 template selected |
| Validate Templates | Check the content of all templates for readability | Superadministrator |
| Delete | Delete selected templates (incl. dependent recurring orders) | Template selected |
| Select All / Clear Selection | Set/clear the selection of all templates | — |
| Refresh | Reload the list | — |
| Search | Search templates by name, notes or ID | — |
| Saved Views | Save and restore the table configuration | — |