Doens.be » Number Sequence

Working with numbersequences – On forms

Jeroen Doens — Thu, 18 Feb 2010 17:00:59 +0000

When you want to implement NumberSequences in a Ax form (new numbersequence when you create a record etc.) you can just implement the ‘numberSeqFormHandler’.

Step-by-step:

Define a object of the type ‘NumberSeqFormHandler‘ in the ClassDeclaration of the form

public class FormRun extends ObjectRun
{
    NumberSeqFormHandler            numberSeqFormHandler;
}

Create a new method on your form that create a new instance of the ‘numberSeqFormHandler’ object or creates a new object when it isn’t instanciated.

NumberSeqFormHandler numberSeqFormHandler()
{
    ;
    if (!numberSeqFormHandler)
        numberSeqFormHandler = NumberSeqFormHandler::newForm(TestParameters::numRefTEST().NumberSequence,
                                                             element,
                                                             TestTable_DS,
                                                             fieldnum(TestTable,TEST)
                                                            );
    return numberSeqFormHandler;
}

Complete some of the existing methods with the correct method of the ‘numberSeqFormHandler‘ object:

Table : Create() –> The user creates a new record in the data source.

public void create(boolean _append = false)
{
    ;
    element.numberSeqFormHandler().formMethodDataSourceCreatePre();
    super(_append);
    element.numberSeqFormHandler().formMethodDataSourceCreate();
}

Table : Delete() –> The user deletes a record in the data source.

public void delete()
{
    ;
    element.numberSeqFormHandler().formMethodDataSourceDelete();
    super();
}

Table : Write() –> The user inserts a new record or updates an existing one.

public void write()
{
    ;
    ttsbegin;
    super();
    element.numberSeqFormHandler().formMethodDataSourceWrite();
    ttscommit;
}

Table : validatWrite() –> new or updated record is to be written.

public boolean validateWrite()
{
    boolean ret;
    ;
    ret = super();
    ret = element.numberSeqFormHandler().formMethodDataSourceValidateWrite(ret) &amp;&amp; ret;
    return ret;
}

Table : linkActive() à The user selects a new record in a form that has a data source linked to another data source.

public void linkActive()
{
    ;
    element.numberSeqFormHandler().formMethodDataSourceLinkActive();
    super();
}

Close() –> The form is closed.

public void close()
{
    ;
    if (numberSeqFormHandler)
        numberSeqFormHandler.formMethodClose();
    super();
}

Working with numbersequences – Keep In Mind

Jeroen Doens — Wed, 17 Feb 2010 17:00:54 +0000

When you are using a Number Sequence, keep in mind that a Continuous Number Sequence is slower than a non-continuous. The reason is that the system creates a record in the table NumberSequenceList (with the status Active) and cleans it up later during TTSCOMMIT.

Performance tip: You can improve the performance of a process that creates many numbers of one Number Sequence by using number pre-allocation. This loads a set of numbers into the memory and provides faster access. You can do this by using the NumberSeqGlobal, witch means that once it is instantiated, it is available until the session is closed. This function is only available for non-continuous Number Sequences. The numbers can only be retrieved from the cache by calling the getNumInternal() method in the NumberSeq_Fast class.

Working with numbersequences – New Module

Jeroen Doens — Tue, 16 Feb 2010 17:30:28 +0000

In a previous post I explained how to create a new Number Sequence in a existing module (Working with numbersequences – new NumberSequence). In this post I will explain how you can create a new Number Sequence-module.
I will create a new module called TEST (lack of inspiration).

Step-By-Step:

First of all extend the existing Enum ‘NumberSeqModule’ with a new value ‘TEST’ and enter the name of the module in the Label-property
create a new class called ‘NumberSeqReference_TEST‘ and that extends from ‘NumberSeqReference‘.

Add a static method called ‘numberSeqModule’ and return the new value of the Enum.

public static NumberSeqModule numberSeqModule()
{
    return NumberSeqModule::TEST;
}

Override the Method loadModule and enter the necessary code for all the Number Sequences in your new module.

protected void loadModule()
{
    NumberSequenceReference numRef;
    ;
    /* TEST */
    numRef.DataTypeId               = typeId2ExtendedTypeId(typeid(TEST));
    numRef.ReferenceHelp            = literalstr("@SYS31561");
    numRef.WizardContinuous         = false;
    numRef.WizardManual             = NoYes::No;
    numRef.WizardAllowChangeDown    = NoYes::No;
    numRef.WizardAllowChangeUp      = NoYes::No;
    numRef.WizardHighest            = 999999;
    numRef.SortField                = 1;
 
    this.create(numRef);
}

In the class NumberSeqReference, you have to add some new lines so the system recognizes your new module. Complete the method construct & moduleList.
Open the NumberSequence-form under BASIC – SETUP – NUMBER SEQUENCES – NUMBER SEQUENCES
Open the Number Sequence-wizard
Follow all the steps of the wizard and finish
See how the new Number Sequence in the Number Sequence-form

From now on you can use your new Numbersequence and the module.

Working with numbersequences – new NumberSequence

Jeroen Doens — Tue, 05 May 2009 18:00:12 +0000

When you want to create a new NumberSequence in AX you have to do the following steps:
1. Create a new Extended Data Type (EDT). Often this EDT extends from num. (this step is not mandatory, but it is a best practice)

2. Discide in witch module this new Number Sequence Reference (classes NumberSeqReference_…) should be included and find the corresponding NumberSeqReference class. (ex. module sales –> NumberSeqReference_SalesOrder)

3. The loadModule() method shows a number of blocks of code, which creates records in the table NumberSequenceReference.

4.Copy a block and change the following fields:
* DataTypeID is the type Id of the new data type.
* referenceLabel is the description shown in the left column of the Number sequence tab on the parameters form.
* referenceHelp is the longer description of the reference shown in the top part of the Number sequence tab of the parameters form.
* sortfield defines the sequence that the references are displayed on the Number sequence tab of the parameters form.
* The wizard fields are default values when using the wizard to create a numbersequenceexample:

numRef.DataTypeId = typeId2ExtendedTypeId(typeid(NewType));
numRef.ReferenceLabel = literalstr("@...");
numRef.ReferenceHelp = literalstr("@...");
numRef.WizardManual = NoYes::No;
numRef.WizardAllowChangeDown = NoYes::No;
numRef.WizardAllowChangeUp = NoYes::No;
numRef.SortField = #;
 
this.create(numRef);

5. Create a static method on the parameter table that will be used to retrieve the reference. These methods usually start with “numref”.
example:

static client server NumberSequenceReference  numRefNewType()
{
return NumberSeqReference::findReference(typeId2ExtendedTypeId(typeid(NewType)));
}