Adding docs for prefilling configurations (not complete) and template types

This commit is contained in:
Thomas Georgios Giannos 2024-05-09 18:02:15 +03:00
parent f39ce3f93c
commit 0bb5d236dd
7 changed files with 97 additions and 5 deletions

View File

@ -116,7 +116,7 @@ Let's clarify a little bit more about our description multiplicity options. Ther
### Prefilling Sources form
We will explore this in detail in the [Prefilling Configurations](/docs/documentation/administration/blueprints/prefilling-configurations) section.
Here, we specify which of the available prefilling sources will be available for the user to select, when he creates a [plan](/docs/category/plans) using this blueprint. We will explore how these are configured in detail in the [Prefilling Configurations](/docs/documentation/administration/blueprints/prefilling-configurations) section.
---

View File

@ -3,4 +3,46 @@ sidebar_position: 3
description: View details about the prefilling sources
---
# Prefilling Configurations
# Prefilling Configurations
In this page, there is a listing where you can view details about all the configured prefilling sources. These are data sources coming outside of the platform, in order to help the user with filling out a [plan](/docs/category/plans) form with some basic information.
The information displayed by default is: the `label` of the source, the `status` and timestamps for the `creation` and `updates` of the records. At the top right corner of the listing you can also select which columns to display.
:::tip
For prefilling sources, all the columns are visible by default.
:::
You can also create new or edit / remove sources by clicking to the `+ Create Prefilling Source` button at the top right of the page or to the three dots at the last column, respectively.
## Authorization
Only users that have the **Admin** role can access this page.
## Navigation
This view is available when the user presses the `Prefilling Sources` link from the side navigation menu.
## Pagination
Not all the records are being displayed at once. By default, there is a pagination of 10 records applied to them.
You can control how many records are being displayed at any time, by adjusting the `items per page` control at the bottom left corner of the table.
## Filtering
There is a filtering option available for prefilling sources.
- **Is Active**: By toggling this control you can view only the active or only the disabled types.<br/>*By default, this option is set to true.*
In order for the filters to apply, you have to click the `Apply filters` button.
You can also clear any filters already applied, by pressing the `clear all filters` option, located at the top of the popup.
---
## Edit form
TODO: thgiannos

View File

@ -128,6 +128,8 @@ In this section we can specify query parameters we can apply to our requests.
- Name: The name of the query parameter. <br/>*For example, `like`.*
- Default Value: The default value of the parameter.<br/>*This is optional.*
---
## End notes
:::tip

View File

@ -3,4 +3,47 @@ sidebar_position: 3
description: Manage all description template types
---
# Template Types
# Template Types
In this page, there is a listing where you can view details about all the available descryption template types.
The information displayed by default is: the `display name` of the template type, the `status` and timestamps for the `creation` and `updates` of the records. At the top right corner of the listing you can also select which columns to display.
:::tip
For descryption template types, all the columns are visible by default.
:::
You can also create new or remove template types by clicking to the `Create Descryption Type` button at the top right of the page or to the three dots at the last column, respectively.
## Authorization
Only users that have the **Admin** role can access this page.
## Navigation
This view is available when the user presses the `Descryption Types` link from the side navigation menu.
## Pagination
Not all the records are being displayed at once. By default, there is a pagination of 10 records applied to them.
You can control how many records are being displayed at any time, by adjusting the `items per page` control at the bottom left corner of the table.
## Filtering
There is a filtering option available for descryption types.
- **Is Active**: By toggling this control you can view only the active or only the disabled types.<br/>*By default, this option is set to true.*
- **Status**: Filter types by their status. The status can either be `Draft` or `Finalized`.<br/>*By default, no status is selected.*
In order for the filters to apply, you have to click the `Apply filters` button.
You can also clear any filters already applied, by pressing the `clear all filters` option, located at the top of the popup.
---
## Edit form
In order to create a new Descryption type, all you have to provide is a name for it. If you want to save it as a `Draft`, press the `Save` button. Otherwise, press the `Finalize` button.

View File

@ -3,4 +3,6 @@ sidebar_position: 2
description: View details about the conditional questions
---
# Conditional Questions
# Conditional Questions
TODO: thgiannos

View File

@ -100,6 +100,7 @@ For a question you can specify:
- **Default Value**: If you set this, it will be the default answer for this question.
- **Input Placeholder Text**: Text that will appear to the input if it is empty. Only applicable if no default value is set.
- **Required**: If set to true, the answer will be mandatory.
- **Make Conditional Question**: Some question types can be displayed to the forms only if some conditions you specify here are met. You can view more information [here](/docs/documentation/administration/templates/conditional-questions)<br/>*By default, all questions are visible.*
:::info

View File

@ -3,4 +3,6 @@ sidebar_position: 11
description: Configure the tenant you are logged in with
---
# Tenant Configuration
# Tenant Configuration
TODO: thgiannos