{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"c5748a6c-c22a-43e0-ba30-1bd0cb0cbcfe"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"6158d944-13e9-408f-8ea7-0a6d98f138fe"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Introduction","type":"text"}]},{"type":"paragraph","content":[{"text":"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).","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Preconditions","type":"text"}]},{"type":"paragraph","content":[{"text":"As of today, Protocol Reader Service is only available for database.","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Tia-Core needs a configured protocol section. See : ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://kgs-software.atlassian.net/wiki/spaces/DOCUEN/pages/2415951873"}},{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage:","type":"text"}]},{"type":"paragraph","content":[{"text":"The Protocol Access Service exposes following REST-Endpoints:","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Endpoints","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"GET","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"http://:/protocolaccess/records?repository=&requestId=\nhttp://:/protocolaccess/records?repository=&startTime=&endTime=&offset=&pageSize=\nhttp://:/protocolaccess/records?repository=&startTime=&endTime=&offset=&pageSize=&commandStatus=[String commandStatus]","type":"text"}]},{"type":"paragraph","content":[{"text":"Allowed Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"81603ee5-c801-4718-8139-16faed4ef37b"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parametername","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Value Sample","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"repository","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"FI","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"requestId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"35c91fb2-8eed-4237-8cab-27b50070b6a1","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"startTime","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ISO with TimeZone","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"2023-06-14T12:28:22.000Z","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"endTime","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ISO with TimeZone","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"2023-06-14T12:29:30.123Z","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"commandStatus","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"One of:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"error","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"success","type":"text"}]}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"DELETE","type":"text"}]},{"type":"codeBlock","content":[{"text":"http://:/protocolaccess/records/cleanup (only available in test mode)","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Functionality","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Protocol entry cleanup","type":"text"}]},{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"paragraph","content":[{"text":"If entries are found, they are deleted.","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"The listed configuration is available since tia core (CMIS,SAPTTP,ILM) version >= 3.1.0","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Configuration in repository.cfg","type":"text"}]},{"type":"codeBlock","content":[{"text":".protocolservice.deleteafterdays=90","type":"text"}]}],"version":1}

Browser not supported