Modifying Signon PeopleCode

Signon PeopleCode is record PeopleCode, which you view and edit on the record with which the program is associated. PeopleSoft applications deliver a PeopleCode program for directory authentication. It is intended for production use but it can also be used as a sample that shows many of the technologies you can include within a Signon PeopleCode program. You can find the delivered PeopleCode program on the following record: FUNCLIB_LDAP.LDAPAUTH (FieldDefault). You can customize it as needed for testing or production use.

Open the record in PeopleSoft Application Designer, and view the PeopleCode with the PeopleCode Editor. The delivered PeopleCode accommodates as many different directory scenarios as possible; it demonstrates use of the business interlink and component interface technologies. You may want to modify the authentication PeopleCode to improve login performance or to accommodate any special directory authentication needs. The delivered program that ships with PeopleTools has the following general flow:

1. Searches the directory server for the user profile of the user signing in.

2. Using the password the user entered at the signon page, the program attempts to bind (or connect) to the directory server.

   If the connect succeeds, then the password is valid.

3. Retrieves the user profile of the user signing in.

   The program gets the profile from the directory server and creates a local cache copy within the PeopleSoft database. This improves performance by enabling the PeopleSoft applications to access the user profile locally, rather than making a call to the LDAP server every time they need user profile data. If a locally cached copy already exists for the user signing in, the local cache is updated according to the current user in the directory server.

Note:

To see what the Signon PeopleCode program does, use the PeopleCode debugger. This enables you to step through the program step-by-step.

The following table presents the key PeopleCode constructs that you use with Signon PeopleCode. Click the function to view more details in the PeopleCode product documentation:

PeopleCode Function	Description
See PeopleCode Language Reference: %PSAuthResult system variable.	Returns the result (boolean) of PeopleSoft authentication.
See PeopleCode Language Reference: SetAuthenticationResult function.	Verifies customers who log on to the system even if the PeopleSoft authentication fails.
See PeopleCode Language Reference: %SignonUserId system variable.	User ID value entered by the user on the Signon page. This applies to Pure Internet Architecture and Windows signon.
See PeopleCode Language Reference: %SignOnUserPswd system variable.	User password value the user entered at the Signon page. This value is encrypted. This applies to Pure Internet Architecture and Windows signon.
See PeopleCode Language Reference: %Request system variable.	The HTML request that comes from the browser. In the case of security, this includes any information submitted at the Signon page, such as user ID, password, and any additional fields if you have extended the Signon page. This applies only to Pure Internet Architecture.

Note:

Do not use the %SwitchUser variable in Signon PeopleCode.