Check CKS configuration - ACS - Reference Guides

ACS Installation and Administration Guide

Product
ACS
AFS_Version
7.11
Category
Reference Guides
language
English
audience
public

Call the following service to check if CKS is configured to send/forward error notifications:

${cks_server}/cks/instance/${service_number}-${service_status}/settings/configuration?afs:login=login://${cks_login}:${cks_password}@cks/${service_number}-${service_status}

Ensure that the following parameter is set to true:

<forwardSearchNotificationErrors>true</forwardSearchNotificationErrors>

Otherwise, run the following command to set the value to true to activate error notifications:

curl -H "content-type: application/json" -X PUT --data '{"forwardSearchNotificationErrors": true, "x:partial": true}' ${cks_server}/cks/instance/${service_number}-${service_status}/settings/configuration?afs:login=login://${cks_login}:${cks_password}@cks/${service_number}-${service_status}

The following lines show an example of the notification received the next time an error occurs:

<?xml version="1.0" standalone="yes"?>
<value xmlns="antidot:cks:output" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="antidot:cks:output http://ref.antidot.net/v7/cks.xsd" xsi:type="cks.ws.notification.search">
<metadata xsi:type="dynamic"/>
<source xsi:type="cks.ws.search.afs" reference="/cks/instance/10041-stable/book/12/search/184511">
<metadata xsi:type="dynamic"/>
<id>184511</id>
<hidden>false</hidden>
<tracker xsi:type="ws.tracker">
<creationDate xsi:type="date-time">2017-02-07T12:18:14+01:00</creationDate>
<creator xsi:type="cks.ws.user" partial="true" reference="/cks/instance/10041-stable/user/7">
<id>7</id>
<annotations/>
<email>user@mail.net</email>
<firstName>user</firstName>
<lastName>Root</lastName>
<login>root</login>
</creator>
<modificationDate xsi:type="date-time">2017-02-09T09:26:01+01:00</modificationDate>
</tracker>
<annotations/>
<description>to test scheduled searches</description>
<name>first ss</name>
<rating xsi:type="cks.ws.rating">
<count>0</count>
<value>0.0</value>
</rating>
<book xsi:type="cks.ws.book" reference="/cks/instance/10041-stable/book/12"/>
<lastExecutionDate xsi:type="date-time">2017-02-09T09:26:01+01:00</lastExecutionDate>
<lastResultDate xsi:type="date-time">2017-02-07T12:29:01+01:00</lastResultDate>
<pafIds>
<pafId key="Lnk4c_index" xsi:type="number">1</pafId>
</pafIds>
<schedule xsi:type="cks.ws.schedule.byminute">
<id>1948</id>
<isActive>true</isActive>
<periodicity>1</periodicity>
</schedule>
<url>http://ln360-prj06/search?afs:service=10041</url>
</source>
<subscribers>
<item xsi:type="cks.ws.user" partial="true" reference="/cks/instance/10041-stable/user/7">
<id>7</id>
<annotations/>
<email>user@mail.net</email>
<firstName>user</firstName>
<lastName>Root</lastName>
<login>root</login>
</item>
</subscribers>
<afsData/>
<errorMessage>ReplySet.Meta.lastTimestamp is empty</errorMessage>
<nbResult>0</nbResult>
</value>

Where <errorMessage> show the error notification.