OData Server documentation

System requirements

Supported OS:

  • Microsoft Windows 7;
  • Microsoft Windows 8;
  • Microsoft Windows 10;
  • Microsoft Windows Server 2008;
  • Microsoft Windows Server 2008 R2;
  • Microsoft Windows Server 2012;
  • Microsoft Windows Server 2012 R2.

Other requirements

OData Server require installation of .NET Framework - one of the versions listed below (how to define version of installed .NET Framework):

  • Net 4.5 (regedit key value: 378389);
  • Net 4.5.1 (regedit key value: 378675 or 378758);
  • Net 4.5.2 (regedit key value: 379893);
  • Net 4.6 (regedit key value: 393295 or 393297);
  • Net 4.6.1 (regedit key value: 394254 or 394271).

INSTALLATION AND RUNING ODATA SERVER

Downloading the distribution of application

Product distribution posted for downloading in official site of RWAD Technologies by this link.
Distribution is implemented in the form of installer with *.msi extension.
The final form of the product is web application, which is installed in Windows-service format. Specific properties of installation and running of ODS is described below.

Installation of main component in form of Windows service

To install ODS it is necessary to run the installation file ODataServer.msi.
The result of running the file is dialog window of installation (picture below).
Dialog window of installation

During installation of ODS it is necessary to define the catalogue for deployment of unpacked software and one of the options of using software by users (two options: “Everyone” and “Just me”) (shown below).
Definition of catalogue for deployment of ODS

When catalogue is defined to continue the installation process you need to click button “Next”, after that license agreement will be shown (picture below).
License agreement

On the next step you need to specify login and password of your account on site https://rwad-tech.com.
It is necessary for automatic downloading of file of trial-license from website (picture below).
Input login and password of account

In the end of installation dialog window will be switch to message about successful (or unsuccessful) result of installation process (picture below).
Message about successful installation

After successful installation of product browser will automatically open two new tabs:

  1. http://localhost:9001/#/ (URL, where ODS is available by default);
  2. https://rwad-tech.com/en/ODataServer/Buy (page to purchase license for ODS on official website).

Check of installation correctness

As ODS is installed in Windows-service format, to verify that installed ODS has permissions to Windows event log it is necessary to make sure that log “ODataServer log” is existed. This is done by opening Windows event log viewer (by command “eventvwr”) (it’s shown below).
Opening Windows event log

Next you need to open the log “ODataServerLog” (it is shown below).
ODataServerLog

Next you need to verify the correctness of installing and starting of Windows service “OData Server” itself.
This is done by opening Windows Services snap-in by running command “services.msc” (shown below).
Opening Windows Services snap-in

In the case of successful installation, list of the services should have entry “RWAD Tech OData Server” (shown below).
View Windows Services snap-in

In the case of error when starting ODS, the content of error message is logged to ODataServerLog.
If you find such errors, please create request to the support of RWAD Technologies.

LICENSE ACTIVATION

File of ODS trial-license (“License.lic”) is loaded by default in the installation catalogue of product.
To get file of paid (fully functional) ODS license (and in the case when you need to manually download the trial-license) it is necessary to download license file by open section “My licenses” in personal cabinet on RWAD Technologies official site and click on picture of downloading for appropriate license (shown below).
Downloading license file on site

Activation of license file is performed at first start of ODS.
There are two types of activation process: online and offline.

Online activation of license

Online activation is performed in case when machine has active internet connection.
During online activation launched ODS refers to RWAD Technologies site for obtaining the activation key.
Received activation key is recorded to the file of keys. Next launching of ODS is performed without activation procedure.

Offline activation of license

Offline activation is performed in case when machine don’t has active internet connection. To get the ODS distribute that would be activated by offline method, you need to create appropriate request to RWAD Tech support.
Offline activation procedure consists of the following steps:

  • Starting ODS;
  • In result of first operation, the file activationRequest.txt will appear in the folder of launched ODS;
  • You need to fill the form of activation request on site of RWAD Technologies via this link;
  • In opened form You should enter the content of file (activationRequeest.txt) (shown below);
    Offline activation of license on site
  • Next, You should click button “Send”. After click the loading indicator should appear on button;
  • In the case of valid activation request data, file activationkey.txt will be returned to browser. In the case of error in activation request data, error message will be displayed on the form;
  • Next, You should put the received file (activationkey.txt) to the folder of activated ODS;
  • Next step, You should run the file ODataServer.Licensing.OfflineActivator.exe;
  • As a result of previous operation, the following message about successful activation will be appeared:
    The message about successful license activation

USING ODATA SERVER

Start OData Server

Start of Windows service RWAD Tech OData Server is performed automatically after installation of product.
By default ODS is available on next address http://localhost:9001/.
Appropriate message about start of ODS is displayed in event log “ODataServerLog” (shown below).
Entry in event log about start of ODS

Web-interface of ODS is opened after calling of appropriate URL address in browser.

View “List of web services”

Initial view of web application is the list of currently active web services, which is generated by ODS (shown below).
List of web services

List of web services includes next columns:

  • Identifier (it has automatically assigned value of GUID type);
  • DB name (name of DB, which is used by web service as a data source);
  • Port (number of port, that hosts web service);
  • Description (contains entered by user brief description of web service);
  • Authentication method (method of authentication, which is used by web service. It can take values None, Basic, Token);
  • Actions. It contains icon buttons to call next procedures:
    • Edit (call the form of editing parameters of web service);
    • Open (open the new browser tab with URL address for browsing metadata of web service);
    • Delete (call the procedure of deletion of selected web service);
    • Access management. It contains drop-down list with next options (shown below):
      Drop-down list for access management
      • Go to access management (opens the new browser tab with URL address of UI for access management);
      • Actualize tables of access management component (updates the DB objects, which related to access management);
    • Download the log. It contains drop-down list with next lines (shown below):
      Drop-down list for downloading logs
      • Error log (contains errors of selected web service);
      • Security log (contains security events of selected web service);
      • OData Handler (contains business-logic data of service);
      • Common log (contains information about working of whole web service instance).

Creating of web service

Form to create new web service is opened from list of web services by clicking tab “Create service” or by clicking button “Add”, which is located above the list of web services on the right side (it shown below).
Call the form of creation new web service

Form to create new web service includes next columns (shown below):
Form of creation new web service

  • Description (contains brief description of web service);
  • Connection string (contains parameters of connection to DB);
  • Port (number of port, that will host web service);
  • Host name (DNS name or IP address of service. This value will be used during formation links to entities, which are returned by this service);
  • DB type (choosing the type of DBMS, which is base for source DB);
  • Excluded tables (access to tables, which are defined in this field, will not be provided by using this service);
  • Authentication settings:
    • Authentication method (method of authentication, which is used by web service. It can take the values None, Basic, Token);
    • Method of transfering the auth token;
    • Cookie name for auth token (in this cookie auth token will be transfered);
  • CORS settings (cross-origin resource sharing):
    • Using CORS (permission for service to create responses for CORS requests);
    • Permitted hosts (service will create response to request, which are entered from these hosts). Values are delimited by comma symbol.

Buttons “Save” and “Back to list”, which are located in down part of form, calls procedures of saving the service and returning to the list of services.
Connection string can be constituted manually or using special helper, which can be opened by clicking the picture of folder (located the right to the field “Connection string”) (shown below).
Opening the master of formation connection string

Process of formation connection string using helper is implemented in four steps:

  1. Choosing the type of DBMS (shown below);
    Choosing the type of DBMS
  2. Definition parameters of DBMS host (shown below);
    Definition parameters of DBMS host
  3. Definition parameters of user account to connect the DBMS (shown below);
    Definition parameters of user for connect to DBMS
  4. Choosing source DB (shown below).
    Choosing source DB

After formation of connection string is finished, you should click button “Create connection string”.
After that dialog window with master of creation connection string will be closed and browser will return to the form of editing the service.
In the right down corner the message about successful creation of connection string will appear (shown below).
Message about successful creation of connection string

After you fill out all fields in form of creatings new web services, you should click button “Save”, which located in the bottom of form.
After that browser will return to the services list. In the right down corner the message about successful creation of service will appear.

OData Server Settings

Call the window of ODS settings is performed by clicking the picture of cogwheel, which is located in right top corner of views “List of services” and “Create service” (shown below).
Window of ODS settings contains next information:
Form of ODS settings

Window of ODS settings contains next information about current ODS license:

  • License ID (unique identifier of ODS license);
  • Valid until (the expiration date of license)
  • License type (it can takes the values Trial or Standard);
  • Availability of access management component (it can takes the values True or False);
  • Availability of access management UI (it can takes the values True or False).

The section ”Settings of application” contains field “Port” for input number of port, that hosts ODS web application.
If default value of port (9001) is changed and button “Apply” is clicked, it will cause procedure of automatic reboot the windows-service «RWAD Tech OData Server».
Simultaneously new browser tab with ODS web interface will be opened, that hosts on new defined port.

ACCESS MANAGEMENT COMPONENT

Using of Access management component is available for trial-license during the first month after license activation procedure.
Paid versions of ODS don’t has time limitation of using Access management component (appropriate features should be defined during Order procedure in accordance with conditions of license agreement).

Call the Access management component for selected web service is performed by click the line “Go to access management” from drop-down list of user management (shown below).
Call the Access management component

You should take into consideration that for using Access management component web service should meets next requirements:

  • field “Using CORS” is activated;
  • field “Permitted hosts” contains value of actual port, that hosts ODS web application (default is http://localhost:9001).

User management

List of users

During initial opening the Access management component user should be authenticated with login “Admin” and password “111111” (shown below).
Authentication form

After login and password is filled out, you should click button «Login», after that list of users will be opened.
This view initially contains only one record (Admin). It is shown below.
. List of users

List of users contains next columns:

  • Key (unique numeric identifier, which is assigned automatically);
  • User name (user’s login);
  • Email address;
  • Last name;
  • First name
  • Middle initial;
  • User roles;
  • Actions. It contains next lines:
    • Edit;
    • Change password;
    • Delete.

Creating of new user

Creating of new user is performed by click button “Add”, which is located in left corner above list of users. Click of button will open form of creating new user (shown below), which contains next fields:

  • Key (unique numeric identifier, which is assigned automatically);
  • User name (user’s login);
  • Email address;
  • Last name;
  • First name
  • Middle initial;
  • Password;
  • Confirm password (this field is necessary for check the correctness of password input).
Form of creating new user

Fields «User name», «Password» and «Confirm password» are required.
Bottom part of form contains buttons for call procedures of save and cancel changes.

Editing the user

Editing of selected user is perfomed by clicking the button “Edit”, which is located in drop-down list of actions.
Click of button “Edit” will open form of editing the user, which contains fields similar to form of creation the user (with one additional field “User roles”).
Form of editing user

Field “User roles” is using to appoint selected roles for user.
Appointment of roles is performed by clicking on field and chooses one of the roles from drop-down list of roles (shown below).
Appointment of role to the user

Deletion of the user

Deletion the user is performed in list of users by clicking line “Delete” from drop-down list of actions for selected user.

Roles management

List of roles

List of roles is called by clicking the appropriate tab, which is located in right corner above the list of users. Initially list of users contains only one line – “Admin” (shown below).
List of roles

List of roles contains next fields:

  • Key (unique numeric identifier, which is assigned automatically);
  • Role name;
  • Actions. It contains next lines:
    • Edit;
    • Delete.

Creating of role

Creating the new role is carried by click button “Add”, which is located in left corner above list of roles.
Click button calls form of creating new role (shown below).
Form of creation new role

Form contains next fields:

  • Key (unique numeric identifier, which is assigned automatically);
  • Role name (this field is required for input).

Bottom part of form contains buttons for call procedures of save and cancel changes.

Editing the role

Editing of selected role is carried by click button “Edit”, which is located in drop-down list of actions. Click of button “Edit” will open form of editing the role, which contains fields similar to form of creating the role and table with role’s permissions (shown below).
Form of editing the role

Appointment of role’s permissions is performed by set check marks in columns “Read”, “Create, Edit”, “Delete” and “All permissions”.
Lines of table are related to entities of source-database.
Technologic entities (entities, which are created automatically when creating the model of access management component of ODS) is marked in table by pink filing.

Deletion the role

Deletion the role is performed in list of roles by chooses line “Delete” from drop-down list of actions above selected role.