EXT: GSA Admin¶

What does it do?¶

GSA Admin provides a bunch of TYPO3 backend administration interfaces for data handled by GSA Shop (ext. pt_gsashop) or other extensions of the “General Shop Applications” (GSA) extension family. Furthermore some other GSA extensions hook into GSA Admin to provide their functionality in TYPO3's backend.

GSA Admin is intended to be used for the GSA Shop TYPO3 standalone version (without the ERP system GSA Shop is able to interact with). GSA Admin's tax rate module must not be used in combination with the ERP system currently (see chapter “Known Problems” below)!

GSA Admin is already in use for some production environment websites, e.g. http://www.klickbilderbox.de , http://www.vth.de . and http://www.stn- international.de/workshops.html .

The extension is still under development and not all features have been implemented completely! Don't expect all APIs and templates staying unchanged in future versions!

This manual is just a short introduction to GSA Admin and may be extended in upcoming versions.

Credits and history¶

Credits go to punkt.de GmbH ( http://punkt.de/ ) for sponsoring the extension development, toFabrizio Branca for support and addition of several improvements of this extension's functionality from 2007 to 2008 and to Martin Alker for creating the extension's backend icons.

The original author of GSA Admin, Rainer Kuhn, transfers the further development of GSA Admin and all GSA extensions to punkt.de GmbH ( http://punkt.de/ ) at the end of 2009, since he meets new challenges from 2010 on. Please contact the email address “t3extensions<at>punkt.de” for any questions about GSA Admin.

Screenshots¶

Screenshot of the Articles module's list view

The Articles module¶

All available articles are listed in the Article module's list view (see screenshot at chapter “Screenshots” above). To enter a new article or to edit/delete an existing article please use the appropriate TYPO3 backend button.

To enter a new article or edit an existing article the module offers a complex form to enter the article's basic properties, scale prices, images and texts. There are only a few fields required (others are optional), and these are marked with a red star.

Screenshot of the Articles module's edit form

In the field “Web Address” you can define the type of linking to an article's detail page by choosing from the following options:

• leave field blank (default): link to the default article single view page of GSA Shop (requires articleSingleViewPage config in pt_gsashop)
• enter a TYPO3 PID or alias for an individual article detail page
• enter an external URL
• enter -1 if you do not want the article to be linked to any detail page

Please note: if you want to enter fixed costs (= one-time article basic cost independently of ordered article quantity) in the “Calculation” section, these price always have to be entered as net prices (excluding tax), independently of the “Gross prices” checkbox in the “Article master data” section.

The Dispatch Cost module¶

This modules offers the possibility to enter different dispatch cost types. To switch between entering a new record or editing an existing one please use the selectorbox at the top right of the screen.

Every dispatch cost type can be splitted into 4 cost components with individual allowances. Dispatch costs currently have to be entered once for the gross version and once for the net version of each dispatch cost type due the the structure of the underlying ERP system data GSA Shop is based on.(this may be changed in future versions).

Screenshot of the dispatch cost module's edit form

Do not forget to adjust your dispatch cost type names with the configuration done in GSA Shop's Constant Editor (category “PT_GSASHOP::GSA SETTING”, “GSA dispatch *” options).

The Tax Rates module¶

This module s a temporary solution to enter tax rates and must not be used in combination with the ERP system (please refer to chapter “Known problems” below). The module can be disabled in GSA Admin's Extension Manager configuration.

To switch between entering a new record or editing an existing one please use the selectorbox at the top right of the screen.

Tax rate types (e.g. “full tax”, “reduced tax”) are grouped with tax codes from '00' to '19'. Each tax code may have several tax rate records starting from different dates. Please note that a tax code description entered for one tax rate will be used for all tax rates belonging to the same tax code!

Screenshot of the tax rates module's edit form

System requirements¶

Since the installation of GSA Admin is not trivial and requires additional server modules and databases, this should be done by an administrator or someone with the appropriate technical background! These are the current requirements to install and run GSA Admin:

• PHP 5.1 or higher
• TYPO3 4.1 or higher
• PEAR HTML_QuickForm: this PEAR module has to be installed on your server to run pt_gsaadmin (please refer to http://pear.php.net/package/HTML_QuickForm and http://pear.php.net/manual/en/installation.php for details). Alternatively you may use the TYPO3 extension “PEAR Manager” (pear) to install this package ( http://typo3.org/extensions/repository/view/pear/current/info/ ). Independent of the way to install the HTML_Quickform package, the path to the PEAR main directory on your server must be contained in the PHP search patch finally (since the package is included using “HTML/QuickForm.php” include statements in pt_gsaadmin's classes).
• A valid MySQL GSA database - please refer to the manuals of the extension pt_gsashop ( http://typo3.org/documentation/document- library/extension-manuals/pt_gsashop/current/ ) and pt_gsasocket ( http://typo3.org/documentation/document-library/extension- manuals/pt_gsasocket/current/ ) for details
• TYPO3 Extensions (the version numbers of the currently required extension versions are regulary updated under 'constraints'->'depends' in the ext_emconf.php file of pt_gsaadmin):
• 'smarty':TYPO3 integration for Smarty templating framework (see http://www.smarty.net/ ).
• 'jquery'':TYPO3 integration for the jQuery Javascript library (see http://jquery.com/ ). This extension requires the 'jsmanager' extension to be installed before.
• 'pt_tools'':A PHP5 toolbox and library for extensions.
• 'pt_gsasocket'':A socket for accessing the GSA data layer (needed for all extensions of the pt_gsa* extension family). This extension has to be configured in Ext. Manager to enable access to the GSA database, please refer to that extension's manual.
• 'pt_gsashop'':GSA Shop is the core of the GSA extension family and provides libraries used by GSA Admin.

Installation recommendations¶

To run GSA Shop with GSA Admin as a standalone installation without the ERP, the following extension is recommended in its particular up- to-date version:

'pt_gsaminidb':A minimal MySQL database to run the General Shop Applications (GSA) extensions as a TYPO3 standalone version. The extension provides an SQL script to import to your MySQL database server, please refer to that extension's manual.

Installation and Extension Manager Settings¶

Install the extension in TYPO3's extension manager and follow the instructions given there. After having installed the extension itself, you have to include the static extension template “GSA Shop: Admin interface (pt\_gsaadmin)” into your appropriate Typoscript template (it is recommended to use the same TS template where you've included the main shop static template “GSA Shop (pt_gsashop)”. The PID of the page/sysfolder, where you are using this template, has to be entered to the “TS configuration PID” configuration field in the Extension Manager (see below).

Please note : if your Typoscript template is stored in a sysfolder, you don't have to set the PID of the sysfolder there, but the PID of the page where the template is included/used!

Now the extension'sbasic settings have to be configured in TYPO3's Extension Manager. The available options are listed here:

IMPORTANT: The tax rate module must not be used in combination with the ERP system, please disable this module if you want to use the ERP system (since both do currently not work together due to some bugs of the ERP system concerning the tax data storage – this leads to ERP software crashes, overwritten DB records etc.)!

Extension Configuration in Constant Editor¶

The extension can be adapted to your individual needs by TypoScript respective by using TYPO3's Constant editor. The options are labeled in Constant Editor and should be self-explaining.

((generated))¶