AX 2012 - Number Sequence Framework

In questo post vedremo il funzionamento delle sequenza numeriche in AX 2012 creando una nuova sequenza per un modulo custom chiamato FCM con la relativa tabella dei parametri. La fonte di questo articolo è:
http://msdn.microsoft.com/en-us/library/aa608474.aspx Rispetto all'originale ho approfondito alcuni aspetti che risultavano un pò vaghi.

1) Creazione EDT: creiamo un unovo EDT per la nostra sequenza, unica accortezza che il nostro EDT dovrè assere di tipo "String". Rinominiamo l'EDT in "NSid", impostiamo una lunghezza (per es 15) assegnamo la label "Test sequenza numerica" e salviamo.

2) Creazione Tabella parametri: La tabella dovrò contenere ALMENO il campo chiave con il nostro EDT appena creato. Chiamiamo la tabella "NSParameters" e aggiungiamoci il campo. Implementiamo poi il classico metodo "find()" e facciamo l'ovverride dei metodi delete() e update() rispettivamente:

 void delete()  
 {  
   throw error("@SYS23721");  
 }  

 void update()  
 {  
   super();  
   flush NSParameters;  
 }  

ed i metodi per la gestione della sequenza:

 client server static NumberSequenceReference numRefNSIdNum()  
 {  
   NumberSeqScope scope = NumberSeqScopeFactory::createDataAreaScope(curext());  
   return NumberSeqReference::findReference(extendedtypenum(NSId), scope);  
 }  

 public NumberSeqModule numberSeqModule()  
 {  
   return NumberSeqModule::FCM;  
 }  

3)Modifica base enum: modificare l'enumerato "NumberSeqModule" aggiungendo il un nuovo valore che chiameremo FCM

4) Creazione nuova classe : La classe servirà a gestire la sequenza:

 //Classe per il setup delle sequenza numerica  
 class NumberSeqModuleFacilityManagement extends NumberSeqApplicationModule  
 {  
 }  

implementando i metodi:

 public NumberSeqModule numberSeqModule()  
 {  
   return NumberSeqModule::FCM;  
 }  

 void loadModule()  
 {  
   NumberSeqDatatype datatype = NumberSeqDatatype::construct();  
   datatype.parmDatatypeId(extendedTypeNum(NSid));  
   datatype.parmReferenceHelp("Riferimento unico all'elemento della sequenza");  
   datatype.parmWizardIsContinuous(false);  
   datatype.parmWizardIsManual(NoYes::No);  
   datatype.parmWizardIsChangeDownAllowed(NoYes::No);  
   datatype.parmWizardIsChangeUpAllowed(NoYes::No);  
   datatype.parmSortField(1);  
   datatype.parmWizardHighest(999999);  
   datatype.addParameterType(NumberSeqParameterType::DataArea, true, false);  
   this.create(datatype);  
 }  

5) Creazione form: creiamo il form per la nostra tabella dei paramtri. Come suggeriscono le BP di miscosoft e bene crere un nuovo tab con la relativa griglia che conterrà la Sequenza per il nostro modulo. Al form dovrà anche essere aggiunto il datasource della tabella NumberSequenceReference con le seguenti proprietà:

il form dovrà contenere i seguenti metodi:

 public class FormRun extends ObjectRun  
 {  
   boolean          runExecuteDirect;  
   TmpIdRef          tmpIdRef;  
   NumberSeqScope       scope;  
   NumberSeqApplicationModule numberSeqApplicationModule;  
   container         numberSequenceModules;  
 }

 public void init()  
 {  
   this.numberSeqPreInit();  
   super();  
   this.numberSeqPostInit();  
 } 

 void numberSeqPostInit()  
 {  
   numberSequenceReference_ds.object(fieldNum(NumberSequenceReference, AllowSameAs)).visible(numberSeqApplicationModule.sameAsActive());  
   referenceSameAsLabel.visible(numberSeqApplicationModule.sameAsActive());  
 } 

 void numberSeqPreInit()  
 {  
   runExecuteDirect  = false;  
   numberSequenceModules = [NumberSeqModule::FCM, NumberSeqModule::FCM];  
   numberSeqApplicationModule = new NumberSeqModuleCustomer();  
   scope = NumberSeqScopeFactory::createDataAreaScope();  
   NumberSeqApplicationModule::createReferencesMulti(numberSequenceModules, scope);  
   tmpIdRef.setTmpData(NumberSequenceReference::configurationKeyTableMulti(numberSequenceModules));  
 }  

Implementiamo i seguenti metodi nel datasource  "NumberSequenceReference" :

 void removeFilter()  
 {  
   runExecuteDirect = false;  
   numbersequenceReference_ds.executeQuery();  
 }

 void executeQuery()  
 {  
   if (runExecuteDirect)  
   {  
     super();  
   }  
   else  
   {  
     runExecuteDirect = true;  
     this.queryRun(NumberSeqReference::buildQueryRunMulti(numberSequenceReference,  
                                tmpIdRef,  
                                numberSequenceTable,  
                                numberSequenceModules,  
                                scope));  
     numbersequenceReference_ds.research();  
   }  
 } 

 int active()  
 {  
   int ret;  
   ret = super();  
   buttonNumberSequenceGroup.enabled(numberSequenceReference.groupEnabled());  
   return ret;  
 }  

Nel nodo design , nella griglia relativa al datasource "NumberSequenceReference" aggiungiamo 6 controlli.

Possiamo direttamente copiare questi controlli  dal tab numberSeq del form "CustParameters":

5 nella griglia:

- referenceLabel

- NumberSequenceReference_NumberSequenceId

- taxBookSectionId

- NumberSequenceReference_AllowSameAs

- referenceSameAsLabel

1 fuori:

- referenceHelp

Consigliamo a questo punto un riavvio dell'AOS

6) Job Caricamento: Creiamo un job per il refresh delle sequenze numeriche di tutti i moduli:

 static void NumberSeqLoadAll(Args _args)  
 {  
   NumberSeqApplicationModule::loadAll();  
 }  

7) Il Wizard:

1. Andare in Organization administration > Common > Number sequences > Number sequences.
2. Click Generate -> Set up number sequences wizard.
3. Completare il wizard per creare la nuova sequenza per il modulo custom

Se tutto è andato a buon fine se apriamo la lookup sul campo "Codice sequenza numerica" dovremo poter vedere la nuova sequenza con la descrizione equivalente al campo Label del nostro EDT:

Possiamo creare ora un job per iniziare a generare numeri con la sequenza numeri impostata nella tabella dei parametri:

 static void testNSId(Args _args)  
 {;  
   Info(NumberSeq::newGetNum(NSParameters::numRefNSIdNum()).num());  
 }  

8) Creazione form di utilizzo: creiamo un nuovo form in modo tale che ad ogni nuovo record creato venga automaticamente assegnato il numero di sequenza. Il form dovrà avere come datasource una nuova tablella (che chiameremo NSUsage) con almeno un campo di tipo NSid (cioè la stesso EDT creato al punto 1).
Metodi del from:

 public class FormRun extends ObjectRun  
 {  
   NumberSeqFormHandler numberSeqFormHandler;  
 } 

 NumberSeqFormHandler numberSeqFormHandler()  
 {  
   if (!numberSeqFormHandler)  
   {  
     numberSeqFormHandler = NumberSeqFormHandler::newForm(  
       NSParameters::numRefNSIdNum().NumberSequenceId,  
        element,  
        NSUsage_ds,  
        fieldnum(NSUsage, NSId));  
   }  
   return numberSeqFormHandler;  
 }  

il datasource dovrà contenere i seguenti 3 metodi:

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

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

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

Salviamo il form. A questo punto ogni volta che clicchiamo su nuovo, il campo "Test sequenza numerica" sarà automaticamente popolato con il numero della sequenza numerica selezionata nella tabella dei parametri:

A questo link potete trovare l' XPO del progetto