Interface IDataTransaction
- All Superinterfaces:
IDisposable, IEntity
Represents a data transaction.
-
Method Summary
Modifier and TypeMethodDescriptionvoidabort(boolean synchronous) Aborts the data transaction.voidRegisters the ContactLoadedListener.voidRegisters the ContactLoadProgressListener.voidRegisters the ContactProfileUpdatedListener.voidRegisters the ContactUnloadedListener.voidRegisters the DataTransactionEndedListener.intcreateContactProfile(int directoryId, Attribute[] values) Creates a contact profile.voiddiscard(boolean synchronous) Discards the data transaction.voidend(boolean synchronous) Stops the data transaction.voidexecuteRequest(DataTransactionRequest request, DataTransactionDataRequest dataRequest, boolean validate) Set the properties specified in thedataRequestand then executes therequest.getAgent()Name of the agent.Returns the allowed operations on the data transaction.Contact attributes in the case of a contact, or workflow attributes in the case of a workflow.Returns theAttributesformatted to be displayed in a GUI.Average talking time of the agent in the campaign.Average talking time of the campaign.Average delivery time of the call.Gets or sets the business status.Campaign of the data transaction.intIdentifier of the campaign.Name of the campaign.intIdentifier of the contact.intIdentifier of the contact profile.Contact attributes of the contact table.intIdentifier of the directory.In the case of an outbound contact, contact attributes when the session was created.Returns theInitialAttributesformatted to be displayed in a GUI.Moment.Outbound address type.Gui name of the outbound rule.Name of the outbound rule.Attribute[][]Gets or sets the outcomes.Attribute[][]Returns the formatted outcomes.Previous interaction status.intPriority.The reschedule phone.The Reschedule phone schedule rule.Reschedule moment limit.Returns the contact business data stored in database.Returns the session associated with the data transaction.Name of the skill profile.The start time.Abbreviation of the time zone of the contact.Attributes transferred with the session.intIdentifier of the transferred contact profile.intIdentifier of the transferred directory.booleanIf true, use the do not call list.voidinNode(int nodeId) Informs the instance, for outbound campaigns, that the script is entering a specific node.loadContactByContactId(int contactId) Loads a contact.loadContactByContactProfileId(int directoryId, int contactProfileId) Loads a contact.Refresh the session contact business data, overwriting the attributes saved in memory that have been updated, with the ones currently stored in database.voidUnregisters the ContactLoadedListener.voidUnregisters the ContactLoadProgressListener.voidUnregisters the ContactProfileUpdatedListener.voidUnregisters the ContactUnloadedListener.voidUnregisters the DataTransactionEndedListener.voidrescheduleContact(GregorianCalendar rescheduleMoment, Duration rescheduleTimeLimit, String agentName, int priority, String outboundRule, boolean usesDoNotCallList, String skillProfileName, SkillInProfile[] skills) Reschedules the contact.voidReschedules the contact with failed reason.reserveContact(boolean refreshAttributes) Reserves a loaded contact that currently is not reserved by the agent.voidrestart(String campaignName, DataTransactionRestartMode mode, Attribute[] attributes, boolean synchronous) Ends the data transaction in the current campaign and starts the data transaction in another campaign.voidsetAttributes(Attribute[] value) Contact attributes in the case of a contact, or workflow attributes in the case of a workflow.voidsetBusinessStatus(BusinessStatus value) Gets or sets the business status.voidsetContactProfile(int directoryId, int contactProfileId) Sets the contact profile.voidsetOutcomes(Attribute[][] value) Gets or sets the outcomes.voidsetReschedulePhone(String value) The reschedule phone.voidThe Reschedule phone schedule rule.voidsetRescheduleTimeLimit(Duration value) Reschedule moment limit.voidsetTimeZoneName(String value) Abbreviation of the time zone of the contact.voidsetUsesDoNotCallList(boolean value) If true, use the do not call list.voidUnloads the manual loaded contact.voidupdateContactProfile(Attribute[] values) Updates a contact profile.Methods inherited from interface IDisposable
addDisposedListener, removeDisposedListenerMethods inherited from interface IEntity
getUserContext, setUserContext
-
Method Details
-
addContactLoadedListener
Registers the ContactLoadedListener.- Parameters:
listener- Event listener to add.
-
removeContactLoadedListener
Unregisters the ContactLoadedListener.- Parameters:
listener- Event listener to remove.
-
addContactLoadProgressListener
Registers the ContactLoadProgressListener.- Parameters:
listener- Event listener to add.
-
removeContactLoadProgressListener
Unregisters the ContactLoadProgressListener.- Parameters:
listener- Event listener to remove.
-
addContactProfileUpdatedListener
Registers the ContactProfileUpdatedListener.- Parameters:
listener- Event listener to add.
-
removeContactProfileUpdatedListener
Unregisters the ContactProfileUpdatedListener.- Parameters:
listener- Event listener to remove.
-
addContactUnloadedListener
Registers the ContactUnloadedListener.- Parameters:
listener- Event listener to add.
-
removeContactUnloadedListener
Unregisters the ContactUnloadedListener.- Parameters:
listener- Event listener to remove.
-
addDataTransactionEndedListener
Registers the DataTransactionEndedListener.- Parameters:
listener- Event listener to add.
-
removeDataTransactionEndedListener
Unregisters the DataTransactionEndedListener.- Parameters:
listener- Event listener to remove.
-
abort
-
createContactProfile
int createContactProfile(int directoryId, Attribute[] values) throws Exception, altitude.integrationServer.exceptions.ISException Creates a contact profile.- Parameters:
directoryId- Identifier of the directory.values- The contact profile data.- Returns:
- The contact profile identifier.
- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
discard
void discard(boolean synchronous) throws Exception, altitude.integrationServer.exceptions.ISException Discards the data transaction.The method ends the script without creating a new contact or changing the state of a loaded contact.
- Parameters:
synchronous- If true, the method is synchronous.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
end
Stops the data transaction.In case of an error when saving to the database, the
ICampaign.SaveActivityErrorEventis sent. Enumerated attributes with invalid value are sent to the instance as Int32.MinValue. The method ends the script and updates the Altitude uCI Server database. The script only sends the changed attributes to the server.- Parameters:
synchronous- If true, the method is synchronous.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
executeRequest
void executeRequest(DataTransactionRequest request, DataTransactionDataRequest dataRequest, boolean validate) throws Exception, altitude.integrationServer.exceptions.ISException Set the properties specified in thedataRequestand then executes therequest.- Parameters:
request- Request to execute.dataRequest- Request data to set.validate- If true, the attributes and outcomes are validated before the request is executed.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getAgent
-
getAllowedOperations
DataTransactionCanDo getAllowedOperations() throws Exception, altitude.integrationServer.exceptions.ISExceptionReturns the allowed operations on the data transaction.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getAttributes
Contact attributes in the case of a contact, or workflow attributes in the case of a workflow. No validation of the attributes is made. Enumerated attributes with invalid value are sent to the instance as Int32.MinValue. The attributes are sent to the instance in the End method.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
setAttributes
void setAttributes(Attribute[] value) throws Exception, altitude.integrationServer.exceptions.ISException Contact attributes in the case of a contact, or workflow attributes in the case of a workflow. No validation of the attributes is made. Enumerated attributes with invalid value are sent to the instance as Int32.MinValue. The attributes are sent to the instance in the End method.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getAttributesFormatted
-
getAvgDataTransactionAgent
-
getAvgDataTransactionCampaign
-
getAvgDeliverTime
-
getBusinessStatus
BusinessStatus getBusinessStatus() throws Exception, altitude.integrationServer.exceptions.ISExceptionGets or sets the business status.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
setBusinessStatus
void setBusinessStatus(BusinessStatus value) throws Exception, altitude.integrationServer.exceptions.ISException Gets or sets the business status.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getCampaign
-
getCampaignId
-
getCampaignName
-
getContactId
-
getContactProfileId
-
getDataTransactionData
DataTransactionData getDataTransactionData() throws Exception, altitude.integrationServer.exceptions.ISExceptionContact attributes of the contact table.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getDirectoryId
-
getInitialAttributes
Attribute[] getInitialAttributes() throws Exception, altitude.integrationServer.exceptions.ISExceptionIn the case of an outbound contact, contact attributes when the session was created. In the case of an inbound contact and data-only session, contact attributes when the contact was loaded. In the case of a workflow, workflow attributes when the session was created.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getInitialAttributesFormatted
-
getMoment
Moment.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getOutboundAddressType
AddressType getOutboundAddressType() throws Exception, altitude.integrationServer.exceptions.ISExceptionOutbound address type.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getOutboundRuleGuiName
-
getOutboundRuleName
-
getOutcomes
-
setOutcomes
-
getOutcomesFormatted
-
getPreviousStatus
InteractionStatus getPreviousStatus() throws Exception, altitude.integrationServer.exceptions.ISExceptionPrevious interaction status.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getPriority
-
getReschedulePhone
-
setReschedulePhone
-
getReschedulePhoneScheduleRule
-
setReschedulePhoneScheduleRule
-
getRescheduleTimeLimit
-
setRescheduleTimeLimit
-
getSavedContactAttributes
-
getSession
-
getSkillProfileName
-
getStartTime
GregorianCalendar getStartTime() throws Exception, altitude.integrationServer.exceptions.ISExceptionThe start time.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getTimeZoneName
-
setTimeZoneName
-
getTransferredAttributes
-
getTransferredContactProfileId
-
getTransferredDirectoryId
-
getUsesDoNotCallList
-
setUsesDoNotCallList
-
inNode
Informs the instance, for outbound campaigns, that the script is entering a specific node.- Parameters:
nodeId- Identifier of the node in the script.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
loadContactByContactId
DataTransactionData loadContactByContactId(int contactId) throws Exception, altitude.integrationServer.exceptions.ISException Loads a contact.- Parameters:
contactId- Identifier of the contact.- Returns:
- The
DataTransactionDataobject with the loaded contact. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
loadContactByContactProfileId
DataTransactionData loadContactByContactProfileId(int directoryId, int contactProfileId) throws Exception, altitude.integrationServer.exceptions.ISException Loads a contact.- Parameters:
directoryId- Identifier of the directory.contactProfileId- Identifier of the contact profile.- Returns:
- The
DataTransactionDataobject with the loaded contact. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
refreshAttributes
RefreshedAttribute[] refreshAttributes() throws Exception, altitude.integrationServer.exceptions.ISExceptionRefresh the session contact business data, overwriting the attributes saved in memory that have been updated, with the ones currently stored in database.- Returns:
- A list with the attributes that were overwritten, or newly added in database.
- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
rescheduleContact
void rescheduleContact(GregorianCalendar rescheduleMoment, Duration rescheduleTimeLimit, String agentName, int priority, String outboundRule, boolean usesDoNotCallList, String skillProfileName, SkillInProfile[] skills) throws Exception, altitude.integrationServer.exceptions.ISException Reschedules the contact.- Parameters:
rescheduleMoment- Moment.rescheduleTimeLimit- Reschedule moment limit.agentName- Name of the agent.priority- The relative priority to assign to the contact, centred in zero. -50, +50.outboundRule- Outbound rule.usesDoNotCallList- If true, the do not call list is used.skillProfileName- Name of the skill profile with the agent skills required.skills- Optional agent skills required to handle the contact. This parameter will be ignored if theskillProfileNameis specified.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
rescheduleContactWithReason
void rescheduleContactWithReason(ContactFailedReason reason) throws Exception, altitude.integrationServer.exceptions.ISException Reschedules the contact with failed reason.- Parameters:
reason- Failure reason for the contact.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
reserveContact
RefreshedAttribute[] reserveContact(boolean refreshAttributes) throws Exception, altitude.integrationServer.exceptions.ISException Reserves a loaded contact that currently is not reserved by the agent.- Parameters:
refreshAttributes- Iftruerefresh the session contact business data, overwriting the attributes saved in memory that have been updated, with the ones currently stored in database. Iffalseonly newly added attributes in database will be appended to current attributes list saved in memory.- Returns:
- A list with the attributes that were overwritten, or newly added in database.
- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
restart
void restart(String campaignName, DataTransactionRestartMode mode, Attribute[] attributes, boolean synchronous) throws Exception, altitude.integrationServer.exceptions.ISException Ends the data transaction in the current campaign and starts the data transaction in another campaign.- Parameters:
campaignName- Name of the campaign to start the data transaction.mode- Restart mode.attributes- Attributes to send to the new script.synchronous- If true, the method is synchronous.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
setContactProfile
void setContactProfile(int directoryId, int contactProfileId) throws Exception, altitude.integrationServer.exceptions.ISException Sets the contact profile.- Parameters:
directoryId- Identifier of the directory.contactProfileId- Identifier of the contact profile.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
unloadContact
-
updateContactProfile
-