Create a Custom Account Key Field

Use this topic to create a custom Account Key field for Digital Customer Service.

The value of the new Account Key field must be unique to each account and can be set to any value. If the value is set to a string that's easy to guess then someone could guess the value and create for themselves a user account. This is a particular problem if automatic approval is set to true. If the account key is set to a string that is difficult to guess then only those to whom the string is sent can successfully submit a registration request.

End user customers are required to have a known account key. Users must also specify an appropriate account key when they register for a self-service user account.

Multiple tasks must be completed to create a custom Account Key field for Digital Customer Service. To create a custom Account Key field for Digital Customer Service, complete these tasks in the order that they appear in this topic:

1. Add the Account Key to the Account Object

2. Add the Account Key to Pages

3. Populate the Account Key for Existing Accounts

4. Publish the Sandbox

5. Set a Profile Attribute for the Account Key

Add the Account Key to the Account Object

To add a custom field for the Account Key to the Account object, you will need to use the Application Composer in Oracle Fusion Service.

1. Sign in to Oracle Fusion Service as an administrator or a setup user.

2. Create a sandbox for adding the Account Key field:

   1. Click Navigator > Configuration > Sandboxes.

   2. Click the + icon (New) to create the new sandbox.

      The Create Sandbox dialog appear.

   3. Enter a name in the Sandbox Name field.

   4. Click Save and Close.

      A confirmation dialog appears.

   5. In the Manage Sandboxes list, click the line item with the sandbox name that you specified in step c.

   6. Click Set as Active.

3. Navigate to the Application Composer.

4. Expand Objects, then Standard Objects, then Account, and then click Fields.

   The Select Field Type page appears.

5. Click the Action menu, and select Create.

   The Select Field Type dialog appears.

6. Click the Text option, then click OK.

   The Create Text Field page appears.

7. Specify the following for the Account Key text field options:

   • In the Display Label field, enter the following string:

     Account Key

   • 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: You will need to note the value assigned to the API Name field, because it will be assigned to the SVC_CSS_ACCT_KEY_FIELD profile option in the Set a Profile Attribute for the Account Key task, later in this topic.

   • In the Display Type option, click the Simple Text Box option.

   • Deselect the Required option in the Constraints section.

   • Select the Updatable option in the Constraints section.

   • Select the Searchable option in the Constraints section.

   • Select the Include in Service Payload option in the Constraints section.

8. Click Save and Close.

Add the Account Key to Pages

In this task, you will add the Account Key field that you created in the previous task to the necessary pages in the Oracle Fusion Service Application Composer.

1. Sign in to Oracle Fusion Service as an administrator or a setup user.

2. Navigate to the Application Composer.

3. Expand Objects, then Standard Objects, then Account, and then click Pages.

   The Account: Pages page appears.

4. In the Creation Page Layouts section, select a layout to base your page on, such as Standard layout.

5. In the Creation Page Layouts section, click the Actions menu, and select Duplicate.

   The Duplicate Layout dialog appears.

6. Enter a name in the New Layout Name.

7. Click Save and Edit.

8. Click the Pencil icon (Edit) next to FUSE Customer ObjectCreation View.

9. The Creation Layout page appears.

10. From the Available Fields column, click the AccountKey field that you created in the previous task, then click the arrow to move it to the Selected Fields column.

11. Click Save and Close.

12. Click the AccountKey hyperlink, then set the following options on the Edit UI Properties dialog:

    • Set Required to No.

    • Set Updatable to Yes.

    • Set Hidden to No.

13. Click Save and Close.

14. Click Done.

15. In the Details Page Layouts section, click the Actions menu, and select Duplicate.

    The Duplicate Layout dialog appears.

16. Enter a name in the New Layout Name.

17. Click Save and Edit.

18. In the Subtabs Region, click the Profile subtab.

19. Click the Pencil icon (Edit) next to SummaryEdit Summary Subtab.

    The Details Layout Edit Summary page appears.

20. From the Available Fields column, click the Account Key field that you created in the previous task, then click the arrow to move it to the Selected Fields column.

21. Click Save and Close.

22. Click the Account Key hyperlink.

    The Edit UI Properties dialog appears.

23. Set Required to Expression, then click the xyz next to the Required field.

    The Advanced Expression dialog appears.

24. In the Edit Script text box, add the following expression:

    if (SalesProfileType == "ZCA_CUSTOMER") {return true} else {return false}

    Note: This makes the Account Key required if the Account Type is Customer. Self-service registration only works for Customer accounts.

25. Click OK.

26. Set Updatable to Yes.

27. Set Hidden to Expression, then click the xyz next to the Required field.

    The Advanced Expression dialog appears.

28. In the Edit Script text box, add the following expression:

    if (SalesProfileType != "ZCA_CUSTOMER") {return true} else {return false}

    Note: This hides the field if it's not a Customer account type.

29. Click OK.

30. Click Save and Close.

Populate the Account Key for Existing Accounts

If you already have existing Customer accounts, you will need to edit the accounts, and add the required Account Key field.

Note: Make sure to assign unique values to each account.

1. Sign in to Oracle Fusion Service as an administrator or a setup user.

2. Navigate to Accounts.

3. Search for, then click on the account.

   The Edit Account dialog appears.

4. In the Account Key field, enter a value that uniquely identifies the Customer account.

5. Click Save and Close.

6. Repeat steps 3-5 for all previously existing Customer accounts.

Publish the Sandbox

To ensure that the configuration that you applied in the previous tasks takes effect, you must now publish the sandbox.

1. Sign in to Oracle Fusion Service as an administrator or a setup user.

2. Click Navigator > Configuration > Sandboxes.

3. Select the name of the sandbox created in step 2 of the Add the Account Key to the Account Object task.

   The Sandbox Details dialog appears.

4. Click Publish.

Set a Profile Attribute for the Account Key

The account key is used to uniquely identify an account, and is determined by the value assigned to the SVC_CSS_ACCT_KEY_FIELD profile option.

By default, the SVC_CSS_ACCT_KEY_FIELD profile option is set to the organizationName field, which appears as Name of the Account in the Oracle Fusion Service User Interface for account management. You must create an attribute to be the account key: the default account key of organizationName isn't secure because it can be easily guessed.

You must set the SVC_CSS_ACCT_KEY_FIELD profile option to the API Name field of the Account Key created in step 7 of the Add the Account Key to the Account Object task in this topic.