Automate tracking code import from CSV

About the Extension

Purpose of this plugin

This plugin helps you to automate importing tracking information, in example
for feedback from dropshipping partners, by providing a new cronjob.

The cronjob of the plugin checks in given intervals if the configured file has changed and
imports it in case it has.

(Un-)Install

By using the plugin manager, see Shopware documentation for details.

Please clear the Shopware cache after installing, otherwise it could happen that
components can't be found. You should be asked to do so after installing. Remember
to configure the options before using the cronjob, for details see Configuration.

Usage

How you invoke the cronjob doesn't matter. You can do so by using your browser (not
recommended), your servers crontab or `bin/console`. For details please see the Shopware
documentation <https://en-community.shopware.com/_detail_1103.html#Setting_up_a_cronjob>.
To adjust the import interval, you can edit the cronjob interval. But in general the file
will be imported only if changed.

The "action name" for usage by `bin/console` is `Shopware_CronJob_pixe2SimpleTrackingUpdateCron`,
so the whole command is `bin/console sw:cron:run Shopware_CronJob_pixe2SimpleTrackingUpdateCron`.

Depending on the amount of orders, the import runtime could be quite high.
Because of that the execution by browser is unsuited.

You can check the import results in the cronjob management.

Configuration

The plugin has options to adjust the process. Set this options like you
need them, then activate the cronjob. Please note that Shopwares own plugin
"Cron" must be active for this plugin to work.

Filepath

Enter the name of the import file here. The plugin assumes that this file
resides in the plugin directory. Plugin directory means `<yourshop>/custom/plugins/pixe2SimpleTrackingUpdate`.
But you can also enter relatives paths, as long as that path is readable for the
user account under which the web server/PHP is running. For relative paths to
work, they must be relative to the plugin directory. In example, if the file is
located in the root of your shop, the path would be `../../../file.csv`. Keep in
mind that not only the path itself, but also the file needs to be readable.

You can also give an HTTP(S) or FTP URL here, the file will be fetched and
deleted again after importing.

Column separator

Enter the column separator here. You can use any sequence of characters, in
example "," or ";". To use [TAB] as separator please enter "\t" here.

Ordernumber column

Numerical index of the column holding the ordernumber  
(Note: count starts at 0!)

Trackingcode column

Numerical index of the column containing the new tracking value  
(Note: count starts at 0!)

Skip first line

If the first line of the import file contains column headers, you can activate
this option to ignore it at import time.

Update order state

Will change the order state to "completely delivered" when importing.

Disable locking

By default the plugin will create a file called ".lockfile" in the plugin directory
when starting the import. This file is used to prevent multiple imports from running
at the same time. If the last import was terminated early, most likely because of
execution by browser and `max_execution_time`, the file will not be deleted and prevent
further runs to properly start. You can use this option to disable this check without
deleting ".lockfile". The lockfile will then be deleted after the next successful execution.
After that you can disable this option again.

IMPORTANT: This option is intended as workaround, not for permanent use. If the lockfile
still exists after the job is run, it wasn't finished properly!

Disable check for changes

Normally the plugin will only start importing when the import file has changed since
the last run. By enabling this option you can disable this check and force the import
to be executed no matter the "last modified" timestamp of the importfile.

Normalize linebreaks

In case your importfile uses "\r" linebreaks, or some mix, you can activate a
workaround with this option.

Remarks

Non existing orders will be logged as "Exception", but import of the file will be
continued nonetheless. It will be logged as "Error" if an order wasn't updated
like expected.

All columns except the ones for ordernumber and trackingcode will be ignored. But
keep in mind that they need to be loaded into memory anyway. Depending on
filesize it can make sense to reduce the file before.