ePages 6.17.12 - DE_EPAGES/ShopConfiguration/API/ShopExportCSV.pm

Package DE_EPAGES::ShopConfiguration::API::ShopExportCSV

Functions for exporting the status of shops.

@EXPORT_OK
ExportShopStatusByProvider
ExportShopStatusByStore
ShopExportCSVConfig

Functions

ExportShopStatusByProvider
ExportShopStatusByStore
ShopExportCSVConfig

ExportShopStatusByProvider

Exports shop status data of one database to a CSV file.

Syntax
@Errors = ExportShopStatusByProvider($Provider, $FileName, $hConfig);
Input
$Provider (DE_EPAGES::ShopConfiguration::API::Object::Provider)
Provider object
$FileName (string)
CSV file name
$hConfig (ref.hash)
(optional) see ExportShopStatusByStore,
if undefined, ShopExportCSVConfig is used for each database
Return
@Errors (array.string)
list of error messages

ExportShopStatusByStore

Exports shop status data of one database to a CSV file.

Syntax
ExportShopStatusByStore($Store, $FileName, $hConfig, $hCommonValues);
Example
ExportShopStatusByStore($Store, $FileName, undef, { Provider => 'Papa' });
Input
$Store (DE_EPAGES::Store::API::Object::Store)
Store object
$FileName (string)
CSV file name
$hConfig (ref.hash)
(optional, default=all columns and all shops), see ShopExportCSVConfig
  • Columns - columns to export (all if undefined) - ref.array.string
  • Conditions - conditions (key => value)(all if undefined) - ref.array.hash
$hCommonValues (ref.hash.string)
(optional) common values for all shops

ShopExportCSVConfig

Gets configuration parameters for the shop CVS export from the file "$ENV{'EPAGES_CONFIG'}/ShopExportCSV.conf".

Syntax
$hConfig = ShopExportCSVConfig($Section);
Input
$Section (string)
section name in ShopExportCSV.conf
Return
$hConfig (ref.hash)
columns and conditions for shop CVS export
  • Columns - columns to export (all if undefined) - ref.array.string
  • Conditions - conditions (key => value)(all if undefined) - ref.array.hash