Revision as of 15:30, 23 November 2016

Overview

Service providers who use the Emersion Sign Up Portal and the Agents module have the ability to populate all, or parts of an address used in an orders for that agent. This may be useful when agents selling your products and services are limited to a specific region or area and some fields are always going to be the same.

This feature is optional and is not included with either the Agents module or the Sign Up Portal by default. If you would like to subscribe to this feature, please contact Emersion Sales.

Prerequisites

The following prerequisites apply before you can use this feature

A subscription to Agent module and an instance of the Emersion Sign Up Portal. Active and correctly configured Agent accounts 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

This feature supports standard and complex addresses only. Unstructured addresses are not supported.

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

1. Search for the Org unit that belongs to the Agent.
2. Click on the ID to open the Org Unit
3. 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. 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:

https://yoursignup.yourname.com.au?agent_code=xxxxxx -- where xxxxxx = agent code

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.

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.

1. Click on the Add New Site button to add a new address.
2. Ensure the Set As Default Site is enabled.
3. Complete the fields that will be populated in the sign up portal.
4. 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.