Smartstaff
2,014
edits
Changes
m
Learn more about routing pages on [[Login_Page|Login Page]]
→How to modify the Duplicate check settings
=Overview=
A Signup signup page (also known as a registration page) enables users and organizations to independently register and gain access to your system. It is common to have multiple signup pages depending on the types of people and organizations you want to register. In this article you will learn about the different types of signup pages, how to configure them and related functionality. '''Global Administrator ''' access is required to create and modify signup pages.
=Configuration - Essentials=
==Creating a signup page==
===The Associated Organization===
Before you create a signup page, you will need to decide where the users and organizations you are creating will reside in your organization hierarchy. In other words, when you create a new user or organization via a signup page, where will they be created in your system? Typically, you would create an organization in the external organization hierarchy and call it something like Web Registrants. Later you would associate that organization with your signup page. Then all new users and organizations created by this specific signup page will be created under that organization.
You can setup set up an organization by going to '''Menu''' icon > '''Organization Hierarchy''' > click on the second tab which is the external hierarchy, and click the '''New''' button to create a new organization in the external organization hierarchy.
===Roles and Categories===
: ''Main Articles: [[User Role]] & [[Client Categories]]''Once you have an organization setup set up that you will associate with a signup page, next you will need to setup set up '''Roles''' (for users) and '''Categories''' (for organizations). '''[[User Role|Roles]]''' are a way of grouping like users together. We use roles to control what the user can see and do in the system. When you create a user via a signup page, you need to give them one or more roles. Typically, you would give a user a role like "applicant" or "reviewer".
Before you create your signup page, make sure you have created the roles you intend to give to the new users.
You can setup user roles by going to '''Menu''' icon > '''Global Settings''' > '''Users''' tab > '''Roles''' and click the '''New''' button.
'''[[Client Categories|Categories]]''' are a way of grouping like organizations together and are also used to control what can be seen and done. When you create an organization via a signup page, you need to give them one or more categories. Typically, you would give an organization the category of "Grant Seeking Organization" or "External Reviewers".
Before you create your signup page, make sure you have created the desired categories for your organization.
===Statuses===
: ''Main Article: [[Status]]''Lastly, you may want to setup set up a [[Status|status ]] for users and organizations. Statuses are like a place in time; for . For example, you might use a “Newly Registered” status for new registrants, and later once they have been vetted, you might switch them to an “Active” Status and later when you no longer engage with the user you might move them to an “Inactive” status.
Before you create your signup, pages create desired statuses.
# Click the '''New Signup Page''' button in the action bar. It looks like a plus sign.
# Choose an '''Associated Organization''' via the lookup. New users will be created under the associated organization. Generally, you want to select an external organization.
# Enter a '''Description'''. This is not seen by your applicants but it is important as it is the only way you can tell user signup pages apart when you are picking one a user signup page from the organization signup configuration page.
# If you want the user to be able to login, change the '''Access Type''' to '''User Access'''.
# Add desired roles
# Modify the '''Signup Page Content''' and '''Confirmation Page Content''' as desired. Typically in the instructions you might want to add a phone number or email of who to contact if the user is having trouble registering. On the confirmation page content you might want to add something like '"''check your email and spam folder in your email for instructions on how to gain access to the system'''."
# Drag and drop the fields from the '''Available Fields''' list into the '''Selected Fields''' list. Once fields are in the '''Selected Fields''' list you drag and drop fields to reorder them or hover over a field and click the grey '''x''' button to remove the field from the list.
# Click '''Save'''.
# Choose an '''Associated Organization''' via the lookup. New users will be created under this organization. Generally, you want to select an external organization.
# Choose the organization '''Categories''' you want to add.
# Change the content on the signup page and confirmation page with a custom message. Typically, you will want to add something like who the user should contact should if they need assistance.
# Drag and drop the fields from the '''Available Fields''' list into the '''Selected Fields''' list.
# Click '''Save'''.
# Edit the organization signup page, and for the setting called '''User Signup''' pick either '''Single User''' or '''Multiple Users'''.
# If you picked '''Single User''' you will see a '''User Signup Page''' setting. Click the drop down and select the desired user signup page.
# Optionally toggle ''(Optional)'' Toggle on '''Enable Same Address Button''' which will allow if you want the user user’s address to populate their address using be pre-populated with the address of the company so the user does not need to enter their address twice.# Click '''saveSave'''.
Note: when you choose a user signup page, it will show up inside the organization signup page in its own section that appears under the organization details section. Also note, that when a user signup page is attached, the ''user '' signup confirmation page is used. Therefore, so you will need to navigate to the user signup page if you want to make changes to the confirmation page that will be displayed appears to the user upon submission, you will need to navigate the user signup page instead.
[[File:Signup-org-multi-user.png|thumb|none|800px|A signup page that creates a single organization and multiple users at the same time. In this example the Lead Applicant is set to a minimum of 1 so they are required. The co-applicant is set to a minimum of 0 and maximum of 3 so none or up to 3 co-applicants can register at the same time.]]
If for the setting you chose '''User SignupMultiple Users''', you chose for the '''Multiple UsersUser Signup''' setting, you will be able to create an organization and with more than one user and signup as well as more than one set of users.
In this scenario you will see a setting called '''Multiple User Signup'''.
You can specify a minimum and maximum number of users you want to create per attached signup page as well as specify section and user titles.
Note: depending on your jurisdiction , be mindful that if you enable multiple users, you are asking someone to enter personally identifying information, into the your system on someone else’s behalf.
==How to make Making changes to fields on your signup page==Let’s say you want to make the '''emailEmail''' field on your user signup page mandatory. Navigate to the '''User''' standard field for email: '''Menu''' Icon > '''Global Settings''' > '''Users''' Tab > '''Standard Fields''' link and edit the '''Email''' standard field by toggling on the '''Mandatory''' setting. Now when you go back to the signup page and preview it, you will see the email field is now set to mandatory and the relevant validation was automatically added.
Any changes you make to any fields that are included on a signup page will be updated right away on your signup pages. You can also go back to the signup page at anytime any time to change the order of fields and add or remove fields by modifying the selected fields. To remove a field, hover over the desired field and click the button marked with an '''x''' to modify the order drag and drop fields.
==How to modify Modifying the New User Email Template==If you are giving new users the ability to login in via the '''Access Type''' setting, which gets set to '''User Access''', then the user will receive an email based off a '''New user User Email Template''' either the one on the signup page or the global template.
By default, all new users will receive the email template found in '''Menu''' Icon > '''Global Settings''' > '''Security''' Tab > '''Password and Activation Policies''' > '''Activation Emails''' in the left navigation.Once you add the sample template you can modify it as needed. The sample template will send the new registrant a link where they can enter their desired password to complete user activation. The variable for this is '''https://@url@@activationlink@'''. It is also possible to email users their username and password by using '''@email@''' and '''@password@''' if desiredby using the basic syntax references of the [[Variable Processor|variable processor]].
If you want a custom new user email sent to all users who register through this specific signup page only, instead of using the global one, then go to the '''Templates''' tab and add the sample template and fill in the other fields. The '''New User Email Template''' on the signup page takes precedence over the '''New User''' general template found under '''Global Settings'''. Typically we recommend that you leave the '''Template''' tab '''New User Email Template''' empty so the global template will be used.
==How to setup Setting Up Privacy Policies==A privacy policy details your company’s views and procedures related to the collection of information on people who use your system. Its It's important to let your users know how you are going to use the information you are requesting, and to tell users who to contact should they have questions. In some jurisdictions such as California, you are required to post your privacy policy by law. In the EU, the [[General Data Protection Regulation (GDPR)]] and the e-privacy directive oblige you to put a privacy notice containing specific elements on your system; failure . Failure to do so can result in fines.
[[File:Signup-privacy.png|thumb|none|800px|If you attach a privacy policy to a signup page. Anyone attempting to register will have to accept the policy before they can gain access to the system. ]]
You can create a '''privacy policy''' for your system by going to the '''Menu''' Icon > '''Global Settings''' > '''Security''' Tab > '''Privacy and Security Policies''' link. We suggest you start by creating a policy for the '''Default Country''' and '''Languages ''' of your choice. The default country is displayed until the user has logged in, at which point the system shows you the policy for the country you have chosen as your primary residence. We also suggest you '''Enforce User Acceptance''' by picking a date on your privacy policy. Once you have a privacy policy created, go to the desired user signup page and select the desired policy from the '''Attach Policies''' drop downdropdown. Then, '''Save''' your signup page. Now, when anyone is sent to your signup page, they will first be required to read and accept your privacy policy before they can register and gain access to your system.
==How to modify Modifying the Duplicate check Check settings==Choose a uniquely identifiable field, such as the user’s email. If a user tries to enter an email that is already in the system, it will be flagged as a possible duplicate and prevent the user from registering againtwice with the same email. Optionally, you can conduct a duplicate check on multiple fields. It is important to note that when you check on multiple fields , it is currently an using the [[Boolean Operators|Boolean operator]] '''andAND''', not an instead of the '''orOR'''operator. For example: if you chose '''email''' and '''first name''', it will only flag users that have the same '''email''''' and '' '''first name''' as another an existing user in the system(as opposed to flagged an existing user that may have the same email ''or'' first name). Support for '''andOR''' is planned for the November 2020 upgrade.
By default, '''Email''' is typically used as a unique identifier of users in the system and '''Name''' is used for organizations.
==Creating a routing page==
: ''Main Article: [[Login_Page|Login Page]]''
Routing pages are created to direct the user to the appropriate signup page in the desired language. Typically, the user clicks a button on the login page that takes them to an intermediary page where they can see the list of available signup pages. You can create a routing page by going to '''Menu''' Icon > '''Global Settings''' > '''Branding''' tab > '''Login Pages''' link > edit the desired login page > '''Routing Page''' tab.
[[File:Singup-routing.png|thumb|none|800px|The routing page takes users to the signup page that is right for them.]]
If you paste the '''Page URL''' of your signup page into a routing page, make sure you use the relative path example: '''<pre>/s_csignup.jsp?token=XVtQHUUGYVpQRhRRXxNRS1BWZEl2HnFsFA%3D%3D&ptoken=XVtQC1oGYVpQRhRRXxNRS1BWZEl2HnFsFQ%3D%3D'''. </pre>
Relative paths will resolve correctly and work on production as well as development and backup systems.
Also make sure you include the desired language ID example '''&tid=14''' will display the Spanish translations.
==Creating an organization lookup style signup page==
The following settings are available on the '''General''' tab:
===General Settings===
{| class="wikitable"
|-
!|Setting
!|Description
|-
||Associated Organization
||Determines where the users and organizations created will reside in your organization hierarchy. Typically, you would create an organization in the external organization hierarchy and call it something like “Web Registrants”.
|-
||Description
||This input is not seen by your applicants but it is important as it is the only way you can tell user signup pages apart when you are picking a user signup page from the organization signup configuration page. You may also wish to add special instructions or notes for other administrators in this field.
|}
===Activation & Security===
{| class="wikitable"
|-
!|Setting
!|Description
|-
||Activate Page
||The signup page will only be accessible if this setting is toggled on. If this setting is toggled off and a user navigates to this signup page they will receive an error message asking the user to contact your system administrator.
|-
||Enable Field Security Token
||This setting enhances security of signup pages by validating the fields that are submitted with expected values. Typically, this should be toggled on.
|-
||Standard
||Provides a link to this signup page which you can give to people who want to register in your system. Click the '''View''' button to see the signup page, or click the '''Copy''' button to copy the URL to this signup page.
|-
||Email Broadcast
||This is an alternate URL intended for updating existing users in conjunction with the email broadcast tool. This link is typically, not used.
|}
===Signup Options===
{| class="wikitable"
|-
!|Setting
!|Description
|-
||Duplicate Check Field
||Select one or more fields to be used by the duplicate check. Typically, '''Email''' is used for users and '''Name''' is used for organizations. If you choose to check on more than one field the operation used is '''AND'''. For example: if you chose email and first name, it will only flag users that have the same email and first name. Support for '''OR''' is planned for the November 2020 upgrade.
|-
||Update Behaviour
||This setting is only found on the User Signup page. Typically, you will choose '''Only create new users'''. The three available settings are:
* '''Create new or update matching user''' - is not recommended as it allow the direct update of users when existing duplicate matches are found, or create new users when no match is found.
* '''Only create new user''' – Is recommended and Only creates a user as new when no existing duplicate match is found. No updates are made to contacts when existing duplicate users are found.
* '''Always create new user''' – is not recommended and will always create a user as new, regardless of whether any existing duplicate match is found.
|-
||Duplicate Restriction Message
||Enter a custom message you want displayed when the duplication check fails. By default, it will say “A user/organization matching the information you entered already exists. Please contact your system administrator.”
|-
||Access Type
||Only available on the User signup page. Set to '''User Access''' if you want the user to be able to login. This setting only applies to new users. New users will be given the access type selected. The '''Access Type''' for existing users will not change.
|-
||User Signup
||Only available on the organization signup page. Choose between '''Single User''' which will create 1 user along with the organization or '''Multiple Users''' which can create multiple sets of users along with the organization.
|-
||User/Multiple User Signup Page
||Select the user signup page(s) you want to attach to the Organization signup page. The User signup page, will show up inside the organization signup page in its own section that appears under the organization details section.
|-
||Submission Behavior
||Only available on the organization signup page. Typically, only '''Create new organization, block submission if matching organization found''' is recommended. The options are:
* '''Create new organization, update if matching organization found''' - This setting is not recommended. Allows the direct update of organizations when existing duplicate matches are found, or create new organization when no match is found.
* '''Create new organization, block submission if matching organization found''' - This is the default setting. It only allows the creation of organizations as new when no existing duplicate match is found. No updates are made to either organizations or contacts when existing duplicate organizations are found.
* '''Create new organization regardless of matching organization found''' - This setting will always create an organization as new, regardless of whether any existing duplicate match is found.
* '''Create new organization, if matching organization exists, only update users''' – This setting allows you to create a new organization or create a new contact under an existing organization. No updates are made to either organizations or contacts when existing duplicate organizations are found.
* '''Create new organization, if matching organization exists, show entries to select, with option to create new''' - This setting allows you to create a new organization or create a new contact under an existing organization. When duplicate organizations are found, allow for the selection of a duplicate organization, and also allow an option to force create a new organization.
|-
||SmartCheck Validation
||Select the SmartCheck validation you want to run upon form submission. Note if you are on an Organization Signup Page with a User Signup Page attached, the SmartCheck validation from the User Signup Page will be automatically included.
|-
||Attach Workflow
||Select the desired workflow you would like to run upon the registration of a new user or organization. Typically, workflows on signup pages notify someone that a new user has registered and or some action needs to be taken or the workflow will run some tasks automatically.
|-
||Attach Policies
||Only found on the User Signup page. Select the policy you want users to be forced to accept before they can register. Typically, you would select a privacy policy that details your company’s views and procedures related to the collection of information on people who use your system. This way a new user can see and accept your policies before they enter any personally identifiable information (PII) into your system.
|-
||Default Country
||This setting is used to specify a default country on the signup page. For example, if all applicants registering via this signup page live in the United States, you might choose that option as the default country.
When the form opens, if the value chosen is United States then that value will automatically be pre-selected in the Country field for the user. The user can still change the Country field value if they wish, but if the user does not, this feature saves the user some time.
|-
||Default State
||This setting is used to specify a default State on the signup page. For example, if all applicants registering via this signup page live in New York State, you might choose that option as the default State.
When the form opens, if the value chosen is New York then that value will automatically be pre-selected in the State field for the user. The user can still change the State field value if they wish, but if the user does not, this feature saves the user some time.
|-
||Default Status
||Select the status you want to give the User/Organization upon registering. Statuses are like a place in time; for example, you might use a "Newly Registered" status for new registrants, and later once they have been vetted, you might switch them to an "Active" Status.
|-
||Categories
||Only found on Organization signup pages. Categories are a way of grouping like organizations together and are used to control what can be seen and done. You can '''Add''', '''Remove''' or '''Update''' categories for Organizations using this setting.
|-
||Roles
||Only found on User signup pages. Roles are a way of grouping like users together. We use roles to control what the user can see and do in the system. You can '''Add''' or '''Remove''' roles for Users using this setting.
|-
||Page Layout
||This setting controls the layout of the page. '''Default''' is recommended as you will always get the latest and greatest signup page template. If you select Custom you will be able to add the sample template and customize the HTML of the signup page. However, if you select custom, your template will not get updated with future upgrades and as such you may be need to manually update your custom template after future upgrades.
|}
===Signup Page Content===
{| class="wikitable"
|-
!|Setting
!|Description
|-
||Page Title
||If you want to add some text such as “registration” into the header beside your logo you can add it here. Typically, this input is left blank.
|-
||Company Section Title
||Only available on the organization signup page. This text will appear above the fields where you enter organization data. Typically, people enter “Organization Information”.
|-
||Contact Section Title
||Only available on the user signup page. This text will appear above the fields where you enter user data. Typically, people enter “User Information”.
|-
||Instructions Title
||Text entered here will appear inside the instruction box in blue and above your instructions. Typically, people enter “Registration”.
|-
||Instructions Content
||Add any custom instructions to help user complete the signup page. Typically, people enter “Fields marked with a red asterisk (*) are required. If you need assistance contact Fake@fake.fake.”.
|-
||Enable Same Address button
||Toggle on to get a button that will populate the user address fields with the values entered into the Organization address fields. This feature will save users time if they use their organizations address for their user address.
|-
||Same Address Button label
||Define the caption you would like to see on the same address button. Typically, people enter “Copy Address”.
|}
===Confirmation Page Content===
These settings can only be found on user signup pages.
{| class="wikitable"
|-
!|Setting
!|Description
|-
||Confirmation Page Title
||Large text displayed after the user has submits the form. Typically, people enter “Registration Complete”.
|-
||Confirmation Page Content
||Smaller text displayed after the user submits the form. Appears under the title. Typically, people enter “Thank you for registering. Activation instructions have been emailed to you.”.
|-
||Link text
||Text used for a link to the login page so people can log in after registering. Typically, people enter either “log in here” or “Visit youralias.smartsimple.com”.
|-
||Link URL
||Link to login page. typically, people enter “/s_Login.jsp”.
|}
===Input Form===
{| class="wikitable"
|-
!|Setting
!|Description
|-
||Available Fields
||The list of fields you can pick from. Drag and drop these fields into the '''Selected Fields''' area.
|-
||Selected Fields
||Any fields in this area will be displayed on the signup page. Reorder fields within this area using drag and drop. To remove fields, hover over the desired field and click the “x” button.
|}
===Verification Settings===
These settings can only be found on Organization signup pages.
{| class="wikitable"
|-
!|Setting
!|Description
|-
||Verification Service
||Select the type of internal or external verification service you would like to use. Example internally you might want to search your systems organization hierarchy for a specific organization and add a new user under that organization. Externally you might want to search Internal Revenue Service data to ensure new charitable organizations that register have 501(c)(3) status and then populate that organizations information from the IRS database.
|-
||Lookup Category
||Only available if Internal “Organization Lookup” is selected. Select the Categories of organizations you want to appear when a user searches for an organization to add themselves to. Typically, only charitable or research organization categories would be chosen.
|-
||Lookup Status
||Only available if Internal “Organization Lookup” is selected. Select the Status of organizations you want to appear when a user searches for an organization to add themselves to. Typically, only organizations in an approved, or active status would be chosen.
|-
||Limit Searchable Fields to ID Only
||if you toggle this setting on, users will only be able to search on the ID of the organization, not the name, state or other fields. For example, if you were doing an IRS search you will only be able to search the EIN number.
|-
||Limit Results to US Based Organization Only
||Only available for IRS. Toggle this setting on if you only want US based organizations to show up in the list of search results.
|-
||Search Instructions (HTML)
||Click the sample Instructions, and modify the provided text as desired. Typically, this explains how the user can search.
|-
||Result Instructions (HTML)
||Click the sample Instructions, and modify the provided text as desired. This text will show up on the results page after you have searched for an organization. Typically, this explains how to select your desired organization.
|-
||Disable Automatic Field Population
||When you select an organization from the verification service, the inputs on your form will be automatically populated. If your signup page does not include inputs for city, state or zip/postal code, check the ones that are not present on your signup page. This will prevent an error when the verification service tries to populate fields that don’t exist on your form.
|-
||Additional Automatic Field Population
||Only available with IRS verification service. Click the add mapping field button under the mapping field column to add a mapping field. Then select a mapping field from the drop down. Then in the custom field column start typing the caption of the desired custom field, then click it to select that field. Note that the custom field you select must also be in the selected fields list in the Input Form section.
|-
||Lookup Field ID
||Not found on IRS or Internal organization lookups. Enter the custom field ID you want to use for mapping the ABN, CRA, CC, CRO, NCES number to. Enter cf_ then the custom field ID, Example cf_1234567.
|-
||Exclude Foundation(s)
||Only available with IRS verification service. Select foundations types you want to exclude from the search, then click the Exclude foundation button which looks like +. Example some people may wish to exclude religious organizations such as churches so they select 10 – Church 170(b)(1)(A)(i) and click exclude foundation button.
|-
||Exclude Subsection(s)
||Only available with IRS verification service. Select subsections you want to exclude from the search and then click the exclude subsection button looks like a +.
|}
==Templates==
The following settings are available on the templates tab.
The templates tab only appears if you have selected “Custom” for “Page Layout”. This setting allows you to modify the HTML of the signup page and is generally not recommended. If you choose to customize the HTML of your signup page you won’t get the latest and greatest templates and you may be required to update your HTML if changes to templates or functionality occur in an upgrade.
===Signup Page Template===
Click the Sample Template link to add the html of the signup page into the input and then modify as desired.
===Confirmation Page Template===
Only available on user signup pages. Click the Sample Template link to add the html of the signup page into the input and then modify as desired.
==Classic Options==
The settings on the Classic Options tab for signup pages are legacy options slated for deprecation and are no longer used or recommended.
[[Category:Interface]]
