2 Outbound Methods

The library calls outbound SCI methods when specific events occur.

To receive the outbound calls, you must configure a connection using createSciDestination(). Outbound SCI configuration has a protocol option that allows http or https. If the protocol is https, the library includes a WS-Security username and password token in the SOAP header to the outbound SCI destination. If the protocol is http, the library does not send a username and password token as it would be visible in clear text.

The library will make calls to the destination until you delete or disable the connection. Outbound methods are grouped by EventCategory. You can configure a destination to receive SCI calls for one, several, or all categories.

If communication with the destination is disrupted, the library will queue the calls for the retentionTimeLimit specified for the destination. The time period is limited because of available space. This is intended to deal with temporary network outages, not as a means to have the library retain history for later delivery. 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.

Outbound methods only specify input parameters, which are the data objects sent from the library to the called SCI service. The library does not expect a response from any of the methods except for ping(), which must return a string indicating success.

• auditComplete()
• capacityChanged()
• capClosed()
• capOpened()
• capOwnershipOverridden()
• capReadyToOpen()
• deviceControlStateChange()
• deviceFailed()
• deviceInstalled()
• deviceRemoved()
• doorClosed()
• doorOpened()
• driveCleaningNeeded()
• faultDetected()
• intermediateData()
• libraryComplexStateChange()
• libraryStateChange()
• lostCartridges()
• mediaValidationDrivePoolModified()
• moveData()
• partitionChanged()
• ping()
• railStateChange()
• test()

auditComplete()

Sends a notification when a physical audit (scan of barcodes) completes.

Category	Inputs	Outputs
LIBRARY	AuditEventDataDto	None

capacityChanged()

Sends a notification when the licensed capacity of the library complex changes.

Used by STA.

Category	Inputs	Outputs
CAP	LicensedCapacityChangeEventDataDto	None

capClosed()

Sends a notification when a CAP closes and the audit completes.

Used by STA

Category	Inputs	Outputs
CAP	CapMoveEventDataDto	None

capOpened()

Sends a notification when a CAP opens.

Used by STA.

Category	Inputs	Outputs
CAP	CapMoveEventDataDto	None

capOwnershipOverridden()

Sends a notification when the ownership of the CAP has been forcibly removed from a partition.

Used by STA.

Category	Inputs	Outputs
CAP	CapOwnerOverriddenEventDataDto	None

capReadyToOpen()

Sends a notification when you need to open a CAP. The library sends this call when ejectExpiredCleaningCartridges, ejectCartridges, or continueEject processes require the operator to open the CAP.

Used by STA.

Category	Inputs	Outputs
CAP	CapReadyToOpenEventDataDto	None

deviceControlStateChange()

Sends data about a device when its control state changes. This is usually for a device coming online or going offline, though some device types may have other states.

Used by STA.

Category	Inputs	Outputs
DEVICE	DeviceEventDataDto	None

deviceFailed()

Sends data when a device fails. Typically, the library also sends an ASR for the failure.

Used by STA.

Category	Inputs	Outputs
DEVICE	DeviceEventDataDto	None

deviceInstalled()

Sends data when a devices is installed into the library. Only sent when a device is installed while the library is operating.

Used by STA.

Category	Inputs	Outputs
DEVICE	DeviceEventDataDto	None

deviceRemoved()

Sends data when you remove a device from the library. Typically, the library only makes this call for a FRU because you must power off the library to remove most other devices.

Used by STA.

Category	Inputs	Outputs
DEVICE	DeviceEventDataDto	None

doorClosed()

Sends a notification when a door closes and the audit completes.

Used by STA.

Category	Inputs	Outputs
DOOR	DoorEventDataDto	None

doorOpened()

Sends a notification when a door opens.

Used by STA.

Category	Inputs	Outputs
DOOR	DoorEventDataDto	None

driveCleaningNeeded()

Sends a notification when a drive reports that it needs cleaning by an application. The library does not send this call if library auto-cleaning is enabled.

Used by STA.

Category	Inputs	Outputs
CLEANING_REQUIRED	DriveCleanNeededEventdataDto	None

faultDetected()

Sends data about an alert condition. Alerts are conditions in the library that require intervention.

Generally, the library also sends ASRs or SNMP traps. Over temp events might trigger an alert. Not all alerts are device failures, but all device failures are alerts.

Used by STA.

Category	Inputs	Outputs
DEVICE	FaultEventDataDto	None

intermediateData()

Sends a notification one minute after media validation starts and then every 10 minutes. This call can also be made available for normal (non media validation) mounts.

Used by STA.

Category	Inputs	Outputs
MEDIA_VALIDATION	IntermediateMountDriveEventDataDto	None

libraryComplexStateChange()

Sends data about the library complex when the library complex's functional state (such as normal or fault) or control state (online, offline) changes.

Used by STA.

Category	Inputs	Outputs
LIBRARY	LibraryComplexEventDataDto	None

libraryStateChange()

Sends data about a library when the library's functional state (such as normal or fault) or control state (online, offline) changes.

Used by STA.

Category	Inputs	Outputs
LIBRARY	LibraryEventDataDto	None

lostCartridges()

Sends a notification whenever the library identifies a "lost" cartridge. Lost cartridges can occur when the library finds a cartridges, but the library cannot determine the proper location for the cartridge.

Used by STA.

Category	Inputs	Outputs
LIBRARY	LostCartridgesEventDataDto	None

mediaValidationDrivePoolModified()

Sends a notification when the media validation drive pool changes. The call returns one element for each drive in the media validation pool.

Used by STA.

Category	Inputs	Outputs
MEDIA_VALIDATION	MediaValidationDrivePoolModifiedEventDataDto	None

moveData()

Sends a notification for any cartridge move.

Used by STA.

Category	Inputs	Outputs
CARTRIDGE_MOVEMENT	CartridgeMoveEventDataDto	None

partitionChanged()

Sends a notification when a partition changes. Generally, any partitioning changes involve at least two partitions, because the commands that change partitions move cells and drives from one partition to another.

Used by STA.

Category	Inputs	Outputs
PARTITION	PartitionEventDataDto for affected partitions	None

ping()

The library calls ping() when an outbound SCI destination is created to verify connectivity.

The library passes in a string containing the library's hostname. The ping() method should return a string indicating success that will be appended into the library logs.

Category	Inputs	Outputs
None	String	String

railStateChange()

Sends data about a rail when the rail's functional state changes (such as normal or fault).

Used by STA.

Category	Inputs	Outputs
LIBRARY	RailEventDataDto	None

test()

Sends a test event to verify connectivity after a call to createTestEvent().

Category	Inputs	Outputs
TEST	TestEventDataDto	None