Set up number sequences and apply a mask

To create or modify a sequence

1. From the Administration menu, select System tools > Sequence generator.

2. To define a number sequence, do one of the following:

   • Create a new sequence for the item by right-clicking either sequence option from the navigation tree and selecting New sequence. You can also select the Menu button and select New sequence from the list.

     

     Civic Platform organizes the items you can apply numbering to into several categories. Each category has a default numbering definition that is ready to use immediately, with no configuration. To review the predefined or default settings, see Recommended mask formats.

   • Locate and select an existing item in the navigation tree. To locate an existing item, select the plus sign (+) to the left of the sequence or mask type to expand the list of items.

     

     • Sequence by type organizes sequence definitions based on the sequence type, including: Agency, Asset ID, Record Id, Partial record ID, Temporary record Id, Record key, and Receipt.

     • Sequence by name lists the definitions based on the starting letter of the sequence definition name, and then by the sequence type.

     • Mask by type organizes mask definitions based on the sequence type.

     • Mask by name lists the mask definitions based on the starting letter of the mask name, and then by the sequence type

3. Complete or update the sequence definition fields.

   Field	Action
   Cache size	(Required) Enter the value to reflect how many of the numbers you want the sequence to pull or reserve at a time. The default value is 1. We recommend you do not change this value.
   Description	Enter text for describing the pattern or any other characteristics of this sequence definition. Maximum of 200 characters.
   Increment by	(Required) Enter the number that specifies the increase using a positive integer. Civic Platform does not support negative integers.
   Interval type	Select the type of interval for this sequence. The options are: None Calendar year Calendar month Calendar day Fiscal year Fiscal quarter Fiscal month The sequence value restarts based upon the interval type. For example, selecting Calendar year means the sequence number resets itself to the starting value at the start of every calendar year. Select None if you do not want the sequence number to reset itself based upon a date.
   Name	(Required) Enter a unique name for this sequence definition. It must be unique within the Sequence type selected.
   Reset action	Select the reset action. This field works in conjunction with the Reset value field. Reset action tells the sequence generator what action to take if you exceed the Reset value maximum. The default setting is Exception. You must configure Record keys and Record IDs to throw an Exception. If you exceed the Reset value maximum and an exception error displays, contact Accela Customer Support to resolve the issue. You might need to change the format. You must configure all categories to throw an exception, except the agency sequence type. You should only use the other one (Set to minimum) if duplicate sequence numbers are acceptable. Do not configure the Set to minimum option unless you are certain that duplicate numbers are not a problem. Civic Platform stores many of the sequence numbers in database columns whose values must be unique. If you choose the Set to minimum option, the sequence number resets to the Start value if you exceed the Reset value.
   Reset value	(Required) Enter the maximum value you want Civic Platform to generate from this sequence definition. When you exceed this maximum value the Reset action triggers.
   Sequence type	(Required) Select a sequence type. One exception to this grouping is the agency type which groups all single definitions together. Each Sequence type must have a unique Name. When you create the Mask definition for an item, first select the Sequence type that is the same as the Sequence definition. This filters the Sequence definition name list, listing only the Sequence definitions available for that Type. Then specify this Sequencedefinition using the Apply a mask definition table below.
   Start value	(Required) Enter the minimum starting value for the sequence.
   Status	Select the status. Enabled means you can use this definition. Set to Disabled if you no longer need to use this sequence definition. You cannot delete a sequence definition.

4. Select Submit.

5. Select Refresh in the navigation tree to display the sequence you just created or updated.

After creating or updating the sequence, you can apply a mask definition to the item.

To apply a mask definition

1. In the tree, locate the new or updated sequence and expand it by selecting the plus next to the sequence name.

2. Select (+) Masks under the sequence name.

   

3. Complete the mask definition fields in the Mask def section to the right.

   Field	Action
   Description	Enter text for describing the pattern or any other characteristics of this mask. Maximum of 200 characters.
   Maximum length	(Required) Enter a numeric value that defines the total number of allowed characters for the item or for the formatted sequence output. For example, a receipt number, or a Record ID number. Agency can be different for a predefined mask.
   Minimum length	(Required) Enter the minimum number of characters for the formatted sequence output.
   Name	(Required) Enter a name that defines the sequence mask. Maximum of 200 characters.
   Pattern	(Required) Enter mast pattern. Mask pattern describes how Civic Platform formats the sequence output. You must consider several fields when creating a pattern: The Sequence number base field works with the pattern. To make the pattern human-readable apply Base10. To use a key or coded apply Base36. The Sequence Number Base (10 or 36) is in this part of the sequence output [$$SEQ$$]. The Reset value and Interval type in the sequence definition. See Recommended mask formats. Include the date value in the pattern of the Interval Type to prevent duplication of numbers.
   Sequence def name	(Required) Select the sequence definition name for this mask to generate sequence numbers. You can only select a sequence definition from the list that is the same sequence type for the Mask definition. You must define the Sequence definition before you can assign it to a Mask definition.
   Sequence number base	Select a sequence number base. Use Base 10 for user readable numbers. Use Base 36 to display the sequence output [$$SEQ$$] using numbers and letters [0-9] and [A-Z]. See examples of mask patterns using Base 10 and Base 36 inRecommended mask formats
   Sequence type	(Required) Select the category of the sequence. For example, Record ID or Receipt. You cannot mix Mask definitions and Sequence definitions with different Sequence types. You also cannot assign a Record key mask definition in place of a Record ID definition
   Status	Select a status. Enabled means you can use this definition. Set to Disabled if you no longer need to use this mask definition. You cannot delete a mask definition.

4. (Optional) Use the Validate button to validate the maximum and minimum length, sequence type, and sequence number base against the mask pattern using a sequence of 1 and today's date.

5. Select Submit to save the mask definition.