-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
62 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
# Survey | ||
|
||
The survey of an operation in Squest is actually the one configured in the RHAAP/AWX job templates. | ||
|
||
Squest administrator can select which fields will be exposed to the end users when requesting a service or a day 2 operation. | ||
|
||
By default, the approval workflow is composed of 2 steps: | ||
|
||
- Customer form (fields noted as 'customer field') | ||
- Admin form (All fields of the job template) | ||
|
||
If more steps are needed, you can create a dedicated [approval workflow](../administration/approval_workflow.md). | ||
|
||
|
||
## Is customer field | ||
|
||
A **customer field** is a field that will be displayed into the end user survey. | ||
By default, all fields are enabled when creating a new operation. | ||
|
||
Fields that are not **customer fields** can be filled by any users who have the **accept_request** permission. | ||
|
||
!!! note | ||
|
||
If the field is set as **required** into the RHAAP/AWX job template survey config then the administrator | ||
will have to fill it in any case during the review of the request. | ||
|
||
## Default value | ||
|
||
|
||
When set, the default value is pre-filled into the final form. It takes precedence over the default value set in RHAAP/AWX job template survey config. | ||
|
||
Default value precedence: | ||
|
||
```mermaid | ||
flowchart LR | ||
RHAAP/AWX(Default from RHAAP/AWX) --> squest(Default from Squest value) --> User(User's input) --> Admin(Admin's input) | ||
``` | ||
|
||
!!! note | ||
|
||
When used with a 'multiple select' or 'multiple select multiple' type of field, the value need to be a valid one from the RHAAP/AWX survey field options. | ||
|
||
**Jinja templating** | ||
|
||
Jinja templating can be used in the default value based on the current `{{ instance }}` and `{{ user }}` objects as context. | ||
Examples can be retrieved in the [dedicated documentation section](../advanced/jinja.md). | ||
|
||
Full `instance` and `user `object definition can be retrieved through the [API documentation](../../administration/api.md). | ||
|
||
## Validators | ||
|
||
Field validators are python modules that can be added as plugin to perform a custom check on a form field. | ||
See related [documentation here](../advanced/validators.md). | ||
|
||
|
||
## Attribute definition | ||
|
||
Each field can be linked to an _Attribute definition_ from the resource tracking. This allows to automatically limit the field value to a [quota](../access.md#quota). | ||
The available quota is shown in the form of the request so the end user know what he can still consume. | ||
|
||
![survey_quota](../../images/survey_quota.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters