Trigger Scripts

For example, shipping settings can be changed according to the items in an order or the shipping address, items in an order can be split off when pre-booked, or the special discounts can be calculated when an order is created or imported.

Triggers exist in all parts of xentral and trigger scripts allow easy customization of almost any process, such as OnDocumentChange.

Working with receipts (documents)

Working with master data

Working with productions

Process trigger

          <?php

class erpAPICustom extends erpAPI
{
  public function __construct(&$app)
  {
    $this->app = $app;
    parent::__construct($app);
  } // end of constructor

  public function ANABREGSNeuberechnen($id, $art, $bool = false)
  {
    /* Choose the documents you want to manipulate  - Sample 1 */
    if($art === 'auftrag') {

      /* Custom definitions here */
      $rebateId = 15;        /* Set rebate article ID % */
      $threshold = 100;      /* Activate rebate for orders above EUR 100,- */
      $rebateExists = false; /* Assume rebate article not yet added */

      /* Get some information about positions from database - Sample 2 */
      $positionenSQL = sprintf('SELECT ap.* FROM %s_position ap  WHERE %s = %s', $art, $art, $id);
      $positionen = $this->app->DB->SelectArr($positionenSQL);

      /* Walk through positions and compute the price */
      $sum = 0;
      foreach ($positionen as $p) {
        $artikelId = $p['artikel'];
        $menge = $p['menge'];

        if ((int)$artikelId !== $rebateId) {
          $sum += $this->app->erp->GetVerkaufspreis($artikelId, $menge) * $menge; /* Sample 3 */
        } else {
          $rebateExists = true;
        }
      } // end of foreach

      if ($sum >= $threshold && !$rebateExists) {
        /* Sample 4 */
        $this->app->erp->AddAuftragPositionManuell($id, $rebateId, 0, 1, 'Rabatt ab € '.$this->app->erp->formatMoney($threshold, 'EUR'));
      } // end of if - add rebate if not exists
    } // end of if - Document type: Offer / Auftrag

    /* Call the main routine from parent class erpAPI and return */
    return parent::ANABREGSNeuberechnen($id, $art);
  } // end of function

} // end of class

        

As a result, the position table then adjusts as follows:

And the document also has a different appearance:

In Switzerland, 1 and 2 centime coins are no longer in circulation. Therefore, retailers round up or down to 5 or 10 centimes, with mathematical rounding rules applying. In this case, the rounding normally refers to the total amount.

With the help of the function ANABREGSNeuberechnen() this rounding can be implemented. For this purpose, the total amount must be stored in two fields:

Additional ideas for projects:

With the method LieferscheinAuslagern the warehouse stock is adjusted. The algorithm for this can be developed by the user. The ID of the delivery note appears primarily as a parameter. Then the positions from the data base can be queried (article ID and quantity), in order to take the correct quantities in the warehouse in the table lager_platz_inhalt.

            function     LieferscheinAuslagern($lieferschein,$anzeige_lagerplaetze_in_lieferschein=false, $standardlager = 0, $belegtyp = 'lieferschein', $chargenmhdnachprojekt = 0, $forceseriennummerngeliefertsetzen = false,$nurrestmenge = false, $lager_platz_vpe = 0, $lpiid = 0)

          

            function LagerAuslagernRegal($artikel,$regal,$menge,$projekt,$grund,$importer="", $doctype = "", $doctypeid = 0, $lager_platz_vpe = 0, $lpiid = 0)

          

The following example creates a time-controlled export of the product data in BMEcat format, a standardized exchange format for catalog data in catalog management (see also BMEcat on Wikipedia). In this case, specifically changed articles are exported in the update format and only articles are selected that have been changed since the last execution of the CRON job. In this example, only changes to the master data of the articles are taken into account, but not, for example, changed sales prices.

          <?php

use Xentral\Components\Database\Exception\QueryFailureException;
use Xentral\Components\Filesystem\Filesystem;
use Xentral\Components\Filesystem\FilesystemFactory;
use Xentral\Components\Util\StringUtil;

//predefined variables:

/** @var Application $app
 * access to services and functions(e.g. Database, erpAPI, PHPMail...)
 */

/** @var array $task
 * information about all current executed cronjobs
 */

/** @var int $task_index
 * index of current cronjob in $task array
 */


//information about the current running cronjob
$jobInfo = $task[$task_index];

//get the time of the last execution of this cronjob
$lastExec = $jobInfo['letzteausfuerhung'];

//it makes sense to keep some settings flexible (e.g. for test environment)
$outputDir = '';

$exportObject = new BmecatExportCronjob($app, $lastExec, $outputDir);
$exportObject->execute();

final class BmecatExportCronjob
{
    /** @var erpooSystem $app */
    private $app;

    /** @var array $data */
    private $data;

    /** @var string $lastExecution */
    private $lastExecution;

    /** @var SimpleXMLElement $xml */
    private $xml;

    /** @var string $outputDirectory */
    private $outputDirectory;

    /** @var bool $debugMode */
    private $debugMode = true; //set to false for production usage

    /**
     * @param erpooSystem $app
     * @param string      $lastExecution
     * @param string      $outputDirectory
     */
    public function __construct($app, $lastExecution, $outputDirectory = '')
    {
        $this->app = $app;
        $this->lastExecution = $lastExecution;
        if ($outputDirectory !== '') {
            $this->outputDirectory = $outputDirectory;
        } else {
            //get the userdata directory of Xentral as default value for output         directory
            $this->outputDirectory = $app->Conf->WFuserdata;
        }
    }

    /**
     * Collects data for the BMECAT export and writes the result to a file
     *
     * @throws Exception
     *
     * @return void
     */
    public function execute()
    {
        $this->app->erp->LogFile('BMECAT_export started', __FILE__);

        //collect data for the export
        $this->data['header'] = $this->getHeader();
        $articles = $this->getArticles();

        //if there are no changed articles we leave a hint in the logfile and exit      cleanly
        if (empty($articles)) {
            $this->app->erp->LogFile('BMECAT_export: No changed articles since last    execution.');

            return;
        }

        $this->data['t_update_products']['_attr_prev_version'] = '0';
        $this->data['t_update_products']['article'] = $articles;

        //render the XML string according to BMECAT specs
        $this->xml = $this->toXml();

        //It is good practice to use filenames with timestamps for output to avoid      colliding results
        $date = new DateTime('now');
        $filename = sprintf('bmecat_export_%s.xml', $date->format('Y-m-d_H_i_s'));

        //write the XML content to a file
        $this->writeXmlFile($this->xml, $filename);

        $this->app->erp->LogFile('BMECAT_export completed');
    }

    /**
     * Write the xml string to a file in the userdata directory
     *
     * uses Xentral FileSystem class to write the file.
     *
     * @param string $xml
     * @param string $filename
     */
    private function writeXmlFile($xml, $filename)
    {
        $path = sprintf('%s/%s', $this->outputDirectory, $filename);
        $this->debug('BMECAT_export write xml file', $path);

        //we do not want to overwrite old export files
        if (file_exists($path)) {
            throw new RuntimeException(sprintf('BMECAT_export Cannot overwrite file     %s', $path));
        }

        /** @var FilesystemFactory $factory */
        $factory = $this->app->Container->get('FilesystemFactory');
        /** @var Filesystem $fileSystem */
        $fileSystem = $factory->createLocal('/');
        $fileSystem->write($path, $xml);
    }

    /**
     * transforms the data to xml string
     *
     * @return string
     */
    private function toXml()
    {
        $xml = new SimpleXMLElement('<BMECAT/>');
        $xml->addAttribute('version', '1.2');
        $this->appendXmlRecursive($xml, $this->data);

        return $xml->asXML();
    }

    /**
     * walks through the data recursively and buidls the data structure for bmecat
     *
     * @param SimpleXMLElement $startnode
     * @param array            $data
     * @param string           $parentName
     */
    private function appendXmlRecursive(SimpleXMLElement $startnode, $data, $parentName = '')
    {
        foreach ($data as $name => $value) {
            if ($parentName !== '') {
                $name = $parentName;
            }
            if (is_array($value)) {
                if (count(array_filter(array_keys($value), 'is_string')) === 0) {
                    $this->appendXmlRecursive($startnode, $value, $name);
                } else {
                    $child = $startnode->addChild(mb_strtoupper($name), '');
                    $this->appendXmlRecursive($child, $value);
                }
            } else {
                if (StringUtil::startsWith($name, '_attr_')) {
                    $startnode->addAttribute(substr($name, 6), $value);
                } else {
                    $startnode->addChild(mb_strtoupper($name), $value);
                }
            }
        }
    }

    /**
     * collects necessary data for the bmecat header
     *
     * @throws Exception
     *
     * @return array
     */
    private function getHeader()
    {
        $header = [];
        $header['generator_info'] = 'Xentral custom cronjob';
        $date = new DateTime('now');
        $header['catalog'] = [
            'language'        => 'deu',
            'catalog_id'      => 'standard_endkunden_katalog',
            'catalog_version' => '001.001',
            'datetime'        => [
                '_attr_type' => 'generation_date',
                'date'       => $date->format('Y-m-d'),
                'time'       => $date->format('H:i:s'),
            ],
        ];
        $header['supplier'] = ['suppliername' => $this->app->erp-      >Firmendaten('footer_0_1')];

        return $header;
    }

    /**
     * collects data about changed articles
     *
     * @return array
     */
    private function getArticles()
    {
        $data = [];
        //this query gets all articles that were edited since the cronjob's last        execution
        $sql = sprintf(
        "SELECT a.id, a.typ, a.nummer, a.ean, a.name_de, a.katalogbezeichnung_de, a.katalogtext_de, 
                a.hersteller, a.herstellernummer
            FROM artikel AS a 
            WHERE a.useredittimestamp > '%s' AND a.katalog = 1",
            $this->lastExecution
        );

        $articles = $this->app->DB->SelectArr($sql);

        $dbError = $this->app->DB->error();
        if (!empty($dbError)) {
            //this is a critical error, the cronjob can not continue
            //so log the error message and quit the cronjob with an error by throwing an exception
            $this->app->erp->LogFile('BMECAT_export article query failed', $this->app->DB->real_escape_string($sql));
            $this->app->erp->LogFile('BMECAT_export DB error', $this->app->DB->real_escape_string($dbError));

            throw new QueryFailureException('database query failed');
        }

        if (empty($articles)) {
                return [];
            }

            $this->debug(sprintf('BMECAT_export %s changed articles found', count($articles)));

            foreach ($articles as $article) {
                $item = [];
                $item['_attr_mode'] = 'update';
                $item['supplier_aid'] = $article['nummer'];
                $item['article_details']['description_short'] = $article['katalogbezeichnung_de'];
                $item['article_details']['description_long'] = $article['katalogtext_de'];
                if ($article['ean'] !== '') {
            $item['article_details']['ean'] = $article['ean'];
        }
                        if ($article['herstellernummer'] !== '') {
            $item['article_details']['manufacturer_aid'] = $article['herstellernummer'];
            }
            if ($article['hersteller'] !== '') {
                $item['article_details']['manufacturer_name'] = $article['hersteller'];
            }
            $prices = $this->getPrices((int)$article['id']);
            foreach ($prices as $price) {
                $item['article_price_details']['article_price'][] = [
                    'price_amount'   => $price['preis'],
                    'price_currency' => $price['waehrung'],
                ];
            }
            $data[] = $item;
        }

        return $data;
    }

    /**
     * Gets currently active prices of one article
     *
     * @param int $articleId
     *
     * @return array
     */
    private function getPrices($articleId)
    {
        $this->debug('get prices for article', $articleId);
        //this query gets all prices of the specified article that are active on the current date
        $sql = sprintf(
            "SELECT p.preis, p.waehrung, p.ab_menge
                FROM verkaufspreise AS p
                WHERE p.art = 'kunde' AND p.adresse = 0 AND p.geloescht = 0
                    AND (p.gueltig_bis = '0000-00-00' OR curdate() <= p.gueltig_bis OR isnull(gueltig_bis))
                    AND (p.gueltig_ab = '0000-00-00' OR curdate() >= p.gueltig_ab OR isnull(gueltig_ab))
                    AND p.artikel = %s
                ORDER BY p.ab_menge",
            $articleId
        );

        $prices = $this->app->DB->SelectArr($sql);

        $dbError = $this->app->DB->error();
        if (!empty($dbError)) {
            //this is a noncritical error, the cronjob can still continue, just log the error message
            $this->app->erp->LogFile('BMECAT_export price query failed', $this->app->DB->real_escape_string($sql));
            $this->app->erp->LogFile('BMECAT_export DB error', $this->app->DB->real_escape_string($dbError));
        }

        if (empty($prices)) {
            return [];
        }

        return $prices;
    }

    /**
     * Prints log message to logfile table
     * (only if debug mode is enabled)
     *
     * @param string     $message
     * @param mixed|null $dump
     */
    private function debug($message, $dump = null)
    {
        if ($this->debugMode === true) {
            $this->app->erp->LogFile($message, $dump);
        }
    }
}

        

The following example shows how to create a file attachment to a document. This code example registers on the trigger when a document is changed and creates a file, which can then extend the document as an attachment. In xentral there are e.g. additional payment slips for invoices or dangerous goods declarations, which are anchored in the system according to this pattern. However, any type of file attachment is conceivable. As long as the file is stored as an attachment type, it can be sent automatically with the invoice or printed additionally when printing the invoice by a suitable configuration in the project settings.