Difference between revisions of "Getting Started"

Latest revision as of 10:26, 9 March 2023

UBIK^® Topological overview

Introduction

UBIK^® Platform Architecture

A complete UBIK^® System consists of a few parts that play together but have different purposes. Not every component (or access to it) is needed for each and every scenario and sometimes these components are spread over various servers and devices. The only part that is always necessary and therefore not listed in this table is the UBIK^® Database. The following table should provide an overview which part of UBIK^® has to be installed and accessible for which use case:

Use case/Component	UBIK^® Studio	UBIK^® Web Services	UBIK^® Enterprise Service	UBIK^® Mobile Client
Data model administration	Yes	No	No	No
Manual interfacing to 3rd party systems	Yes	No	No	No
Automated interfacing to 3rd party systems	No	No	Yes	No
Mobile working	No	Yes	No	Yes

See Set up UBIK^® for details on installation issues.

First Steps

Follow these four steps to create an UBIK^® application from scratch:

Install and configure according components required for the existing use case (see table above)
Build up data model and publish tables with data
Configure the Application Context Management
Enjoy UBIK^®!

Installation

UBIK^® Studio

UBIK^® Studio can be installed and used on a local client as well as via a Remote Desktop Connection (RDP). All the structural and content data are stored in the UBIK^® database managed by a Microsof SQL server. A Microsoft Internet-Information-Server (IIS) serves as platform to publish this data to the mobile device. A necessary but obvious condition is of course, that all the software packages (UBIK^® Studio, Microsoft SQL and IIS) can communicate between each other.

See How to install UBIK^® Studio for help on installation issues.

See UBIK^® Studio Basics for further details on configuration.

UBIK^® Enterprise Service

The UBIK^® Enterprise Service is a Windows service that is meant to automate UBIK^® interface components or interface workflows. It typically runs on a server and is triggered by changes in an arbitrary amount of folders in the file system (like new or modified files).

See How to install UBIK^® Enterprise Service for help on installation issues.

See UBIK^® Enterprise Service for further details about configuration.

UBIK^® Web Service

The UBIK^® web services publish data from the UBIK^® database to mobile devices (i.e. mobile phone, tablet etc.).

See How to install UBIK^® Web Service for help on installation issues.

See Web Service for further details about configuration.

UBIK^® Database (SQL)

See Set up UBIK^® Database for help on configuration issues.

UBIK^® WinX Client

See Install UBIK WinX Client for help on installation.

Entity Data Model

Get to know about the relational model used in UBIK^® beginning from a rather figurative and abstract point of view.

See: Entity Data Model

Built-in Objects

Based on the UBIK^® meta model a set of Metaclasses and Metaproperties have been already implemented in advance. These objects serve as root nodes for more user specific Metaclasses or containers for a range of functionality. New customer specific meta objects are derivatives of those system objects, hence implicitly inherit a set of Metaproperties and features.

The most important system objects are:

Interfacing

See Interfacing for a comprehensive list of interfacing topics.

Interface Manager

Used to configure Interface components and Interface Workflows

See Interface Manager

Interface Toolkits

See SAP Interface Toolkit

See XML Interface Toolkit

See Interface Tools Library

Working mobile

See Client Basics

Frequently Asked Questions

See FAQ

Site Map

See SiteMap

@@ Line 1: / Line 1: @@
+[[File:IL_Platform_Topology.png|thumb|220px|{{UBIK}} Topological overview]]
+==Introduction==
+[[File:IL_Platform_Architecture.png|thumb|220px|{{UBIK}} Platform Architecture]]
+A complete {{UBIK}} System consists of a few parts that play together but have different purposes. Not every component (or access to it) is needed for each and every scenario and sometimes these components are spread over various servers and devices. The only part that is always necessary and therefore not listed in this table is the {{UBIK}} Database. The following table should provide an overview which part of {{UBIK}} has to be installed and accessible for which use case:
+{| class="wikitable sortable"
+|-
+! Use case/Component !! {{UBIK}} Studio !! {{UBIK}} Web Services !! {{UBIK}} Enterprise Service !! {{UBIK}} Mobile Client
+|-
+| Data model administration || Yes || No|| No || No
+|-
+| Manual interfacing to 3rd party systems|| Yes || No || No || No
+|-
+| Automated interfacing to 3rd party systems || No || No || Yes || No
+|-
+| Mobile working|| No || Yes || No || Yes
+|}
+:''See [[HowTo:Set_up_UBIK|Set up {{UBIK}}]] for details on installation issues.''
+== First Steps ==
+Follow these four steps to create an {{UBIK}} application from scratch:
+# [[Getting_Started#Installation|Install and configure]] according components required for the existing use case (see table above)
+# [[Entity Data Model|Build up data model]] and publish tables with data
+# Configure the [[ACM|Application Context Management]]
+# '''Enjoy {{UBIK}}!'''
 == Installation ==
 === {{UBIK}} Studio ===
@@ Line 4: / Line 35: @@
 {{UBIK}} Studio can be installed and used on a local client as well as via a Remote Desktop Connection (RDP). All the structural and content data are stored in the {{UBIK}} database managed by a Microsof SQL server. A Microsoft Internet-Information-Server (IIS) serves as platform to publish this data to the mobile device. A necessary but obvious condition is of course, that all the software packages ({{UBIK}} Studio, Microsoft SQL and IIS) can communicate between each other.
-:''See [[Install_UBIK_Studio|How to install {{UBIK}} Studio]] for help on installation issues.''
+:''See [[HowTo:Install_UBIK_Studio|How to install {{UBIK}} Studio]] for help on installation issues.''
 :''See [[UBIK_Studio_Basics#Options|{{UBIK}} Studio Basics]] for further details on configuration.''
@@ Line 10: / Line 41: @@
 The {{UBIK}} Enterprise Service is a [http://en.wikipedia.org/wiki/Windows_service Windows service] that is meant to automate {{UBIK}} interface components or interface workflows. It typically runs on a server and is triggered by changes in an arbitrary amount of folders in the file system (like new or modified files).
-:''See [[Install_UBIK_Enterprise_Service|How to install {{UBIK}} Enterprise Service]] for help on installation issues.''
+:''See [[HowTo:Install_UBIK_Enterprise_Service|How to install {{UBIK}} Enterprise Service]] for help on installation issues.''
 :''See [[Enterprise_Service|{{UBIK}} Enterprise Service]] for further details about configuration.''
-=== Database (SQL) ===
-:''See: [[UBIK_Database|Set up {{UBIK}} database]]''
 === {{UBIK}} Web Service ===
-The {{UBIK}} web services publish data from the {{UBIK}} database to a mobile device (eg mobile phone, tablet).
+The {{UBIK}} web services publish data from the {{UBIK}} database to mobile devices (i.e. mobile phone, tablet etc.).
+:''See [[HowTo:Install_UBIK_Web_Service|How to install {{UBIK}} Web Service]] for help on installation issues.''
+:''See [[:Category:Web_Service|Web Service]] for further details about configuration.''
+=== {{UBIK}} Database (SQL) ===
+:''See [[HowTo:Install_UBIK_Database|Set up {{UBIK}} Database]] for help on configuration issues.''
+=== {{UBIK}} WinX Client ===
+:''See [[HowTo:Install_UBIK_WinX_Client]] for help on installation.''
+[[Category:UBIK|Getting Started]]
-:''See [[Install_UBIK_Web_Service|How to install {{UBIK}} Web Service]] for help on installation issues.''
+== Entity Data Model ==
-:''See [[UBIK_Web_Service|{{UBIK}} Web Service]] for further details about configuration.''
+Get to know about the relational model used in {{UBIK}} beginning from a rather figurative and abstract point of view.
+:''See: [[Entity Data Model]]''
-== Data- and Object Model ==
+=== Built-in Objects ===
-:''See: [[Data- and Object Model]]''
+Based on the {{UBIK}} meta model a set of Metaclasses and Metaproperties have been already implemented in advance. These objects serve as root nodes for more user specific Metaclasses or containers for a range of functionality. New customer specific meta objects are derivatives of those system objects, hence implicitly inherit a set of Metaproperties and features.
-== Interfaces ==
+The most important system objects are:
-:''See: [[UBIK_Interfaces|Interfaces]]''
+* [[:Category:Metaclasses|Metaclasses]]
+* [[MetaProperty|MetaProperties]]
+* [[:Category:Classifications|Classifications]]
+* [[:Category:Workflow|Workflows]]
+* [[:Category:Relations|Relations]]
+* [[:Category:References|References]]
-== System Objects ==
+[[Category:UBIK|Getting Started]]
-=== MetaClasses ===
+== Interfacing ==
-Based on the {{UBIK}} meta model a set of MetaClasses and MetaProperties have been already implemented in advance. These objects serve as root nodes for more user specific MetaClasses or containers for a range of functionalities. New customer specific metaobjects are derivatives of those system objects, hence implicitely inherit a set of MetaProperties and features.
+:''See [[:Category:Interfacing|Interfacing]] for a comprehensive list of interfacing topics.''
-For a comprehensive list of system MetaClasses go to [[:Category:System MetaClasses|System MetaClasses]]
+=== Interface Manager ===
+Used to configure Interface components and Interface Workflows
+:''See [[Interface Manager]]''
-=== Classifications ===
+=== Interface Toolkits ===
-If you want to know more about this topic go to [[:Category:System_Classifications|System Classifications]]
+:''See [[SAP Interface Toolkit]]''
+:''See [[XML Interface Toolkit]]''
+:''See [[Interface Tools Library]]''
-=== Workflows ===
+== Working mobile ==
-If you want to know more about this topic go to [[:Category:System_Workflows|System Workflows]]
+:''See [[UBIK Client Basics|Client Basics]]''
-=== Relations ===
+== Frequently Asked Questions ==
-If you want to know more about this topic go to [[:Category:System_Relations|System Relations]]
+:''See [[:Category:FAQ|FAQ]]''
-=== References ===
+== Site Map ==
-If you want to know more about this topic go to [[:Category:System_References|System References]]
+:''See [[SiteMap]]''
-== Create a Mobile Event Management ==
+[[Category:UBIK|Getting Started]]
-Provide a step-by-step guide how to create metaclasses, assign metaproperties and publish data on the mobile device including creation of documents.
-This first example should be based on the event example from the internal {{UBIK}} training (Dec, 2012).