Business Key
Every process instance gets a business key when it is started - a readable identifier for users, e-mails and phone calls. The format is configured per process in the business service, without code changes.
PR260930-3f9a1c2b instead of 8c3e5f0a-1b2c-4d3e-9f4a-5b6c7d8e9f01
The key can be used wherever a case is opened, e.g. /process/PR260930-3f9a1c2b.
Configuration
All settings live under eccatm.keyindex in application.yml of the business service:
eccatm:
keyindex:
keyRetryCount: 3
global:
enabled: false
pattern: "{00000000}"
default:
pattern: "EC{MMdd}-{RANDOM8}"
processes:
purchase:
pattern: "PR{yyMMdd}-{RANDOM8}"
| integer | attempts with a new key if a key is already taken. Default |
| boolean |
|
| string | pattern when |
| string | pattern for every process without an own entry. Built-in fallback: |
| string | pattern of one process, by its processId |
Order: global (if enabled), then processes.<processId>, then default, then the built-in fallback.
Pattern syntax
Text outside curly braces is copied literally. Each {...} is replaced:
| n random characters (0-9, a-f) |
|
|
anything else | Java |
|
|
Examples:
|
|
|
|
|
|
Keys may contain letters, digits, _ and - only.
Uniqueness
A key can exist only once. If it is taken, the business service generates a new key and retries the start up to keyRetryCount times. Always include {RANDOM<n>} (6 or more characters). A pattern with only a date, e.g. UR{yyyyMMdd}, allows only one case per day.
On this page
- Business Key