Menu Content

Dokumentace komponenty VM Invoice

Abstrakt

Uživatelská dokumentace pro komponentu VM Invoice. Instalace a instrukce k použití.


Kapitola 1. Představení

1.1. Co jsou VM Invoices

VM Invoices je komponenta pro Joomla CMS / VirtueMart e-store, tato komponenta generuje faktury ve formátu PDF za každý jeden uskutečněný VirtueMart nákup. VM Invoices nabízí seznam objednávek, v tomto seznamu si můžete danou fakturu ve formátu PDF stáhnout pomocí jediného kliknutí nebo ji můžete zaslat svému klientovi e-mailem. Faktury je možno nakupujícím zákazníkům posílat automaticky pomocí e-mailu. Integrace s VirtueMart frontendem je také možná, uživatelé si mohou stáhnout faktury pomocí frontendu na seznamu objednávek.

Mezi hlavní funkce komponenty VM Invoice patří:

  • Automatické generování faktur ve formátu PDF pro zákazníky VirtueMart

  • Můžete posílat faktury na e-maily svých zákazníků

  • Ručně nastavitelný nebo plně automatický provoz

  • Při generování faktury si můžete nastavit stav objednávky

  • Nastavitelný vzhled faktury s vlastními poli

Kapitola 2. Instalace komponenty VM Invoices

Generátor faktur VirtueMart můžete získat jeho zakoupením a stažením na internetových stránkách ARTIO www.artio.net. Jeho instalace je jednoduchá a snadná.

2.1. Předpoklady

Chcete-li pokračovat v této instalaci, ujistětě se nejprve, že:

  • máte fungující Joomla siť

  • máte nainstalované a fungující VirtueMart rozšíření

  • v Joomla adresáři zkontrolujte zda máte oprávnění k zápisu: Help → System Info → Directory permissions

2.2. Instalace VM Invoice

  • přihlašte se do administrace Joomly! s oprávněním Super Administrátora

  • jděte do ExtensionsInstall/Uninstall

  • vyberte si stažený zip soubor a potvrďte tlačítkem upload&install

  • postupujte podle pokynů a zkontrolujte případné chyby

 

2.2.1. Instalace

Instalace komponenty je ve většině případů plně automatizovaná. Dojde k instalaci:

  • hlavní komponenty VM Invoices (in components/com_vminvoice a administrator/components/com_vminvoice)

  • jazykové soubory (in languages)

  • databázové tabulky (#__vminvoice_config, #__vminvoice_mailsended, #__vminvoice_run, #__vminvoice_additional_field)

Kapitola 3. Základní použití a konfigurace

Chcete-li spravovat komponentu VM Invoice, musíte být přihlášení v Joomla backendu (administrace). Pak přejděte do Components → ARTIO VM Invoices → Control panel

Zde jsou k dispozici 3 záložky. První z nich má název "Global configuration" (globální nastavení) a používá se k nastavení hlavních komponentů. Druhá záložka je určena k nastavení vaší banky a informacích o společnosti, PDF záhlaví a zápatí. Třetí záložka "Faktury" Vám umožňuje spravovat objednávky a faktury s nimi související.

3.1. Všeobecné nastavení

Tato záložka obsahuje několik možností, které kontrolují, jak komponenta VM Invoice funguje, stejně jako tlačítka související se zahájením činnosti. Jakákoliv změna by měla být uložena kliknutím na tlačítko "Save Configuration" (Uložení nastavení), které najdete v pravém horním rohu stránky.

3.1.1. Globální konfigurace

Provozní režim

Můžete si vybrat mezi možností automatického nebo manuálního odesílání.

Pokud si vyberete možnost manuálního režimu, nebudou zasílány žádné e-maily ani generovány faktury a to až do té doby, dokud nespustíte danou akci.

Pokud si vyberete možnost automatického režimu, budete muset provést více konfigurací - prosím přečtěte si Kapitolu 4 - 1 .


Požadovaný stav objednávky

(Platí pouze pro automatický režim)

Stav objednávky, způsobuje, že PDF faktura bude vygenerována a poslána klientovi.

Poštovní interval
(Platí pouze pro automatický režim)

Tato možnost Vám dovoluje nastavit časový interval, ve kterém jsou zasílány e-maily s nově vygenerovanými fakturami. (V případě, že používáte cron, měl by být tento interval stejný nebo delší než jedna konfigurace ve vašem cron skriptu. Pro více informací se podívejte na Kapitolu 4 - 1.1.)

Výběr písma pro PDF

Seznam dostupných druhů písma pro generování PDF.

Aktuálně dostupným druhem písma je Arial a Arial CE. Pokud nepotřebujete speciální znaky s diakritikou, můžete použít písmo Arial font, které je kompaktnější a výsledná velikost PDF souboru bude menší. Pro středoevropské jazyky používající diakritiku, je nejvhodnější používat písmo Arial CE.

Pro jiné než latinské jazyky může být použita verze písma UTF-8. Generované PDF soubory jsou pak nicméně větší.

Zobrazení DIČ

Nejprve musíte vybrat IČ nebo DIČ společnosti. Pokud již adresa obsahuje jednu z těchto položek, bude zobrazena v popisce.

IČ společnosti

Pokud chcete zobrazit IČ společnosti, vyberte příslušnou položku.

IČO
Pokud chcete zobrazit IČO společnosti, vyberte příslušnou položku.
 
Změna znaku měny

Jestliže se vaše měna negeneruje správně (např. při použití znaku €), můžete použít toto jako náhradu:

Syntaxe: původní řetězec měny 1| nový řetězec měny 1[, původní řetězec měny 2 | nový řetězec měny 2, ...]

Jako oddělovač mezi znakem a názvem používejte  "|" (lomítko) a oddělovač mezi celou sub.word použíjte "," (čárku)

Příklad: €|EUR,$|USD

Vzor data

Formát vzoru data pro datum ve faktuře může být např. (m-d-r nebo d.m.r); pro funkci datum použíjte PHP syntaxi

3.1.1.1. Konfigurace faktury

Zobrazení adresy

Typ adresy, který má být použit ve faktuře. Můžete si vybrat mezi fakturační adresou nebo doručovací adresou, popřípadě můžete použít obě.

Zobrazení datumu na faktuře

Zobrazení popisku datumu

Zobrazení SKU produktu

Zobrazení SKU položky pro produkt

Zobrazení ceny bez daně

Zobrazení ceny bez DPH pro položku produkt. Může být také zobrazeno souhrnně.

Zobrazení sazby daně

Zobrazení daňové sazby pro položku produkt. Může být také zobrazeno souhrnně.

Zobrazení hodnoty daně

Zobrazení ceny daně pro položku produkt. Může být také zobrazeno souhrnně.

Zobrazení souhrnu

Zobrazení souhrnu faktury. Toto shrnutí zobrazuje všechny položky uvedené výše (Cena bez daně, daňová sazba, cena daně).

Zobrazení popisku shrnutí

Zobrazení popisku shrnutí s hraniční linií

 

3.1.1.2. Konfigurace dodacího listu

Povolení dodacího listu
Pokud chcete použít dodací listy, povolte tuto možnost.
 
Odeslání s fakturou

V jednom e-mailu můžete poslat faktury a zároveň dodací listy.

Zobrazení adresy

Typ adresy, který může být používán v dodacím listu. Můžete si vybrat mezi fakturační adresou nebo doručovací adresou, popřípadě můžete použít obě.

Zobrazení datumu dodacího listu

Zobrazení popisku datum

3.1.2. Admin Mail

Používat poštu z

Pro nastavení pošty použíjte jedno z těchto nastavení (Globální konfigurace, VirtueMart konfigurace, VM Invoice konfigurace). 

Emailová adresa a jméno odesílatele bude použito při odesílání e-mailů.

Pokud chcete použít konfiguraci komponenty VM Invoice, nastavte si e-mailovou adresu a jméno, viz níže.  

Poslání kopie

Zaslání kopie pošty administrátorovi? Použíjte nastavení 'Use Mail From'.

Emailová adresa

Adresa, odkud budou faktury posílány (mailer adresa)

Posláno od

Zde nastavte odesílatelovo jméno.

Předmět

Předmět e-mailu s fakturou

Zpráva

Tato kolonka je určena pro vkládání textu do e-mailu, jež je určen k zaslání zákazníkovi (faktura je automaticky odesílána v příloze e-mailu)

3.2. Pole

3.2.1. Informace týkající se banky, platebních metod atd.

Do faktury můžete zahrnou také informace o platbě. Můžete zadat tyto údaje:

  • Název banky

  • Číslo účtu

  • Kód banky

  • BIC / Swift

  • IBAN

Vedle každého pole najdete tlačítko k přepínání - zda se mají dané informace zobrazovat ve faktuře či nikoliv.

3.2.2. Informace o společnosti

Informace o Vaší společnosti, které mohou být zobrazeny ve faktuře:

  • Číslo daně

  • DIČ

  • Rejstříkový soud

  • Telefon

  • E-mail

  • Web Url adresa

PDF záhlaví a zápatí

Pro Vaše zápatí a záhlaví je vygenerován PDF soubor. Do zápatí si můžete např. vložit Váš podpis. Také můžete použít HTML tagy.

3.3. Faktury

Přehledu faktur nabízí ucelený seznam všem objednávek v systému. V tomto systému tak můžete upravovat dané faktury. 

V případě, že faktura již byla poslána zákazníkovi, uvidíte její stav. V případě že ještě nebyla poslána, máte možnost ji (znovu) manuálně poslat (pomocí e-mailu) nebo ji stáhnout jako soubor.

Pro rychlejší vyhledávání určitého klienta nebo objednávky můžete použít možnost filtrování.

Tabulka obsahuje tyto sloupce
  • ID (identifikační číslo)

  •  ID objednávky

  • Jméno klienta

  • Společnost

  • E-mail

  • Stav

  • Vytvoření

  • Modifikace

  • Celkem

  • Odeslaná pošta

  • Pošta

  • PDF

Kapitola 4. Pokročilá konfigurace

4.1. Nastavení automatického posílání PDF faktur

Chcete-li povolit automatické posílání PDF faktur svým zákazníkům, je třeba přidat volání skriptu VM Invoice do systému seznamu úloh. V systému Linux/Unix, by se ve většině případů jednalo o cron nebo crontab, v systému Windows by to byl Správce úloh.

Toto je nejúčinnější způsob, jak vytvářet a kontrolovat faktury pouze jedenkrát.

Tuto situaci však můžete také vyřešit instalací " pluginu VM Invoice", který bude kontrolovat nakonfigurované faktury. Toto je snadnější nastavení (pouze v případě instalace pluginu) nicméně méně efektivní, neboť potřebuje kontrolu při každém zatížení Joomla.


4.1.1. Konfigurace VM Invoices pomocí Cronu

4.1.1.1. co je cron?

Cron je časový spouštěč úloh v Unixu, pracující jako operační systém. Cron umožňuje, aby si uživatelé naplánovali spouštění daných programů pravidelně v určitou dobu nebo při určitém datu. Běžně se tato služba využívá při automtatické údržbě systému, při správě, atd.

4.1.1.2. Kde cron najdu?

Cron běží v crontab, v konfiguračním souboru, který spouští dané příkazy podle zadaného plánu. V souborech crontab jsou uloženy seznamy úloh a další instrukce pro cron daemon. Uživatelé mohou mít své vlastní soubory crontab, často se zde nachází rozsáhlé soubory crontab (obvykle v adresáři nebo podadresáři), které mohou upravovat pouze administrátoři.

4.1.1.3. Nastavení Cron skriptu

Struktura cron skriptu.

4.1.1.4. Příklady cronu pro komponentu VM Invoice

Následující příklad zabezpečí, že budou nově potvrzené objednávky kontrolovány a vygenerované faktury budou posílány každých 20 minut:

*/20 * * * * wget -q -O /dev/null "http://www.yousite.name/?option=com_vminvoice&;task=cronMail&view=vminvoice"

4.1.2. Instalace pluginu VM invoices

Pokud nemůžete použít cron plánovač (nebo správce úloh), můžete si nainstalovat plugin VM Invoices. Není nainstalován ve výchozím nastavení!

Musíte si stáhnout soubor plg_vminvoice_autorun.zip samostatně a nainstalovat jej prostřednictvím Extensions → Install/Uninstall.

Po instalaci se ujistěte, že stav pluginu je - zveřejněn.

*/20 * * * * wget -q -O /dev/null "http://www.yousite.name/?option=com_vminvoice&task=cronMail&view=vminvoice"

4.2. Integrace s VirtueMart frontendem

Pokud chcete svým uživatelům poskytnout možnost stáhnout si, z frontendu VirtueMart, faktury ve formátu PDF, nacházející se v seznamu objednávek, proveďte následující kroky:

  1. vyhledejte soubor components/com_virtuemart/classes/ps_order.php

  2. Okolo řádku 664 (VirtueMart verze 1.1.4) nebo řádku 705 (VirtueMart verze 1.1.5 & verze 1.1.6), upravte kód:

    $listObj->writeTableHeader( 3 );

    na

    $listObj->writeTableHeader( 4 );

    Také můžete použít editor "Vyhledávání funkce" k nalezení správného řádku; berte však na vědomí, že se může lišit, a to v případě, pokud máte různé verze VirtueMart nebo používáte jiné doplňky, které upravují původní zdrojový kód.

  3. Po řádku 682 (VirtueMart verze 1.14) nebo řádku  723 (VirtueMart verze 1.1.5 & verze 1.1.6), přidejte následující řádky:

    $pdf_url = "index.php?option=com_vminvoice&controller=invoices&task=pdf&cid=". $db->f("order_id");

    $tmp_cell = ($db->f("order_status") == 'C') ? '<a href="' . JRoute::_($pdf_url) . '"><img src="' . JURI::base() . 'plugins/editors/jce/tiny_mce/plugins/filemanager/img/ext/pdf_small.gif" /> ' . JText::_('Invoice') .' </a>' : '';

    $listObj->addCell( $tmp_cell );

    Berte prosím na vědomí, že čísla řádků se mohou lišit, v závislosti od různých verzí nebo při používání dalších doplňků, které upravují původní zdrojový kód.  Výše uvedené řádky dané do jednoho celku by měly vypadat asi takto:

    $tmp_cell = "<strong>".$VM_LANG->_('PHPSHOP_ORDER_PRINT_PO_STATUS').":</strong> ".$order_status;

    $tmp_cell .= "<br /><strong>".$VM_LANG->_('PHPSHOP_ORDER_PRINT_PO_NUMBER').":</strong> " . sprintf("%08d", $db->f("order_id"));

    $listObj->addCell( $tmp_cell );

    takže pro najití správného řádku můžete použít funkci Vyhledávání.

    Upravení hodnoty C (řádek 2) na jiný stav objednávky - pokud chcete zobrazit fakturu pro jiný stav než "potvrzeno" (kontrola směřující k nastavení komponenty VM Invoice není nastavena automaticky, proto je integrace VirtueMart tak jednoduchá jak je to jen možné).

    Chcete-li použít jinou než PDF ikonu, změňte cestu obrázku, přidáním řádku 2.

Přihlášení uživatele Prázdný