public interface WFMScheduleService761Soap
extends java.rmi.Remote
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeNotification(int siteID,
long timestamp)
Acknowledges to the server that the notification was received and processed.
|
void |
addActivityToScenario(int scheduleID,
int siteID,
int[] activityIDArray) |
void |
addAgentToScenario(int scheduleID,
int siteID,
SchScenarioAgent[] agentArray) |
java.lang.String |
applyCalendarItemsAsync(int scheduleID,
int siteID,
double startDate,
double endDate,
CfgAgentFilter agentFilter,
SchStateFilter stateFilter,
boolean autoCommit)
Applies non-scheduled calendar items to the schedule, if possible.
|
void |
assignProfileAgents(int scheduleID,
int siteID,
SchAssignment[] assignments) |
void |
assignProfileTeams(int scheduleID,
int siteID,
SchTeamAssignment[] assignments)
Associates profile agents in a profile team with a real team
|
java.lang.String |
autoAssignProfileAgents(int scheduleID,
int siteID,
int rankingSystem,
boolean biddingAgentsOnly)
Starts profile schedule auto-assignment engine.
|
SchAgentDayHolder |
buildAgentDay(int scheduleID,
int siteID,
SchAgentDay[] newSchedule,
SchAgentDayDetails schDetails)
Builds complete schedule shifts with optimal break/meal distibution for the given schedule shifts
|
SchAgentDayHolder |
buildAgentDayInSnapshot(java.lang.String schSnapshotID,
SchAgentDay[] newSchedule,
SchAgentDay[] modifiedSchedule,
SchAgentDayDetails schDetails)
Builds complete schedule shifts with optimal break/meal distibution for the given schedule shifts (based on existing schedule snapshot).
|
void |
clearProfileAgentAssignments(int scheduleID,
int siteID,
int[] profileAgentIDArray)
Clears the existing assignments of the profile agent schedules.
|
void |
clearProfileTeamAssignments(int scheduleID,
int siteID,
int[] teamIDArray)
Disassociates profile agents associated a real team and returns them to the original profile team.
|
java.lang.String |
commitPendingAgentDay(int scheduleID,
int siteID,
double[] days,
CfgAgentFilter agentFilter,
SchStateFilter stateFilter) |
java.lang.String |
commitPendingAgentDayFromSnapshot(java.lang.String schSnapshotID,
int[] indexArray) |
int |
createScenario(java.lang.String name,
double startDate,
double endDate,
double endDateExt,
SchScenarioSite[] sites,
int type,
java.lang.String comments)
Creates new schedule scenario
SchScenario |
java.lang.String |
deleteAgentDay(int scheduleID,
double startDate,
double endDate,
CfgAgentFilter agentFilter,
SchStateFilter stateFilter) |
void |
deleteAgentFromScenario(int scheduleID,
int siteID,
int[] agentIDArray) |
void |
deleteScenario(int scheduleID) |
java.lang.String |
deleteState(int scheduleID,
CfgAgentFilter agentFilter,
SchStateFilter stateFilter,
SchState[] states,
int timezoneId,
boolean ignoreWarnings,
boolean allOrNothing,
boolean autoCommit)
Deletes the specified scheduled state(s) from the agent(s) schedules.
|
SchAgentDayHolder |
fetchAgentDayFromSnapshot(java.lang.String schSnapshotID,
int firstAgentIndex,
int lastAgentIndex,
double firstDate,
double lastDate,
SchAgentDayDetails schDetails,
CfgAgentDetails cfgAgentDetails,
boolean autoRefresh)
Retrieves a range of schedule agent days from existing schedule snapshot.
|
SchScenarioHolder |
fetchScenarioFromSnapshot(java.lang.String snapshotID,
int firstIndex,
int lastIndex,
int infoType,
boolean provideUserInfo) |
int |
findScenarioInSnapshot(java.lang.String snapshotID,
java.lang.String name,
int startIndex) |
SchBid[] |
getAgentBids(int scheduleID,
int siteID,
int[] agentIDArray)
Returns schedule bids for the specified agents.
|
SchAgentDayHolder |
getAgentDay(SchSource source,
int scheduleID,
double startDate,
double endDate,
int timezoneId,
CfgAgentFilter agentFilter,
SchStateFilter stateFilter,
SchSortMode sortMode,
SchAgentDayDetails schDetails,
CfgAgentDetails cfgAgentDetails,
SchTotalsRequest[] totalsRequest)
Loads agent days from the specified schedule for the specified range of dates and specified set of agents.
|
SchSnapshot |
getAgentDaySnapshotResult(java.lang.String requestID) |
SchAgentStateHolder |
getAgentState(SchSource source,
int scheduleID,
double startDateTime,
double endDateTime,
int timezoneId,
CfgAgentFilter agentFilter,
SchStateFilter stateFilter,
SchStateDetails schDetails,
CfgAgentDetails cfgAgentDetails)
Loads agent scheduled states of specified type from specified time window.
|
SchAgentTotals[] |
getAgentTotals(SchSource source,
int scheduleID,
CfgAgentFilter agentFilter,
SchStateFilter stateFilter,
SchTotalsRequest[] totalsRequest)
Calculates different totals, such as paid time, work time, and vacation time, for the given agent
for the specified date period(s) and granularity.
|
java.lang.String |
getAuditLogAsync(int siteID,
int[] teamIDArray,
int[] agentIDArray,
double schStartDate,
double schEndDate,
double actionStartDateTime,
double actionEndDateTime,
int[] actionTypes,
int[] actionUsers,
int detailsLevel,
SchAgentDayDetails schDetails)
Reads schedule audit log in async mode.
|
SchAuditLog |
getAuditLogByID(long auditID,
int siteID,
int[] teamIDArray,
int[] agentIDArray,
double schStartDate,
double schEndDate,
int detailsLevel,
SchAgentDayDetails schDetails,
CfgAgentDetails cfgAgentDetails,
boolean provideScenarioInfo,
boolean provideUserInfo)
Returns information about a specific schedule audit transaction.
|
SchAuditLog |
getAuditLogResults(java.lang.String requestID,
SchAgentDayDetails schDetails,
CfgAgentDetails cfgAgentDetails,
boolean provideScenarioInfo,
boolean provideUserInfo)
Retrieves Audit Log that was requested asynchronously.
|
SchBiddingParams |
getBiddingParams(int scheduleID,
int siteID)
Returns current bidding parameters for the schedule scenario, which includes the bidding window and a list of
bidding agents.
|
SchActivitySet[] |
getDayActivitySetInfo(int siteID,
double date,
int[] activityIDArray) |
SchPlanningPeriod[] |
getPlanningPeriod(int scheduleID,
int siteID,
double startDate,
double endDate) |
SchCandidateHolder |
getProfileAgentCandidates(int scheduleID,
int siteID,
int[] profileAgentIDArray,
boolean biddingAgentsOnly,
boolean provideBids,
boolean mergeCandidates,
boolean provideAgentInfo)
Returns a list of actual agents who qualify for the schedules of the specified profile agent(s), or
returns a list of qualifying profile agents, if actual agents were specified as an input.
|
SchValidationHolder |
getRequestValidation(java.lang.String requestID)
Used to retrieve validation (error/warning) messages after the completion of asynchronous operations such as insertState, deleteState, and saveAgentDayAsync.
|
SchScenarioHolder |
getScenario(int scheduleID,
int infoType,
boolean provideUserInfo) |
CfgActivityHolder |
getScenarioActivity(int scheduleID,
int siteID,
int[] activityIDArray,
CfgSortMode sortMode,
CfgActivityDetails details) |
SchScenarioAgent[] |
getScenarioAgentInfo(int scheduleID,
int siteID,
int[] agentIDArray)
Returns additional information related to scenario agents.
|
SchAgentQuota[] |
getScenarioAgentQuota(int scheduleID,
int siteID,
int[] agentIDArray) |
SchScenarioParams |
getScenarioParams(int scheduleID,
int siteID) |
CfgSiteHolder |
getScenarioSite(int scheduleID,
int[] siteIDArray,
CfgSortMode sortMode,
CfgSiteDetails details) |
CfgTeamHolder |
getScenarioTeam(int scheduleID,
int siteID,
int[] teamIDArray,
CfgSortMode sortMode,
CfgTeamDetails details) |
CfgVirtualActivityHolder |
getScenarioVirtualActivity(int scheduleID,
int[] virtualActivityIDArray,
CfgSortMode sortMode,
CfgVirtualActivityDetails details) |
SchScenarioWarning[] |
getScenarioWarnings(int scheduleID,
int siteID) |
CfgAgentHolder |
getScheduleAgent(int scheduleID,
CfgAgentFilter agentFilter,
int[] agentTypeFilter,
int[] flagFilter,
CfgSortMode sortMode,
CfgAgentDetails cfgAgentDetails) |
SchCoverageHolder |
getStateGroupCoverage(SchSource source,
int scheduleID,
int siteID,
double startDate,
double endDate,
CfgAgentFilter agentFilter,
SchStateFilter stateFilter,
int[] stateGroups,
int granularity)
Calculates the schedule state group coverage for every specified state group, taking schedules of specified
agents.
|
SchCoverageHolder |
getStateGroupCoverageFromSnapshot(java.lang.String schSnapshotID,
int[] stateGroups,
int granularity,
SchAgentDay[] modifiedSchedule)
Calculates schedule state group coverage for every specified state group, taking schedules
from the existing schedule snapshot.
|
SchCandidateHolder |
getSwapCandidates(int scheduleID,
int siteID,
double[] days,
int[] teamIDArray,
int[] agentIDArray,
boolean provideAgentInfo) |
java.lang.String |
insertAgentDay(int scheduleID,
CfgAgentFilter agentFilter,
SchStateFilter stateFilter,
SchAgentDay[] agentDayArray,
boolean buildAgentDay,
boolean ignoreWarnings,
boolean allOrNothing,
boolean autoCommit)
Used to insert the same agent day schedule(s) for multiple agents.
|
java.lang.String |
insertAgentState(int scheduleID,
SchAgentState[] states,
boolean ignoreWarnings,
boolean allOrNothing,
boolean autoCommit)
Used to insert different schedule states into different agents' schedules.
|
java.lang.String |
insertState(int scheduleID,
CfgAgentFilter agentFilter,
SchStateFilter stateFilter,
SchState[] states,
int timezoneId,
boolean ignoreWarnings,
boolean allOrNothing,
boolean autoCommit)
Used to insert the same schedule states into different agents' schedules.
|
SchSnapshot |
openAgentDaySnapshot(SchSource source,
int scheduleID,
double startDate,
double endDate,
int timezoneId,
CfgAgentFilter agentFilter,
SchStateFilter stateFilter,
SchSortMode sortMode,
SchTotalsRequest[] totalsRequest)
Opens a snapshot of day schedules for specified criteria.
|
java.lang.String |
openAgentDaySnapshotAsync(SchSource source,
int scheduleID,
double startDate,
double endDate,
int timezoneId,
CfgAgentFilter agentFilter,
SchStateFilter stateFilter,
SchSortMode sortMode,
SchTotalsRequest[] totalsRequest) |
SchScenarioSnapshot |
openScenarioSnapshot(int ownership,
int[] typeFilter,
int[] statusFilter,
int[] siteIDFilter,
double startDate,
double endDate,
int sortMode,
boolean ascending) |
CfgSnapshot |
openScheduleAgentSnapshot(int scheduleID,
CfgAgentFilter agentFilter,
int[] agentTypeFilter,
int[] flagFilter,
CfgSortMode sortMode) |
SchNotification |
pollNotification(long timestamp,
int siteID,
int[] teamIDArray,
int[] agentIDArray,
double schStartDate,
double schEndDate,
int detailsLevel,
SchAgentDayDetails schDetails,
CfgAgentDetails cfgAgentDetails)
Polls schedule change notification
|
java.lang.String |
publishSchedule(SchSiteAgents[] siteAgents,
int sourceScheduleID,
double sourceStartDate,
double sourceEndDate,
int targetScheduleID,
double targetStartDate,
double targetEndDate,
boolean applyCalendarItems)
Publishes schedule scenario to Master, or Master to scenario, or scenario to scenario.
|
long |
readAgentDayDBTimestamp(int scheduleID,
int siteID,
int[] agentIDArray,
double startDate,
double endDate) |
long |
readScenarioDBTimestamp(int scheduleID) |
void |
renameScenario(int scheduleID,
java.lang.String name) |
long |
rollbackAuditTransaction(long auditID,
int siteID,
int[] teamIDArray,
int[] agentIDArray,
double schStartDate,
double schEndDate)
Rolls back current schedule to specific Schedule Audit Transaction from the past.
|
java.lang.String |
rollbackPendingAgentDay(int scheduleID,
int siteID,
double[] days,
CfgAgentFilter agentFilter,
SchStateFilter stateFilter) |
java.lang.String |
rollbackPendingAgentDayFromSnapshot(java.lang.String schSnapshotID,
int[] indexArray) |
SchValidationHolder |
saveAgentDay(int scheduleID,
SchAgentDay[] agentDayArray,
boolean ignoreWarnings,
boolean checkTimestamp,
boolean autoCommit)
Saves agent day schedule to database.
|
java.lang.String |
saveAgentDayAsync(int scheduleID,
SchAgentDay[] agentDayArray,
boolean ignoreWarnings,
boolean checkTimestamp,
boolean autoCommit)
Saves agent day schedule to database asynchronously.
|
void |
saveScenarioComments(int scheduleID,
java.lang.String comments) |
void |
saveScenarioWarnings(int scheduleID,
int siteID,
SchScenarioWarning[] warnings) |
SchValidationHolder |
scheduleMeeting(int scheduleID,
int siteID,
int[] teamIDArray,
int[] agentIDArray,
CfgMeeting meeting,
boolean ignoreWarnings,
boolean autoCommit)
Schedules meeting and saves it to the schedule database.
|
java.lang.String |
scheduleMeetingAsync(int scheduleID,
int siteID,
int[] teamIDArray,
int[] agentIDArray,
CfgMeeting meeting,
boolean ignoreWarnings,
boolean autoCommit)
Schedules meeting and saves it to the schedule database asynchronously.
|
void |
setAgentBids(int scheduleID,
int siteID,
int[] agentIDArray,
SchBid[] bids)
Sets schedule bid values for the specified list of agents.
|
void |
setBiddingParams(int scheduleID,
int siteID,
SchBiddingParams params)
Used to open scenario for bidding by setting bidding window and list of bidding agents.
|
void |
setScenarioAgentQuota(int scheduleID,
int siteID,
SchAgentQuota[] agentQuota) |
void |
setScenarioParams(int scheduleID,
int siteID,
SchScenarioParams param) |
void |
setScenarioType(int scheduleID,
int scenarioType) |
void |
sortAgentDaySnapshot(java.lang.String schSnapshotID,
SchSortMode sortMode) |
void |
sortScenarioSnapshot(java.lang.String snapshotID,
int sortMode,
boolean ascending) |
SchValidationHolder |
swapSchedules(int scheduleID,
int siteID,
double[] days,
int agentID1,
int agentID2,
boolean ignoreWarnings,
boolean checkTimestamp,
boolean autoCommit) |
SchValidationHolder |
validateAgentDay(int scheduleID,
int siteID,
SchAgentDay[] agentDayArray) |
SchValidationHolder |
validatePendingAgentDayFromSnapshot(java.lang.String schSnapshotID,
int[] indexArray) |
java.lang.String |
validateScheduleAsync(SchSource source,
int scheduleID,
int siteID,
double startDate,
double endDate,
CfgAgentFilter agentFilter,
SchStateFilter stateFilter)
Validates the specified range of the schedule.
|
boolean |
wasAgentDaySnapshotModified(java.lang.String schSnapshotID,
int firstAgentIndex,
int lastAgentIndex,
double firstDate,
double lastDate) |
SchAgentStateHolder getAgentState(SchSource source, int scheduleID, double startDateTime, double endDateTime, int timezoneId, CfgAgentFilter agentFilter, SchStateFilter stateFilter, SchStateDetails schDetails, CfgAgentDetails cfgAgentDetails) throws java.rmi.RemoteException
source
- Specifies schedule source SchSource
scheduleID
- Schedule (Scenario) identifier. It's zero for Master SchedulestartDateTime
- Time window start date/time OleDateTime
endDateTime
- Time window end date/time OleDateTime
timezoneId
- Time Zone ID. Identifies time zone used in startDateTime/endDateTime time window
as well time zone to use in returned schedule states. A zero value tells to use 'target' site time zone.agentFilter
- Agent filter CfgAgentFilter
stateFilter
- Schedule state filter SchStateFilter
schDetails
- Request details SchStateDetails
cfgAgentDetails
- Agent details CfgAgentDetails
SchAgentStateHolder
java.rmi.RemoteException
SchAgentDayHolder getAgentDay(SchSource source, int scheduleID, double startDate, double endDate, int timezoneId, CfgAgentFilter agentFilter, SchStateFilter stateFilter, SchSortMode sortMode, SchAgentDayDetails schDetails, CfgAgentDetails cfgAgentDetails, SchTotalsRequest[] totalsRequest) throws java.rmi.RemoteException
source
- Specifies schedule source SchSource
scheduleID
- Schedule (Scenario) identifier. It's zero for Master SchedulestartDate
- Period start date OleDateTime
endDate
- Period end date OleDateTime
timezoneId
- Time Zone ID. Identifies time zone used in startDate/endDate date period
as well time zone to use in returned schedule states. A zero value tells to use 'target' site time zone.agentFilter
- Agent filter CfgAgentFilter
stateFilter
- Schedule state filter SchStateFilter
sortMode
- Sort Mode SchSortMode
schDetails
- Request details SchAgentDayDetails
cfgAgentDetails
- Agent details CfgAgentDetails
totalsRequest
- An array of SchTotalsRequest
. Contains a request to provide selected work totals for one or several different date periods. A "null" value means request no totals.SchAgentDayHolder
java.rmi.RemoteException
SchSnapshot openAgentDaySnapshot(SchSource source, int scheduleID, double startDate, double endDate, int timezoneId, CfgAgentFilter agentFilter, SchStateFilter stateFilter, SchSortMode sortMode, SchTotalsRequest[] totalsRequest) throws java.rmi.RemoteException
source
- Specifies schedule source SchSource
scheduleID
- Schedule (Scenario) identifier. It's zero for Master SchedulestartDate
- Period start date OleDateTime
endDate
- Period end date OleDateTime
timezoneId
- Time Zone ID. Identifies time zone used in startDate/endDate date period
as well time zone to use in returned schedule states. A zero value tells to use 'target' site time zone.agentFilter
- Agent filter CfgAgentFilter
stateFilter
- Schedule state filter SchStateFilter
sortMode
- Sort Mode SchSortMode
totalsRequest
- An array of SchTotalsRequest
. Contains a request to provide selected work totals for one or several different date periods. A "null" value means request no totals.SchSnapshot
java.rmi.RemoteException
java.lang.String openAgentDaySnapshotAsync(SchSource source, int scheduleID, double startDate, double endDate, int timezoneId, CfgAgentFilter agentFilter, SchStateFilter stateFilter, SchSortMode sortMode, SchTotalsRequest[] totalsRequest) throws java.rmi.RemoteException
java.rmi.RemoteException
SchSnapshot getAgentDaySnapshotResult(java.lang.String requestID) throws java.rmi.RemoteException
java.rmi.RemoteException
void sortAgentDaySnapshot(java.lang.String schSnapshotID, SchSortMode sortMode) throws java.rmi.RemoteException
java.rmi.RemoteException
SchAgentDayHolder fetchAgentDayFromSnapshot(java.lang.String schSnapshotID, int firstAgentIndex, int lastAgentIndex, double firstDate, double lastDate, SchAgentDayDetails schDetails, CfgAgentDetails cfgAgentDetails, boolean autoRefresh) throws java.rmi.RemoteException
openAgentDaySnapshot
The range is either two dimentional (X - Agents, Y - Dates) or singe dimension (X - schedule days)schSnapshotID
- Snapshot IDfirstAgentIndex
- First Agent index (or First Schedule Day if firstDate/lastDate dimension is not used)lastAgentIndex
- Last Agent Index (or Last Schedule Day if firstDate/lastDate dimension is not used)firstDate
- First Date (can be NULL)lastDate
- Last Date (can be NULL)schDetails
- Request details SchAgentDayDetails
cfgAgentDetails
- Agent details CfgAgentDetails
autoRefresh
- Tells whether snapshot should be auto-refreshed if modified or not.SchAgentDayHolder
java.rmi.RemoteException
boolean wasAgentDaySnapshotModified(java.lang.String schSnapshotID, int firstAgentIndex, int lastAgentIndex, double firstDate, double lastDate) throws java.rmi.RemoteException
java.rmi.RemoteException
SchActivitySet[] getDayActivitySetInfo(int siteID, double date, int[] activityIDArray) throws java.rmi.RemoteException
java.rmi.RemoteException
SchAgentTotals[] getAgentTotals(SchSource source, int scheduleID, CfgAgentFilter agentFilter, SchStateFilter stateFilter, SchTotalsRequest[] totalsRequest) throws java.rmi.RemoteException
source
- Specifies schedule source SchSource
scheduleID
- Schedule (Scenario) identifier. It's zero for Master ScheduleagentFilter
- Agent filter CfgAgentFilter
stateFilter
- Schedule state filter SchStateFilter
totalsRequest
- An array of SchTotalsRequest
. Contains a request to provide selected work totals for one or several periods. A NULL value means request no totals.SchAgentTotals
[]java.rmi.RemoteException
long readAgentDayDBTimestamp(int scheduleID, int siteID, int[] agentIDArray, double startDate, double endDate) throws java.rmi.RemoteException
java.rmi.RemoteException
SchValidationHolder validateAgentDay(int scheduleID, int siteID, SchAgentDay[] agentDayArray) throws java.rmi.RemoteException
java.rmi.RemoteException
SchValidationHolder saveAgentDay(int scheduleID, SchAgentDay[] agentDayArray, boolean ignoreWarnings, boolean checkTimestamp, boolean autoCommit) throws java.rmi.RemoteException
scheduleID
- Schedule (Scenario) identifier. It's zero for Master ScheduleagentDayArray
- An array of agent day schedules SchAgentDay
to saveignoreWarnings
- if true, agent day is saved to db, even if there are warningscheckTimestamp
- If true, every agent day schedule timestamp from agentDayArray is checked against one in the database. If the database timestamp is more recent, a warning is generated.autoCommit
- Specifies whether to auto-commit the changes that are being made, or make them "pending".SchValidationHolder
java.rmi.RemoteException
java.lang.String saveAgentDayAsync(int scheduleID, SchAgentDay[] agentDayArray, boolean ignoreWarnings, boolean checkTimestamp, boolean autoCommit) throws java.rmi.RemoteException
getRequestValidation
to retrieve results.scheduleID
- Schedule (Scenario) identifier. It's zero for Master ScheduleagentDayArray
- An array of agent day schedules SchAgentDay
to saveignoreWarnings
- if true, agent day is saved to db, even if there are warningscheckTimestamp
- If true, every agent day schedule timestamp from agentDayArray is checked against one in the database. If the database timestamp is more recent, a warning is generated.autoCommit
- Specifies whether to auto-commit changes are being made or make them "pending".java.rmi.RemoteException
java.lang.String insertAgentDay(int scheduleID, CfgAgentFilter agentFilter, SchStateFilter stateFilter, SchAgentDay[] agentDayArray, boolean buildAgentDay, boolean ignoreWarnings, boolean allOrNothing, boolean autoCommit) throws java.rmi.RemoteException
getRequestValidation
to retrieve results.scheduleID
- Schedule (Scenario) identifier. It's zero for Master ScheduleagentFilter
- Agent filter CfgAgentFilter
stateFilter
- Schedule state filter SchStateFilter
agentDayArray
- An array of agent days schedules SchAgentDay
to insert. If agent ID is not specified (is zero) in passed agent day then such agent day schedule is multiplied for all target agents. Otherwise agent day schedule is inserted for specified agent only. The shift schedules to insert are passed as agent day schedules with specified shift start/end, activities and activity set schedule states.buildAgentDay
- Specifies whether breaks/meals should be automatically inserted and optimally distributed for inserted schedule shiftsignoreWarnings
- if "true" agent day is saved to db even if there were warningsallOrNothing
- Specifies whether opration is atomic or not.autoCommit
- Specifies whether to auto-commit changes are being made or make them "pending".java.rmi.RemoteException
java.lang.String deleteAgentDay(int scheduleID, double startDate, double endDate, CfgAgentFilter agentFilter, SchStateFilter stateFilter) throws java.rmi.RemoteException
java.rmi.RemoteException
SchValidationHolder swapSchedules(int scheduleID, int siteID, double[] days, int agentID1, int agentID2, boolean ignoreWarnings, boolean checkTimestamp, boolean autoCommit) throws java.rmi.RemoteException
java.rmi.RemoteException
SchCandidateHolder getSwapCandidates(int scheduleID, int siteID, double[] days, int[] teamIDArray, int[] agentIDArray, boolean provideAgentInfo) throws java.rmi.RemoteException
java.rmi.RemoteException
int createScenario(java.lang.String name, double startDate, double endDate, double endDateExt, SchScenarioSite[] sites, int type, java.lang.String comments) throws java.rmi.RemoteException
SchScenario
name
- Name of scenario. If the specified name already exists, then the next consecutive number is added to the name so as to make it unique.startDate
- Scenario start date OleDateTime
endDate
- Scenario end date OleDateTime
endDateExt
- Scenario extended end date (optional) OleDateTime
sites
- An array of SchScenarioSite
type
- Scenario type ESchScenarioType
comments
- Commentsjava.rmi.RemoteException
void deleteScenario(int scheduleID) throws java.rmi.RemoteException
java.rmi.RemoteException
void setScenarioParams(int scheduleID, int siteID, SchScenarioParams param) throws java.rmi.RemoteException
java.rmi.RemoteException
SchScenarioParams getScenarioParams(int scheduleID, int siteID) throws java.rmi.RemoteException
java.rmi.RemoteException
SchScenarioHolder getScenario(int scheduleID, int infoType, boolean provideUserInfo) throws java.rmi.RemoteException
java.rmi.RemoteException
SchScenarioSnapshot openScenarioSnapshot(int ownership, int[] typeFilter, int[] statusFilter, int[] siteIDFilter, double startDate, double endDate, int sortMode, boolean ascending) throws java.rmi.RemoteException
java.rmi.RemoteException
void sortScenarioSnapshot(java.lang.String snapshotID, int sortMode, boolean ascending) throws java.rmi.RemoteException
java.rmi.RemoteException
int findScenarioInSnapshot(java.lang.String snapshotID, java.lang.String name, int startIndex) throws java.rmi.RemoteException
java.rmi.RemoteException
SchScenarioHolder fetchScenarioFromSnapshot(java.lang.String snapshotID, int firstIndex, int lastIndex, int infoType, boolean provideUserInfo) throws java.rmi.RemoteException
java.rmi.RemoteException
CfgSiteHolder getScenarioSite(int scheduleID, int[] siteIDArray, CfgSortMode sortMode, CfgSiteDetails details) throws java.rmi.RemoteException
java.rmi.RemoteException
CfgVirtualActivityHolder getScenarioVirtualActivity(int scheduleID, int[] virtualActivityIDArray, CfgSortMode sortMode, CfgVirtualActivityDetails details) throws java.rmi.RemoteException
java.rmi.RemoteException
CfgActivityHolder getScenarioActivity(int scheduleID, int siteID, int[] activityIDArray, CfgSortMode sortMode, CfgActivityDetails details) throws java.rmi.RemoteException
java.rmi.RemoteException
CfgTeamHolder getScenarioTeam(int scheduleID, int siteID, int[] teamIDArray, CfgSortMode sortMode, CfgTeamDetails details) throws java.rmi.RemoteException
java.rmi.RemoteException
CfgAgentHolder getScheduleAgent(int scheduleID, CfgAgentFilter agentFilter, int[] agentTypeFilter, int[] flagFilter, CfgSortMode sortMode, CfgAgentDetails cfgAgentDetails) throws java.rmi.RemoteException
java.rmi.RemoteException
CfgSnapshot openScheduleAgentSnapshot(int scheduleID, CfgAgentFilter agentFilter, int[] agentTypeFilter, int[] flagFilter, CfgSortMode sortMode) throws java.rmi.RemoteException
java.rmi.RemoteException
void assignProfileAgents(int scheduleID, int siteID, SchAssignment[] assignments) throws java.rmi.RemoteException
java.rmi.RemoteException
void setScenarioAgentQuota(int scheduleID, int siteID, SchAgentQuota[] agentQuota) throws java.rmi.RemoteException
java.rmi.RemoteException
SchAgentQuota[] getScenarioAgentQuota(int scheduleID, int siteID, int[] agentIDArray) throws java.rmi.RemoteException
java.rmi.RemoteException
void clearProfileAgentAssignments(int scheduleID, int siteID, int[] profileAgentIDArray) throws java.rmi.RemoteException
scheduleID
- Schedule Scenario IDsiteID
- Site IDprofileAgentIDArray
- An array of profile agent IDsjava.rmi.RemoteException
SchCandidateHolder getProfileAgentCandidates(int scheduleID, int siteID, int[] profileAgentIDArray, boolean biddingAgentsOnly, boolean provideBids, boolean mergeCandidates, boolean provideAgentInfo) throws java.rmi.RemoteException
scheduleID
- Schedule Scenario IDsiteID
- Site IDprofileAgentIDArray
- A list of profile or actual agent IDsbiddingAgentsOnly
- Indicates whether to consider only the bidding agents as the candidate pool, or to consider all agents (true/false).provideBids
- Indicates whether to provide bids from the returned candidates (true/false).mergeCandidates
- Identifies whether to merge those candidates that have identical schedules into one returned profile agent.provideAgentInfo
- Tells whether to provide agent info (true/false).SchCandidateHolder
java.rmi.RemoteException
SchScenarioWarning[] getScenarioWarnings(int scheduleID, int siteID) throws java.rmi.RemoteException
java.rmi.RemoteException
void saveScenarioWarnings(int scheduleID, int siteID, SchScenarioWarning[] warnings) throws java.rmi.RemoteException
java.rmi.RemoteException
void saveScenarioComments(int scheduleID, java.lang.String comments) throws java.rmi.RemoteException
java.rmi.RemoteException
void renameScenario(int scheduleID, java.lang.String name) throws java.rmi.RemoteException
java.rmi.RemoteException
void deleteAgentFromScenario(int scheduleID, int siteID, int[] agentIDArray) throws java.rmi.RemoteException
java.rmi.RemoteException
void addAgentToScenario(int scheduleID, int siteID, SchScenarioAgent[] agentArray) throws java.rmi.RemoteException
java.rmi.RemoteException
void addActivityToScenario(int scheduleID, int siteID, int[] activityIDArray) throws java.rmi.RemoteException
java.rmi.RemoteException
void setScenarioType(int scheduleID, int scenarioType) throws java.rmi.RemoteException
java.rmi.RemoteException
long readScenarioDBTimestamp(int scheduleID) throws java.rmi.RemoteException
java.rmi.RemoteException
java.lang.String publishSchedule(SchSiteAgents[] siteAgents, int sourceScheduleID, double sourceStartDate, double sourceEndDate, int targetScheduleID, double targetStartDate, double targetEndDate, boolean applyCalendarItems) throws java.rmi.RemoteException
getRequestValidation
to retrieve the results.siteAgents
- Specifies which agent schedules to publish SchSiteAgents
[]sourceScheduleID
- Source scenario ID. (A value of zero designates the Master Schedule).sourceStartDate
- Source schedule range start date. OleDateTime
sourceEndDate
- Source schedule range end date. OleDateTime
targetScheduleID
- Target scenario ID. ('0' value designates Master Schedule).targetStartDate
- Target schedule range start date. OleDateTime
targetEndDate
- Target schedule range start date. OleDateTime
applyCalendarItems
- Tells whether to apply calendar items (true/false).java.rmi.RemoteException
java.lang.String insertAgentState(int scheduleID, SchAgentState[] states, boolean ignoreWarnings, boolean allOrNothing, boolean autoCommit) throws java.rmi.RemoteException
getRequestValidation
to retrieve results.scheduleID
- Schedule (Scenario) identifier. It's zero for Master Schedulestates
- An array of SchAgentState
to insertignoreWarnings
- If "true" tells to proceed with insert even if there were warnings.allOrNothing
- If "true" tells that all schedule states should be successfully inserted for all specified agents as an atomic transaction. A "false" value tells that all successful inserts should be kept even if other inserts have failed.autoCommit
- Specifies whether to auto-commit changes are being made or make them "pending".java.rmi.RemoteException
java.lang.String insertState(int scheduleID, CfgAgentFilter agentFilter, SchStateFilter stateFilter, SchState[] states, int timezoneId, boolean ignoreWarnings, boolean allOrNothing, boolean autoCommit) throws java.rmi.RemoteException
getRequestValidation
to retrieve results.scheduleID
- Schedule (Scenario) identifier. It's zero for Master ScheduleagentFilter
- Agent filter CfgAgentFilter
stateFilter
- Schedule state filter SchStateFilter
states
- An array of SchState
to inserttimezoneId
- Time Zone ID. Identifies time zone used in states start/end timesignoreWarnings
- If "true" tells to proceed with insert even if there were warnings.allOrNothing
- If "true" tells that all schedule states should be successfully inserted for all specified agents as an atomic transaction. A "false" value tells that all successful inserts should be kept even if other inserts have failed.autoCommit
- Specifies whether to auto-commit changes are being made or make them "pending".java.rmi.RemoteException
java.lang.String deleteState(int scheduleID, CfgAgentFilter agentFilter, SchStateFilter stateFilter, SchState[] states, int timezoneId, boolean ignoreWarnings, boolean allOrNothing, boolean autoCommit) throws java.rmi.RemoteException
getRequestValidation
to retrieve results.scheduleID
- Schedule (Scenario) identifier (zero for Master Schedule)agentFilter
- Agent filter CfgAgentFilter
stateFilter
- Schedule state filter SchStateFilter
states
- An array of SchState
. Every state's start/end times specify start and end date time of the time window where the specified scheduled states should be located for this delete operation. A scheduled state is assumed to be inside the window, even if it is only partially inside it.timezoneId
- Time Zone ID. Identifies time zone used in states start/end timesignoreWarnings
- If true, indicates that the procedure should proceed with the deletion, even if there are warnings.allOrNothing
- If true, indicates that the entire series of scheduled states deletions should be succeed for all the specified agents as a single transaction. A false value indicates that individual successful deletions should be retained, even if other deletions fail.autoCommit
- Specifies whether to auto-commit changes that are being made, or designate them "pending".java.rmi.RemoteException
SchValidationHolder getRequestValidation(java.lang.String requestID) throws java.rmi.RemoteException
requestID
- Asynchronous request IDSchValidationHolder
java.rmi.RemoteException
SchPlanningPeriod[] getPlanningPeriod(int scheduleID, int siteID, double startDate, double endDate) throws java.rmi.RemoteException
java.rmi.RemoteException
java.lang.String commitPendingAgentDay(int scheduleID, int siteID, double[] days, CfgAgentFilter agentFilter, SchStateFilter stateFilter) throws java.rmi.RemoteException
java.rmi.RemoteException
java.lang.String rollbackPendingAgentDay(int scheduleID, int siteID, double[] days, CfgAgentFilter agentFilter, SchStateFilter stateFilter) throws java.rmi.RemoteException
java.rmi.RemoteException
SchValidationHolder validatePendingAgentDayFromSnapshot(java.lang.String schSnapshotID, int[] indexArray) throws java.rmi.RemoteException
java.rmi.RemoteException
java.lang.String commitPendingAgentDayFromSnapshot(java.lang.String schSnapshotID, int[] indexArray) throws java.rmi.RemoteException
java.rmi.RemoteException
java.lang.String rollbackPendingAgentDayFromSnapshot(java.lang.String schSnapshotID, int[] indexArray) throws java.rmi.RemoteException
java.rmi.RemoteException
SchNotification pollNotification(long timestamp, int siteID, int[] teamIDArray, int[] agentIDArray, double schStartDate, double schEndDate, int detailsLevel, SchAgentDayDetails schDetails, CfgAgentDetails cfgAgentDetails) throws java.rmi.RemoteException
timestamp
- A timestamp value to use as a baseline for notifications. A zero value implies the current moment, and a negative value tells the server to use the last acknowledged timestamp as a baseline.siteID
- Site IDteamIDArray
- 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, it means "all agents".schStartDate
- Start date of the schedule range that needs to be tracked for changes. OleDateTime
schEndDate
- End date of the schedule range that needs to be tracked for changes. OleDateTime
detailsLevel
- Level of notification details ESchAuditLevel
schDetails
- Schedule details SchAgentDayDetails
cfgAgentDetails
- Agent details CfgAgentDetails
SchNotification
java.rmi.RemoteException
void acknowledgeNotification(int siteID, long timestamp) throws java.rmi.RemoteException
pollNotification
.siteID
- Site IDtimestamp
- A timestamp value from SchNotification
returned by pollNotification
java.rmi.RemoteException
java.lang.String getAuditLogAsync(int siteID, int[] teamIDArray, int[] agentIDArray, double schStartDate, double schEndDate, double actionStartDateTime, double actionEndDateTime, int[] actionTypes, int[] actionUsers, int detailsLevel, SchAgentDayDetails schDetails) throws java.rmi.RemoteException
siteID
- Site IDteamIDArray
- 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, it means "all agents".schStartDate
- Start date of schedule range that you are interested in. Can be NULL. OleDateTime
schEndDate
- End date of schedule range that you are interested in. Can be NULL. OleDateTime
actionStartDateTime
- Start date+time of action time range. It always uses the GMT timezone. Can be NULL to ignore. OleDateTime
actionEndDateTime
- End date+time of action time range. It always uses the GMT timezone. Can be NULL to ignore. OleDateTime
actionTypes
- Action type filter ESchActionType
. Can be null.actionUsers
- User ID filter. Can be null.detailsLevel
- Audit log details level ESchAuditLevel
schDetails
- Schedule details SchAgentDayDetails
java.rmi.RemoteException
SchAuditLog getAuditLogResults(java.lang.String requestID, SchAgentDayDetails schDetails, CfgAgentDetails cfgAgentDetails, boolean provideScenarioInfo, boolean provideUserInfo) throws java.rmi.RemoteException
requestID
- Async request ID that was returned by getAuditLogAsync
.schDetails
- cfgAgentDetails
- provideScenarioInfo
- Tells whether to provide SchScenarioShort
information about every unique scenario in the response.provideUserInfo
- Tells whether to provide short user information about every unique user in the response.SchAuditLog
java.rmi.RemoteException
SchAuditLog getAuditLogByID(long auditID, int siteID, int[] teamIDArray, int[] agentIDArray, double schStartDate, double schEndDate, int detailsLevel, SchAgentDayDetails schDetails, CfgAgentDetails cfgAgentDetails, boolean provideScenarioInfo, boolean provideUserInfo) throws java.rmi.RemoteException
auditID
- The ID of the specific Schedule Audit Transaction SchAuditTransaction
siteID
- Site IDteamIDArray
- 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".schStartDate
- Start date of schedule range that you are interested in. Can be NULL. OleDateTime
schEndDate
- End date of schedule range that you are interested in. Can be NULL. OleDateTime
detailsLevel
- Level for the audit log details ESchAuditLevel
schDetails
- SchAgentDayDetails
cfgAgentDetails
- provideScenarioInfo
- Tells whether to provide SchScenarioShort
information about every unique scenario in the response.provideUserInfo
- Tells whether to provide short user information about every unique user in the response.SchAuditLog
java.rmi.RemoteException
long rollbackAuditTransaction(long auditID, int siteID, int[] teamIDArray, int[] agentIDArray, double schStartDate, double schEndDate) throws java.rmi.RemoteException
auditID
- An ID of Schedule Audit Transaction to which to rollback schedule state.siteID
- Site IDteamIDArray
- 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".schStartDate
- Start date of schedule range that you are interested in. Can be null. OleDateTime
schEndDate
- End date of schedule range that you are interested in. Can be null. OleDateTime
java.rmi.RemoteException
SchAgentDayHolder buildAgentDayInSnapshot(java.lang.String schSnapshotID, SchAgentDay[] newSchedule, SchAgentDay[] modifiedSchedule, SchAgentDayDetails schDetails) throws java.rmi.RemoteException
schSnapshotID
- Schedule Snapshot IDnewSchedule
- Schedule shifts that need to be builtmodifiedSchedule
- Other modified, but not saved agent daysschDetails
- SchAgentDayDetails
SchAgentDayHolder
java.rmi.RemoteException
SchAgentDayHolder buildAgentDay(int scheduleID, int siteID, SchAgentDay[] newSchedule, SchAgentDayDetails schDetails) throws java.rmi.RemoteException
scheduleID
- Schedule IDsiteID
- Site IDnewSchedule
- Schedule shifts that need to be builtschDetails
- SchAgentDayDetails
SchAgentDayHolder
java.rmi.RemoteException
SchValidationHolder scheduleMeeting(int scheduleID, int siteID, int[] teamIDArray, int[] agentIDArray, CfgMeeting meeting, boolean ignoreWarnings, boolean autoCommit) throws java.rmi.RemoteException
scheduleID
- Scenario ID (0 value stands for Master Schedule)siteID
- Site IDteamIDArray
- 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".meeting
- Meeting definition CfgMeeting
ignoreWarnings
- Tells whether warnings should be ignored or not. If not and there are warnings,
then resulting schedules are saved as 'pending' schedules no matter what 'autoCommit' parameter is.autoCommit
- Specifies whether to auto-commit the changes that are being made, or make them "pending".SchValidationHolder
java.rmi.RemoteException
java.lang.String scheduleMeetingAsync(int scheduleID, int siteID, int[] teamIDArray, int[] agentIDArray, CfgMeeting meeting, boolean ignoreWarnings, boolean autoCommit) throws java.rmi.RemoteException
getRequestValidation
to retrieve results.scheduleID
- Scenario ID (0 value stands for Master Schedule)siteID
- Site IDteamIDArray
- 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".meeting
- Meeting definition CfgMeeting
ignoreWarnings
- Tells whether warnings should be ignored or not. If not and there are warnings,
then resulting schedules are saved as 'pending' schedules no matter what 'autoCommit' parameter is.autoCommit
- Specifies whether to auto-commit the changes that are being made, or make them "pending".java.rmi.RemoteException
void setBiddingParams(int scheduleID, int siteID, SchBiddingParams params) throws java.rmi.RemoteException
scheduleID
- Scenario IDsiteID
- Site IDparams
- SchBiddingParams
java.rmi.RemoteException
SchBiddingParams getBiddingParams(int scheduleID, int siteID) throws java.rmi.RemoteException
scheduleID
- Scenario IDsiteID
- Site IDSchBiddingParams
java.rmi.RemoteException
java.lang.String autoAssignProfileAgents(int scheduleID, int siteID, int rankingSystem, boolean biddingAgentsOnly) throws java.rmi.RemoteException
scheduleID
- Scenario IDsiteID
- Site IDrankingSystem
- Ranking system that should be used while auto-assigning, ESchRankingSystem
biddingAgentsOnly
- Tells whether to consider only the agents bidding as the candidate pool, or consider all agents (true/false).java.rmi.RemoteException
SchScenarioAgent[] getScenarioAgentInfo(int scheduleID, int siteID, int[] agentIDArray) throws java.rmi.RemoteException
SchScenarioAgent
scheduleID
- Scenario IDsiteID
- Site IDagentIDArray
- An array of agent IDsSchScenarioAgent
[]java.rmi.RemoteException
void setAgentBids(int scheduleID, int siteID, int[] agentIDArray, SchBid[] bids) throws java.rmi.RemoteException
scheduleID
- Scenario IDsiteID
- Site IDagentIDArray
- An array of agent IDs whose bids are being set. Note that if 'agentIDArray' contains
some agent ID, and there are no bid records in the provided 'bids' array, then it is understood that all existing
bids for that agent should be cleared.bids
- An array of agent bids. SchBid
java.rmi.RemoteException
SchBid[] getAgentBids(int scheduleID, int siteID, int[] agentIDArray) throws java.rmi.RemoteException
scheduleID
- Scenario IDsiteID
- Site IDagentIDArray
- An array of agent IDs whose bids are to be returned.SchBid
[]java.rmi.RemoteException
java.lang.String validateScheduleAsync(SchSource source, int scheduleID, int siteID, double startDate, double endDate, CfgAgentFilter agentFilter, SchStateFilter stateFilter) throws java.rmi.RemoteException
getRequestValidation
to retrieve the results.source
- Specifies schedule source ESchSource
scheduleID
- Scenario IDsiteID
- Site IDstartDate
- Schedule range start date. OleDateTime
endDate
- Schedule range end date. OleDateTime
agentFilter
- Agent filter CfgAgentFilter
stateFilter
- Schedule state filter SchStateFilter
java.rmi.RemoteException
java.lang.String applyCalendarItemsAsync(int scheduleID, int siteID, double startDate, double endDate, CfgAgentFilter agentFilter, SchStateFilter stateFilter, boolean autoCommit) throws java.rmi.RemoteException
getRequestValidation
to retrieve the results.scheduleID
- Schedule Scenario IDsiteID
- Site IDstartDate
- Schedule range start date. OleDateTime
endDate
- Schedule range end date. OleDateTime
agentFilter
- Agent filter CfgAgentFilter
stateFilter
- Schedule state filter SchStateFilter
autoCommit
- Specifies whether to auto-commit the changes that are being made, or make them "pending".java.rmi.RemoteException
SchCoverageHolder getStateGroupCoverage(SchSource source, int scheduleID, int siteID, double startDate, double endDate, CfgAgentFilter agentFilter, SchStateFilter stateFilter, int[] stateGroups, int granularity) throws java.rmi.RemoteException
source
- Specifies schedule source ESchSource
scheduleID
- Schedule (Scenario) identifier (zero for the Master Schedule)siteID
- Site IDstartDate
- Period start date OleDateTime
endDate
- Period end date OleDateTime
agentFilter
- Agent filter CfgAgentFilter
stateFilter
- Schedule state filter SchStateFilter
stateGroups
- A list of state group IDs for which coverage needs to be calculated. If NULL, coverage
is calculated for all configured state groups.granularity
- The granularity of the returned coverage ESchGranularity
SchCoverageHolder
java.rmi.RemoteException
SchCoverageHolder getStateGroupCoverageFromSnapshot(java.lang.String schSnapshotID, int[] stateGroups, int granularity, SchAgentDay[] modifiedSchedule) throws java.rmi.RemoteException
schSnapshotID
- Schedule snapshot IDstateGroups
- A list of state group IDs for which coverage needs to be calculated. If NULL, coverage
is calculated for all configured state groups.granularity
- The granularity of the returned coverage ESchGranularity
modifiedSchedule
- An array of agent schedule days that are not saved yetSchCoverageHolder
java.rmi.RemoteException
void assignProfileTeams(int scheduleID, int siteID, SchTeamAssignment[] assignments) throws java.rmi.RemoteException
scheduleID
- Schedule scenario IDsiteID
- Site IDassignments
- SchTeamAssignment
[]java.rmi.RemoteException
void clearProfileTeamAssignments(int scheduleID, int siteID, int[] teamIDArray) throws java.rmi.RemoteException
scheduleID
- Schedule scenario IDsiteID
- Site IDteamIDArray
- An array of real team IDs.java.rmi.RemoteException
Copyright © 2005-2016 Genesys Telecommunications Labs, Inc. All Rights Reserved.