Appboard/2.4/admin/accessing appboard

Revision as of 05:08, 28 August 2013 by imported>Jason.nicholls


Default Access

After a clean install of AppBoard using the default configuration the following details will bring up the login screen, and after logging in, will then bring up the AppBoard Builder. Please note all login page fields are case sensitive.

URL http://<hostname>:8080/
User Name administrator
Password administrator
Domain System


AppBoard 2.4 default login screen


Important URLs

The table below summarizes the important URLs for accessing AppBoard.

Component URL Description
Home URL / Launches either AppBoard or enPortal, depending on the Home URL configuration (see "Home URL" section below)
AppBoard /enportal/ab/home If the User's default role is portalAdministration, this will launch the AppBoard Builder. Otherwise, this will launch the AppBoard Viewer.
enPortal /enportal/home Launches enPortal
AppBoard Viewer /enportal/ab/home?viewer Explicitly launch the Viewer, useful for administrators.
AppBoard Builder Safemode /enportal/ab/#safeMode=1 Launches the AppBoard builder in safe mode by disabling all stacks. The administrator can then access the configuration panels to delete or edit the broken component.
Dispatcher /enportal/servlet/pd Accepts a number of parameters to allow for login credentials to be passed in and redirection (e.g. login, then redirect to a specific stack, or custom html page, etc...). See the section below for more information on the dispatcher.

Home URL

The Home URL is used to determine what URL to send a User to when a full path is not provided in the URL, or in cases such as when a User switches to a different Role. By default AppBoard is configured to have itself as the home URL, but in some cases where enPortal is the main interface for end-users then enPortal can be configured as the home URL.

To override the default configuration, and have enPortal as the default home:

  1. edit the [INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/appboard.properties file.
  2. find the following line: dispatch.loginredirect=/enportal/ab/home
  3. and change it to use the URL: /enportal/home
Template-tip.png
The default home URL is a global setting that is not configurable by user, role, or domain - however if it's necessary to have a user login directly to enPortal or AppBoard then they can bookmark the AppBoard or enPortal URLs as shown in the table above.

Dispatcher

The dispatcher provides a way to bypass the login screen and pass login credentials via URL parameters. It can also be used to redirect to a different URL once logged in.

Provide Login Credentials

The following URL parameters are required to authenticate:

  • login: included but not set to any value
  • userid: set to the User Name
  • password: set to the users password
  • domainSelect: set to the Domain

Some examples:

  1. Authenticate and let the dispatcher redirect to the default home page:
    /enportal/servlet/pd?login&userid=USERNAME&passsword=PASSWORD&domainSelect=DOMAIN
  2. Authenticate and go to the enPortal home by implied URL vs dispatcher URL:
    /enportal/home?login&userid=USERNAME&passsword=PASSWORD&domainSelect=DOMAIN

Redirect

To redirect to a specific URL after authenticating use the redirect URL parameter.

Some examples:

  1. Prompt user to authenticate and then redirect to /foo:
    /enportal/servlet/pd?redirect=/foo
  2. Combine authentication credentials with redirect:
    /enportal/servlet/pd?login&userid=USERNAME&passsword=PASSWORD&domainSelect=DOMAIN&redirect=/foo