Smartstaff
2,356
edits
Changes
Created page with "=Overview= The =Configuration - Essentials= ==SubSection== ==SubSection== =Configuration - Advanced= ==SubSection== ==SubSection== =Settings Explained= ==General Tab==..."
=Overview=
The
=Configuration - Essentials=
==SubSection==
==SubSection==
=Configuration - Advanced=
==SubSection==
==SubSection==
=Settings Explained=
==General Tab==
The following settings are available on the '''General''' tab:
{| class="wikitable"
|-
!|Setting
!|Description
|-
||'''Language'''
||Each login page must have a single language which you can select from the dropdown.
|-
||'''Is Default Login Page'''
||By default, when a user goes to your system's URL without the Language ID, they will be directed to the '''English US''' language login page. If you want users to go to a different language login page by default, toggle this setting on for the login page with your desired language. Note: only one login page can be set as the default.
|-
||'''Page Layout'''
||Leave this setting on '''Default''' unless you specifically need to customize the HTML to your login page as it will ensure you will always have the latest and greatest looking login page. If you choose '''Custom''' you will get a '''Template''' tab where you can modify the underlying HTML of the login page. Note if you opt to go custom, you may need to manually update your login pages to take advantage of improvements or changes in functionality.
|-
||'''Page Title'''
||This is the title your browser displays on it’s title bar or page tab. This text is used to populate the title tag in the HTML of the login page. Typically your organization's name is entered into this field.
|-
||'''Login Title'''
||Text entered here appears above the area where you authenticate. Typically the word "Login" is entered into this field.
|-
||'''Content Title'''
||Text entered here appears above the custom message on the right area of the screen. Typically this is replaced with something like "Welcome to XYZ".
|-
||'''Content Text'''
||Text entered here appears below the content title. Typically this area is used to describe who you are, what you do and what the system is used for. Example: "XYZ group provides grants to non-profits in the USA. Register to gain access to the system and apply for funding."
|-
||'''Logout Redirect URL'''
||This is the page the user gets redirected to once they logout. Enter a URL such as ''https://www.smartsimple.com/'' or leave it blank to have the user redirected back to your system’s login page by default.
|}
===Privacy Policies===
This section is only visible if you chose a '''Page Layout''' of '''Default'''.
{| class="wikitable"
|-
||'''Section'''
||Choose to show or hide the '''Privacy Policies''' for your system on the login page only.
|-
||'''Section Title'''
||This input only appears if you are using the '''Default''' page layout with privacy policies on. Typically people enter "Learn more about our".
|-
||'''Button Label'''
||This input only appears if you are using the '''Default''' page layout with '''Privacy Policies''' on. Enter the name you want to give the button that will open your systems policies that you define. Typically people enter "Privacy and Security Policies" for the button text.
|}
===Links===
This section is typically used for giving people the ability to self-register and gain access to your system.
{| class="wikitable"
|-
||'''Link Section'''
||The '''None''' option provides no links to a signup page and hides this section. Users cannot self-register and must be created and activated in your system via a different methodology, such as an autoloader, importing or manual creation by internal staff.
The '''Use Routing page''' option is best if you have multiple signup pages often for different types of users and organizations. The routing page will display a list of signup pages so the user can be directed to the signup page that is right for them. Learn more about [[Signup_Page#Creating_a_routing_page|routing pages]]
The '''Custom URL''' option is best if you only have one signup page. If you choose this option you will be able to enter a label for the button such as "Register here" as well as the URL to the desired signup page. For the URL use the relative path to your signup page. This way the register button will work on production and backup and any staging servers you may have. Example:
''/s_signup.jsp?token=XVtQC1oGYFFaRhNaXxJaQVBRZEl8GnA%3D''
|-
||'''Section Title'''
||Text entered here appears above the register buttons. Typically the text entered is "New to the System?".
|}
===Page Formatting===
The following settings are available on the '''General tab''', '''Page Formatting''' section:
{| class="wikitable"
|-
!|Setting
!|Description
|-
||'''Background Image'''
||The image uploaded will appear behind the content of your login page (in the background). Upload an image in JPG or PNG format with a resolution of 1920 x 1080 or higher but try to optimize the image to keep the file size low.
Click the '''Browse''' button which looks like a folder icon to select a file from your computer and click the '''Upload''' button which has an '''upwards arrow '''to upload the image file.
|-
||'''Background Position'''
||Select how the image will render at different resolutions by choosing where to anchor the image vertically and horizontally. For example if you choose '''Top''' and '''Left''' as the position, then the top left area of the background image will always be visible on screen. Anything on the right/bottom of the image may be clipped and not display depending on screen size and aspect ratio of the image and the user's device.
|-
||'''Background Color'''
||Adjust this setting to change the color that will appear over the background image. Enter the desired hexadecimal value here without the # or use the color picker. Example, enter FFFFFF to have a white background. You must enter either 3 or 6 characters if you are manually entering the hexadecimal value.
|-
||'''Background Opacity'''
||Adjust this setting to change the opacity of the background color. For example '''High''' will make the color completely opaque and you will not see the background image. '''Low''' will make the background color completely transparent revealing the background image as uploaded. Something in between '''Low''' and '''High''' will create a translucent layer of color over the background image.
|-
||'''Panel Color'''
||Select the color of the login panel that appears behind the content such as the username and password but in front of the background color and image.
|-
||'''Panel Opacity'''
||Select the level of opacity for the panel that appears behind the login content such as the username and password. '''Low''' will make the panel transparent, '''High''' will make the panel opaque.
|-
||'''Font Color'''
||Select the color used for all text that appears on the panel. Example '''Content Title, Content Text, Section Title, '' etc. Note you must make sure there is enough contrast between the foreground text and the panel or background image. Typically text is black on a white panel or white on a black panel.
|}
==Routing Page Tab==
The following settings are available on the '''Routing Page''' tab:
{| class="wikitable"
|-
!|Setting
!|Description
|-
||'''Page URL'''
||This area displays the direct link to the routing page and gives you a preview button so you can see how the routing page looks without logging out.
|-
||'''Button Label'''
||The text entered here will be used as the label for the button that will open the '''Routing Page'''. This button is displayed on the login page. Typically you will enter the text "Register".
|-
||'''Header Title'''
||The text entered here will appear at the top of the routing page. Typically you will enter something like "Registration Options".
|-
||'''Introduction Text'''
||The text entered here will appear under the title but before the list of signup pages. Typically you will enter something like "I am applying as:".
|-
||'''Trailing Text'''
||The text entered here will appear under the list of signup pages. Typically you will leave this blank however you may want to add contact information here in case the user needs assistance.
|-
||'''Routing Links'''
||This dynamic section enables the administrator to add links to their desired signup pages onto the Routing Page.
To create a new link, click the '''Add''' button which has a '''+''' icon.
|}
Each routing link has the following settings
{| class="wikitable"
|-
!|Setting
!|Description
|-
||'''Title'''
||Text entered here will appear in bold for each link. Typically you would enter a few words like Individual, International Organizations, Domestic Organizations.
|-
||'''Description'''
||Text entered here will appear below the title and is used to clarify what kind of user should click this link. Example "For applicants who are not associated with an organization".
|-
||'''URL'''
||The relative URL to the desired signup page.
|}
==Template Tab==
The following settings are available on the '''Template''' tab:
{| class="wikitable"
|-
!|Setting
!|Description
|-
||'''Sample Template'''
||Clicking this link inserts the HTML, CSS and other code which is used to render the login page. Typically you would only use a custom template if you wanted to add some functionality that is not typically used or you wanted to radically customize the look and structure of the login page.
|-
||'''Login Page Template'''
||You can enter your custom code into this text area or modify the existing content added by clicking the sample template link. Although you can enter your own code here we generally don’t recommend it. If you do add your own code here make sure your code meets accessibility guidelines and make sure it is responsive (works on all devices including mobile).
|}
=Alternate Login Page Settings=
Settings from Alternate login pages which are typically only used in special circumstances
{| class="wikitable"
|-
||'''Login Page Name'''
||Name of the virtual alias login page
|-
||'''Description'''
||Description of the virtual alias login page that is not exposed to end users.
|-
||'''Scope Organization'''
||Lookup that allows the virtual alias login page to be restricted to users in the selected organization.
|-
||'''Virtual Folder Name'''
||Enter a name which will appear in the login URL and be used to differentiate logins.
|-
||'''Web Alias'''
||Enter the desired alias you want instead of using the instance-defined alias.
|-
||'''Persistent Cookies'''
||Enable or disable persistent cookies. Rather than having to log into your system each time you open your web browser, a "cookie" can be installed on your computer that will automatically authenticate you, allowing you to bypass the login screen and having to re-enter your credentials.
|-
||'''Attach User Identifier'''
||
|-
||'''Encrypt URL'''
||Enable or disable the encryption of the URL
|-
||'''Logout Redirect URL'''
||Enter URL for users to be redirected to upon logout. If left blank users go to the login page on logout.
|-
||'''Primary Role'''
||Select from the available system roles to choose the primary default role that a user will have when they log in through this alternate login page. This function is used to force the user to see a specific Role based portal.
|-
||'''Login Type'''
||Select from the desired options: All Users, Activated Users Only, No Access
|-
||'''User Field'''
||This is the field that will be used on the login page to uniquely identify the specific user when they log in. This is typically set to '''Email Address'''.
|-
||'''Password Field'''
||This is the field on the login page that will be used for the password.
|-
||'''Login Error Message'''
||This is the error message that will appear on the login page upon a failed login attempt.
|-
||'''Login Page Content'''
||Click the '''Insert Sample Template''' hyperlink to auto-populate the text window with a sample template for a login page. Otherwise, you can insert in your own customized content. Note that the Alternate login page content works differently than primary login pages so you cannot use the same template for both.
|}
[[Category:Interface]]
The
=Configuration - Essentials=
==SubSection==
==SubSection==
=Configuration - Advanced=
==SubSection==
==SubSection==
=Settings Explained=
==General Tab==
The following settings are available on the '''General''' tab:
{| class="wikitable"
|-
!|Setting
!|Description
|-
||'''Language'''
||Each login page must have a single language which you can select from the dropdown.
|-
||'''Is Default Login Page'''
||By default, when a user goes to your system's URL without the Language ID, they will be directed to the '''English US''' language login page. If you want users to go to a different language login page by default, toggle this setting on for the login page with your desired language. Note: only one login page can be set as the default.
|-
||'''Page Layout'''
||Leave this setting on '''Default''' unless you specifically need to customize the HTML to your login page as it will ensure you will always have the latest and greatest looking login page. If you choose '''Custom''' you will get a '''Template''' tab where you can modify the underlying HTML of the login page. Note if you opt to go custom, you may need to manually update your login pages to take advantage of improvements or changes in functionality.
|-
||'''Page Title'''
||This is the title your browser displays on it’s title bar or page tab. This text is used to populate the title tag in the HTML of the login page. Typically your organization's name is entered into this field.
|-
||'''Login Title'''
||Text entered here appears above the area where you authenticate. Typically the word "Login" is entered into this field.
|-
||'''Content Title'''
||Text entered here appears above the custom message on the right area of the screen. Typically this is replaced with something like "Welcome to XYZ".
|-
||'''Content Text'''
||Text entered here appears below the content title. Typically this area is used to describe who you are, what you do and what the system is used for. Example: "XYZ group provides grants to non-profits in the USA. Register to gain access to the system and apply for funding."
|-
||'''Logout Redirect URL'''
||This is the page the user gets redirected to once they logout. Enter a URL such as ''https://www.smartsimple.com/'' or leave it blank to have the user redirected back to your system’s login page by default.
|}
===Privacy Policies===
This section is only visible if you chose a '''Page Layout''' of '''Default'''.
{| class="wikitable"
|-
||'''Section'''
||Choose to show or hide the '''Privacy Policies''' for your system on the login page only.
|-
||'''Section Title'''
||This input only appears if you are using the '''Default''' page layout with privacy policies on. Typically people enter "Learn more about our".
|-
||'''Button Label'''
||This input only appears if you are using the '''Default''' page layout with '''Privacy Policies''' on. Enter the name you want to give the button that will open your systems policies that you define. Typically people enter "Privacy and Security Policies" for the button text.
|}
===Links===
This section is typically used for giving people the ability to self-register and gain access to your system.
{| class="wikitable"
|-
||'''Link Section'''
||The '''None''' option provides no links to a signup page and hides this section. Users cannot self-register and must be created and activated in your system via a different methodology, such as an autoloader, importing or manual creation by internal staff.
The '''Use Routing page''' option is best if you have multiple signup pages often for different types of users and organizations. The routing page will display a list of signup pages so the user can be directed to the signup page that is right for them. Learn more about [[Signup_Page#Creating_a_routing_page|routing pages]]
The '''Custom URL''' option is best if you only have one signup page. If you choose this option you will be able to enter a label for the button such as "Register here" as well as the URL to the desired signup page. For the URL use the relative path to your signup page. This way the register button will work on production and backup and any staging servers you may have. Example:
''/s_signup.jsp?token=XVtQC1oGYFFaRhNaXxJaQVBRZEl8GnA%3D''
|-
||'''Section Title'''
||Text entered here appears above the register buttons. Typically the text entered is "New to the System?".
|}
===Page Formatting===
The following settings are available on the '''General tab''', '''Page Formatting''' section:
{| class="wikitable"
|-
!|Setting
!|Description
|-
||'''Background Image'''
||The image uploaded will appear behind the content of your login page (in the background). Upload an image in JPG or PNG format with a resolution of 1920 x 1080 or higher but try to optimize the image to keep the file size low.
Click the '''Browse''' button which looks like a folder icon to select a file from your computer and click the '''Upload''' button which has an '''upwards arrow '''to upload the image file.
|-
||'''Background Position'''
||Select how the image will render at different resolutions by choosing where to anchor the image vertically and horizontally. For example if you choose '''Top''' and '''Left''' as the position, then the top left area of the background image will always be visible on screen. Anything on the right/bottom of the image may be clipped and not display depending on screen size and aspect ratio of the image and the user's device.
|-
||'''Background Color'''
||Adjust this setting to change the color that will appear over the background image. Enter the desired hexadecimal value here without the # or use the color picker. Example, enter FFFFFF to have a white background. You must enter either 3 or 6 characters if you are manually entering the hexadecimal value.
|-
||'''Background Opacity'''
||Adjust this setting to change the opacity of the background color. For example '''High''' will make the color completely opaque and you will not see the background image. '''Low''' will make the background color completely transparent revealing the background image as uploaded. Something in between '''Low''' and '''High''' will create a translucent layer of color over the background image.
|-
||'''Panel Color'''
||Select the color of the login panel that appears behind the content such as the username and password but in front of the background color and image.
|-
||'''Panel Opacity'''
||Select the level of opacity for the panel that appears behind the login content such as the username and password. '''Low''' will make the panel transparent, '''High''' will make the panel opaque.
|-
||'''Font Color'''
||Select the color used for all text that appears on the panel. Example '''Content Title, Content Text, Section Title, '' etc. Note you must make sure there is enough contrast between the foreground text and the panel or background image. Typically text is black on a white panel or white on a black panel.
|}
==Routing Page Tab==
The following settings are available on the '''Routing Page''' tab:
{| class="wikitable"
|-
!|Setting
!|Description
|-
||'''Page URL'''
||This area displays the direct link to the routing page and gives you a preview button so you can see how the routing page looks without logging out.
|-
||'''Button Label'''
||The text entered here will be used as the label for the button that will open the '''Routing Page'''. This button is displayed on the login page. Typically you will enter the text "Register".
|-
||'''Header Title'''
||The text entered here will appear at the top of the routing page. Typically you will enter something like "Registration Options".
|-
||'''Introduction Text'''
||The text entered here will appear under the title but before the list of signup pages. Typically you will enter something like "I am applying as:".
|-
||'''Trailing Text'''
||The text entered here will appear under the list of signup pages. Typically you will leave this blank however you may want to add contact information here in case the user needs assistance.
|-
||'''Routing Links'''
||This dynamic section enables the administrator to add links to their desired signup pages onto the Routing Page.
To create a new link, click the '''Add''' button which has a '''+''' icon.
|}
Each routing link has the following settings
{| class="wikitable"
|-
!|Setting
!|Description
|-
||'''Title'''
||Text entered here will appear in bold for each link. Typically you would enter a few words like Individual, International Organizations, Domestic Organizations.
|-
||'''Description'''
||Text entered here will appear below the title and is used to clarify what kind of user should click this link. Example "For applicants who are not associated with an organization".
|-
||'''URL'''
||The relative URL to the desired signup page.
|}
==Template Tab==
The following settings are available on the '''Template''' tab:
{| class="wikitable"
|-
!|Setting
!|Description
|-
||'''Sample Template'''
||Clicking this link inserts the HTML, CSS and other code which is used to render the login page. Typically you would only use a custom template if you wanted to add some functionality that is not typically used or you wanted to radically customize the look and structure of the login page.
|-
||'''Login Page Template'''
||You can enter your custom code into this text area or modify the existing content added by clicking the sample template link. Although you can enter your own code here we generally don’t recommend it. If you do add your own code here make sure your code meets accessibility guidelines and make sure it is responsive (works on all devices including mobile).
|}
=Alternate Login Page Settings=
Settings from Alternate login pages which are typically only used in special circumstances
{| class="wikitable"
|-
||'''Login Page Name'''
||Name of the virtual alias login page
|-
||'''Description'''
||Description of the virtual alias login page that is not exposed to end users.
|-
||'''Scope Organization'''
||Lookup that allows the virtual alias login page to be restricted to users in the selected organization.
|-
||'''Virtual Folder Name'''
||Enter a name which will appear in the login URL and be used to differentiate logins.
|-
||'''Web Alias'''
||Enter the desired alias you want instead of using the instance-defined alias.
|-
||'''Persistent Cookies'''
||Enable or disable persistent cookies. Rather than having to log into your system each time you open your web browser, a "cookie" can be installed on your computer that will automatically authenticate you, allowing you to bypass the login screen and having to re-enter your credentials.
|-
||'''Attach User Identifier'''
||
|-
||'''Encrypt URL'''
||Enable or disable the encryption of the URL
|-
||'''Logout Redirect URL'''
||Enter URL for users to be redirected to upon logout. If left blank users go to the login page on logout.
|-
||'''Primary Role'''
||Select from the available system roles to choose the primary default role that a user will have when they log in through this alternate login page. This function is used to force the user to see a specific Role based portal.
|-
||'''Login Type'''
||Select from the desired options: All Users, Activated Users Only, No Access
|-
||'''User Field'''
||This is the field that will be used on the login page to uniquely identify the specific user when they log in. This is typically set to '''Email Address'''.
|-
||'''Password Field'''
||This is the field on the login page that will be used for the password.
|-
||'''Login Error Message'''
||This is the error message that will appear on the login page upon a failed login attempt.
|-
||'''Login Page Content'''
||Click the '''Insert Sample Template''' hyperlink to auto-populate the text window with a sample template for a login page. Otherwise, you can insert in your own customized content. Note that the Alternate login page content works differently than primary login pages so you cannot use the same template for both.
|}
[[Category:Interface]]
