An Action bean is a JavaBean that performs a specific telephony function or sequence of functions. The Action beans supported by this toolkit are:
Establishes a telephone call.
Answers an incoming telephone call on behalf of a Resource.
Removes a Resource from a telephone call.
Places an existing telephone call on hold on behalf of the specified Resource.
Retrieves a telephone call that is on hold.
Extends an existing telephone call (places an existing call on hold and attempts to connect to another Resource).
Transfers an existing telephone call from one Resource to another Resource without placing the existing call on hold.
Adds a new Resource to an existing telephone call.
Retrieves a held telephone call and joins the Resources in the retrieved call with the Resources in a second, active telephone call.
Transfers an existing telephone call from a Resource that is currently taking part in the call to a new Resource.
Ends an existing active telephone call and retrieves a telephone call that is on hold.
Provides the application with the latest Key Call Data (such as ANI, DNIS, and applicationCallData) for a call or set of calls.
Logs an Agent into an ACD Resource.
Logs an Agent out of an ACD Resource.
Enables an Agent to handle ACD Resource calls.
Disables an Agent from handling ACD Resource calls.
Disables an Agent from handling ACD Resource calls while the Agent is completing a previous call.
Handles the setting for the agent's current skills.
Places an existing telephone call on hold and retrieves a held telephone call for this resource (enabling the held telephone call to become the active call).
Handles the setting of Do Not Disturb for this resource.
Handles the setting of Forward for this resource.
Places a telephone call that has been offered to this resource.
All properties associated with an Action are related to the invocation of an action() method. These properties:
Properties have attributes that affect the behavior of the bean. Properties, which can be monitored and controlled by the application, are comprised of one or more of the following attributes:
The properties associated with Action beans are:
Attributes: R, B, T
This property represents the latest ANI (Automatic Numbering Identification) associated with the Action. If there are multiple calls with ANI information at the Action, this property will contain the last known value.
Attributes: R, B, T
This property represents the latest application call data associated with the Action. If there are multiple calls with application call data information at the Action, this property will contain the last known value.
Attributes: R, W, B, T
This property is used to associate application information (data) with the ConnectionItem (call) being used or created when an action() or action(ActionStatusEvent) method is invoked.
After the action() or action(ActionStatusEvent) method is invoked, this property is reset by the Action. After the application information (data) is associated with the ConnectionItem (call), the application should control this attribute from the applicationCallData property of the ConnectionItem.
Attributes: R, W, B, T
This property is used by an application to specify a ConnectionItem. It should be used in conjunction with the connectionToUse property when performing the Action (invoking the action() method).
If this property is not set by the application before the action() method is invoked, the Action selects a valid ConnectionItem to use when performing the action() method. For the invocation of the action() method to be successful, the application should use one of the ConnectionItems from the usableAssociatedConnectionItems property when setting this property.
Attributes: R, B, T
This property represents the latest calledNumber associated with the Action. If there are multiple calls with called number information at the Action, this property will contain the last known value.
Attributes: R, W, B, T
This property is used by an application to specify the ConnectItem to use when performing the Action (invoking the action() method). If this property is not set by the application before the action() method is invoked, the Action selects a valid ConnectionItem to use when performing the action() method.
For the invocation of the action() method to be successful, the application should use one of the ConnectionItems from the usableConnectionItems property when setting this property.
Attributes: R, W, B, P
This property indicates the intention of the ConsultCall; whether to
transfer or to conference. This property is only required for certain
telephony switches. Consult the CallPath switch reference documentation
for your switch to see if consultPurpose applies to your
environment. Table 26 shows the possible values for this parameter:
| Type | Value | Description |
|---|---|---|
| TRANSFER_AND_CONFERENCE | 0 | This value indicates consulting in order to transfer or conference. |
| TRANSFER | 1 | This value indicates consulting with the intention to transfer. |
| CONFERENCE | 2 | This value indicates consulting with the intention to conference. |
If using the ConsultCall Action, it is recommended that the application set this property before invoking the action() or action(ActionStatusEvent) method. The default purpose for this property (if it not set) is ConsultCall.TRANSFER_AND_CONFERENCE.
Because this property is persistent, it can be set with a value and retained with the Action until it is changed.
Attributes: R, W, B, P
This property is used by the application to specify the destination (address) of the Action when the action() or action(ActionStatusEvent) method is invoked.
This property is persistent. Its value is retained with the Action until the value is changed.
Attributes: R, B, T
This property represents the latest DNIS (Dialed Number Identification Service) associated with the Action. If there are multiple calls with DNIS information at the Action, this property will contain the last known value.
Attributes: R, B, T
This property indicates why the action() or action(ActionStatusEvent) method failed the last time it was invoked.
Attributes: R, B, T
This property indicates which ConnectionItems are valid for use with the ConnectionItems of the usableConnectionItems property. Each ConnectionItem in this array has attributes (for example, state and associated Resource) that, with the ConnectionItems from the usableConnectionItems property, ensure a high probability that the action() method succeeds.
Attributes: R, B, T
This property indicates which ConnectionItems are valid when invoking the action() method. Each ConnectionItem in this array has attributes (for example, state and associated Resource) that ensure a high probability that the action() method succeeds.
This property should be used when selecting the ConnectionItem to use for setting the connectionToUse property.
This property can be set to true or false. If it is set to true, the ConsultCall bean will wait for the called party to answer before sending the ActionDone event. If set to false, the bean will send the ActionDone event as soon as the consult request is successful. For example, assume waitForAnswer is set to true. If you consult with Party A, and Party A does not answer immediately, the ActionDone event will not send until Party A actually answers. If waitForAnswer is false, the ActionDone event will send while Party A's phone is ringing.
Event sets associated with Action beans are:
Listener: ActionAvailableListener
This event set indicates the availability of the Action to perform its function.
Example: This event set is connected to an AWT (Abstract Windowing Toolkit) button. The AWT button is automatically enabled and disabled depending on the events reported by this event set.
The ActionAvailableEvent contains information associated with each event in this event set. This event extends EventObject and has the following attributes:
The reference to the Action that generated this event.
The list of ConnectionItems that were involved during the invocation of the Action.
The reason this event was generated.
The events and event descriptions in the actionAvailable event set are:
This event is reported to all interested (registered) listeners when the Action determines that it cannot complete successfully. The connectionItems attribute of this event does not contain any entries and the reason attribute is null.
This event is reported to all interested (registered) listeners when the Action determines that it can complete successfully. The connectionItems attribute of this event contains one ConnectionItem and the reason attribute is null.
This event is reported to all interested (registered) listeners when the Action determines that it can complete successfully. The connectionItems attribute of this event contains more than one ConnectionItem and the reason attribute is null.
This event is reported to all interested (registered) listeners when the Action determines that it is permanently disabled until the Action's association with Resource is reset or changed. The connectionItems attribute of this event does not contain any entries and the reason attribute contains the reason the Action is permanently disabled.
This event is reported to all interested (registered) listeners when the Action determines that it can complete successfully. The connectionItems attribute of this event contains more than one ConnectionItem and the reason attribute is null.
Listener: ActionStatusListener
This event set indicates the status of the invocation of a version of an action() method for the Action.
The application connection between this event set and the action(ActionStatus Event) method is how you create script or flow diagram applications using these beans.
Example: This event set is connected to a text field of an application. This text field displays the results of the invocation of the Actions in the application.
The ActionStatusEvent contains the relative information associated with each event in this event set. This event extends EventObject and has the following attributes:
The reference to the Action that generated this event.
The ConnectionItem that was involved during the invocation of the Action.
The reason this event was generated.
Following are the events and event descriptions in the actionStatus event set:
This event is reported to all interested (registered) listeners when the Action determines that an Action() method has been invoked and is in the process of being executed. The reason attribute is null.
This event is reported to all interested (registered) listeners when the Action determines that the invocation of an Action() method has completed successfully. The connectionItem attribute of this event contains the ConnectionItem involved in the execution of the Action and the reason attribute is null.
On the DisconnectCall and TransferCall Actions, the actionDone event should not be connected to the action(ActionStatusEvent) method of another Action, because the ConnectionItem in the event is no longer valid.
This event is reported to all interested (registered) listeners when the Action determines that the invocation of an Action() method has failed at some point during execution.
The connectionItem attribute of this event contains the ConnectionItem involved in the execution of the Action and the reason attribute contains the reason this invocation failed.
Listener: PropertyChangeListener
This event set indicates that the value of a property has changed. This event set is reported only for bounded properties.
The PropertyChangeEvent contains the relative information associated with each event in this event set. This event extends EventObject and has the following attributes:
The text name for the property.
The new value of the property.
The old value of the property.
The event and event description in the propertyChange event set is:
This event is reported to all interested (registered) listeners when the Action determines that the value of a bounded property has changed. See Properties for the properties that are bound.
The methods associated with Action beans are:
When the action() method is invoked, the specific function associated with the Action is executed.
This version uses the actual connectionToUse property as it was set up by the Action or application.
You must set up the following Action properties before invoking this method:
The actions requiring the destination property are MakeCall, ConsultCall, BlindConferenceCall, and BlindTransferCall.
The action requiring the consultPurpose property is ConsultCall, but you can use the default value.
This method is a version of the action() method. When this method is invoked, the specific function associated with the Action is executed. In this version, the method uses the ConnectionItem attribute from the ActionStatusEvent parameter as the connectionToUse property when executing the function of the Action.
The application connection between this method and the actionStatus event set is the way you create script or flow diagram applications using these beans.
The actionDone event from the DisconnectCall and TransferCall Actions should not be connected to the action(ActionStatusEvent) method of another Action, because the ConnectionItem in the event would no longer be valid.
This method is a version of the associate() method. This method associates (connects) a specific ConnectionItem with the Action. When you invoke this method, you focus the Action on the particular ConnectionItem (the focus of the properties, the event sets, and the action() method will all be associated with the ConnectionItem). This method is used when an application is allowing the user to change the focus of a set of Actions based on a set of ConnectionItems (calls).
The association between the ConnectionItem and the Action remains even after the ConnectionItem is no longer valid. The application must change the association (focus) under these conditions.
This method is a version of the associate() method. This method associates (connects) a specific Resource with the Action. When you invoke this method, you focus the Action on the Resource (the focus of the properties, the event sets, and the action() method will be associated with all ConnectionItems associated with the Resource). This method is used when an application is allowing the user to change the focus of a set of Actions based on a set of Resources (for example, telephone numbers).
This method is a version of the associate() method. This method associates (connects) a given Resource from the lineResourceDataInitialized event (when the Resource is ready to be used) with the Action. When you invoke this method, you focus the Action on the particular Resource (the focus of the properties, the event sets, and the action() method will be associated with all ConnectionItems associated with the Resource). This method is used when an application has started the Resource and the Resource is notifying the associated Action that it is ready for processing.