Working with the Test Environment

The test environment for SmarterWX Sentinel is available for members and users of the BYDA Referral Service to perform technical integration testing. New features are often released to the test environment before being rolled out to the live production system.

You can access the test environment here: https://swx-sentinel-uat.smarterdbyd.com/. The user credentials in the test environment are separate from those used in the live production system – you can sign-up for a new account, recover your password etc following the standard workflows.

Receiving Referrals

Important note: All existing member configurations will be removed from the test environment on 24th October 2023. If you require member access to the test environment, please contact our help desk team including the following details: Member Name, Utility ID, Administrator Email Address.

To be added as a member in the test environment, you must request this access from the BYDA help desk. Once completed, you will see the member admin functions when you login to the test environment.

To receive referrals you must complete the configuration steps: –

  1. Setup your area of interest (AOI). The area of interest tells SmarterWX Sentinel when an enquiry should be passed to you as a referral. The easiest way to setup your AOI is to sketch a region – accuracy isn’t important given that this is only a test environment.
  2. Configure your referral channel. The referral channel tells SmarterWX Sentinel how an enquiry should be passed to you as a referral. Referrals can be sent by email, web hook, or handled by the BYDA automation service (SmarterWX Automate).

Once you’ve setup your area of interest and configured your referral channel, you can go ahead and lodge an enquiry inside your AOI and you’ll receive a referral. Other users in the test environment may also be lodging enquiries in your AOI, so be prepared to receive referrals that you might not be expecting!

To strictly limit referrals to only those created by you, you can use the Sandbox Mode which enables a private referral channel. Sandbox mode allows you to lodge enquiries that are handled by your draft referral channel configuration.

Lodging Enquiries

Any user can sign-up and create a basic account in the test environment. This will allow you to perform all the usual enquirer functions such as lodging enquiries, working with the API, searching your enquiry history and so on.

It should be noted that there are far fewer members (asset owners) setup in the test environment and it’s possible that your enquiry will only trigger a small number of referrals (or even zero in some locations). Also, members may not have linked the test environment up to an automated response system, so don’t expect to receive responses to all of the referrals for your enquiries.

API Access

The root path for the test environment API is: https://swx-sentinel-uat.smarterdbyd.com/api/.

API access keys need to be created in the test environment. Access keys from the live production system will not work in the test environment.