Platform › Process & Structure
Approval Document Types
What can be sent for approval. The built-in types are run by their own modules' rules (listed under Approval Rule Catalogue) or by self-service; add a type of your own by naming the table it lives in. No code needed.
Where to find it
- Module: Platform
- Group: Configuration
- Section: Process & Structure
- Screen: Approval Document Types
Address in the console: /platform/approval-doc-types
List · 6 columns · 18 fields on its form · 5 of them required
What the list shows
These are the columns of the list, in the order they are drawn. Any of them can be sorted on, filtered on, hidden, or exported.
| Column | Kind | Field name |
|---|---|---|
| Type | Code | doc_type |
| Name | Text | label |
| Run by | Status | engine |
| Table | Code | table_name |
| No rule applies | Status | when_no_rule |
| Active | Yes or no | is_active |
The form
What is asked for when a record is created here. Required fields are marked; a choice drawn from a configuration list is one an administrator can extend without a release.
| Field | Type | Choices | Notes |
|---|---|---|---|
| Type key required | Text | Lower case, such as expense_claim or contract. | |
| Name required | Text | ||
| Table required | Text | schema.table, such as crm.contracts. It must carry org_id. | |
| Id column | Text | ||
| Number column | Text | The column people know the document by. | |
| Amount column | Text | Routes can be limited by amount when this is named. | |
| Currency column | Text | ||
| Description column | Text | ||
| Org unit column | Text | Routes can be limited to an org unit, and org-unit-manager steps need it. | |
| Screen module required | Text | The module of the screen the documents are kept on, such as crm. | |
| Screen resource required | Text | The screen key, such as contracts. Only people who may change that screen can send one for approval. | |
| Status column | Text | ||
| Status when approved | Text | ||
| Status when rejected | Text | ||
| When no route applies | Choice | Refuse to send it (safe), Approve it automatically | |
| Requester may approve their own | Yes or no | ||
| Active | Yes or no | ||
| Description | Long text |
The rules that apply here
Everything on this screen obeys the platform rules rather than rules of its own. The ones worth knowing before you use it:
- Narrowing a list — search, conditions, sort, totals, export and saved views.
- What may be changed — the five grounds a record may not be edited on.
- Companies and business units — what the switcher above this list is doing to it.
- Creating a record — required fields, where choices come from, and how the number is allocated.
- Importing a spreadsheet — this screen accepts one, and it runs through the same rules as typing.