To enable the Emerald EMS integration in your Dataforce ASAP instance, your system must first be configured correctly. The instructions below outline the steps required to configure you system to enable the Emerald EMS integration.
Prerequisites
- You must have the IHD Activity (Activity 30) configured in your system.
Step 1: Prepare your system for the Emerald EMS integration
Before Emerald EMS integration can be turned on, there are a few preparation steps that must be completed.
-
Refer to the image below and ensure that all questions highlighted in red, exist for your IHD work types
For details on managing questions, please refer to the following pages:
Required Questions
Question | Input Type | Answers |
---|---|---|
Electrical Meter Number | Barcode (Single) | N/A |
IHD Serial Number | Number | N/A |
What is the customers energy tariff structure? | Radio | Flat Rate, Peak / Off-peak |
- Customers energy rate (in $ per kW) | Number | N/A |
- Customers off-peak energy rate (in $ per kW) | Number | N/A |
- Customers peak energy rate (in $ per kW) | Number | N/A |
Meter LED Pulse / Flash rate: | Radio | 800, 1000, 3200, 1600, Other |
Other Flash rate: | Number | N/A |
Meter LED Pulse / Flash rate Units: | Radio | imp/kWh, imp/unit, Wh/imp |
Optional Questions
Question | Input Type | Answers |
---|---|---|
Customer’s Distribution Network Service Provider (DNSP) name? | Select | List of distributors |
Customer’s electricity retailer? | Select | List of retailers |
Customers NMI Number? | Number | N/A |
Step 2: Obtain your agency ID
- Login to the Emerald EMS dashboard at https://admin.emerald-ems.com.au/login
- Click on Profile in the left-hand side navigation bar
- Copy your Agency ID
Step 3: Enable the Integration
- In Dataforce ASAP, navigate to (Configuration icon) Integrations Integration Settings
- Click on the Configure button in the Emerald EMS integration
- The integration settings window will open, toggle the integration to the On position
- Enter the Agency ID that you copied in step 3 into the Agency ID field
- Map each of the parameters to the matching question
Important: For the Impulse Rate Question, ensure you map both the *Meter LED Pulse / Flash rate’ question and the ‘Other flash rate’ question
- After mapping all questions, your screen should look like this:
- Click the Save Settings button to save the integration settings
Step 4: Configure a new tab on Runabout
Before Runabout users will be able to complete appointments using the new Emerald EMS integration you will need to configure a new tab in Runabout for each work type that you will be using for IHD installations
- In Dataforce ASAP, navigate to (Configuration icon) Runabout
- In the Select work type to configure field, select the work type you wish to configure
- Click the Add New Tab button
-
Configure the tab as per below:
Field Value Tab Name Emerald EMS Registration Sort Value Enter a sort value so that the tab is positioned after the question tab with the IHD related questions Status Active Tab Type Web View Runabout data access Yes Authentication Method AWS JWT Authorisation Context Emerald EMS Requires Full Validation No Web View URL https://production-ap-southeast-2.ams.asap.dataforce.services/ui/emeraldplanet/index.html - Click Save Changes
- Click Publish Changes
- Repeat steps 1 to 6 for each work type that will be used for IHD installations
Completing an IHD installation with Emerald EMS integration enabled
After completing the setup above, complete a test appointment in Runabout by following the instructions in the video below
Appendix
List of distributors
- Citipower
- Jemena
- Powercor
- United Energy United Energy Distribution
List of retailers
- Aest Retailer
- AGL
- Aurora Energy
- Elysian Energy Pty Ltd.
- Energy Locals Pty Ltd
- EnergyAustralia
- Origin Energy Electricity
- Powershop Australia - authorised electricity retailer
- Red Energy
- Simply Energy
- Vansh Electricity Retailers
- 1st Energy Pty Ltd
- 3P Energy Pty Ltd - application for electricity retailer authorisation
- ActewAGL Retails ravo
- Active Utilities Retail Pty Ltd - authorised electricity retailer
- Aest Retailer
- AGL
- Alinta Energy Retail Sales Pty Ltd
- Amaysim Energy Pty Ltd
- Amber Electric Pty Ltd
- Arc Energy Corporation Pty Ltd
- Aurora Energy
- Balance Commodities and Energy Pty Ltd
- Blue NRG
- Bright Spark Power Pty Ltd
- CleanCo Queensland Limited
- CleanPeak Energy Retail Pty Ltd
- CleanTech Energy Pty Ltd
- Cogent Energy
- Cova U Pty Ltd
- CPE Mascot Pty Ltd
- CS Energy
- Diamond Energy
- Discover Energy Pty Ltd
- Dodo Power & Gas
- EDL Retail
- ElectrAg Pty Ltd
- Electricity in a Box Pty Ltd
- Elysian Energy Pty Ltd.
- Energy Locals Pty Ltd
- Energy On Pty Ltd
- EnergyAustralia
- EnergyAustralia Yallourn (formerly TRUenergy Yallourn)
- Enova Energy Pty Ltd
- Ergon Energy Queensland
- ERM Power Retail
- Evergy Pty Ltd
- EZI Power Pty Ltd
- Flow Power
- Flow Systems Pty Ltd
- Future X Power
- GEE Power & Gas Pty Ltd
- GloBird Energy Pty Ltd
- Hanwha Energy Retail Australia Pty Ltd
- Humenergy Group Pty Ltd
- Infigen Energy Holdings
- Infigen Energy Markets
- International Power (Retail)
- Locality Planning Energy
- Localvolts Pty Ltd
- Macquarie Bank Limited
- Metered Energy Holdings
- Microgrid Power Pty Ltd
- Mojo Power Pty Ltd
- Momentum Energy
- MTA Energy Pty Ltd
- Neighbourhood Energy
- Next Business Energy Pty Ltd
- OC Energy Pty Ltd
- Origin Energy Electricity
- OVO Energy Pty Ltd
- OzGen Retail
- People Energy
- Pooled Energy
- Positive Energy TM Pty Ltd
- Power Club Limited
- Powerdirect
- PowerHub Pty Ltd
- Powershop Australia
- Powershop Australia - authorised electricity retailer
- QEnergy
- Radian Holdings Pty Ltd
- Real Utilities Pty Ltd
- ReAmped Energy Pty Ltd
- Red Energy
- Rush Energy Pty Ltd
- Sanctuary Energy
- Savant Energy Power Networks Pty Ltd
- Simply Energy
- Smart Energy Retail Pty Ltd
- SmartestEnergy Australia Pty Ltd
- Social Energy Australia Pty Ltd
- Stanwell Corporation
- Starcorp Energy Pty Ltd
- Sumo Power Pty Ltd
- Sun Retail
- Sustainable Savings Pty Ltd
- Tango Energy Pty Ltd
- The Embedded Networks Company Pty Ltd
- Tilt Renewables Australia Pty Ltd
- Total Gas & Power Australia Pty Ltd
- Vansh Electricity Retailers
- WINconnect Pty Ltd
- Y.E.S. Energy (SA) Pty Ltd