Welcome to the Ubisense Documentation Portal

Filter:
Submit Search

SmartSpace Documentation

Install and configure SmartSpace.

DIMENSION4 Documentation

Install and configure DIMENSION4 software and hardware.

ACS Documentation

Install and configure ACS.

Ubisense Academy

Learn how to use our products

Our eLearning courses are available for Ubisense employees and partners to learn how to use Ubisense products.

Browse Courses

Latest Updates

Software

SmartSpace 3.10 SP2 is now available. View more details in the change log.

Ubisense Academy

The Ubisense External Definitions course is now available.

Useful Information

To search the website, type a query into the search bar and press Enter (or click image of the search button).

Search has the following features:

  • You can search for occurrences of single words, for example tag. The search is not case sensitive, so entering tag would locate topics containing both "tag" and "Tag". You can enter a partial term (a minimum of four characters long) and all topics with words containing that sequence of characters will be returned.

  • You can search for phrases, by enclosing the phrase in double quotes, for example "spatial monitoring". Only topics containing an exact match for the phrase will be returned. Again the search is not case sensitive, so entering "spatial monitoring" would locate topics containing both "Spatial monitoring" and "spatial monitoring".

  • You can narrow the topics to be searched by using a filter. Enter a query and click image of the select filter button to choose a relevant filter from the dropdown of categories. (The filter button changes to image of filter button whenever a filter has been applied.)

    The filter remains active until you select another, opt to search all topics, or go to another topic. To return to a search of all topics, click image of filter button and choose All Files from the dropdown.

  • You can use Boolean operators to refine your searches. The following operators are supported:

    • AND (also + or &)

      Separating terms with a space also implies AND.

    • OR (also |)

    • ^ (also NOT or !)

      Used to find topics that contain one term but not another.

    You can also use parentheses in searches.

Searching for Operators and Mathematical Symbols

Note: These hints apply especially when you search for keywords for use in the Business rules editor in SmartSpace Config.

  • Search cannot find symbols such as < or +. Instead change your search to use words describing the symbol, for example "less than" instead of "<".

  • Using quotes around search terms, especially those containing common words, can also get you better results, for example "there is a" returns several hits whilst there is a does not.

Using Google to search the documentation

You can make use of Google's site: search feature to search all of the Ubisense Documentation site. Prefix your search term with

site:https://docs.ubisense.com

Note: There is no space between site: and the URL of the website.

Your search for returned result(s).

Browse the archive for information about:

Site History

Contains:

  • Information on support for setting multiple property values in a single transaction in the Application REST API

  • Information on setting property values in SmartSpace via the Kafka integration BETA

  • Additional information added to support successful use of the "remove location pending" flag

  • max_health_timeout_secs config parameter described in Health monitoring and information on the ubisense_health_metric_admin tool added

  • Updated ACS Guide available (PDF)

  • Updates to installation guides for ACS release 2.12

  • Update in installation guides about default value of no_multicast_mode with SmartSpace 3.10 and DIMENSION4 versions 3.8 SP1 or earlier

  • Updates to systemd examples in Linux installation

Redesigned Ubisense Documentation website with new branding

  • Added section on auditing configuration changes in SmartSpace (RTLSDOC-331)

  • Note in installation guides about default value of no_multicast_mode (RTLSDOC-332)

  • Information on ubisense_location_logger and ubisense_location_replayer command-line tools added (RTLSDOC-333)

  • Updates to information on loading and saving modules (RTLSDOC-335)

  • Default location age for the "Tags" search documented (RTLSDOC-334)

  • Updated guidance for where to look for OpenID Connect errors (RTLSDOC-304)

  • Added report queries to the Application REST API (RTLSDOC-312)

  • In Reports engine developer a small change for warnings with unsaved changes to SQL queries (SSREPORTS-238)

  • Update to OpenID Connect authentication configuration, in SmartSpace Web installation guide, to return small cookie session instead of OpenID authentication token (RTLSDOC-311)

  • Guidance added for where to look for OpenID Connect errors (RTLSDOC-304)

  • Updates to EDC documentation

    • edc_log_path configuration parameter

    • EDC does not support retrieval of geometry rows from a SQL Server

  • HMI documentation updated with a note explaining that the external development workflow has been deprecated and users should use the hot reloading method instead (RTLSDOC-273)

  • Information on automatic tag disassociation (RTLSDOC-66)

  • Order of entry/exit events in Business rules explained in Rules engine developer (RTLSDOC-300)

  • Updated SmartSpace property and Object type in EDC documentation (RTLSDOC-291)

  • Information on configuring anonymous auth in ObjectView (RTLSDOC-290)

  • Information on updating background object locations on the web map (SSVISIB-743)

  • Property transfer diagram updated (RTLSDOC-264)

  • License generation process added to installation guides (RTLSDOC-267)

  • In Troubleshooting, removed note and revised instructions for downloading OpenGL DLLs to correct display problems in the 3D map.

  • Added information about using SQL queries in Reporting (RTLSDOC-246)

  • Installation guides:

    • Updated Linux installation requirements (RTLSDOC-275)

    • Updated .NET runtime/hosting to version 8.0.x (RTLSDOC-272)

  • Kafka feature added to Applications integration (RTLSDOC-270)

  • Rules engine developer update to ubisense_smartspace_module_admin (RTLSDOC-285)

  • Web searches Configuration

    • ObjectView and web map searches do not support cellular properties (RTLSDOC-284)

  • HMI Editor and component library are deprecated from version 3.9 (SSVISIB-564)

  • SmartSpace Map feature added to Visibility (SSCORE-1075)

  • Web Searches:

    • Updated supported forms (RTLSDOC-268)

  • Installation guides:

    • Updated Linux reference to SLES (RTLSDOC-279)

    • Added bearer authentication to SmartSpace Web installation guide (RTLSDOC-280)

  • SmartSpaceApplication REST API documentation (RTLSDOC-280)

  • Location system sync feature added to Visibility (SSVISIB-678)

  • Added information about dwell time colors (SSREPORTS-179)

  • Updated information about the rendering order of 2D reps in SmartSpace WebMap view (RTLSDOC-251)

  • ubisense_object_view_web_interface(.exe)added to list of services required on partitioned web servers

  • ObjectView API:

  • Business rules/Business rule trace:

    • Added information on duplicate definition errors (SSBUSRULS-338)

    • Added information on how to zoom in/out in Business rules and Business rule trace (SSBUSRULS-337)

    • Added clarification for the keyword "and then" represented by ";" in Business rules (RTLSDOC-78)

    • Added information on setting a new battery status with Business rules (RTLSDOC-144)

  • Added section on changing the location aggregation rate (RTLSDOC-219)

  • Installation/Reporting/RDBMS map: Updated requirements for Windows SQL Server and linked to details on Microsoft site (RTLSDOC-241)

  • Search:

    • Improved Search/Microcontent for properties and assertions supplied with SmartSpace features (RTLSDOC-150)

    • Improved Search/Microcontent for report chart types (RTLSDOCC-236)

  • Updated installation instructions for HMIs and Real-time rules engine for ACS+SmartSpace (ACSEXT-2823)

  • Added information about using Outgoing ACS Event events of the type SimpleObjectLocationEvent (ACSEXT-2784)

  • User statistics in SmartSpace Web: the ability to count users of features in SmartSpace Web has been added (SSVISIB-580)

    • A property can be seen in Types and objects workspace

    • A metric has been added to Health monitoring

    • User statistics can be used in Reporting

  • A delay between individual services restarting can now be set (PLATFORM-142)

  • The ubisense_cell_config_dump command-line tool is available in the SmartSpace distribution (PLATFORM-133)

  • Copying all data in TRACE VIEWER in SmartSpace Config, Ctrl+A selects all messages and Ctrl+C copies them. Home followed by Shift+End also selects all. (PLATFORM-137)

  • Installation: added further Linux requirement for a 64-bit libssl.so.1.1 (RTLSDOC-211)

  • ObjectView API: added information on connecting to a different hub (RTLSDOC-210)

  • Platform transfer and Property transfer tool documentation combined and reorganized (SSADVIT-62)

  • Installation:

    • Required .NET versions updated in installation guides

    • MS Visual C++ requirement added

    • List of supported browsers updated

  • Added information on using OpenID Connect to configure the SmartSpace Web site to use an external provider for authentication

  • HMIs:

  • Guide to the ObjectView API with worked example, and information on the ability to set properties

  • Additional information on creating/modifying cells in SmartSpace Config

  • Updates to the External data connector including:

  • Added requirement to disable Automatic Diagnostic Repository to installation instructions for Oracle client on Linux for Reporting and RDBMS map

  • Added square root function to toolbox elements of the Defining Queries section of Designing Reports in SmartSpace

  • Added information on controlling the rendering of label reps on the web map

  • A section "Example: Connecting a Quuppa tracking system to SmartSpace" added to the External data connector guide (Ubisense and Partners only)

  • Added to HMIs:

  • Added link to information on "Forward to Multitag Service" filter parameter to enable the use of DIMENSION4 raw data with the Multi-tag feature

  • Added requirement for libnsl to installation instructions for Oracle client on Linux for Reporting and RDBMS map

  • Updated port number in D4 sensor ports diagram

  • Installation guides include information about removal of default availability of NTLM authentication and workaround for Firefox browser

  • Guide to scaling out SmartSpace Web added

  • Guide to using external definitions in real-time rules added

  • Added train stale timeout and train update period to Paths and queues parameters; renamed handover variance threshold to handover distance and updated description

  • Added information on the File Reader Stream in the External data connector

  • Added description of behavior of web search with choice parameters where a property is null

  • Added use of views in web search URLs

  • Updates to HMIs including information on:

    • Change to versions of jQuery and jQuery UI used

    • Support for search parameters

    • Addition of the createObject function

    • Explanation of how searches that include complex properties are handled

  • Updated information about default roles for configuring access to SmartSpace Web

  • Described changed display of tags with no assigned tag type and the method to revert to the previous configuration

  • In Reporting:

    • Added reminder about escaping any instances of the special characters “@” and “\” in passwords when configuring SQL server for Reporting

    • Added additional information on connection strings for Windows SQL server in Reporting

  • Clarified the effects of using set and clear in ubisense_property_transfer_config

  • Amended default port for health_mcast_port in Health monitoring

  • Added information on the Property transfer tool
  • Added description of the sighting persistence parameter for Automated tag association
  • Update to description of tag behavior in the Grenade tag support guide
  • Location simulation feature added: enables the simulation of object movements in SmartSpace
  • Location quality monitoring feature added: enables analysis of the accuracy and robustness of location data supplied to SmartSpace
  • New loadable module added to support the management of error handling in SmartSpace applications (used with Location quality monitoring)
  • Information on refactoring support and ubisense_refactor.exe added
  • Updated .NET API with support for external definitions created in the Business rules editor
  • Installation: all installation instructions involving .NET Core now instruct users to install version 3.1.x
  • Installation: information added to the installation guides on storing a persistent custom theme for the SmartSpace website
  • External data connector includes information on support for TCP streams and the import of single-field, unformatted data
  • HMIs: a guide to working with an external development environment, such as Vue CLI when creating HMIs
  • Web maps: Explanation of how to record who changed a property via the web map using the new "user changed" property
  • Web maps: Limit Zoom setting prevents images becoming too small on the web map
  • Reporting: description of the ability to set a category color in the Location History chart has been added
  • Updated information on configuring firewall exceptions for the web site with unicast cluster
  • Details of port number for LDAPS connection for website and REST API added to installation instructions and DIRECTORY SERVICES in SmartSpace Config
  • Enhancements to ACS on SmartSpace
  • Health monitoring metrics details removed and reference to their new location and that of sample dashboards added (all available from the Ubisense Downloads Portal)
  • SQL Server and Oracle databases on Linux: installation and configuration instructions added for Reporting and RDBMS map
  • New installation and migration information added with selection of guide via an interactive wizard
  • Download pdf links added to introduction topics of all sections of the website that have an associated stand-alone guide
  • Changes to content of Tag status and Sensor status topics to reflect display of additional details and actions on tags and sensors
  • Information on adding areas for use in Generation 2 programs and importing representations for copying to Generation 2 programs added to SmartSpace Config
  • Information on use of the health_reporter_interface parameter in Health Monitoring to set the ip address of the interface to bind to
  • Information on a work-around to get a .NET core application that uses the Ubisense Managed Browser API to run within the Visual Studio debugger
  • Installing SmartSpace Web updated to include Linux installation
  • Installing SmartSpace Web updated
  • Information on roles updated to include default role configuration
  • HMIs added (and PDF guide) (Ubisense only)
  • Content added to Configure SmartSpace for:
    • Web forms
    • Email
    • Shifts
    • Service Parameters

    and updated content in:

    • Types and objects (reorganized topics)
    • Troubleshooting (cells)
  • Added new worker content:
    • Web forms
    • Site connector

    • AngleID connect

    • AVL/GPS connect

    • Ubisense ISO 24730
  • New worker content added (Ubisense only, pre-release)
    • Health monitoring
    • Paths and queues
  • New Ubisense-only content:
    • Tracing Platform Data Use
    • Testing Licensed Components
  • Added new downloadable content:

    • AngleID connect(pdf format)

    • AVL/GPS connect(pdf format)

    • Ubisense ISO 24730(pdf format)
  • Software version of a feature's first release shown on all relevant pages
  • Various cosmetic changes to look of pages and navigation
  • Added new downloadable content:

    • Paths and Queues Configuration Guide

    • Ubisense Health Monitoring Config

  • Fixes to formatting of the following downloads:
    • RDBMS Map Configuration Guide
    • SmartSpace Components and Features
  • Top-level descriptions show software version of feature's first release
  • Individual logins
  • Updated site design
  • Downloads, IT resources, Doc admin sections added
  • Location rules added
  • Automated failover added
  • RDBMS map added
  • Additions to Configure SmartSpace for:
    • Logging
    • Cells
    • Tag association
    • Directory services
  • Installation
  • Config: Types and objects, Spatial properties, Model import and assignment, Object placement, Web searches, Web forms, Users/roles
  • Visibility: Simple types and attributes, Searches and web maps, Web maps at runtime, Users, roles, role nesting and LDAP
  • Advanced IT: Replication, Property transfer
  • Core: Types and objects, Object representations, Spatial monitoring, Introduction to security manager, .NET API, C++ API,
  • Overviews of Components and Features

Version

This is version 4.3 of the SmartSpace website.

Copyright

Copyright © 2025, Ubisense Limited 2014 - 2025. 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 535170

WWW: https://www.ubisense.com

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.

UBISENSE®, the Ubisense motif, SmartSpace® and AngleID® are registered trademarks of Ubisense Ltd. DIMENSION4™ and UB-Tag™ are trademarks of Ubisense Ltd.

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.