Interface IInstanceManager
- All Superinterfaces:
IDisposable, IEntity
Manages the instance.
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddToDoNotCallList(String doNotCallListName, String number) Adds a number to the do not call list.voidaddToDoNotCallList(String doNotCallListName, String number, String uniqueId, GregorianCalendar expiryDate) Adds an entry in the do not call list.voidcancelBackgroundTask(int taskId) Cancels the background task.intcreateDayType(DayTypeCreateRequest request) Creates a day type.intcreateOutcome(int scriptSessionId, Attribute[] outcome) Creates an outcome.intcreateSite(SiteCreateRequest request) Creates a site.intcreateTimeZone(TimeZoneCreateRequest request) Creates a time zone.voiddeleteDayType(String dayTypeName) Deletes a day type.voiddeleteFromDoNotCallList(String doNotCallListName, String number) Deletes a number from the do not call list.voiddeleteFromDoNotCallList(String doNotCallListName, String number, String uniqueId) Deletes a do not call list entry.voiddeleteOutcome(int outcomeId) Deletes an outcome.getBackgroundTaskData(int taskId) Gets the background task data.getCubeCursor(int cursorId) Gets a cube cursor open in the instance.Attribute[][]getCubeDataAsAttributes(CubeDimensionRequestBase[] dimensionRequests, TimeSplitDimension timeSplitDimension, GregorianCalendar startMoment, GregorianCalendar endMoment, Duration startDayTime, Duration endDayTime, String[] columns) Fetches data from cubes.Attribute[][]getCubeDataAsAttributes(CubeDimensionRequestBase[] dimensionRequests, TimeSplitDimension timeSplitDimension, GregorianCalendar startMoment, GregorianCalendar endMoment, Duration startDayTime, Duration endDayTime, String[] columns, PurposeFilter purposeFilter) Fetches data from cubes.String[][]getCubeDataAsValues(CubeDimensionRequestBase[] dimensionRequests, TimeSplitDimension timeSplitDimension, GregorianCalendar startMoment, GregorianCalendar endMoment, Duration startDayTime, Duration endDayTime, String[] columns) Fetches data from cubes.String[][]getCubeDataAsValues(CubeDimensionRequestBase[] dimensionRequests, TimeSplitDimension timeSplitDimension, GregorianCalendar startMoment, GregorianCalendar endMoment, Duration startDayTime, Duration endDayTime, String[] columns, PurposeFilter purposeFilter) Fetches data from cubes.Gets the table schema with all existent cube counters.getCubeTableSchema(CubeDimensionRequestBase[] dimensionRequests, TimeSplitDimension timeSplitDimension, MediaType mediaType) Gets the table schema with the counters available for a certain context, specified by the set of cube dimensions, timeframe and media type.getDayType(String dayTypeName) Gets a specific day type.String[]Gets the day type names.String[]Gets the day type names that include the given date.String[]Gets the list of do not call list names.getEmailGateway(String gatewayName) Gets the email gateway data.getEnumeratedTypes(int tableSchemaId) Gets the enumerated types of a table schema.getGatewayById(GatewayType gatewayType, int gatewayId) Gets information about the specified gateway.getGatewayByName(GatewayType gatewayType, String gatewayName) Gets information about the named gateway.String[]getGatewayNames(GatewayType gatewayType) Gets the list of gateway names.getGateways(GatewayType gatewayType) Gets the list of gateways.getGatewayState(GatewayType gatewayType, String gatewayName) Gets the state of the gateway.The instance.Gets the instance data.intGets the count of the interaction history.getInteractionHistoryCursor(int cursorId) Gets a contact profile interaction history cursor open in the instance.Gets the table schema of anInteractionThreadScriptSessionused in the Fetch of the InteractionHistory cursor.Gets the list of not ready reasons.Gets the Router Afiniti data.getScriptDocumentCursor(int cursorId) Gets a script document cursor open in the instance.Gets the table schema of the script document.getTelephonyGateway(String gatewayName) Gets the telephony gateway data.booleanisInDoNotCallList(String doNotCallListName, String number) Checks if a number is in the specified, or in the global do not call lists.booleanisInDoNotCallList(String doNotCallListName, String number, String uniqueId) Checks if a number is in the specified, or in the global do not call lists.newCubeCursor(CubeDimensionRequest[] dimensionRequests, TimeSplitDimension timeSplitDimension, GregorianCalendar startMoment, GregorianCalendar endMoment, Duration startDayTime, Duration endDayTime, String[] columns) Opens a cube cursor.newCubeCursor(CubeDimensionRequest[] dimensionRequests, TimeSplitDimension timeSplitDimension, GregorianCalendar startMoment, GregorianCalendar endMoment, Duration startDayTime, Duration endDayTime, String[] columns, PurposeFilter purposeFilter) Opens a cube cursor.newInteractionHistoryCursor(String[] columns, String sql) Opens an interaction history cursor.newInteractionHistoryCursor(String[] columns, String sql, PurposeFilter purposeFilter) Opens an interaction history cursor.newScriptDocumentCursor(String[] columns, String sql) Opens a script document cursor.voidstartGateway(GatewayType gatewayType, String gatewayName) Starts the gateway.voidstopGateway(GatewayType gatewayType, String gatewayName) Stops the gateway.tryGetCubeCursor(int cursorId) Gets a cube cursor open in the instance or null if it doesn't exist.tryGetInteractionHistoryCursor(int cursorId) Gets a contact profile interaction history cursor open in the instance or null if it doesn't exist.tryGetScriptDocumentCursor(int cursorId) Gets a script document cursor open in the instance or null if it doesn't exist.voidupdateDayType(String dayTypeName, DayTypeUpdateRequest request) Updates a day type.voidupdateInstance(InstanceUpdateRequest request) Updates the instance.voidupdateOutcome(int outcomeId, Attribute[] outcome) Updates an outcome.voidUpdates the Router Afiniti.Methods inherited from interface IDisposable
addDisposedListener, removeDisposedListenerMethods inherited from interface IEntity
getUserContext, setUserContext
-
Method Details
-
addToDoNotCallList
void addToDoNotCallList(String doNotCallListName, String number) throws Exception, altitude.integrationServer.exceptions.ISException Adds a number to the do not call list.- Parameters:
doNotCallListName- Name of the do not call list.number- The phone number to add.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
addToDoNotCallList
void addToDoNotCallList(String doNotCallListName, String number, String uniqueId, GregorianCalendar expiryDate) throws Exception, altitude.integrationServer.exceptions.ISException Adds an entry in the do not call list.- Parameters:
doNotCallListName- Name of the do not call list.number- The phone number to add. This parameter is optional.uniqueId- Unique identifier of the contact profile. This parameter is optional.expiryDate- Date of the expiration of the do not call list entry. This parameter is optional.The
numberanduniqueIdparameters can not be both unspecified.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
cancelBackgroundTask
-
createDayType
int createDayType(DayTypeCreateRequest request) throws Exception, altitude.integrationServer.exceptions.ISException Creates a day type.- Parameters:
request- Contains the fields that must be overwritten- Returns:
- Identifier of the created day type.
- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
createOutcome
int createOutcome(int scriptSessionId, Attribute[] outcome) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException Creates an outcome. This is a mechanism designed only to be used in specific situations to correct the outcomes introduced by the agents. Massive use of this functionality is not advised because it may impact severely the performance of the Altitude uCI Server.- Parameters:
scriptSessionId- Identifier of the script session.outcome- Outcome attributes.- Returns:
- Identifier of the created outcome.
- Throws:
Exceptionaltitude.integrationServer.exceptions.ISExceptionaltitude.integrationServer.exceptions.ISSqlException
-
createSite
int createSite(SiteCreateRequest request) throws Exception, altitude.integrationServer.exceptions.ISException Creates a site.- Parameters:
request- Contains the fields that must be overwritten- Returns:
- Identifier of the created site.
- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
createTimeZone
int createTimeZone(TimeZoneCreateRequest request) throws Exception, altitude.integrationServer.exceptions.ISException Creates a time zone.- Parameters:
request- Contains the fields that must be overwritten- Returns:
- Identifier of the created time zone.
- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
deleteDayType
-
deleteFromDoNotCallList
void deleteFromDoNotCallList(String doNotCallListName, String number) throws Exception, altitude.integrationServer.exceptions.ISException Deletes a number from the do not call list.- Parameters:
doNotCallListName- Name of the do not call list.number- The phone number to remove.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
deleteFromDoNotCallList
void deleteFromDoNotCallList(String doNotCallListName, String number, String uniqueId) throws Exception, altitude.integrationServer.exceptions.ISException Deletes a do not call list entry.- Parameters:
doNotCallListName- Name of the do not call list. This parameter is optional.number- The phone number to remove. This parameter is optional.uniqueId- Unique identifier of the contact profile. This parameter is optional.The
numberanduniqueIdparameters are used to exact match the entries that are deleted. For instance, ifnumberis specified anduniqueIdis unspecified, only the entries that have only the number specified are deleted. IfnumberanduniqueIdare both unspecified, no entries are deleted.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
deleteOutcome
void deleteOutcome(int outcomeId) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException Deletes an outcome. This is a mechanism designed only to be used in specific situations to correct the outcomes introduced by the agents. Massive use of this functionality is not advised because it may impact severely the performance of the Altitude uCI Server.- Parameters:
outcomeId- Identifier of the outcome.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISExceptionaltitude.integrationServer.exceptions.ISSqlException
-
getBackgroundTaskData
BackgroundTaskData getBackgroundTaskData(int taskId) throws Exception, altitude.integrationServer.exceptions.ISException Gets the background task data.- Parameters:
taskId- Identifier of the task.- Returns:
- The object
BackgroundTaskData. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getCubeCursor
ICubeCursor getCubeCursor(int cursorId) throws Exception, altitude.integrationServer.exceptions.ISException Gets a cube cursor open in the instance.- Parameters:
cursorId- Identifier of the cursor.- Returns:
- The
ICubeCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getCubeDataAsAttributes
Attribute[][] getCubeDataAsAttributes(CubeDimensionRequestBase[] dimensionRequests, TimeSplitDimension timeSplitDimension, GregorianCalendar startMoment, GregorianCalendar endMoment, Duration startDayTime, Duration endDayTime, String[] columns) throws Exception, altitude.integrationServer.exceptions.ISException Fetches data from cubes.- Parameters:
dimensionRequests- The requests for each dimension.timeSplitDimension- The time split dimension.startMoment- The initial moment specified in localtime.endMoment- The final moment specified in localtime.startDayTime- The start of the period of the day.endDayTime- The end of the period of the day.columns- The columns to fetch. SeeTypes.BuiltInCounterfor the columns available.- Returns:
- The data fetched.
- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getCubeDataAsAttributes
Attribute[][] getCubeDataAsAttributes(CubeDimensionRequestBase[] dimensionRequests, TimeSplitDimension timeSplitDimension, GregorianCalendar startMoment, GregorianCalendar endMoment, Duration startDayTime, Duration endDayTime, String[] columns, PurposeFilter purposeFilter) throws Exception, altitude.integrationServer.exceptions.ISException Fetches data from cubes.- Parameters:
dimensionRequests- The requests for each dimension.timeSplitDimension- The time split dimension.startMoment- The initial moment specified in localtime.endMoment- The final moment specified in localtime.startDayTime- The start of the period of the day.endDayTime- The end of the period of the day.columns- The columns to fetch. SeeTypes.BuiltInCounterfor the columns available.purposeFilter- Purpose filter.- Returns:
- The data fetched.
- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getCubeDataAsValues
String[][] getCubeDataAsValues(CubeDimensionRequestBase[] dimensionRequests, TimeSplitDimension timeSplitDimension, GregorianCalendar startMoment, GregorianCalendar endMoment, Duration startDayTime, Duration endDayTime, String[] columns) throws Exception, altitude.integrationServer.exceptions.ISException Fetches data from cubes.- Parameters:
dimensionRequests- The requests for each dimension.timeSplitDimension- The time split dimension.startMoment- The initial moment specified in localtime.endMoment- The final moment specified in localtime.startDayTime- The start of the period of the day.endDayTime- The end of the period of the day.columns- The columns to fetch. SeeTypes.BuiltInCounterfor the columns available.- Returns:
- The data fetched.
- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getCubeDataAsValues
String[][] getCubeDataAsValues(CubeDimensionRequestBase[] dimensionRequests, TimeSplitDimension timeSplitDimension, GregorianCalendar startMoment, GregorianCalendar endMoment, Duration startDayTime, Duration endDayTime, String[] columns, PurposeFilter purposeFilter) throws Exception, altitude.integrationServer.exceptions.ISException Fetches data from cubes.- Parameters:
dimensionRequests- The requests for each dimension.timeSplitDimension- The time split dimension.startMoment- The initial moment specified in localtime.endMoment- The final moment specified in localtime.startDayTime- The start of the period of the day.endDayTime- The end of the period of the day.columns- The columns to fetch. SeeTypes.BuiltInCounterfor the columns available.purposeFilter- Purpose filter.- Returns:
- The data fetched.
- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getCubeTableSchema
CubeTableSchema getCubeTableSchema() throws Exception, altitude.integrationServer.exceptions.ISExceptionGets the table schema with all existent cube counters.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getCubeTableSchema
CubeTableSchema getCubeTableSchema(CubeDimensionRequestBase[] dimensionRequests, TimeSplitDimension timeSplitDimension, MediaType mediaType) throws Exception, altitude.integrationServer.exceptions.ISException Gets the table schema with the counters available for a certain context, specified by the set of cube dimensions, timeframe and media type. An entity can be fixed (eg: {Campaign-cp0 x BusinessSegment-bs0 x ContactList-all}) by creating aCubeDimensionRequest.EntityIdFilterwith the identifier of the entity. eg:cubeDimensionRequest.EntityIdFilter = new int[] {campaign.Id}- Parameters:
dimensionRequests- The requests for each dimension.timeSplitDimension- The time split dimension.mediaType- The type of media.- Returns:
- The
ICubeCursorcursor table schema. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getDayType
-
getDayTypeNames
-
getDayTypeNamesByDate
String[] getDayTypeNamesByDate(GregorianCalendar date) throws Exception, altitude.integrationServer.exceptions.ISException Gets the day type names that include the given date.- Parameters:
date- Date to get the day types.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getDoNotCallListNames
-
getEmailGateway
EmailGatewayData getEmailGateway(String gatewayName) throws Exception, altitude.integrationServer.exceptions.ISException Gets the email gateway data.- Parameters:
gatewayName- Name of the gateway.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getEnumeratedTypes
EnumeratedType[] getEnumeratedTypes(int tableSchemaId) throws Exception, altitude.integrationServer.exceptions.ISException Gets the enumerated types of a table schema.- Parameters:
tableSchemaId- Identifier of the table schema.- Returns:
- An array with the enumerated types.
- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getGatewayById
GatewayData getGatewayById(GatewayType gatewayType, int gatewayId) throws Exception, altitude.integrationServer.exceptions.ISException Gets information about the specified gateway.- Parameters:
gatewayType- Type of gateway.gatewayId- Id of the gateway.- Returns:
- The object
GatewayData. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getGatewayByName
GatewayData getGatewayByName(GatewayType gatewayType, String gatewayName) throws Exception, altitude.integrationServer.exceptions.ISException Gets information about the named gateway.- Parameters:
gatewayType- Type of gateway.gatewayName- Name of the gateway.- Returns:
- The object
GatewayData. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getGatewayNames
String[] getGatewayNames(GatewayType gatewayType) throws Exception, altitude.integrationServer.exceptions.ISException Gets the list of gateway names.- Parameters:
gatewayType- Type of gateway.- Returns:
- An array with the names of the gateways.
- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getGateways
GatewayData[] getGateways(GatewayType gatewayType) throws Exception, altitude.integrationServer.exceptions.ISException Gets the list of gateways.- Parameters:
gatewayType- Type of gateway.- Returns:
- An array with the gateways.
- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getGatewayState
GatewayState getGatewayState(GatewayType gatewayType, String gatewayName) throws Exception, altitude.integrationServer.exceptions.ISException Gets the state of the gateway.- Parameters:
gatewayType- Type of gateway.gatewayName- Name of the gateway.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getInstance
-
getInstanceData
Gets the instance data.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getInteractionHistoryCount
int getInteractionHistoryCount(String sql) throws Exception, altitude.integrationServer.exceptions.ISException Gets the count of the interaction history.- Parameters:
sql- Sql-like statement. The columns admitted are the ones returned by theGetInteractionHistoryTableSchemamethod. Ifnullthen all rows are counted.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getInteractionHistoryCursor
IInteractionHistoryCursor getInteractionHistoryCursor(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
IInteractionHistoryCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getInteractionHistoryTableSchema
TableSchema getInteractionHistoryTableSchema() throws Exception, altitude.integrationServer.exceptions.ISExceptionGets the table schema of anInteractionThreadScriptSessionused in the Fetch of the InteractionHistory cursor.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getNotReadyReasons
NotReadyReasonData[] getNotReadyReasons() throws Exception, altitude.integrationServer.exceptions.ISExceptionGets the list of not ready reasons.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getRouterAfinitiData
RouterAfinitiData getRouterAfinitiData() throws Exception, altitude.integrationServer.exceptions.ISExceptionGets the Router Afiniti data.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getScriptDocumentCursor
IScriptDocumentCursor getScriptDocumentCursor(int cursorId) throws Exception, altitude.integrationServer.exceptions.ISException Gets a script document cursor open in the instance.- Parameters:
cursorId- Identifier of the cursor.- Returns:
- The
IScriptDocumentCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getScriptDocumentTableSchema
TableSchema getScriptDocumentTableSchema() throws Exception, altitude.integrationServer.exceptions.ISExceptionGets the table schema of the script document.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
getTelephonyGateway
TelephonyGatewayData getTelephonyGateway(String gatewayName) throws Exception, altitude.integrationServer.exceptions.ISException Gets the telephony gateway data.- Parameters:
gatewayName- Name of the gateway.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
isInDoNotCallList
boolean isInDoNotCallList(String doNotCallListName, String number) throws Exception, altitude.integrationServer.exceptions.ISException Checks if a number is in the specified, or in the global do not call lists.- Parameters:
doNotCallListName- Name of the do not call list.number- The phone number.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
isInDoNotCallList
boolean isInDoNotCallList(String doNotCallListName, String number, String uniqueId) throws Exception, altitude.integrationServer.exceptions.ISException Checks if a number is in the specified, or in the global do not call lists.- Parameters:
doNotCallListName- Name of the do not call list.number- The phone number. This parameter is optional.uniqueId- Unique identifier of the contact profile. This parameter is optional.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
newCubeCursor
ICubeCursor newCubeCursor(CubeDimensionRequest[] dimensionRequests, TimeSplitDimension timeSplitDimension, GregorianCalendar startMoment, GregorianCalendar endMoment, Duration startDayTime, Duration endDayTime, String[] columns) throws Exception, altitude.integrationServer.exceptions.ISException Opens a cube cursor.- Parameters:
dimensionRequests- The requests for each dimension.timeSplitDimension- The time split dimension.startMoment- The initial moment specified in localtime.endMoment- The final moment specified in localtime.startDayTime- The start of the period of the day.endDayTime- The end of the period of the day.columns- The columns to fetch. SeeTypes.BuiltInCounterfor the columns available.- Returns:
- The
ICubeCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
newCubeCursor
ICubeCursor newCubeCursor(CubeDimensionRequest[] dimensionRequests, TimeSplitDimension timeSplitDimension, GregorianCalendar startMoment, GregorianCalendar endMoment, Duration startDayTime, Duration endDayTime, String[] columns, PurposeFilter purposeFilter) throws Exception, altitude.integrationServer.exceptions.ISException Opens a cube cursor.- Parameters:
dimensionRequests- The requests for each dimension.timeSplitDimension- The time split dimension.startMoment- The initial moment specified in localtime.endMoment- The final moment specified in localtime.startDayTime- The start of the period of the day.endDayTime- The end of the period of the day.columns- The columns to fetch. SeeTypes.BuiltInCounterfor the columns available.purposeFilter- Purpose filter.- Returns:
- The
ICubeCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
newInteractionHistoryCursor
IInteractionHistoryCursor newInteractionHistoryCursor(String[] columns, String sql) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException Opens an interaction history cursor. TheOutcomesfield returned by the cursor fetch have null values. Please use theIServiceManager.NewInteractionHistoryCursormethod to fetch the outcomes instead.- Parameters:
columns- Columns to fetch.sql- SQL.- Returns:
- The
IInteractionHistoryCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISExceptionaltitude.integrationServer.exceptions.ISSqlException
-
newInteractionHistoryCursor
IInteractionHistoryCursor newInteractionHistoryCursor(String[] columns, String sql, PurposeFilter purposeFilter) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException Opens an interaction history cursor. TheOutcomesfield returned by the cursor fetch have null values. Please use theIServiceManager.NewInteractionHistoryCursormethod to fetch the outcomes instead.- Parameters:
columns- Columns to fetch.sql- Sql-like statement. The columns admitted are the ones returned by theGetInteractionHistoryTableSchemamethod. Ifnullthen all rows are selected.purposeFilter- Purpose filter.- Returns:
- The
IInteractionHistoryCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISExceptionaltitude.integrationServer.exceptions.ISSqlException
-
newScriptDocumentCursor
IScriptDocumentCursor newScriptDocumentCursor(String[] columns, String sql) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException Opens a script document cursor. TheOutcomesfield returned by the cursor fetch have null values.- Parameters:
columns- Columns to fetch.sql- SQL.- Returns:
- The
IScriptDocumentCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISExceptionaltitude.integrationServer.exceptions.ISSqlException
-
startGateway
void startGateway(GatewayType gatewayType, String gatewayName) throws Exception, altitude.integrationServer.exceptions.ISException Starts the gateway.- Parameters:
gatewayType- Type of gateway.gatewayName- Name of the gateway.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
stopGateway
void stopGateway(GatewayType gatewayType, String gatewayName) throws Exception, altitude.integrationServer.exceptions.ISException Stops the gateway.- Parameters:
gatewayType- Type of gateway.gatewayName- Name of the gateway.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
tryGetCubeCursor
ICubeCursor tryGetCubeCursor(int cursorId) throws Exception, altitude.integrationServer.exceptions.ISException Gets a cube cursor open in the instance or null if it doesn't exist.- Parameters:
cursorId- Identifier of the cursor.- Returns:
- The
ICubeCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
tryGetInteractionHistoryCursor
IInteractionHistoryCursor tryGetInteractionHistoryCursor(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
IInteractionHistoryCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
tryGetScriptDocumentCursor
IScriptDocumentCursor tryGetScriptDocumentCursor(int cursorId) throws Exception, altitude.integrationServer.exceptions.ISException Gets a script document cursor open in the instance or null if it doesn't exist.- Parameters:
cursorId- Identifier of the cursor.- Returns:
- The
IScriptDocumentCursorcursor. - Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
updateDayType
void updateDayType(String dayTypeName, DayTypeUpdateRequest request) throws Exception, altitude.integrationServer.exceptions.ISException Updates a day type.- Parameters:
dayTypeName- Name of the day type.request- Contains the fields to be updated.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
updateInstance
void updateInstance(InstanceUpdateRequest request) throws Exception, altitude.integrationServer.exceptions.ISException Updates the instance.- Parameters:
request- Contains the fields to be updated.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-
updateOutcome
void updateOutcome(int outcomeId, Attribute[] outcome) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException Updates an outcome. This is a mechanism designed only to be used in specific situations to correct the outcomes introduced by the agents. Massive use of this functionality is not advised because it may impact severely the performance of the Altitude uCI Server.- Parameters:
outcomeId- Identifier of the outcome.outcome- Outcome attributes.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISExceptionaltitude.integrationServer.exceptions.ISSqlException
-
updateRouterAfiniti
void updateRouterAfiniti(RouterAfinitiUpdateRequest request) throws Exception, altitude.integrationServer.exceptions.ISException Updates the Router Afiniti.- Parameters:
request- Contains the fields to be updated.- Throws:
Exceptionaltitude.integrationServer.exceptions.ISException
-