Sequencing Fields
This topic describes the fields and buttons that are available when building a sequence format from the Sequences subtab of the Foundations Setup page.
When you create a sequence format from the Sequences subtab, Foundations stores the data in several custom metadata records:
- Sequence
- Sequence Field
- Sequence Part
Full details about custom metadata fields is available in the Sequencing Custom Metadata Types section.
Sequences Subtab Fields
Here is a description of the fields that are displayed when building a sequence format on the Sequences subtab.
Key: * – Mandatory field; Descriptions of checkbox settings describe the selected (true) case.
Field |
|
Description |
---|---|---|
Label | * | Name of the sequence format. |
Unique Name | * | Unique name of the sequence format. |
Text | Static text to separate the parts of the number sequence. By default, the value for the text part is a hyphen (-). | |
Number Length |
The number of digits in the sequence. By default, the number length is 5. |
|
Starting Number | The starting number of the number sequence part. By default, the starting number is 0. | |
Object | * | The object that contains the target field. |
Target Field | * | The text field that stores the generated sequence number. |
Filter Field | The checkbox field that determines whether or not to generate a sequence for particular records. If you specify a filter field, Foundations only generates sequence numbers when the value for the specified checkbox is selected on the record. For example, if you have specified Sales Invoice as the object, you can specify Approved as a filter to ensure Foundations only generates sequence numbers for approved sales invoices. |
|
Enabled | Indicates that the sequence format is enabled. Foundations only generates sequence numbers when the sequence format is enabled. | |
Select the placeholder fields | The field that provides the source data that replaces the field placeholder part in the generated sequence number. |
Sequences Subtab Buttons
The following buttons are available on the Sequences subtab of the Foundations Setup page.
Button Name | Description | |
---|---|---|
New | Creates a new sequence format. | |
Deletes a sequence format. |
The following buttons are available when creating or editing a sequence format from the Sequences subtab.
Button Name | Description | |
---|---|---|
Add Part | Opens the sequence format menu. From this menu, you can add a field placeholder, text, or number sequence part. | |
Displays the part menu, which enables you to move or remove parts. | ||
Reset Sequence Number | Resets the generated sequence number when the field related to the field placeholder part contains a unique value. | |
Hide | Hides the field placeholder part that resets the sequence number. | |
Move Left | Moves the selected part one position to the left. | |
Move Right | Moves the selected part one position to the right. | |
Remove | Removes the part from the sequence format. | |
Add | Adds a new sequence field to the sequence. | |
Save | Saves any changes made to a sequence format. | |
Cancel | Closes the Sequence Edit popup and discards any unsaved changes. |
Sequencing Custom Metadata Types
This section provides information about the fields on the custom metadata types that make up a sequence format. Where a field directly correlates to one or more labels on the Sequences subtab of the Foundations Setup page, this is listed.
Here is a description of the fields on the Sequence metadata type.
Key: * – Mandatory field on the metadata type.
Field |
Label on the Sequences Subtab |
|
Description |
---|---|---|---|
Label | Label | * | Label of the sequence metadata type record. |
Sequence Name | Unique Name | * | Unique name of the sequence metadata type record. |
Format | Build the sequence format |
* |
Format of the number sequence. This defines the information that appears in the generated sequence number. This can include:
For example, depending on the related sequence parts and sequence field records, a format with BD-{1}-{2}-{3}-{000000} can generate the following sequence number: BD-UK-Credit Note-2017-000001. |
Text | |||
Number Length | |||
Starting Value | Starting Number | * | The starting number of the number sequence part. By default, the starting number is 0. |
Reset Sequence for Parts | Reset Sequence Number | A comma-separated list of sequence part index numbers that reset the starting value when the field related to the field placeholder part contains a unique value. |
Here is a description of the fields on the Sequence Field metadata type.
Key: * – Mandatory field.
Field |
Label on the Sequences Subtab |
|
Description |
---|---|---|---|
Label | - | * | Label of the sequence field metadata type record. |
Sequence Field Name | - | * | Unique name of the sequence field metadata type record. |
Sequence | - | * | Lookup to the related sequence record. |
Object | Object | * | The name of the object that contains the target field. |
Field | Target Field | * |
The name of the text field that stores the generated sequence number. |
Include Record | Filter Field | The name of the checkbox field that determines whether the record is eligible for sequencing. The checkbox or formula field must be equal to true for Foundations to sequence the record. | |
Enabled | Enabled | Indicates whether the sequence format is enabled for the object and field specified. |
Here is a description of the fields on the Sequence Part metadata type.
Key: * – Mandatory field.
Field |
Label on the Sequences Subtab |
|
Description |
---|---|---|---|
Label | - | * | Label of the sequence part record. |
Sequence Part Name | - | * | Unique name of the sequence part metadata type record. |
Sequence Field | - | * | Lookup to related sequence field record. |
Value | Select the placeholder fields | * | The API name of the field that provides the source data that replaces the field placeholder part in the generated sequence number. |
Index | - | * | Number that determines the order of the part in the sequence format. |