Appboard/2.4/admin/accessing appboard: Difference between revisions
imported>Jason.nicholls No edit summary |
imported>Jason.nicholls (→Stacks) |
||
| (38 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:Accessing AppBoard}} | {{DISPLAYTITLE:Accessing AppBoard}} | ||
[[Category:AppBoard 2.4]] | |||
== Default Access == | == Default Access == | ||
| Line 57: | Line 58: | ||
| 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. | | 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 === | === Default Home === | ||
| Line 64: | Line 69: | ||
To override the default configuration, and have enPortal as the default home: | To override the default configuration, and have enPortal as the default home: | ||
# edit the <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/ | # 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.}} | {{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 | The following URL parameters can be used to bypass authentication: | ||
* '''login''': included but not set to any value | * '''login''': included but not set to any value | ||
| Line 85: | Line 85: | ||
Examples: | Examples: | ||
# Authenticate and let the dispatcher redirect to the default home page:<br>[http://localhost:8080/enportal/servlet/pd?login&userid=USERNAME& | # 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>[http://localhost:8080/enportal/home?login&userid=USERNAME& | # 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 === | |||
To redirect to a specific URL after authenticating use the '''redirect''' URL parameter. | To redirect to a specific URL after authenticating use the '''redirect''' URL parameter. | ||
| Line 94: | Line 94: | ||
Examples: | Examples: | ||
# Prompt user to authenticate and then redirect to <tt>/foo</tt>:<br>[http://localhost:8080/enportal/servlet/pd?redirect=/foo /enportal/servlet/pd?redirect=/foo] | # 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>[http://localhost:8080/enportal/servlet/pd?login&userid=USERNAME& | # 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> | ||
=== | === Stacks === | ||
By default the stack order and set of stacks is controlled by provisioning stacks to roles. However, it's also possible further restrict the list of visible stacks and select a specific stack by using the following URL parameters. Please note this does not grant permissions, the user/role must already have permission to view the stacks. | By default the stack order and set of stacks is controlled by provisioning stacks to roles. However, it's also possible further restrict the list of visible stacks and select a specific stack by using the following URL parameters. Please note this does not grant permissions, the user/role must already have permission to view the stacks. | ||
| Line 105: | Line 105: | ||
[[File:appboard-2.4-diagnostics-stack-id.png|frame|right|Builder diagnostics tool showing Stack IDs]] | [[File:appboard-2.4-diagnostics-stack-id.png|frame|right|Builder diagnostics tool showing Stack IDs]] | ||
* '''selectedStackId''': ID of the selected (visible) stack, if used on | * '''selectedStackId''': ID of the selected (visible) stack, if used on its own the user will also see all other stacks currently provisioned to their role. | ||
* '''onlyStackIds''': comma separated list of stack IDs. Only these stacks will appear to the user regardless what is configured for the role and assuming they have permission to view them. | * '''onlyStackIds''': comma separated list of stack IDs. Only these stacks will appear to the user regardless what is configured for the role and assuming they have permission to view them. | ||
* '''stacksControl''': Options are <tt>Tab</tt> (default) and <tt>Button</tt>. Button provides an alternative display mode for the ''Viewer'' only where tabs are shown as buttons and ''without'' the AppBoard banner. Also if used in conjunction with onlyStackIds and only a single stack is specified then no banner and no buttons are shown. | |||
Determining the stack ID can be done from the Builder interface using the Diagnostics | Determining the stack ID can be done from the Builder interface using the Diagnostics tool available in the header next to the help menu. Select the Data button and navigate to <tt>appboard.config.Stack</tt>. Expand out each item to see the stack title and record the IDs for the stack(s) you're interested in. | ||
Examples (these will work with the AppBoard 2.4 Welcome archive): | Examples (these will work with the AppBoard 2.4 Welcome archive): | ||
# display a specified stack:<tt> | # display a specified stack:<br><tt>[http://localhost:8080/enportal/ab/home?selectedStackId=07BCE32E-D977-EACF-EAFB-33E579C5F63A /enportal/ab/home?selectedStackId=07BCE32E-D977-EACF-EAFB-33E579C5F63A]</tt> | ||
[http://localhost:8080/enportal/ab/home?selectedStackId=07BCE32E-D977-EACF-EAFB-33E579C5F63A /enportal/ab/home?selectedStackId=07BCE32E-D977-EACF-EAFB-33E579C5F63A] | # display '''only''' the specified stack:<br><tt>[http://localhost:8080/enportal/ab/home?onlyStackIds=07BCE32E-D977-EACF-EAFB-33E579C5F63A /enportal/ab/home?onlyStackIds=07BCE32E-D977-EACF-EAFB-33E579C5F63A]</tt> | ||
# display '''only''' the specified stack:<br>[http://localhost:8080/enportal/ab/home?onlyStackIds=07BCE32E-D977-EACF-EAFB-33E579C5F63A /enportal/ab/home?onlyStackIds=07BCE32E-D977-EACF-EAFB-33E579C5F63A] | # display a specified stack and restricted set of available stacks:<br><tt>[http://localhost:8080/enportal/ab/home?onlyStackIds=07BCE32E-D977-EACF-EAFB-33E579C5F63A,4E72001C-2F0D-248C-61EE-33E3679D7400&selectedStackId=4E72001C-2F0D-248C-61EE-33E3679D7400 /enportal/ab/home?onlyStackIds=07BCE32E-D977-EACF-EAFB-33E579C5F63A,4E72001C-2F0D-248C-61EE-33E3679D7400&selectedStackId=4E72001C-2F0D-248C-61EE-33E3679D7400]</tt> | ||
# display a specified stack and restricted set of available stacks:<br> | |||
[http://localhost:8080/enportal/ab/home?onlyStackIds=07BCE32E-D977-EACF-EAFB-33E579C5F63A,4E72001C-2F0D-248C-61EE-33E3679D7400&selectedStackId=4E72001C-2F0D-248C-61EE-33E3679D7400 /enportal/ab/home?onlyStackIds=07BCE32E-D977-EACF-EAFB-33E579C5F63A,4E72001C-2F0D-248C-61EE-33E3679D7400&selectedStackId=4E72001C-2F0D-248C-61EE-33E3679D7400] | === Kiosk Mode === | ||
Kiosk mode is useful for unattended displays to cycle through a set of stacks automatically. In addition kiosk mode can be combined with other dispatcher options such as the Stacks options to further restrict the set of stacks or change from the default display mode to Button mode. Supported options are: | |||
* '''kioskMode''': The presence of this option will enable kiosk mode. | |||
* '''kioskDelay''': This is the cycle delay in seconds. By default if this option is not specified the delay is 30 seconds. | |||
* '''clientRefresh''': Set the number of hours before the flash client is refreshed (reloaded). Fractional hours are allowed such as "1.5" to mean 1 hour and 30 minutes. | |||
Examples: | |||
# enable Kiosk mode with a 10 second cycle delay:<br><tt>[http://localhost:8080/enportal/ab/home?kioskMode&kioskDelay=10 /enportal/ab/home?kioskMode&kioskDelay=10]</tt> | |||
# enable Kiosk mode in Button display mode:<br><tt>[http://localhost:8080/enportal/ab/home?kioskMode&stacksControl=Button /enportal/ab/home?kioskMode&stacksControl=Button]</tt> | |||
# enable Kiosk mode and have the client refresh itself every 12 hours:<br><tt>[http://localhost:8080/enportal/ab/home?kioskMode&clientRefresh=12 /enportal/ab/home?kioskMode&clientRefresh=12]</tt> | |||
# combine authentication and redirect into Kiosk mode in Button display mode:<br><tt>[http://localhost:8080/enportal/servlet/pd?login&userid=USERNAME&password=PASSWORD&domainSelect=DOMAIN&redirect=/enportal/ab/home%3FkioskMode%26stacksControl%3DButton /enportal/servlet/pd?login&userid=USERNAME&password=PASSWORD&domainSelect=DOMAIN&redirect=/enportal/ab/home%3FkioskMode%26stacksControl%3DButton]</tt> | |||
{{Note|Kiosk Mode was introduced in AppBoard 2.4.2. If using an earlier 2.4 release then please upgrade to the latest release to access this functionality. For AppBoard 2.3 or earlier refer to the 2.3 documentation.}} | |||
=== Session Variables === | |||
Additional session variables can be passed in via URL parameter to AppBoard and utilized using SHIM expressions. Only defined variables that are '''not''' marked ''Server Use Only'' will be passed through. Refer to the [[appboard/2.4/builder/system_administration/session_variables|Session Variables]] documentation for more information on creating and using these. | |||
* '''_es_.''VariableName''''': the special identifier <tt>_es_.</tt> must be prefixed to the variable name. Set this to the desired value. | |||
Examples: | |||
# Set the variable '''TESTVAR''' to <tt>myValue</tt>, accessed via <tt>${shim:session.var.get('TESTVAR')}</tt>: <br><tt>[http://localhost:8080/enportal/servlet/pd?_es_.TESTVAR=myValue /enportal/servlet/pd?_es_.TESTVAR=myValue ]</tt> | |||
Latest revision as of 10:08, 15 September 2014
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 |
|---|---|---|
| Base URL | / | Redirects to the dispatcher |
| 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 | 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 [INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/custom.properties file; if it does not exist, create it.
- add the following line: dispatch.loginredirect=/enportal/home
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 users password
- domainSelect: set to the Domain
Examples:
- Authenticate and let the dispatcher redirect to the default home page:
/enportal/servlet/pd?login&userid=USERNAME&password=PASSWORD&domainSelect=DOMAIN - Authenticate and go to the enPortal home by implied URL vs dispatcher URL:
/enportal/home?login&userid=USERNAME&password=PASSWORD&domainSelect=DOMAIN
Redirect
To redirect to a specific URL after authenticating use the redirect URL parameter.
Examples:
- Prompt user to authenticate and then redirect to /foo:
/enportal/servlet/pd?redirect=/foo - Combine authentication credentials with redirect:
/enportal/servlet/pd?login&userid=USERNAME&password=PASSWORD&domainSelect=DOMAIN&redirect=/foo
Stacks
By default the stack order and set of stacks is controlled by provisioning stacks to roles. However, it's also possible further restrict the list of visible stacks and select a specific stack by using the following URL parameters. Please note this does not grant permissions, the user/role must already have permission to view the stacks.
A typical use case here is to combine passing in authentication credentials with a specific stack selected for use on an unattended wall display.
Builder diagnostics tool showing Stack IDs
- selectedStackId: ID of the selected (visible) stack, if used on its own the user will also see all other stacks currently provisioned to their role.
- onlyStackIds: comma separated list of stack IDs. Only these stacks will appear to the user regardless what is configured for the role and assuming they have permission to view them.
- stacksControl: Options are Tab (default) and Button. Button provides an alternative display mode for the Viewer only where tabs are shown as buttons and without the AppBoard banner. Also if used in conjunction with onlyStackIds and only a single stack is specified then no banner and no buttons are shown.
Determining the stack ID can be done from the Builder interface using the Diagnostics tool available in the header next to the help menu. Select the Data button and navigate to appboard.config.Stack. Expand out each item to see the stack title and record the IDs for the stack(s) you're interested in.
Examples (these will work with the AppBoard 2.4 Welcome archive):
- display a specified stack:
/enportal/ab/home?selectedStackId=07BCE32E-D977-EACF-EAFB-33E579C5F63A - display only the specified stack:
/enportal/ab/home?onlyStackIds=07BCE32E-D977-EACF-EAFB-33E579C5F63A - display a specified stack and restricted set of available stacks:
/enportal/ab/home?onlyStackIds=07BCE32E-D977-EACF-EAFB-33E579C5F63A,4E72001C-2F0D-248C-61EE-33E3679D7400&selectedStackId=4E72001C-2F0D-248C-61EE-33E3679D7400
Kiosk Mode
Kiosk mode is useful for unattended displays to cycle through a set of stacks automatically. In addition kiosk mode can be combined with other dispatcher options such as the Stacks options to further restrict the set of stacks or change from the default display mode to Button mode. Supported options are:
- kioskMode: The presence of this option will enable kiosk mode.
- kioskDelay: This is the cycle delay in seconds. By default if this option is not specified the delay is 30 seconds.
- clientRefresh: Set the number of hours before the flash client is refreshed (reloaded). Fractional hours are allowed such as "1.5" to mean 1 hour and 30 minutes.
Examples:
- enable Kiosk mode with a 10 second cycle delay:
/enportal/ab/home?kioskMode&kioskDelay=10 - enable Kiosk mode in Button display mode:
/enportal/ab/home?kioskMode&stacksControl=Button - enable Kiosk mode and have the client refresh itself every 12 hours:
/enportal/ab/home?kioskMode&clientRefresh=12 - combine authentication and redirect into Kiosk mode in Button display mode:
/enportal/servlet/pd?login&userid=USERNAME&password=PASSWORD&domainSelect=DOMAIN&redirect=/enportal/ab/home%3FkioskMode%26stacksControl%3DButton
Session Variables
Additional session variables can be passed in via URL parameter to AppBoard and utilized using SHIM expressions. Only defined variables that are not marked Server Use Only will be passed through. Refer to the Session Variables documentation for more information on creating and using these.
- _es_.VariableName: the special identifier _es_. must be prefixed to the variable name. Set this to the desired value.
Examples:
- Set the variable TESTVAR to myValue, accessed via ${shim:session.var.get('TESTVAR')}:
/enportal/servlet/pd?_es_.TESTVAR=myValue
