Header Element

The first subelement of all payloads is ses-header. The ses-header element contains information about the identity of the two parties that exchange the payload.

<!ELEMENT ses-header (ses-sender, ses-receiver?, ses-authentication?)>
<!ELEMENT ses-sender EMPTY>
<!ATTLIST ses-sender
  sender-id CDATA #REQUIRED
  name CDATA #REQUIRED>
<!ELEMENT ses-receiver EMPTY>
<!ATTLIST ses-receiver
  receiver-id CDATA #REQUIRED
  name CDATA #REQUIRED>
<!ELEMENT ses-authentication EMPTY>
<!ATTLIST ses-authentication
  login CDATA #REQUIRED
  password CDATA #REQUIRED>

ses-sender

The ses-sender element must always appear as the subelement of the ses-header element. It specifies the identity of the payload sender. The attributes of the ses-sender elements have the following meaning:

  • sender-id
    Payload sender ID. During the installation, each CMS server application and the clients are allocated an ID which is unique within the communication context. This ID is used in the creation of the payload as the sender-id.
  • name
    Payload sender name. The name is a string which identifies the application which sends the payload. The Search Engine Server uses SES as the name.

ses-receiver

The ses-receiver element specifies the identity of the desired receiver of the payload. This element is optional as long as there is an individual network connection between the server and the client. In this case, the sender of the payload and the receiver are uniquely identified. If, however, between the server and the client there is a proxy server which serves several clients or servers, both the server and the client can use the ses-receiver element to inform the proxy server of the receiver. The attributes of the ses-receiver elements have the following meaning:

  • receiver-id
    Payload receiver ID. This attribute has the same semantics as the sender-id attribute of the ses-sender element. It contains the ID of the NPS server or NPS client which is to receive the payload. The ID is unique within a communication context. For response payloads, this attribute is always a copy of the sender-id attribute of the ses-sender element in the corresponding request payload.
  • name
    Name of the receiver. The name is a string which identifies the desired receiver application. For response payloads, this attribute is a copy of the name attribute of the ses-sender element in the corresponding request payload.

ses-authentication

The ses-authentication element is optional. It can only be used in request payloads. It contains information about the user for whom the request is to be processed. The attributes of the ses-authentication element have the following meaning:

  • login
    The login of the user of the Search Engine Server.
  • password
    The password of the user (clear text).