.. You may want to use the usual include line. Uncomment and adjust the path. 
.. include:: ../Includes.txt


=========================
EXT: zooom Akamai Handler
=========================

:Author:
      Christopher

:Created:
      2010-12-18T19:57:23

:Changed:
      2014-07-01T16:20:39

:Classification:
      zoat_akamai

:Author:
      Hannes Maier

:Email:
      hannes.maier@zooom.at

:Language:
      en


.. _img-1-img-2-Akamai-CCU-ECCU-Purge:

|img-1| |img-2| Akamai CCU / ECCU Purge
=======================================

Extension Key: zoat\_akamai

Language: en

Version: 2.2

Keywords:

Copyright 2013, Hannes Maier, <hannes.maier@zooom.at>

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

.. _Table-of-Contents:

Table of Contents
-----------------

**`zooom Akamai Handler 1 <#__RefHeading__5708_1738894311>`_**

**`Introduction 3 <#__RefHeading__5710_1738894311>`_**

`What does it do? 3 <#__RefHeading__463_413120346>`_

`Screenshots 3 <#__RefHeading__465_413120346>`_

**`Users manual 4 <#__RefHeading__467_413120346>`_**

**`Configuration 5 <#__RefHeading__31515_818911409>`_**

**`Known problems 6 <#__RefHeading__31525_818911409>`_**

**`To-Do list 7 <#__RefHeading__477_413120346>`_**

**`ChangeLog 8 <#__RefHeading__31623_818911409>`_**


.. _Introduction:

Introduction
------------


.. _What-does-it-do:

What does it do?
^^^^^^^^^^^^^^^^

- CCU REST and ECCU SOAP Akamai

- Hooks clearCachePostProc and clearPageCacheEval collect purge
  information

- CCU/ECCU statements collected in a table

- Scheduler Task to periodical send CCU/ECCU statements to Akamai

- Menu Item added to purge by CP-Code

- tt\_content / pages and tt\_news changes in Version 1.

- Feel free to add your own plugins / statements

- Akamai Dokus (only available with valid logins):
  
  - `https://control.akamai.com/dl/customers/other/CCU/Content\_Control\_I
    nterfaces.pdf <https://control.akamai.com/dl/customers/other/CCU/Conte
    nt_Control_Interfaces.pdf>`_
  
  - https://control.akamai.com/portal/content/webservices/docs/wsdls.jsp


.. _Screenshots:

Screenshots
^^^^^^^^^^^

|img-3| Menu item for CCU by CP-Code (use with caution)


.. _Users-manual:

Users manual
------------

Hooks generate URLs (special page type) which are stored in the
database.

On a regular basis these URLs are read with CURL (to have full access
to th TSFE, typolink, RealUrl, …)

Via the special page type you land in
/service/class.tx\_zoatakamai\_service.php where the params from the
URL are parsed and evaluated which statements should be sent to
Akamai.

Here you can add you own classes to generate ARLs (for CCU), ...


.. _Configuration:

Configuration
-------------

Configuration is done at plugin installation.

Don't forget to add the static extension template!

Page 1 should be the rootpage

Extension setup:

- CP Code: provided by Akamai / business sponsor

- Host Header: provided by Akamai / business sponsor

- Domain: production / staging

- API Username: provided by Akamai / business sponsor

- API Password: provided by Akamai / business sponsor

- API action: remove / invalidate

- Notification Email address (only for ECCU SOAP)

Page Setup:

- add the static extension template

- for plugin-data setup TCEMAIN.clearCacheCmd in the sys-Folder

|img-4| 
Known problems
--------------

None


.. _To-Do-list:

To-Do list
----------

- Maybe think much simpler and send only ECCU on default and custom file
  extensions (but this way the whole project would be purged – and it
  takes longer...)

- add “default file extension” to configuration

- Bugfixing :)


.. _ChangeLog:

ChangeLog
---------

Create a file "ChangeLog" (see e.g. the extension "cal") to inform
about changes or use this section to document all the changes through
the versions.

Alternatively to using the following list: `ChangeLog online (Forge
gives the possibility to create a Roadmap very easily; change this
link to point to YOUR extension) <http://forge.typo3.org/projects/typo
3v4-official_extension_template/roadmap>`_

.. ### BEGIN~OF~TABLE ###


.. _2-2:

2.2
^^^

.. container:: table-row

   Version
         2.2
   
   Changes
         Akamai CCU changed to REST API



.. _2-1-0-2-1-2:

2.1.0 - 2.1.2
^^^^^^^^^^^^^

.. container:: table-row

   Version
         2.1.0 - 2.1.2
   
   Changes
         Bugfixes



.. _2-0-0:

2.0.0
^^^^^

.. container:: table-row

   Version
         2.0.0
   
   Changes
         First version


.. ###### END~OF~TABLE ######


.. ######CUTTER_MARK_IMAGES######

.. |img-1| image:: img-1.png
.. :align: left
.. :border: 0
.. :height: 44
.. :id: graphics5
.. :name: graphics5
.. :vspace: 57
.. :width: 161

.. |img-2| image:: img-2.png
.. :align: left

.. |img-3| image:: img-3.png
.. :align: left

.. |img-4| image:: img-4.png
.. :align: left