Prerequisites
All the bullet points below have to be respected if you want to use the new feature on your project
Portal & Engine version 2024.4 (or after)
New structures
portal
wkfpkgportal
wkfpkgportalaction
portaldownload
homewidgetelttype
Updates on existing structures :
asset & all your #damobject structures
vueapphomewidget
Creation or updates of/on instances for :
wkfpkgportal => CREATION
wkfpkgportalaction => CREATION
homewidgetelttype => CREATION
vueapphomewidgettype => UPDATE
pkgroletemplate => UPDATE
Plugins :
PACKAGED_Portals => activated
Portal’s configuration :
portals config domain added
named action actions added in common
features config has a new entry called portals, it should be set to true, if you want to use the creative workflow and it is by default activated
1/ Install on existing projects
Steps to follow for installing portals on existing projects, after fulfilling the prerequisites.
Permissions
To have correct permissions on portals we also recommend to update or reset pkgroletemplate instances and all the other pkg* objects. If you reset your permissions from the nar, don’t forget to call the update (admin) endpoint given by PACKAGED_Security.
A touch on the users may also be needed to ensure that users, roles and roles templates are correctly synchronized.
For the portals to be fully functionnal, and to benefit from the “share” feature fully, the “update” endpoint will add a new instance in pkgsecugroup, to allow users to access public portals and their assets without being logged in (direct access by link).
If you can’t reset your permissions, you must modify them. You can do this by using wedia-config’s role template menu. For each role template, you will edit it’s “ Global permissions ” permissions.
For the “Administrator role type” the permissions should be configured this way :
Create portals => checked ✅
Administering portals => checked ✅
For the “Contributor role type” the permissions should be configured this way :
Create portals => checked ✅
Administering portals => not checked 🟩
For the “Userrole type” the permissions should be configured this way :
Create portals => not checked 🟩
Administering portals => not checked 🟩
Front app
You will also need to upgrade your portal to retrieve all the new components and configs to benefit from the portals
Asset Libraries
For all your library structures, which are containing assets that you want to use in portals, you will need to update them by adding a new prop called portals, the same way it’s present on asset structure (tags too).
All asset libraries created from wedia-config will be prepared to work with the portals, and will have a portals prop
Front app home widgets
We’ve added the possibility to link portals to a vueapphomewidget instance, and therefore display them on the front’s home page as widgets, the same way boards are displayed.
To benefit from this feature, you have to update your vueapphomewidget structure, retrieve the new structure called homewidgetelttype and it’s instances (from the nar) and update your current vueapphomewidgettype instances. vueapphomewiget received new props and a significant number of faces (facet/ “facettes”). More details here : https://crossmedia.atlassian.net/wiki/spaces/WD/pages/3299180556/Portals+feature+explained#Home-widgets
After updating your structure, we recommend updating any existing instances and selecting the element type "Board" when it's displayed as "None." This update won't affect the front-end rendering, but it will ensure your data remains more consistent.
2/ Install on projects starting on 2024.4
In this case, you will only have to respect the Prerequisites. And the feature is coming by default with the 2024.4.
Don’t forget to call the update (admin) endpoint given by PACKAGED_Security.
If you create asset libraries without using wedia-config, make sure to copy our asset structure if you want to fully benefit from the new feature.
3/ Don’t need the portals
If you are updating your app to the 2024.4 and you don’t want to benefit from or use the new feature, here are the steps to follow :
Disable PACKAGED_Portals
In your front app’s feature config, set portals to false