Interaction SDK
(Web Services)

com.genesyslab.ail.ws.srl

Class Summary
SRLCategoriesResponses Defines the result of SRL searches
SRLCategoryDTO This class describes the DTO data for a standard response category.
SRLError This class describes SRL (Standard Response Library) error codes.
SRLForm This class describes an SRL form.
SRLFormResult This class describes a SRL form result.
SRLSearchAttribute Defines a SRL attribute to be searched. If UCS is not connected, you cannot search for SRLs.
SRLSearchTemplate Defines a template for a SRL search. You can use SRLSearchAttribute instances to define Strings to be searched in the subject, the body, the name and/or the description attributes of a standard response (see SRLAttribute). To indicate if you search an attribute matching one of your settings, you specify the SRLOperator.OR by calling the setSrlOperator() method. If you set the SRLOperator.AND, the returned results will match all your settings. Note: Additionally, the search can be case sensitive. See SRLSearchAttribute.
SRLUsernameDTO This class describes a set of the standard response DTO data associated with a username..
StandardResponseDTO This class describes the DTO data of a standard response.

Enum Summary
SRLAttribute Lists the possible attribute types that you can use for a SRL search.
SRLCategoryType Enumeration for the kinds of SRL category type.
SRLOperator Lists the possible operators that you can use for a SRL search.
SRLResponseType Enumeration for the different response types of SRL usage.
SRLSearchCriteria Lists the possible main criterias for a search.

Class Detail

SRLCategoriesResponses

Defines the result of SRL searches

Fields:

  categoryIds  String[]
   The category identifiers.

  srIds  String[]
   The standard response identifiers.

SRLCategoryDTO

This class describes the DTO data for a standard response category.

Fields:

  srlsDTO  com.genesyslab.ail.ws.srl.StandardResponseDTO[]
   An array of standard response DTO data.

  categoryId  String
   The category identifier.

  data  com.genesyslab.ail.ws.KeyValue[]
   The category DTO attributes.

SRLError

This class describes SRL (Standard Response Library) error codes.

Fields:

  srlError  String
   The SRL error code.

  srlId  String
   The SRL identifier.

  attributeErrors  com.genesyslab.ail.ws.AttributeError[]
   The attribute error codes.

SRLForm

This class describes an SRL form.

Fields:

  username  String
   The user name of the agent.

  standardResponseId  String
   The identifier of the standard response.

SRLFormResult

This class describes a SRL form result.

Fields:

  done  boolean
   The action is done.

  SRLForm  com.genesyslab.ail.ws.srl.SRLForm
   The SRL form.

SRLSearchAttribute

Defines a SRL attribute to be searched. If UCS is not connected, you cannot search for SRLs.

Fields:

  attribute  com.genesyslab.ail.ws.srl.SRLAttribute
   The attribute.

  caseSensitive  boolean
   true if the search for this attribute is case sensitive.

  searchValue  String
   The search value.

SRLSearchTemplate

Defines a template for a SRL search. You can use SRLSearchAttribute instances to define Strings to be searched in the subject, the body, the name and/or the description attributes of a standard response (see SRLAttribute). To indicate if you search an attribute matching one of your settings, you specify the SRLOperator.OR by calling the setSrlOperator() method. If you set the SRLOperator.AND, the returned results will match all your settings. Note: Additionally, the search can be case sensitive. See SRLSearchAttribute.

Fields:

  attributes  com.genesyslab.ail.ws.srl.SRLSearchAttribute[]
   The search attributes.

  srlOperator  com.genesyslab.ail.ws.srl.SRLOperator
   The search operator.

SRLUsernameDTO

This class describes a set of the standard response DTO data associated with a username..

Fields:

  srlDTO  com.genesyslab.ail.ws.srl.StandardResponseDTO[]
   An array of standard response DTO data.

  username  String
   User name of the agent.

StandardResponseDTO

This class describes the DTO data of a standard response.

Fields:

  data  com.genesyslab.ail.ws.KeyValue[]
   The DTO attributes.

  srlId  String
   The SRL identifier.

Enum Detail

SRLAttribute

Lists the possible attribute types that you can use for a SRL search.

Members:

  BODY
   The BODY SRL attribute.

  DESCRIPTION
   The DESCRIPTION SRL attribute.

  NAME
   The NAME SRL attribute.

  SUBJECT
   The SUBJECT SRL attribute.

SRLCategoryType

Enumeration for the kinds of SRL category type.

Members:

  BOTH
   Both: EMAIL and WSS.

  EMAIL
   EMAIL.

  WSS
   Web Self Service.

SRLOperator

Lists the possible operators that you can use for a SRL search.

Members:

  AND
   The and SRL operator.

  OR
   The or SRL operator.

SRLResponseType

Enumeration for the different response types of SRL usage.

Members:

  AGENT_CHOOSE_NOT_IN_SUGGESTED_RESPONSE_TYPE
   Agent received suggested responses on the desktop but choose to ignore them and choose another one from SRL.

  AGENT_CHOOSE_ONE_OF_SUGGESTED_RESPONSE_TYPE
   Agent received suggested responses on the desktop and choose one of them and replied.

  AGENT_CHOOSE_STANDARD_RESPONSE_TYPE
   Agent did not receive suggested responses from content analyzer and choose a standard response from SRL.

  CONFIGURED_RESPONSE_TYPE
   The system replied automatically with a specific response chosen by administrator.

SRLSearchCriteria

Lists the possible main criterias for a search.

Members:

  ALL
   Search in both categories and standard responses.

  CATEGORY
   Search in categories.

  STANDARD_RESPONSE
   Search in standard responses only.

Interaction SDK
(Web Services)