Welcome to UnityBase Web client core API documentation

UnityBase Web client core (ub-core) package simplify the communication between Browser based client and UnityBase server.

In most case you create a single instance of Core class in yor application - see usage sample in Core.

Compatibility warning - Core class is introduced in UB 4.0, all other classes are the same in UB < 4.0.

Introduction

All API provided by ub-core are promisified by a Q library. The tasks, solved by package are:

• Authentication & Authorization for all schemas, supported by UB
• UBQL query builder helper class UB.Repository
• access to application domain metadata UBDomain
• client-side data cache using UBCache
• communication with build-in to UB WebSocket server using UBNotifierWSProtocol
• communication between web page and native applications with help of UBNativeMessage
• utilities for dependency injection, AJAX requests

Loading script

Bundled (with source maps):

<script charset="utf-8" src="models/UB/dist/q-lodash-crypto.min.js"></script>
<script charset="utf-8" src="models/UB/dist/ub-core.min.js"></script>

Or from sources using SystemJS:

<script src="models/UB/systemjs/dist/system.js" type="text/javascript"></script>
<script type="text/javascript">
    // set our baseURL reference path
    System.config({
        baseURL: '/models/UB/_src',
        defaultJSExtensions: true,
        map: {
            q: '/models/UB/_src/libs/q.js',
            lodash: '/models/UB/_src/libs/lodash/lodash.js',
            CryptoJS: '/models/UB/_src/libs/CryptoJS'
        }
    });

    System.import('ub-core-wglobals').then(function(ubCore){
        // window.UB
    });
</script>

Commercial editions

"Enterprise" edition

UnityBase Enterprise edition come with additional models and provide:

• support for Negotiate (Kenberos/NTLM) and Certificate based authorization
• a visual components for ER Diagrams, Organisation chart diagram and BPMN diagram (UBE model)
• in-browser PDF signing components (UBE model)
• in-browser PDF creation with Unicode fonts & HTML import support (PDF model)

Defense edition

Defense edition adds a client-side components for client & server side DSTU encryption & signing (DSTU model)