| Siebel CRM Siebel Security Guide Siebel Innovation Pack 2015 E24814-01 |
|
 Previous |
 Next |
View PDF |
| Siebel CRM Siebel Security Guide Siebel Innovation Pack 2015 E24814-01 |
|
Previous |
Next |
View PDF |
This topic describes the tasks involved in implementing user self-registration.
Self-registration comprises several components, as follows:
Siebel seed workflow processes provide a sequence of interactive forms to the user for collecting the new user's data. These processes also validate data and write much of the data to the new User record in the Siebel database.
Some fields in the new User record in the database are populated automatically from fields in the anonymous user record.
A new record is created in the user directory. The security adapter authenticates the user against this record. Fields are populated automatically from the data the user enters to the forms.
Perform the following tasks to implement self-registration:
"Setting the PropagateChange Parameter for Self-Registration"
Review "About Activating Workflow Processes for Self-Registration"
"(Optional) Modifying Self-Registration Views and Workflows"
This topic describes the modifications you might have to make to the anonymous user record when you implement self-registration. For additional information on the anonymous user, see "Configuring the Anonymous User".
This task is a step in "Process of Implementing Self-Registration".
Before implementing self-registration, verify that:
An anonymous user record exists in your Siebel database and external directory.
The New Responsibility field of your anonymous user provides all the views you require for self-registering users.
Different Siebel Business Applications in the same implementation can use different anonymous users. Two Siebel application user records, identified by their user IDs, GUESTCST and GUESTCP, are provided as seed data for use as anonymous users. Appendix B, "Seed Data," describes seed data users, responsibilities, and the Siebel Business Applications for which they are designed.
When a user self-registers, a new record is created in the User Registration business component. The User Registration business component is based on the same tables as the User business component, so a new User record is essentially created.
|
Note: When a user self-registers through partner applications, such as Siebel Partner Portal, data is also written to the Contact business component (or equivalent). |
The following key fields are populated automatically from fields in the anonymous user's record in the Siebel database:
Responsibility. The new user's responsibility is inherited from the anonymous user's New Responsibility field. A user's responsibility determines the list of views to which the user has access.
New Responsibility. The new user's New Responsibility field value is also inherited from the anonymous user's New Responsibility field. The New Responsibility field is not used by regular registered users. Several Siebel Business Applications allow customer or partner users to be upgraded to delegated administrators. A delegated administrator can register other users, who inherit their responsibility from the delegated administrator's New Responsibility field.
The New Responsibility field is a single-value field. Therefore, if the seed responsibility in the New Responsibility field of your anonymous user does not provide all the views you require for self-registering users, then do one of the following:
Replace the New Responsibility value with a responsibility you create.
Copy the seed responsibility record, add missing views to the copy, and replace the New Responsibility with the modified responsibility.
|
Note: You cannot directly modify a seed responsibility. |
For information about creating a responsibility or adding views to a responsibility, see Chapter 9, "Configuring Access Control."
This topic describes the Siebel PropagateChange parameter. Setting the PropagateChange parameter to True simplifies user administration when you implement user self-registration.
This task is a step in "Process of Implementing Self-Registration".
The user directory can be administered through Siebel Business Applications if you implement security adapter authentication. Changes such as adding a user, or changing a password by an internal administrator, a delegated administrator, or when a user self-registers, are propagated to the user directory.
Set the PropagateChange parameter to True for the security adapter so that user data, including user name and password, propagate to the user directory when users self-register from the Siebel Web Client.
To set the PropagateChange parameter to True
In a Siebel employee application, such as Siebel Call Center, navigate to the Administration - Server Configuration screen, then the Profile Configuration view.
Select either ADSI Security Adapter or LDAP Security Adapter, as appropriate.
In the Profile Parameters applet, set the Propagate Change parameter to True.
For additional information about setting the PropagateChange parameter, see "Siebel Gateway Name Server Parameters".
When you install Siebel Business Applications, you are provided with several workflow processes that control self-registration. For the self-registration workflow processes to be invoked, you must set the workflows to have a status of Active. For information about how to activate workflow processes, see Siebel Business Process Framework: Workflow Guide.
This task is a step in "Process of Implementing Self-Registration".
The self-registration workflow processes together present a sequence of forms for the user to complete. They perform data validation, and they invoke database operations. The self-registration workflow processes which you must activate are as follows:
User Registration Initial Process. For purposes of self-registration, this process is invoked when a user clicks New User on the login form or clicks Check Out during the buying process in Siebel Sales. This process is also invoked by clicking Forgot Your Password? on the login form. The process branches to one of the following subprocesses:
User Registration Process
User Registration Forgot Password Process
User Registration Process. This is the main self-registration process. It updates the database, including:
Creating a new User record
Checking for a duplicate User record
Updating the existing User record with new information if a duplicate record is found
User Registration SubProcess. This process is a subprocess to User Registration Process. It performs all of the information gathering and validation. The validated information includes:
A duplicate user ID does not exist in the database
The Password and Verify Password entries are identical
All required fields are completed
The registration workflow processes branch at various stages depending on the following:
The application is Siebel Partner Portal
The application is other than Siebel Partner Portal
This is the default case, and it includes Siebel Sales, Siebel eService, Siebel Customer, Siebel Training, Siebel Events, and Siebel Marketing.
Table 8-1 lists the views specified in the workflow processes that provide interactive forms during self-registration.
Table 8-1 Self-Registration Workflow Views
You can modify existing views in a self-registration workflow process or create new views as required. You can also modify the seed workflow processes that are used for self-registration.
This task is an optional step in "Process of Implementing Self-Registration".
You can modify the default self-registration functionality in several ways. See the following topics for additional information:
Modifying self-registration views, applets, and workflow processes include standard processes common with modifying other views, applets, and workflow processes.
The views used in the self-registration workflow processes are based on the VBC User Registration virtual business component, which collects the user data. The data is written to the User Registration business component and the Siebel database only when all stages of collecting user data are completed. Before you make any modifications, you must understand how these components handle the user data.
The User Registration and User business components are both based on the same database tables: S_PARTY, S_CONTACT, and S_USER. Therefore, writing a record through the User Registration business component is equivalent to writing a record through the User business component. In either case, a new user is created.
The user-registration process provides the following benefits:
If the self-registration process is terminated before completion, then it is not necessary to perform the time-consuming process of undoing a new, partially written record in the database. This process requires searching several tables.
User record duplication can be prevented before a record is written.
You can replace the default license agreement that appears to the self-registering user in the User Registration Legal Confirmation View.
The DotCom Applet License Base 1 Column Web template includes the Web template file with the name DotCom Applet Form Base 1 Column, which is the file of name dCCAppletLicenseBase1Col.swt. The license agreement is contained in the dCCAppletLicenseBase1Col.swt file, following the phrasing: <!--This is where we include the html license agreement-->. You can replace the license agreement text. For information about working with Web templates, see Configuring Siebel Business Applications.
The self-registration workflow processes for your business scenario might require that you do revisions to the seed self-registration workflow processes, such as:
Replace or insert a view
Insert or delete a step
Modify a step
You cannot directly modify a seed workflow process, such as any of the self-registration processes. Instead, you must create a copy of the process, and then revise the copy.
By convention, to avoid renaming processes, you can use the Revise button to make a copy of the same name, but with an incremented version number. All other processes of the same name are assigned Outdated status, so that the new version can be the only active version. This convention is recommended for revising any workflow process, not just seed processes. For information about how to view, revise, activate, and deploy workflow processes, see Siebel Business Process Framework: Workflow Guide.
Siebel Business Applications provides predefined business services that you can use in a step of a workflow process. You can also script your own custom business services and then run them in workflow process steps. For information about predefined business services and creating business services, see Configuring Siebel Business Applications. For information about running business services in workflow processes, see Siebel Business Process Framework: Workflow Guide.
As default functionality, a user who is self-registering is required to provide entries in certain fields. These fields might differ depending on the application. A required field is indicated in the user interface by a star icon, where the field appears in a form.
For a view used in the self-registration workflow processes, you can change whether a field is required. Use Siebel Tools to determine the view that includes a self-registration field. For information about how to view, revise, activate, and deploy workflow processes, see Siebel Business Process Framework: Workflow Guide.
The CSSSWEFrameUserRegistration frame class is applied to applets that are used in views that appear in the seed self-registration workflow processes. This class allows you to specify required self-registration fields.
To designate a required field in a self-registration form, use Siebel Tools to modify the applet that contains the form. The following procedure is intended to present the main steps in a Siebel Tools task. For detailed information about working with applets and views in Siebel Tools, see Configuring Siebel Business Applications.
To designate a required field in a self-registration form
Open Siebel Tools.
Lock the User Registration project.
In Object Explorer, expand the View object type.
The Views list appears.
Select a view that includes a self-registration field.
In Object Explorer, expand the View Web Template child object type, and then expand its child, View Web Template Item.
Self-registration views typically contain a single form applet. It is listed in the View Web Template Items list.
In the View Web Template Items list, drill down on the link in the Applet field for the single applet that is listed. If there is more than one applet listed, then drill down on the one you think is most likely to contain the field you are looking for.
The Applets list appears with one record, the applet you drilled down on.
In the Object Explorer, expand the Applet object type, and then expand the Control child object type.
The Controls list appears below the Applets list.
In the Controls list, select the record whose Caption field is the name displayed in the user interface for the field you want to require users to complete. Record the value that appears in the Name column, for example, MiddleName.
In Object Explorer, click the Applet User Prop object type.
The Applet User Properties list displays the user properties for the applet in the Applets list.
With the Applet User Properties list active, choose Edit, and then New Record.
A new user property record appears.
Complete the following fields. Use the indicated guidelines.
| Field | Guideline |
|---|---|
| Name | Required. Enter Show Required and a sequence number one greater than the highest existing sequence number. For example, if Show Required 6 is the highest sequenced entry, then enter Show Required 7. This entry is case-sensitive. |
| Value | Required. The name of the field that you recorded in Step 8, such as MiddleName. |
Recompile the Siebel repository file, and unlock the User Registration project.
When viewed in the self-registration interface, the new required field has a star icon.
|
Note: To make a required field no longer required in the user interface, follow the steps in the preceding procedures, with the following exception: in the Applet User Properties list, either check the Inactive column for the record you added in Step 10, or delete the record. |
All the data collected in views used in the seed self-registration workflow processes are written to fields in the User Registration business component. The following process describes how data is collected in the user interface and written to a user's record in the database:
The user enters data, such as the user's last name, into a text box on a form.
The text box is mapped to a field in the VBC User Registration virtual business component, such as LastName. Consequently, the data is written to that field.
Data from the virtual business component VBC User Registration is written to the User Registration business component. The User Registration business component writes to the same database tables as the User business component. Consequently, each field is actually stored as part of a user record.
|
Note: No data from the VBC User Registration virtual business component is written to the User Registration business component fields until the self-registration process is complete. |
To add or delete fields in a view used in a self-registration workflow process, you must perform Siebel Tools tasks and then Siebel Workflow tasks (using Business Process Designer in Siebel Tools).
To add a field to one of the views used in the self-registration workflow processes, you must use Siebel Tools to do one or more steps of the following procedure. This procedure is intended to identify the major tasks required. For detailed information about modifying views and applets, see Configuring Siebel Business Applications.
To add a field to a view used in a self-registration workflow process
Open Siebel Tools.
Lock the User Registration project.
Determine the business component and the underlying database table on which the new field is based.
If the new field is not based on an existing database table column, then define a column on an extension table of the appropriate table.
Create a new field, based on the new or existing table column, in the appropriate business component.
If the new field is based on the User Registration business component, then create a new field in the VBC User Registration virtual business component. Use the exact same field name.
Configure the appropriate applet to display the new field in the user interface.
If necessary, configure the new field so that a self-registering user is required to complete it.
Recompile the Siebel repository file, and unlock the User Registration project.
|
Note: To remove a field from the self-registration user interface, you do not have to delete the field from the applet in which it appears. Instead, configure the applet so that the field is not displayed in the user interface. |
For information about changing the physical appearance of a view or applet, such as moving fields or changing colors, see Configuring Siebel Business Applications.
You create a new view for insertion into one of the self-registration workflow processes in the same way you create a view for any other purpose.
You can include new applets in a view that you create that you include in a self-registration workflow process. You create the new applet and include it in the view in the same way as you would for any other purpose. However, if you base the applet on the User Registration business component, then apply the CSSSWEFrameUserRegistration class to the applet. This allows you to define fields for which a star icon displays in the user interface. By convention, fields that you require users to complete during the self-registration process have a star icon. For information about working with views, see Configuring Siebel Business Applications.
When a user self-registers, the User Registration Process workflow process attempts to determine whether the user already exists in the database. User deduplication is a default feature, and it is configurable.
This task is an optional step in "Process of Implementing Self-Registration".
As default functionality, if all of the following non-null field values entered by the self-registering user match those for an existing user, the users are considered to be the same person.
First name
Last name
Email address
If the self-registering user is a match of an existing user, then the existing User record is updated instead of a new User record being written. If the value in a field of the existing User record differs from the self-registering user's non-null entry, then the existing field is updated with the new data. All other existing field values are left unchanged.
In the User Registration SubProcess workflow process, the duplication comparison is done by the ValidateContact method in the User Registration business service. The comparison is done by the Check User Key step.
You can specify that certain fields in the User Registration business component are not updated when a duplicate user is determined.
The following procedure is intended to list the major steps you must do. For detailed information about doing any step, see Configuring Siebel Business Applications.
To exclude a field from being updated when a duplicate user is determined
Open Siebel Tools.
Lock the User Registration project.
Determine the field in the VBC User Registration virtual business component that you want to exclude from updating.
In the Object Explorer, click Business Component.
In the Business Components list, select the VBC User Registration business component.
In the Object Explorer, expand the Business Component item, then select the Field child item.
In the Fields list, query or scroll to select the field you want to exclude.
Add the appropriate business service user property.
In the Object Explorer, click Business Service.
In the Business Services list, select the User Registration business service.
In the Object Explorer, expand the Business Service item, then select the Business Service User Prop child item.
In the Business Service User Props list, create a new record.
Complete only the fields listed. Use the indicated guidelines.
| Field | Guideline |
|---|---|
| Name | Enter Exclude From Update number, where number is the next number in the sequence for this particular user property. For example, enter Exclude From Update 3. This entry is case-sensitive. |
| Value | Enter the field name from the VBC User Registration virtual business component that you noted in Step 3. |
Recompile the Siebel repository file and unlock the User Registration project.
You can change the fields that are used to determine whether a duplicate user exists.
The following procedure is intended to list the major steps you must perform to modify the fields used to determine a duplicate user. For detailed information about performing any step, see Configuring Siebel Business Applications.
To modify the fields used to determine a duplicate user
Open Siebel Tools.
Lock the User Registration project.
Determine the fields in the User Registration business component that you want to add or delete from the duplication comparison.
In the Object Explorer, expand Business Service, and then click on its Business Service User Properties child.
The Business Services list and the Business Service User Properties child list appear.
In the Business Services list, select User Registration.
Delete a field from the duplication comparison:
In the Business Service User Properties list, select the record with name App User Key: Default number or App User Key: Siebel eChannel number (for Siebel Partner Portal) whose value is the User Registration business component field you want to delete from the comparison.
Click to put a check in the Inactive field, and then commit the record.
Add a field to the duplication comparison:
In the Business Service User Properties, create a new record.
Enter only the fields listed below. Use the indicated guidelines.
| Field | Guideline |
|---|---|
| Name | Enter App User Key: Default number or App User Key: application number, where application is the name of the Siebel application, and number is the next number in the sequence for this particular user property. This entry is case-sensitive.
For example, you might enter |
| Value | Enter the name of the field in the User Registration business component that you want to add to the duplication check. |
Recompile the Siebel repository file and unlock the User Registration project.
You can deactivate the duplicate user check.The following procedure is intended to show the main steps in deactivating the duplication check. For more detailed information on working with workflow processes, see Siebel Business Process Framework: Workflow Guide.
To deactivate the self-registration deduplication check
In Siebel Tools, select Workflow Process in the Object Editor.
Query or scroll to select User Registration SubProcess.
Create a revised copy of User Registration SubProcess.
For information, see "(Optional) Modifying Self-Registration Views and Workflows".
Right-click and choose Edit Workflow Process to edit the revised copy.
The Process Designer appears, showing the current workflow process.
For each process step that applies to your application, record the sources of all connectors to the step and the destination of the single connector from the step. Reroute the connectors to bypass the step. For all Siebel Business Applications, choose the Check User Key step.
Delete the bypassed process step, which is no longer the source or destination of any connector.
Right-click and choose All Processes.
The Workflow Processes list appears again. The revised process is still selected.
Click Deploy.
