TYPO3 4.x
Since version 0.4.1 the static data in ext_tables_static+adt.sql of pt_conference is based on the TYPO3 4 database structure.
MySQL database
At this state of the extension no other DBMS are supported. Please refer to chapter “Known Problems”/”TYPO3 SQL Bug for MySQL 4.” if you want to use MySQL 4.1+. It's recommended to edit the mentioned SQL files before installing the extension!
PHP5 with XML-RPC
Since version 0.4.3 pt_conference depends on the extension pt_euvatcheck, which is written in PHP5 and uses XML-RPC functions (for more information please refer to http://php.net/xmlrpc).
htmldoc
You need a working htmldoc installation. This software is used by the HTML to PDF converter extension (see below; for more details please refer to the pt_html2pdf extension manual).
TYPO3 extension dependencies
To install this extension you need to have the following extension installed:
Static info tables extension (static_info_tables, v1.3.0 or above): Some static database tables with useful informations about countries, languages and currencies. Used for user data forms and VAT ID check.
punkt.de Library extension (pt_lib, v0.6.6 or above): A code library for pt_* extensions from punkt.de. Many methods from these libraries are used in the Conference Management extension. Important: From version 0.2.x of pt_conference you need pt_lib version 0.6.x or above!
Cardia ePayment extension (pt_payment, v1.0.0 or above): An eCommerce payment solution enabling a merchant to receive payments through credit card (Visa, Eurocard, Mastercard). To enable the credit card payment option of the conference registration you have to install and configure the “Cardia ePayment” extension (pt_payment) and configure the interfaces between both extensions (for pt_conference set “Cardia ePayment page” in Constant editor, see chapter “Administration”/”Extension settings in Constant Editor“, for pt_payment please refer to that extensions' manual).
HTML to PDF converter extension (pt_html2pdf, v0.1.0 or above)): A converter that generates a PDF file from an HTML file (using the open source software htmldoc). Used to create PDF invoices after finishing an registration/ordering process (see chapter ”Customizing the invoice template” below)
Euroüpean VAT ID check extension (pt_euvatcheck, v0.0.7 or above)): A checking tool for European VAT IDs. Used to check the VAT ID at the billing data form.
Any TYPO3 Login: e.g. the default TYPO3 login or the new login box extension (login details see below).
(Please refer to chapter “Known Problems”/”TYPO3 SQL Bug for MySQL 4.” if you want to use MySQL 4.1+. It is recommended to edit the mentioned SQL files before installing the extension!)
Database table fe_groups
If you install the extension pt_conference, the following seven frontend user groups are inserted in to TYPO3's system database table fe_groups, if you don't reject it. The groups must have a special UID, don't change these UIDs!
IMPORTANT: For all groups you have to set the entry for the database field 'pid' (set to 0 by default) to the PID of your FE users sysfolder. Use the same PID as the one set in plugin.tx_ptconference.feusersSysfolderPid in Constant Editor (see Administration). You can do this using phpMyAdmin in the backend of TYPO3, e.g. with the following SQL statement:
UPDATE fe_groups SET pid = <your FE users sysfolder PID> WHERE pid = 0;
IMPORTANT: Don't use the 'Import static data' feature of extension manager after changing static data: once you have adjusted or changed your database tables (see above) an re-import of static data will override all your changes and set up the default tables again (as the static data file requires the deletion of any mentioned tables)!
We're striving to find a better solution for the FE groups handling in one of next versions of the extension (see To-Do List).
Some groups are used solely to restrict the access to a page (e.g. committee). For some pages it is necessary that a frontend user is logged in (e.g. speaker). The following table shows an overview of the usage of frontend usergroups:
FE group | UID | Usage | Description |
|---|---|---|---|
speaker | 5 | Restrict pages (login is checked in “Speakers Area” plugin). UID used in plugin code. | Registered preliminary speakers and accepted speakers after the program committee's talks/tutorial selection using the “Finalize speaker selection” plugin (conference admin). Speakers may submit and edit paper proposals and an author's description at the page where you've integrated the “Paper Registration” plugin. |
committee | 6 | Restrict pages. | Members of the program committee (selection of talks and tutorials): Users do not register themselves in FE as member of this group, but they're registered by conference organizers in the BE (or this group is added to their existing FE user record). |
attendees | 7 | UID used in plugin code. | Conference Attendees: Users have registered themselves using your provided FE login, or by placing an order (in this case they are automatically registered attendees and also members of the group "orderers"), or they have been registered by a third person (of the group "orderer"), or as accepted speakers the attendee group has been added to their existing user record by the conference admin (e.g. by using the “Finalize speaker selection” plugin). |
orderers | 8 | UID used in plugin code. | Orderers: User who have placed an order ("Visitors Area"->"Registration/Order") for the conference. The registration is done automatically by the ordering process. |
default | 9 | UID used in plugin code. | The default group may be assigned by your provided FE user administration (as no user can be created without the assignment of an FE group). Furthermore if a registration/order has been canceled (“Conference Accounting plugin”), the users' group is changed from 'attendees'/'orderers' to 'default'. Members of this group have no special user rights. |
admin | 10 | Restrict pages and special content. Group name used in plugin code. | Members of the conference organization team, who are allowed to use the FE "Admin" areas (accounting/statistics) and special features (e.g. at “Committee overview plugin” or “Finalize speaker selection” plugin). |
rejected_speakers | 11 | Revoke the speaker privileges from a former speaker. No special usage. | Rejected Speakers: User, who have registered at "Speakers Registration", but who have been rejected as speakers by the program committee/admin (e.g. by using the “Finalize speaker selection” plugin). Members of this group have no special user rights. |
'Import static data' feature of extension manager
WARNING! Be careful with this feature of extension manager - once you have adjusted your database tables (see above) or changed some database tables (e.g. products) an re-import of static data will override all your changes and set up the default tables again (as the static data file requires the deletion of any mentioned tables)!
Some parts of this extension require restricted access to pages, respective they can only be used combined with a login. Therefore it is necessary to provide a login interface like the TYPO3 default login or the new login box.
Since version 0.3.0, the speaker registration and default user registration interfaces are part of the conference extension. Therefore the plugin “Frontend User Administration” and the static templates for speaker registration and for default user registration are integrated in this extension, so for implementation to your site you only have to add this plugin to the appropriate pages (see chapter “Brief description of the plugins and their types”), create an extended TypoScript template for these pages and include the static template “Conference Speakers Registration” or “Conference Default Registration” to the extended template. Registering at these pages will add the appropriate frontend usergroup (“speaker” or respective “default”) to the user.
Furthermore the visitor's registration automatically creates a FE login for all registered users (usergroup “attendees” for all registered attendees and additionally usergroup “orderers” for the ordering person).
Additional fields for fe_users table
Among other fields the fe_users database table has two fields which can be used to force a registered attendee to complete his data. The name of these fields are tx_ptconference_change_userdata and tx_ptconference_change_proddata. The value of these fields are set to 1 if an attendee has been registered. This values are used by the static template of the default registration.
A HTML template file is used to generate an invoice, credit note or a cancellation. By default this is the file EXT:pt_conference/res/bill.html, which can be changed using the Constant Editor. Using the pt_html2pdf extension a PDF file of the HTML template file is created.
All text information for an invoice can be configured in the Constant Editor choosing 'pt_conference'. The layout of the invoice including a possible company logo can be configured in the Constant Editor choosing 'pt_html2pdf'. To add a logo you have to set $LOGOIMAGE in the setting for 'htmldoc header_right', 'htmldoc header_left' or 'htmldoc header_center' and additionally you have to set the directory path for the logo file in 'htmldoc logoimage' (e.g. fileadmin/img/mylogo.gif). Alternatively it's possible to add a logo by inserting an HTML image tag (<img src=... >) into the HTML template of the invoice.
The HTML template file contains placeholders and blocks for non-static values. The placeholders are signed like ###PLACEHOLDER###, blocks starts with <!--###BLOCK### begin --> and end with <!--###BLOCK### end -->.The followings blocks and placeholders are used:
Blocks | Description |
TEMPLATE_BILL_DATA | This block contains the invoice completely |
TEMPLATE_BILL_ITEM | A booked product |
TEMPLATE_REVERSAL | A special text if this is a cancellation |
TEMPLATE_CREDIT_NOTE | A special text if this is a credit note |
TEMPLATE_PARTIAL_REVERSAL | A special text if this is a partial cancellation |
TEMPLATE_UNTIL | If it is an invoice, an 'until' text and date is printed |
TEMPLATE_ATTENDEES | if it is an invoice a list of the attendees is printed |
TEMPLATE_ATTENDEE | One attendee is printed |
Placeholders | Description |
|---|---|
Placeholders of TEMPLATE_BILL_DATA block | |
ORGANIZER_NAME | set by Constant Editor (organizerName) |
ORGANIZER_ADDRESS | set by Constant Editor (organizerAddress) |
ORGANIZER_ZIP | set by Constant Editor (organizerZip) |
ORGANIZER_TOWN | set by Constant Editor (organizerTown) |
ORGANIZER_COUNTRY | set by Constant Editor (organizerCountry) |
ORGANIZER_PHONE | set by Constant Editor (organizerPhone) |
ORGANIZER_FAX | set by Constant Editor (organizerFax) |
ORGANIZER_EMAIL | set by Constant Editor (organizerEmail) |
ORGANIZER_WWW | set by Constant Editor (organizerWWW) |
ORGANIZER_CEO | set by Constant Editor (organizerCEO |
ORGANIZER_INCORPORATION | set by Constant Editor (organizerIncorporation) |
BANK_ID | set by Constant Editor (bankId) |
BANK_ACCOUNT | set by Constant Editor (bankAccount) |
BANK_NAME | set by Constant Editor (bankName) |
BIC | set by Constant Editor (bankBic) |
IBAN | set by Constant Editor (bankIban) |
VAT_ID | set by Constant Editor (vatId) |
TAX_ID | set by Constant Editor (taxId) |
SALUTATION | Personal data of the orderer - entered by the user during the ordering process |
FIRSTNAME | Personal data of the orderer - entered by the user during the ordering process |
LASTNAME | Personal data of the orderer - entered by the user during the ordering process |
COMPANY | Personal data of the orderer - entered by the user during the ordering process |
ADDRESS | Personal data of the orderer - entered by the user during the ordering process |
ADDRESS2 | Personal data of the orderer - entered by the user during the ordering process |
ZIP | personal data of the orderer - entered by the user during the ordering process |
TOWN | Personal data of the orderer - entered by the user during the ordering process |
COUNTRY | Personal data of the orderer - entered by the user during the ordering process |
BILLINGVATID | Personal data of the orderer - entered by the user during the ordering process |
BILL_NO | invoice number - automatically generated |
CUST_NO | customer number - automatically generated |
DATE | the current date |
CONTENT | the content of the blocks TEMPLATE_REVERSAL,TEMPLATE_CREDIT_NOTE, TEMPLATE_PARTIAL_REVERSAL AND TEMPLATE_BILL_ITEM are set here |
ATTENDEES | the content of the block TEMPLATE_ATTENDEES is set |
SUBTOTAL | the net value of the invoice |
VAT_RATE | vat rate used for the invoice |
VAT | vat value of the invoice - subtotal * (vat rate + 100) / 100 |
TOTAL | the gross value of the invoice |
UNTIL | the block of TEMPLATE_UNTIL is set |
Placeholders of TEMPLATE_BILL_ITEM block | |
TITLE | title of the booked product |
COUNT | number of the booked product |
PRICE | price of the booked product |
TOTAL | total of the booked product |
Placeholders of TEMPLATE_REVERSAL block | |
REFERRER_BILL_NO | Invoice number, which be canceled |
Placeholders of TEMPLATE_CREDIT_NOTE block | |
REFERRER_BILL_NO | invoice number for which the credit note is |
Placeholders of TEMPLATE_PARTIAL_REVERSAL block | |
REFERRER_BILL_NO | Invoice number, which be partial canceled |
Placeholders of TEMPLATE_UNTIL block | |
UNTIL | final date to pay |
Placeholders of TEMPLATE_ATTENDEES block | |
ATTENDEES | content of block TEMPLATE_ATTENDEE is set |
Placeholders of TEMPLATE_ATTENDEE block | |
ATTENDEE | firstname, lastname and username of an attendee is set |
Before you start to use the extension, you have to include the static extension template 'Conference basic configuration' where needed (since v.0.4.3) and to configure it's settings in TYPO3's Constant Editor. Please refer to chapter “Administration/Extension settings in Constant Editor” for an overview of available settings.
