General Information

#### Search Results

Search

# General Information

Adabas RESTful administration consists of three main access parts:

- Adabas Administration and Monitor Handler

- Job Control

- File Transfer Handler

- Technical Insight

- Adabas Batch Administration

- Merge Adabas RESTful Server

## Adabas Administration and Monitor Handler

The Adabas administration and monitor handler supports:

Resource | Description
--- | ---
Adabas Database | An Adabas database can be created or deleted on the server.
Adabas Runtime | Adabas can be started or stopped using the possibilities that Adabas provides. User queue and UCB entries can be managed. Provides Adabas Nucleus log.
Monitor | Display Adabas user queue, command queue and hold queue. Adabas high water marks and buffer pool statistics are available. All possible monitor features can be found in the Swagger definition.
Adabas Files | Provide the creation and deletion of new Adabas files (online) .
Adabas Fields | Inside the Adabas file, Adabas fields can be modified in the frame of the Adabas functionality.

## Job Control

Inside the RESTful server it is possible to start scripts for Adabas utilities. The scripts can be triggered asynchronously. After the job is finished, the corresponding log output can be retrieved using a RESTful access.

Detailed information about the RESTful interface is described in the Swagger definition.

## File Transfer Handler

The RESTful server provides an interface to upload or download files to or from the server. The server only provides access to restricted, defined directories. The directories have to be configured in the configuration file.

Each configuration entry can be accessed via a given name. All subdirectories under the configured one can be accessed and files can be transferred.

If a job creates output, the created file can be transferred to the HTTP client (browser or RESTful client).

## Technical Insight

Adabas RESTful administration includes standard RESTful HTTP access methods. It supports two types of response formats:

- JSON is the standard supported response format you can use.

- XML can be used for read requests.

Adabas RESTful administration also supports SSL-secured HTTPS connections. HTTPS connections are recommended. For further information about configuring secure REST connections and secure data resource accesses, refer to the section RESTful Security.

Adabas RESTful administration supports the following HTTP/S request types:

- GET: Retrieve administration or monitor information

- PUT: Change an administration value or parameter in the Adabas database configuration

- PUSH: Create new objects such as Adabas database files or an Adabas database

- DELETE: Delete a resource inside the Adabas database

The Adabas REST administration server is open to be used by any RESTful client. There are no restrictions by Software GmbH components. The RESTful definition is provided in the Swagger file located in the product installation. You can use the Swagger/OpenAPI infrastructure to use the Swagger file.

## Adabas Batch Administration

On the Software AG GITHUB page, you can download a batch administration client. The client application can access all flavors of Adabas administration tasks that the Adabas RESTful administration server provides.

The GITHUB page can be found at <https://github.com/SoftwareAG/adabas-admin-restful-client>.

The following example shows the batch command to list all available databases on the remote server:

    client -url <host>:<port> list

The output of this example out would look something like this:

    2018/10/10 12:40:54 Adabas Administration RESTful client started

    2018/10/10 12:40:54 Server: linhost:8390
    2018/10/10 12:40:54 User:   admin

    Enter Password:
     Dbid   Name                  Active    Version

      001 [TestDatabase    ]      false    Adabas v6.6 (20)
      015 [SAMPLE_DB       ]      false    Adabas v6.6 (20)
      050 [GENERAL_DATABASE]      false    Adabas v6.5 (19)
      075 [GENERAL_DATABASE]      false    Adabas v6.7 (21)
      102 [GENERAL_DATABASE]      false    Adabas v6.6 (20)
      155 [SAMPLE_DB       ]      false    Adabas v6.7 (21)
      195 [DEMODB          ]      false    Adabas v6.7 (21)

    2018/10/10 12:40:57 Adabas Administration RESTful client took 61.262267ms terminated

In batch mode, the ADABAS_ADMIN_URL environment points to the Adabas RESTful administration server, and the ADABAS_ADMIN_PASSWORD environment can contain the user password.

The Adabas batch client supports the following commands/functionality:

Command | Functionality
--- | ---
env | List Adabas environment version
list | List all Adabas databases
start | Start Adabas database
shutdown | Shutdown Adabas database
cancel | Cancel Adabas database
abort | Abort Adabas database
info | Retrieve Adabas database information
userqueue | Display current user queue
cmdqueue | Display current command queue
holdqueue | Display current hold queue
highwater | Display high water mark
commandstats | Display Adabas command statistics
bp | Display Adabas buffer pool statistics
activity | Display Adabas activity
threadtable | Display Adabas thread table
createdatabase | Create new Adabas database
deletedatabase | Delete an Adabas database
renamedatabase | Rename an Adabas database
parameter | List database parameter information
parameterinfo| | List database parameter information with minimum and maximum ranges
setparameter | Set database parameter
nucleuslog | Display Adabas nucleus log
files | Display Adabas file list
file | Display Adabas file
deletefile | Delete Adabas file
fields | Display Adabas file definition table
information | Display Adabas database information
container | Display Adabas database container
renamefile | Rename database file
createfile | Create database file
checkpoints | Display database checkpoints. Without parameter it shows one day. The following is a parameter example with from and to parameter: 2018-05-15_01:00:00,2018-05-20_00:00:00
joblist | Job control list
jobstart | Start a specific job
deletejob | Delete a specific job and the execution log
deletejobexec | Delete the execution log of a job
createjob | Create a new specific job
joblog | Job entry log
listucb | List Adabas UCB entries
deleteucb | Delete an Adabas UCB entry
addfields | Add Adabas fields
status | Adabas database online state
filelocations | List all available file locations
listfiles | List files in file location
downloadfile | Download file from the file location
uploadfile | Upload file to file location

## Merge Adabas RESTful Server

The Adabas client for Java contains a module to access Adabas database data content. It is possible to enable the data access in the Adabas RESTful administration server. Please contact our support for the steps required to enable this data access.

### On this page

- Adabas Administration and Monitor Handler
- Job Control
- File Transfer Handler
- Technical Insight
- Adabas Batch Administration
- Merge Adabas RESTful Server