Portal management
On this site you find information on how to manage portals.
Overview
Start managing your portals by clicking on "Content-Management → Portale"
You get a list of available portals:
Create / Edit a portal
Basic settings
You can enter the basic settings of a portal here:
| Key | Explanation | Example |
|---|---|---|
| ID | The ID of the portal - automatically set upon creation of the portal | 1 |
| Namespace | The namespace the portal belongs to | _instance.staging-my-ikona |
| Titel | The title of the portal | ikona-staging |
| URL | The URL of the portal (Regular expression. This will be matched against the request from the domain, to resolve the current portal) | ^staging-www\.my-ikona\.com |
| Portal-Domain (Host) | The portal domain (Host) (accessible by the JSMA portal.host) | staging-www.my-ikona.com |
| ProductionHost | The production host (optional. If set, this domain will be used for content resolving instead of the actual domain of the request) | |
| Log Level | The level of logging. Possbile values are:
| DEBUG |
Security settings
Secure a portal using Basic Auth when the portal should not be public (yet).
| Key | Explanation |
|---|---|
| Basic Auth Benutzer | The name of the user, that should be used for Basic Auth |
| Basic Auth Passwort | The password of the user for Basic Auth |
Backend settings
Set up a backend for further processing of the order. This is mainly used for connecting the IFE to the IBE2 Service.
| Key | Explanation | Example |
|---|---|---|
| Backend Typ | The type of the used backend | ikona.ibe2 |
| URL | The URL where the backend can be found | https://print2.my-ikona.com/ibe2/ |
| Benutzer | The user that is used to authenticate at the backend | |
| Passwort | The password of the user |
IBS settings
Connect the portal with the Ikona Binary Store (IBS)
| Key | Explanation |
|---|---|
| Ibs Base Url | The URL of the IBS API server |
| Ibs User | The user name used in authentication |
| Ibs Password | The password used in authentication |
E-Mail settings
Set up SMTP-settings. These will be used when sending mail programmatically via JSMA mail.
| Key | Explanation |
|---|---|
| SMTP-Server | The URL of the SMTP-server |
| SMTP-Port | The port of the SMTP-server |
| SMTP-Benutzer | The user name that is used for authentication |
| SMTP-Passwort | The password that is used for authentication |
See also JSMA mail
Payment settings
Set up the supported payment types for the portal.
| Key | Explanation |
|---|---|
| Versand MwStSatz | The percentage of the value-added tax |
| Zahlungsarten | Chose the possible payment-types |
| Paypal-Modus | If Paypal is in one of the intended payment-types, you can choose here, whether the sandbox-mode of paypal should be used or the live-mode |
| Paypal Login | The user that is used to authenticate with the Paypal-server (live-mode) |
| Paypal Passwort | The password of the user (live-mode) |
| Paypal API Signatur | The signature of the API (live-mode) |
| Paypal Sandbox Login | The user that is used to authenticate with the Paypal-server (sandbox-mode) |
| Paypal Sandbox Passwort | The password of the user (sandbox-mode) |
| Paypal Sandbox API Signatur | The signature of the API (sandbox-mode) |
Shipping settings
Select which shipping methods the user will be able to choose from:
| Key | Explanation |
|---|---|
| Versandarten | Choose one of the possible shipping methods |
| Versandregionen | Manage the shipping regions |
| Regions-Key | Explanation | Example |
|---|---|---|
| Land | The destination country | Deutschland |
| Aktiv | Choose whether this region should be active or not | |
| Priorität | Chosse whether this region has priority or not | |
| Versand | The shipping costs the customer has to pay | 5.50 |
| Versand XL | The xl-shipping costs the customer has to pay | 9.95 |
| Expressversand | The express shipping costs the customer has to pay | |
| Expressversand XL | The xl-express shipping costs the customer has to pay | |
| Aktionen | Possible actions, e.g. delete the region |
Template settings
Set up templates for the portal. You can set a default layout and an error layout. The template should include the macro page.content. This is where the content of the current page will be substituted.
| Key | Explanation | Example |
|---|---|---|
| Default Layout | The layout that should be used by default | ikona.templates.Content |
| Fehler Layout | The layout that should be used when an error occurred |
Flexible Attributes
Store arbitrary key/value pairs. Keep in mind that values will be converted into strings. See the JSMA portal functions get, set, has, increment on how to work with the flexible attributes programmatically.
| Column | Explanation |
|---|---|
| First column | The name of the flexible attribute |
| Second column | The value of the flexible attribute |
| Löschen | Delete the flexible attribute |
Updating a production system
To perform a complete update of a production system using the code from a staging system, you can perform the following steps:
1. Export the data from staging
At the staging-system open the source-control:
Check, whether the "Repo Settings" are correct, for example:
Click on "Export" an wait until the export is done.
2. Activate the maintenance-page
Log in at the production system that should be updated and active the maintenance-page.
See Maintenance Mode - activate; for PFB-Cluster use https://print50.my-ikona.com/_jenhaproxystats and „Set state to MAINT“ for the Ikona and the PFB-Backend. For PFB do the following steps on print52 or print54:
3. Import the data
At the production system, open the source-control again and check, whether the "Repo Settings" are correct.
After that click on "Import" an wait until the import has finished
4. Sphinx re-build
If the import does not notice "Rebuilding sphinx indices for CMS entities" you have to do it manually, see /wiki/spaces/IKONA/pages/305627140
5. Empty Cache
See Empty cache
6. Reset sessions
See /wiki/spaces/IKONA/pages/305627140
7. Reset carts
See /wiki/spaces/IKONA/pages/305627140
8. Deactivate the maintenance-page
See Maintenance Mode - deactivate; for PFB-Cluster use https://print50.my-ikona.com/_jenhaproxystats and „Set state to READY“ for the Ikona and the PFB-Backend.
9. View and test all pages
View all updated pages in order to fill the cache again. Also check, whether all pages are shown correctly.
10. Test the editor
Test the editor using several products.