Enportal/5.4/admin/accessing enportal - Revision history

imported>Nick.chang: /* Redirect */

2013-12-23T17:01:19Z

Redirect

← Older revision		Revision as of 17:01, 23 December 2013
Line 90:		Line 90:

	# Prompt user to authenticate and then redirect to <tt>/foo</tt>:<br><tt>[http://localhost:8080/enportal/servlet/pd?redirect=/foo /enportal/servlet/pd?redirect=/foo]</tt>		# Prompt user to authenticate and then redirect to <tt>/foo</tt>:<br><tt>[http://localhost:8080/enportal/servlet/pd?redirect=/foo /enportal/servlet/pd?redirect=/foo]</tt>
	# Combine authentication credentials with redirect:<br><tt>[http://localhost:8080/enportal/servlet/pd?login&userid=USERNAME&~~passsword~~=PASSWORD&domainSelect=DOMAIN&redirect=/foo /enportal/servlet/pd?login&userid=USERNAME&~~passsword~~=PASSWORD&domainSelect=DOMAIN&redirect=/foo]</tt>		# Combine authentication credentials with redirect:<br><tt>[http://localhost:8080/enportal/servlet/pd?login&userid=USERNAME&password=PASSWORD&domainSelect=DOMAIN&redirect=/foo /enportal/servlet/pd?login&userid=USERNAME&password=PASSWORD&domainSelect=DOMAIN&redirect=/foo]</tt>

	=== Direct Component Access ===		=== Direct Component Access ===

imported>Nick.chang: /* Login Credentials */

2013-12-23T16:59:31Z

← Older revision		Revision as of 16:59, 23 December 2013
Line 80:		Line 80:
	Examples:		Examples:

	# Authenticate and let the dispatcher redirect to the default home page:<br><tt>[http://localhost:8080/enportal/servlet/pd?login&userid=USERNAME&~~passsword~~=PASSWORD&domainSelect=DOMAIN /enportal/servlet/pd?login&userid=USERNAME&~~passsword~~=PASSWORD&domainSelect=DOMAIN]</tt>		# Authenticate and let the dispatcher redirect to the default home page:<br><tt>[http://localhost:8080/enportal/servlet/pd?login&userid=USERNAME&password=PASSWORD&domainSelect=DOMAIN /enportal/servlet/pd?login&userid=USERNAME&password=PASSWORD&domainSelect=DOMAIN]</tt>
	# Authenticate and go to the enPortal home by implied URL vs dispatcher URL:<br><tt>[http://localhost:8080/enportal/home?login&userid=USERNAME&~~passsword~~=PASSWORD&domainSelect=DOMAIN /enportal/home?login&userid=USERNAME&~~passsword~~=PASSWORD&domainSelect=DOMAIN]</tt>		# Authenticate and go to the enPortal home by implied URL vs dispatcher URL:<br><tt>[http://localhost:8080/enportal/home?login&userid=USERNAME&password=PASSWORD&domainSelect=DOMAIN /enportal/home?login&userid=USERNAME&password=PASSWORD&domainSelect=DOMAIN]</tt>

	=== Redirect ===		=== Redirect ===

imported>Jason.nicholls: 1 revision

2013-12-19T15:17:45Z

1 revision

← Older revision	Revision as of 15:17, 19 December 2013
(No difference)

imported>Mylene.stolpe at 22:51, 13 December 2013

2013-12-13T22:51:28Z

New page

[[Category:enPortal 5.4]]
{{DISPLAYTITLE:Accessing enPortal}}

== Default Access ==

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

{|
!URL
|<nowiki>http://<hostname>:8080/</nowiki>
|-
!User Name
|administrator
|-
!Password
|administrator
|-
!Domain
|System
|}

[[File:appboard-2.4-default-login.png|frame|center|enPortal 5 default login screen]]

== Important URLs ==

The table below summarizes the important URLs for accessing enPortal.

{|class="wikitable" border="1" style="background-color:#eeeeee;"
|-
!Component
!URL
!Description
|-
| Base URL
| [http://localhost:8080/ /]
| Redirects to the dispatcher
|-
| enPortal
| [http://localhost:8080/enportal/home /enportal/home]
| Launches enPortal
|-
| AppBoard Viewer
| [http://localhost:8080/enportal/ab/home?viewer /enportal/ab/home?viewer]
| Explicitly launch the Viewer, useful for administrators.
|-
| AppBoard Builder Safemode
| [http://localhost:8080/enportal/ab/#safeMode=1 /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
| [http://localhost:8080/enportal/servlet/pd /enportal/servlet/pd]
| Displays the login page and/or 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. After logging in the user is redirected to the default home address (see below) unless a redirect is explicitly given.
|}

== 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.

=== Default Home ===

The default home 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:

# edit the <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/custom.properties</tt> file; if it does not exist, create it.
# add the following line: <tt>dispatch.loginredirect=/enportal/home</tt>

{{Tip|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.}}

=== Login Credentials ===

The following URL parameters can be used to bypass authentication:

* '''login''': included but not set to any value
* '''userid''': set to the User Name
* '''password''': set to the user's Password
* '''domainSelect''': set to the Domain

Examples:

# Authenticate and let the dispatcher redirect to the default home page:<br><tt>[http://localhost:8080/enportal/servlet/pd?login&userid=USERNAME&passsword=PASSWORD&domainSelect=DOMAIN /enportal/servlet/pd?login&userid=USERNAME&passsword=PASSWORD&domainSelect=DOMAIN]</tt>
# Authenticate and go to the enPortal home by implied URL vs dispatcher URL:<br><tt>[http://localhost:8080/enportal/home?login&userid=USERNAME&passsword=PASSWORD&domainSelect=DOMAIN /enportal/home?login&userid=USERNAME&passsword=PASSWORD&domainSelect=DOMAIN]</tt>

=== Redirect ===

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

Examples:

# Prompt user to authenticate and then redirect to <tt>/foo</tt>:<br><tt>[http://localhost:8080/enportal/servlet/pd?redirect=/foo /enportal/servlet/pd?redirect=/foo]</tt>
# Combine authentication credentials with redirect:<br><tt>[http://localhost:8080/enportal/servlet/pd?login&userid=USERNAME&passsword=PASSWORD&domainSelect=DOMAIN&redirect=/foo /enportal/servlet/pd?login&userid=USERNAME&passsword=PASSWORD&domainSelect=DOMAIN&redirect=/foo]</tt>

=== Direct Component Access ===

To directly access a component in Virtual Directory, use <tt>/enportal/servlet/pd/vdir/<companent reference></tt>.

Examples:

# To show the about page, <tt>[http://localhost:8080/enportal/servlet/pd/vdir/system/About /enportal/servlet/pd/vdir/system/About]</tt>
# To access the backup page, <tt>[http://localhost:8080/enportal/servlet/pd/vdir/system/util/Backup /enportal/servlet/pd/vdir/system/util/Backup]</tt>