Notification Configuration Methods

Notification configuration methods manage outbound SCI destinations.

createSciDestination()

Creates a new outbound SCI destination.

See also Outbound Methods. The destinationPath should start with a slash "/". An empty string for destinationPath is not permitted. Protocol is "http" or "https". Username and password are allowed, but optional, with https protocol. If the library cannot connect to a SCI destination it retains un-sent events up to retentionTimeLimit. Later, if the library can communication with the destination, it will send all unsent events in the order they occurred. If the library cannot communicate with the detestation within retentionTimeLimit, the library discards all unsent and new events until communication is restored.

Used by ACSLS and WWOPs.

Inputs Outputs Roles Errors

Inputs	Outputs	Roles	Errors
List of EventCategory `eventCategories`, string `destinationProtocol`, string `destinationIpAddress`, string `destinationPort`, string `destinationPath`, string `username`, string `password`, int `retentionTimeLimit`	SciDestinationDto	C2,S2,I	WebServiceException

List of EventCategory eventCategories,

string destinationProtocol,

string destinationIpAddress,

string destinationPort,

string destinationPath,

string username,

string password,

int retentionTimeLimit

SciDestinationDto

C2,S2,I

WebServiceException

deleteDestination()

Deletes the notification destination.

Used by ACSLS and STA.

Inputs	Outputs	Roles	Errors
long `destinationId`	None	C2,S2,I	WebServiceException

getSciDestinations()

Returns a list of SCI destinations. SCI destinations must implement the outbound SCI specification. The library will invoke the outbound SCI methods when the specified list of events occur.

Used by STA and ACSLS.

Inputs	Outputs	Roles	Errors
None	List of SciDestinationDto	All	WebServiceException