ERP 2.50:Developers Guide/How to create a dataset/it

Contents 1 Obiettivo 1.1 Introduzione al Concetto di Dataset 1.2 Dati Riferimento 2 Struttura Dati per definire Dataset 2.1 Livello Accesso Dati 3 Esportare un Modulo 4 Impacchettare un Modulo 5 Esempi 5.1 Dataset di Ruoli e Accessi 5.2 Dataset di Tasse o Avvisi 5.3 Dataset di regioni

Obiettivo

Questo how-to si concentrerà sulla creazione di un dataset in Openbravo ERP e anche sulla spiegazione con alcuni esempi in dettaglio nella sezione Esempi . I Dataset esportano sia i dati di riferimento sia i dati di default.

Introduzione al Concetto di Dataset

Prima di tutto abbiamo bisogno di capire il concetto di dataset , che permette di esportare i set di dati provenienti da tabelle diverse in un unico passaggio. Ciò è particolarmente utile per gestire e distribuire il modulo con i dati di riferimento, per esempio aliquote , le regioni o i dati di default in una nuova tabella(e) aggiunta da un modulo.

Un dataset è definito tramite le sue Tabelle di Dataset e le Colonne di Dataset . Questa configurazione dettagliata indica quali tabelle e quali colonne di ogni tabella verranno esportate.

Dati Riferimento

I dati di riferimento sono impacchettati, distribuiti e installat insieme al implementazione del codice di programma del modulo.

In Openbravo ERP 2.50, il concetto di dati di riferimento è generalizzato e qualsiasi dato nell'istanza può essere esportato in un modulo e importato per l'installazione / applicazione del modulo.

È possibile trovare il campo / opzione Contiene dati di riferimento al momento della creazione del modulo.

Struttura Dati per definire Dataset

Ci sono principalmente tre tabelle riferite come struttura dati per definire i dataset :

1. DataSet con le seguenti colonne:Value, Nome, Descrizione, Modulo e DataAccessLevel

• I DataSet hanno un nome e una descrizione per descrivere il contenuto del DataSet.
• Il valore è utilizzato per ottenere un oggetto DataSet dalla factory fornita da DAL (es. DBSourceManager ottiene il DataSet AD).
• Un DataSet è di proprietà di un modulo nello stesso modo degli altri componenti del Dizionario Applicazione.

Se la colonna esportazione permesso è spuntata viene visualizzato il  pulsante Export Dati di riferimento

2. DataSet_Table con le seguenti colonne:DataSet, Tabella, fullBusinessObjec, includeAllColumns, excludeAuditInfo e whereClause (espressione HQL)

• Un dataset può avere una o più tabelle prese da quelle registrati nel AD_Table. Per ciascuna di esse gli sviluppatori possono decidere di includere solo i record in quella tabella o esportare il business object completo utilizzando il flag fullBusinessObject.
• Gli sviluppatori possono inoltre definire per ogni tabella le colonne che sono inclusi nel dataset. Essi possono includere tutte le colonne con il flag includeAllColumns e poi rimuoverne alcune nella definizione della colonna o includere solo quelle che sono definite in modo esplicito nella definizione di colonna.
• Il whereClause è un espressione HQL per filtrare le righe che sono incluse nel DataSet. Dettagli su questa espressione saranno forniti nel progetto DAL.
• Gli sviluppatori possono escludere le colonna di informazioni di controllo come created, createdby, updated, ecc spuntando la colonna excludeAuditInfo.

Nota: Se il campo IsBusinessObject è spuntato allora i 'records-figli' della tabella vengono esportati.
 Per esempio se la tabella del dataset è definito per la tabella C_Order e questo campo è spuntato poi anche le righe della C_OrderLines correlate vengono esportate.

3. Dataset_column con le seguenti colonne: DataSet_Table, Colonna, isExcluded e conditionClause (espressione Java).

• Per ogni tabella in un dataset gli sviluppatori possono decidere quali colonne includere da quelle registrate nel AD di quella tabella.
• Si può escludere colonne utilizzando la casella di controllo isExcluded se hanno segnato la tabella come Includere tutte le colonne. Tipicamente info di revisione verranno rimossi dal dataset.

Livello Accesso Dati

Il Livello di Accesso ai Dati viene utilizzato per definire la modalità di importazione / installazione del modulo a vari livelli come livello di System, a livello di Client, a livello di Organizzazione, ecc Questi valori di livello di accesso è disponibile sulla tabella a Dataset. Di seguito è riportato il dettaglio esplicativo ad ogni livello di accesso.

• Solo System: i dati saranno importati al momento dell'installazione del modulo a livello di System senza alcuna interazione da parte dell'utente.
• Client: i dati saranno importati al momento dell'Installazione Iniziale del Client se l'utente sceglie il modulo in cui è incluso il DataSet.
• Organization: i dati saranno importati al momento dell'Installazione Iniziale del Organizzazione se l'utente sceglie il modulo in cui è incluso il DataSet.
• Client/Organization: i dati saranno importati al momento dell'Installazione Iniziale del Client o dell'Organizzazione se l'utente sceglie il modulo in cui è incluso il DataSet. Il modulo non può essere applicato a entrambi i livelli, allo stesso tempo, perché porterebbe alla ridondanza dei dati. Quindi, se il modulo viene installato in un client non sarà disponibile per poterlo applicare alle sue Organizzazioni e se il modulo viene installato in un'organizzazione non sarà disponibile, da applicare nel proprio Client.

Esportare un Modulo

Prima dell'impacchettamento abbiamo bisogno di esportare il modulo che crea una directory nella cartella modules della directory principale di Openbravo ERP e i file XML appropriati per l'inserimento nel modulo finito. I moduli che non sono etichettati come in sviluppo non vengono esportati in modo che bisogna ricordare che è necessario selezionare la casella di controllo In Sviluppo quando si definisce un nuovo modulo.

Quando lo sviluppo del modulo è finito, aprire una finestra di comando / shell e passare al progetto di sviluppo Openbravo ERP e eseguire il comando export.database.

ant export.database

Impacchettare un Modulo

L'ultimo passo nel processo è di confezionare il modulo e distribuirlo per l'utente finale.

Per creare un pacchetto di un modulo, eseguire il comando ant package.module -Dmodule=nomemodulo, dove nomemodulo è il nome del pacchetto Java del modulo. Quindi, nel caso del modulo howto, il comando sarà:

ant package.module -Dmodule=org.openbravo.howto

Esempi

Qui di seguito troverete degli esempi per sapere come creare un dataset e esportarlo con i dati di riferimento.

Dataset di Ruoli e Accessi

In questa sezione potete trovare l'esempio di un dataset di Ruoli e Accessi. Essa riguarda essenzialmente la definizione del ruolo all'interno dell'organizzazione e dei privilegi di cui hanno bisogno.

Creare un Ruolo e Assegnare Privilegi

• Collegarsi con il ruolo di amministratore del proprio Client.
• Cliccare su Configurazione Generale e Navigare su Sicurezza > Ruolo.
• Creare un nuovo record. Riempire i campi obbligatori richiesti per questo record :
  • Name = il nome del ruolo nella organizzazione del Client I.E Sales Clerk, Production Manager, Forcaster etc.
  • Active = opzione per assicurare che tale ruolo appaia nella applicazione generata. Durante lo sviluppo si può richiedere che il ruolo appaia quando è completo.
  • User Level = Questo controlla a quali organizzazioni il ruolo ha accesso. Ci sono 4 opzioni, le più comuni sono:
    • Organization - il ruolo ha accesso solo ai dati di una specifica organizzazione.
    • Client and Organization - il ruolo ha accesso ai dati specifica organizzazione e dati condivisi del Client .
  • Manual = indica se tutti i privilegi esistenti vengono automaticamente attribuiti al ruolo o se sono associati manualmente a seconda delle necessità. è E'consigliato selezionare questa opzione per il controllo manuale.

• Salvare il record.
• Ora è necessario assegnare alcuni privilegi cliccando sul pulsante "Grant Access".
• Selezionare il modulo e il tipo di accesso per assegnare i privilegi al ruolo appena creato.

Creare un utente e Assegnare l'utente al Ruolo

• Ora cliccate su Impostazioni generali e selezionare Sicurezza> Utente.
• Creare un nuovo record. Il campo Client mostrerà il nome del vostro client di default.
• selezionare l'organizzazione (che può essere per l'accesso ad una o tutte le organizzazioni in un client).
  • Nome.
  • Cognome.
  • Nome (Default).
  • Selezionare Attivo (Default).
  • Nome utente (il valore predefinito è una concatenazione di nome e cognome).
  • Inserisci la password dell'utente (Ricorda questo).
• Salvare il record.

• Selezionare la finestra Utente:
• Selezionare la scheda 'Ruoli utente'.
• Creare un nuovo record e selezionare un ruolo.
• Salvare il record.
• Aggiungi tutti i ruoli che il nuovo utente sarà in grado di avere / usare (una riga per ogni ruolo).
• Esci dal ruolo attuale.

Creare u nuovo modulo

• Log into Openbravo ERP as a System Administrator.
• Click on Module menu from the Application Dictionary.
• From the Module Type list, select Module.
• In the Name field, type the java package name of the module(proper naming convention).
• Complete the Description and Help fields. Supply the information about chart of accounts.
• Select the Has reference data option.
• Clear the Has chart of accounts, Translation required and Is translation module options.
• Select the In development option. Remember that you cannot work on a module unless the In development option is selected.
• On the Dependencies tab, select Core.
• Save the module

Create a Dataset of roles and access

1. From the Application menu, select Application Dictionary > Dataset
2. Click New.
3. From the Module list, select the module above created.
4. Specify a search key, name and description.
5. From the Data Access Level list, select the Data access level as Organization.
6. Select the Export allowed option.
7. Select the Table Tab
8. From the Table list, select the table whose content you want to include in the module. For example, ad_role_org_access, ad_role, ad_user_roles
9. In the SQL where clause field, specify the SQL "WHERE" statement that will identify the set of rows to be exported, in DAL notation. For example, adrole.id='2EA831D59184490E9BA858E9745EF89F'
10. Select the Include All Columns option.
11. Select isBusinessObject option
12. Click Save
13. Click the Export Reference Data button to export the reference data to an .xml file that you can include in the module

Exporting and Packaging Module

After completing all the steps successfully. Run the below ant task to

export the module:
ant export.database -Dmodule="org.openbravo.rolesandaccess"

packaging the module:
ant package.module -Dmodule="org.openbravo.rolesandaccess"

On successful execution of the above task an .obx file has been generated.

How to Install - Organization Access Level Reference Data

To install the new module into the running Openbravo ERP then need handle the steps carefully. In this example we have selected the access level as Organization then the installation would be done using Enterprise Module Management find below the steps.

• Log into Openbravo ERP as System Administrator.
• Install the OBX using Module Management under General Setup and rebuild the system.
• But the reference data will not be installed.
• Change the login as Openbravo Admin
• Click on General Setup and navigate to Enterprise > Enterprise module Management.
• Select the Organization type then select the appropriate module and click Ok to install the reference data.

Dataset di Tasse o Avvisi

In questa sezione potete trovare l'esempio su i dataset di tasse o di avvisi. Il processo di creazione di un modulo di dati di riferimento standard per le imposte e gli avvisi, è stato impostato Openbravo ERP in un modo particolare per soddisfare esigenze locali, è possibile esportare i dati e convertirli in un modulo, in modo da poterlo condividere con altri utenti.

Registrazione di un modulo dati per le tasse e gli avvisi:

• Entra in Openbravo ERP come System Administrator.
• Fare clic sul menu Modulo dal Dizionario Applicazione.
• Dalla lista Tipo di modulo, selezionare Modulo.
• Nel campo Nome, digitare il nome del pacchetto Java del modulo (convenzione di denominazione corretta).
• Compilare i campi Descrizione e Guida. Fornire le informazioni su piano dei conti.
• Selezionare l'opzione Ha dati di riferimento.
• Cancellare le opzioni Ha Piano dei Conti, Traduzione Richiesta, e E' un modulo di Traduzione.
• Scegliere l'opzione In Sviluppo. Ricordate che non si può lavorare su un modulo a meno che la scelta In Sviluppo sia selezionata.
• Nella scheda Dipendenze, selezionare Core.
• Salvare il modulo

Definizione ed Esportazione del Dataset

1. Dal menu Applicazioni, selezionare Dizionario Applicazione > Dataset
2. Fare clic su Nuovo.
3. Dall'elenco dei Moduli, selezionare il modulo creato in precedenza.
4. Specificare una chiave di ricerca, il nome e la descrizione.
5. Dalla lista dei Livelli di Accesso Dati , selezionare il livello di accesso ai dati come System Only
6. Selezionare l'opzione Consenti Export.
7. Selezionare la scheda Tabella
8. dalla lista Tabella, selezionare la tabella i cui contenuti si desidera includere nel modulo.
9. Nella clausola SQL where , specificare il comando SQL "WHERE" che identificherà l'insieme di righe che verranno esportate, in notazione DAL. Ad esempio, client.id = '1000001 '
10. Per esportare tutte le colonne, selezionare l'opzione Includere Tutte le colonne. Per includere solo alcune colonne, selezionare la scheda Colonne e creare un nuovo record per ogni colonna che si desidera esportare.
11. Per includere le colonne di sicurezza audit (created, createdby, updated and updatedby) nell'esportazione, deselezionare la casella di controllo Escludi Info Audit .
12. Deselezionare il campo Is Business Object.
13. Fare clic su Salva
14. Fare clic sul pulsante Esporta Dati di Riferimento per esportare i dati di riferimento a un file. xml che è possibile includere nel modulo.

Export e Packaging del Modulo

Dopo aver completato tutti i passaggi correttamente. Eseguire il seguente task ant per esportare il modulo:

ant export.database -Dmodule="org.openbravo.taxesandalerts"

packaging del modulo:
ant package.module -Dmodule="org.openbravo.taxesandalerts"

Se il task ant viene eseguito correttamente viene generato un file .obx.

Come Installare - Dati Riferimento con Livello Accesso System/Client

Per installare il nuovo modulo in Openbravo ERP quindi è necessario gestire la procedura con attenzione. In questo esempio abbiamo selezionato il livello di accesso come organizzazione quindi l'installazione potrebbe essere fatto con Gestione Moduli seguendo i passi :

• Fare il Log in Openbravo ERP come System Administrator.
• Installare il Modulo OBX usando Gestione Modulo sotto Impostazioni Generali e fare il rebuild del sistema.
• Ma i dati di riferimento non saranno installati
• Cliccare su Configurazione Generale e navigare su Client > Configruazione Iniziale del Client.
• Riempire tutti i campi obbligatori e quindi selezionare l'apposito modulo.
• Infine, fare clic su OK per installare i dati di riferimento.

Dataset di regioni

In this section you can export the reference data with the examples on regions. Find below the steps to create the Dataset for this module:

• Log into Openbravo ERP as a System Administrator.
• Create a new module called for the this example.
• Make sure that you have selected or flagged for the field Has Reference Data.
• Now expand the Application Dictionary menu.
• Click on Dataset menu and create a new record for the for this module.
• For example here I have given the Name as Indian States. You can give as you want to select the region.
• Fill up the Dataset form using the below mentioned values.

  • Field	value for the field
    Client	:	System
    Organization	:	*
    Active	:	make it flagged/put a tick mark
    Module	:	select the value from the drop down Indian States - 1.0.0
    Search Key	:	Indian States
    Name	:	Indian States
    Data Access Level	:	System Only

• Before assigning the tables to Dataset. Please execute the below query in sqldeveloper or postgres IDE to find the C_country_Id for "INDIA". After executing the below query the result of c_country_id would be 208 for the below query.

select * from c_country where countrycode like 'IN%';

• Navigate to Table Tab and create 2 new records for the dataset.
• One table called C_Country and another table called C_Region it look likes as given below.
  • Fill up the form by using below values for the Table Name: "C_Country"

  • Field	value for the field
    Dataset	:	Indian States
    Table	:	C_Country
    Active	:	Default it is flagged. Leave as it is
    Module	:	Indian States -1.0.0
    SQL Where Clause	:	id='208'
    Include All Columns	:	Remove the flag or tick mark (Note: Need to add the individual columns for this table using Column Tab)
    Exclude Audit Info	:	Mark it as flagged or put tick mark for this check box

• Fill up the form by using below values for the Table Name: "C_Region"

  • Field	value for the field
    Dataset	:	Indian States
    Table	:	C_Region
    Active	:	Default it is flagged. Leave as it is
    Module	:	Indian States -1.0.0
    SQL Where Clause	:	country.id='208'
    Include All Columns	:	Mark it as flagged or put tick mark for this check box
    Exclude Audit Info	:	Mark it as flagged or put tick mark for this check box

  • Select the "C_Country" table from the table grid view and navigate to Column Tab.
  • Click on create a new record button for the above table. You need to select three columns for this table.
  • Those columns are:(1)Name, (2)CountryCode, and (3)HasRegion
  • Fill up the following values in the form.

    • Field	value for the field
      Column 1:
      Dataset Table	:	C_Country
      Column	:	Name
      Active	:	It has benn flagged. Leave as it is
      Module	:	Indian States - 1.0.0
      Column 2:
      Dataset Table	:	C_Country
      Column	:	CountryCode
      Active	:	It has benn flagged. Leave as it is
      Module	:	Indian States - 1.0.0
      Column 3:
      Dataset Table	:	C_Country
      Column	:	HasRegion
      Active	:	It has benn flagged. Leave as it is
      Module	:	Indian States - 1.0.0

• Finally navigate to Dataset Tab of Indian States and Click on Export Reference Data button to export the data.

Exporting and Packaging Module

After completing all the steps successfully. Run the below ant task to

export the module:
ant export.database -Dmodule="org.openbravo.indianstates"

packaging the module:
ant package.module -Dmodule="org.openbravo.indianstates"

On successful execution of the above task an .obx file has been generated.

How to Install - System Only Access Level Reference Data

To install the new module into the running Openbravo ERP then need handle the steps carefully. In this example we have selected the access level as Organization then the installation would be done using Enterprise Module Management find below the steps.

• Log into Openbravo ERP as System Administrator.
• Install the OBX using Module Management under General Setup and rebuild the system.
• It will install along with the reference data.