Developer Reference to Deploy New User Registration

To create user accounts, New User Registration requires two pre-defined user profiles set with the following user IDs: SCC_GUEST and SCC_SS_TEMPLATE.

Once created, those user profiles can be used as templates to grant your guests basic security access to your PeopleSoft system.

To be provisioned with application level security and transfer to a specific target page, the newly created user ID will need to be provisioned with a security role granting access to the Gatekeeper.

See Setting Up CTM for New User Registration.

For each of the online transactions you want to integrate with New User Registration, create a New User Registration Context ID or create a New User Registration Context ID that will serve as default.

See Setting Up New User Registration Context.

See Using the New User Registration Sample User Interfaces.

Set up the following on the database of the Kiosk:

• The User Exception check box needs to set on the Routing Definition page of the Kiosk. When the check box is selected, in case an error is encountered during processing it allows the system to capture the SOAP fault and display it. Else, when the check box is not selected the system responds with a HTTP 500 error. To access the Routing Definition page, select select PeopleTools, then select Integration Broker, then select Integration Setup, then select Routings.

  Image: Routing Definitions page

  This example illustrates the fields and controls on the Routing Definitions page. You can find definitions for the fields and controls later on this page.

  

• Verify that the gateway is active. To access the Gateways page, select select PeopleTools, then select Integration Broker, then select Configuration, then select Gateways.

  Image: Gateways page

  This example illustrates the fields and controls on the Gateways page. You can find definitions for the fields and controls later on this page.

  

  Press the Ping Gateway button to make sure the gateway is active. The Status displays ACTIVE.

  Note: The gateway needs to be active on both the Kiosk as well as the production environments.

• Verify that the setup target location is configured. To access the Target Locations page, select select PeopleTools, then select Integration Broker, then select Configuration, then select Service Configuration. In the Service Configuration tab, click the Setup Target Locations link.

  Image: Target Locations page

  This example illustrates the fields and controls on the Target Locations page. You can find definitions for the fields and controls later on this page.

  

• Verify that you can ping the node. To access the Connectors page, select select PeopleTools, then select Integration Broker, then select Integration Setup, then select Nodes, then select Connectors. From the Connectors page, press the Ping Node button.

  Click the Ping Node button to verify the results. Make sure Message Text shows Success.

  Image: Connectors page

  This example illustrates the fields and controls on the Connectors page. You can find definitions for the fields and controls later on this page.

  

• During the consume web services step ensure that the Build Documents Message check box is cleared. To access the Consume Web Services wizard, select select PeopleTools, then select Integration Broker, then select Web Services, then select Consume Web Service.

  Image: Consume Web Service Wizard page

  This example illustrates the fields and controls on the Consume Web Service Wizard page. You can find definitions for the fields and controls later on this page.

  

• Verify that schema exists for the imported message. To access this schema, first navigate to the General page of the service operation(select PeopleTools, then select Integration Broker, then select Integration Setup, then select Service Operations), then click the View Message link for the message, and finally click the Schema tab.

  Image: Schema page

  This example illustrates the fields and controls on the Schema page. You can find definitions for the fields and controls later on this page.

  

Use the Provide Web Service page to publish the SCC_USERREG web service (select PeopleTools, then select Integration Broker, then select Web Services, then select Provide Web Service).

New User Registration includes the SCC_USERREG web service with the following service operations:

• SCC_USERREG_AUTHENTICATE

• SCC_USERREG_CREATEACCT

• SCC_USERREG_GET_PASSWORD

• SCC_USERREG_GET_PSWD_HINT

• SCC_USERREG_GET_USERID

• SCC_CHECK_AUTH

  Note: Activate this only if you use Simplified Campus Experience

See the product documentation for PeopleSoft Integration Broker.

The URL triggers the NUR framework. It transfers your anonymous users to your New User Registration login page. To facilitate the consumption of the NUR framework, you can use the New User Registration Installation page to automatically generate the URL. The URL is embedded with the environment information you specify as well as the logic that the NUR framework provides. For example, the autologger and gatekeeper information. You use the New User Registration Installation page, and, optionally, the New User Registration Context page to configure the NUR constants, and activate the Production or Tester URL. Use the Production URL if you are ready to deploy your online transactions, and the Tester URL to test your online transactions.

You can hardcode the URL in your applications, although it is recommended to use logic to dynamically refer to the URL. As part of the NUR framework, the application class SCC_IDENTITY_MGR.UTIL.NURConstants contains the logic to use the URL that you specify as Active in the New User Registration Context page. To see an example of how the application class is extended, see the Delegated Access application class SCC_DA.NOTIFICATION.NOTIFY.OnExecute. In this application class, the NUR context ID for Delegated Access is hardcoded: SCC_NURCTXT_20120918102441. The method ActiveAutoGenURL is implemented to retrieve the proper URL that you would include in an email message. For Delegated Access, an email message is sent to the proxies to inform them how to access the school system. It includes the URL (a hyperlink) that is also dynamically retrieved.

When you dynamically refer to the URL, it ensures that if there are any changes to the New User Registration constants, the current URL will always be retrieved. It also allows you to easily switch between your Tester URL and Production URL.

See product documentation for PeopleTools: Portal Technology, Configuring the Portal Environment, Understanding Web Profiles.

The permission list HCCPCSSA1200 - CS NUR GateKeeper is used to access the Gatekeeper. Add this permission list to a role that you want to assign to all of your users that could potentially register with your system through a New User Registration login page. For example, students, alumni, applicants, and so on.

The HCCPCSSA1200 permission list grants access to the web library WEBLIB_SCC_NUR.

Image: HCCPCSSA1200 Web Service Permissions Page

This example illustrates the fields and controls on the HCCPCSSA1200 Web Service Permissions Page.

The web library grants access to the following permissions:

Image: WEBLIB_SCC_NUR Weblib Permissions Page

This example illustrates the fields and controls on the WEBLIB_SCC_NUR Weblib Permissions Page.

Having security access to the Gatekeeper will allow your existing users to sign in through New User Registration login page with an existing user ID and password, and take advantage of the Gatekeeper functions. For example, automatic application level provisioning and page transfer after successfully signing into your system. If users do not have access to the Gatekeeper, they see the following error after they are authenticated: Not Authorized.

If you implement the New User Registration Forgot Password and Forgot User ID utilities, your existing users will also need to have access to the HCCPCSSA1210 permission list. This permission list grants access to the web services that are needed for the Forgot Password and Forgot User ID utilities.

Image: HCCPCSSA1210 Web Service Permissions Page

This example illustrates the fields and controls on the HCCPCSSA1210 Web Service Permissions Page.

For guest users, create a new role that exclusively contains the HCCPCSSA1200 permission list. Also, when you implement the New User Registration Forgot Password and Forgot User ID utilities, include the HCCPCSSA1210 permission list. Add this role to the SCC_SS_TEMPLATE user ID. By default, the guest will be provisioned with all the security setup inside that user ID.

To configure the Forgot User ID Utility:

1. Store email addresses in the PSOPRDEFN.EMAILID and PSUSEREMAIL.EMAILID records where PRIMARY_EMAIL = ‘Y’.

   To take advantage of the Forgot User ID utility, all users must have an email address stored in their user profile. When users forget their user ID, they are asked to enter their email address. The email address is matched to the one stored in your system. This email address must match only one user profile stored in your system.

   You can require users that are created through the SCC_USERREG_CREATEACCT service operation to enter an email address. For example, guests who create their own account using the New User Registration login page. To require users to enter an email address, select this option in the New User Registration Installation page. The email address users enter at account creation time is automatically stored in the newly created user profile. The email address is used to populate the records PSOPRDEFN.EMAILID and PSUSEREMAIL.EMAILID with an email type (EMAILTYPE field), and the PRIMARY_EMAIL field must be selected.

   See:

   • Defining Installation Options for New User Registration

   • PeopleTools: Security Administration, “Setting General User Profile Attributes”

2. Set up the Notifications Framework.

   1. If necessary, set up the generic template NUR_EMAIL_OPRID. The generic template NUR_EMAIL_OPRID is configured for the Forgot User ID email message. You can modify the text of this template. To set up the template, go to select PeopleTools, then select Workflow, then select Notifications, then select Generic Templates.

      See Understanding New User Registration, Notifications Framework and New User Registration.

   2. Verify the notification setup and the email recipients for the generic template. This setup is delivered with your system as sample data (Notification Template ID SCC_NTF_TMP_20130213051038 – NUR_EMAIL_OPRID). To view the setup, go to select Set up SACR, then select System Administration, then select Utilities, then select Notifications, then select Notification Setup.

   3. Verify the setup for the notification consumer for New User Registration. This is delivered with your system as sample data (Notification Consumer ID SCC_NTF_CON_20121212000832 – New User Registration). To view the setup, go to select Set up SACR, then select System Administration, then select Utilities, then select Notifications, then select Notification Consumer Setup.

3. Grant all users access to a permission list that is set up to grant access to the Forgot My User ID page.

   See Step 1: Initial Setup for New User Registration.

To configure the Forgot Password Utility:

1. Store email addresses in the PSOPRDEFN.EMAILID and PSUSEREMAIL.EMAILID records where PRIMARY_EMAIL = ‘Y’.

   The New User Registration Forgot Password utility leverages the PeopleTools security function for forgotten passwords. This function uses the PeopleTools Workflow and requires users to have an email address stored in their user profile (General tab, Edit Email Address link).

   To take advantage of the Forgot Password utility, you can require users that are created through the SCC_USERREG_CREATEACCT service operation to enter an email address. For example, guests who create their own account using the New User Registration login page. To require users to enter an email address, select this option in the New User Registration Installation page. The email address users enter at account creation time is automatically stored in the newly created user profile. The email address is used to populate the records PSOPRDEFN.EMAILID and PSUSEREMAIL.EMAILID with an email type (EMAILTYPE field), and the PRIMARY_EMAIL field must be selected.

   See:

   • Defining Installation Options for New User Registration

   • PeopleTools: Security Administration, “Setting General User Profile Attributes”

2. Create the URL you include in the forgotten password email text.

   When you use the Forgot Password utility, the user receives an email message that contains the newly generated password. In the email message, it is recommended that you include a URL to access the New User Registration login page. Use the URL to force users to reset the temporary password they received. After users log in with their temporary password, they should be automatically redirected to the Change Password page. The URL you use must be embedded with the New User Registration context ID that grants the newly authenticated user the security to access and immediate transfer to the Change Password page. Your system includes a New User Registration Context ID sample: SCC_NURCTXT_20130211110717 - NUR_CHANGE_PASSWORD. Make sure the generic URL you use has been configured using the New User Registration Installation page.

   See:

   • Step 7: Creating a URL to Access the New User Registration Login pageDefining Installation Options for New User Registration

   • Setting Up New User Registration Context

3. Create password hint questions.

   To use the Forgot Password utility, users need to answer a security question or password hint question. To create password hint questions, go to select PeopleTools, then select Security, then select Password Configuration, then select Forgot Password Hint.

   See PeopleTools: Security Administration, “Creating Hints for Forgot Passwords.”

4. Set up the Forgot Password email text.

   When the user initiates the Forgot Password utility and successfully answers the security question, an email message is sent to the email address that is stored in the user's profile. It includes a newly generated password. You can configure the email message text by going to select PeopleTools, then select Security, then select Password Configuration, then select Forgot Password Email text.

   The email text must include the <<%PASSWORD>> tag. PeopleTools replaces the tag with the newly generated password. To facilitate user experience, it is recommended that you also include a URL that transfers the user automatically to the New User Registration sample login page (or your own version of this page). This is the URL you create in step 2. This forces the user to immediately change the newly received password. The PeopleTools email text editor allows you to easily paste a URL. You can use the URL you marked as Active in the New User Registration context ID in your system (SCC_NURCTXT_20130211110717 - NUR_CHANGE_PASSWORD).

   This is an example of an email text:

   You are receiving this auto-generated email message because you requested your Campus Solutions password to be reset. Use the following temporary password: <<%PASSWORD>>. Click this link or copy the below URL to access the system with your newly generated password. You will be requested to change the temporary password immediately.” https://yourKioskServer.yourKioskDomain.com/psc/ps/EMPLOYEE/HRMS/c/SCC_NUR.SCC_NUR_REG.GBL=start?CAMPUS_URL=https%3a%2f%2fyourCSServer.yourCSDomain.com%2fpsc%2fps%2fEMPLOYEE%2fHRMS%2fs%2fWEBLIB_SCC_NUR.SCC_SS_GATEKEEPER.FieldFormula.IScript_SCC_GateKeeper%3fSCC_APPL_CONTXT_ID%3dSCC_NURCTXT_20130211110717

   See PeopleTools: Security Administration, “Working with Passwords.”

5. Grant all your users access to a self-service page where they can respond to a security question.

   Delivered with your system with the generic PeopleTools security a self-service user can answer is a security question under Home page, My System Profile. In the General Profile Information page (USER_SELF_SERVICE), by clicking the link Change or set up forgotten password help, the user can select a question and enter a response. This page is delivered with your system and security needs to be granted to all of your users. Alternatively, a simpler self-service version of this page could be created.

6. Configure the Forget My Password page.

   This is a delivered custom version of the Tools page EMAIL_PSWD as public.

   See PeopleTools: Security Administration, “Working with User Profiles Across Multiple PeopleSoft Databases, Implementing Default User Profile Synchronization.”

7. Make sure you grant all your users access to a permission list set up with Allow Password to be Emailed and Forgot My Password.

   See Step 1: Initial Setup for New User Registration.

8. Set up the New User Registration context ID for the Change My Password page, or use the SCC_NURCTXT_20130211110717 - NUR_CHANGE_PASSWORD context ID.

9. Set the PeopleTools Workflow to activate email.

   The New User Registration Forgot Password utility leverages the PeopleTools send password functionality. Because this functionality uses the PeopleTools Workflow, the following setup is required:

   1. Go to select PeopleTools, then select Workflow, then select Defaults & Messages, then select Set Workflow Defaults.

   2. In the select Worklist System Defaults page, then select System Wide Route Processing make sure the Worklists Active and the Email Active checkboxes are selected.

   3. Reboot the application server for the changes to take effect.