public interface WFMCalendarService851Soap
extends java.rmi.Remote
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeNotification(int siteID,
int itemType,
long timestamp)
Acknowledges to the server that notification was received and processed.
|
void |
acknowledgeTimeOffBidStatus(long timestamp)
Acknowledges time off bid status retrieval
|
java.lang.String |
asyncDeleteSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
int timezoneID,
java.util.List<CalItemShortInformation> items,
boolean ignoreWarnings)
Request to delete existing Calendar items.
|
java.lang.String |
asyncEditSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
int timezoneID,
java.util.List<CalItemShortInformation> items,
boolean ignoreWarnings)
Request to update Calendar items.
|
java.lang.String |
asyncGetTimeOffLimits(int siteID,
int target,
int targetID,
java.util.List<java.lang.Integer> types,
double start,
double end,
int granularity)
Requests retrieval of Time-Off limit values for specified target and date range.
|
java.util.List<CalLimitInformation> |
asyncGetTimeOffLimitsRequestInformation(java.lang.String asyncRequestID)
Gets result of previous Time-Off limit request.
|
java.lang.String |
asyncGetTimeOffTypeLimits(int siteID,
int target,
int targetID,
java.util.List<java.lang.Integer> infoTypes,
double start,
double end,
int granularity,
int timeOffTypeID)
Requests retrieval of Time-Off limit values for specified target, Time-Off type and date range.
|
java.util.List<CalTypeLimitInformation> |
asyncGetTimeOffTypeLimitsRequestInformation(java.lang.String asyncRequestID)
Gets result of previous Time-Off Type limit request.
|
java.lang.String |
asyncInsertSnapshotCalendarItem(java.lang.String snapshotID,
int accessLevel,
CfgAgentFilter agentFilter,
int timezoneID,
java.util.List<java.lang.Double> dates,
CalItemShortInformation newItem,
boolean ignoreWarnings)
Request insert of the same Calendar item for specified agents and dates to Calendar snapshot.
|
java.lang.String |
asyncInsertSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
int timezoneID,
java.util.List<CalItemShortInformation> items,
boolean ignoreWarnings)
Request insert of the same Calendar item for specified agents and dates to Calendar snapshot.
|
java.lang.String |
asyncSetTimeOffLimits(java.util.List<CalLimitInformation> information)
Requests update of Time-Off limits.
|
java.lang.String |
asyncSetTimeOffTypeLimits(java.util.List<CalTypeLimitInformation> information)
Requests update of Time-Off Type limits.
|
java.util.List<CalAgentDateTimeOffBalance> |
calculateTimeOffBalance(int accessLevel,
int siteID,
java.util.List<java.lang.Integer> teamIDArray,
java.util.List<java.lang.Integer> agentIDArray,
java.util.List<java.lang.Double> dateArray,
java.util.List<java.lang.Integer> timeOffIDArray,
boolean adjustDateToLastCarryOverDate,
boolean ignoreCreditHours)
Calculates Time-Off balance hours for the selected agents for given dates.
|
java.util.List<CalDateTimeOffBalanceInformation> |
calculateTimeOffBalanceToDate(int accessLevel,
int siteID,
java.util.List<java.lang.Integer> teams,
java.util.List<java.lang.Integer> agents,
double date,
java.util.List<java.lang.Integer> timeOffTypes,
boolean ignoreCreditHours)
Calculates Time-Off balance hours for the selected target for given date.
|
java.util.List<CalDateTimeOffBalanceInformation> |
calculateTimeOffCarryOverInformation(int accessLevel,
int siteID,
java.util.List<java.lang.Integer> teams,
java.util.List<java.lang.Integer> agents,
double date,
java.util.List<java.lang.Integer> timeOffs)
Calculates Time-Off carry-over date and carry-over hours for the specified target for given date (current date).
|
void |
deleteAgentAvailabilityPatterns(int accessLevel,
int siteId,
int agentId,
java.util.List<java.lang.Integer> patternIds)
Deletes specified Agent Availability Patterns.
|
CalValidationHolder |
deleteCalendarItems(int accessLevel,
int siteID,
int timezoneID,
java.util.List<CalItemShortInformation> items,
boolean ignoreWarnings)
Deletes existing calendar items for specified agents and dates.
|
CalUpdatedSnapshot |
deleteSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
int timezoneID,
java.util.List<CalItemShortInformation> items,
boolean ignoreWarnings)
Delete specified Calendar items from snapshot.
|
CalValidationHolder |
editCalendarItems(int accessLevel,
int siteID,
int timezoneID,
java.util.List<CalItemShortInformation> items,
boolean ignoreWarnings)
Edits existing Calendar items for specified agents and dates.
|
CalUpdatedSnapshot |
editSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
int timezoneID,
java.util.List<CalItemShortInformation> items,
boolean ignoreWarnings)
Updates specified Calendar items in snapshot.
|
CalTimeOffBidStatusHolder |
fetchTimeOffBidStatusFromSnapshot(java.lang.String cfgAgentSnapshotID,
int firstIndex,
int lastIndex)
Retrieves time off bid statuses for specified range agents in snapshot
|
int |
findAgentInSnapshot(java.lang.String snapshotID,
int field,
java.lang.String value,
int startIndex)
Find first index of matching agent in Calendar snapshot.
|
void |
generateAgentAvailabilityItems(int accessLevel,
int siteId,
int agentId,
int patternId,
double start,
int numberOfDays,
int status)
Generates Availability items from specified pattern starting from requested date.
|
void |
generateAgentAvailabilityItemsForTimezone(int accessLevel,
int siteID,
int agentID,
int patternID,
double start,
int numberOfDays,
int status,
int timezoneID)
Generates Availability items from specified pattern starting from requested date with item start/end times in specific time zone.
|
java.util.List<CalAgentPatterns> |
getAgentAvailabilityPatterns(int accessLevel,
int siteId,
int agentId)
Gets Availability Patterns configured for specified Agent.
|
java.util.List<AgentTimeOffIndicators> |
getAgentTimeOffIndicators(CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
java.util.List<java.lang.Double> dates)
Returns Agent Time-Off indicators/openings for requested dates.
|
java.util.List<AgentTimeOffIndicators> |
getAgentTimeOffIndicatorsForTimezone(CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
java.util.List<java.lang.Double> dates,
int timezoneID)
Returns Agent Time-Off indicators/openings for requested dates and specified time zone.
|
java.util.List<AgentTimeOffIndicators> |
getAgentTimeOffTypeIndicators(CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
java.util.List<java.lang.Double> dates,
int timezoneID,
int timeOffTypeID)
Returns Agent Time-Off indicators/openings for requested dates, specified time zone and requested Time-Off type.
|
java.util.List<CalDateShiftHolder> |
getAllShiftByAgentAndDate(int siteID,
java.util.List<java.lang.Integer> teamIDArray,
java.util.List<java.lang.Integer> agentIDArray,
java.util.List<java.lang.Double> dateArray,
int timezoneID,
int sortMode,
boolean sortAscending)
Returns all configured shifts for specified agents, selected dates in requested time zone.
|
java.util.List<CalDateShift> |
getAllShiftByAgentAndDateEx(int siteID,
java.util.List<java.lang.Integer> teamIDArray,
java.util.List<java.lang.Integer> agentIDArray,
java.util.List<java.lang.Double> dateArray,
int sortMode,
boolean sortAscending)
Returns all configured shifts for specified agents.
|
CalData |
getAsyncCalendarItemsData(java.lang.String asyncRequestID,
CfgAgentDetails agentDetails)
Gets result of previous asynchronous request for Calendar data.
|
CalUpdatedSnapshot |
getAsyncCalendarSnapshotUpdate(java.lang.String asyncRequestID)
Gets result of previous asynchronous request for Calendar snapshot update.
|
java.util.List<AvailableAgents> |
getAvailableAgentsResult(java.lang.String asyncRequestID)
Gets result of previous request for available agents.
|
CalData |
getCalendarItemsFromSnapshot(java.lang.String snapshotID,
int startItem,
int endItem,
int request,
CfgAgentDetails agentDetails)
Retrieve Calendar items from snapshot from index startItem to index endItem.
|
CalSnapshot |
getCalendarSnapshotResult(java.lang.String requestID)
Gets result of previous asynchronous request for Calendar snapshot.
|
java.util.List<PossibleDayOffs> |
getPossibleDayOffsResult(java.lang.String asyncRequestID)
Gets result of previous request for possible day off numbers.
|
java.util.List<CalRequestData> |
getRelatedCalendarItems(java.util.List<java.lang.Integer> itemIDArray,
int timezoneID,
CalFilter filter,
CalSort sort)
Returns related Calendar items from the same request as requested items
|
CalShiftHolder |
getShiftByAgentAndDate(int siteID,
java.util.List<java.lang.Integer> teamIDArray,
java.util.List<java.lang.Integer> agentIDArray,
java.util.List<java.lang.Double> dateArray,
int timezoneID,
int sortMode,
boolean sortAscending)
Returns only shifts available for all specified agents, selected dates in requested time zone.
|
ShiftHolder |
getShiftByAgentAndDateEx(int siteID,
java.util.List<java.lang.Integer> teamIDArray,
java.util.List<java.lang.Integer> agentIDArray,
java.util.List<java.lang.Double> dateArray,
int sortMode,
boolean sortAscending)
Returns only shifts available for all specified agents.
|
CalTimeOffBidStatusHolder |
getTimeOffBidStatus(long timestamp,
CfgTimeOffBidPeriodFilter timeOffBidPeriodFilter,
CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
java.util.List<java.lang.Integer> statusFilter,
boolean provideAgentInfo,
boolean provideTimeOffBidPeriodInfo)
Returns time off bid status
|
java.util.List<CalTimeOffConfiguration> |
getTimeOffConfiguration(int accessLevel,
int siteID,
java.util.List<java.lang.Integer> teams,
java.util.List<java.lang.Integer> agents,
java.util.List<java.lang.Integer> timeOffIDs)
Returns Time-Off rule configuration for specified Time-Off types and agents.
|
java.util.List<CalTimeOffConfiguration> |
getTimeOffConfiguration2(int accessLevel,
int siteID,
java.util.List<java.lang.Integer> teams,
java.util.List<java.lang.Integer> agents,
double date,
java.util.List<java.lang.Integer> timeOffIDs)
Returns Time-Off rule configuration for specified Time-Off types and agents.
|
java.util.List<CalTimeOffInformation> |
getTimeOffInformation(int accessLevel,
int siteID,
java.util.List<java.lang.Integer> teams,
java.util.List<java.lang.Integer> agents,
double date,
java.util.List<java.lang.Integer> timeOffTypes)
Calculates and returns values of Agent Time-Off balance information.
|
java.util.List<WaitListIndicators> |
getWaitListIndicators(CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
java.util.List<java.lang.Double> dates)
Returns Wait list indicators for requested dates and agents.
|
java.util.List<WaitListIndicators> |
getWaitListIndicatorsForTimezone(CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
java.util.List<java.lang.Double> dates,
int timezoneID)
Returns Wait list indicators for requested dates and agents in specified time zone.
|
CalValidationHolder |
insertCalendarItems(int accessLevel,
int siteID,
int timezoneID,
java.util.List<CalItemShortInformation> items,
boolean ignoreWarnings)
Inserts new Calendar items for specified agents and dates.
|
CalUpdatedSnapshot |
insertSnapshotCalendarItem(java.lang.String snapshotID,
int accessLevel,
CfgAgentFilter agentFilter,
int timezoneID,
java.util.List<java.lang.Double> dates,
CalItemShortInformation newItem,
boolean ignoreWarnings)
Insert the same Calendar item for specified agents and dates to Calendar snapshot.
|
CalUpdatedSnapshot |
insertSnapshotCalendarItems(java.lang.String snapshotID,
int accessLevel,
int siteID,
int timezoneID,
java.util.List<CalItemShortInformation> items,
boolean ignoreWarnings)
Insert new Calendar items for specified agents and dates to Calendar snapshot.
|
CalSnapshot |
openCalendarSnapshotForDates(int accessLevel,
CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
CfgAgentDetails agentDetails,
int timezoneID,
java.util.List<java.lang.Double> dates,
int schScenarioID,
CalFilter filter,
CalSort sort)
Opens sorted and filtered snapshot of Calendar items for the specified agents and dates
|
java.lang.String |
openCalendarSnapshotForDatesAsync(int accessLevel,
CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
int timezoneID,
java.util.List<java.lang.Double> dates,
int schScenarioID,
CalFilter filter,
CalSort sort)
Request to open sorted and filtered snapshot of Calendar items for the specified agents and dates
|
CfgSnapshot |
openTimeOffBidPeriodAgentSnapshot(int timeOffBidPerdiodId)
Opens a snapshot of time off bidding period agents
|
java.lang.String |
performCarryOverForAgentTimeOffType(CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
java.util.List<java.lang.Integer> timeOffTypeIDArray,
double date)
Performs carry-over on carry-over day prior requested date for selected agents and Time-Off types.
|
java.lang.String |
performCarryOverForTimeOffRule(java.util.List<java.lang.Integer> timeOffRuleIDArray,
double date)
Performs carry-over on carry-over day prior requested date for selected Time-Off rules.
|
CalNotification |
pollNotification(long timestamp,
int siteID,
int itemType,
java.util.List<java.lang.Integer> teamIDArray,
java.util.List<java.lang.Integer> agentIDArray,
double calStartDate,
double calEndDate,
int detailsLevel,
boolean provideAgentInfo)
Polls calendar data change notifications
|
CalNotification |
pollNotification2(long timestamp,
int siteID,
int itemType,
java.util.List<java.lang.Integer> teamIDArray,
java.util.List<java.lang.Integer> agentIDArray,
double calStartDate,
double calEndDate,
int detailsLevel,
boolean provideAgentInfo)
Polls calendar data change notifications
|
java.lang.String |
processBidding()
Processes applicable bidding requests
|
java.lang.String |
processCarryOver() |
java.lang.String |
processWaitList() |
CalData |
queryCalendarItemsForDates(int accessLevel,
CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
CfgAgentDetails agentDetails,
int timezoneID,
java.util.List<java.lang.Double> dates,
int schScenarioID,
CalFilter filter,
CalSort sort,
int request)
Returns sorted and filtered array of Calendar items for the specified agents and dates.
|
java.lang.String |
queryCalendarItemsForDatesAsync(int accessLevel,
CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
int timezoneID,
java.util.List<java.lang.Double> dates,
int schScenarioID,
CalFilter filter,
CalSort sort,
int request)
Requests sorted and filtered array of Calendar items for the specified agents and dates.
|
java.lang.String |
requestAvailableAgents(CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
double startDate,
double endDate,
int option,
double adjustmentPercentage)
Requests available agent number for each day of the week (average if more than 1 week requested) for specified target and for each date in requested period.
|
java.lang.String |
requestPossibleDayOffs(CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
double startDate,
double endDate,
int option)
Requests possible day off numbers for each day of the week (average if more than 1 week requested) for specified target and for each date in requested period.
|
void |
setAgentAvailabilityPatterns(int accessLevel,
int siteId,
int agentId,
java.util.List<CalAgentPatterns> patterns)
Modifies (creates new, updates existing) Agent Availability Patterns.
|
void |
setTimeOffBidStatus(java.util.List<CalTimeOffBidStatus> wmTimeOffBidStatus)
Sets new time off bid status
|
java.lang.String |
setTimeOffLimitConsiderAvailableAgents(java.util.List<java.lang.Integer> siteIDArray,
java.util.List<java.lang.Integer> teamIDArray,
java.util.List<java.lang.Integer> activityIDArray,
java.util.List<java.lang.Integer> multiSiteActivityIDArray,
double startDate,
double endDate,
double percentage,
double adjustmentPercentage,
int option,
WeekdayAdjustmentPct weekdayPercentages,
java.util.List<PossibleDayOffsForDate> possibleDayOffsForDateArray)
Set specified target Time-Off limits while taking in account available agents (not all configured agents).
|
void |
updateCalendarSnapshot(java.lang.String snapshotID,
CalSort sort)
Updates existing Calendar snapshot (used to change sort order)
|
CalShiftHolder getShiftByAgentAndDate(int siteID, java.util.List<java.lang.Integer> teamIDArray, java.util.List<java.lang.Integer> agentIDArray, java.util.List<java.lang.Double> dateArray, int timezoneID, int sortMode, boolean sortAscending) throws java.rmi.RemoteException
siteID
- Site IDteamIDArray
- Team ID arrayagentIDArray
- Agent ID arraydateArray
- Requested datestimezoneID
- Time zone IDsortMode
- Sort criteriasortAscending
- Ascending/Descendingjava.rmi.RemoteException
java.util.List<CalDateShiftHolder> getAllShiftByAgentAndDate(int siteID, java.util.List<java.lang.Integer> teamIDArray, java.util.List<java.lang.Integer> agentIDArray, java.util.List<java.lang.Double> dateArray, int timezoneID, int sortMode, boolean sortAscending) throws java.rmi.RemoteException
siteID
- Site IDteamIDArray
- Team ID arrayagentIDArray
- Agent ID arraydateArray
- Requested datestimezoneID
- Time zone IDsortMode
- Sort criteriasortAscending
- Ascending/Descendingjava.rmi.RemoteException
ShiftHolder getShiftByAgentAndDateEx(int siteID, java.util.List<java.lang.Integer> teamIDArray, java.util.List<java.lang.Integer> agentIDArray, java.util.List<java.lang.Double> dateArray, int sortMode, boolean sortAscending) throws java.rmi.RemoteException
siteID
- Site IDteamIDArray
- Team ID arrayagentIDArray
- Agent ID arraydateArray
- Requested datessortMode
- Sort criteriasortAscending
- Ascending/Descendingjava.rmi.RemoteException
java.util.List<CalDateShift> getAllShiftByAgentAndDateEx(int siteID, java.util.List<java.lang.Integer> teamIDArray, java.util.List<java.lang.Integer> agentIDArray, java.util.List<java.lang.Double> dateArray, int sortMode, boolean sortAscending) throws java.rmi.RemoteException
siteID
- Site IDteamIDArray
- Team ID arrayagentIDArray
- Agent ID arraydateArray
- Requested datessortMode
- Sort criteriasortAscending
- Ascending/Descendingjava.rmi.RemoteException
java.lang.String queryCalendarItemsForDatesAsync(int accessLevel, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, int timezoneID, java.util.List<java.lang.Double> dates, int schScenarioID, CalFilter filter, CalSort sort, int request) throws java.rmi.RemoteException
accessLevel
- User access levelagentFilter
- Agent Filter CfgAgentFilter
activityFilter
- Activity Filter CfgActivityFilter
timezoneID
- Required timezone ID, 0 - local (item) timezonedates
- Date arrayschScenarioID
- Schedule scenario ID, 0 - Master (required for actual status resolution)filter
- Filter optionssort
- Sort parametersrequest
- Request flag to indicate required information.java.rmi.RemoteException
ECalAccessLevels
CalSnapshot getCalendarSnapshotResult(java.lang.String requestID) throws java.rmi.RemoteException
requestID
- Async request IDjava.rmi.RemoteException
CalData getAsyncCalendarItemsData(java.lang.String asyncRequestID, CfgAgentDetails agentDetails) throws java.rmi.RemoteException
asyncRequestID
- Async request IDagentDetails
- Configuration information detail level CfgAgentDetails
java.rmi.RemoteException
CalUpdatedSnapshot getAsyncCalendarSnapshotUpdate(java.lang.String asyncRequestID) throws java.rmi.RemoteException
asyncRequestID
- Async request IDjava.rmi.RemoteException
java.lang.String asyncInsertSnapshotCalendarItem(java.lang.String snapshotID, int accessLevel, CfgAgentFilter agentFilter, int timezoneID, java.util.List<java.lang.Double> dates, CalItemShortInformation newItem, boolean ignoreWarnings) throws java.rmi.RemoteException
snapshotID
- Snapshot IDaccessLevel
- Agent/SupervisoragentFilter
- Agent Filter CfgAgentFilter
timezoneID
- Required timezone ID, 0 - local (item) timezonedates
- Requested datesnewItem
- New Calendar item (agent and date information ignored and taken from agents and dates parameters)ignoreWarnings
- true/false and specifies weather to ignore limit if limit is violatedjava.rmi.RemoteException
ECalAccessLevels
CalUpdatedSnapshot insertSnapshotCalendarItem(java.lang.String snapshotID, int accessLevel, CfgAgentFilter agentFilter, int timezoneID, java.util.List<java.lang.Double> dates, CalItemShortInformation newItem, boolean ignoreWarnings) throws java.rmi.RemoteException
snapshotID
- Snapshot IDaccessLevel
- Agent/SupervisoragentFilter
- Agent Filter CfgAgentFilter
timezoneID
- Required timezone ID, 0 - local (item) timezonedates
- Requested datesnewItem
- New Calendar item (agent and date information ignored and taken from agents and dates parameters)ignoreWarnings
- true/false and specifies weather to ignore limit if limit is violatedjava.rmi.RemoteException
ECalAccessLevels
CalValidationHolder insertCalendarItems(int accessLevel, int siteID, int timezoneID, java.util.List<CalItemShortInformation> items, boolean ignoreWarnings) throws java.rmi.RemoteException
accessLevel
- User access levelsiteID
- Site IDtimezoneID
- Required timezone ID, 0 - local (item) timezoneitems
- Array of item information. Agent and date information is provided here.ignoreWarnings
- true/false and specifies weather to ignore limit if limit is violatedjava.rmi.RemoteException
ECalAccessLevels
java.lang.String asyncInsertSnapshotCalendarItems(java.lang.String snapshotID, int accessLevel, int siteID, int timezoneID, java.util.List<CalItemShortInformation> items, boolean ignoreWarnings) throws java.rmi.RemoteException
snapshotID
- Snapshot IDaccessLevel
- Agent/SupervisorsiteID
- Site IDtimezoneID
- Required timezone ID, 0 - local (item) timezoneitems
- Array of item information. Agents and dates information are provided here.ignoreWarnings
- true/false and specifies weather to ignore limit if limit is violatedjava.rmi.RemoteException
ECalAccessLevels
CalUpdatedSnapshot insertSnapshotCalendarItems(java.lang.String snapshotID, int accessLevel, int siteID, int timezoneID, java.util.List<CalItemShortInformation> items, boolean ignoreWarnings) throws java.rmi.RemoteException
snapshotID
- Snapshot IDaccessLevel
- Agent/SupervisorsiteID
- Site IDtimezoneID
- Required timezone ID, 0 - local (item) timezoneitems
- Array of item information. Agents and dates information are provided here.ignoreWarnings
- true/false and specifies weather to ignore limit if limit is violatedjava.rmi.RemoteException
ECalAccessLevels
CalValidationHolder editCalendarItems(int accessLevel, int siteID, int timezoneID, java.util.List<CalItemShortInformation> items, boolean ignoreWarnings) throws java.rmi.RemoteException
accessLevel
- User access levelsiteID
- Site IDtimezoneID
- Required timezone ID, 0 - local (item) timezoneitems
- Array of item information. Agents and dates information are provided here. In order to modify Exception or Time-Off items, you need to set the itemID.ignoreWarnings
- true/false and specifies weather to ignore limit if limit is violatedjava.rmi.RemoteException
ECalAccessLevels
java.lang.String asyncEditSnapshotCalendarItems(java.lang.String snapshotID, int accessLevel, int siteID, int timezoneID, java.util.List<CalItemShortInformation> items, boolean ignoreWarnings) throws java.rmi.RemoteException
snapshotID
- Snapshot IDaccessLevel
- Agent/SupervisorsiteID
- Site IDtimezoneID
- Required timezone ID, 0 - local (item) timezoneitems
- Array of item information. Agents and dates information are provided here. In order to modify Exception or Time-Off items, you need to set the itemID.ignoreWarnings
- true/false and specifies weather to ignore limit if limit is violatedjava.rmi.RemoteException
CalUpdatedSnapshot editSnapshotCalendarItems(java.lang.String snapshotID, int accessLevel, int siteID, int timezoneID, java.util.List<CalItemShortInformation> items, boolean ignoreWarnings) throws java.rmi.RemoteException
snapshotID
- Snapshot IDaccessLevel
- Agent/SupervisorsiteID
- Site IDtimezoneID
- Required timezone ID, 0 - local (item) timezoneitems
- Array of item information. Agents and dates information are provided here. In order to modify Exception or Time-Off items, you need to set the itemID.ignoreWarnings
- true/false and specifies weather to ignore limit if limit is violatedjava.rmi.RemoteException
CalValidationHolder deleteCalendarItems(int accessLevel, int siteID, int timezoneID, java.util.List<CalItemShortInformation> items, boolean ignoreWarnings) throws java.rmi.RemoteException
accessLevel
- User access levelsiteID
- Site IDtimezoneID
- Required timezone ID, 0 - local (item) timezoneitems
- Array of item information. Agents and dates information are provided here. In order to modify Exception or Time-Off items, you need to set the itemID.java.rmi.RemoteException
ECalAccessLevels
java.lang.String asyncDeleteSnapshotCalendarItems(java.lang.String snapshotID, int accessLevel, int siteID, int timezoneID, java.util.List<CalItemShortInformation> items, boolean ignoreWarnings) throws java.rmi.RemoteException
snapshotID
- Snapshot IDaccessLevel
- Agent/SupervisorsiteID
- Site IDtimezoneID
- Required timezone ID, 0 - local (item) timezoneitems
- Array of item information. Agents and dates information are provided here. In order to modify Exception or Time-Off items, you need to set the itemID.java.rmi.RemoteException
CalUpdatedSnapshot deleteSnapshotCalendarItems(java.lang.String snapshotID, int accessLevel, int siteID, int timezoneID, java.util.List<CalItemShortInformation> items, boolean ignoreWarnings) throws java.rmi.RemoteException
snapshotID
- Snapshot IDaccessLevel
- Agent/SupervisorsiteID
- Site IDtimezoneID
- Required timezone ID, 0 - local (item) timezoneitems
- Array of item information. Agents and dates information are provided here. In order to modify Exception or Time-Off items, you need to set the itemID.java.rmi.RemoteException
CalData queryCalendarItemsForDates(int accessLevel, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, CfgAgentDetails agentDetails, int timezoneID, java.util.List<java.lang.Double> dates, int schScenarioID, CalFilter filter, CalSort sort, int request) throws java.rmi.RemoteException
accessLevel
- User access levelagentFilter
- Agent Filter CfgAgentFilter
activityFilter
- Activity Filter CfgActivityFilter
agentDetails
- Configuration information detail level CfgAgentDetails
timezoneID
- Required timezone ID, 0 - local (item) timezonedates
- Date arrayschScenarioID
- Schedule scenario ID, 0 - Master (required for actual status resolution)filter
- Filter optionssort
- Sort parametersrequest
- Request flag to indicate required information.java.rmi.RemoteException
ECalAccessLevels
CalSnapshot openCalendarSnapshotForDates(int accessLevel, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, CfgAgentDetails agentDetails, int timezoneID, java.util.List<java.lang.Double> dates, int schScenarioID, CalFilter filter, CalSort sort) throws java.rmi.RemoteException
accessLevel
- User access levelagentFilter
- Agent Filter CfgAgentFilter
activityFilter
- Activity Filter CfgActivityFilter
agentDetails
- Configuration information detail level CfgAgentDetails
timezoneID
- Required timezone ID, 0 - local (item) timezonedates
- Date arrayschScenarioID
- Schedule scenario ID, 0 - Master (required for actual status resolution)filter
- Filter optionssort
- Sort parametersjava.rmi.RemoteException
ECalAccessLevels
java.lang.String openCalendarSnapshotForDatesAsync(int accessLevel, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, int timezoneID, java.util.List<java.lang.Double> dates, int schScenarioID, CalFilter filter, CalSort sort) throws java.rmi.RemoteException
accessLevel
- User access levelagentFilter
- Agent Filter CfgAgentFilter
activityFilter
- Activity Filter CfgActivityFilter
timezoneID
- Required timezone ID, 0 - local (item) timezonedates
- Date arrayschScenarioID
- Schedule scenario ID, 0 - Master (required for actual status resolution)filter
- Filter optionssort
- Sort parametersjava.rmi.RemoteException
ECalAccessLevels
void updateCalendarSnapshot(java.lang.String snapshotID, CalSort sort) throws java.rmi.RemoteException
snapshotID
- Snapshot IDsort
- Sort criteriajava.rmi.RemoteException
int findAgentInSnapshot(java.lang.String snapshotID, int field, java.lang.String value, int startIndex) throws java.rmi.RemoteException
snapshotID
- Snapshot IDfield
- Agent properties indicator (ECfgAgentField)value
- Property valuestartIndex
- Search start indexjava.rmi.RemoteException
ECfgAgentField
CalData getCalendarItemsFromSnapshot(java.lang.String snapshotID, int startItem, int endItem, int request, CfgAgentDetails agentDetails) throws java.rmi.RemoteException
snapshotID
- Snapshot IDstartItem
- Start indexendItem
- End indexrequest
- Request flag to indicate required information.agentDetails
- Configuration information detail level CfgAgentDetails
java.rmi.RemoteException
java.util.List<CalTimeOffConfiguration> getTimeOffConfiguration(int accessLevel, int siteID, java.util.List<java.lang.Integer> teams, java.util.List<java.lang.Integer> agents, java.util.List<java.lang.Integer> timeOffIDs) throws java.rmi.RemoteException
accessLevel
- User access levelsiteID
- Site IDteams
- Team ID(s)agents
- Agent ID(s)timeOffIDs
- Time-Off type ID(s)java.rmi.RemoteException
java.util.List<CalTimeOffConfiguration> getTimeOffConfiguration2(int accessLevel, int siteID, java.util.List<java.lang.Integer> teams, java.util.List<java.lang.Integer> agents, double date, java.util.List<java.lang.Integer> timeOffIDs)
accessLevel
- User access levelsiteID
- Site IDteams
- Team ID(s)agents
- Agent ID(s)date
- Date to calculate totimeOffIDs
- Time-Off type ID(s)java.rmi.RemoteException
java.util.List<CalDateTimeOffBalanceInformation> calculateTimeOffBalanceToDate(int accessLevel, int siteID, java.util.List<java.lang.Integer> teams, java.util.List<java.lang.Integer> agents, double date, java.util.List<java.lang.Integer> timeOffTypes, boolean ignoreCreditHours) throws java.rmi.RemoteException
accessLevel
- User access levelsiteID
- Site IDteams
- Team ID(s)agents
- Agent ID(s)date
- Requested datetimeOffTypes
- Time-Off types array - filter, empty = all typesignoreCreditHours
- TRUE - balance without credit hours included, FALSE - balance includes credit hoursjava.rmi.RemoteException
ECalAccessLevels
java.util.List<CalTimeOffInformation> getTimeOffInformation(int accessLevel, int siteID, java.util.List<java.lang.Integer> teams, java.util.List<java.lang.Integer> agents, double date, java.util.List<java.lang.Integer> timeOffTypes) throws java.rmi.RemoteException
accessLevel
- - User access levelsiteID
- Site IDteams
- Team ID(s)agents
- Agent ID(s)timeOffTypes
- Time-Off types array - filter, empty = all typesjava.rmi.RemoteException
ECalAccessLevels
java.util.List<CalDateTimeOffBalanceInformation> calculateTimeOffCarryOverInformation(int accessLevel, int siteID, java.util.List<java.lang.Integer> teams, java.util.List<java.lang.Integer> agents, double date, java.util.List<java.lang.Integer> timeOffs) throws java.rmi.RemoteException
accessLevel
- User access levelsiteID
- Site IDteams
- Team ID(s)agents
- Agent ID(s)timeOffs
- Time-Off types array - filter, empty = all typesjava.rmi.RemoteException
ECalAccessLevels
java.util.List<CalAgentPatterns> getAgentAvailabilityPatterns(int accessLevel, int siteId, int agentId) throws java.rmi.RemoteException
accessLevel
- User access levelsiteId
- Site IDagentId
- Agent IDjava.rmi.RemoteException
void setAgentAvailabilityPatterns(int accessLevel, int siteId, int agentId, java.util.List<CalAgentPatterns> patterns) throws java.rmi.RemoteException
accessLevel
- User access levelsiteId
- Site IDagentId
- Agent IDpatterns
- New/Updated Agent Availability Patternsjava.rmi.RemoteException
void deleteAgentAvailabilityPatterns(int accessLevel, int siteId, int agentId, java.util.List<java.lang.Integer> patternIds) throws java.rmi.RemoteException
accessLevel
- User access levelsiteId
- Site IDagentId
- Agent IDpatternIds
- Pattern ID(s)java.rmi.RemoteException
void generateAgentAvailabilityItemsForTimezone(int accessLevel, int siteID, int agentID, int patternID, double start, int numberOfDays, int status, int timezoneID) throws java.rmi.RemoteException
accessLevel
- User access levelsiteID
- Site IDagentID
- Agent IDpatternID
- Pattern IDstart
- Start DatenumberOfDays
- Number of daysstatus
- Initial generated Availability statustimezoneID
- Time zone IDjava.rmi.RemoteException
void generateAgentAvailabilityItems(int accessLevel, int siteId, int agentId, int patternId, double start, int numberOfDays, int status) throws java.rmi.RemoteException
accessLevel
- User access levelsiteId
- Site IDagentId
- Agent IDpatternId
- Pattern IDstart
- Start DatenumberOfDays
- Number of daysstatus
- Initial generated Availability statusjava.rmi.RemoteException
java.lang.String asyncGetTimeOffLimits(int siteID, int target, int targetID, java.util.List<java.lang.Integer> types, double start, double end, int granularity) throws java.rmi.RemoteException
siteID
- Site IDtarget
- Target level (ECalLimitTarget)targetID
- Target IDtypes
- Limit types (ECalLimitType)start
- Start Dateend
- Start Dategranularity
- Daily/Timestepjava.rmi.RemoteException
ECalLimitTarget
,
ECalLimitType
java.lang.String asyncGetTimeOffTypeLimits(int siteID, int target, int targetID, java.util.List<java.lang.Integer> infoTypes, double start, double end, int granularity, int timeOffTypeID) throws java.rmi.RemoteException
siteID
- Site IDtarget
- Target level (ECalLimitTarget)targetID
- Target IDinfoTypes
- Limit types (ECalLimitType)start
- Start Dateend
- Start Dategranularity
- Daily/TimesteptimeOffTypeID
- Time-Off type ID, 0 - all Time-Off typesjava.rmi.RemoteException
ECalLimitTarget
,
ECalLimitType
java.lang.String asyncSetTimeOffLimits(java.util.List<CalLimitInformation> information) throws java.rmi.RemoteException
information
- Limit informationjava.rmi.RemoteException
java.lang.String asyncSetTimeOffTypeLimits(java.util.List<CalTypeLimitInformation> information) throws java.rmi.RemoteException
information
- Limit informationjava.rmi.RemoteException
java.util.List<CalLimitInformation> asyncGetTimeOffLimitsRequestInformation(java.lang.String asyncRequestID) throws java.rmi.RemoteException
asyncRequestID
- Async request IDjava.rmi.RemoteException
java.util.List<CalTypeLimitInformation> asyncGetTimeOffTypeLimitsRequestInformation(java.lang.String asyncRequestID) throws java.rmi.RemoteException
asyncRequestID
- Async request IDjava.rmi.RemoteException
CalNotification pollNotification(long timestamp, int siteID, int itemType, java.util.List<java.lang.Integer> teamIDArray, java.util.List<java.lang.Integer> agentIDArray, double calStartDate, double calEndDate, int detailsLevel, boolean provideAgentInfo) throws java.rmi.RemoteException
timestamp
- A timestamp value to use as a baseline for notifications. A timestamp value to use as a baseline for notifications. A zero value implies current moment and negative value tells server to use last acknowledged timestamp as a baseline.siteID
- Site ID. A negative ID can be used to track changes for all sites.itemType
- A calendar item type ECalItems
to track changes for. Use CAL_ITEM_UNKNOWN type value to request notification for all item types.teamIDArray
- Team ID filter. Can be "null" meaning "any team"agentIDArray
- Agent ID filter. Can be null meaning "all agents for specified teams". If teams were not specified - means "all agents".calStartDate
- Start date of calendar data range that needs to be tracked for changes. OleDateTime
calEndDate
- End date of calendar data range that needs to be tracked for changes. OleDateTime
detailsLevel
- Notification details level ECalAuditLevel
provideAgentInfo
- Tells whether to provide short agent information about every unique agent in response.CalNotification
java.rmi.RemoteException
CalNotification pollNotification2(long timestamp, int siteID, int itemType, java.util.List<java.lang.Integer> teamIDArray, java.util.List<java.lang.Integer> agentIDArray, double calStartDate, double calEndDate, int detailsLevel, boolean provideAgentInfo) throws java.rmi.RemoteException
timestamp
- A timestamp value to use as a baseline for notifications. A timestamp value to use as a baseline for notifications. A zero value implies current moment and negative value tells server to use last acknowledged timestamp as a baseline.siteID
- Site ID. A negative ID can be used to track changes for all sites.itemType
- A calendar item type ECalItems
to track changes for. Use CAL_ITEM_UNKNOWN type value to request notification for all item types.teamIDArray
- Team ID filter. Can be "null" meaning "any team"agentIDArray
- Agent ID filter. Can be null meaning "all agents for specified teams". If teams were not specified - means "all agents".calStartDate
- Start date of calendar data range that needs to be tracked for changes. OleDateTime
calEndDate
- End date of calendar data range that needs to be tracked for changes. OleDateTime
detailsLevel
- Notification details level ECalAuditLevel
provideAgentInfo
- Tells whether to provide short agent information about every unique agent in response.CalNotification
java.rmi.RemoteException
void acknowledgeNotification(int siteID, int itemType, long timestamp) throws java.rmi.RemoteException
pollNotification(long, int, int, java.util.List<java.lang.Integer>, java.util.List<java.lang.Integer>, double, double, int, boolean)
.siteID
- Site IDitemType
- An item type from CalNotification
returned by pollNotification(long, int, int, java.util.List<java.lang.Integer>, java.util.List<java.lang.Integer>, double, double, int, boolean)
timestamp
- A timestamp value from CalNotification
returned by pollNotification(long, int, int, java.util.List<java.lang.Integer>, java.util.List<java.lang.Integer>, double, double, int, boolean)
java.rmi.RemoteException
java.util.List<AgentTimeOffIndicators> getAgentTimeOffIndicators(CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, java.util.List<java.lang.Double> dates) throws java.rmi.RemoteException
agentFilter
- Agent Filter CfgAgentFilter
activityFilter
- Activity Filter CfgActivityFilter
dates
- Date arrayjava.rmi.RemoteException
java.util.List<AgentTimeOffIndicators> getAgentTimeOffTypeIndicators(CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, java.util.List<java.lang.Double> dates, int timezoneID, int timeOffTypeID) throws java.rmi.RemoteException
agentFilter
- Agent Filter CfgAgentFilter
activityFilter
- Activity Filter CfgActivityFilter
dates
- Date listtimezoneID
- Required timezone ID, 0 - local (Site) timezonetimeOffTypeID
- Time-Off type ID, 0 - all Time-Off typesjava.rmi.RemoteException
java.util.List<AgentTimeOffIndicators> getAgentTimeOffIndicatorsForTimezone(CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, java.util.List<java.lang.Double> dates, int timezoneID) throws java.rmi.RemoteException
agentFilter
- Agent Filter CfgAgentFilter
activityFilter
- Activity Filter CfgActivityFilter
dates
- Date arraytimezoneID
- Required timezone ID, 0 - local (Site) timezonejava.rmi.RemoteException
java.util.List<CalAgentDateTimeOffBalance> calculateTimeOffBalance(int accessLevel, int siteID, java.util.List<java.lang.Integer> teamIDArray, java.util.List<java.lang.Integer> agentIDArray, java.util.List<java.lang.Double> dateArray, java.util.List<java.lang.Integer> timeOffIDArray, boolean adjustDateToLastCarryOverDate, boolean ignoreCreditHours) throws java.rmi.RemoteException
accessLevel
- User access levelsiteID
- Site IDteamIDArray
- Team ID(s)agentIDArray
- Agent ID(s)dateArray
- Requested datestimeOffIDArray
- Time-Off types arrayadjustDateToLastCarryOverDate
- Specifies whether date should be adjusted to last carry-over dateignoreCreditHours
- TRUE - balance without credit hours included, FALSE - balance includes credit hoursjava.rmi.RemoteException
ECalAccessLevels
java.lang.String setTimeOffLimitConsiderAvailableAgents(java.util.List<java.lang.Integer> siteIDArray, java.util.List<java.lang.Integer> teamIDArray, java.util.List<java.lang.Integer> activityIDArray, java.util.List<java.lang.Integer> multiSiteActivityIDArray, double startDate, double endDate, double percentage, double adjustmentPercentage, int option, WeekdayAdjustmentPct weekdayPercentages, java.util.List<PossibleDayOffsForDate> possibleDayOffsForDateArray)
siteIDArray
- Site ID arrayteamIDArray
- Team ID arrayactivityIDArray
- Activity ID arraymultiSiteActivityIDArray
- MSA ID arraystartDate
- Range start dateendDate
- Range end datepercentage
- Percentage from actual agentsadjustmentPercentage
- Adjustment percentage for non-work items (Exceptions etc.), if knownoption
- Items to consider while calculating actual number of agents at the target, default is 0 (ECalLimitConsiderations)weekdayPercentages
- Possible Day Offs for each day of weekpossibleDayOffsForDateArray
- Possible Day Offs for each date, overrides weekdayPercentages parameterECalLimitConsiderations
java.lang.String requestPossibleDayOffs(CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, double startDate, double endDate, int option)
agentFilter
- Agent Filter CfgAgentFilter
startDate
- Range start dateendDate
- Range end dateactivityFilter
- Activity Filter CfgActivityFilter
option
- Items to consider while calculating actual number of agents at the target, default is 0 (ECalLimitConsiderations)ECalLimitConsiderations
java.util.List<PossibleDayOffs> getPossibleDayOffsResult(java.lang.String asyncRequestID)
asyncRequestID
- Async Request IDPossibleDayOffs
java.lang.String requestAvailableAgents(CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, double startDate, double endDate, int option, double adjustmentPercentage)
agentFilter
- Agent Filter CfgAgentFilter
startDate
- Range start dateendDate
- Range end dateactivityFilter
- Activity Filter CfgActivityFilter
option
- Items to consider while calculating actual number of agents at the target, default is 0 (ECalLimitConsiderations)adjustmentPercentage
- ECalLimitConsiderations
java.util.List<AvailableAgents> getAvailableAgentsResult(java.lang.String asyncRequestID)
asyncRequestID
- Async Request IDAvailableAgents
and each date in the requested periodjava.lang.String processWaitList() throws java.rmi.RemoteException
java.rmi.RemoteException
java.util.List<WaitListIndicators> getWaitListIndicators(CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, java.util.List<java.lang.Double> dates) throws java.rmi.RemoteException
agentFilter
- Agent Filter CfgAgentFilter
activityFilter
- Activity Filter CfgActivityFilter
dates
- Date arrayjava.rmi.RemoteException
java.util.List<WaitListIndicators> getWaitListIndicatorsForTimezone(CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, java.util.List<java.lang.Double> dates, int timezoneID) throws java.rmi.RemoteException
agentFilter
- Agent Filter CfgAgentFilter
activityFilter
- Activity Filter CfgActivityFilter
dates
- Date arraytimezoneID
- Required timezone ID, 0 - local (Site) timezonejava.rmi.RemoteException
java.lang.String performCarryOverForTimeOffRule(java.util.List<java.lang.Integer> timeOffRuleIDArray, double date)
date
- Requested datetimeOffRuleIDArray
- Array of Time-Off Rule IDsjava.lang.String performCarryOverForAgentTimeOffType(CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, java.util.List<java.lang.Integer> timeOffTypeIDArray, double date)
agentFilter
- Agent Filter CfgAgentFilter
date
- Requested dateactivityFilter
- Activity Filter CfgActivityFilter
timeOffTypeIDArray
- Array of Time-Off Type IDsjava.lang.String processBidding()
java.util.List<CalRequestData> getRelatedCalendarItems(java.util.List<java.lang.Integer> itemIDArray, int timezoneID, CalFilter filter, CalSort sort)
sort
- Item sort criteriatimezoneID
- time zone IDitemIDArray
- requested item IDs arrayfilter
- Item filterjava.lang.String processCarryOver()
CfgSnapshot openTimeOffBidPeriodAgentSnapshot(int timeOffBidPerdiodId)
timeOffBidPerdiodId
- time off bidding period IDCalTimeOffBidStatusHolder fetchTimeOffBidStatusFromSnapshot(java.lang.String cfgAgentSnapshotID, int firstIndex, int lastIndex)
cfgAgentSnapshotID
- firstIndex
- lastIndex
- CalTimeOffBidStatusHolder getTimeOffBidStatus(long timestamp, CfgTimeOffBidPeriodFilter timeOffBidPeriodFilter, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, java.util.List<java.lang.Integer> statusFilter, boolean provideAgentInfo, boolean provideTimeOffBidPeriodInfo)
timestamp
- 0=current status, -1=status changes after last acknowledgementtimeOffBidPeriodFilter
- CfgTimeOffBidPeriodFilter
agentFilter
- CfgAgentFilter
activityFilter
- CfgActivityFilter
statusFilter
- ECalTimeOffBidStatus
provideAgentInfo
- provideTimeOffBidPeriodInfo
- void setTimeOffBidStatus(java.util.List<CalTimeOffBidStatus> wmTimeOffBidStatus)
wmTimeOffBidStatus
- void acknowledgeTimeOffBidStatus(long timestamp)
timestamp
- Copyright © 2005-2016 Genesys Telecommunications Labs, Inc. All Rights Reserved.