Modern Portal¶
From Haufe X360 26R1 on, the Legacy Portal is replaced by the Modern Portal. X360 Developer Tool installs a Modern Portal as an additional deployment of an existing instance: a separate copy of the instance’s application files, running in portal mode in its own IIS site and application pool, and connected to the database of the instance.
An instance can have several Modern Portals, for example one per tenant, or one with and one without guest access.
Modern Portal Requirements¶
The instance runs Haufe X360 26R1 (26.101.0100.00) or later. For older versions, the Additional Deployments action shows the reason why it cannot be used.
The instance uses SQL Server. Instances on PostgreSQL cannot register a Modern Portal in the ERP.
The instance has at least one tenant. Each Modern Portal serves exactly one tenant.
Legacy Portal from 26R1 on¶
New installations: The Install Portal option is not available for version 26R1 or later. Install the instance without a portal and add a Modern Portal afterwards.
Updates: When you update an instance that has a Legacy Portal to version 26R1 or later, the update form shows a warning: the Legacy Portal of the instance is removed by the update, and no Modern Portal is created automatically. Confirm with Yes, remove the Legacy Portal to continue, then add a Modern Portal after the update.
Open the Additional Deployments page¶
Go to the Applications screen.
Open the Actions menu of the instance and click Additional Deployments.
The page shows the list of deployments of this instance on the left and the Add deployment form on the right. On the Applications screen, instances with additional deployments show a badge with their number, for example 2 additional deployments. The badge shows a warning if at least one of them has failed.
Add a Modern Portal¶
Fill in the Add deployment form and click Add:
Type: Modern Portal.
Name: 1 to 20 lowercase letters (
a-z) and digits (0-9), starting with a letter, e.g.portalorportal2. The name must be unique within the instance.Tenant: The tenant of the instance that the portal serves.
Allow guest access: Whether users can open the portal without signing in.
The form shows a preview of the address of the portal. The port is assigned when the deployment is created.
The deployment is created in these steps. You can follow them in the Execution log below the list (see View the logs):
Validate the name, the type and the settings, and check that no IIS site or application pool with the same name exists.
Reserve the deployment folder
<instance folder>\AdditionalDeployments\<name>with the subfoldersLogs,Customization,SnapshotandBackup.Copy the
Website\Filesfolder of the instance into<instance folder>\AdditionalDeployments\<name>\Files.Configure the
web.configof the copy: switch it to portal mode with the chosen guest access, and point its customization, snapshot, backup and log paths into the deployment folder. The connection string of the instance is kept.Create an IIS application pool and IIS site named
<instance>_ad_<name>. The site is bound to the host name<name>.<instance>.localhoston the next free port starting from 7777.Create a SQL login for the application pool with access to the database of the instance.
Enable the ERP features the Modern Portal needs for the chosen tenant, if they are not enabled yet: Case Management, Case Management on Portal, Customer Portal and Modern Customer Portal.
Register the portal in the ERP of the instance.
Restart the application pool and check that the ERP recognises the portal.
If a step fails, the task fails with the reason and everything created so far is removed again, so you can simply add the deployment again. Only if this cleanup fails too, the deployment stays in the list as Failed with the reason; remove it before adding it again.
The portal is reached at http://<name>.<instance>.localhost:<port>, for example http://portal.myinstance.localhost:7777.
The address is shown in the list. Host names ending in .localhost are resolved to the local machine by the browser, so no
change of the hosts file is needed.
The deployment list¶
For each deployment the list shows:
Name and Type
Status: Deploying, Ready, Refreshing, Removing or Failed (with the reason)
Address: the link to open the portal
Settings: the tenant and whether guest access is on or off
If the portal is running but the ERP does not recognise it, the list shows a warning. A likely cause is that the Modern Portal feature (ModernPortalModule) is not enabled for the tenant. The deployment itself still counts as created.
Refresh a Modern Portal¶
Click Refresh to bring a deployment up to the current build of its instance. This stops its application pool, deletes its
Files folder, copies the Files folder of the instance again, reconfigures the web.config, starts the pool again and
checks the ERP registration. The record, the logs and the other subfolders of the deployment stay. Use it after you changed the
files of the instance, or if a refresh after an update failed.
Remove a Modern Portal¶
Click Remove and confirm with Remove deployment. This removes the registration of the portal from the ERP, its IIS site and application pool, its SQL login and its folder. The instance itself is not affected.
View the logs¶
Click the log icon of a deployment to see its execution steps in the Execution log panel. Use Clear to empty the panel.
The ERP log file of a running portal is written to <instance folder>\AdditionalDeployments\<name>\Logs.
Additional deployments and other instance operations¶
Update: The application pools of all deployments are stopped before the instance is updated, and every deployment that was Ready is refreshed to the new build afterwards. If a refresh fails, the update itself still succeeds; use Refresh on the Additional Deployments page to try again.
Delete: Deleting an instance also deletes all of its additional deployments.
Manage Tenants: A tenant that is served by a Modern Portal cannot be deleted. Remove the deployment first.
Clone: Additional deployments are not cloned. Add them to the clone again if needed.
Orphaned deployments: If the instance a deployment belonged to no longer exists, its IIS site is shown on the Applications screen as an orphaned additional deployment. It can only be removed. Its files and IIS site are removed; its SQL login stays in SQL Server, because the database of the instance is gone.
Interrupted creation: If XDT was restarted while a deployment was being created, the deployment is shown as Failed. Remove it and add it again.
Troubleshooting¶
“Not recognised by the ERP”: Check in the ERP of the instance that the Modern Customer Portal feature is enabled for the tenant, then click Refresh.
“An IIS site or app pool named … already exists”: Remove the site or pool in IIS Manager, or choose another name.
“The app pool … of this deployment does not exist”: The pool was deleted outside XDT. Remove the deployment and add it again.