Implementation Guide › Adapter Configuration Specifications › CA Business Service Insight Interface Section

CA Business Service Insight Interface Section

The CA Business Service Insight Interface section consists of attributes specifying the connection to CA Business Service Insight. There are two modes; online and offline. In online mode the adapter connects to CA Business Service Insight, gets the translation tables and control command from CA Business Service Insight and send events, statues and translation requests to CA Business Service Insight. In offline mode the adapter works with a local translation tables file and writes the events to an output file.

XML Structure for online mode:

<OblicoreInterface
	Mode="online">
	<OnlineInterface
		Port="3006"
		ConnectionInitiator="server"
		Address="localhost"
		SecurityLevel="high"
		SecurityKey="12345678901234567890123456789012"
		UseAcknowledgeProtocol="yes"
		PacketSize="50"	
		PacketDeadline="60"
		PacketResendTimeout="60"
		WindowSize="10"
      />
</OblicoreInterface>

• Port-The TCP/IP port number the Adapter uses to communicate with CA Business Service Insight server.
• ConnectionInitiator-(optional)

  Legal Values-server/adapter. Default value-server.

  Defines the connection initiator, the Adapter side or the Adapter listener on CA Business Service Insight side.

  The initiator plays the 'slave' or client role, while the other is the 'master' or server role.

• Address-Server network address it is mandatory when the initiator is the adapter.
• SecurityLevel-Defines the level of authentication between the Adapter and CA Business Service Insight server ("Hand Shake"). Level options:
  • none-No authentication is performed.
  • high-authentication is performed. The SecurityKey must be supplied.
• SecurityKey-string of 32 digits. It must be the same string as defined to the adapter in CA Business Service Insight database.

  The flow of the "Hand Shake" process is a follows:

  • CA Business Service Insight server connects to the Adapter.
  • A random string is sent from the Adapter to CA Business Service Insight server.
  • CA Business Service Insight server encrypts the string with a pre-configured key and sends the result back to the Adapter.
  • The Adapter encrypts the same random string that was sent to CA Business Service Insight server using the SecurityKey string and compares the results.
  • CA Business Service Insight server randomizes a string and sends the string to the Adapter.
  • The Adapter encrypts the string with and sends it back to CA Business Service Insight server.
  • CA Business Service Insight server encrypts the same string and compares the results to what has been received from the Adapter.
  • The connection is established.
  • If any fault is detected in any of the phases in the flow, the connection is not established.
• UseAcknowledgeProtocol-(optional)

  Legal Values-[yes/no] Default value-yes

  When set to yes, the adapter uses the acknowledge protocol. When set to no, the adapter sends the messages/packets and does not wait for the acknowledgement from CA Business Service Insight.

  It is not recommended to set this attribute to "no" because there is a chance that you may lose events.

• PacketSize-(optional)

  Legal Values-1 to 1000

  Default Value-50

  Maximum number of events in one packet.

• PacketDeadline-(optional)

  Legal Values-1 to 3600

  Default Value-60

  Number of seconds before sending a packet that is not full.

• PacketResendTimeout-(optional)

  Legal Values-1 to 3600

  Default Value-60

  Amount of time in seconds to wait for acknowledgement message before sending the packet again. This attribute is applicable only when the UseAcknowledgeProtocol attribute is set to yes.

• WindowSize-(optional)

  Legal Values-1 to 100

  Default Value-10

  Number of packets in window. This attribute is applicable only when the UseAcknowledgeProtocol attribute is set to yes.

XML Structure for offline mode:

<OblicoreInterface
	Mode="offline">
	<OfflineInterface
		OutputFileName="outputEvents.txt"
		OutputFileType="tsv"
		OutputTimeFormat="%Y/%m/%d %H:%M:%S"
		OutputDecimalSymbol="."
	/>
</OblicoreInterface>

• OutputFileName-(optional)

  Name of the file to which the adapter writes the output events.

  Default Value-AdapterOutput.txt (If not otherwise specified, the default value is used.)

• OutputFileType-(optional)

  Legal Values-csv/tsv/xml

  Defines the event format.

• OutputTimeFormat-defines the date fields' format. This attribute can be omitted if the DefaultTimeFormat attribute, in the General section, was defined.
• OutputDecimalSymbol-(optional)

  Defines the decimal symbol for read fields.

  Default Value-. (point)