|
2 | 2 |
|
3 | 3 | ## Introduction
|
4 | 4 |
|
5 |
| -This Web-Application provides access to Adabas REST server tasks and data. |
6 |
| -The pages contain REST api web URL's used to retrieve the JSON content. The received data is displayed on the web page. Actions are added to the web page as well. |
| 5 | +This Web Application provides access to Adabas REST server tasks and data. |
| 6 | +The pages contain REST API web URLs used to retrieve the JSON content. The received data is displayed on the web page. Actions are added to the web page as well. |
7 | 7 |
|
8 | 8 | 
|
9 | 9 |
|
10 | 10 | ## Installation
|
11 | 11 |
|
12 |
| -The Adabas REST web application can be compiled using the NPM and Node infrastructure. NPM third party packages needed to be installed first. Following command will install the corresponding packages in `node_modules`: |
| 12 | +The Adabas REST web application can be compiled using the NPM and Node infrastructure. NPM third party packages need to be installed first. The following command will install the corresponding packages in `node_modules`: |
13 | 13 |
|
14 | 14 | ```sh
|
15 | 15 | npm install
|
16 | 16 | ```
|
17 | 17 |
|
18 |
| -To final compile the web application the distribution need to be build using following command: |
| 18 | +To finally compile the web application, the distribution needs to be built using the following command: |
19 | 19 |
|
20 | 20 | ```sh
|
21 | 21 | npm run build
|
22 | 22 | ```
|
23 | 23 |
|
24 |
| -The final Web-Application is located in the `dist` directory. |
| 24 | +The final Web Application is located in the `dist` directory. |
25 | 25 |
|
26 | 26 | ## Usage
|
27 | 27 |
|
28 |
| -The example consists out of three parts |
| 28 | +The example consists of three parts: |
29 | 29 |
|
30 |
| -1. the web application provides access to Adabas data. The Adabas data access can use the Adabas Map long name which maps classic database reference to long name representation. Alternatively the usage of classic database id and short name references can be used as well. |
| 30 | +1. The web application provides access to Adabas data. The Adabas data access can use the Adabas Map long name which maps a classic database reference to a long name representation. Alternatively, classic database IDs and short name references can be used. |
31 | 31 | 2. Adabas administration tasks and monitoring access is possible. The creation of Adabas databases and maintaining Adabas parameters and resources are possible. Various monitor data can be requested.
|
32 |
| -3. the Adabas REST server provides the start of jobs inside the installation of Adabas. The scripts defined inside the job list. |
| 32 | +3. The Adabas REST server provides the possibility to start jobs inside the Adabas installation. The scripts are defined in the job list. |
33 | 33 |
|
34 |
| -Beside the main topics above, a number of short data-access example pages are included in the Web application. Large objects or Unicode access to the Adabas database are contained in the Web application. |
| 34 | +Beside the main topics above, a number of short data access example pages are included in the Web application. Large objects and Unicode access to the Adabas database are contained in the Web application. |
35 | 35 |
|
36 | 36 | Nearly all pages display the URL query call and the JSON response output in the corresponding `JSON response` tab.
|
37 | 37 |
|
38 |
| -A menu entry provides the Swagger API web page of Adabas REST server which can be used to get an overview of available Adabas REST operations. |
| 38 | +A menu entry provides the Swagger API web page of the Adabas REST server which can be used to get an overview of the available Adabas REST operations. |
39 | 39 |
|
40 | 40 | ### Adabas data access
|
41 | 41 |
|
42 |
| -Inside the `Adabas Data access` menu you can access the Adabas example page using Adabas Map references. The Adabas Map administration is done using the `Adabas Client for Java` product delivered by Software AG. The Software AG Adabas Data Designer manage creation, import from various import formats and other administration of Adabas Maps. |
| 42 | +In the `Adabas Data access` menu you can access the Adabas example page using Adabas Map references. The Adabas Map administration is done using the `Adabas Client for Java` product delivered by Software AG. The Software AG Adabas Data Designer manages creation, import from various import formats and other administration of Adabas Maps. |
43 | 43 |
|
44 |
| -The Data access web page contains a number of search parameters like search query, descriptor read or sort criteria. |
| 44 | +The Data access web page contains a number of search parameters like search query, descriptor read and sort criteria. |
45 | 45 |
|
46 |
| -In addition the Adabas classic way to access Adabas data is provided as well. In the classic Adabas data access you need to define the Adabas database id and the Adabas file. The corresponding field list and possible descriptors are selectable. Press `Query Data` to request the record result. |
| 46 | +In addition, the Adabas classic way of accessing Adabas data is provided. In the classic Adabas data access you need to define the Adabas database ID and the Adabas file. The corresponding field list and possible descriptors are selectable. Press `Query Data` to request the record result. |
47 | 47 |
|
48 |
| -To get a deep insight into the Adabas Map metadata it can be evaluated using the `Adabas Map Metadata` entry. |
| 48 | +To get a deep insight into the Adabas Map metadata, it can be evaluated using the `Adabas Map Metadata` entry. |
49 | 49 |
|
50 | 50 | Adabas data records can be modified using the `Modify record` page.
|
51 | 51 |
|
52 | 52 | ### Adabas administration and monitoring
|
53 | 53 |
|
54 |
| -Inside the `Database administration` menu entry the corresponding list of Adabas databases can be viewed. It is possible to administrate and monitor various operation on the database. Dependent on the online state some actions are invisible. |
| 54 | +In the `Database administration` menu entry the corresponding list of Adabas databases can be viewed. It is possible to administrate and monitor various operations on the database. Depending on the online state, some actions are invisible. |
55 | 55 |
|
56 |
| -**Please keep in mind, that shutdown and delete operations and modifications are done on Adabas databases!!!!!** |
| 56 | +**Please keep in mind that shutdown and delete operations and modifications are done on Adabas databases!!!!!** |
57 | 57 |
|
58 | 58 | 
|
59 | 59 |
|
60 |
| -The start and stop of the Adabas databases is initiated in background. Please have a look into the Adabas nucleus log to see the current state. The Adabas databases have a number of tasks which are displayed using the corresponding menues. |
| 60 | +The start and stop of the Adabas databases is initiated in the background. Please have a look in the Adabas nucleus log to see the current state. The Adabas databases have a number of tasks which are displayed using the corresponding menus. |
61 | 61 |
|
62 |
| -Various different monitor tasks are updated periodically. Start and stop operations are called directly. |
| 62 | +Various monitoring tasks are updated periodically. Start and stop operations are called directly. |
63 | 63 |
|
64 | 64 | #### Monitoring
|
65 | 65 |
|
66 |
| -Various Adabas monitoring data can be retrieved. The number of table entries is not cached or optimized. A huge number of queue entries might take influences on the web application performance. |
| 66 | +Various items of Adabas monitoring data can be retrieved. The number of table entries is not cached or optimized. A huge number of queue entries might influence the web application performance. |
67 | 67 |
|
68 | 68 | 
|
69 | 69 |
|
70 | 70 |
|
71 | 71 | ### Job control
|
72 | 72 |
|
73 |
| -To start and display jobs the `Job list` menu entry can be used. |
| 73 | +To start and display jobs, the `Job list` menu entry can be used. |
74 | 74 |
|
75 | 75 | 
|
76 | 76 |
|
77 | 77 | Job modifications are not added to the web application example.
|
78 | 78 |
|
79 | 79 | ## Summary
|
80 | 80 |
|
81 |
| -The example pages don't use all REST API possibilities. Some new or enhanced features are not available. Even queue modifications, like stop or delete user queue entries are not possible. To see the full user queue information is not part of the web application example. |
| 81 | +The example pages don't use all of the REST API possibilities. Some new or enhanced features are not available. Even queue modifications, like stop or delete user queue entries, are not possible. The ability to see the full user queue information is not part of the web application example. |
82 | 82 |
|
83 |
| -**But pay attention. Adabas file delete or refresh operations are part of the web application** |
| 83 | +**But note: Adabas file delete or refresh operations are part of the web application** |
84 | 84 |
|
85 | 85 | Have fun and stay healthy!
|
86 | 86 |
|
|
0 commit comments