Interface IInstance

All Superinterfaces:

IDisposable, IEntity

public interface IInstance
extends IEntity

Represents an instance.

Method Summary

Modifier and Type	Method	Description
void	addInstanceConnectedListener(InstanceConnectedListener listener)	Registers the InstanceConnectedListener.
void	addInstanceDisconnectedListener(InstanceDisconnectedListener listener)	Registers the InstanceDisconnectedListener.
void	addInstanceMessageOfTheDayChangedListener(InstanceMessageOfTheDayChangedListener listener)	Registers the InstanceMessageOfTheDayChangedListener.
void	addLogoutListener(LogoutListener listener)	Registers the LogoutListener.
void	addPingListener(PingListener listener)	Registers the PingListener.
void	addRecoveryCompletedListener(RecoveryCompletedListener listener)	Registers the RecoveryCompletedListener.
GregorianCalendar	convertLocalTimeToUtc(GregorianCalendar localDateTime)	Converts the local time passed as argument to coordinated universal time, based on the current contact center time zone configuration.
GregorianCalendar	convertTime(GregorianCalendar dateTime, String originTimeZone, String destinationTimeZone)	Converts the time from the specified time zone to another time zone.
GregorianCalendar	convertUtcTimeToLocal(GregorianCalendar utcDateTime)	Converts the coordinated universal time passed as argument to local time, based on the current contact center time zone configuration.
AgentFindData[]	findAgents(String agentNameSubstring, String agentFullNameSubstring, boolean onlyLoggedAgents, boolean onlyAgentsWithExtension, String[] onlyReadyInCampaigns)	Find agents in the instance.
AgentFindData[]	findAgents(String agentNameSubstring, String agentFullNameSubstring, String loginGroup, boolean onlyLoggedAgents, boolean onlyAgentsWithExtension, String[] onlyReadyInCampaigns)	Find agents in the instance.
void	forcedLogout()	Logs out the agent regardless of the current state of the agent.
AdditionalPhoneData[]	getAdditionalPhones()	Gets the additional phones.
String	getAddress()	Address of the instance.
AgentInfo	getAgentInfoById(int agentId)	Gets the agent info with the specified identifier.
AgentInfo	getAgentInfoByName(String agentName)	Gets the agent info with the specified name.
IAgentManager	getAgentManager()	The agent manager used to manage agents.
InstanceCanDo	getAllowedOperations()	Operations that can be performed in the instance.
BusinessStatus	getBusinessStatus(int scriptSessionId)	Gets the business status of the data transaction.
ICampaign	getCampaignById(int campaignId)	Gets a specific campaign.
ICampaign	getCampaignByName(String campaignName)	Gets a specific campaign.
ICampaignManager	getCampaignManager()	The campaign manager used to manage campaigns.
String[]	getCampaignNames()	Gets the list of campaign names.
ICampaign[]	getCampaigns()	Campaigns of the instance.
int	getContactProfileInProgressWorkflowCount(int directoryId, int contactProfileId, String sql)	Gets the count of the contact profile in progress workflow process task.
IContactProfileInProgressWorkflowCursor	getContactProfileInProgressWorkflowCursor(int cursorId)	Gets an in progress workflow process task cursor open in the instance.
IContactProfileInProgressWorkflowCursor[]	getContactProfileInProgressWorkflowCursors()	Returns the contact profile in progress workflow process task cursors open in the instance.
TableSchema	getContactProfileInProgressWorkflowTableSchema()	Gets the table schema of the contact profile in progress workflow.
int	getContactProfileInteractionHistoryCount(int directoryId, int contactProfileId, String sql)	Gets the count of the contact profile interaction history, without the outcomes of each interaction.
IContactProfileInteractionHistoryCursor	getContactProfileInteractionHistoryCursor(int cursorId)	Gets a contact profile interaction history cursor open in the instance.
IContactProfileInteractionHistoryCursor[]	getContactProfileInteractionHistoryCursors()	Gets the contact profile interaction history cursors open in the instance.
TableSchema	getContactProfileInteractionHistoryTableSchema()	Gets the table schema of the contact profile interaction history.
int	getContactProfileQueuedEmailCount(int directoryId, int contactProfileId, String sql, PurposeFilter purposeFilter)	Gets the count of the contact profile queued email.
IContactProfileQueuedEmailCursor	getContactProfileQueuedEmailCursor(int cursorId)	Gets a contact profile queued email cursor open in the instance.
IContactProfileQueuedEmailCursor[]	getContactProfileQueuedEmailCursors()	Returns the contact profile queued email cursors open in the instance.
TableSchema	getContactProfileQueuedEmailTableSchema()	Gets the table schema of the contact profile queued email.
int	getContactProfileQueuedSocialCount(int directoryId, int contactProfileId, String sql, PurposeFilter purposeFilter)	Gets the count of the contact profile queued social.
IContactProfileQueuedSocialCursor	getContactProfileQueuedSocialCursor(int cursorId)	Gets a contact profile queued social cursor open in the instance.
IContactProfileQueuedSocialCursor[]	getContactProfileQueuedSocialCursors()	Returns the contact profile queued social cursors open in the instance.
TableSchema	getContactProfileQueuedSocialTableSchema()	Gets the table schema of the contact profile queued social.
int	getContactProfileScheduledContactCount(int directoryId, int contactProfileId, String sql)	Gets the count of the contact profile scheduled contact.
IContactProfileScheduledContactCursor	getContactProfileScheduledContactCursor(int cursorId)	Gets a contact profile scheduled contact cursor open in the instance.
IContactProfileScheduledContactCursor[]	getContactProfileScheduledContactCursors()	Returns the contact profile scheduled contact cursors open in the instance.
TableSchema	getContactProfileScheduledContactTableSchema()	Gets the table schema of the contact profile scheduled contact.
CustomCallStatusData[]	getCustomCallStatusList()	Gets the custom call status list.
ICustomInteractionManager	getCustomInteractionManager()	The open media manager used to access the recordings.
IDirectoryManager	getDirectoryManager()	The directory manager used to manage directories.
IDocumentCursor	getDocumentCursor(int cursorId)	Returns a document cursor open in the instance.
IDocumentCursor[]	getDocumentCursors()	Returns the document cursors open in the instance.
IDocumentManager	getDocumentManager()	The document manager used to manage documents.
TableSchema	getDocumentTableSchema()	Gets the table schema of the document.
IEmailManager	getEmailManager()	The email manager used to decode emails encoded in the MIME format.
IEventAdapter	getEventAdapter()	The event adapter that monitors the instance for events.
IGdprManager	getGdprManager()	The GDPR manager used to manage GDPR.
InProgressWorkflowProcessTask	getInProgressWorkflowProcessTask(int inProgressWorkflowProcessTaskId)	Gets the in-progress workflow process task.
IInstanceManager	getInstanceManager()	The instance manager used to manage this instance.
TimeZone	getInstanceTimeZoneData()	Gets the rules of the time zone of the instance.
IIntegrationServer	getIntegrationServer()	The integration server associated to the instance.
InteractionThread	getInteractionThread(long interactionThreadId)	Gets the interaction thread with the outcomes.
int	getInteractionThreadCount(int directoryId, int contactProfileId, String sql)	Gets the count of the interaction thread.
IInteractionThreadCursor	getInteractionThreadCursor(int cursorId)	Gets a contact profile interaction thread cursor open in the instance.
IInteractionThreadCursor[]	getInteractionThreadCursors()	Gets the interaction thread cursors open in the instance.
InteractionThread[]	getInteractionThreadsByKey(String interactionKey)	Gets the interaction thread corresponding to the interaction key.
InteractionThread[]	getInteractionThreadsByUcid(String ucid)	Gets the interaction thread corresponding to the UCID.
InteractionThreadScriptSession	getInteractionThreadScriptSession(long interactionThreadId, int scriptSessionId, int outcomeId, boolean fetchOutcomes)	Gets information about a script session and the related interaction thread.
InteractionThreadSegment[]	getInteractionThreadSegments(long interactionThreadId)	Gets the segments of a certain interaction thread.
TableSchema	getInteractionThreadTableSchema()	Gets the table schema of an InteractionThread used in the Fetch of the InteractionThread cursor.
IKnowledgeBaseManager	getKnowledgeBaseManager()	The knowledge base manager used to manage categories and knowledge base documents.
GregorianCalendar	getLocalTime()	Gets the local time of the contact center.
IAgent	getLoggedAgent()	Gets the agent logged in the instance.
ILogManager	getLogManager()	The log manager used to manage logs.
ManualNotReadyReason[]	getManualNotReadyReasons()	Gets the list of not ready reasons that can be manually set by the agent.
MediaData	getMediaById(int mediaId)	Gets information about the media.
MediaData	getMediaByName(String mediaName)	Gets information about the media.
IMediaManager	getMediaManager()	The media manager used to manage medias.
MediaData[]	getMedias()	Gets information about the medias.
String	getMessageOfTheDay()	Instance message of the day.
String	getName()	Name of the instance.
String[]	getNotReadyReasonNames()	Gets the list of the custom not ready reasons names.
String[]	getOutboundRuleNames()	Gets the outbound rule names.
OutcomeData[]	getOutcomes(int scriptSessionId)	Gets the outcomes of the specified data transaction.
IOxeSynchro	getOxeSynchro()	The OxeSynchro object used to synchronize objects with an OXE switch
PendingWork	getPendingWork(int pendingWorkId)	Gets the pending work.
PendingWork	getPendingWork(int pendingWorkId, PurposeFilter purposeFilter)	Gets the pending work.
int	getPendingWorkCount(String agentName, String sql, boolean onlyOpenedCampaigns, boolean onlyActivitiesWithAgent)	Gets the count of the pending work.
IPendingWorkCursor	getPendingWorkCursor(int cursorId)	Returns a pending work cursor open in the instance.
IPendingWorkCursor[]	getPendingWorkCursors()	Returns the pending work cursors open in the instance.
TableSchema	getPendingWorkTableSchema()	Gets the table schema of the pending work.
PhoneScheduleRuleData	getPhoneScheduleRuleById(int phoneScheduleRuleId)	Gets the phone schedule rule.
PhoneScheduleRuleData	getPhoneScheduleRuleByName(String phoneScheduleRuleName)	Gets the phone schedule rule.
PhoneScheduleRuleData[]	getPhoneScheduleRules()	Gets the list of phone schedule rules.
QueuedAgentPickUpTask	getQueuedAgentPickUpTask(int queuedAgentPickUpTaskId)	Gets the queued agent pick up task.
QueuedAgentPickUpTask	getQueuedAgentPickUpTask(int queuedAgentPickUpTaskId, PurposeFilter purposeFilter)	Gets the queued agent pick up task.
int	getQueuedAgentPickUpTaskCount(String sql, boolean onlyOpenedCampaigns, boolean onlyPickable)	Gets the count of the queued agent pick up task.
IQueuedAgentPickUpTaskCursor	getQueuedAgentPickUpTaskCursor(int cursorId)	Gets a queued agent pick up task cursor open in the instance.
IQueuedAgentPickUpTaskCursor[]	getQueuedAgentPickUpTaskCursors()	Gets the queued agent pick up task cursors open in the instance.
TableSchema	getQueuedAgentPickUpTaskTableSchema()	Returns the table schema of the queued agent pick up task.
QueuedEmail	getQueuedEmail(int queuedEmailId)	Gets the queued email.
QueuedEmail	getQueuedEmail(int queuedEmailId, PurposeFilter purposeFilter)	Gets the queued email.
QueuedEmailBase	getQueuedEmailBase(int queuedEmailId)	Gets the queued email without contact profile and attributes.
int	getQueuedEmailCount(String sql, boolean onlyOpenedCampaigns, boolean onlyPickable)	Gets the count of the queued email.
IQueuedEmailCursor	getQueuedEmailCursor(int cursorId)	Gets a queued email cursor open in the instance.
IQueuedEmailCursor[]	getQueuedEmailCursors()	Returns the queued email cursors open in the instance.
TableSchema	getQueuedEmailTableSchema()	Gets the table schema of the queued email.
QueuedSocial	getQueuedSocial(int queuedSocialId, PurposeFilter purposeFilter)	Gets the queued social.
QueuedSocialBase	getQueuedSocialBase(int queuedSocialId)	Gets the queued social without contact profile and attributes.
int	getQueuedSocialCount(String sql, boolean onlyOpenedCampaigns, boolean onlyPickable)	Gets the count of the queued social.
IQueuedSocialCursor	getQueuedSocialCursor(int cursorId)	Gets a queued social cursor open in the instance.
IQueuedSocialCursor[]	getQueuedSocialCursors()	Returns the queued social cursors open in the instance.
TableSchema	getQueuedSocialTableSchema()	Gets the table schema of the queued social.
IRecordingManager	getRecordingManager()	The recording manager used to access the recordings.
IReportManager	getReportManager()	The report manager used to manage reports.
IRoleManager	getRoleManager()	The role manager used to manage roles.
ScheduledContact	getScheduledContact(int scheduledContactId)	Gets the scheduled contact.
boolean	getSecure()	If true the connection between the IntegrationServer and the instance is secure.
SentEmail	getSentEmail(long sentEmailId)	Gets the sent email.
SentEmail	getSentEmail(long sentEmailId, PurposeFilter purposeFilter)	Gets the sent email.
int	getSentEmailCount(String sql, boolean onlyOpenedCampaigns)	Gets the count of the sent email.
ISentEmailCursor	getSentEmailCursor(int cursorId)	Gets a sent email cursor open in the instance.
ISentEmailCursor[]	getSentEmailCursors()	Returns the sent email cursors open in the instance.
TableSchema	getSentEmailTableSchema()	Gets the table schema of the sent email.
SentSocial	getSentSocial(long sentSocialId, PurposeFilter purposeFilter)	Gets the sent social.
int	getSentSocialCount(String sql, boolean onlyOpenedCampaigns)	Gets the count of the sent social.
ISentSocialCursor	getSentSocialCursor(int cursorId)	Gets a sent social cursor open in the instance.
ISentSocialCursor[]	getSentSocialCursors()	Returns the sent social cursors open in the instance.
TableSchema	getSentSocialTableSchema()	Gets the table schema of the sent social.
IService	getServiceById(int serviceId)	Gets a specific service.
IService	getServiceByName(String serviceName)	Gets a specific service.
IServiceManager	getServiceManager()	The service manager used to manage services.
String[]	getServiceNames()	Retrieves the list of service names.
IService[]	getServices()	Gets the services of the instance.
String[]	getSiteNames()	Gets the list of site names.
SkillInProfile[]	getSkillProfile(String skillProfileName)	Gets the skills of a profile.
String[]	getSkillProfileNames(boolean includeAutomaticallyCreated)	Gets the skill profile names.
Skill[]	getSkills()	Gets the skills of all profiles.
ISocialManager	getSocialManager()	The social manager used to manage socials.
ISqlRunner	getSqlRunner()	The SQL runner used to make SQL operations.
ITeamManager	getTeamManager()	The team manager used to manage teams.
TimeZone	getTimeZoneData(String timeZoneName)	Gets the rules of a specific time zone.
String	getTimeZoneName()	The time zone of the instance.
String[]	getTimeZoneNames()	Gets the time zone names.
EnumeratedField	getUserDefinedEnumeratedField(int tableSchemaId, String enumeratedTypeName, String value)	Gets the user-defined enumerated field.
IUserDefinedEnumeratedFieldCursor	getUserDefinedEnumeratedFieldCursor(int cursorId)	Gets an user defined enumerated field cursor open in the instance.
IUserDefinedEnumeratedFieldCursor[]	getUserDefinedEnumeratedFieldCursors()	Returns the user defined enumerated field cursors open in the instance.
TableSchema	getUserDefinedEnumeratedFieldTableSchema()	Gets the table schema of the user-defined enumerated field.
GregorianCalendar	getUtcTime()	Gets the current coordinated universal time (UTC).
IWorkflowManager	getWorkflowManager()	The workflow manager used to manage workflows.
boolean	isUserDefinedEnumeratedValue(int tableSchemaId, String enumeratedTypeName, String value)	Returns true if the value belongs to the user defined enumerated.
void	logout()	Logs out the agent.
IContactProfileInProgressWorkflowCursor	newContactProfileInProgressWorkflowCursor(int directoryId, int contactProfileId, String[] columns, String sql)	Opens a contact profile in progress workflow process task cursor.
IContactProfileInteractionHistoryCursor	newContactProfileInteractionHistoryCursor(int directoryId, int contactProfileId, String[] columns, String sql)	Opens a contact profile interaction history cursor.
IContactProfileQueuedEmailCursor	newContactProfileQueuedEmailCursor(int directoryId, int contactProfileId, String[] columns, String sql)	Opens a contact profile queued email cursor.
IContactProfileQueuedEmailCursor	newContactProfileQueuedEmailCursor(int directoryId, int contactProfileId, String[] columns, String sql, PurposeFilter purposeFilter)	Opens a contact profile queued email cursor.
IContactProfileQueuedSocialCursor	newContactProfileQueuedSocialCursor(int directoryId, int contactProfileId, String[] columns, String sql, PurposeFilter purposeFilter)	Opens a contact profile queued social cursor.
IContactProfileScheduledContactCursor	newContactProfileScheduledContactCursor(int directoryId, int contactProfileId, String[] columns, String sql)	Opens a contact profile scheduled contact cursor.
IDocumentCursor	newDocumentCursor(String[] columns, String sql)	Opens a document cursor.
IInteractionThreadCursor	newInteractionThreadCursor(int directoryId, int contactProfileId, String[] columns, String sql)	Opens an interaction thread cursor.
IPendingWorkCursor	newPendingWorkCursor(String agentName, String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyActivitiesWithAgent)	Opens a pending work cursor.
IPendingWorkCursor	newPendingWorkCursor(String agentName, String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyActivitiesWithAgent, PurposeFilter purposeFilter)	Opens a pending work cursor.
IQueuedAgentPickUpTaskCursor	newQueuedAgentPickUpTaskCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyPickable)	Opens a queued agent pick up task cursor.
IQueuedAgentPickUpTaskCursor	newQueuedAgentPickUpTaskCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyPickable, PurposeFilter purposeFilter)	Opens a queued agent pick up task cursor.
IQueuedEmailCursor	newQueuedEmailCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyPickable)	Opens a queued email cursor.
IQueuedEmailCursor	newQueuedEmailCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyPickable, PurposeFilter purposeFilter)	Opens a queued email cursor.
IQueuedSocialCursor	newQueuedSocialCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, boolean onlyPickable, PurposeFilter purposeFilter)	Opens a queued social cursor.
ISentEmailCursor	newSentEmailCursor(String[] columns, String sql, boolean onlyOpenedCampaigns)	Opens a sent email cursor.
ISentEmailCursor	newSentEmailCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, PurposeFilter purposeFilter)	Opens a sent email cursor.
ISentSocialCursor	newSentSocialCursor(String[] columns, String sql, boolean onlyOpenedCampaigns, PurposeFilter purposeFilter)	Opens a sent social cursor.
IUserDefinedEnumeratedFieldCursor	newUserDefinedEnumeratedFieldCursor(int tableSchemaId, String enumeratedTypeName, String[] columns, String sql)	Opens an user defined enumerated field cursor.
void	pingReply()	Method that must be invoked by applications following a PingEvent, to tell IntegrationServer to keep the agent logged on.
void	removeInstanceConnectedListener(InstanceConnectedListener listener)	Unregisters the InstanceConnectedListener.
void	removeInstanceDisconnectedListener(InstanceDisconnectedListener listener)	Unregisters the InstanceDisconnectedListener.
void	removeInstanceMessageOfTheDayChangedListener(InstanceMessageOfTheDayChangedListener listener)	Unregisters the InstanceMessageOfTheDayChangedListener.
void	removeLogoutListener(LogoutListener listener)	Unregisters the LogoutListener.
void	removePingListener(PingListener listener)	Unregisters the PingListener.
void	removeRecoveryCompletedListener(RecoveryCompletedListener listener)	Unregisters the RecoveryCompletedListener.
void	setNewInteractionThreadsMedia(String interactionKey, String mediaName)	Sets the media of the future threads created in the context of a certain interaction, as a result of an Enqueue, Divert, BlindTransfer, Extend/Transfer operations, for example.
void	setRecorderKey(int agentId, int sessionId, String key, int recorderType)	Sets the recording key.
void	setSecurityToken(String token)	Notifies a new access token to IntegrationServer.
AgentInfo	tryGetAgentInfoById(int agentId)	Gets the agent info with the specified identifier or null if the agent does not exist.
AgentInfo	tryGetAgentInfoByName(String agentName)	Gets the agent info with the specified name or null if the agent does not exist.
ICampaign	tryGetCampaignById(int campaignId)	Gets the campaign with the specified identifier or null if the campaign does not exist.
ICampaign	tryGetCampaignByName(String campaignName)	Gets the campaign with the specified name or null if the campaign does not exist.
IContactProfileInProgressWorkflowCursor	tryGetContactProfileInProgressWorkflowCursor(int cursorId)	Gets an in progress workflow process task cursor open in the instance or null if it doesn't exist.
IContactProfileInteractionHistoryCursor	tryGetContactProfileInteractionHistoryCursor(int cursorId)	Gets a contact profile interaction history cursor open in the instance or null if it doesn't exist.
IContactProfileQueuedEmailCursor	tryGetContactProfileQueuedEmailCursor(int cursorId)	Gets a contact profile queued email cursor open in the instance or null if it doesn't exist.
IContactProfileQueuedSocialCursor	tryGetContactProfileQueuedSocialCursor(int cursorId)	Gets a contact profile queued social cursor open in the instance or null if it doesn't exist.
IContactProfileScheduledContactCursor	tryGetContactProfileScheduledContactCursor(int cursorId)	Gets a contact profile scheduled contact cursor open in the instance or null if it doesn't exist.
IDocumentCursor	tryGetDocumentCursor(int cursorId)	Returns a document cursor open in the instance or null if the cursor does not exist.
IInteractionThreadCursor	tryGetInteractionThreadCursor(int cursorId)	Gets a interaction thread cursor open in the instance or null if it doesn't exist.
IPendingWorkCursor	tryGetPendingWorkCursor(int cursorId)	Returns a pending work cursor open in the instance or null if the cursor does not exist.
IQueuedAgentPickUpTaskCursor	tryGetQueuedAgentPickUpTaskCursor(int cursorId)	Gets a queued agent pick up task cursor open in the instance or null if it doesn't exist.
IQueuedEmailCursor	tryGetQueuedEmailCursor(int cursorId)	Gets a queued email cursor open in the instance or null if it doesn't exist.
IQueuedSocialCursor	tryGetQueuedSocialCursor(int cursorId)	Gets a queued social cursor open in the instance or null if it doesn't exist.
ISentEmailCursor	tryGetSentEmailCursor(int cursorId)	Gets a sent email cursor open in the instance or null if it doesn't exist.
ISentSocialCursor	tryGetSentSocialCursor(int cursorId)	Gets a sent social cursor open in the instance or null if it doesn't exist.
IService	tryGetServiceById(int serviceId)	Gets a specific service or null if the service does not exist.
IService	tryGetServiceByName(String serviceName)	Gets a specific service or null if the service does not exist.
IUserDefinedEnumeratedFieldCursor	tryGetUserDefinedEnumeratedFieldCursor(int cursorId)	Gets an user defined enumerated field cursor open in the instance or null if it doesn't exist.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

addInstanceConnectedListener

void addInstanceConnectedListener(InstanceConnectedListener listener)

Registers the InstanceConnectedListener.

Parameters:

listener - Event listener to add.

removeInstanceConnectedListener

void removeInstanceConnectedListener(InstanceConnectedListener listener)

Unregisters the InstanceConnectedListener.

Parameters:

listener - Event listener to remove.

addInstanceDisconnectedListener

void addInstanceDisconnectedListener(InstanceDisconnectedListener listener)

Registers the InstanceDisconnectedListener.

Parameters:

listener - Event listener to add.

removeInstanceDisconnectedListener

void removeInstanceDisconnectedListener(InstanceDisconnectedListener listener)

Unregisters the InstanceDisconnectedListener.

Parameters:

listener - Event listener to remove.

addInstanceMessageOfTheDayChangedListener

void addInstanceMessageOfTheDayChangedListener(InstanceMessageOfTheDayChangedListener listener)

Registers the InstanceMessageOfTheDayChangedListener.

Parameters:

listener - Event listener to add.

removeInstanceMessageOfTheDayChangedListener

void removeInstanceMessageOfTheDayChangedListener(InstanceMessageOfTheDayChangedListener listener)

Unregisters the InstanceMessageOfTheDayChangedListener.

Parameters:

listener - Event listener to remove.

addLogoutListener

void addLogoutListener(LogoutListener listener)

Registers the LogoutListener.

Parameters:

listener - Event listener to add.

removeLogoutListener

void removeLogoutListener(LogoutListener listener)

Unregisters the LogoutListener.

Parameters:

listener - Event listener to remove.

addPingListener

void addPingListener(PingListener listener)

Registers the PingListener.

Parameters:

listener - Event listener to add.

removePingListener

void removePingListener(PingListener listener)

Unregisters the PingListener.

Parameters:

listener - Event listener to remove.

addRecoveryCompletedListener

void addRecoveryCompletedListener(RecoveryCompletedListener listener)

Registers the RecoveryCompletedListener.

Parameters:

listener - Event listener to add.

removeRecoveryCompletedListener

void removeRecoveryCompletedListener(RecoveryCompletedListener listener)

Unregisters the RecoveryCompletedListener.

Parameters:

listener - Event listener to remove.

convertLocalTimeToUtc

GregorianCalendar convertLocalTimeToUtc(GregorianCalendar localDateTime)
                                 throws Exception,
altitude.integrationServer.exceptions.ISException

Converts the local time passed as argument to coordinated universal time, based on the current contact center time zone configuration.

Parameters:

localDateTime - Local date time

Returns:

Throws:

Exception

altitude.integrationServer.exceptions.ISException

convertTime

GregorianCalendar convertTime(GregorianCalendar dateTime,
 String originTimeZone,
 String destinationTimeZone)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Converts the time from the specified time zone to another time zone.

Parameters:

dateTime - Time to convert.

originTimeZone - Time zone of the specified time.

destinationTimeZone - Time zone of the destination time.

Returns:

The converted time.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

convertUtcTimeToLocal

GregorianCalendar convertUtcTimeToLocal(GregorianCalendar utcDateTime)
                                 throws Exception,
altitude.integrationServer.exceptions.ISException

Converts the coordinated universal time passed as argument to local time, based on the current contact center time zone configuration.

Parameters:

utcDateTime - UTC date time

Returns:

Throws:

Exception

altitude.integrationServer.exceptions.ISException

findAgents

AgentFindData[] findAgents(String agentNameSubstring,
 String agentFullNameSubstring,
 boolean onlyLoggedAgents,
 boolean onlyAgentsWithExtension,
 String[] onlyReadyInCampaigns)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Find agents in the instance.

Parameters:

agentNameSubstring - Substring of the agent name.

agentFullNameSubstring - Substring of the full agent name.

onlyLoggedAgents - If true, only find logged agents.

onlyAgentsWithExtension - If true, only find agents with extension.

onlyReadyInCampaigns - Names of the campaigns that the agent must be ready.

Returns:

An array of AgentFindData objects.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

findAgents

AgentFindData[] findAgents(String agentNameSubstring,
 String agentFullNameSubstring,
 String loginGroup,
 boolean onlyLoggedAgents,
 boolean onlyAgentsWithExtension,
 String[] onlyReadyInCampaigns)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Find agents in the instance.

Parameters:

agentNameSubstring - Substring of the agent name.

agentFullNameSubstring - Substring of the full agent name.

loginGroup - Login group in which the agent is logged in the switch. If specified, only find agents logged in that switch group.

onlyLoggedAgents - If true, only find logged agents.

onlyAgentsWithExtension - If true, only find agents with extension.

onlyReadyInCampaigns - Names of the campaigns that the agent must be ready.

Returns:

An array of AgentFindData objects.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

forcedLogout

void forcedLogout()
           throws Exception,
altitude.integrationServer.exceptions.ISException

Logs out the agent regardless of the current state of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAdditionalPhones

AdditionalPhoneData[] getAdditionalPhones()
                                   throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the additional phones.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAddress

String getAddress()
           throws Exception,
altitude.integrationServer.exceptions.ISException

Address of the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAgentInfoById

AgentInfo getAgentInfoById(int agentId)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the agent info with the specified identifier.

Parameters:

agentId - Identifier of the agent.

Returns:

The object AgentInfo.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAgentInfoByName

AgentInfo getAgentInfoByName(String agentName)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the agent info with the specified name.

Parameters:

agentName - Name of the agent.

Returns:

The object AgentInfo.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAgentManager

IAgentManager getAgentManager()
                       throws Exception,
altitude.integrationServer.exceptions.ISException

The agent manager used to manage agents.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAllowedOperations

InstanceCanDo getAllowedOperations()
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Operations that can be performed in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getBusinessStatus

BusinessStatus getBusinessStatus(int scriptSessionId)
                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the business status of the data transaction.

Parameters:

scriptSessionId - Identifier of the data transaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCampaignById

ICampaign getCampaignById(int campaignId)
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a specific campaign.

Parameters:

campaignId - Identifier of the campaign.

Returns:

The object ICampaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCampaignByName

ICampaign getCampaignByName(String campaignName)
                     throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a specific campaign.

Parameters:

campaignName - Name of the campaign.

Returns:

The object ICampaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCampaignManager

ICampaignManager getCampaignManager()
                             throws Exception,
altitude.integrationServer.exceptions.ISException

The campaign manager used to manage campaigns.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCampaignNames

String[] getCampaignNames()
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the list of campaign names.

Returns:

An array with the names of the campaigns.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCampaigns

ICampaign[] getCampaigns()
                  throws Exception,
altitude.integrationServer.exceptions.ISException

Campaigns of the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileInProgressWorkflowCount

int getContactProfileInProgressWorkflowCount(int directoryId,
 int contactProfileId,
 String sql)
                                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the contact profile in progress workflow process task.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

sql - SQL.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileInProgressWorkflowCursor

IContactProfileInProgressWorkflowCursor getContactProfileInProgressWorkflowCursor(int cursorId)
                                                                           throws Exception,
altitude.integrationServer.exceptions.ISException

Gets an in progress workflow process task cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IContactProfileInProgressWorkflowCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileInProgressWorkflowCursors

IContactProfileInProgressWorkflowCursor[] getContactProfileInProgressWorkflowCursors()
                                                                              throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the contact profile in progress workflow process task cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileInProgressWorkflowTableSchema

TableSchema getContactProfileInProgressWorkflowTableSchema()
                                                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the contact profile in progress workflow.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileInteractionHistoryCount

int getContactProfileInteractionHistoryCount(int directoryId,
 int contactProfileId,
 String sql)
                                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the contact profile interaction history, without the outcomes of each interaction. Please use the IService.GetContactProfileInteractionHistoryCount method to get the count with outcomes.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

sql - SQL.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileInteractionHistoryCursor

IContactProfileInteractionHistoryCursor getContactProfileInteractionHistoryCursor(int cursorId)
                                                                           throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a contact profile interaction history cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IContactProfileInteractionHistoryCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileInteractionHistoryCursors

IContactProfileInteractionHistoryCursor[] getContactProfileInteractionHistoryCursors()
                                                                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the contact profile interaction history cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileInteractionHistoryTableSchema

TableSchema getContactProfileInteractionHistoryTableSchema()
                                                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the contact profile interaction history.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileQueuedEmailCount

int getContactProfileQueuedEmailCount(int directoryId,
 int contactProfileId,
 String sql,
 PurposeFilter purposeFilter)
                               throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the contact profile queued email.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

sql - SQL.

purposeFilter - Purpose filter.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileQueuedEmailCursor

IContactProfileQueuedEmailCursor getContactProfileQueuedEmailCursor(int cursorId)
                                                             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a contact profile queued email cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IContactProfileQueuedEmailCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileQueuedEmailCursors

IContactProfileQueuedEmailCursor[] getContactProfileQueuedEmailCursors()
                                                                throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the contact profile queued email cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileQueuedEmailTableSchema

TableSchema getContactProfileQueuedEmailTableSchema()
                                             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the contact profile queued email.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileQueuedSocialCount

int getContactProfileQueuedSocialCount(int directoryId,
 int contactProfileId,
 String sql,
 PurposeFilter purposeFilter)
                                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the contact profile queued social.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

sql - SQL.

purposeFilter - Purpose filter.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileQueuedSocialCursor

IContactProfileQueuedSocialCursor getContactProfileQueuedSocialCursor(int cursorId)
                                                               throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a contact profile queued social cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IContactProfileQueuedSocialCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileQueuedSocialCursors

IContactProfileQueuedSocialCursor[] getContactProfileQueuedSocialCursors()
                                                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the contact profile queued social cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileQueuedSocialTableSchema

TableSchema getContactProfileQueuedSocialTableSchema()
                                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the contact profile queued social.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileScheduledContactCount

int getContactProfileScheduledContactCount(int directoryId,
 int contactProfileId,
 String sql)
                                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the contact profile scheduled contact.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

sql - SQL.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileScheduledContactCursor

IContactProfileScheduledContactCursor getContactProfileScheduledContactCursor(int cursorId)
                                                                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a contact profile scheduled contact cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IContactProfileScheduledContactCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileScheduledContactCursors

IContactProfileScheduledContactCursor[] getContactProfileScheduledContactCursors()
                                                                          throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the contact profile scheduled contact cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileScheduledContactTableSchema

TableSchema getContactProfileScheduledContactTableSchema()
                                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the contact profile scheduled contact.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCustomCallStatusList

CustomCallStatusData[] getCustomCallStatusList()
                                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the custom call status list.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCustomInteractionManager

ICustomInteractionManager getCustomInteractionManager()
                                               throws Exception,
altitude.integrationServer.exceptions.ISException

The open media manager used to access the recordings.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDirectoryManager

IDirectoryManager getDirectoryManager()
                               throws Exception,
altitude.integrationServer.exceptions.ISException

The directory manager used to manage directories.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDocumentCursor

IDocumentCursor getDocumentCursor(int cursorId)
                           throws Exception,
altitude.integrationServer.exceptions.ISException

Returns a document cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IDocumentCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDocumentCursors

IDocumentCursor[] getDocumentCursors()
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the document cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDocumentManager

IDocumentManager getDocumentManager()
                             throws Exception,
altitude.integrationServer.exceptions.ISException

The document manager used to manage documents.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDocumentTableSchema

TableSchema getDocumentTableSchema()
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the document.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getEmailManager

IEmailManager getEmailManager()
                       throws Exception,
altitude.integrationServer.exceptions.ISException

The email manager used to decode emails encoded in the MIME format.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getEventAdapter

IEventAdapter getEventAdapter()
                       throws Exception,
altitude.integrationServer.exceptions.ISException

The event adapter that monitors the instance for events.

Receives events from the instance, filters the events, only sends the selected events in order to reduce network traffic and applications workload.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getGdprManager

IGdprManager getGdprManager()
                     throws Exception,
altitude.integrationServer.exceptions.ISException

The GDPR manager used to manage GDPR.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInProgressWorkflowProcessTask

InProgressWorkflowProcessTask getInProgressWorkflowProcessTask(int inProgressWorkflowProcessTaskId)
                                                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the in-progress workflow process task.

Parameters:

inProgressWorkflowProcessTaskId - Identifier of the in progress workflow process task.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInstanceManager

IInstanceManager getInstanceManager()
                             throws Exception,
altitude.integrationServer.exceptions.ISException

The instance manager used to manage this instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInstanceTimeZoneData

TimeZone getInstanceTimeZoneData()
                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the rules of the time zone of the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getIntegrationServer

IIntegrationServer getIntegrationServer()
                                 throws Exception,
altitude.integrationServer.exceptions.ISException

The integration server associated to the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInteractionThread

InteractionThread getInteractionThread(long interactionThreadId)
                                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the interaction thread with the outcomes.

Parameters:

interactionThreadId - Identifier of the interaction thread.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInteractionThreadCount

int getInteractionThreadCount(int directoryId,
 int contactProfileId,
 String sql)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the interaction thread.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

sql - SQL.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInteractionThreadCursor

IInteractionThreadCursor getInteractionThreadCursor(int cursorId)
                                             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a contact profile interaction thread cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IInteractionThreadCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInteractionThreadCursors

IInteractionThreadCursor[] getInteractionThreadCursors()
                                                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the interaction thread cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInteractionThreadsByKey

InteractionThread[] getInteractionThreadsByKey(String interactionKey)
                                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the interaction thread corresponding to the interaction key.

Parameters:

interactionKey - Identifier of the interaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInteractionThreadsByUcid

InteractionThread[] getInteractionThreadsByUcid(String ucid)
                                         throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the interaction thread corresponding to the UCID.

Parameters:

ucid - UCID.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInteractionThreadScriptSession

InteractionThreadScriptSession getInteractionThreadScriptSession(long interactionThreadId,
 int scriptSessionId,
 int outcomeId,
 boolean fetchOutcomes)
                                                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about a script session and the related interaction thread.

Parameters:

interactionThreadId - Identifier of the interaction thread.

scriptSessionId - Identifier of the script session.

outcomeId - Identifier of the outcomes.

fetchOutcomes - Id true, get the outcomes.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInteractionThreadSegments

InteractionThreadSegment[] getInteractionThreadSegments(long interactionThreadId)
                                                 throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the segments of a certain interaction thread.

Parameters:

interactionThreadId - Identifier of the interaction thread.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInteractionThreadTableSchema

TableSchema getInteractionThreadTableSchema()
                                     throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of an InteractionThread used in the Fetch of the InteractionThread cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getKnowledgeBaseManager

IKnowledgeBaseManager getKnowledgeBaseManager()
                                       throws Exception,
altitude.integrationServer.exceptions.ISException

The knowledge base manager used to manage categories and knowledge base documents.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getLocalTime

GregorianCalendar getLocalTime()
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the local time of the contact center.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getLoggedAgent

IAgent getLoggedAgent()
               throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the agent logged in the instance.

Returns:

The object IAgent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getLogManager

ILogManager getLogManager()
                   throws Exception,
altitude.integrationServer.exceptions.ISException

The log manager used to manage logs.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getManualNotReadyReasons

ManualNotReadyReason[] getManualNotReadyReasons()
                                         throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the list of not ready reasons that can be manually set by the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getMediaById

MediaData getMediaById(int mediaId)
                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the media.

Parameters:

mediaId - Identifier of the media.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getMediaByName

MediaData getMediaByName(String mediaName)
                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the media.

Parameters:

mediaName - Name of the media.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getMediaManager

IMediaManager getMediaManager()
                       throws Exception,
altitude.integrationServer.exceptions.ISException

The media manager used to manage medias.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getMedias

MediaData[] getMedias()
               throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the medias.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getMessageOfTheDay

String getMessageOfTheDay()
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Instance message of the day.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getName

String getName()
        throws Exception,
altitude.integrationServer.exceptions.ISException

Name of the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getNotReadyReasonNames

String[] getNotReadyReasonNames()
                         throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the list of the custom not ready reasons names.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getOutboundRuleNames

String[] getOutboundRuleNames()
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the outbound rule names.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getOutcomes

OutcomeData[] getOutcomes(int scriptSessionId)
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the outcomes of the specified data transaction.

Parameters:

scriptSessionId - Identifier of the data transaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getOxeSynchro

IOxeSynchro getOxeSynchro()
                   throws Exception,
altitude.integrationServer.exceptions.ISException

The OxeSynchro object used to synchronize objects with an OXE switch

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPendingWork

PendingWork getPendingWork(int pendingWorkId)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the pending work.

Parameters:

pendingWorkId - Identifier of the pending work.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPendingWork

PendingWork getPendingWork(int pendingWorkId,
 PurposeFilter purposeFilter)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the pending work.

Parameters:

pendingWorkId - Identifier of the pending work.

purposeFilter - Purpose filter.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPendingWorkCount

int getPendingWorkCount(String agentName,
 String sql,
 boolean onlyOpenedCampaigns,
 boolean onlyActivitiesWithAgent)
                 throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the pending work.

Parameters:

agentName - Name of the agent.

sql - SQL.

onlyOpenedCampaigns - If true, the cursor only has pending works of campaigns that the agent has open.

onlyActivitiesWithAgent - If true, include only activities that have an agent assigned.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPendingWorkCursor

IPendingWorkCursor getPendingWorkCursor(int cursorId)
                                 throws Exception,
altitude.integrationServer.exceptions.ISException

Returns a pending work cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IPendingWorkCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPendingWorkCursors

IPendingWorkCursor[] getPendingWorkCursors()
                                    throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the pending work cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPendingWorkTableSchema

TableSchema getPendingWorkTableSchema()
                               throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the pending work.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPhoneScheduleRuleById

PhoneScheduleRuleData getPhoneScheduleRuleById(int phoneScheduleRuleId)
                                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the phone schedule rule.

Parameters:

phoneScheduleRuleId - Identifier of the peschedule phone rule.

Returns:

The phone schedule rule.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPhoneScheduleRuleByName

PhoneScheduleRuleData getPhoneScheduleRuleByName(String phoneScheduleRuleName)
                                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the phone schedule rule.

Parameters:

phoneScheduleRuleName - Name of the peschedule phone rule.

Returns:

The phone schedule rule.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPhoneScheduleRules

PhoneScheduleRuleData[] getPhoneScheduleRules()
                                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the list of phone schedule rules.

Returns:

An array with the names of the phone schedule rules.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedAgentPickUpTask

QueuedAgentPickUpTask getQueuedAgentPickUpTask(int queuedAgentPickUpTaskId)
                                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the queued agent pick up task.

Parameters:

queuedAgentPickUpTaskId - Identifier of the queued agent pick up task.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedAgentPickUpTask

QueuedAgentPickUpTask getQueuedAgentPickUpTask(int queuedAgentPickUpTaskId,
 PurposeFilter purposeFilter)
                                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the queued agent pick up task.

Parameters:

queuedAgentPickUpTaskId - Identifier of the queued agent pick up task.

purposeFilter - Purpose filter.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedAgentPickUpTaskCount

int getQueuedAgentPickUpTaskCount(String sql,
 boolean onlyOpenedCampaigns,
 boolean onlyPickable)
                           throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the queued agent pick up task.

Parameters:

sql - SQL.

onlyOpenedCampaigns - If true, the cursor only has workflow tasks of campaigns that the agent has open.

onlyPickable - If true, the cursor only has workflow tasks that the agent can pick up.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedAgentPickUpTaskCursor

IQueuedAgentPickUpTaskCursor getQueuedAgentPickUpTaskCursor(int cursorId)
                                                     throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a queued agent pick up task cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IQueuedAgentPickUpTaskCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedAgentPickUpTaskCursors

IQueuedAgentPickUpTaskCursor[] getQueuedAgentPickUpTaskCursors()
                                                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the queued agent pick up task cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedAgentPickUpTaskTableSchema

TableSchema getQueuedAgentPickUpTaskTableSchema()
                                         throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the table schema of the queued agent pick up task.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedEmail

QueuedEmail getQueuedEmail(int queuedEmailId)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the queued email.

Parameters:

queuedEmailId - Identifier of the queued email.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedEmail

QueuedEmail getQueuedEmail(int queuedEmailId,
 PurposeFilter purposeFilter)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the queued email.

Parameters:

queuedEmailId - Identifier of the queued email.

purposeFilter - Purpose filter.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedEmailBase

QueuedEmailBase getQueuedEmailBase(int queuedEmailId)
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the queued email without contact profile and attributes.

Parameters:

queuedEmailId - Identifier of the queued email.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedEmailCount

int getQueuedEmailCount(String sql,
 boolean onlyOpenedCampaigns,
 boolean onlyPickable)
                 throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the queued email.

Parameters:

sql - SQL.

onlyOpenedCampaigns - If true, the cursor only has emails of campaigns that the agent has open.

onlyPickable - If true, the cursor only has emails that the agent can pick up.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedEmailCursor

IQueuedEmailCursor getQueuedEmailCursor(int cursorId)
                                 throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a queued email cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IQueuedEmailCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedEmailCursors

IQueuedEmailCursor[] getQueuedEmailCursors()
                                    throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the queued email cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedEmailTableSchema

TableSchema getQueuedEmailTableSchema()
                               throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the queued email.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedSocial

QueuedSocial getQueuedSocial(int queuedSocialId,
 PurposeFilter purposeFilter)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the queued social.

Parameters:

queuedSocialId - Identifier of the queued social.

purposeFilter - Purpose filter.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedSocialBase

QueuedSocialBase getQueuedSocialBase(int queuedSocialId)
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the queued social without contact profile and attributes.

Parameters:

queuedSocialId - Identifier of the queued social.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedSocialCount

int getQueuedSocialCount(String sql,
 boolean onlyOpenedCampaigns,
 boolean onlyPickable)
                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the queued social.

Parameters:

sql - SQL.

onlyOpenedCampaigns - If true, the cursor only has socials of campaigns that the agent has open.

onlyPickable - If true, the cursor only has socials that the agent can pick up.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedSocialCursor

IQueuedSocialCursor getQueuedSocialCursor(int cursorId)
                                   throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a queued social cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IQueuedSocialCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedSocialCursors

IQueuedSocialCursor[] getQueuedSocialCursors()
                                      throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the queued social cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueuedSocialTableSchema

TableSchema getQueuedSocialTableSchema()
                                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the queued social.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRecordingManager

IRecordingManager getRecordingManager()
                               throws Exception,
altitude.integrationServer.exceptions.ISException

The recording manager used to access the recordings.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getReportManager

IReportManager getReportManager()
                         throws Exception,
altitude.integrationServer.exceptions.ISException

The report manager used to manage reports.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRoleManager

IRoleManager getRoleManager()
                     throws Exception,
altitude.integrationServer.exceptions.ISException

The role manager used to manage roles.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getScheduledContact

ScheduledContact getScheduledContact(int scheduledContactId)
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the scheduled contact.

Parameters:

scheduledContactId - Identifier of the scheduled contact.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSecure

boolean getSecure()
           throws Exception,
altitude.integrationServer.exceptions.ISException

If true the connection between the IntegrationServer and the instance is secure.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSentEmail

SentEmail getSentEmail(long sentEmailId)
                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the sent email.

Parameters:

sentEmailId - Identifier of the sent email.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSentEmail

SentEmail getSentEmail(long sentEmailId,
 PurposeFilter purposeFilter)
                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the sent email.

Parameters:

sentEmailId - Identifier of the sent email.

purposeFilter - Purpose filter.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSentEmailCount

int getSentEmailCount(String sql,
 boolean onlyOpenedCampaigns)
               throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the sent email.

Parameters:

sql - SQL.

onlyOpenedCampaigns - If true, the cursor only has emails of campaigns that the agent has open.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSentEmailCursor

ISentEmailCursor getSentEmailCursor(int cursorId)
                             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a sent email cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The ISentEmailCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSentEmailCursors

ISentEmailCursor[] getSentEmailCursors()
                                throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the sent email cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSentEmailTableSchema

TableSchema getSentEmailTableSchema()
                             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the sent email.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSentSocial

SentSocial getSentSocial(long sentSocialId,
 PurposeFilter purposeFilter)
                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the sent social.

Parameters:

sentSocialId - Identifier of the sent social.

purposeFilter - Purpose filter.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSentSocialCount

int getSentSocialCount(String sql,
 boolean onlyOpenedCampaigns)
                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the sent social.

Parameters:

sql - SQL.

onlyOpenedCampaigns - If true, the cursor only has socials of campaigns that the agent has open.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSentSocialCursor

ISentSocialCursor getSentSocialCursor(int cursorId)
                               throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a sent social cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The ISentSocialCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSentSocialCursors

ISentSocialCursor[] getSentSocialCursors()
                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the sent social cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSentSocialTableSchema

TableSchema getSentSocialTableSchema()
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the sent social.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getServiceById

IService getServiceById(int serviceId)
                 throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a specific service.

Parameters:

serviceId - Identifier of the service.

Returns:

The object IService.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getServiceByName

IService getServiceByName(String serviceName)
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a specific service.

Parameters:

serviceName - Name of the service.

Returns:

The object IService.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getServiceManager

IServiceManager getServiceManager()
                           throws Exception,
altitude.integrationServer.exceptions.ISException

The service manager used to manage services.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getServiceNames

String[] getServiceNames()
                  throws Exception,
altitude.integrationServer.exceptions.ISException

Retrieves the list of service names.

Returns:

An array with the names of the services.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getServices

IService[] getServices()
                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the services of the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSiteNames

String[] getSiteNames()
               throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the list of site names.

Returns:

An array with the names of the sites.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSkillProfile

SkillInProfile[] getSkillProfile(String skillProfileName)
                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the skills of a profile.

Parameters:

skillProfileName - Name of the skill profile.

Returns:

The array of type SkillInProfile.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSkillProfileNames

String[] getSkillProfileNames(boolean includeAutomaticallyCreated)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the skill profile names.

Parameters:

includeAutomaticallyCreated - If true, includes the automatically created skill profile names.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSkills

Skill[] getSkills()
           throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the skills of all profiles.

Returns:

The array of type Skill.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSocialManager

ISocialManager getSocialManager()
                         throws Exception,
altitude.integrationServer.exceptions.ISException

The social manager used to manage socials.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSqlRunner

ISqlRunner getSqlRunner()
                 throws Exception,
altitude.integrationServer.exceptions.ISException

The SQL runner used to make SQL operations.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getTeamManager

ITeamManager getTeamManager()
                     throws Exception,
altitude.integrationServer.exceptions.ISException

The team manager used to manage teams.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getTimeZoneData

TimeZone getTimeZoneData(String timeZoneName)
                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the rules of a specific time zone.

Parameters:

timeZoneName - Name of the time zone.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getTimeZoneName

String getTimeZoneName()
                throws Exception,
altitude.integrationServer.exceptions.ISException

The time zone of the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getTimeZoneNames

String[] getTimeZoneNames()
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the time zone names.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getUserDefinedEnumeratedField

EnumeratedField getUserDefinedEnumeratedField(int tableSchemaId,
 String enumeratedTypeName,
 String value)
                                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the user-defined enumerated field.

Parameters:

tableSchemaId - Identifier of the table schema. This value can be retrieved fom IService.GetCampaignAttributesTableSchema, IService.GetActivityAttributesTableSchema, or IService.GetOutcomesTableSchema.

enumeratedTypeName - Name of the enumerated type.

value - Enumerated value.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getUserDefinedEnumeratedFieldCursor

IUserDefinedEnumeratedFieldCursor getUserDefinedEnumeratedFieldCursor(int cursorId)
                                                               throws Exception,
altitude.integrationServer.exceptions.ISException

Gets an user defined enumerated field cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IUserDefinedEnumeratedFieldCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getUserDefinedEnumeratedFieldCursors

IUserDefinedEnumeratedFieldCursor[] getUserDefinedEnumeratedFieldCursors()
                                                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the user defined enumerated field cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getUserDefinedEnumeratedFieldTableSchema

TableSchema getUserDefinedEnumeratedFieldTableSchema()
                                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the user-defined enumerated field.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getUtcTime

GregorianCalendar getUtcTime()
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the current coordinated universal time (UTC).

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWorkflowManager

IWorkflowManager getWorkflowManager()
                             throws Exception,
altitude.integrationServer.exceptions.ISException

The workflow manager used to manage workflows.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

isUserDefinedEnumeratedValue

boolean isUserDefinedEnumeratedValue(int tableSchemaId,
 String enumeratedTypeName,
 String value)
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Returns true if the value belongs to the user defined enumerated.

Parameters:

tableSchemaId - Identifier of the table schema. This value can be retrieved fom IService.GetCampaignAttributesTableSchema, IService.GetActivityAttributesTableSchema, or IService.GetOutcomesTableSchema.

enumeratedTypeName - Name of the enumerated type.

value - Enumerated value.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

logout

void logout()
     throws Exception,
altitude.integrationServer.exceptions.ISException

Logs out the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

newContactProfileInProgressWorkflowCursor

IContactProfileInProgressWorkflowCursor newContactProfileInProgressWorkflowCursor(int directoryId,
 int contactProfileId,
 String[] columns,
 String sql)
                                                                           throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a contact profile in progress workflow process task cursor.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

columns - Columns to fetch.

sql - SQL.

Returns:

The IContactProfileInProgressWorkflowCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newContactProfileInteractionHistoryCursor

IContactProfileInteractionHistoryCursor newContactProfileInteractionHistoryCursor(int directoryId,
 int contactProfileId,
 String[] columns,
 String sql)
                                                                           throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a contact profile interaction history cursor. The InteractionThreadScriptSession.Outcome returned by the cursor fetch have null values. Please use the IService.NewContactProfileInteractionHistoryCursor method to fetch the outcomes.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

columns - Columns to fetch.

sql - SQL.

Returns:

The IContactProfileInteractionHistoryCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newContactProfileQueuedEmailCursor

IContactProfileQueuedEmailCursor newContactProfileQueuedEmailCursor(int directoryId,
 int contactProfileId,
 String[] columns,
 String sql)
                                                             throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a contact profile queued email cursor.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

columns - Columns to fetch.

sql - SQL.

Returns:

The IContactProfileQueuedEmailCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newContactProfileQueuedEmailCursor

IContactProfileQueuedEmailCursor newContactProfileQueuedEmailCursor(int directoryId,
 int contactProfileId,
 String[] columns,
 String sql,
 PurposeFilter purposeFilter)
                                                             throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a contact profile queued email cursor.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

columns - Columns to fetch.

sql - SQL.

purposeFilter - Purpose filter.

Returns:

The IContactProfileQueuedEmailCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newContactProfileQueuedSocialCursor

IContactProfileQueuedSocialCursor newContactProfileQueuedSocialCursor(int directoryId,
 int contactProfileId,
 String[] columns,
 String sql,
 PurposeFilter purposeFilter)
                                                               throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a contact profile queued social cursor.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

columns - Columns to fetch.

sql - SQL.

purposeFilter - Purpose filter.

Returns:

The IContactProfileQueuedSocialCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newContactProfileScheduledContactCursor

IContactProfileScheduledContactCursor newContactProfileScheduledContactCursor(int directoryId,
 int contactProfileId,
 String[] columns,
 String sql)
                                                                       throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a contact profile scheduled contact cursor.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

columns - Columns to fetch.

sql - SQL.

Returns:

The IContactProfileScheduledContactCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newDocumentCursor

IDocumentCursor newDocumentCursor(String[] columns,
 String sql)
                           throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a document cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

Returns:

The IDocumentCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newInteractionThreadCursor

IInteractionThreadCursor newInteractionThreadCursor(int directoryId,
 int contactProfileId,
 String[] columns,
 String sql)
                                             throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens an interaction thread cursor.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

columns - Columns to fetch.

sql - SQL.

Returns:

The IInteractionThreadCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newPendingWorkCursor

IPendingWorkCursor newPendingWorkCursor(String agentName,
 String[] columns,
 String sql,
 boolean onlyOpenedCampaigns,
 boolean onlyActivitiesWithAgent)
                                 throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a pending work cursor.

Parameters:

agentName - Name of the agent.

columns - Columns to fetch.

sql - SQL.

onlyOpenedCampaigns - If true, the cursor only has pending works of campaigns that the agent has open.

onlyActivitiesWithAgent - If true, include only activities that have an agent assigned.

Returns:

The IPendingWorkCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newPendingWorkCursor

IPendingWorkCursor newPendingWorkCursor(String agentName,
 String[] columns,
 String sql,
 boolean onlyOpenedCampaigns,
 boolean onlyActivitiesWithAgent,
 PurposeFilter purposeFilter)
                                 throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a pending work cursor.

Parameters:

agentName - Name of the agent.

columns - Columns to fetch.

sql - SQL.

onlyOpenedCampaigns - If true, the cursor only has pending works of campaigns that the agent has open.

onlyActivitiesWithAgent - If true, include only activities that have an agent assigned.

purposeFilter - Purpose filter.

Returns:

The IPendingWorkCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newQueuedAgentPickUpTaskCursor

IQueuedAgentPickUpTaskCursor newQueuedAgentPickUpTaskCursor(String[] columns,
 String sql,
 boolean onlyOpenedCampaigns,
 boolean onlyPickable)
                                                     throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a queued agent pick up task cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

onlyOpenedCampaigns - If true, the cursor only has workflow tasks of campaigns that the agent has open.

onlyPickable - If true, the cursor only has workflow tasks that the agent can pick up.

Returns:

The IQueuedAgentPickUpTaskCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newQueuedAgentPickUpTaskCursor

IQueuedAgentPickUpTaskCursor newQueuedAgentPickUpTaskCursor(String[] columns,
 String sql,
 boolean onlyOpenedCampaigns,
 boolean onlyPickable,
 PurposeFilter purposeFilter)
                                                     throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a queued agent pick up task cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

onlyOpenedCampaigns - If true, the cursor only has workflow tasks of campaigns that the agent has open.

onlyPickable - If true, the cursor only has workflow tasks that the agent can pick up.

purposeFilter - Purpose filter.

Returns:

The IQueuedAgentPickUpTaskCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newQueuedEmailCursor

IQueuedEmailCursor newQueuedEmailCursor(String[] columns,
 String sql,
 boolean onlyOpenedCampaigns,
 boolean onlyPickable)
                                 throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a queued email cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

onlyOpenedCampaigns - If true, the cursor only has emails of campaigns that the agent has open.

onlyPickable - If true, the cursor only has emails that the agent can pick up.

Returns:

The IQueuedEmailCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newQueuedEmailCursor

IQueuedEmailCursor newQueuedEmailCursor(String[] columns,
 String sql,
 boolean onlyOpenedCampaigns,
 boolean onlyPickable,
 PurposeFilter purposeFilter)
                                 throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a queued email cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

onlyOpenedCampaigns - If true, the cursor only has emails of campaigns that the agent has open.

onlyPickable - If true, the cursor only has emails that the agent can pick up.

purposeFilter - Purpose filter.

Returns:

The IQueuedEmailCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newQueuedSocialCursor

IQueuedSocialCursor newQueuedSocialCursor(String[] columns,
 String sql,
 boolean onlyOpenedCampaigns,
 boolean onlyPickable,
 PurposeFilter purposeFilter)
                                   throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a queued social cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

onlyOpenedCampaigns - If true, the cursor only has socials of campaigns that the agent has open.

onlyPickable - If true, the cursor only has socials that the agent can pick up.

purposeFilter - Purpose filter.

Returns:

The IQueuedSocialCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newSentEmailCursor

ISentEmailCursor newSentEmailCursor(String[] columns,
 String sql,
 boolean onlyOpenedCampaigns)
                             throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a sent email cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

onlyOpenedCampaigns - If true, the cursor only has emails of campaigns that the agent has open.

Returns:

The ISentEmailCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newSentEmailCursor

ISentEmailCursor newSentEmailCursor(String[] columns,
 String sql,
 boolean onlyOpenedCampaigns,
 PurposeFilter purposeFilter)
                             throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a sent email cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

onlyOpenedCampaigns - If true, the cursor only has emails of campaigns that the agent has open.

purposeFilter - Purpose filter.

Returns:

The ISentEmailCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newSentSocialCursor

ISentSocialCursor newSentSocialCursor(String[] columns,
 String sql,
 boolean onlyOpenedCampaigns,
 PurposeFilter purposeFilter)
                               throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a sent social cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

onlyOpenedCampaigns - If true, the cursor only has socials of campaigns that the agent has open.

purposeFilter - Purpose filter.

Returns:

The ISentSocialCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newUserDefinedEnumeratedFieldCursor

IUserDefinedEnumeratedFieldCursor newUserDefinedEnumeratedFieldCursor(int tableSchemaId,
 String enumeratedTypeName,
 String[] columns,
 String sql)
                                                               throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens an user defined enumerated field cursor.

Parameters:

tableSchemaId - Identifier of the table schema.

enumeratedTypeName - Name of the enumerated type.

columns - Columns to fetch.

sql - SQL.

Returns:

The IUserDefinedEnumeratedFieldCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

pingReply

void pingReply()
        throws Exception,
altitude.integrationServer.exceptions.ISException

Method that must be invoked by applications following a PingEvent, to tell IntegrationServer to keep the agent logged on.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setNewInteractionThreadsMedia

void setNewInteractionThreadsMedia(String interactionKey,
 String mediaName)
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Sets the media of the future threads created in the context of a certain interaction, as a result of an Enqueue, Divert, BlindTransfer, Extend/Transfer operations, for example.

Parameters:

interactionKey - The interaction key.

mediaName - Name of the media.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setRecorderKey

void setRecorderKey(int agentId,
 int sessionId,
 String key,
 int recorderType)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Sets the recording key.

Parameters:

agentId - Identifier of the agent being recorded.

sessionId - Identifier of the session being recorded.

key - Unique recording key.

recorderType - Type of recorder used.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setSecurityToken

void setSecurityToken(String token)
               throws Exception,
altitude.integrationServer.exceptions.ISException

Notifies a new access token to IntegrationServer. This method should be used by applications that login the agent using the OpenIdConnect authentication type whenever an access token is renewed. The IntegrationServer requires the access token to automatically relogin the agent in the context of the recovery mechanism.

Parameters:

token - Access token that has been renewed.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetAgentInfoById

AgentInfo tryGetAgentInfoById(int agentId)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the agent info with the specified identifier or null if the agent does not exist.

Parameters:

agentId - Identifier of the agent.

Returns:

The object AgentInfo.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetAgentInfoByName

AgentInfo tryGetAgentInfoByName(String agentName)
                         throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the agent info with the specified name or null if the agent does not exist.

Parameters:

agentName - Name of the agent.

Returns:

The object AgentInfo.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetCampaignById

ICampaign tryGetCampaignById(int campaignId)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the campaign with the specified identifier or null if the campaign does not exist.

Parameters:

campaignId - Identifier of the campaign.

Returns:

The object ICampaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetCampaignByName

ICampaign tryGetCampaignByName(String campaignName)
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the campaign with the specified name or null if the campaign does not exist.

Parameters:

campaignName - Name of the campaign.

Returns:

The object ICampaign.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetContactProfileInProgressWorkflowCursor

IContactProfileInProgressWorkflowCursor tryGetContactProfileInProgressWorkflowCursor(int cursorId)
                                                                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets an in progress workflow process task cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IContactProfileInProgressWorkflowCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetContactProfileInteractionHistoryCursor

IContactProfileInteractionHistoryCursor tryGetContactProfileInteractionHistoryCursor(int cursorId)
                                                                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a contact profile interaction history cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IContactProfileInteractionHistoryCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetContactProfileQueuedEmailCursor

IContactProfileQueuedEmailCursor tryGetContactProfileQueuedEmailCursor(int cursorId)
                                                                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a contact profile queued email cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IContactProfileQueuedEmailCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetContactProfileQueuedSocialCursor

IContactProfileQueuedSocialCursor tryGetContactProfileQueuedSocialCursor(int cursorId)
                                                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a contact profile queued social cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IContactProfileQueuedSocialCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetContactProfileScheduledContactCursor

IContactProfileScheduledContactCursor tryGetContactProfileScheduledContactCursor(int cursorId)
                                                                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a contact profile scheduled contact cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IContactProfileScheduledContactCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetDocumentCursor

IDocumentCursor tryGetDocumentCursor(int cursorId)
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Returns a document cursor open in the instance or null if the cursor does not exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IDocumentCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetInteractionThreadCursor

IInteractionThreadCursor tryGetInteractionThreadCursor(int cursorId)
                                                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a interaction thread cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IInteractionThreadCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetPendingWorkCursor

IPendingWorkCursor tryGetPendingWorkCursor(int cursorId)
                                    throws Exception,
altitude.integrationServer.exceptions.ISException

Returns a pending work cursor open in the instance or null if the cursor does not exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IPendingWorkCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetQueuedAgentPickUpTaskCursor

IQueuedAgentPickUpTaskCursor tryGetQueuedAgentPickUpTaskCursor(int cursorId)
                                                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a queued agent pick up task cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IQueuedAgentPickUpTaskCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetQueuedEmailCursor

IQueuedEmailCursor tryGetQueuedEmailCursor(int cursorId)
                                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a queued email cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IQueuedEmailCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetQueuedSocialCursor

IQueuedSocialCursor tryGetQueuedSocialCursor(int cursorId)
                                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a queued social cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IQueuedSocialCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetSentEmailCursor

ISentEmailCursor tryGetSentEmailCursor(int cursorId)
                                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a sent email cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The ISentEmailCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetSentSocialCursor

ISentSocialCursor tryGetSentSocialCursor(int cursorId)
                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a sent social cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The ISentSocialCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetServiceById

IService tryGetServiceById(int serviceId)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a specific service or null if the service does not exist.

Parameters:

serviceId - Identifier of the service.

Returns:

The object IService.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetServiceByName

IService tryGetServiceByName(String serviceName)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a specific service or null if the service does not exist.

Parameters:

serviceName - Name of the service.

Returns:

The object IService.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetUserDefinedEnumeratedFieldCursor

IUserDefinedEnumeratedFieldCursor tryGetUserDefinedEnumeratedFieldCursor(int cursorId)
                                                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets an user defined enumerated field cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IUserDefinedEnumeratedFieldCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException