Protocol Reader Service

Introduction

The Protocol Reader Service enables a client to connect to the Application via REST and receive ProtocolEntries that were stored previously by the ProtocolService. It starts automatically in the tia Core for all protocols (SAPHTTP, CMIS and ILM).

Preconditions

As of today, Protocol Reader Service is only available for database.

Tia-Core needs a configured protocol section. See : Protocol Database (tC)

Usage:

The Protocol Reader Service exposes following REST-Endpoints:

Endpoints

GET

http://<Server>:<port>/protocolaccess/records?repository=<String repoName>&requestId=<String RequestId>
http://<Server>:<port>/protocolaccess/records?repository=<String repoName>&startTime=<ISO startTime>&endTime=<ISO endTime>&offset=<int offset>&pageSize=<int pageSize>
http://<Server>:<port>/protocolaccess/records?repository=<String repoName>&startTime=<ISO startTime>&endTime=<ISO endTime>&offset=<int offset>&pageSize=<int pageSize>&commandStatus=[String commandStatus]

Allowed Parameters:

DELETE

http://<Server>:<port>/protocolaccess/records/cleanup (only available in test mode)

Functionality

Protocol entry cleanup

If configured in the repository.cfg, the tia® CS core checks every night at 2 a.m. whether there are protocol entries that are older than the configured days.

If entries are found, they are deleted.

Configuration in repository.cfg

<repoName>.protocolservice.deleteafterdays=90 (CS core version >= 3.1.0)