Esprinet importazione catalogo: differenze tra le versioni

Da Dolibarr Wiki.
Vai alla navigazione Vai alla ricerca
(Creata pagina vuota)
 
Nessun oggetto della modifica
 
(10 versioni intermedie di uno stesso utente non sono mostrate)
Riga 1: Riga 1:
<div style="text-align:right;">'''Manuale utente rev. 1


'''“Modulo Esprinet importazione catalogo”'''
'''Versione del modulo: 2.0.0'''
'''Versione di Dolibarr supportate: 12.0.x / 13.0.x'''
'''Data: 13 Luglio 2021'''
'''Autori: Diciannove Soc. Coop.'''</div>
<div style="text-align:right;">'''''https://shop.19.coop'''''</div>
= 1. Introduzione =
Il modulo '''Esprinet importazione catalogo''' è il modulo sviluppato ad-hoc per Dolibarr ERP & CRM che consente l’importazione come prodotti predefiniti del catalogo “disponibilità prodotti” di Esprinet.
<br
Il modulo prevede la possibilità di collegarsi al server di Esprinet tramite protocollo s/ftp e scaricare il file del catalogo aggiornato. Tale file viene messo a disposizione dai servizi Esprinet ogni 15 minuti.
Tale operazione può essere effettuata automaticamente, tramite processo pianificato oppure manualmente.
= 2. Installazione del modulo in Dolibarr ERP&CRM =
<div style="color:#000000;">[[File:Img1 ddt-italia manuale.png|346x346px]]</div>
<span style="color:#000000;">Una volta scaricato il pacchetto contenente il Modulo “</span><span style="color:#000000;">Esprinte importazione catalogo”</span><span style="color:#000000;">, il contenuto va copiato nella cartella “</span><span style="color:#000000;">''/custom”''</span><span style="color:#000000;"> all’interno della directory principale di Dolibarr ERP&CRM.</span>
<span style="color:#000000;">Effettuata questa operazione il modulo va attivato dalla pagina </span><span style="color:#000000;"><u>Impostazioni</u></span><span style="color:#000000;"> → </span><span style="color:#000000;"><u>Moduli/Applicazioni.</u></span>
<div style="color:#000000;">{{clear}}</div>
'''Nota 1: '''dopo aver copiato il modulo nella cartella “''/custom”'', se esso non risulta ancora visibile nell’elenco dei moduli, è necessario attivare nel file di configurazione di Dolibarr ERP&CRM le due direttive seguenti:
<div style="text-align:center;">$dolibarr_main_url_root_alt
$dolibarr_main_document_root_alt
</div>eliminando le “//” iniziali e compilando con il percorso corretto.
In un’installazione Dolibarr ERP&CRM eseguita a partire da files zip o tar.gz, il file di configurazione chiamato '''conf.php''' è all’interno della cartella ''htdocs/conf/.''
Per ulteriori informazioni consultare il link: [https://wiki.dolibarr.org/index.php/FAQ_Custom_module_install https://wiki.dolibarr.org/index.php/FAQ_Custom_module_install]
<span style="color:#000000;">'''Nota 2'''</span><span style="color:#000000;">: è necessario effettuare il login al sistema con un account avente privilegi di “Super amministratore” per poter accedere alla pagina delle Impostazioni.</span>
= <span style="color:#800000;">3. </span><span style="color:#800000;">Configurazione</span><span style="color:#800000;"> del modulo</span> =
Una volta effettuato l’accesso con un account avente i privilegi di “Super Amministratore”, si accede al menù laterale “'''Impostazioni'''” e quindi “'''Moduli/Applicazioni'''”. Si scorre la pagina fino ad arrivare al modulo “Esprinet Importazione Catalogo” oppure si utilizza l’apposita funzione di ricerca in cima alla pagina.
Una volta attivato il modulo (pulsante toggle) si può accedere alla pagina di impostazioni (pulsante ingranaggio). La pagina di impostazioni del modulo è la seguente:
{{clear}}
[[File:Img4 import esprinet catalogo manuale.png|1080x1080px]]
Per modificare questi parametri, premere il tasto “'''Modifica'''” in fondo alla pagina.
<div style="color:#007b8c;">Opzioni generali:</div>
Il primo parametro da indicare è il login (username) di un utente del sistema, al quale andranno assegnati i privilegi per “'''eseguire i processi pianificati”'''.
{{clear}}
[[File:Img5 import esprinet catalogo manuale.png|1080x1080px]]
All’utente poi si possono assegnare anche i permessi specifici introdotti dal modulo:
{{clear}}
[[File:Img6 import esprinet catalogo manuale.png|1080x1080px]]
Tutte le configurazioni dei vari parametri sono descritti in maniera puntuale.
L’opzione “<span style="color:#202020;">Effettua il backup del database prima dell'importazione del catalogo</span>”, se attivata, effettuerà un backup di tutto il database '''prima''' di effettuare l’aggiornamento del catalogo. Si consiglia l’attivazione di questa opzione.
Le ultime due opzioni determinano se utilizzare una connessione via s/ftp per scaricare direttamente dal repository Esprinet il catalogo (versione più aggiornata) da importare in Dolibarr. Nell’ultima opzione “<span style="color:#202020;">Connessione FTP per download file zip catalogo</span>”, andrà selezionata quale connessione FTP, configurata nel modulo FTP (vedi procedura a seguire), utilizzare per il download del file DispoP contenente il catalogo.
<div style="color:#007b8c;">Opzioni per processo pianificato (importazione tramite Cron Job automatico):</div>
Queste opzioni verranno utilizzate dal processo pianificato. La prima opzione, se attivata, utilizzerà la stessa connessione indicata nella sezione precedente.
L’opzione “<span style="color:#202020;">Percorso del file zip da prelevare rispetto la root del server FTP (es. "cartella1/cartella2/" oppure "/" per indicare la cartella root)</span>” di default può essere lasciata vuota (equivale a “/”) così come la terza opzione “<span style="color:#202020;">Nome del file zip da utilizzare per l'importazione automatica (es. dispoP.xml.zip)</span>” è corretto inserire il valore di esempio '''dispoP.xml.zip''' (Consultare comunque Esprinet in caso di configurazioni particolari).
È possibile avviare manualmente il processo pianificato visitando il link “<span style="color:#000000;">URL per controllare ed eseguire il processo di importazione catalogo in cron</span>”
<div style="color:#007b8c;">Opzioni invio notifica email:</div>
Abilitando tramite la relativa opzione l’invio delle notifiche email, verrà inviata una email al termine della procedura di importazione del catalogo, con oggetto e testo definiti sempre in questa sezione, agli indirizzi indicati (indirizzi email da inserire separati da una virgola ‘,’ ).
<div style="color:#007b8c;">Impostazioni modulo FTP client:</div>
Le impostazioni dell’FTP vanno configurate nel relativo modulo core del gestionale dal quale si accede sempre da Home → Impostazioni → Moduli/Applicazioni.
Di seguito le impostazioni di default per il client FTP di Esprinet:
[[File:Img7 import esprinet catalogo manuale.png|1080x1080px]]
'''N.B. '''Utente e Password vanno richiesti ad Esprinet. Il “Nome” può essere inserito a piacere, sarà l’opzione che viene presentata nelle impostazioni del modulo “Esprinet Importazione Catalogo” alla voce “<span style="color:#202020;">Connessione FTP per download file zip catalogo</span>”.
NOTA: su pannello ISP CONFIG il cron job automatico per l’importazione del catalogo tutte le domeniche alle ore 3.00 è configurato nel seguente modo. Il comando lanciato per esteso:
''https://dolibarr.19.coop/custom/esprinetcatalogimport/esprinetcatalogimportindex.php?cronjob=1&securitykey=SECURITYKEYCRONJOB&userlogin=esprinet&action=importcatalog''
{{clear}}
[[File:Img8 import esprinet catalogo manuale.png]]
= <span style="color:#800000;">4. </span><span style="color:#800000;">Esprinet importazione catalogo</span> =
Attivando il modulo, verranno inserite due nuove voci di menu laterale, all’interno del menù “'''Strumenti'''”. La prima voce, '''Esprinet importazione''', consente di avviare l’importazione del catalogo manualmente. Se le impostazioni del modulo appena effettuate sono corrette, la pagina dovrebbe apparire in questo modo:
{{clear}}
[[File:Img10 import esprinet catalogo manuale.png|1080x1080px]]
In alto sono presente le informazioni riguardanti la connessione FTP con il repository Esprinet e nell’elenco vengono presentati i file selezionabili per l’importazione. Dalla configurazione del modulo sappiamo che il file da selezionare è ''dispoP.xml.zip''.
Una volta selezionato uno o più files, comparirà il tasto “'''IMPORTA FILE IN LOCALE'''”.
Procedendo il file verrà scaricato in una cartella dei documenti di Dolibarr e sarà disponibile nella tabellina sottostante, pronto per essere importato:
{{clear}}
[[File:Img11 import esprinet catalogo manuale.png|1080x1080px]]
La seconda voce di menù laterale, “'''Files importati'''”, è il semplice log delle importazioni manuali ed automatiche effettuate con il modulo:
{{clear}}
[[File:Img12 import esprinet catalogo manuale.png|1080x1080px]]
Per effettuare la corretta importazione dei prodotti del catalogo Esprinet è necessario creare gli appositi extrafields della scheda prodotto:
{{clear}}
[[File:Img13 import esprinet catalogo manuale.png]]
Il modulo non aggiunge gli extrafields automaticamente e consente l’importazione anche se tali campi extrafields NON vengono inseriti.
{{clear}}
[[File:Img14 import esprinet catalogo manuale.png|1080x1080px]]
N.B. sono tutti di tipo Stringa
<div style="color:#007b8c;">Configuarzione Cron Job:</div>
# tramite linea di comando:
* php cron_esprinet_start.php <IDCRONESPRINET> <NOMEFILEZIP> <TYPE> <LANGS>
* php cron_esprinet_start.php 13 dispoP.xml.zip automatic it_IT
# tramite invocazione pagina php:
* https://<URLDOLIBARR>/custom/esprinetcatalogimport/esprinetcatalogimportindex.php?cronjob=1&securitykey=<SECURITYKEYCRONJOB>&userlogin=<LOGINUTENTE>&action=importcatalog
[[Categoria:Moduli]]

Versione attuale delle 15:33, 5 apr 2024

Manuale utente rev. 1

“Modulo Esprinet importazione catalogo”

Versione del modulo: 2.0.0

Versione di Dolibarr supportate: 12.0.x / 13.0.x

Data: 13 Luglio 2021

Autori: Diciannove Soc. Coop.
https://shop.19.coop

1. Introduzione

Il modulo Esprinet importazione catalogo è il modulo sviluppato ad-hoc per Dolibarr ERP & CRM che consente l’importazione come prodotti predefiniti del catalogo “disponibilità prodotti” di Esprinet. <br Il modulo prevede la possibilità di collegarsi al server di Esprinet tramite protocollo s/ftp e scaricare il file del catalogo aggiornato. Tale file viene messo a disposizione dai servizi Esprinet ogni 15 minuti.

Tale operazione può essere effettuata automaticamente, tramite processo pianificato oppure manualmente.

2. Installazione del modulo in Dolibarr ERP&CRM

Una volta scaricato il pacchetto contenente il Modulo “Esprinte importazione catalogo”, il contenuto va copiato nella cartella “/custom” all’interno della directory principale di Dolibarr ERP&CRM.

Effettuata questa operazione il modulo va attivato dalla pagina ImpostazioniModuli/Applicazioni.


Template:Clear

Nota 1: dopo aver copiato il modulo nella cartella “/custom”, se esso non risulta ancora visibile nell’elenco dei moduli, è necessario attivare nel file di configurazione di Dolibarr ERP&CRM le due direttive seguenti:

$dolibarr_main_url_root_alt

$dolibarr_main_document_root_alt

eliminando le “//” iniziali e compilando con il percorso corretto.

In un’installazione Dolibarr ERP&CRM eseguita a partire da files zip o tar.gz, il file di configurazione chiamato conf.php è all’interno della cartella htdocs/conf/.

Per ulteriori informazioni consultare il link: https://wiki.dolibarr.org/index.php/FAQ_Custom_module_install

Nota 2: è necessario effettuare il login al sistema con un account avente privilegi di “Super amministratore” per poter accedere alla pagina delle Impostazioni.

3. Configurazione del modulo

Una volta effettuato l’accesso con un account avente i privilegi di “Super Amministratore”, si accede al menù laterale “Impostazioni” e quindi “Moduli/Applicazioni”. Si scorre la pagina fino ad arrivare al modulo “Esprinet Importazione Catalogo” oppure si utilizza l’apposita funzione di ricerca in cima alla pagina.

Una volta attivato il modulo (pulsante toggle) si può accedere alla pagina di impostazioni (pulsante ingranaggio). La pagina di impostazioni del modulo è la seguente:

Template:Clear

Per modificare questi parametri, premere il tasto “Modifica” in fondo alla pagina.

Opzioni generali:

Il primo parametro da indicare è il login (username) di un utente del sistema, al quale andranno assegnati i privilegi per “eseguire i processi pianificati”.

Template:Clear

All’utente poi si possono assegnare anche i permessi specifici introdotti dal modulo:

Template:Clear

Tutte le configurazioni dei vari parametri sono descritti in maniera puntuale.

L’opzione “Effettua il backup del database prima dell'importazione del catalogo”, se attivata, effettuerà un backup di tutto il database prima di effettuare l’aggiornamento del catalogo. Si consiglia l’attivazione di questa opzione.

Le ultime due opzioni determinano se utilizzare una connessione via s/ftp per scaricare direttamente dal repository Esprinet il catalogo (versione più aggiornata) da importare in Dolibarr. Nell’ultima opzione “Connessione FTP per download file zip catalogo”, andrà selezionata quale connessione FTP, configurata nel modulo FTP (vedi procedura a seguire), utilizzare per il download del file DispoP contenente il catalogo.

Opzioni per processo pianificato (importazione tramite Cron Job automatico):

Queste opzioni verranno utilizzate dal processo pianificato. La prima opzione, se attivata, utilizzerà la stessa connessione indicata nella sezione precedente.

L’opzione “Percorso del file zip da prelevare rispetto la root del server FTP (es. "cartella1/cartella2/" oppure "/" per indicare la cartella root)” di default può essere lasciata vuota (equivale a “/”) così come la terza opzione “Nome del file zip da utilizzare per l'importazione automatica (es. dispoP.xml.zip)” è corretto inserire il valore di esempio dispoP.xml.zip (Consultare comunque Esprinet in caso di configurazioni particolari).

È possibile avviare manualmente il processo pianificato visitando il link “URL per controllare ed eseguire il processo di importazione catalogo in cron

Opzioni invio notifica email:

Abilitando tramite la relativa opzione l’invio delle notifiche email, verrà inviata una email al termine della procedura di importazione del catalogo, con oggetto e testo definiti sempre in questa sezione, agli indirizzi indicati (indirizzi email da inserire separati da una virgola ‘,’ ).

Impostazioni modulo FTP client:

Le impostazioni dell’FTP vanno configurate nel relativo modulo core del gestionale dal quale si accede sempre da Home → Impostazioni → Moduli/Applicazioni.

Di seguito le impostazioni di default per il client FTP di Esprinet:

N.B. Utente e Password vanno richiesti ad Esprinet. Il “Nome” può essere inserito a piacere, sarà l’opzione che viene presentata nelle impostazioni del modulo “Esprinet Importazione Catalogo” alla voce “Connessione FTP per download file zip catalogo”.


NOTA: su pannello ISP CONFIG il cron job automatico per l’importazione del catalogo tutte le domeniche alle ore 3.00 è configurato nel seguente modo. Il comando lanciato per esteso:

https://dolibarr.19.coop/custom/esprinetcatalogimport/esprinetcatalogimportindex.php?cronjob=1&securitykey=SECURITYKEYCRONJOB&userlogin=esprinet&action=importcatalog

Template:Clear

Attivando il modulo, verranno inserite due nuove voci di menu laterale, all’interno del menù “Strumenti”. La prima voce, Esprinet importazione, consente di avviare l’importazione del catalogo manualmente. Se le impostazioni del modulo appena effettuate sono corrette, la pagina dovrebbe apparire in questo modo:

Template:Clear

In alto sono presente le informazioni riguardanti la connessione FTP con il repository Esprinet e nell’elenco vengono presentati i file selezionabili per l’importazione. Dalla configurazione del modulo sappiamo che il file da selezionare è dispoP.xml.zip.

Una volta selezionato uno o più files, comparirà il tasto “IMPORTA FILE IN LOCALE”.

Procedendo il file verrà scaricato in una cartella dei documenti di Dolibarr e sarà disponibile nella tabellina sottostante, pronto per essere importato:

Template:Clear

La seconda voce di menù laterale, “Files importati”, è il semplice log delle importazioni manuali ed automatiche effettuate con il modulo:

Template:Clear

Per effettuare la corretta importazione dei prodotti del catalogo Esprinet è necessario creare gli appositi extrafields della scheda prodotto:

Template:Clear

Il modulo non aggiunge gli extrafields automaticamente e consente l’importazione anche se tali campi extrafields NON vengono inseriti.

Template:Clear

N.B. sono tutti di tipo Stringa

Configuarzione Cron Job:
  1. tramite linea di comando:
  • php cron_esprinet_start.php <IDCRONESPRINET> <NOMEFILEZIP> <TYPE> <LANGS>
  • php cron_esprinet_start.php 13 dispoP.xml.zip automatic it_IT


  1. tramite invocazione pagina php:
  • https://<URLDOLIBARR>/custom/esprinetcatalogimport/esprinetcatalogimportindex.php?cronjob=1&securitykey=<SECURITYKEYCRONJOB>&userlogin=<LOGINUTENTE>&action=importcatalog