1. Revision History

These pages describe the changes in the branding and packaging for each release of PiPA.

1.1 Changes for Release 3.1.1 – June 30 2017

This version of PiPA includes the following change(s):

– Fixed login caching issues
– Added Primary Sensors modifications
– Added proximity sensor
– Updated accelerometer algorithm with specific logic to reduce false accepts

1.2 Changes for Release 2.0.2 – March 31 2017

This version of PiPA includes the following change(s):

– Optimised Push Notification management for multi-recipe, single sensor environments
– Optimised call state sensor for improved energy management
– Rectified bug in Accelerometer sensor to improve stability

1.3 Changes for Release 2.0.1 – March 29 2017

This version of PiPA includes the following change(s):

– Added Vibration control in PiPA configuration file
– Rectified vibration timing intervals between iOS and Android
– Modified GPS threading for improved energy management
– Added Android light sensor support
– Fixed a bug in scheduler (time) sensor (used by flip to dnd)

1.4 Changes for Release 2.0.0- Dec 15 2016

This version of PiPA includes the following change(s):

– Added XSI URL within app configuration file
– Added ability to enable/disable local notification in PiPA configuration file
– Added show/hide XSI url in PiPA configuration file
– Added support for Estimate beacon technology
– Added support for test/demo mode
– Added support for test mode UI interface option management
– Added support for test mode App Preferences option management

1.5 Changes for Release 1.3.1 – November 15 2016

This version of PiPA includes the following change(s):

– Improved PiPA location sensor algorithm for increased accuracy
– Added support for Kontakt.io beacon technology
– Updated default sensor settings
– Added local notification support
– Added Vibration can now be enabled/disabled

1.6 Changes for Release 1.2.0 – October 19 2016

This version of PiPA includes the following change(s):

– Added ability to change PiPA help url and PiPA online url in PiPA configuration file
– Help now points to pipa.broadsource.com.au/user-guide
– Online center points to pipa.broadsource.com.au
– Added support for Radius Networks beacon technology
– Added BroadWorks Mobility
– Add ad-hoc check for call state in the call pull feature
– Removed call state from recipe to optimise energy consumption
– Updated with new node, npm and cordova-android

1.7 Changes for Release 1.1.3 – September 15 2016

This version of PiPA includes the following change(s):

– Added support for vibration feedback from XSI events
– Added Hoteling support
– Added upload profile photo feature + auto crop
– Added plugins + platforms + events + actions
– Added UI alert when got error from HttpService service
– Added updated templates
– Added script to run in proxy and non proxy modes
– Added dnd to dashboard
– Added call sensor
– Added support for vibration
– Added call state
– Added notification as feedback
– Added local notification

1.8 Changes for Release 1.0.4 – August 15 2016

This version of PiPA includes the following change(s):

– Added multi-criteria Recipe support
– Added sensor reset and sensor polling buttons
– Rectified retention of modified settings when navigating multiple pages
– Fixed api url + missing service
– Fixed login
– Fixed API address
– Fixed promise ui_service+context_service
– Added UI Service
– Added profile UI rules
– Fixed call not forward name
– Fixed call forward busy
– Fixed functions merge
– Fixed a number of state saving errors
– Fixed range gps
– Added profile actions
– Fixed event function
– Updated data upon entry and exit of pages
– Updated controllers
– Set bluetooth ID + gps position + logic code event
– Update recipe conditions
– Renamed flip to orientation
– Removed cyclic dependency
– Fixed profile diversion selection
– Updated condition pages
– Added geolocation
– Added bluetooth event
– Added save bluetooth ID
– Added non-proxy addresses
– Added readme

2. Supported Platforms

The following tables shows the current version of PiPA and the supported mobile phone operating systems.

PiPA Platform Version Supported operating systems
iOS 3.1.1 Apple iOS 9 +
Android 3.1.1 Android 7.0 +

3. Introduction

This deployment guide is to be used by service providers to plan for, package and deliver PiPA to their customers.
There are a number aspects of the PiPA platform that can be customised and localised to the service provider’s environment.

This includes:-
a) Branding and Customisation of the application to suit the service provider
b) Packaging and distribution of the application
c) User Interface presentation options to suit the customer requirements
d) Recipes management
e) BroadWorks XSI

The following sections describe the deployment and customisation options available to the service provider. The decisions made from this document become the inputs required in the PiPA customisation activity that is required for the service provider to deploy to its customers.

4. Branding

The way in which PiPA is visually presented to customers is totally dependant on the Service Providers specific requirements.

In most cases, the Service Provider will elect, as a part of the customisation and localisation project, to rename PiPA and change the way it looks and feels.
To that end, PiPA has many user interface presentation options available for the Service Provider to change.

The following table describes those elements of the application that are brandable.

Item Description Default
Application branding
application_icon 50 x 50 PNG file bsrc_thumb.png
application_splash_screen 1080 x 1917 PNG file bsrc_splash.png
app_background_color RGB BroadSource Red
app_font_color RGB BroadSource Grey
app_toggle_color RGB BroadSource Danger
Page branding
login_screen_logo 50 x 50 PNG file bsrc_logo.png
login_username_title_string max_length: 30 Username
login_username_string max_length: 30 user@serviceprovider.com
login_password_title_string max_length: 30 Password
login_password_string max_length: 30 BroadWorks password
login_button_string max_length: 30 Log in
show_password TRUE/FALSE FALSE
remember_password TRUE/FALSE TRUE
recipe_title_string max_length: 30 Recipes
recipe_myrecipes_string max_length: 30 My Recipes
recipe_onlinerecipes_string max_length: 30 Online Recipes…
dashboard_title_string max_length: 30 Dashboard
dashboard_welcome_string max_length: 30 Welcome FIRST LAST
dashboard_welcome_graphic PNG bsrc_dashboard.png
dashboard_set_home_location max_length: 30 Set current as home location
dashboard_set_office_location max_length: 30 Set current as office location
preferences_title_string max_length: 30 Preferences
ui_preferences_title_string max_length: 30 UI Preferences
app_preferences_title_string max_length: 30 App Preferences
help_title_string max_length: 30 Help
online_userguide_title_string max_length: 30 PiPA Help
online_centre_title_string max_length: 30 PiPA Online Centre
support_title_string max_length: 30 Support
support_email_title_string max_length: 30 Email TAC
support_call_title_string max_length: 30 Call TAC
logout_menu_title_string max_length: 30 Logout

4. Packaging

PiPA aims to simplify the user’s experience and remove, as much as possible, the need for the user to interact with the PiPA interface.
While PiPA is very flexible and has many configuration options, BroadSource recommends that the Service Provider chooses the configuration that best suits their customers and then removes all configuration options as practically possible to simplify the user’s interaction with PiPA.

5.1 Application Preferences

Below are the application preferences available to the Service Provider. The build released for the Service Provider has these preferences set and locked.

Item Description Default
Application Preferences
show_advanced_pages Advanced preferences exposed in UI FALSE
xsi_server URL of Service Providers Xtended Services Platform https://xsi.server.com
pipa_server URL of recipe server http://emu-connect.broadsource.com.au
pipa_help URL of application help files http://pipa.broadsource.com.au/user-guide
pipa_email E-mail address of PiPA support centre pipa@broadsource.com.au
pipa_tac PiPA technical assistance centre number 1300 399 838
Advanced App preferences
prompt_before_activation Have PiPA prompt the user before activating a BroadWorks service FALSE
enable_vibration Have PiPA vibrate to signal an activation and de-activation of a BroadWorks feature TRUE
enable_notification Have PiPA use the mobile phone’s Notification service in response to activations and deactivations FALSE
Sensor preferences
allow_background_mode Allow PiPA to operate in background mode TRUE
polling_interval in milliseconds (100-10000) 250
accelerometer_polling_interval in milliseconds (100-10000) 500
flip_factor Range (1-10) 8.5
shake_factor Range (10-100) 40
bluetooth_polling in milliseconds (1000-10000) 10000
bluetooth_timeout in seconds (1-10) 5
geolocation_polling in milliseconds (100-10000) 500
geolocation_radius in meters (10-1000) 200
geolocation_accuracy in meters (0-1000) 0
geolocation_minimum_distance in meters (1-1000) 1
call_state_polling in milliseconds (100-10000) 1000

5.2 User Interface Preferences

Below are the user interface preferences available to the Service Provider. The build released for the Service Provider has these preferences set and locked.


Item Description Default
User Interface Preferences
show_user_details Show user details in the Dashboard FALSE
show_user_services Show user services available in the Dashboard FALSE
show_recipe_image Show Recipe image in MyRecipes and Online Recipes TRUE
show_recipe_level Show scope of Recipe availability in terms BroadWorks hierarchy FALSE
show_recipe_description Show text based description of Recipe event and action logic TRUE
show_recipe_details Show details and criteria of each Recipe TRUE
Advanced UI preferences
allow_self_care_portal Allow the user to use PiPA to modify BroadWorks services FALSE

6. Recipe Management

PiPA Recipes are at the heart of persona management and reflect how the customer would like their UC service to behave.
Service Providers deploy, onto the customer’s mobile phone, BroadSource developed Recipes or, on request, have Recipes developed by the BroadSource team.

To date, Service providers have needed to educate customers on how each individual feature operates and then how to interact with the BroadWorks platform to make the changes. This approach has proven to be costly with limited success.
Recipes remove the need for the customer to understand how and when to use a UC feature. This complexity is replaced with a simple ‘FLIP’, or ‘SHAKE’ or automatic mobile sensor to trigger the Recipe to change the feature needed at that time.

When successfully implemented, the power of BroadWorks services truely drives increased customer productivity and collaboration.
Great Recipes combine really simple customer experiences with one or a number of powerful BroadWorks features. To that end, today, Recipe creation is the domain of smart Service Provider product managers, who know how to get the best from their BroadWorks feature pack. This allows product managers to sell user experiences, (Recipes) as opposed to selling discrete BroadWorks features.



Different Recipes use one, or a number of the following sensors (EVENTS) in the mobile phone to trigger BroadWorks features and services.

6.1 Sensor Event List


Mobile Phone Sensor Support
The phone’s clock (time and day schedule)
The phone’s calendar status
The Accelerometer to measure the phone’s orientation, velocity and acceleration
The proximity to a BlueTooth Low Energy beacon
Light sensitivity to know whether the phone is in a pocket or not (Android only at this point)
The Call Status. Are you on the phone or not?
The GPS location, in three (3) zones. Office, Home and Other
The Wifi and Mobile Network connection status (home/roaming locations)

More sensors are being added all the time so many combinations of Recipes can be downloaded to trigger a change in the BroadWorks configuration.

A Recipe triggers a BroadWorks ACTION, which is the real time modification to one or a number of the customer’s UC features.
This is implemented via the BroadWorks Xtended Services Interface (XSI), where call control and feature management is supported.

6.2 BroadWorks Action List


UC Feature List
IM&P (presence status)

6.3 Recipe Storage and Distribution

Recipes are stored on a web server within the Service Providers network or at BroadSource and delivered over the Internet.

Default Recipes are selected and/or developed as a part of the PiPA Localisation and Customisation implementation project. These default Recipes are downloaded and activated as a part of the PiPA installation process. These Recipes automatically become the customer’s ‘My Recipe’ list and are operational from the time they are downloaded to the mobile phone.

The Service Provider has full control on what recipes are available to which customers. PiPA Recipe distribution policies follow the BroadWorks Scope of Service models so that the Service Provider can make some Recipes available to all, some to specific Enterprises and even Groups of Users.
Each Recipe is therefore ‘tagged’ with its scope of service and made available at one of the following levels in the BroadWorks system hierarchy.



Recipe Scope Of Service Description
System Level All Recipes are available to all users on the BroadWorks platform
Service Provider Recipes are specific to a Service Provider and all their customers plus any System Level Recipes
Enterprise Recipes are specific to individual Enterprises, plus any Recipes available at the Service Provider and System Level
Group Recipes are specific to individual Groups, plus any Recipes available at the Enterprise, Service Provider and System Level
Users Recipes are specific to individual Users, plus any Recipes available at the Group, Enterprise, Service Provider and System Level

7. BroadWorks XSI

PiPA uses the BroadWorks Xtended Services Interface (XSI) to interact with the subscriber’s service.
This BroadWorks XSI interface allows PiPA to control the subscriber’s telephony experience by supporting various kinds of call control requests.
It is a requirement that the service provider offers the XSI protocol, based on HTTPS, over the internet so that the subscribers mobile phone, using internet data, can interact with BroadWorks.

More information on the BroadWorks XSI interface can be found here. Xtended Services Interface, Interface Specification, Release 21.0

Information related to the configuration and deployment of the BroadWorks XSP can be found here. Xtended Services Platform Configuration Guide Release 21.0