Customizing Microsoft Dynamics AX 2009

Number Sequence Customization

In Chapter 6, the sample X++ code shows that a service order feature must have a number sequence to generate a unique identification number. To achieve this, you must customize the number sequence class, setting up the relationship between a module and a number sequence reference, and also associating the number sequence reference with the extended data type in which you want to store a number from the sequence.

When you want to create a new number sequence, you must first create an extended data type. The ID of the type is used as the identifier for the number sequence reference, so it must be unique. Figure 5-19 shows a string data type named BikeServiceOrderId.

Figure 5-19. BikeServiceOrderId extended data type

The properties on the extended data type are set to create a type with a maximum length of 20 characters, as shown in Table 5-15.

Table 5-15. BikeServiceOrderId Property Settings

To implement a number sequence reference for service orders and assign it a specific service order number sequence, you must make changes to a NumberSeqReference class. To implement the reference in the Accounts Receivable module, among other references used by the sales order functionality, you add the following lines of X++ code to the loadModule method on the NumberSeqReference_SalesOrder class.

numRef.DataTypeId             = typeId2ExtendedTypeId(
                                typeid(BikeServiceOrderId));
numRef.ReferenceHelp          = "Unique key for the service order table, "+
                                "used when identification of a service "+
                                "order is allocated automatically.";
numRef.WizardContinuous       = false;
numRef.WizardManual           = NoYes::No;
numRef.WizardAllowChangeDown  = NoYes::No;
numRef.WizardAllowChangeUp    = NoYes::No;
numRef.SortField              = 100;
this.create(numRef);

These are the only modifications necessary to set up a new number sequence reference. The reference is available in the Accounts Receivable parameter form, and a number sequence can be created automatically by using the Number Sequence Wizard. You start the Number Sequence Wizard by clicking the Wizard button in the Number Sequences form located in the navigation pane under Basic\Setup\Number Sequences\Number Sequences.

The numRef table buffer in the preceding example is of a NumberSequenceReference table type. This table contains several fields that can be set depending on the reference you want to create. These fields are described in Table 5-16.

Table 5-16. NumberSequenceReference Field Explanations

Finally, the following method is implemented on the SalesParameters table. The method returns the new number sequence reference and should be used in the X++ code that requires numbers from the number sequence.

static client server NumberSequenceReference numRefBikeServiceOrderId()
{
    return NumberSeqReference::findReference(
                           typeId2ExtendedTypeId(typeid(BikeServiceOrderId)));
}