Release Notes 260
Release Notes 260
Release Notes
________________________________________________________________________________
2.6
Ubisense myWorld Release Notes
Contents
1 Introduction ........................................................................................................................ 4
1.1 Intended audience ...................................................................................................................... 4
2 Installation ......................................................................................................................... 5
2.1 Product structure modified .......................................................................................................... 5
2.2 Data model install localised ........................................................................................................ 5
2.3 Default configuration modified .................................................................................................... 5
2.4 Database upgrade ...................................................................................................................... 5
3 Server ................................................................................................................................ 7
3.1 Authorisation configuration modified........................................................................................... 7
3.2 Feature model extended ............................................................................................................. 7
3.3 Internals model re-worked .......................................................................................................... 7
3.4 CSV now default file format ........................................................................................................ 8
3.5 Layer groups added .................................................................................................................... 8
3.6 External search added ................................................................................................................ 8
3.7 New layer type myWorld External ............................................................................................... 9
3.8 Partial replication added ............................................................................................................. 9
3.9 Module structure modified .......................................................................................................... 9
3.10 Other changes .......................................................................................................................... 10
4 Client ............................................................................................................................... 11
4.1 Internals viewer enhanced ........................................................................................................ 11
4.2 Layer groups supported ............................................................................................................ 11
4.3 Search enhanced ...................................................................................................................... 11
4.4 Phone layout re-instated ........................................................................................................... 11
4.5 Other changes .......................................................................................................................... 12
5 Configuration pages ......................................................................................................... 13
5.1 Features page modified ............................................................................................................ 13
5.2 Layers page extended .............................................................................................................. 13
5.3 Applications page extended ...................................................................................................... 13
5.4 Replication page extended ....................................................................................................... 13
5.5 Other changes .......................................................................................................................... 14
6 Tools ................................................................................................................................ 15
6.1 myw_db command enhanced ................................................................................................... 15
6.2 myw_tilestore command ........................................................................................................... 16
7 Smallworld ETL................................................................................................................ 17
7.1 Glue methods changed ............................................................................................................. 17
7.2 Internals transform changed ..................................................................................................... 17
Page 2 of 26
Ubisense myWorld Release Notes
Page 3 of 26
Ubisense myWorld Release Notes
1 Introduction
This document provides a summary of the major changes in release 2.6 of
myWorld.
Page 4 of 26
Ubisense myWorld Release Notes
2 Installation
The following changes relate to installation and upgrade.
A database upgrade is provided to make these changes. You must upgrade your
database using the myw_db command line tool.
See Upgrading for more details.
Page 6 of 26
Ubisense myWorld Release Notes
3 Server
The following server-side changes have been made at this release.
Page 7 of 26
Ubisense myWorld Release Notes
Internals worlds are grouped into world types depending on the kind of
drawing they represent. For example, a telecoms database might have
world types floorplan, terminal enclosure, rack front view and rack back
view.
Each world type has an associated layer definition that controls rendering
and selectability when the world is displayed. Rendering can be via tiles or
vectors. The association between the layer and its world type is made
using the layer definition category field.
The old internals model based on a myw_internal_world_view field and a single
Internals layer is still supported but is no longer recommended. If you use internals,
you should consider migrating to the new internals model at this release. Contact
Ubisense support for details of the migration process.
The new internals model is described in detail in product documents myWorld ETL
for Smallworld and Installation & Configuration.
The myw_db command continues to support dump and load of JSON files and the
server REST interface continues to use GeoJSON for feature data exchange.
Note, however, that these use a myWorld-specific extension to the GeoJSON
format to represent features with secondary geometries (since the GeoJSON
standard does not support multiple geometries).
You should consider moving you ETL feature export to CSV at this release.
Page 8 of 26
Ubisense myWorld Release Notes
autocomplete suggestions. Selecting the item causes the query to be sent to the
external system and its results displayed in the Details tab.
To enable search for an external layer, add a Datasource parameter in your layer
definition. This can be done using the Layers configuration page. See help text on
that page for more details.
Note: The Datasource parameter was called Select Spec in previous releases.
Page 9 of 26
Ubisense myWorld Release Notes
3. The custom module must now contain a version_info.json file in its root
directory. This file is used in the construction of a 'bust' string for
JavaScript caching. See Client re-caching supported below for more
details.
You may need to update your custom module for these changes.
Page 10 of 26
Ubisense myWorld Release Notes
4 Client
The following changes have been made to the JavaScript application at this
release.
Page 11 of 26
Ubisense myWorld Release Notes
Note: Since previous versions of the client did not include a 'bust'
mechanism, users may still have to clear their cache manually when
moving to myWorld 2.6
Page 12 of 26
Ubisense myWorld Release Notes
5 Configuration pages
The following changes have been made to the configuration pages at this release.
Page 13 of 26
Ubisense myWorld Release Notes
Page 14 of 26
Ubisense myWorld Release Notes
6 Tools
The following changes relate to the command line tools.
8. When using operation load to import feature data from JSON, fields with
a value null in the JSON file are now set to NULL in the database. (In
previous releases such fields were set to their default value, which could
lead to unexpected behaviour.)
In addition, the following replication-related operations have been modified.
9. Operation extract takes new optional parameters table_set and name.
These are used in partial replication.
10. Operations export and import now export feature data as CSV (rather
than JSON).
11. Operation import now supports import of updates from a single replica
(or set of replicas) via a new optional argument replica.
12. Operation import now only checks for updates from 'live' replicas. This
can improve performance if you have a large number of terminated
replicas in your master database.
13. Operation list replicas --full now includes information on shard
usage and most recent download for each replica.
For more details use --help for the operation of interest.
Page 15 of 26
Ubisense myWorld Release Notes
Page 16 of 26
Ubisense myWorld Release Notes
7 Smallworld ETL
The following changes have been made to the myWorld ETL for Smallworld
component at this release.
3. Withdrawn methods: The following glue methods are now obsolete (are
replaced by parameters in your internals layer definitions):
myw_internal_tiling_config
myw_internal_world_ace_name
myw_internal_world_buffering_factor
myw_internal_world_max_scale
myw_internal_world_min_scale
To avoid confusion, Ubisense recommend removing the obsolete glue
methods from your configuration.
Product document myWorld ETL for Smallworld explains the signatures and use of
all glue methods in detail. It also contains a new section dealing specifically with
the process of exporting internals data. Section Upgrading below explains the
minimum steps required to port you ETL configuration at this release.
Page 17 of 26
Ubisense myWorld Release Notes
If you are upgrading from a previous release you will need to re-export all your
internals features and tiles for this change. Alternatively, you can revert to the 2.5
formula by setting the following shared variable in your glue code or image build:
myw_etl_settings.internal_world_origin_method << :geometry_bounds
See section 4.3 of product document myWorld ETL for Smallworld for more details
on this setting.
Page 18 of 26
Ubisense myWorld Release Notes
selectable in the associated ACE. This can provide a useful starting point for
configuring your myWorld layer settings.
You can export layer definitions using the Tile Export Tool and Sync Manager
Dialog.
Page 19 of 26
Ubisense myWorld Release Notes
8 JavaScript API
The following changes have been made to the JavaScript customisation API at this
release.
Page 20 of 26
Ubisense myWorld Release Notes
For more details see the Customization Guide and JavaScript API documentation
for IExternalDataSource.
the core version stamp, future myWorld core software upgrades will automatically
trigger a re-cache. You can also force a bust yourself by changing the version
stamp in you custom module. This can be useful when deploying changes to your
custom code.
Page 22 of 26
Ubisense myWorld Release Notes
9 Documentation
The documentation set has been updated to reflect the new features described
above. In addition:
myWorld ETL for Smallworld now includes step-by-step instructions for
configuring your glue code, with examples. Reference material for glue
code methods has been moved to an Appendix.
Installation & Configuration documentation has been extended to cover
definition of internals layers. There is also a a new sub-section describing
partial replication.
The Customization Guide has been extended to cover the publishing of
plugin buttons and configuration of external datasources.
The User Guide has been streamlined and updated for recent product
changes.
Page 23 of 26
Ubisense myWorld Release Notes
10 Upgrading
This section provides an overview of the upgrade process for this release.
These settings ensure that your internals data continues to be output using
the 'old' transform and that world owners continues to be given a
myw_internal_world_view field.
Page 24 of 26
Ubisense myWorld Release Notes
2. Define the int layer: In your tile export configuration, add a new layer
definition int with type internals. This layer will be used to perform internals
tile exports. Its bounds should be copied from a geographic layer (an
overlay). Its ACE name, zoom level and other parameters should be set to
the values that in previous releases came from your glue code. The Tile
Export Tool provides a GUI for performing this configuration.
Note: The layer must be called int since this was the world type used for
pre-myWorld 2.6 exports.
3. Add the int layer to batch jobs: In your Sync Manager control file, add the
int layer to the list of tile exports. This will ensure that it participates in
incremental exports.
Full and incremental exports should now behave as in myWorld 2.5, except that
myw_world_owner_field values will include an int/ prefix (as described in Feature
export modified above). Existing world owner data in the myWorld database is
migrated to the new format by the database upgrade.
For assistance with any of the processes above please contact Ubisense support.
Page 25 of 26
Ubisense myWorld Release Notes
Ubisense contact
This document contains confidential and proprietary information, and is the property of
Ubisense Group plc.
Page 26 of 26