DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

Org +ESAB

Author:Kasper Skårhøj
Created:2002-11-01T00:32:00
Changed by:dirk
Changed:2014-06-26T23:49:07
Classification:orgesab
Description:Publish your ESAB data with Org +ESAB. Org +ESAB imports data from an XML feed. Org +ESAB doesn't need the Organiser. It is not integrated in the Orgainser. But it is prepared for integration. The Organiser provides a calendar, locations, online-tickets and staff-management out of the box.
Keywords:forAdmins, forDevelopers, forAdvanced, esab, organiser
Author:Dirk Wildt (Die Netzmacher)
Email:http://wildt.at.die-netzmacher.de
Parent project:Organiser (org)
Website:http://die-netzmacher.de
Language:en

img-1 img-2 Org +ESAB img-3

Org +ESAB

Publish your ESAB data with Org +ESAB. Org +ESAB imports data from an XML feed. Org +ESAB doesn't need the Organiser. It is not integrated in the Orgainser. But it is prepared for integration. The Organiser provides a calendar, locations, online-tickets and staff-management out of the box.

img-4

Version: 0.1.0 - 2014-06-26

Extension Key: orgesab

Language: en

Keywords: forAdmins, forDevelopers, forAdvanced, esab, organiser

Copyright 2013-2014, Dirk Wildt (Die Netzmacher), <http://wildt.at .die-netzmacher.de>

This document is published under the Open Content License available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3 - a GNU/GPL CMS/Framework available from www.typo3.org

Introduction

What does it do?

Org +ESAB is an extension for the Europäische Sport-Akademie Land Brandenburg (ESAB) :sup:`0 <#sdfootnote1sym>`_ .

Org +ESAB imports the annual program hosted as an XML file into the TYPO3 database.

Org +ESAB manages the program data and published it supported by the Browser – TYPO3 without PHP.

The import is supported by the Scheduler (cron job). Org +ESAB is supported by the DRS – the Development Reporting System: You can follow the work flow of the import.

Org +ESAB is not integrated into the Organiser (org) yet but is prepared.

What do you need?

The extensions

  • Browser – TYPO3 without PHP (browser)
  • cps_tcatree

TYPO3 Versions

Version 4.5, 4.6 or 4.7.

Audience

Org +ESAB is totally dull for TYPO3 integrators and developers apart from this aspect:

  • You have to develop an interface for an XML import into TYPO3.
  • You need a cron job.
  • You like the support by the DRS – Development Reporting System

Maybe you can save time for the developing of an own solution, after you have inspected the code of Org +ESAB.

Installation

Quick guide

Install Org +ESAB supported by the Extension Manager.

Add and configure a sysfolder in the page tree for your Org +ESAB data.

Add a page for publishing your Org +ESAB data.

Add a TypoScript templateInclude the static templates:

Browser

Org +ESAB basis

Org +ESAB views

Add the Browser plugin/flexform.Configure it:

hh

Constant Editor

Add the Org +ESAB job to the scheduler

Extension Manager

Admin Tools > Extension Manager

  • Import Org +ESAB (orgesab)

  • Install Org +ESAB

    Database needs some new tables and fields. Click [Update]

Page and Sysfolder

Add a page and a sysfolder like in the example below:

Root

esab (page)

data (folder)

If you like the esab icon within your page tree please configure

  • The page properties of your page and/or your folder
  • [Appearance] > Use as container: "Org: ESAB"

img-5

TypoScript

Add a TypoScript template to your page esab.

  • Call it: +page_esab_1135 (where 1135 is the id of your TypoScript template)

  • Include the static templates

    • Browser (browser)
    • Org +ESAB: Basis (orgesab)
    • Org +ESAB: Views (orgesab)
    • Org +ESAB: +CSS (orgesab)

    Take care of the order!

Plugin

Add the Browser plugin/flexform to your page esab.

Configure it:

  • [General]
    • Call it: [Browser for Org +ESAB]
    • Set the header type to: [Don't display any header]
  • [Plugin]
    • Selected Plugin: Browser – TYPO3 without PHP
    • [List View] > Display: Navigation > Index Browser [ ] (disabled)
    • [Templating] > HTML: [Browser Main (browser)]
    • [jQuery & AJAX] > AJAX: [disabled]
  • [Behaviour] > Record Storage Page: Add the sysfolder data.

Please check your configuration

[General] > [Plugin check]

Constant Editor

Web > Template > page esab > constant editor

Category: [Organiser ESAB – pages]

Org +ESAB page uid: The id of your page esab

Scheduler (Cron Job)

Configuration

Modul: Admin Tools > Scheduler

Edit area: Select on top: [Setup check]

Please check, if your installation is proper.

Edit area: Select on top: [Information]

Add the job "Org +ESAB XML Import"

Start: Increase the current time by two hours

Frequency: 86000 (for once a day) or 14400 (every for hours) :sup:`0 <#sdfootnote2sym>`_

Id of Org +ESAB folder: The id of the folder "data" from above

Url: The URL of the ESAB program :sup:`0 <#sdfootnote3sym>`_

Save the form (see icon on the top)

Test it!

Execute the Org *ESAB job.

Modul: Admin Tools > Scheduler

Edit area: Select on top: [Scheduled tasks]

Select the job "Org +ESAB XML Import"

Start: Increase the current time by two hours

Click [Execute selected tasks]

You should get one e-mail at least to the given e-mail address from above.

If there is an error, you will get an e-mail per error too.

DRS – Development Reporting System

If there is any unexpected result, you can enable the DRS – the Development Reporting System. You will get prompts in the TYPO3 backend while runtime.

You need the extension developer log (devlog).

Modul: Admin Tools > Extension Manager

Edit area: Select this extension: "Org +ESAB"

[Configuration]

Category [DebuggIng]

DRS - Development Reporting System: [Enabled (for debugging only!]

[Update]

Test the job from above again. See "Test it!" above.

Call the DRS report:

Modul: Admin Tools > Developer Log

Frontend

Please visit the frontend.

RealURL

Org +esab has a ready-to-use configuration for RealURL. See

res/realurl_conf.php

Further Information

Other extensions published by Die Netzmacher

Manual in PDF

You find this manual as PDF file at

doc/manual.pdf

Change Log

0.1.0 Feature * #i0008: unique title for RealURL

0.0.9 Improvement * #i0007: RealURL configuration is updated.

0.0.8 Bugfix * #50220: Integration in Organiser

0.0.7 Bugfix * #i0006: Test of OS is canceled. It isn't needed.

0.0.6 Improvement * #i0005: Test of OS is canceled. It isn't needed.

0.0.5 Initial Release Dirk Wildt < http://wildt.at.die- netzmacher.de >

0 http://www.esab-brandenburg.de/

0 Unit are seconds. Example: formula for four hours is 60 seconds * 60 minutes * 4 hours: 60 *60 * 4 = 14400

0 Sorry: private data

9