Configure the Address Update OmniScript
To customize the address update request flow, edit the steps of the Change Address OmniScript.
Required Editions
| Available in: Lightning Experience |
| Available in: Professional, Enterprise, and Unlimited Editions |
Update Address
To edit the address update flow, open the OmniStudio app, go to the OmniScripts page, expand the FSCAddressUpdate/CreateRequest OmniScript, and open the latest version.
| Component Name | Component Type | What It Does | What It Calls |
|---|---|---|---|
| SetAccountContext | Integration Procedure | Retrieves the customer community user’s Account Id from Salesforce when the user logs in to a self-service portal and launches the address update service process. It also retrieves the portal’s URL extension and stores it in the CommunityBasePath variable. To let customer community users use the address update service process on a self-service portal, the SetAccountContext component must be present in the FSCAddressUpdate/CreateRequest OmniScript. |
SelfService_SetAccountContext Integration Procedure |
| GetAccountAddresses | Omnistudio Data Mapper Extract | Retrieves the user’s existing addresses. | FSCAddressUpdateAccountDetails Data Mapper |
| NewAddressInformation | Step | Prompts for the user for new address information. | None |
| SetAddressValidation | Set Values | Checks to see if the customer already has an account and an address in the system. | None |
| ConvertAddresses | Remote Action | Reformats the retrieved addresses. | AddressUpdateHelperFunctions class, convertAddresses method |
| ConvertAccounts | Remote Action | Reformats the Financial Account data. | AddressUpdateHelperFunctions class, convertArrayToKeyValuePairs method |
| UpdateRecords | Step | Displays the user’s old addresses and prompts for which one to update. | FSCDisplayCustomerAddressestoUpdate_1_Salesforce and FSCDisplayFinancialAccountsAddressestoUpdate_1_Salesforce LWCs |
| SetAddressList | Set Values | Sets values based on the selected addresses. | None |
| SetAddressSelectionValues | Set Values | Checks to make sure that at least one address is selected. | None |
| SetOneAddressError | Set Errors | Displays an error message if no address is selected. | None |
| ConvertAndMergeAccounts | Remote Action | Merges the new address data into the Financial Account data. | AddressUpdateHelperFunctions class, convertAndMergeAccounts method |
| GetAllDocumentTypesIP | Integration Procedure | Retrieves the document types list. | FSCAddressUpdate_GetDocumentTypes Integration Procedure |
| UploadDocuments | Step | Prompts for address change documents. | None |
| MultipleDocumentsValidationCheck | Remote Action | Checks to see if multiple documents are uploaded. | AddressUpdateHelperFunctions class, ifUploadContainsMultipleFiles method |
| SetOneDocumentError | Set Errors | Displays an error message if two documents of the same type are uploaded. | None |
| ConvertUploadedDocuments | Remote Action | Processes the uploaded documents. | AddressUpdateHelperFunctions class, convertUploadedDocuments method |
| SetAddressListAndUploadedDocs | Set Values | Sets values based on the uploaded documents. | Note |
| Summary | Step | Displays the address change, lists the uploaded documents, and presents a Submit button for the user to confirm the address change. | FSCDisplayCustomerAddresses_1_Salesforce, FSCDisplayAccountLevelAddresses_1_Salesforce, and FSCDisplayUploadedFileNames_1_Salesforce LWCs |
| CallConnectApi | Integration Procedure | Creates a case for the address change. | FSCAddressUpdate_CreateCase Integration Procedure |
| SetConnectAPIResponse | Set Values | Sets values based on the case. | None |
| AddressChangeFinal | Step | Displays the address change again along with a case number. | FSCDisplayCaseConfirmationIcon_1_Salesforce LWC |
