Sequencing Fields
This topic describes the fields and buttons that are available when building a sequence format from the Sequencing page or the Sequences subtab of the Foundations Setup page.
When you create a sequence format from the Sequencing page or 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.
Sequence Fields
Here is a description of the fields that are displayed when building a sequence format from the Sequencing page or the Sequences subtab. For information about the fields available in the Sequences table on the Sequencing page, see FDN Sequences Table Lightning Component Fields.
Key: * – Mandatory field; Descriptions of checkbox settings describe the selected (true) case.
| Field | Description | |
|---|---|---|
| Label | * | The name of the sequence format. The maximum length of this field is 40 characters. |
| Unique Name | * |
The unique name of the sequence format. The maximum length of this field is 40 characters. |
| Text | Static text to separate the parts of the number sequence. By default, the value for the text part is a hyphen (-). The maximum length of this field is 254 characters. | |
| 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/Target Field Object | * |
The object that contains the target field. |
| Target Field | * | The text field that stores the generated sequence number. The valid fields that can be used for the Target Field are Text, and Text Area. |
| 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 | If selected, the sequence format is enabled. Foundations only generates sequence numbers when the sequence format is enabled. | |
| Select the placeholder fields/Placeholder Field | * |
The field that provides the source data that replaces the field placeholder part in the generated sequence number. |
Buttons and Actions
The buttons available vary depending on whether you are accessing sequencing features from the Sequencing page or the Sequences subtab of the Foundations Setup page. The following sections describe the buttons, actions, and options displayed in each context.
From the Sequencing Page
The following buttons are available in the New Sequence window that opens when creating a sequence format from the Sequencing page and also in the Edit Sequence window that opens when you edit it. For information about creating or editing a sequence format, see Creating a Sequence Format. For information about the buttons available in the Sequences table on the Sequencing page, see FDN Sequences Table Lightning Component Fields.
| Button | Description |
|---|---|
|
|
Opens a sequence format part's menu. |
|
|
Increases the number length or the starting number of the number sequence part by one. |
|
|
Decreases the number length or the starting number of the number sequence part by one. |
|
|
Deletes the selected sequence format part. |
|
|
Clears the set of target field settings. If the target field you want to clear is the only existing target field, its content will be deleted, but the text box will remain. However, if there is more than one target field, the target field box and its content will be deleted. |
| Add Target Field | Adds a new target field to a sequence. |
| Add Field Placeholder | Adds a field placeholder part to the sequence format. |
| Add Number Sequence | Adds a number sequence part to the sequence format. |
| Add Text | Adds a text part to the sequence format. |
| Cancel | Closes the creation or edition window and discards any unsaved changes. |
| Save | Saves the sequence format. |
The following options and actions are available from sequence format parts' menus.
| Options and Actions | Description |
|---|---|
| Delete | Deletes the part from the sequence format. |
| Move Left | Moves the selected part one position to the left. |
| Move Right | Moves the selected part one position to the right. |
| Reset Sequence Number |
Resets the generated sequence number for each unique value in the specified placeholder field. When selected, the text in the field placeholder part changes from Placeholder to Placeholder (Reset), and a check mark appears next to the option in the menu. To deselect this option, click it again from the menu. Only available for field placeholder parts. For more information, see Resetting Numbers and Hiding Parts in a Sequence Format. |
| Reset Sequence Number and Hide Part |
Hides the field placeholder part that resets the sequence number. When selected, the text in the field placeholder part changes from Placeholder to Placeholder (Hidden), and a check mark appears next to the option in the menu. To deselect this option, click it again from the menu. Only available for field placeholder parts. For more information, see Resetting Numbers and Hiding Parts in a Sequence Format. |
From the Sequences Subtab
The following buttons are available on the Sequences subtab of the Foundations Setup page.
| Button Name | Description |
|---|---|
| New | Creates a new sequence format. |
| Delete | Deletes a sequence format. Click |
The following buttons are available in the Sequence Edit popup that opens 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.
Sequence
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/Sequencing page |
|
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/Sequence Format Builder | * |
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. |
Sequence Field
Here is a description of the fields on the Sequence Field metadata type.
Key: * – Mandatory field.
| Field | Label on the Sequences Subtab/Sequencing page | 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/Target Field 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. The valid fields that can be used for the Target Field are Text, and Text Area. |
| 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. |
Sequence Part
Here is a description of the fields on the Sequence Part metadata type.
Key: * – Mandatory field.
| Field | Label on the Sequences Subtab/Sequencing page | 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/Placeholder Field | * | 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. |