Share via


Number sequences (form)

Applies To: Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 Feature Pack, Microsoft Dynamics AX 2012

Click Organization administration > Common > Number sequences > Number sequences. Click the Number sequence button or double-click an existing number sequence.

Use this form to create or modify a number sequence.

Number sequences in Microsoft Dynamics AX are used to generate readable, unique identifiers for master data records and transaction records that require them. A master data or transaction record that requires an identifier is referred to as a reference. Before you can create new records for a reference, you must set up a number sequence and associate it with the reference.

Note

To set up number sequences that are related to a particular module, you can use the Parameters form for the module.

Task that uses this form

Set up number sequences

The following tables provide descriptions for the controls in this form.

Tabs

Tab

Description

Identification

Enter a number sequence code and a name for the number sequence.

Scope parameters

Select a scope for the number sequence. The scope defines which organizations use the number sequence.

Segments

Define the segments of the number sequence. The segments define the format of the numbers that are generated for the number sequence.

References

Select the document types or records that use the number sequence.

General

Specify general options for the number sequence. These options include whether a number sequence is active, the highest and lowest numbers that can be used, and whether users can change numbers generated from the number sequence.

Automatic cleanup

Set up a schedule for automatic cleanup of number sequences.

Performance

Set performance options for number sequences.

Buttons

Button

Description

Edit

Switch between view and edit modes in the form.

Delete

Delete the current number sequence.

Number sequence

Save the current number sequence and clear the form to create a new number sequence.

Generate

Open the Set up number sequences wizard to set up multiple number sequences. The wizard displays all required number sequences that are not yet defined.

Status list

Open the Status for number sequences form to view unused numbers in the selected number sequence.

Manual cleanup

Open the Inquiry form to clean up number sequences manually. If, for example, numbers in a number sequence are not used because of an error during update or a power failure, manual cleanup returns the missing numbers to the list with a status of Free.

Select Current to clean up numbers that are in the currently selected number sequence. Select All to clean up numbers that are in all number sequences.

Note

We recommend that you perform the cleanup as a batch job during non-peak hours.

History

Open the History form to view all changes that were made to the setup of the selected number sequence.

Fields

Field

Description

Number sequence code

Enter an identification code for the number sequence.

Name

Enter a short description of how and where the number sequence is used.

Scope

Select a scope for the number sequence.

The scope defines which organizations use the number sequence. In addition, number sequences that have a scope other than Shared can contain segments that correspond to the scope. For example, a number sequence that has a scope of Legal entity can contain a Legal entity segment.

When you select a value for the scope, you can modify the number sequence for that scope value. For example, when you select a particular legal entity, you can modify the number sequence that is used for the selected reference in that legal entity.

By default, the following scopes are available:

  • Shared – The number sequence is used in all organizations. Shared number sequences have alphanumeric and constant segments only.

  • Company – A separate number sequence is used in each company.

  • Legal entity – A separate number sequence is used in each legal entity.

  • Operating unit – A separate number sequence is used in each operating unit.

  • Company and Fiscal calendar period – A separate number sequence is used in each company and fiscal calendar period combination.

  • Legal entity and Fiscal calendar period – A separate number sequence is used in each legal entity and fiscal calendar period combination.

  • Operating unit type– A separate number sequence is used for each type of operating unit.

    This control is not available in versions of Microsoft Dynamics AX 2012 prior to cumulative update 6 for AX 2012 R2.

Segment

The segment type. By default, the following segment types are available:

  • Company – Displays the identifier for the company in which the number sequence is used. This segment type can be used only in number sequences that have a scope of Company.

  • Legal entity – Displays the identifier for the legal entity in which the number sequence is used. This segment type can be used only in number sequences that have a scope of Legal entity.

  • Operating unit – Displays the identifier for the operating unit in which the number sequence is used. This segment type can be used only in number sequences that have a scope of Operating unit.

  • Operating unit type – Displays an identifier for the type of operating unit in which the number sequence is used. This segment type can be used only in number sequences that have a scope of Operating unit type.

    This control is not available in versions of Microsoft Dynamics AX 2012 prior to cumulative update 6 for AX 2012 R2.

  • Fiscal calendar period – Displays the name of the fiscal period in which the number sequence is used. This segment type can be used only in number sequences that have a scope that includes Fiscal calendar period.

  • Constant – Displays a set of alphanumeric characters that does not change. Use this segment type to add a hyphen or other separator between number sequence segments. This segment type can be used in number sequences of any scope.

  • Alphanumeric – Displays a set of alphanumeric characters that increment with each number that is used from the number sequence. Use a number sign (#) to increment numbers and an ampersand (&) to increment letters. For example, the format #####_2014 creates the sequence 00001_2014, 00002_2014, and so on.

    This segment type can be used in number sequences of any scope. A number sequence must consist of at least one alphanumeric segment that contains as many characters as the largest possible value for the number sequence.

Scope segments, such as company or legal entity, are not mandatory for number sequences that have a scope other than Shared. However, even if you do not include scope segments in the format, numbers are still generated per scope.

Value

Enter a value for the number sequence segment type. For scope segments, a value is automatically inserted, based on your selections on the Scope parameters tab.

Length

The length of the number sequence segment. This value is based on the information that you entered in the Value field. You cannot directly modify the information in this field.

Format

A preview of the format of the number sequence. This value is based on the information that you entered for the segments. For numbers that are incremented, a number sign (#) is displayed. For letters that are incremented, an ampersand (&) is displayed.

Area

Specify the Microsoft Dynamics AX module or feature area where the number sequence is used.

Reference

Specify the document type or record that uses the number sequence.

Reuse numbers

Select this check box to use the same number that is being used for another reference.

For example, select this option if the invoice voucher number or the credit note voucher number should be the same as the invoice number.

This option is not available for all references.

If you select this check box, you must select a reference in the Use same number as field.

Use same number as

Select the reference that you want to reuse numbers from.

In use

Indicates whether the number sequence is being used.

Stopped

Select this check box to stop using the selected number sequence.

Manual

Select this check box to require manual entry of numbers. Number sequences are not generated automatically.

Continuous

Select this option to use a continuous number sequence. When continuous number sequences are used, the next available number from the sequence is used when a transaction is entered. The system verifies that no numbers from the sequence are lost. If a number is generated but the transaction fails, automatic cleanup makes the number available again.

Do not select this option if you must preallocate numbers.

To a lower number

Select this check box to allow users to change an automatically generated number to a lower number.

To a higher number

Select this check box to allow users to change an automatically generated number to a higher number.

Smallest

Enter the lowest possible value that can be used for to automatically generate numbers for the number sequence.

Largest

Enter the highest possible value that can be used to automatically generate numbers for the number sequence.

Important

An alphanumeric segment in the number sequence format must contain as many characters as the highest possible value. For example, if you enter 999999 in this field, the number sequence format must contain the alphanumeric segment ######.

Next

Enter the next value that is used to automatically generate numbers for the number sequence.

Clean up

A selected option indicates that the number sequence is cleaned up automatically.

This option is automatically selected when the number sequence is continuous. We recommend that you do not change the selection if it is automatically selected.

You can set up a time interval for automatic cleanup in the Interval field.

If there is a power failure, system failure, or other unexpected failure of the client at the same time that a number is generated, cleanup must be performed manually on either the current number sequence or all number sequences. To manually clean up number sequences, click the Manual cleanup button.

Note

If you do not select the automatic cleanup option, we recommend that you run a nightly batch job to clean up number sequences.

Interval

Enter the interval at which you want automatic cleanup to run. Enter 24 to run a cleanup every 24 hours. The cleanup is performed the first time that a number is generated after 24 hours pass.

Important

If you leave this field blank, cleanup is performed every time that the number sequence is used. This can cause a significant drop in performance.

Latest complete cleanup

The most recent date and time that cleanup was performed.

Preallocation

Generate numbers before they are needed and store them in system memory. Because selecting numbers from system memory is faster than selecting numbers from the database, this option can improve system performance.

Select this option only if you do not require continuous number sequences.

Quantity of numbers

Specify how many numbers you want to generate in advance and store in system memory.

For example, if you enter 10 in this field, the system generates and stores 10 numbers at a time. A new set of numbers is generated from the database every tenth time a number is required.

See also

Number sequence overview

Announcements: To see known issues and recent fixes, use Issue search in Microsoft Dynamics Lifecycle Services (LCS).