|
|
(3 intermediate revisions by 2 users not shown) |
Line 1: |
Line 1: |
− | {{DISPLAYTITLE:Auto Populating Addresses in Sign Up Orders}}
| + | =This Content Has Moved House= |
− | = Overview = | |
− | This feature provides the ability to populate all, or parts of an address used in an orders for that agent that come through the Sign Up Portal. This may be useful when agents selling your products and services are limited to a specific region or area and parts of an address are always going to be the same when the order is received.
| |
| | | |
− | This feature supports standard and complex addresses only. Unstructured addresses are not supported. | + | This article has been moved to our new home for documentation and help content, the new Emersion Knowledge Base. |
| | | |
− | This feature is optional and is not included with either the [[Agent Management|Agents]] module or the [[End_User_Portal_and_Customer_Sign_Up_Portal|Sign Up Portal]] by default. If you would like to subscribe to this feature, please contact Emersion Sales.
| + | We are sorry for the untidiness while we are shifting locations and we appreciate your patience during the transition to our new home. |
| | | |
− | == Prerequisites ==
| + | [https://resources.emersion.com/display/EKB/Configure+Auto-Populating+Addresses+in+the+Sign+Up+Portal Take me to the Emersion Knowledge Base article] |
− | The following prerequisites apply before you can use this feature
| |
| | | |
− | * A subscription to the [[Agent Management|Agents]] module
| + | [[file:new_home_sm.jpg|900px]] |
− | * An instance of the Emersion [[End_User_Portal_and_Customer_Sign_Up_Portal|Sign Up Portal]].
| |
− | * [[Service_Types|Service types]] that use an [[Services/Orders/Address-based_Service_Qualification|address-based SQ]]
| |
− | * A correctly configured Agent account under your Retail Service Provider Account.
| |
− | * A unique '''Agent Code''' saved in the ''Org Unit'' of each Agent account where address fields will be populated.
| |
− | * A site address is saved against the Agent Account and one is marked as ''default''.
| |
− | The ability to pass the Agent Code to the Sign Up Portal via a parameter in the URL.
| |
− | | |
− | == Address Types and Fields ==
| |
− | The following address fields can be populated in the sign up portal automatically.
| |
− | | |
− | * Building Name
| |
− | * Unit Type
| |
− | * Unit Number
| |
− | * Level Type
| |
− | * Level Number
| |
− | * Site Name
| |
− | * Street Number
| |
− | * Street Name
| |
− | * Street Type
| |
− | * Suburb
| |
− | * Postcode
| |
− | * State
| |
− | * Country
| |
− | | |
− | Any fields that are not populated in Cumulus remain blank for the sign up user to complete themselves as per any other order.
| |
− | | |
− | == Configuration ==
| |
− | The sections below contain the steps on how to configure the feature.
| |
− | | |
− | === Add an Agent Code to the Agent's Org Unit ===
| |
− | Log in to your Retail Service Provider Account
| |
− | | |
− | Nav: '''Admin > Org Unit & Roles > Org Unit'''
| |
− | | |
− | # Search for the Org unit that belongs to the Agent.
| |
− | # Click on the ID to open the Org Unit
| |
− | # Enter a unique code for the agent in the '''Org Unit / Agent Code''' field. Use only alphanumeric characters.
| |
− | | |
− | While Cumulus allows users to enter any text string into the '''Org Unit / Agent Code''' field, this feature uses the agent code in the sign up portal URL. Emersion will not support unsafe characters. [https://perishablepress.com/stop-using-unsafe-characters-in-urls/ Refer to this article] for a chart showing safe/unsafe characters. If you are not sure, use only letters, numbers and underscores and your resultant URL will always be safe.
| |
− | | |
− | === Construct a Sign Up URL for your Agent's Orders ===
| |
− | Once you have an Agent Code, you can create a URL that includes the agent code. By 'passing in' the agent code to the Sign Up portal, the system knows who the agent is, and the order will always be attributed to the agent in the same way as if the agent had logged into Cumulus and placed the order themselves.
| |
− | | |
− | The format of the URL is as follows:
| |
− | | |
− | <nowiki>
| |
− | https://yoursignup.yourname.com.au?agent_code=xxxxxx
| |
− | | |
− | -- where xxxxxx = agent code
| |
− | </nowiki>
| |
− | | |
− | If the agent code is passed into the Sign Up Portal, the order will always be attributed to the agent, regardless of whether address population is configured.
| |
− | | |
− | === Add an Address (site) to the Agent ===
| |
− | Once the previous steps are complete, users need to configure the address fields that will be populated in the Sign Up Portal.
| |
− | | |
− | Nav: '''Customer > Customer List'''
| |
− | | |
− | Search for and locate the agent's customer account.
| |
− | Click on the ID of the account to open the Customer Screen.
| |
− | Click on the '''Sites''' tab.
| |
− | | |
− | [[file: Customer-sites.png|1200px|Customer > Sites screen]] | |
− | | |
− | This page supports multiple addresses, but only one can be used to populate fields in the Sign Up Portal. The ''default'' address will be used in the sign up portal.
| |
− | | |
− | # Click on the '''Add New Site''' button to add a new address.
| |
− | # Ensure the '''Set As Default Site''' is enabled.
| |
− | # Complete the fields that will be populated in the sign up portal.
| |
− | # Press '''Save''' when you are done.
| |
− | | |
− | Address fields in the Sign Up Portal that are not populated will need to be completed by the user during the order.
| |
− | | |
− | === Test URL ===
| |
− | Open a web browser and test the URL that was created in the second step above. Proceed through the order to ensure address fields populated in Cumulus are populating in the address-based SQ.
| |
− | | |
− | = Web Page Comparisons =
| |
− | Below are side-by-side comparisons of standard and unstructured addresses once the system is configured correctly. These are your expected results.
| |
− | | |
− | {| class="wikitable" style="border-style: solid; border-width: 1px 1px 1px 1px; margin-left: auto; margin-left: 0px;"
| |
− | !colspan="2"|Complex Address
| |
− | |-
| |
− | | Cumulus
| |
− | | Sign Up Portal
| |
− | |-
| |
− | | [[File: Complex-address-in-cumulus.png|400px|xx]]
| |
− | | [[File: Complex-address-in-signup.png|800px|xx]]
| |
− | |}
| |
− | | |
− | | |
− | {| class="wikitable" style="border-style: solid; border-width: 1px 1px 1px 1px; margin-left: auto; margin-left: 0px;"
| |
− | !colspan="2"|Standard Address
| |
− | |-
| |
− | | Cumulus
| |
− | | Sign Up Portal
| |
− | |-
| |
− | | [[File: Standard-address-in-cumulus.png|400px|xx]]
| |
− | | [[File: Standard-address-in-signup.png|800px|xx]]
| |
− | |}
| |
This article has been moved to our new home for documentation and help content, the new Emersion Knowledge Base.
We are sorry for the untidiness while we are shifting locations and we appreciate your patience during the transition to our new home.