publicId Configuration
What
A public id is needed for entities for which interaction is needed with external parties. The id is created internally and it is exposed externally.
For example, when an invoice is send to a customer, that document needs a number. That number is created the invoice is created and is exposed on the invoice document.
For every entity which needs a specific sequenced number - a specific publicId generation mechanism can be configured.
Currently publicId generation is activated for:
- Agreement
- Party
- AccessPoint
- Invoice
- Timeseries
How
More information on how the different core PublicId definitions are set up can be found here:
The following steps explain how to create a new publicId definition:
- Open the publicId definition overview screen
- Click the New Definition button
- Click the EDIT button
- Enter information as required for your use case
- Entity Type Ref: Reference to the internal name of the Entity
- Field Name: Field name for which the publicId sequencer will work
- Format: Format of the output for the Field in the specific entity
- Sequence Start: Number from which to start the Sequence
- Sequence Inc: Number to increment the Sequence
- Sequence Reset Format: Currently not used
- Sequence Value: Last used sequence value on this specific publicId configuration
- Sequence Reset Trigger: Currently not used
- Click the SAVE button
Formats
publicId configuration can contain following elements:
- One or multiple constant strings
- Optionally one 'date' element with format: {"date": "<date format pattern>"}
- One 'sequence' element with format: {"sequence": "<sequence format pattern>"}
Example format: INV-{"date": "yyyy"}-{"sequence": "00000"}
Example output: INV-2020-00015
### **Date format pattern elements:**
Symbol Meaning Presentation Examples
G era text AD
C century **of** era (>=0) number 20
Y year **of** era (>=0) year 1996
x weekyear year 1996
w week **of** weekyear number 27
e day **of** week number 2
E day **of** week text Tuesday; Tue
y year year 1996
D day **of** year number 189
M month **of** year month July; Jul; 07
d day **of** month number 10
a halfday **of** day text PM
K hour **of** halfday (0~11) number 0
h clockhour **of** halfday (1~12) number 12
H hour **of** day (0~23) number 0
k clockhour **of** day (1~24) number 24
m minute **of** hour number 30
s second **of** minute number 55
S fraction **of** second number 978
z time zone text Pacific Standard Time; PST
Z time zone offset/id zone -0800; -08:00; America/Los_Angeles
' escape for text delimiter
'' single quote literal '
Did this answer your question?
😞
😐
🤩