Het in 1907 opgerichte bedrijf SKF is de grootste producent van kogellagers ter wereld. Naast het produceren van kogellagers is een belangrijke dienst van SKF het gegeven van advies over de toepassing van lagers. Hierbij wordt gebruik gemaakt van door SKF zelf ontwikkelde simulatiesoftware waarin praktijktoepassingen van lagers worden nagebootst om onder andere levensduurberekeningen uit te voeren. Omdat dit soort materie vrij complex kan zijn, is een belangrijk aspect van deze software de beschikbaarheid van een goede handleiding. Dit is waar TYPO3 om de hoek komt kijken. Voor SKF ben ik op dit moment bezig om een centaal documentatiesysteem op te zetten, gebaseerd op TYPO3. De documentatie die door TYPO3 wordt gegenereerd kan in de simulatiesoftware zelf worden bekeken met een geïntegreerde browser. Bijzonder hierbij is dat niet elke gebruiker dezelfde mogelijkheden heeft in de simulatiesoftware. Afhankelijk van de licentie van een gebruiker zijn bepaalde onderdelen in het pakket wel of niet actief. Met behulp van uitgebreide gebruikersprofielen krijgt elke gebruiker uniek voor hem gegenereerde documentatie te zien, die precies past bij de mogelijkheden in zijn simulatiesoftware. In mijn presentatie zal ik meer vertellen over deze niet alledaagse toepassing van TYPO3. Hierbij zal ik met name ingaan op hoe TYPO3 is gekoppeld en geïntegreerd met andere SKF systemen en de verschillende manieren waarop TYPO3 is uitgebreid. Denk hierbij aan de uitbreiding van de frontend authenticatie, custom backend modules, custom clickmenu's, LaTex ondersteuning in de RTE, automatische video conversie naar HTML5, en nog veel meer. Interessant voor ontwikkelaars en beleidsmakers die willen zien wat de uitbreidingsmogelijkheden van TYPO3 zijn. - Een niet alledaagse toepassing van TYPO3 - Een showcase van de uitbreidingsmogelijkheden van TYPO3 - Aanknopingspunten voor ontwikkelaars Bart Dubelaar Bart is 31 jaar en werkt als Technical Software Engineer bij Logica, onderdeel van CGI. Bart is gecertificeerd TYPO3 integrator en heeft 3 jaar ervaring als TYPO3 ontwikkelaar en integrator. Op dit moment werkt Bart als consultant bij SKF in het Engineering & Research Centre waar gewerkt wordt aan interne Knowledge & Simulation tooling.

1. Een centraal
Documentatiesysteem met
TYPO3
Bart Dubelaar
6 November 2012

2. Agenda
• Logica
• SKF
• De opdracht
• Systeemcontext
• Aanpak
• Implementatie
• Resultaat
© Logica 2012. All rights reserved No. 2

3. Logica TSE

4. Logica Technical Software Engineering
• Logica onlangs overgenomen door het Canadese CGI
• Nu 76.000 werknemers wereldwijd, 4.500 in Nederland
• Technical Software Engineering: 250 man in Nederland
• Software ontwikkeling in verschillende technische velden
© Logica 2012. All rights reserved No. 4

5. Logica Technical Software Engineering
High Space Smart mobility Modelling,
Monitoring Modelling,
integrity, visualization
& Space Embedded visualization &
monitoring &Geo ICT
Geo ICT
Control Systems
and control
© Logica 2012. All rights reserved No. 5

7. SKF - Svenska Kullagerfabriken
• Grootste kogellagerfabrikant ter wereld
• Niet alleen kogellagers, ook mechatronica, smeermiddelen en
afdichtingen.
• Opgericht in 1907, ooit moederbedrijf van Volvo
• 44.500 werknemers wereldwijd
• Hoofdkantoor in Göteborg Zweden
• Engineering & Research Center in Nieuwegein
© Logica 2012. All rights reserved No. 7

8. SKF Simulation Tools
CAD models of customer
SKF simulation models
© Logica 2012. All rights reserved No. 8

9. SKF Simulation Tools
© Logica 2012. All rights reserved No. 9

10. De opdracht

11. De opdracht
• Help & documentatie geïntegreerd in de simulatiesoftware
• Centraal te beheren
• Beschikbare documentatie dynamisch afgestemd op gebruikersprofiel
van de gebruiker
• Separate documentatie per software release branch
• Workflow met content approval procedure
• Context sensitive help
• Meertalig
• Zoekfunctionaliteit, dynamisch afgestemd op niveau van toegang
• Authenticatie tegen software license server
• Ondersteuning van LaTex formules & embedded video's
© Logica 2012. All rights reserved No. 11

12. Documentatie dynamisch afgestemd op
gebruikersprofiel van de gebruiker
• Software heeft 1000+ features
• Elke gebruiker een profiel met unieke combinatie van features
• Verschillende documentatie per softwareversie
• Pagina en content access control op: Page
• Feature Content element
• Versie
• Gebruikersgroep (SKF afdelingen) Content element
• Zoekfunctie die content access
respecteert Accessible only by: feature X
Content element
© Logica 2012. All rights reserved No. 12

13. Separate documentatie per software
release branch
• Versioning in 3 dimensies:
• Draft versioning Vertaling
• Talen
• SKF Software versies
Pagina
Draft SKF
software
versie versie
© Logica 2012. All rights reserved No. 13

14. Context sensitive help
• Help knoppen in de software doorlinken naar corresponderende
documentatie
• Juiste paginaversie corresponderend met softwareversie
• Documentatiebeheerders moeten eenvoudig kunnen koppelen en
nagaan of alle knoppen gedekt zijn.
© Logica 2012. All rights reserved No. 14

15. Systeemcontext

16. Systeemcontext
Het documentatiesysteem heeft de volgende informatie nodig (1/2):
• Welke softwareversies zijn er?
• Gebruikers moeten naar de documentatie geleid worden die correspondeert
met hun software versie. Documentatie moet gemerkt worden met
features.
• Welke features bestaan er voor elke software versie?
• Toegang tot pagina’s en inhoud moet worden verleend op basis van
features.
• Welke help knoppen bestaan er voor elke software versie?
• Content editors hebben een overzicht nodig en moeten documentatie
toewijzen.
• Mag een gebruiker inloggen?
• Inkomende documentatieverzoeken moeten geauthentiseerd worden tegen
de software license server.
© Logica 2012. All rights reserved No. 16

17. Systeemcontext
Het documentatiesysteem heeft de volgende informatie nodig (2/2):
• Tot welke features heeft een gebruiker toegang?
• Een gebruikersprofiel met gebruikersdetails moet worden verkregen bij de
software license server.
• Welke versie van de software gebruikt de gebruiker op dit moment?
• Deze informatie moet worden verstrekt vanaf de simulatie software.
© Logica 2012. All rights reserved No. 17

18. Systeemcontext
Software
Web Content
Feature & Version
Editor
Manager
Documentatiesysteem
Content Editing
Software License
Authentication
Server
Server (LDAP)
SKF Simulation
Software
© Logica 2012. All rights reserved No. 18

19. Aanpak

20. Integratie in de software
• Geïntegreerde webbrowser op basis van QtWebkit
• SKF Simulation Tools maken gebruik van het Qt framework, dus
QtWebkit is reeds beschikbaar.
© Logica 2012. All rights reserved No. 20

21. Documentatie dynamisch afgestemd op
gebruikersprofiel (1/3)
Content tonen op basis van de software features en software versies.
• Optie 1: Standaard gebruikersgroepen TYPO3 gebruiken
• +: Snel te implementeren
• −: Gebruikersgroepen worden al ingezet voor “gebruikersgroepen”.
Logische “&” combinaties tussen meerdere doeleinden zijn niet mogelijk
(SKF afdeling A & Feature X & Versie 2.0).
• −: Onoverzichtelijk met 1000+ features.
• Optie 2: Users, Pagina’s & Content uitbreiden met velden voor
features en versies. Typoscript conditie om content te verbergen.
• +: Beter overzicht met dedicated velden. Simpele extensie.
• −: Alleen content wordt verborgen, pagina’s zichtbaar in menu’s en
zoekresultaten.
© Logica 2012. All rights reserved No. 21

22. Documentatie dynamisch afgestemd op
gebruikersprofiel (2/3)
Content tonen op basis van de software features en software versies.
• Optie 3 (gekozen): Velden toevoegen zoals bij optie 2.
TYPO3 Core access mechanismen uitbreiden voor de custom velden.
• +: Volledig transparant
© Logica 2012. All rights reserved No. 22

23. Documentatie dynamisch afgestemd op
gebruikersprofiel (3/3)
Ontsluiten van de benodigde informatie
• Import vanaf feature manager (handmatig gestart)
• Beschikbare versies
• Beschikbare features per versie
• Beschikbare help knoppen per versie
• Import vanaf feature manager (automatisch, elke dag)
• Status informatie over beschikbaarheid van nieuwe gegevens
• Import vanaf license manager
• Gebruikersprofielen, automatisch op moment van inloggen
© Logica 2012. All rights reserved No. 23

24. Separate documentatie per software
release branch
Versioning in 3 dimensies:
• Talen ! Standaardfunctionaliteit TYPO3
• Draft versioning ! TYPO3 Workspaces
• SKF Software versies:
• Optie 1: Talen misbruiken.
• −: Talen worden al gebruikt. Verwarrend oneigenlijk gebruik.
Lastig onderhoudbaar bij snelle releasecycles.
• Optie 2 (gekozen): Geen versioning op paginaniveau, maar duplicaat van
de volledige paginaboom per versie. Branchen faciliteren met custom
extensie.
• −: Simultaan onderhouden meerdere losgekoppelde branches is lastig.
© Logica 2012. All rights reserved No. 24

25. Context sensitive help
• Elke help knop in de simulatiesoftware krijgt automatisch een unieke
beschrijving.
• De aanwezige feature manager exporteert lijsten met beschrijvingen
van alle aanwezige help knoppen vanuit de software code.
• Content managers koppelen help beschrijvingen aan pagina’s.
• Bij het klikken op een help knop in de simulatiesoftware wordt een
documentatierequest gegenereerd met de unieke code
• Een custom TYPO3 extensie zoekt de juiste pagina behorend bij de
software versie en unieke help beschrijving.
© Logica 2012. All rights reserved No. 25

26. Authenticatie tegen license server
• Custom frontend authentication service voor TYPO3
• Simulatie Software zet een sessie op met license server
• Sessie token wordt meegestuurd met documentatierequests
• TYPO3 authenticatie service valideert token tegen de license server
• Bij verlopen sessie informeert TYPO3 de simulatie software dat een
nieuwe sessie opgezet moet worden.
© Logica 2012. All rights reserved No. 26

27. Frontend zoekfunctionaliteit
Eisen
• Snel
• Resultaten moeten afgestemd zijn op de toegangspermissies van de
huidige gebruiker.
Opties
• Indexed Search
• −: zoekt niet direct in de content maar in een opgebouwde index. Deze
index bevat een entry per unieke combinatie van usergroups. Dit zou
moeten worden uitgebreid met features en versies. In de praktijk betekent
dit een unieke index per gebruiker door de vele mogelijke combinaties.
• Solr
• −: Gelijk aan Indexed Search
• Search content element (searchresult)
• +: doorzoekt page en content direct met respect voor permissies
• −: traag, maar niet te traag
© Logica 2012. All rights reserved No. 27

28. Implementatie

29. Access extensie (1/2)
Onderdelen
• Authentication service
• Access control uitbreiding met custom velden (features)
• Frontend plugin voor dummy logins (gebruikt door editors)
© Logica 2012. All rights reserved No. 29

30. Access extensie (2/2)
Voor ontwikkelaars
• Authentication service schrijven
• Documentatie van ‘cc_sv_auth’ in TER
• Voorbeeld ‘cc_svauthdemo’ in TER
• Document ‘doc_core_services’ over services in het algemeen
• Access control uitbreiden met custom velden
• ‘Modern Template Building, Part 3’ (extending the built in access scheme)
• In plaats van voorbeeld in modern template building de volgende functies
uitbreiden (ondersteuning voor pages en handiger met versioning):
• 1: getMultipleGroupsWhereClause functie in class.t3lib_pageSelect.php
• 2: checkEnableFields functie in class.tslib_fe.php
• Indien frontend search gebruikt wordt dan moet de treelist cache functie
ook aangepast worden:
• 3: getTreeList functie in class.tslib_content.php
• Treelist cache tabel blokkeren kan ook (minimale performance impact).
© Logica 2012. All rights reserved No. 30

31. Imports & Monitoring
• Monitoring extensie
• Backend module met
statusoverzicht externe data
• Import extensie
• Community extensie
‘external_import’ als engine.
• Task voor dagelijkse controle
Voor ontwikkelaars
• Scheduler task maken
• Manual van scheduler ext
• http://t3blog.de/2010/09/24/den-scheduler-nutzen/
• Backend module toevoegen
• http://wiki.typo3.org/Backend_Programming#Custom_Backend_Module
• Core Doc ‘Inside TYPO3’
© Logica 2012. All rights reserved No. 31

32. Branching
• Custom click menu actie
‘Create new branch’
• Klik op hoofdpagina van bestaande
branch
Voor ontwikkelaars
• Custom action toevoegen aan pagetree
• http://wiki.typo3.org/
Pagetree#How_to_add_custom_actions
• PHP script aanroepen vanuit javascript om
pagina’s te kopieren (Ext.Direct)
• http://wiki.typo3.org/
ExtDirect#How_to_use_Ext.Direct.3F
• Gebruik van een hook na het kopiëren om
interne links te corrigeren
• Geleend van ‘danp_sitecopy’
© Logica 2012. All rights reserved No. 32

33. LaTex & HTML5 video
LaTex
• Community extensie ‘latexmath’
• Rendert LaTex formules als plaatjes
• Voor SKF uitgebreid met RTE support
HTML5 video
• Community extensie ‘ods_html5_media’
• Zet video’s automatisch om naar HTML5 geschikt formaat
met behulp van FFMpeg
© Logica 2012. All rights reserved No. 33

34. Workflow met content approval
procedure
• TYPO3 Workspaces
• Editors editen alleen in draft, geen toegang tot live!
• 4 custom approval stages!
• Custom backend module om gearchiveerde versies te bekijken
• Draft previews & frontend usergroups weinig gebruikte combinatie,
aantal core patches ontwikkeld om dit beter te laten werken.
© Logica 2012. All rights reserved No. 34

35. Resultaat

36. Resultaat
© Logica 2012. All rights reserved No. 36

37. Resultaat
© Logica 2012. All rights reserved No. 37

38. Bedankt
Bart Dubelaar
Logica is now part of CGI, a leading business and technology services company focused on helping clients achieve results. Since our founding in 1976, we've
operated upon the principles of sharing in clients' challenges and delivering quality services to address them. With 72,000 professionals in more than 40
countries, we have the presence, expertise and complete IT services to meet clients’ business needs anywhere, anytime. We provide the responsiveness and
accountability of a true local partner while offering the global scale, talent and services needed to meet your evolving needs. Visit www.cgi.com and
www.logica.com to learn more.