Joomla aanvulling stappenplan

Stel je development site in

Zorg allereerst voor een Joomla develoment site (niet-productie). Neem contact op met je Joomla provider om een development Joomla site (of testomgeving) voor je op te zetten, of doe dit zelf. Volg vervolgens deze stappen: 

1. Kies een subdomein voor je dev Joomla site, bijvoorbeeld subdomein[punt]voorbeeld[punt]com. SSL is nodig voor het goed functioneren van de Wisecat+.
2. Geef je subdomein en Wise instantie zo snel mogelijk door aan OCLC via een Zendesk ticket.
   OCLC zal het subdomein en instantie toevoegen aan de Single Identity configuratie.
3. Maak een dev site aan in een subdomein van je server met een kopie van je Joomla productie site. Je kunt eventueel de dev site vantevoren al aanmaken. Je Joomla provider kan je helpen met het aanmaken van de dev Joomla site en de rest van de Joomla migratie.

Er zijn twee opties voor livegang. Er is geen goede of foute optie hier. Welke optie voor jouw organisatie beter is, ligt aan je situatie. Je kunt zelf (samen met je Joomla provider) bepalen welke van de twee opties je kiest:

Optie A: Livegang met kopie van de dev omgeving
Deze optie heeft de minste downtime van de website, maar je moet wel – zolang je werkt aan de development omgeving – alle (data-)wijzigingen die in productie gedaan worden ook bijhouden in je development omgeving. Als je veranderingen niet op beide plekken maakt, worden ze verwijderd wanneer je productie site wordt omgezet met de nieuwe Joomla extensie en Wisecat+ integratie. 

Deze optie houdt in dat je development Joomla site uiteindelijk je productie website wordt.

Optie B: Livegang door in productie dezelfde stappen te doorlopen die je in je dev omgeving hebt gedaan
Ben je klaar om live te gaan? Zet dan de productiesite in 'offline' modus. Pas dan in de productiesite alle wijzigingen toe die je ook in de dev site hebt gemaakt. Met deze optie is je site ongeveer 2-4 uur niet beschikbaar voor bezoekers.

Als je deze optie kiest, hoef je contentveranderingen niet op twee plekken uit te voeren. Nadeel is dat je site langer onbereikbaar is voor klanten.

Voor de stappen die bij Optie A en Optie B horen, zie Stap 3 verderop op deze pagina.

Verwijder de oude Joomla-Wise integratie

Je Joomla provider zal je oude Joomla en Wise integratie verwijderen. Controleer of je op je Joomla development site zit, en volg deze stappen:

1. Verwijder of outcomment de aan Wise gerelateerde Rewrite Rules in .htaccess. Deze zouden te vinden moeten zijn tussen ## Begin - Custom redirects en ## End - Custom redirects, maar het kan zijn dat ze op een andere plek in het bestand staan. Voor deze stap heb je toegang nodig tot de Joomla server. De regels zien er waarschijnlijk ongeveer zo uit:
   
2. Verwijder de Wise Modules en leeg de prullenbak. Het gaat om deze modules:
   • alle Wise Bookcarousel modules
   • alle Wise Searchbar modules
   • de jQuery Easy Profiles modules voor /wise-apps en /catalog
   • de Login to My Account Custom module
   • de My Account/Logout Custom module
3. Verwijder eventuele Wise-gerelateerde menu-items zoals /wise-apps en /catalog (of catalogus) uit je menus. Het gaat daarbij om één van de volgende menu-types: 
   • Wise > Wise Apps
   • Wise > Wise Wrapper
   • Wrapper >Iframe Wrapper
4. Filter nadat je de menu items hebt weggegooid de search tools, en verwijder de menu items uit de prullenbak. Zorg er ten minste voor dat het menu item met de alias 'wise-apps' uit de prullenbak is verwijderd: de nieuwe integratie heeft het alias 'wise-apps' nodig, en deze kan maar één keer worden gebruikt.
5. Verwijder eventuele Login en Logout menu items, of schakel deze uit. Je hebt de Joomla core login/logout functionaliteit niet meer nodig.
6. De-installeer de extensies die nodig waren voor de oude Joomla-Wise integratie:
   • Wise Package
   • jQuery Easy Profiles (tenzij je deze gebruikt voor iets anders dan Wise)
   • Simplify Your Web Library (tenzij je deze gebruikt voor iets anders dan Wise)
   • Regular Labs Sorcerer (tenzij je deze gebruikt voor iets anders dan Wise)
7. Ga naar System > Manage > Extensions and typ "Wise" in de zoekbalk. Zoek naar eventuele andere Wise extensies geassocieerd met de bestaande (oude) integratie. Als je deze vindt: de-installeer ze dan.
8. Zoek naar eventuele custom extensies die gebouwd zijn om Wise functionaliteit op je site uite te breiden, en de-installeer deze.
9. Verwijder Joomla core Language Overrides die speciaal bedoeld waren voor de Wise-Joomla integratie (bijvoorbeeld: gebruikersnaam en wachtwoord language strings).
10. Verwijder Wise-gerelateerde CSS en template considerations. (Elke site is anders, dus wees hier voorzichtig mee):
    • Bekijk custom CSS bestanden en bepaal wat er direct gerelateerd was aan Wise CSS, en wat er dus kan worden verwijderd. (Je kunt het ook tijdelijk outcommenten, of een kopie van de code bewaren in Kladblok, aangezien je een deel misschien opnieuw kunt gebruiken).
    • Controleer alle HTML overrides. Verwijder deze waar mogelijk.
    • Controleer /templates/yourtemplate/html/layouts/joomla/system/message.php en verwijder deze. Wise gebruikt het Joomla message component niet meer om klant notificaties te tonen bij inloggen.
11. Controleer in de frontend of er nog stukjes Wise zijn achtergebleven, en zo ja, verwijder deze.

Configureer de Wisecat+ (acceptatie-omgeving)

Voor de reguliere Wisecat+ configureer je de menu-ingangen en styling vanuit de Wise Manager via systeemWise. Voor Joomla is dit niet nodig aangezien zowel het menu als de stying in Joomla wordt ingericht. Mocht je dingen willen wijzigen in menus of styling, dan doe je dat in Joomla.

Net als nu zullen er nog een aantal pagina's in een iframe getoond worden. De styling in Joomla heeft op deze onderdelen geen effect. Deze zullen met dezelfde styling getoond worden zoals dat ze voor deze migratie werden getoond. Het ombouwen van de CGI pagina's staat op de planning voor later dit jaar.

De stappen voor het configureren van de Wisecat+ in de acceptatie-omgeving zijn als volgt:

1. Activeer de nieuwe Wisecat+ door voor de Joomla-instantie OPACV2L op 'Ja' te zetten via systeemWise > Systeemopties. 
   Hierna kun je niet meer in de 'oude' portal: je wordt geredirect naar de nieuwe Wisecat+. Ook verandert de authenticatie flow: deze gaat nu via Keycloak. Je wordt nog niet naar de Koninklijke Bibliotheek gestuurd en je kunt nog inloggen met je Wise credentials.

    Let op: je werkt hier nog steeds op de acceptatie- of testomgeving die je wilt koppelen aan de development omgeving van Joomla.

2. Controleer of je Portal via website URI het domein is van je development server /catalogus (of /catalog):
   • Ga naar Beheer organisaties > Instanties en kies je instantie.
   • Bekijk het veld 'Portal via Website URI': hier moet het domein of subdomein van je Joomla website /catalog (of /catalogus) staan.
   • Zorg ervoor dat er iets na de / staat: het maakt niet uit wat (dit is een tijdelijke oplossing).
     
   • Om veranderingen in dit veld door te voeren, is een server restart nodig. Open hiervoor een Zendesk ticket. 

Installeer en configureer de nieuwe Wisecat+ Joomla extensie

Om de nieuwe Wisecat+ Joomla extensie te configureren heb je de volgende informatie nodig van OCLC:

• Wise Server Name: de acceptatie- of testomgeving die je aan Joomla wilt koppelen (het domein)
• Branch number: hoofdvestiging of vestiging 'Alle vestigingen' van de instantie die aan Joomla gekoppeld is (dezelfde als die je nu gebruikt)
• Library ID/Instantie: instantie waarvoor deze Joomla site bedoeld is
• Keycloak Domain
• Realm name
• Client ID local
• Client ID external
• Client secret key

Als je deze informatie nog niet hebt, open dan een Zendesk ticket. Maak in dit ticket duidelijk dat je deze informatie nodig hebt voor je Joomla testomgeving.

Stappen bij Optie A

Hieronder volgen de stappen als je hebt gekozen voor Optie A (livegang met kopie van de dev omgeving):

Copy the dev site with the new extension, kill the prod site, and restore the dev site to public_html on the server. Approximately ten minutes down time. (Disable oclcwise system plugin before taking backup, then restore, fix the configuration of the oclcwise extension to production Wise and Keycloak, then enable the system plugin.) ----> klopt hieronder?

1.  Maak backup van development omgeving 
   1. Schakel de oclcwise system plugin uit (Jennifer)
   2. Maak een backup (kopie) van de Development omgeving
2. Zet de productieomgeving op “offline”
3. Herstellen dev omgeving in productie
   1. Herstel de kopie van dev omgeving als “herstelkopie” voor de productie site
   2. Schakel de oclcwise system plugin weer in (Jennifer)
4. Vervang de voor acceptatie verkregen gegevens (zoals Client ID) door de juiste gegevens voor productie.
   Op dit punt in het proces gebruiken we het local Client ID
5. Activeer systeemoptie OPACV2L.
6. Controleer of alles naar verwachting werkt in offline modus.
7. Wanneer je tevreden bent met het resultaat, zet je de offline modus uit zodat de site weer publiekelijk toegankelijk is. 

Stappen bij Optie B

Hieronder volgen de stappen als je hebt gekozen voor optie B (livegang door productieomgeving actief over te zetten):

1. Zet je bestaande Joomla site in offline modus.
2. Volg het stappenplan uit Stap 2 hierboven (Verwijder de oude Joomla-Wise integratie) binnen je development site. 
3. Activeer systeemoptie OPACV2L.
4. Volg het stappenplan uit Stap 4 (Installeer en configureer de nieuwe Wisecat+ Joomla extensie) binnen je development site.

    Zorg dat je nu de gegevens voor productie invult en niet voor de acceptatie-omgeving.

5. Test grondig in offline modus.
6. Wanneer je tevreden bent met het resultaat, zet je de offline modus uit zodat de site weer publiekelijk toegankelijk is.