How do I configure the Self-Service Registration object in Digital Customer Service?

Overview of the Self-Service Registration Object

Digital Customer Service self-service registration requests are submitted using the Self-Service Registration object. This object is extensible and can be configured using the Application Composer in Oracle Fusion Service. With the Application Composer, you can add new fields, validation rules and triggers to the object.

The payload of the REST request to the Self-Service registration resource can supply values for the following attributes:

Basic attributes:

Attribute Name for the SelfRegistration Object	Display Name	Attribute in the Contact Object	Type
EmailAddress	Email Address	EmailAddress	Text
AccountKey	Account Key	AccountKey	Text
FirstName	First Name	FirstName	Text
MiddleName	Middle Name	MiddleName	Text
LastName	Last Name	LastName	Text
PlaceOfBirth	Place Of Birth	PlaceOfBirth	Text

Address attributes:

Attribute Name for the SelfRegistration Object	Display Name	Attribute in the Contact Object	Type
PrimaryAddressLine1	Primary Address Line 1	Address1	Text
PrimaryAddressLine2	Primary Address Line 2	Address2	Text
PrimaryCountry	Primary Country	Country	LOV
PrimaryCity	Primary City	City	LOV
PrimaryState	Primary State	State	LOV
PrimaryProvince	Primary Province	Province	Text
PrimaryPostalCode	Primary Postal Code	PostalCode	LOV
PrimaryAddressType	Primary Address Type	AddressType	Text
SecondaryAddressLine1	Secondary Address Line 1	Address1	Text
SecondaryAddressLine2	Secondary Address Line 2	Address2	Text
SecondaryCountry	Secondary Country	Country	LOV
SecondaryCity	Secondary City	City	LOV
SecondaryState	Secondary State	State	LOV
SecondaryProvince	Secondary Province	Province	Text
SecondaryPostalCode	Secondary Postal Code	PostalCode	LOV
SecondaryAddressType	Secondary Address Type	AddressType	Text

Contact Point attributes:

Attribute Name for the SelfRegistration Object	Display Name	Attribute in the Contact Object	Type
RawWorkPhoneNumber	Raw Work Phone Number	RawPhoneNumber	Text
RawMobileNumber	Raw Mobile Number	RawPhoneNumber	Text
RawHomePhoneNumber	Raw Home Phone Number	RawPhoneNumber	Text
WorkPhoneCountryCode	Work Phone Country Code	PhoneCountryCode	Text
MobileCountryCode	Mobile Country Code	PhoneCountryCode	Text
HomePhoneCountryCode	Home Phone Country Code	PhoneCountryCode	Text
WorkPhoneAreaCode	Work Phone Area Code	PhoneAreaCode	Text
MobileAreaCode	Mobile Area Code	PhoneAreaCode	Text
HomePhoneAreaCode	Home Phone Area Code	PhoneAreaCode	Text
WorkPhoneExtension	Work Phone Extension	PhoneExtension	Text
MobileExtension	Mobile Extension	PhoneExtension	Text
HomePhoneExtension	Home Phone Extension	PhoneExtension	Text
WorkPhoneNumber	Work Phone Number	PhoneNumber	Text
MobileNumber	Mobile Number	PhoneNumber	Text
HomePhoneNumber	Home Phone Number	PhoneNumber	Text

During the approval process, a contact record is created, and the attributes of the Self-Service Registration object can be transferred to the Contact object. The value assigned to the SVC_CSS_REG_CONT_MAP profile option determines which attributes in the Self-Service Registration object are transferred to which attributes in the Contact object. The default is an empty string. You specify a value for this profile option only if the name of the attribute in the Self Registration object is different from the name in the Contact object. Cases where they may happen are if you have created a custom attribute for an object. Custom attributes are designated with an _c, such as PlaceOfBirth_c. For this use case, you ignore the _c when determining whether an attribute maps or not. So, let's take the custom attribute in the Self Registration object PlaceOfBirth_c. Since the Contact object has a out of the box attribute called PlaceOfBirth no mapping is required since the two values match. If, however, the name of the custom attribute was BirthPlace_c the value of this profile option would then be BirthPlace_c:PlaceOfBirth.

Usage Example

For business reasons, if additional information needs to be gathered about the user submitting a registration request, custom fields can be added to the Self-Service Registration Object. If an additional field is a required, then a value must be provided in the REST request sent to the Self-Service Registration object.

If a new required custom attribute is added to the Contact object, a new custom attribute must also be added to the Self-Service Registration object and then specified in the SVC_CSS_REG_CONT_MAP profile option. This will transfer the value of the new attribute of the Self-Service Registration object to the new attribute of the Contact object.

For example, let's say there's a custom attribute in the Self Registration object called PlaceOfBirth_c. This attribute can be added to the Self-Service Registration object and mapped to the Place of Birth attribute that already exists on the Contact object. If the name of the attribute is BirthPlace_c then the value of SVC_CSS_REG_CONT_MAP profile option should be BirthPlace_c:PlaceofBirth. You can map multiple attributes using colon separating fields, and commas separating the pairs. For more information, see the entry in the Registration Profile Options table in How do I configure DCS profile options?.

Note: The API Name of the new attribute is different from the Name.

Here are the tasks that you need to complete to address this use case:

Create the Field
Test the REST Request
Modify the Profile Option

Create the Field

First, you need to create the field.

To create the field:

Sign in to Oracle Fusion Service as an administrator or a setup user.
Create a sandbox for adding the Place of Birth field:
1. Click Navigator > Configuration > Sandboxes.
2. Click Create Sandbox.
  
  The Create Sandbox page appears.
3. Enter a name in the Name field.
4. From the All Tools list, select Application Composer.
5. Click Create.
6. In the Available Sandboxes list, click the name of the sandbox name that you specified in step c.
7. Click Enter Sandbox.
Navigate to Application Composer.
Expand Objects, then Standard Objects, then Self-Service Registration, and then click Fields.

The Fields page appears.
Click Create a custom field.
Click the Text option, then click OK.
Specify the following for the Date field options:
- In the Display Label field, enter the following string:
  
  Birth Place
- The Name field will be pre-populated based on the name that you entered for the Display Label, without any spaces.
- The API Name field will be pre-populated based on the name that you entered for the Display Label, without any spaces, and typically with the following suffix: _c
  
  Tip: Note the value assigned to the Birth Place field, because it will be assigned to the SVC_CSS_REG_CONT_MAP profile option in the Modify the Profile Option task, later in this topic.
- Deselect the Required option in the Constraints section.
- Select the Updatable option in the Constraints section.
- Deselect the Searchable option in the Constraints section.
- Select the Include in Service Payload option in the Constraints section.
Click Save and Close.

Test the REST Request

Use the following sample curl command to test the REST request. You must set the profile option before you complete your testing. Also, given a meaningful value for the Birth Place (Birthplace_c) field such as "2001-01-01".

Note: This is only an example. Your curl command must include details relevant to your deployment.

curl -X POST \
  https://myhost.us.example.com/crmRestApi/resources/11.13.18.05/selfRegistrations \
  -H 'Accept: application/json' \
  -u "<user_name>:<password>" \
  -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json' \
  -d '{
    "AccountKey": "HDFC Bank",
    "PersonFirstName": "Lilly",
    "PersonLastName": "Inigo",
    "EmailAddress": "lilly.inigo@example.com"    ,
    "BirthPlace_c":"New York"

Modify the Profile Option

To modify the SVC_CSS_REG_CONT_MAP profile option so that it includes the Place of Birth field:

Sign in to Oracle Fusion Service as administrator or a setup user.
In the Setup and Maintenance work area, go to the following:
- Offering: Service
- Functional Area: Digital Customer Service
- Task: Manage Digital Customer Service Profile Options
Click the SVC_CSS_REG_CONT_MAP profile option.
Add the following profile option value to the list of values:

BirthPlace_c:PlaceOfBirth
Click Save and Close.

Usage Example with Multiple Mappings

Now, let's briefly consider a scenario with multiple mappings.

First, you specify the case sensitive name and value pairs to map the fields of the Registration View object to the Contact View object. Here's how you do it: in the following way:

reg_field1:contact_field1,reg_field2:contact_field2

Where, the reg_field1 is the PlaceOfBirth_c in the Registration View Object which is itself a custom object created in Application Composer.

The contact_field is the PlaceOfBirth field in the Contact View object. This attribute is already present in the Contact object.

So the mapping would be: reg_field1:contact_field1 LIKE BirthPlace_c:PlaceOfBirth