Bookshelf v8.1/8.2: SelfServiceRegistration

Siebel CRM Web Services Reference > Siebel CRM Primary Web Services >

SelfServiceRegistration

The Enroll operation of this Web service invokes the SelfServiceRegistration workflow, which internally uses the business services listed below to manage contacts, assigned accounts, assigned personal, or business addresses, create user names, manage assigned responsibilities, send welcome or password update notifications and create Inbox Items to simulate pending registration approvals.

Activity of the workflow is determined by the P_mode input parameter passed to this Web service operation.

P_Mode Request Parameter

For a description of the P_Mode request parameter, see Table 976.

Table 976. P_Mode Request Parameter
P_Mode	Response
CreateContact	Used for creating a contact without a username. Used in Siebel Self-ServiceSelf-Service Applications version 8.1 for contact creation in the Contacts, Administration screen, and other usages in the Contacts, Profile, and the Contacts, Account views.
UpdateContact	Used for updating a contact without a username. Used in Siebel Self-Service Applications version 8.1 in the Contacts, Administration screen, and the Contacts, Profile, and Contacts , Account views. Also used for Personal Info updating from Contacts, Profile view.
CreateUser	Creates a new contact, and a username in the associated LDAP directory, then assigns responsibilities, sends a welcome a notification to the user, and then creates an inbox item for the administrator, if approval is needed. Need to pass the Usertype details (like approval required), notification template, inbox and approval types, when the mode is CreateUser. Used in Siebel Self-Service Applications version 8.1 for making a contact as a user in the Contacts - Administration screen. Also used for all self-service registrations.
UpdateUser	Used for updating a contact with a username and manage the assigned accounts and responsibilities. Used in Siebel Self-Service Applications version 8.1 in the Contacts - Administration screen to update user information.
ResetPasswordOnly	Used for resetting the password of the currently logged in user of the Siebel application session or in the anonymous session. Also used in Forgot Password Flow (for an anonymous session).

SelfServiceRegistration Operations

For a list of operations associated with this Web service, see Table 977.

Table 977. SelfServiceRegistration Operations
Name	Description
Enroll	Internally calls the business services listed below.

Business Services Called by Enroll Operation

The following business services are called by the Enroll operation:

EAITransactionService Business Service

For a description of this business service, see Table 978.

Table 978. EAITransactionService Business Service
EAITransactionService
Business Service Step	Begin Transaction
Business Service Name	EAITransactionService
Business Service Method	Begin Transaction
Description	This step is used to initiate a transaction. BeginTransaction will not take any parameters as input.

SelfServiceContact Business Service

For a description of this business service, see Table 979.

Table 979. Self-ServiceSelf-Service Contact Business Service
SelfServiceContact
Business Service Step	Create, and update contact and account records
Business Service Name	SelfServiceContact
Business Service Method	Execute
Input Arguments
Argument Name	Type	Property Name
SiebelMessageIn	Process Property	P_ContactIO(SS_Contacts_IO)
ViewMode	Process Property	All
LanguageMode	Process Property	LDC
ExecutionMode	Process Property	BiDirectional
Output Arguments
Argument Name	Type	Property Name
SiebelMessageOut	Output Argument	P_ContactIO(SS_Contacts_IO)
Description	This step is used to create or update Contact, Account, Contact Address, Contact_Account relationships and Alternate Communication Address. The Contact integration object with appropriate action specified at the request elements is prepared in the java layer and passed as a Process Property to the workflow. This step executes an EAIUI Service to execute the operations specified at each step in the integration object and returns a ContactIO with the ids specified for each step. Sample SOAP request portions of SS_Contacts_IO are shown below.

PRM ANI Utility Service Business Service

For a description of this business service, see Table 980.

Table 980. PRM ANI Utility Service Business Service
PRM ANI Utility Service
Business Service Step	Retrieve Contact ID
Business Service Name	PRM ANI Utility Service
Business Service Method	GetProperty
Input Arguments
Argument Name	Type	Property Name
Hierarchy Path:	Literal	Contact
Property Name	Literal	ID
SiebelMessage	Hierarchy	P_ContactIO(SS_Contacts_IO)
Output Arguments
Argument Name	Type	Property Name
Property Value	Output Argument	P_ContactId
Description	This step is used to retrieve the contact ID, given the contact IO. In Siebel Self-Service Applications version 8.1, this step is only applicable during the Register your company flow to retrieve the ID of the newly created corporate account, which is then sent to Trigger Approval, and established as the root account. Hence, the caller (java API that calls the proxy) shall ignore the errors reported by this step.

PRM ANI Utility Service Business Service

For a description of this business service, seeTable 981.

Table 981. PRM ANI Utility Service Business Service
PRM ANI Utility Service
Business Service Step	Retrieve Account ID (called only when accountId Process Property is null)
Business Service Name	PRM ANI Utility Service
Business Service Method	GetProperty
Input Arguments
Argument Name	Type	Property Name
Hierarchy Path:	Literal	Contact
Property Name	Literal	Account ID
SiebelMessage	Hierarchy	P_ContactIO (SS_Contacts_IO)
Output Arguments
Argument Name	Type	Property Name
Property Value	Output Argument	AccountId
Description	This step is used to retrieve the account ID, given the contact IO. In Siebel Self-Service Applications version 8.1, this step is only applicable during the Register your company flow to retrieve the ID of the newly created corporate account, which is then sent to Trigger Approval, and established as the root account. Hence, the caller (java API that calls the proxy) shall ignore the errors reported by this step.

SiebelWebRegistrationService Business Service

For a description of this business service, see Table 982.

Table 982. SiebelWebRegistrationService Business Service
SiebelWebRegistrationService
Business Service Step	Create User
Business Service Name	SiebelWebRegistrationService
Business Service Method	Promote
Input Arguments
Argument Name	Type	Property Name
Contactid	Process Property	P_ContactId
Type	Process Property	P_Usertype
Proxy User	Process Property	P_ProxyEmpLoginName
LoginName	Process Property	P_LoginName
Password	Process Property	P_NewPassword
securityQuestion	Process Property	P_ChallengeQuestion
securityAnswer	Process Property	P_ChallengeAnswer
Output Arguments
Argument Name	Type	Property Name
SuccessCode	Output Argument	P_CreateUserStatus
ErrorMessage	Output Argument	Error Message
Description	This step executes the SiebelWebRegistrationService business service to create a Web_User for the given contactid. The business service needs to create Web Channel User of Web User Type, LDAP user record, S_USER record and also update the security question and answer.

Self-Service User Business Service

For a description of this business service, see Table 983.

Table 983. Self-Service User Business Service
Self-Service User
Business Service Step	Assign Responsibilities
Business Service Name	SelfServiceUser
Business Service Method	Execute
Input Arguments
Argument Name	Type	Property Name
SiebelMessageIn	Process Property	P_UserIO
ViewMode	Process Property	All
LanguageMode	Process Property	LDC
Output Arguments
Argument Name	Type	Property Name
SiebelMessageOut	Output Argument	P_UserIO
Description	This step is used to create the responsibilities in the Siebel database. It uses a new EAIUI Service named SelfServiceUser that creates the S_PER_RESP records for the given user ID and the responsibility ID.

EAITransactionService Business Service

For a description of this business service, see Table 984.

Table 984. EAITransactionService Business Service
EAITransactionService
Business Service Step	Commit Transaction
Business Service Name	EAITransactionService
Business Service Method	EndTransaction
Input Arguments
Argument Name	Type	Property Name
Is Abort	Literal	False
Description	This step uses EAITransactionService. EndTransaction to commit the transaction. The parameter Is Abort need be set to False to commit the transaction.

ISS Approval Bus Service Business Service

For a description of this business service, see Table 985.

Table 985. ISS Approval Bus Service Business Service
ISS Approval Bus Service
Business Service Step	Trigger Approval
Business Service Name	ISS Approval Bus Service
Business Service Method	CreateNewApprovalTasks
Input Arguments
Argument Name	Type	Property Name
RequestingBusComp	Literal	Value = Contact
Approval Item ID	Process Property	P_ContactId
Approval Level Name	Process Property	P_UsertypeApprovalType
Inbox Type	Process Property	P_UsertypeInboxType
Approval Level Context	Process Property	P_AccountId
Description	This step uses ISS Approval Bus Service. CreateNewApprovalTasks business service method to create new Inbox Items based on the Inbox Type and Approval Types specified. This step is executed only if approval is required by the user type, based on the P_UsertypeApprovalRequd process property. Note that P_AccountId contains the root account of the corporate account under which the contact, or user is being created. Hence, for newly created corporate account (Register your company flow), P_AccountId is set to the ID of the newly created account. For more information, see Siebel Self-Service Application Developer's Guide.

Outbound Communications Manager Business Service

For a description of this business service, see Table 986.

Table 986. Outbound Communications Manager Business Service
Outbound Communications Manager
Business Service Step	Trigger Notification
Business Service Name	Outbound Communications Manager
Business Service Method	CreateRequest
Input Arguments
Argument Name	Type	Property Name
RecipientBusComp	Literal	Not applicable
SourceIdList	Process Property	P_ContactId
PackageNameList	Process Property	P_NotificationTemplateName
RequestLanguageCode	Process Property	P_Language
RequestLocaleCode	Process Property	P_Locale
ProcessMode	Literal	Not applicable
RequestName	Literal	Not applicable
RecipientGroup	Process Property	Not applicable
Description	This step is used to trigger the notification based on the notification template specified, using the Outbound Communications Manager. CreateRequest. This business service method substitutes the necessary values from the Contact business component which is loaded for the ID specified. For more information, see Siebel Self-Service Application Developer's Guide.

SessionAccessService Business Service

For a description of this business service, see Table 987.

Table 987. SessionAccessService Business Service
SessionAccessService
Business Service Step	Set new password in Siebel session
Business Service Name	SessionAccessService
Business Service Method	SetProfileAttr
Input Arguments
Argument Name	Type	Property Name
Name	Literal	Not applicable
Value	Process Property	P_NewPassword
PackageNameList	Process Property	P_NotificationTemplateName
RequestLanguageCode	Process Property	P_Language
RequestLocaleCode	Process Property	P_Locale
ProcessMode	Literal	Not applicable
RequestName	Literal	Not applicable
RecipientGroup	Process Property	Not applicable
Description	This step is used to set the password in a Siebel CRM session. For more information, see Siebel Self-Service Application Developer's Guide.

Response Message Description: CreateContact

For a description of this business service, see Table 988.

Table 988. Response Message Description: CreateContact
Node	Description	Type
Process_spcInstance_spcId	Not of consequence in response.	String
Object_spcId	Not of consequence in response.	String
Siebel_spcOperation_spcObject_spcId	Not of consequence in response.	String
Error_spcCode	Not of consequence in response.	String
Error_spcMessage	Not of consequence in response.	String
ListOfSSContact	Contains an instance of the output integration object SS_Contacts_IO that holds the ID and ModId of the contact, and or account that is created or updated. See SelfServiceContact for more information on the Structure and subnodes of ListOfSSContact. Maps to the P_ContactIO process property in the workflow.	Integration Object
P_ContactId	Not of consequence in response.	String
P_AccountId	Derived Root Account ID For more information, see Siebel Self-Service Application Developer's Guide on the Siebel Bookshelf.	String
P_DefaultOrgId	Not of consequence in response.	String
P_Mode	Not of consequence in response.	String
P_Usertype	Not of consequence in response.	String
P_LoginName	Username created	String
P_DefaultProxyEmployee	Not of consequence in response.	String
P_LoginId	Value returned by SiebelWebRegistration business service.	String
P_CreateUserStatus	The status set on the newly created user. Inactive, for pending users.	String
P_Password	Not of consequence in response.	String
P_NewPassword	Not of consequence in response.	String
P_ChallengeQuestion	Not of consequence in response.	String
P_ChallengeAnswer	Not of consequence in response.	String
ListOfSSUser	Contains an instance of the input integration object Users that holds the ID and Mode ID of the user-responsibility mapping for the updated responsibility assignments. See SelfServiceUser for more information on the structure and subnodes of ListOfSSUser. Maps to the P_UserIO process property in the workflow.	Integration Object
P_UsertypeApprovalRequd	Not of consequence in response.	String
P_UsertypeApprovalType	Not of consequence in response.	String
P_UsertypeInboxType	Not of consequence in response.	String
P_UsertypeNotifTemplateName	Not of consequence in response.	String
P_RecipientGroup	Not of consequence in response.	String
P_Language	Not of consequence in response.	String
P_Locale	Not of consequence in response.	String

Self-Service Registration Application Interface

This topic describes the application objects called by this Web service. For more information on application implementation, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see Table 989.

Table 989. Self-Service Registration Service Object
Name	Boundary Object Type
SelfServiceRegistration	Workflow

Data Object (Integration Object)

For a description of data objects for this Web service, see Table 990.

Table 990. Self-Service Registration Data Object
Siebel Repository Name	External Name
SelfServiceContact	SelfServiceContact
Users	Users

Example Package for SelfServiceRegistration

To view an example of messages for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

Request and Response Samples are provided for the following scenarios:

Create a B2C contact and a user name and trigger notification.
Create a B2B contact as Inactive and create a user name and trigger notification and create Inbox Items for approval.
Update Personal addresses of an existing Contact.
Update Contact details, Account Assignments, Responsibility Assignments, Password resetting for an existing contact.