NumberSequence — number sequence

What it is#

A rule for generating the ID value of a dictionary/document: start value, step, length with leading zeros, reset policy (for example, annually). A dictionary/document references the sequence through numberSequenceMetaId in its object.json. The server creates a sequence itself on import if you do not declare one explicitly, but the workspace convention requires declaring your own.

JSON envelope#

<Name>Seq.json, "kind": "NumberSequence" — one file, no subarrays:

{
  "kind": "NumberSequence",
  "object": {
    "padLength": 0,
    "startValue": 1000,
    "increment": 1,
    "resetPolicy": "None",
    "metaId": "<GUID NumberSequence>", "name": "CountrySeq", "modelId": "<GUID Model>"
  }
}

padLength: 0 means no leading zeros (the value as is: 1000, 1001...); padLength: 6 would give 000123. resetPolicy is the None/annual/monthly counter reset policy.

C# base#

None — pure data read by the platform numbering service (GetService<INumberSequenceService>()-like access through the core; scripts do not call it directly because the platform substitutes ID when creating a record).

Events / Chain of Command#

None.

Example#

CountrySeq — the number sequence of the Country dictionary in Common.