OData Server require installation of .NET Framework - one of the versions listed below (how to define version of installed .NET Framework):
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.
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).
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).
When catalogue is defined to continue the installation process you need to click button “Next”, after that license agreement will be shown (picture below).
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).
In the end of installation dialog window will be switch to message about successful (or unsuccessful) result of installation process (picture below).
After successful installation of product browser will automatically open two new tabs:
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).
Next you need to open the log “ODataServerLog” (it is shown below).
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).
In the case of successful installation, list of the services should have entry “RWAD Tech OData Server” (shown below).
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.
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).
Activation of license file is performed at first start of ODS.
There are two types of activation process: online and offline.
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 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:
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).
Web-interface of ODS is opened after calling of appropriate URL address in browser.
Initial view of web application is the list of currently active web services, which is generated by ODS (shown below).
List of web services includes next columns:
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).
Form to create new web service includes next columns (shown below):
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).
Process of formation connection string using helper is implemented in four steps:
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).
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.
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:
Window of ODS settings contains next information about current ODS license:
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.
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).
You should take into consideration that for using Access management component web service should meets next requirements:
During initial opening the Access management component user should be authenticated with login “Admin” and password “111111” (shown below).
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 contains next columns:
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:
Fields «User name», «Password» and «Confirm password» are required.
Bottom part of form contains buttons for call procedures of save and cancel changes.
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”).
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).
Deletion the user is performed in list of users by clicking line “Delete” from drop-down list of actions for selected user.
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 contains next fields:
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 contains next fields:
Bottom part of form contains buttons for call procedures of save and cancel changes.
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).
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 is performed in list of roles by chooses line “Delete” from drop-down list of actions above selected role.