ores.inbox.approval_request_state
Table of Contents
Reference data table of the states of an approval request: 'waiting', 'held', 'approved', 'refused', 'withdrawn', 'expired'.
A final state has no exit but the ones the lifecycle names: approved can be
reversed with a comment, and refused, withdrawn and expired cannot be left
at all. The queue reads is_final to tell open requests from closed ones.
States are managed by the system tenant.
1. Flags
2. Columns
2.1. code
Unique state code.
Examples: 'waiting', 'approved'.
2.2. name
Human-readable name for the state.
std::string(faker::word::adjective()) + " State"
2.3. description
What the state means.
std::string(faker::lorem::sentence())
2.4. is_final
Whether a request in this state is closed.
2.5. display_order
Order for UI display purposes.
faker::number::integer(1, 100)
3. SQL
3.1. Flags
4. Validation function
5. Insert trigger
5.1. Validations
| column | validation_function |
|---|---|
| change_reason_code | ores_dq_validate_change_reason_fn |
6. C++
6.1. Flags
6.2. Repository
6.3. Domain includes
#include <string>
6.4. Entity includes
#include <string>
6.5. Conventions
6.6. Table display
| column | header |
|---|---|
| code | Code |
| name | Name |
| is_final | Final |
| display_order | Order |
| modified_by | Modified By |
| version | Version |
6.7. Presentation
6.7.1. Detail fields
| field | label | widget | type | is_key | is_required | placeholder |
|---|---|---|---|---|---|---|
| code | Code | codeEdit | line_edit | true | true | Enter state code |
| name | Name | nameEdit | line_edit | true | Enter display name | |
| description | Description | descriptionEdit | text_edit | Enter a description |
6.7.2. Columns
| enum_name | field | header | type | width |
|---|---|---|---|---|
| Code | code | Code | string | 120 |
| Name | name | Name | string | 200 |
| Description | description | Description | string | 300 |
| DisplayOrder | display_order | Order | int | 80 |
| Version | version | Version | int | 80 |
| ModifiedBy | modified_by | Modified By | string | 120 |
| RecordedAt | recorded_at | Recorded At | timestamp | 150 |
6.8. Custom repository methods
7. See also
- Approval requests — the lifecycle these states name.
- ores.inbox.approval_request — the record whose state this lookup names.