Release Notes

Version 3.1

Ubisense Limited, St Andrew's House, St Andrew's Road, Cambridge CB4 1DL, United Kingdom.

Telephone: +44 (0)1223 535170. Website: http://www.ubisense.net.

Contents
1: Introduction 4
1.1 Intended Audience 4
2: Installation 5
2.1 Supported Browsers 5
2.2 Datasource Concept Added 5
2.3 Layer Type myworld_external Removed 6
2.4 Database Upgrade 6
2.5 Other Changes 6
3: Server 7
3.1 Datasource Concept Added 7
3.2 Layer Model Changed 7
3.3 ArcGIS Support Added 8
3.4 Google and Tilestore Settings Moved 9
3.5 Other Changes 9
4: Client 10
4.1 Search History Added 10
4.2 Bookmark GUI Modified 10
4.3 Layers Tab Enhanced 10
4.4 Layers Now Support Transparency 10
4.5 Phone UI Reworked 11
4.6 Other Changes 11
5: Configuration Pages 12
5.1 Queries Moved to Features Page 12
5.2 New Page Datasources 12
5.3 Layers Page Modified 12
5.4 Settings Page Modified 13
5.5 Replication Page Modified 13
5.6 Other Changes 13
6: Replication 14
6.1 Table Set Definition Now Based on Layers 14

Page ii
 6.2 Table Set Entries Include New Option 'On Demand' 14
6.3 Upload is Now Immediate 14
6.4 Update Supports Feature Mutation 14
6.5 User 'mobile' No Longer Required 14
7: Tools 15
7.1 myw_db command 15
7.2 myw_tilestore command 16
7.3 myw_product command 16
8: Smallworld ETL 17
8.1 Layer Export Modified 17
9: Customization API 18
9.1 External Features now Accessible via Database Object 18
9.2 Support for Native App-specific Code Improved 18
9.3 JavaScript API Modified 18
9.4 Python Controller Naming Scheme Changed 19
9.5 Other Changes 20
10: Documentation 21
11: Upgrading 22
11.1 Upgrading your myWorld server 22
11.2 Upgrading your Smallworld ETL configuration 22
11.3 Post-upgrade actions 22

Page iii
 1: Introduction

1: Introduction
This document provides a summary of the major changes in release 3.1 of myWorld.

1.1 Intended Audience

This document is intended for administrators and customizers with a detailed technical knowledge of
myWorld.

Page 4
 2: Installation

2: Installation
The following changes relate to installation and upgrade.

2.1 Supported Browsers

myWorld 3.1 is supported on the following browsers:
l Internet Explorer (versions 9, 10 and 11).
l Chrome (version 51.0.2704).
l Firefox (version 46.01).
l Safari (version 9.3.2).

2.2 Datasource Concept Added

Data configuration is now based around datasource definitions. A datasource models a source of
geographic data, typically a database server or Web service. The Core installation defines a basic set of
datasources:

Name Type Description

google google Google maps service

bing bing Microsoft Bing map service

myworld myworld The myWorld database

built_in built_in Predefined backgrounds and overlays

mapbox generic_tiles Mapbox OpenStreetMap data server

mapquest generic_tiles AOL Inc free map service

You can (and typically will) add your own definitions modelling your Web-enabled enterprise servers
and other external sources of data.
The database upgrade builds datasource definitions from your layer definitions (and updates your layer
definitions to use them). You should test these migrated definitions carefully after upgrading.
For more details on datasources see Server on page 7.
For details on upgrading, see Upgrading on page 22.

Page 5
2: Installation

2.3 Layer Type myworld_external Removed

In previous releases, the myworld_external layer type was used to create special layers for displaying
master data in the Native Apps, for example to provide an online view of crew locations. This release
introduces a new Native App function master view which allows any layer from the myWorld
datasource to be dynamically switched between local and master view. Layers of type are no longer
required and are therefore dropped by the database upgrade.
For more details on the Master View function, see the Native App Release Notes.

2.4 Database Upgrade

There are data model and other database changes at this release, including:
l Changes to system tables.
l Construction of datasource definitions.
l Migration of database settings.
l Rebuild of feature triggers.
A database upgrade is provided to make these changes. You must upgrade your database using the
myw_db command line tool.
For more details, see Upgrading on page 22.

2.5 Other Changes

Other changes at this release are:
1. The initial definition for user default no longer includes saved application state. This simplifies
configuration of default layer lists and other backstop properties.

Page 6
 3: Server

3: Server
The following server-side changes have been made at this release.

3.1 Datasource Concept Added

As explained above, data configuration is now based around datasource definitions. A datasource
definition consists of a name, type and connection parameters (URL, licence key, username, password,
...). The following datasource types are supported:

Type Description

google The Google maps API

bing The Microsoft Bing API

myworld The myWorld database

built_in Predefined backgrounds and overlays

ogc Geoserver instance or other WMS-compliant server

esri ArcGIS REST server instance

kml KML files or service

generic_tiles Other tile-based web service instance

generic Other datasource-specific leaflet class e.g. L.OWM

Datasources remove the need to duplicate connect spec information across external layer definitions.
They also permit more sophisticated source-specific processing in replication and the Native Apps.
To be valid, a myWorld configuration must contain exactly one myworld and one google datasource
(named myworld and Google respectively).
Datasources and their relationship to layers are described in detail in the Installation and Configuration
Guide.

3.2 Layer Model Changed

A layer definition now consists of a reference to the datasource that supplies its data, together with
presentation parameters specific to that datasource's type. The datasource provides the server
connect spec. The layer parameters identify the data to present and how it will appear.

Page 7
3: Server

The table below show mapping from myWorld 3.0 layer types to myWorld 3.1 types:

Layer Type at 3.0 Layer Type at 3.1

google google

myworld_vector myworld (rendering=vector)

myworld_tile myworld (rendering=tilestore)

myworld_tile_directory myworld (rendering=tile_directory)

myworld_external <no longer required>

wms (geoserver) myworld (rendering=geoserver)

ogc (for non-myworld geoservers)

kml kml

leaflet generic_tiles

blank built_in

custom built_in (for tile ids layer)

bing (for L.bing)
esri (for L.esri)
ogc (for L.WMS)
generic (other)

The Layer configuration page has been re-worked to accommodate the new model, as has the format
of layer definition files (.layer files).
Due to the scale of the changes at this release, the revised .layer file format is not backwards
compatible i.e., it is not possible to load a 3.0 layer definition into 3.1 database.

3.3 ArcGIS Support Added

It is now possible to create external layers displaying data from an ArcGIS REST server.
To do this:
l Define a datasource of type esri.
l Add one or more layers based on that datasource, each displaying a named map from the server.
The datasource type supports selection and search as well as map display.

Page 8
 3: Server

3.4 Google and Tilestore Settings Moved

The following settings are replaced by properties in datasource definitions:
l Settings googleMapsApi and placesAutoCompleteCountry are replaced by properties in the
spec field of the Google datasource.
l Setting tilestore is replaced by a property in the spec field of the myWorld datasource.
The database upgrade automatically migrates these settings for existing databases.

3.5 Other Changes

Other changes at this release are:
1. Geometry field external name: The default external name for field the_geom is now Location,
Route or Boundary (depending on geometry type) rather than The Geom. This value is used in
the client when creating / editing geometry.
2. Controller load errors: Reporting of errors during custom controller load has been improved. In
addition, it is now possible to trace controller loading via the myworldapp logging group in the
.ini file.
3. Geometry indexes modified: Redundant title and short description fields have been removed
from geometry index records. This removed the need to perform a bulk geometry index rebuild
if these feature properties are changed.
4. Search rebuilds reduced: Code for updating feature search definitions now only rebuilds search
indexes for those rules that have changed.
5. Database validation added: The myw_db command line tool now supports basic validation of
layer, datasource, feature and table_set definitions. For more details, see Tools on page 15.
6. Native App-specific applications: It is now possible to declare that a given application should
only be accessible to Native App users (or only to Online users). For more details, see
Configuration Pages on page 12.
In addition, there are various server-side changes relating to table_sets. These are described in the
section Replication on page 14.

Page 9
 4: Client

4: Client
The following changes have been made to the JavaScript application at this release.

4.1 Search History Added

The Search box now remembers the last 10 searches entered. Search history is displayed as a pulldown
list when the search box is empty and has focus.
For more information on searching, see the User Guide.

4.2 Bookmark GUI Modified

The Bookmarks dialog has modified as follows:
1. View definition fields: The Create Bookmark dialog now shows view definition parameters (lat,
lng and zoom) by default. To suppress these fields, set BookmarksPlugin option
showBookmarkDetail to false in your application's JavaScript definition.
2. Back button: The Manage Bookmarks dialog now includes a Back button that returns you to
the Create Bookmark dialog.
3. Set From now sets layers: The Set From button in the Manage Bookmarks dialog now correctly
updates the bookmark's basemap and layers properties (if selected).
For more information on bookmarks, see the User Guide.

4.3 Layers Tab Enhanced

The Layers tab has been extends as follows:
1. Tooltips: Hovering over a layer list item now shows the layer's description and datasource as a
tooltip.
2. Custom control items: It is now possible to configure a custom class for the layer list item
widget. For more details, see the Customization Guide.

4.4 Layers Now Support Transparency

Layer definitions include a new property transparency that can be used to create translucent overlays.
Transparency is supported for all layer types except myWorld (vector).

Page 10
4: Client

4.5 Phone UI Reworked

The Phone layout has been substantially re-worked to improve usability and consistency. Changes
include new login and home pages and revised interaction model for the client. In addition, the client
now supports:
l Creation and editing of feature records (including geometry).
l Customization of toolbar content via the application definition mechanism.
For more details, see the User Guide.

4.6 Other Changes

Other changes at this release include:
1. Measurement tool: The Measurement Tool now preserves unit selections as part of application
state.
2. Feature editor: The Set Geometry button now shows the geometry's external name.
3. Streetview: The Streetview view can now be expanded to fill the entire map window.
4. Related notes: Related note items in the Details pane are now clickable.
5. Layer groups: Changes to layer group content are now reflected automatically the next time a
user starts a session. The user no longers needs to remove and re-add the group to see
changes.

Page 11
 5: Configuration Pages

5: Configuration Pages
The following changes have been made to the configuration pages at this release.

5.1 Queries Moved to Features Page

Queries are now configured from a Queries tab in the feature definition editor (rather than via a
separate Queries page). This change is intended to simplify the user interface and bring all data
relating to a feature type into a single place.
For more details, see the Installation and Configuration Guide.

5.2 New Page Datasources

There is a new page Datasources used to configure datasource definitions. The Edit page provides
items to:
l Enter internal and external names for the datasource.
l Set the datasource type. The remainder of the GUI configures itself based on the type selected.
l Enter connection parameters such as URL and licence key (details depend on datasource type).
Datasource types ogc and esri also provide a Features tab. This tab allows you to download data
dictionary information (feature definitions) from the target server and configure external names,
searches and title expressions.
In order to create an ogc or esri layer, the relevant datasource must have had its data dictionary
information populated. You can safely re-download DD information at any time; your configuration
changes will be merged with any updates from the target server.
For more details on defining datasources, see the Installation and Configuration Guide.

5.3 Layers Page Modified

The Layers page is substantially reworked at this release. Changes relating to the introduction of
datasources include:
1. New property Datasource (replaces property Type).
2. Various new datasource-specific input fields (depend on the type of the selected datasource).
3. The Features tab is now only available for layers of type myWorld.

Page 12
5: Configuration Pages

Other changes are:

4. New property Transparency defining the wash transparency of the layer (in percent).
5. New optional property Control Item Class defining the JavaScript class to be instantiated for
the layer in the client's layer list.
6. Property Visible removed (no longer used).
For more details on defining datasources, see the Installation and Configuration Guide.

5.4 Settings Page Modified

The Settings page has been modified as follows:
1. The Tilestore configuration item on the Basic tab has been removed. This information is now
configured as part of the myWorld datasource definition.
2. The googleMapsApi and placesAutoCompleteCountry settings on the Advanced tab have
been removed. This information is now configured as part of the Google datasource definition.

5.5 Replication Page Modified

The Replication page has been modified as follows:
1. The Table Set editor Features tab is replaced by a Layers tab.
2. Table Set definition entries now include a new checkbox On Demand.
3. The Settings tab no longer shows an entry for Replica ID (no longer required since support for
full stack replication was withdrawn at last release).

5.6 Other Changes

Other changes at this release are:
1. Updating a feature's title or short description no longer provokes rebuild of geom index
records.
2. Updating a feature's searches now only rebuilds index records for the searches that have
changed.
3. The following fields have been renamed in the Searches and Queries tabs:
l Search Val -> Matched Value.
l Search String -> Display Value.

Page 13
 6: Replication

6: Replication
The following changes have been made to myWorld replication at this release.

6.1 Table Set Definition Now Based on Layers

A table set definition now consists of a list of layer names (rather than feature types). Adding a layer to
the table set adds all the feature types associated with that layer. This change is intended to simplify
table set configuration and to support future extensions to replication.
The database upgrade does not attempt to convert existing feature type lists to layers since no
unique mapping exists. Instead, you will need to set layer lists for any existing table sets manually after
the upgrade has run (see Upgrading on page 22).

6.2 Table Set Entries Include New Option 'On Demand'

Table Set entries now include a new option On Demand. This relates to the new On-demand Extraction
feature. Layers and tile files declared as On Demand are not included in the extracted database but
can be obtained by the user in a subsequent server snapshot request.
For a full description of On-demand Extraction, see the Replication and Offline Working Guide.

6.3 Upload is Now Immediate

Changes uploaded by the Native Apps are now applied to the master database immediately (rather
than having to be imported by a separate myw_db import command).
You no longer need to include an import job as part of your replication configuration.

6.4 Update Supports Feature Mutation

The myw_db update command, used to re-align extract databases, now supports feature mutation.
This removes a limitation introduced in release 3.0.

6.5 User 'mobile' No Longer Required

It is no longer necessary to define a special user for use by offline users. Instead, offline users are
granted permissions based on their myWorld Online credentials as part of the new Native App
Database Initialization process.
For more details on Database Initialization see the Native App Installation and Configuration Guides.

Page 14
 7: Tools

7: Tools
The following changes relate to the command line tools.

7.1 myw_db command

The following changes have been made to the basic myw_db operations at this release:
1. Operation load: Unknown feature types in layer definition are no longer fatal (now skipped with
warning instead).
2. Operation load: A non-unique code in layer definition is no longer fatal (now skipped with
warning instead).
3. Operation load: The format of .layer files has changed significantly. Property type is replaced by
datasource and the content of the spec field is entirely revised.
4. Operations dump/load/list: Now support a new option datasources and a new file format
.datasource.
5. Operation list features --full: Output now includes a query count.
6. Operation list --layout csv: Output no longer truncates long strings.
7. Operation list layers --full: Output now includes layer type and feature count.
8. Operation list usage --start and --end: Date specifiers no longer require a time component
when using --by hour.
9. Operation list usage --by: Supports new option --by user which list the names of the users who
have accessed the system.
10. New operation validate for checking configuration integrity.
In addition, the following replication-related operations have been modified:
11. Operation extract: Tables user and user_role are no longer populated in extracts. Instead,
authorization information is populated dynamically after download by the new Native App
database initialization functionality.
12. Operation extract: Spatial extracts no longer extract records with null geoms. This brings the
operation into line with the export function.
13. Operation update: Now supports feature mutation.
14. Operation update: Now vacuums the database before re-packaging (and only repackages if
anything changed).
For more details, use:
myw_db <db_name> <operation> --help

Page 15
7: Tools

7.2 myw_tilestore command

There are no changes to the myw_tilestore command at this release.

7.3 myw_product command

There are no changes to the myw_product command at this release.

Page 16
 8: Smallworld ETL

8: Smallworld ETL
The following changes have been made to the myWorld ETL for Smallworld component at this
release.

8.1 Layer Export Modified

The format of the files generated by the layer definition export function has been updated to reflect
changes to the .layer file format.

Page 17
 9: Customization API

9: Customization API
The following changes have been made to the customization API at this release.

9.1 External Features now Accessible via Database Object

The database API now supports access to external datasources. For example:
l Perform a spatial scan over all datasources:
database.select(point,zoom,layers,...)

l Retrieve a pole feature from the esri01 datasource:

database.getFeature("esri01/map1:pole",27)

l Access the esri01 datasource explicitly:

database.getDatasource("esri01").getFeature("map1:pole",27)

If the datasource qualifier of the featureType parameter is omitted, it defaults to myworld.

For more details, see the JS API Documentation.

9.2 Support for Native App-specific Code Improved

JavaScript support writing Native App specific code has been enhanced as follows:
l There is a new global property myw.isNativeApp that can be used to determine if code is running
in the Native App
l Plugin instantiation can now be made conditional by subclassing static property forOnlineAppor
forNativeApp. This avoids the need to create separate JavaScript application definitions for
online and offline use.
l Application availability is similarly conditional based on definition record attributes for_online_
app and for_native_app. These permits the definition of different layer lists for online and offline
applications.
For more details, see the Customization Guide.

9.3 JavaScript API Modified

The following non-backwards compatible changes have been made to the JavaScript API:
1. Database: Methods for retrieving configuration information and other non-feature data
related tasks are moved to a new class myw.System. An instance of this class is available via the
application object, for example app.system.getSettings().

Page 18
9: Customization API

2. Database: Method layerExternalRequest(layerId, requestParams) is replaced with

tunnelDatasourceRequest(dsName, requestParams, options).
3. Database: Method runQueryWithId() is removed. Use runQuery(queryDetails, bounds,
polygon) instead.
4. Database: Method getDDInfoFor() now only accepts a list of types.
5. Database: Method selection() has been renamed select() and the order of its parameters has
changed.
6. Database: Method getFeaturesAround now accepts a list of feature types instead of a single
feature type.
7. Application: Definition option Geocoder is replaced with geocoderDatasourceName.
8. LayerManager: Method createLeafletLayer() is removed. Use the equivalent method in
myw.Application instead.
9. LayerManager: Method getVisibleLayerIds() has been removed. Use
MapControl.getVisibleLayerIds() or LayerManager.getVisibleLayers() instead
10. Google: Code that requires google should now use the promise
app.getDatasource('Google').initialized, instead of the promise from
myw.googleMapsLibrary.load(). This ensures that the datasource configuration is correctly
applied.
For more details, see the JS API Documentation.

9.4 Python Controller Naming Scheme Changed

The following changes affect custom controllers:
1. The file naming convention for controller classes has changed; the file name should now match
that of the class it contains. For example a controller NetTraceController would now be stored
in source file:
server/controllers/net_trace_controller.py

rather than:
server/controllers/net_trace.py

2. The following core class has been renamed:

BaseController -> Controller
If you have custom controllers, you will need to update them for these changes.

Page 19
 9: Customization API

9.5 Other Changes

Other changes at this release are:
1. myWorld Title for external features: You can now specify a title expression for external objects
without having to register a model (see the Features tab on the Datasource configuration
page).
2. Custom layer list control items: You can now provide a custom class for a layer's client layer list
entry. This can be used to implement filtering and other dynamic control of layer rendering. See
the property Control Item Class on the Layer configuration page.
3. Custom myWorld layer classes: You can now provide a custom class for instantiating any layer
myWorld layer (not just vector layers). This can be useful for adding behavior not supported by
the core system. See the property JavaScript Class on the Layer configuration page.
4. Code minification: It is now possible to minify code that includes requirejs paths and shim
configuration. This is achieved via a new optional file require.config.json in your module
definition.
These features are described in more detail in the Customization Guide.

Page 20
 10: Documentation

10: Documentation
The documentation set has been updated to reflect the new features described above.
In addition:
l The Installation and Configuration Guide has be reorganized and extended to include more
information on datasources and external layers.
l The Replication and Offline Working Guide has a new section describing on-demand extraction.
l The Customization Guide has been extended to cover creation of custom layer control items and
other new customization hooks.
l The documentation set now includes a file Third Party Software Licences.pdf that lists the public
domain libraries used by the Core product and their licensing constraints.

Page 21
 11: Upgrading

11: Upgrading
This section provides an overview of the upgrade process for this release.

11.1 Upgrading your myWorld server

Upgrading your myWorld server installation involves:
1. Installing the myWorld software.
2. Porting your customizations.
3. Upgrading your database.
These steps are described in more detail in the Installation and Configuration Guide.
To upgrade your database use:
myw_db <db_name> upgrade core 310

There are server-side post-upgrade configuration steps at this release - see below for details.

11.2 Upgrading your Smallworld ETL configuration

Upgrading your myWorld ETL for Smallworld installation involves:
1. Installing the software.
2. Updating your images.
These steps are described in detail in the ETL for Smallworld Guide.
You may need to perform some ETL post upgrade configuration steps at this release (see below).

11.3 Post-upgrade actions

After upgrading your database you should:
1. Check upgrade warnings: Review the output from the database upgrade for warnings from the
build_datasources step. Depending on the nature of the problem, you may need to manually fix
up the layer definition named in the warning message.
2. Check datasource definitions: Using the Datasources configuration page (or myw_db list
datasources command), review the datasource definitions created by the migration. You may
wish to modify the external names and descriptions chosen by the upgrade.

Page 22
11: Upgrading

3. Check layer definitions: Using the Layers configuration page (or myw_db list layers --full
command) check that the migrated layers have been mapped to an appropriate datasource
and given the expected properties. You should also check that the migrated external layers
display as expected in the client.
4. Configure Always Master layers: If your original database contained layers of type myworld_
external, they will have been discarded by the upgrade (see Server on page 7). You may wish to
set its Native App View property of the corresponding myWorld layer to Always Master. This
will force the Native App to always display the master view of the data (as per myworld_
external).
For more details on the Native App View property, see documentation of the Master View
feature in the Native App Installation and Configuration Guides.
5. Fixup table sets: If your original database contained tables set definitions, you will need to
populate the layer list for each definition using the Replication configuration page (see
Replication on page 14).

Page 23
Copyright © 2016, Ubisense Limited 2010 - 2016. All Rights Reserved. You may not reproduce
this document in whole or in part without permission in writing from Ubisense at the
following address:
Ubisense Limited
St Andrew’s House
St Andrew’s Road
Cambridge CB4 1DL
United Kingdom
Tel: +44 (0)1223 532670
Fax: +44 (0)1223 535167
E-mail: [email protected]
WWW: http://www.ubisense.net
All contents of this document are subject to change without notice and do not represent a
commitment on the part of Ubisense. Reasonable effort is made to ensure the accuracy of
the information contained in the document. However, due to on-going product
improvements and revisions, Ubisense and its subsidiaries do not warrant the accuracy of
this information and cannot accept responsibility for errors or omissions that may be
contained in this document.
Information in this document is provided in connection with Ubisense products. No license,
express or implied to any intellectual property rights is granted by this document.
Ubisense encourages all users of its products to procure all necessary intellectual property
licenses required to implement any concepts or applications and does not condone or
encourage any intellectual property infringement and disclaims any responsibility related
thereto. These intellectual property licenses may differ from country to country and it is the
responsibility of those who develop the concepts or applications to be aware of and comply
with different national license requirements.
Windows® is a registered trademark of Microsoft Corporation in the United States and/or
other countries. The other names of actual companies and products mentioned herein are
the trademarks of their respective owners.