Skip to main content

Set up a self-service portal

A self-service portal gives users one page, at /portal, where they can start a password reset or activate their account without logging in first. You build the portal as an app with a panel, choose which password reset and onboarding profiles appear on it, and select the app in the preferences.

caution

The portal is reachable without logging in. Every profile you show on it is visible to anyone who opens the page.

How the portal worksDirect link to How the portal works

  • The portal is an app of type self-service portal. Its panel shows a tile for each password reset and onboarding profile you expose, and optionally a tile for the default app.
  • The Self-service portal app preference names the app that /portal serves. NIM serves it only while the app is still of type self-service portal: changing the app type takes the portal offline, even if the preference still names the app.
  • Opening a profile tile starts that profile's flow at /passwordreset/<profile> or /onboarding/<profile>, exactly as a direct link to the profile would.
  • The default app tile opens the default app. That app is not anonymous, so visitors are asked to log in first.
  • Profile tiles appear only when your license includes the Password Reset or Onboarding module.

Set the app typeDirect link to Set the app type

Every app has an app type that states what the app is for. It replaces the former onboarding app and password reset app checkboxes; existing apps are converted automatically.

App typeUse it for
standardApps that users open after logging in, such as the dashboard
onboardingThe app used by an onboarding profile
password resetThe app used by a password reset profile
self-service portalThe portal page

Every type other than standard is intended to be accessed anonymously. A password reset or onboarding profile reports a validation error when its app is not of the matching type.

  1. In NIM Studio, open Apps and open the app in the designer.
  2. In the app properties, under Data processing, set app type to the type you need.
  3. Save the app.

Build the portal appDirect link to Build the portal app

  1. Create an app and set its app type to self-service portal.
  2. Add a panel item to the form. On a self-service portal app the panel lists profile tiles instead of apps. In the designer, a Dummy profile tile stands in for them.
  3. Optional: to also offer the regular apps, turn on the panel's default app tile property. The tile uses the name, icon, description and sort order of the app selected in the Default app preference.
  4. Save the app.

On an app that is not standard, a panel never shows the NIM Studio tile or favourite stars: there is no logged-in user to show them for. The panel's studio properties are greyed out.

tip

To preview a composed item as it will look in a portal, set Usage to self-service portal in the composed item editor. The setting only affects the preview and is not saved with the item.

Show a profile on the portalDirect link to Show a profile on the portal

Repeat these steps for each password reset or onboarding profile that should get a tile.

  1. In NIM Studio, open the password reset or onboarding profile.
  2. On the Configuration tab, select Show this profile on the self-service portal.
  3. Choose how the tile looks:
    • Keep Portal tile follows app properties selected to use the display name, description, icon and sort order of the profile's app. The tile keeps following the app when you change it later.
    • Clear it to give the profile a tile of its own. The app's values are copied into Portal tile name, Portal tile sort order, Portal tile description and Portal tile icon as a starting point. An empty tile name falls back to the profile name.
  4. Save the profile.

Tiles are sorted like the dashboard: higher sort order first, then by name. See Customize the App Dashboard.

Publish the portalDirect link to Publish the portal

  1. Open Settings > Preferences.
  2. Set Self-service portal app to your portal app. Only apps of type self-service portal are listed.
  3. Optional: to open the portal when visitors go to the root URL of the NIM service, set Default route to Self-service portal app. With the default, Default app, the root URL opens the login page.
  4. Save the preferences.
  5. Open https://<your NIM service>/portal in a private browser window to check the page as an anonymous visitor.

The Default app preference now lists only standard apps. Opening /app without an app name starts the default app, or NIM Studio when no default app is set.

Expose the portal through nginxDirect link to Expose the portal through nginx

If NIM is published through nginx, regenerate the configuration after setting up the portal. The generated configuration allows the portal by default, like the onboarding and password reset pages. To block it, select Deny self-service portal in the nginx configuration dialog; onboarding and password reset stay reachable. See Expose the self-service portal through NGINX for deployment and verification steps.

TroubleshootingDirect link to Troubleshooting

Choose the card that matches the symptom. After correcting the configuration, open /portal in a private browser window to test it as an anonymous visitor.

Self-service portal not availableDirect link to Self-service portal not available

Problem

Visitors see “Self-service portal not available.”

Likely cause

No app is selected in the Self-service portal app preference, the selected app is no longer of type self-service portal, or the app cannot be read.

Resolution

  1. Open Configuration → Settings → Preferences and select the intended Self-service portal app.
  2. Confirm the app's app type is self-service portal.
  3. Check the NIM Service log for details if the app cannot be read.

A profile does not appearDirect link to A profile does not appear

Problem

A profile does not appear on the portal

Likely cause

Show this profile on the self-service portal is not selected, the license does not include the module, or the profile follows an app that cannot be read.

Resolution

  1. Open the profile's Configuration tab and select Show this profile on the self-service portal.
  2. Confirm your license includes the Password Reset or Onboarding module for this profile.
  3. Check the app referenced by the profile. When it cannot be read, the tile is left out and the reason is logged.
  4. Save the profile and test the portal again.

Default app tile has a warning iconDirect link to Default app tile has a warning icon

Problem

The “[Default app]” tile has a warning icon

Likely cause

The panel's default app tile property is on, but no default app is configured, or the configured app does not exist.

Resolution

  1. Set Default app in Preferences to an existing standard app, or turn off default app tile on the portal panel.
  2. Review the tile text: it is visible to anonymous visitors.
  3. Confirm opening the default app tile prompts visitors to sign in.
Last updated on