ProtocolAccess Service

1 Introduction
2 Preconditions
3 Usage:
- 3.1 Endpoints
  - 3.1.1 GET
  - 3.1.2 DELETE
- 3.2 Functionality
  - 3.2.1 Protocol entry cleanup
4 Configuration in repository.cfg

Introduction

The ProtocolAccess 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 Access 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:

Parametername	Type	Value Sample

Parametername	Type	Value Sample
repository	String	FI
requestId	String	35c91fb2-8eed-4237-8cab-27b50070b6a1
startTime	ISO with TimeZone	2023-06-14T12:28:22.000Z
endTime	ISO with TimeZone	2023-06-14T12:29:30.123Z
commandStatus	String	One of: error success

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.

The listed configuration is available since tia core (CMIS,SAPTTP,ILM) version >= 3.1.0

Configuration in repository.cfg

<repoName>.protocolservice.deleteafterdays=90