public interface WFMScheduleService800Soap
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,
java.util.List<java.lang.Integer> activityIDArray)
Adds new activities to the scenario
|
void |
addAgentToScenario(int scheduleID,
int siteID,
java.util.List<SchScenarioAgent> agentArray)
Adds new agents to the scenario
|
java.lang.String |
applyCalendarItemsAsync(int scheduleID,
double startDate,
double endDate,
CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
SchStateFilter stateFilter,
boolean autoCommit)
Applies non-scheduled calendar items to the schedule, if possible.
|
void |
assignProfileAgents(int scheduleID,
int siteID,
java.util.List<SchAssignment> assignments)
Manually assigns profile schedule to the actual agents.
|
void |
assignProfileTeams(int scheduleID,
int siteID,
java.util.List<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,
java.util.List<SchAgentDay> newSchedule,
SchAgentDayDetails schDetails)
Builds complete schedule shifts with optimal break/meal distribution for the given schedule shifts
|
SchAgentDayHolder |
buildAgentDayInSnapshot(java.lang.String schSnapshotID,
java.util.List<SchAgentDay> newSchedule,
java.util.List<SchAgentDay> modifiedSchedule,
SchAgentDayDetails schDetails)
Builds complete schedule shifts with optimal break/meal distribution for the given schedule shifts (based on existing schedule snapshot).
|
void |
clearProfileAgentAssignments(int scheduleID,
int siteID,
java.util.List<java.lang.Integer> profileAgentIDArray)
Clears the existing assignments of the profile agent schedules.
|
void |
clearProfileTeamAssignments(int scheduleID,
int siteID,
java.util.List<java.lang.Integer> teamIDArray)
Disassociates profile agents associated a real team and returns them to the original profile team.
|
java.lang.String |
commitPendingAgentDay(int scheduleID,
java.util.List<java.lang.Double> days,
CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
SchStateFilter stateFilter)
Commits pending schedule
|
java.lang.String |
commitPendingAgentDayFromSnapshot(java.lang.String schSnapshotID,
java.util.List<java.lang.Integer> indexArray)
Commits pending schedule from snapshot
|
int |
createScenario(java.lang.String name,
double startDate,
double endDate,
double endDateExt,
java.util.List<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,
CfgActivityFilter activityFilter,
SchStateFilter stateFilter)
Deletes specified range of schedule
|
void |
deleteAgentFromScenario(int scheduleID,
int siteID,
java.util.List<java.lang.Integer> agentIDArray)
Deletes specified agents and their schedules from the scenario
|
void |
deleteScenario(int scheduleID)
Deletes specified schedule scenario
|
java.lang.String |
deleteState(int scheduleID,
CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
SchStateFilter stateFilter,
java.util.List<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)
Returns range of scenarios from scenario snapshot
|
int |
findScenarioInSnapshot(java.lang.String snapshotID,
java.lang.String name,
int startIndex)
Finds scenario index in snapshot
|
java.util.List<SchBid> |
getAgentBids(int scheduleID,
int siteID,
java.util.List<java.lang.Integer> agentIDArray)
Returns schedule bids for the specified agents.
|
SchAgentDayHolder |
getAgentDay(SchSource source,
int scheduleID,
double startDate,
double endDate,
int timezoneId,
CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
SchStateFilter stateFilter,
SchSortMode sortMode,
SchAgentDayDetails schDetails,
CfgAgentDetails cfgAgentDetails,
java.util.List<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)
Returns results of completed openAgentDaySnapshotAsync async request.
|
SchAgentStateHolder |
getAgentState(SchSource source,
int scheduleID,
double startDateTime,
double endDateTime,
int timezoneId,
CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
SchStateFilter stateFilter,
SchStateDetails schDetails,
CfgAgentDetails cfgAgentDetails)
Loads agent scheduled states of specified type from specified time window.
|
java.util.List<SchAgentTotals> |
getAgentTotals(SchSource source,
int scheduleID,
CfgAgentFilter agentFilter,
java.util.List<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,
java.util.List<java.lang.Integer> teamIDArray,
java.util.List<java.lang.Integer> agentIDArray,
double schStartDate,
double schEndDate,
double actionStartDateTime,
double actionEndDateTime,
java.util.List<java.lang.Integer> actionTypes,
java.util.List<java.lang.Integer> actionUsers,
int detailsLevel,
SchAgentDayDetails schDetails)
Reads schedule audit log in async mode.
|
SchAuditLog |
getAuditLogByID(long auditID,
int siteID,
java.util.List<java.lang.Integer> teamIDArray,
java.util.List<java.lang.Integer> 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.
|
java.util.List<SchActivitySet> |
getDayActivitySetInfo(int siteID,
double date,
java.util.List<java.lang.Integer> activityIDArray)
Returns Activity Set info for specified activities
|
java.util.List<SchActivitySet> |
getDayActivitySetInfo2(int siteID,
double date,
java.util.List<java.lang.Integer> schActivities,
java.util.List<SchActivitySet> schActivitySetInfo) |
java.util.List<SchPlanningPeriod> |
getPlanningPeriod(int scheduleID,
int siteID,
double startDate,
double endDate)
Returns schedule planning period information
|
SchCandidateHolder |
getProfileAgentCandidates(int scheduleID,
int siteID,
java.util.List<java.lang.Integer> 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)
Returns specified schedule scenario information
|
CfgActivityHolder |
getScenarioActivity(int scheduleID,
CfgActivityFilter activityFilter,
CfgAgentFilter agentFilter,
CfgProfileFilter profileFilter,
CfgSortMode sortMode,
CfgActivityDetails details)
Returns
CfgActivity from schedule scenario |
java.util.List<SchScenarioAgent> |
getScenarioAgentInfo(int scheduleID,
CfgAgentFilter agentFilter)
Returns additional information related to scenario agents.
|
java.util.List<SchAgentQuota> |
getScenarioAgentQuota(int scheduleID,
int siteID,
java.util.List<java.lang.Integer> agentIDArray)
Returns
SchAgentQuota for scenario |
CfgBUHolder |
getScenarioBU(int scheduleID,
CfgBUFilter BUFilter,
CfgSortMode sortMode,
CfgBUDetails details)
Returns
CfgBU from schedule scenario |
int |
getScenarioForecast(int scheduleID)
Returns forecast associated with schedule scenario
|
java.util.List<SchScenarioParams> |
getScenarioParams(int scheduleID,
java.util.List<java.lang.Integer> siteIDs)
Returns scenario parameters
|
CfgSiteHolder |
getScenarioSite(int scheduleID,
CfgSiteFilter siteFilter,
CfgSortMode sortMode,
CfgSiteDetails details)
Returns
CfgSite from schedule scenario |
CfgTeamHolder |
getScenarioTeam(int scheduleID,
CfgTeamFilter teamFilter,
CfgSortMode sortMode,
CfgTeamDetails details)
Returns
CfgTeam from schedule scenario |
CfgVirtualActivityHolder |
getScenarioVirtualActivity(int scheduleID,
CfgVirtualActivityFilter virtualActivityFilter,
CfgAgentFilter agentFilter,
CfgProfileFilter profileFilter,
CfgSortMode sortMode,
CfgVirtualActivityDetails details)
Returns
CfgVirtualActivity from schedule scenario |
java.util.List<SchScenarioWarning> |
getScenarioWarnings(int scheduleID,
java.util.List<java.lang.Integer> siteIDs)
Returns scenario warnings
|
CfgAgentHolder |
getScheduleAgent(int scheduleID,
CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
java.util.List<java.lang.Integer> agentTypeFilter,
java.util.List<java.lang.Integer> flagFilter,
CfgSortMode sortMode,
CfgAgentDetails cfgAgentDetails)
Returns
CfgAgent from schedule scenario |
SchStateGroupCoverageHolder |
getStateGroupCoverage(SchSource source,
int scheduleID,
double startDate,
double endDate,
int timezoneId,
CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
SchStateFilter stateFilter,
CfgStateGroupFilter stateGroupFilter,
int granularity)
Calculates the schedule state group coverage for every specified state group, taking schedules of specified
agents.
|
SchStateGroupCoverageHolder |
getStateGroupCoverageFromSnapshot(java.lang.String schSnapshotID,
CfgStateGroupFilter stateGroupFilter,
int granularity,
java.util.List<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,
java.util.List<java.lang.Double> days,
java.util.List<java.lang.Integer> teamIDArray,
java.util.List<java.lang.Integer> agentIDArray,
boolean provideAgentInfo)
Returns list of agents that qualify for the schedule swap with specified agent.
|
java.util.List<SchTeamTotals> |
getTeamTotals(SchSource source,
int scheduleID,
int siteID,
java.util.List<java.lang.Integer> teamIDArray,
java.util.List<SchTotalsRequest> totalsRequest)
Calculates Team work totals taking into account team history
|
java.lang.String |
insertAgentDay(int scheduleID,
CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
SchStateFilter stateFilter,
java.util.List<SchAgentDay> agentDayArray,
boolean buildAgentDay,
boolean ignoreWarnings,
boolean allOrNothing,
boolean autoCommit)
Used to insert the same agent day schedule(s) for multiple agents.
- Target agents can be specified using usual agent filter, which can have site, team(s), agent(s) as filtering criteria as well as agent scheduled states filter. - The shift schedules to insert are passed as agent day schedules with specified shift start/end, activities and activity set schedule states. - If agent ID is not specified (is zero) in passed agent day then such agent day schedule is multiplied for all target agents. |
java.lang.String |
insertAgentState(int scheduleID,
java.util.List<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,
CfgActivityFilter activityFilter,
SchStateFilter stateFilter,
java.util.List<SchState> states,
int timezoneId,
boolean ignoreWarnings,
boolean allOrNothing,
boolean autoCommit)
Used to insert the same schedule states into different agents' schedules.
|
java.lang.String |
insertWorkState(int scheduleID,
CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
SchStateFilter stateFilter,
java.util.List<SchWorkState> states,
boolean replaceExistingWorkOnly,
boolean ignoreWarnings,
boolean allOrNothing,
boolean autoCommit)
Inserts Work State / Overtime
|
SchSnapshot |
openAgentDaySnapshot(SchSource source,
int scheduleID,
double startDate,
double endDate,
int timezoneId,
CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
SchStateFilter stateFilter,
SchSortMode sortMode,
java.util.List<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,
CfgActivityFilter activityFilter,
SchStateFilter stateFilter,
SchSortMode sortMode,
java.util.List<SchTotalsRequest> totalsRequest)
Opens a snapshot asynchronously of day schedules for specified criteria.
|
SchScenarioSnapshot |
openScenarioSnapshot(int ownership,
java.util.List<java.lang.Integer> typeFilter,
java.util.List<java.lang.Integer> statusFilter,
java.util.List<java.lang.Integer> siteIDFilter,
double startDate,
double endDate,
int sortMode,
boolean ascending)
Opens schedule scenario snapshot
|
CfgSnapshot |
openScheduleAgentSnapshot(int scheduleID,
CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
java.util.List<java.lang.Integer> agentTypeFilter,
java.util.List<java.lang.Integer> flagFilter,
CfgSortMode sortMode)
Opens CfgAgent snapshot from schedule scenario
|
SchNotification |
pollNotification(long timestamp,
int siteID,
java.util.List<java.lang.Integer> teamIDArray,
java.util.List<java.lang.Integer> agentIDArray,
double schStartDate,
double schEndDate,
int detailsLevel,
SchAgentDayDetails schDetails,
CfgAgentDetails cfgAgentDetails)
Polls schedule change notification
|
java.lang.String |
publishSchedule(java.util.List<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,
java.util.List<java.lang.Integer> agentIDArray,
double startDate,
double endDate)
Returns timestamp of specified schedule range
|
long |
readScenarioDBTimestamp(int scheduleID)
Returns scenario modification timestamp
|
void |
renameScenario(int scheduleID,
java.lang.String name)
Renames schedule scenario
|
long |
rollbackAuditTransaction(long auditID,
int siteID,
java.util.List<java.lang.Integer> teamIDArray,
java.util.List<java.lang.Integer> agentIDArray,
double schStartDate,
double schEndDate)
Rolls back current schedule to specific Schedule Audit Transaction from the past.
|
java.lang.String |
rollbackPendingAgentDay(int scheduleID,
java.util.List<java.lang.Double> days,
CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
SchStateFilter stateFilter)
Rolls back pending schedule
|
java.lang.String |
rollbackPendingAgentDayFromSnapshot(java.lang.String schSnapshotID,
java.util.List<java.lang.Integer> indexArray)
Rolls back pending schedule from snapshot
|
SchValidationHolder |
saveAgentDay(int scheduleID,
java.util.List<SchAgentDay> agentDayArray,
boolean ignoreWarnings,
boolean checkTimestamp,
boolean autoCommit)
Saves agent day schedule to database.
|
java.lang.String |
saveAgentDayAsync(int scheduleID,
java.util.List<SchAgentDay> agentDayArray,
boolean ignoreWarnings,
boolean checkTimestamp,
boolean autoCommit)
Saves agent day schedule to database asynchronously.
|
void |
saveScenarioComments(int scheduleID,
java.lang.String comments)
Saves scenario comments
|
void |
saveScenarioWarnings(int scheduleID,
java.util.List<SchScenarioWarning> warnings)
Saves scenario warnings
|
SchValidationHolder |
scheduleMeeting(int scheduleID,
CfgMeeting meeting,
boolean ignoreWarnings,
boolean autoCommit)
Schedules meeting and saves it to the schedule database.
|
java.lang.String |
scheduleMeetingAsync(int scheduleID,
int cfgMeetingID,
double startDate,
double endDate,
boolean ignoreWarnings,
boolean autoCommit)
Schedules meeting and saves it to the schedule database asynchronously.
|
void |
setAgentBids(int scheduleID,
int siteID,
java.util.List<java.lang.Integer> agentIDArray,
java.util.List<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,
java.util.List<SchAgentQuota> agentQuota)
Sets
SchAgentQuota for scenario |
void |
setScenarioForecast(int scheduleID,
int forecastID)
Associates forecast with schedule scenario
|
void |
setScenarioParams(int scheduleID,
java.util.List<SchScenarioParams> params)
Sets scenario parameters
|
void |
setScenarioType(int scheduleID,
int scenarioType)
Sets new scenario type
|
void |
sortAgentDaySnapshot(java.lang.String schSnapshotID,
SchSortMode sortMode)
Sorts schedule snapshot
|
void |
sortScenarioSnapshot(java.lang.String snapshotID,
int sortMode,
boolean ascending)
Sorts scenario snapshot
|
SchValidationHolder |
swapSchedules(int scheduleID,
int siteID,
java.util.List<java.lang.Double> days,
int agentID1,
int agentID2,
boolean ignoreWarnings,
boolean checkTimestamp,
boolean autoCommit)
Swaps schedules of two agents for specified days.
|
SchValidationHolder |
validateAgentDay(int scheduleID,
java.util.List<SchAgentDay> agentDayArray)
Validates schedule
|
SchValidationHolder |
validatePendingAgentDayFromSnapshot(java.lang.String schSnapshotID,
java.util.List<java.lang.Integer> indexArray)
Validates pending schedule from snapshot
|
java.lang.String |
validateScheduleAsync(SchSource source,
int scheduleID,
double startDate,
double endDate,
CfgAgentFilter agentFilter,
CfgActivityFilter activityFilter,
SchStateFilter stateFilter)
Validates the specified range of the schedule.
|
boolean |
wasAgentDaySnapshotModified(java.lang.String schSnapshotID,
int firstAgentIndex,
int lastAgentIndex,
double firstDate,
double lastDate)
Tells whether specified range of schedule in snapshot was modified since snapshot was created or not.
|
SchAgentStateHolder getAgentState(SchSource source, int scheduleID, double startDateTime, double endDateTime, int timezoneId, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, SchStateFilter stateFilter, SchStateDetails schDetails, CfgAgentDetails cfgAgentDetails)
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
SchAgentDayHolder getAgentDay(SchSource source, int scheduleID, double startDate, double endDate, int timezoneId, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, SchStateFilter stateFilter, SchSortMode sortMode, SchAgentDayDetails schDetails, CfgAgentDetails cfgAgentDetails, java.util.List<SchTotalsRequest> totalsRequest)
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
SchSnapshot openAgentDaySnapshot(SchSource source, int scheduleID, double startDate, double endDate, int timezoneId, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, SchStateFilter stateFilter, SchSortMode sortMode, java.util.List<SchTotalsRequest> totalsRequest)
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.lang.String openAgentDaySnapshotAsync(SchSource source, int scheduleID, double startDate, double endDate, int timezoneId, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, SchStateFilter stateFilter, SchSortMode sortMode, java.util.List<SchTotalsRequest> totalsRequest)
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 getAgentDaySnapshotResult(java.lang.String requestID)
requestID
- Async request IDSchSnapshot
void sortAgentDaySnapshot(java.lang.String schSnapshotID, SchSortMode sortMode)
schSnapshotID
- Snapshot IDsortMode
- SchSortMode
SchAgentDayHolder fetchAgentDayFromSnapshot(java.lang.String schSnapshotID, int firstAgentIndex, int lastAgentIndex, double firstDate, double lastDate, SchAgentDayDetails schDetails, CfgAgentDetails cfgAgentDetails, boolean autoRefresh)
openAgentDaySnapshot
The range is either two dimensional (X - Agents, Y - Dates) or single 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
boolean wasAgentDaySnapshotModified(java.lang.String schSnapshotID, int firstAgentIndex, int lastAgentIndex, double firstDate, double lastDate)
schSnapshotID
- Schedule 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)java.util.List<SchActivitySet> getDayActivitySetInfo(int siteID, double date, java.util.List<java.lang.Integer> activityIDArray)
siteID
- date
- activityIDArray
- SchActivitySet
java.util.List<SchActivitySet> getDayActivitySetInfo2(int siteID, double date, java.util.List<java.lang.Integer> schActivities, java.util.List<SchActivitySet> schActivitySetInfo)
siteID
- date
- schActivities
- schActivitySetInfo
- SchActivitySet
java.util.List<SchAgentTotals> getAgentTotals(SchSource source, int scheduleID, CfgAgentFilter agentFilter, java.util.List<SchTotalsRequest> totalsRequest)
source
- Specifies schedule source SchSource
scheduleID
- Schedule (Scenario) identifier. It's zero for Master ScheduleagentFilter
- Agent filter CfgAgentFilter
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.List
<SchAgentTotals
>java.util.List<SchTeamTotals> getTeamTotals(SchSource source, int scheduleID, int siteID, java.util.List<java.lang.Integer> teamIDArray, java.util.List<SchTotalsRequest> totalsRequest)
source
- Specifies schedule source SchSource
scheduleID
- Schedule (Scenario) identifier. It's zero for Master ScheduleteamIDArray
- Specified teamstotalsRequest
- An array of SchTotalsRequest
. Contains a request to provide selected work totals for one or several periods. A NULL value means request no totals.List
<SchTeamTotals
>long readAgentDayDBTimestamp(int scheduleID, int siteID, java.util.List<java.lang.Integer> agentIDArray, double startDate, double endDate)
scheduleID
- siteID
- agentIDArray
- startDate
- endDate
- SchValidationHolder validateAgentDay(int scheduleID, java.util.List<SchAgentDay> agentDayArray)
scheduleID
- Scenario ID (zero for Master)agentDayArray
- Schedule to validateSchValidationHolder
SchValidationHolder saveAgentDay(int scheduleID, java.util.List<SchAgentDay> agentDayArray, boolean ignoreWarnings, boolean checkTimestamp, boolean autoCommit)
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.lang.String saveAgentDayAsync(int scheduleID, java.util.List<SchAgentDay> agentDayArray, boolean ignoreWarnings, boolean checkTimestamp, boolean autoCommit)
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.lang.String insertWorkState(int scheduleID, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, SchStateFilter stateFilter, java.util.List<SchWorkState> states, boolean replaceExistingWorkOnly, boolean ignoreWarnings, boolean allOrNothing, boolean autoCommit)
scheduleID
- Schedule (Scenario) identifier. It's zero for Master ScheduleagentFilter
- Agent filter CfgAgentFilter
activityFilter
- Activity filter CfgActivityFilter
stateFilter
- Schedule state filter SchStateFilter
states
- A list of SchWorkState
to insertreplaceExistingWorkOnly
- Tells whether to replace existing work only or to replace current states and reschedule shift items (like breaks, meals)ignoreWarnings
- if "true" agent day is saved to db even if there were warningsallOrNothing
- Specifies whether operation is atomic or not.autoCommit
- Specifies whether to auto-commit changes are being made or make them "pending".java.lang.String insertAgentDay(int scheduleID, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, SchStateFilter stateFilter, java.util.List<SchAgentDay> agentDayArray, boolean buildAgentDay, boolean ignoreWarnings, boolean allOrNothing, boolean autoCommit)
getRequestValidation
to retrieve results.scheduleID
- Schedule (Scenario) identifier. It's zero for Master ScheduleagentFilter
- Agent filter CfgAgentFilter
activityFilter
- Activity filter CfgActivityFilter
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 operation is atomic or not.autoCommit
- Specifies whether to auto-commit changes are being made or make them "pending".java.lang.String deleteAgentDay(int scheduleID, double startDate, double endDate, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, SchStateFilter stateFilter)
scheduleID
- Schedule (Scenario) identifier. It's zero for Master SchedulestartDate
- Range start dateendDate
- Range end dateagentFilter
- Agent filter CfgAgentFilter
activityFilter
- Activity filter CfgActivityFilter
stateFilter
- Schedule state filter SchStateFilter
SchValidationHolder swapSchedules(int scheduleID, int siteID, java.util.List<java.lang.Double> days, int agentID1, int agentID2, boolean ignoreWarnings, boolean checkTimestamp, boolean autoCommit)
scheduleID
- Schedule (Scenario) identifier. It's zero for Master SchedulesiteID
- Site IDdays
- Days to swapagentID1
- Agent 1agentID2
- Agent 2ignoreWarnings
- If "true" agent day is saved to db even if there were 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".SchValidationHolder
SchCandidateHolder getSwapCandidates(int scheduleID, int siteID, java.util.List<java.lang.Double> days, java.util.List<java.lang.Integer> teamIDArray, java.util.List<java.lang.Integer> agentIDArray, boolean provideAgentInfo)
scheduleID
- Schedule (Scenario) identifier. It's zero for Master SchedulesiteID
- Site IDdays
- Days to swapteamIDArray
- Team listagentIDArray
- Agent ListprovideAgentInfo
- SchValidationHolder
int createScenario(java.lang.String name, double startDate, double endDate, double endDateExt, java.util.List<SchScenarioSite> sites, int type, java.lang.String comments)
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
- Commentsvoid deleteScenario(int scheduleID)
scheduleID
- Scenario to deletevoid setScenarioParams(int scheduleID, java.util.List<SchScenarioParams> params)
scheduleID
- Scenario IDparams
- A list of SchScenarioParams
java.util.List<SchScenarioParams> getScenarioParams(int scheduleID, java.util.List<java.lang.Integer> siteIDs)
scheduleID
- Scenario IDsiteIDs
- A list of Site IDList
<SchScenarioParams
>SchScenarioHolder getScenario(int scheduleID, int infoType, boolean provideUserInfo)
scheduleID
- Scenario IDinfoType
- ESchInfoType
provideUserInfo
- SchScenarioHolder
SchScenarioSnapshot openScenarioSnapshot(int ownership, java.util.List<java.lang.Integer> typeFilter, java.util.List<java.lang.Integer> statusFilter, java.util.List<java.lang.Integer> siteIDFilter, double startDate, double endDate, int sortMode, boolean ascending)
ownership
- ESchScenarioOwnership
typeFilter
- ESchScenarioType
statusFilter
- ESchScenarioStatus
siteIDFilter
- startDate
- endDate
- sortMode
- ascending
- SchScenarioSnapshot
void sortScenarioSnapshot(java.lang.String snapshotID, int sortMode, boolean ascending)
snapshotID
- sortMode
- ESchScenarioSortMode
ascending
- int findScenarioInSnapshot(java.lang.String snapshotID, java.lang.String name, int startIndex)
snapshotID
- Scenario snapshot IDname
- Name to searchstartIndex
- The index to start search fromSchScenarioHolder fetchScenarioFromSnapshot(java.lang.String snapshotID, int firstIndex, int lastIndex, int infoType, boolean provideUserInfo)
snapshotID
- Scenario snapshot IDfirstIndex
- lastIndex
- infoType
- ESchInfoType
provideUserInfo
- SchScenarioHolder
CfgBUHolder getScenarioBU(int scheduleID, CfgBUFilter BUFilter, CfgSortMode sortMode, CfgBUDetails details)
CfgBU
from schedule scenarioscheduleID
- BUFilter
- sortMode
- details
- CfgBUHolder
CfgSiteHolder getScenarioSite(int scheduleID, CfgSiteFilter siteFilter, CfgSortMode sortMode, CfgSiteDetails details)
CfgSite
from schedule scenarioscheduleID
- siteFilter
- sortMode
- details
- CfgSiteHolder
CfgVirtualActivityHolder getScenarioVirtualActivity(int scheduleID, CfgVirtualActivityFilter virtualActivityFilter, CfgAgentFilter agentFilter, CfgProfileFilter profileFilter, CfgSortMode sortMode, CfgVirtualActivityDetails details)
CfgVirtualActivity
from schedule scenariovirtualActivityFilter
- scheduleID
- agentFilter
- profileFilter
- sortMode
- details
- CfgVirtualActivityHolder
CfgActivityHolder getScenarioActivity(int scheduleID, CfgActivityFilter activityFilter, CfgAgentFilter agentFilter, CfgProfileFilter profileFilter, CfgSortMode sortMode, CfgActivityDetails details)
CfgActivity
from schedule scenarioscheduleID
- activityFilter
- agentFilter
- profileFilter
- sortMode
- details
- CfgActivityHolder
CfgTeamHolder getScenarioTeam(int scheduleID, CfgTeamFilter teamFilter, CfgSortMode sortMode, CfgTeamDetails details)
CfgTeam
from schedule scenarioscheduleID
- teamFilter
- sortMode
- details
- CfgTeamHolder
CfgAgentHolder getScheduleAgent(int scheduleID, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, java.util.List<java.lang.Integer> agentTypeFilter, java.util.List<java.lang.Integer> flagFilter, CfgSortMode sortMode, CfgAgentDetails cfgAgentDetails)
CfgAgent
from schedule scenarioscheduleID
- agentFilter
- CfgAgentFilter
activityFilter
- CfgActivityFilter
agentTypeFilter
- ESchAgentType
flagFilter
- ESchDayFlag
sortMode
- CfgSortMode
cfgAgentDetails
- CfgAgentDetails
CfgAgentHolder
CfgSnapshot openScheduleAgentSnapshot(int scheduleID, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, java.util.List<java.lang.Integer> agentTypeFilter, java.util.List<java.lang.Integer> flagFilter, CfgSortMode sortMode)
agentFilter
- CfgAgentFilter
activityFilter
- CfgActivityFilter
agentTypeFilter
- ESchAgentType
flagFilter
- ESchDayFlag
sortMode
- CfgSortMode
CfgSnapshot
void assignProfileAgents(int scheduleID, int siteID, java.util.List<SchAssignment> assignments)
scheduleID
- Scenario IDsiteID
- Site IDassignments
- SchAssignment
.void setScenarioAgentQuota(int scheduleID, int siteID, java.util.List<SchAgentQuota> agentQuota)
SchAgentQuota
for scenarioscheduleID
- siteID
- agentQuota
- A list of SchAgentQuota
java.util.List<SchAgentQuota> getScenarioAgentQuota(int scheduleID, int siteID, java.util.List<java.lang.Integer> agentIDArray)
SchAgentQuota
for scenarioscheduleID
- siteID
- agentIDArray
- List
<SchAgentQuota
>void clearProfileAgentAssignments(int scheduleID, int siteID, java.util.List<java.lang.Integer> profileAgentIDArray)
scheduleID
- Schedule Scenario IDsiteID
- Site IDprofileAgentIDArray
- An array of profile agent IDsSchCandidateHolder getProfileAgentCandidates(int scheduleID, int siteID, java.util.List<java.lang.Integer> profileAgentIDArray, boolean biddingAgentsOnly, boolean provideBids, boolean mergeCandidates, boolean provideAgentInfo)
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.util.List<SchScenarioWarning> getScenarioWarnings(int scheduleID, java.util.List<java.lang.Integer> siteIDs)
scheduleID
- siteIDs
- List
<SchScenarioWarning
>void saveScenarioWarnings(int scheduleID, java.util.List<SchScenarioWarning> warnings)
scheduleID
- warnings
- A list of SchScenarioWarning
void saveScenarioComments(int scheduleID, java.lang.String comments)
scheduleID
- comments
- void renameScenario(int scheduleID, java.lang.String name)
scheduleID
- name
- void deleteAgentFromScenario(int scheduleID, int siteID, java.util.List<java.lang.Integer> agentIDArray)
scheduleID
- siteID
- agentIDArray
- void addAgentToScenario(int scheduleID, int siteID, java.util.List<SchScenarioAgent> agentArray)
siteID
- scheduleID
- agentArray
- A list of SchScenarioAgent
void addActivityToScenario(int scheduleID, int siteID, java.util.List<java.lang.Integer> activityIDArray)
siteID
- scheduleID
- activityIDArray
- void setScenarioType(int scheduleID, int scenarioType)
scheduleID
- scenarioType
- ESchScenarioType
void setScenarioForecast(int scheduleID, int forecastID)
scheduleID
- forecastID
- int getScenarioForecast(int scheduleID)
scheduleID
- long readScenarioDBTimestamp(int scheduleID)
scheduleID
- java.lang.String publishSchedule(java.util.List<SchSiteAgents> siteAgents, int sourceScheduleID, double sourceStartDate, double sourceEndDate, int targetScheduleID, double targetStartDate, double targetEndDate, boolean applyCalendarItems)
getRequestValidation
to retrieve the results.siteAgents
- Specifies which agent schedules to publish List
<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.lang.String insertAgentState(int scheduleID, java.util.List<SchAgentState> states, boolean ignoreWarnings, boolean allOrNothing, boolean autoCommit)
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.lang.String insertState(int scheduleID, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, SchStateFilter stateFilter, java.util.List<SchState> states, int timezoneId, boolean ignoreWarnings, boolean allOrNothing, boolean autoCommit)
getRequestValidation
to retrieve results.scheduleID
- Schedule (Scenario) identifier. It's zero for Master ScheduleagentFilter
- Agent filter CfgAgentFilter
activityFilter
- Agent filter CfgActivityFilter
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.lang.String deleteState(int scheduleID, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, SchStateFilter stateFilter, java.util.List<SchState> states, int timezoneId, boolean ignoreWarnings, boolean allOrNothing, boolean autoCommit)
getRequestValidation
to retrieve results.scheduleID
- Schedule (Scenario) identifier (zero for Master Schedule)agentFilter
- Agent filter CfgAgentFilter
activityFilter
- Agent filter CfgActivityFilter
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".SchValidationHolder getRequestValidation(java.lang.String requestID)
requestID
- Asynchronous request IDSchValidationHolder
java.util.List<SchPlanningPeriod> getPlanningPeriod(int scheduleID, int siteID, double startDate, double endDate)
scheduleID
- siteID
- startDate
- endDate
- List
<SchPlanningPeriod
>java.lang.String commitPendingAgentDay(int scheduleID, java.util.List<java.lang.Double> days, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, SchStateFilter stateFilter)
scheduleID
- days
- agentFilter
- activityFilter
- stateFilter
- java.lang.String rollbackPendingAgentDay(int scheduleID, java.util.List<java.lang.Double> days, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, SchStateFilter stateFilter)
days
- agentFilter
- activityFilter
- scheduleID
- stateFilter
- SchValidationHolder validatePendingAgentDayFromSnapshot(java.lang.String schSnapshotID, java.util.List<java.lang.Integer> indexArray)
schSnapshotID
- indexArray
- SchValidationHolder
java.lang.String commitPendingAgentDayFromSnapshot(java.lang.String schSnapshotID, java.util.List<java.lang.Integer> indexArray)
schSnapshotID
- indexArray
- java.lang.String rollbackPendingAgentDayFromSnapshot(java.lang.String schSnapshotID, java.util.List<java.lang.Integer> indexArray)
schSnapshotID
- indexArray
- SchNotification pollNotification(long timestamp, int siteID, java.util.List<java.lang.Integer> teamIDArray, java.util.List<java.lang.Integer> agentIDArray, double schStartDate, double schEndDate, int detailsLevel, SchAgentDayDetails schDetails, CfgAgentDetails cfgAgentDetails)
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
void acknowledgeNotification(int siteID, long timestamp)
pollNotification
.siteID
- Site IDtimestamp
- A timestamp value from SchNotification
returned by pollNotification
java.lang.String getAuditLogAsync(int siteID, java.util.List<java.lang.Integer> teamIDArray, java.util.List<java.lang.Integer> agentIDArray, double schStartDate, double schEndDate, double actionStartDateTime, double actionEndDateTime, java.util.List<java.lang.Integer> actionTypes, java.util.List<java.lang.Integer> actionUsers, int detailsLevel, SchAgentDayDetails schDetails)
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
SchAuditLog getAuditLogResults(java.lang.String requestID, SchAgentDayDetails schDetails, CfgAgentDetails cfgAgentDetails, boolean provideScenarioInfo, boolean provideUserInfo)
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
SchAuditLog getAuditLogByID(long auditID, int siteID, java.util.List<java.lang.Integer> teamIDArray, java.util.List<java.lang.Integer> agentIDArray, double schStartDate, double schEndDate, int detailsLevel, SchAgentDayDetails schDetails, CfgAgentDetails cfgAgentDetails, boolean provideScenarioInfo, boolean provideUserInfo)
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
long rollbackAuditTransaction(long auditID, int siteID, java.util.List<java.lang.Integer> teamIDArray, java.util.List<java.lang.Integer> agentIDArray, double schStartDate, double schEndDate)
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
SchAgentDayHolder buildAgentDayInSnapshot(java.lang.String schSnapshotID, java.util.List<SchAgentDay> newSchedule, java.util.List<SchAgentDay> modifiedSchedule, SchAgentDayDetails schDetails)
schSnapshotID
- Schedule Snapshot IDnewSchedule
- Schedule shifts that need to be builtmodifiedSchedule
- Other modified, but not saved agent daysschDetails
- SchAgentDayDetails
SchAgentDayHolder
SchAgentDayHolder buildAgentDay(int scheduleID, int siteID, java.util.List<SchAgentDay> newSchedule, SchAgentDayDetails schDetails)
scheduleID
- Schedule IDsiteID
- Site IDnewSchedule
- Schedule shifts that need to be builtschDetails
- SchAgentDayDetails
SchAgentDayHolder
SchValidationHolder scheduleMeeting(int scheduleID, CfgMeeting meeting, boolean ignoreWarnings, boolean autoCommit)
scheduleID
- Scenario ID (0 value stands for Master Schedule)meeting
- 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.lang.String scheduleMeetingAsync(int scheduleID, int cfgMeetingID, double startDate, double endDate, boolean ignoreWarnings, boolean autoCommit)
getRequestValidation
to retrieve results.scheduleID
- Scenario ID (0 value stands for Master Schedule)cfgMeetingID
- Meeting IDstartDate
- Schedule range startendDate
- Schedule range endignoreWarnings
- 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".void setBiddingParams(int scheduleID, int siteID, SchBiddingParams params)
scheduleID
- Scenario IDsiteID
- Site IDparams
- SchBiddingParams
SchBiddingParams getBiddingParams(int scheduleID, int siteID)
scheduleID
- Scenario IDsiteID
- Site IDSchBiddingParams
java.lang.String autoAssignProfileAgents(int scheduleID, int siteID, int rankingSystem, boolean biddingAgentsOnly)
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.util.List<SchScenarioAgent> getScenarioAgentInfo(int scheduleID, CfgAgentFilter agentFilter)
SchScenarioAgent
scheduleID
- Scenario IDagentFilter
- CfgAgentFilter
List
<SchScenarioAgent
>void setAgentBids(int scheduleID, int siteID, java.util.List<java.lang.Integer> agentIDArray, java.util.List<SchBid> bids)
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.util.List<SchBid> getAgentBids(int scheduleID, int siteID, java.util.List<java.lang.Integer> agentIDArray)
scheduleID
- Scenario IDsiteID
- Site IDagentIDArray
- An array of agent IDs whose bids are to be returned.List
<SchBid
>java.lang.String validateScheduleAsync(SchSource source, int scheduleID, double startDate, double endDate, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, SchStateFilter stateFilter)
getRequestValidation
to retrieve the results.source
- Specifies schedule source ESchSource
scheduleID
- Scenario IDstartDate
- Schedule range start date. OleDateTime
endDate
- Schedule range end date. OleDateTime
agentFilter
- Agent filter CfgAgentFilter
activityFilter
- Activity filter CfgActivityFilter
stateFilter
- Schedule state filter SchStateFilter
java.lang.String applyCalendarItemsAsync(int scheduleID, double startDate, double endDate, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, SchStateFilter stateFilter, boolean autoCommit)
getRequestValidation
to retrieve the results.scheduleID
- Schedule Scenario IDstartDate
- Schedule range start date. OleDateTime
endDate
- Schedule range end date. OleDateTime
agentFilter
- Agent filter CfgAgentFilter
activityFilter
- Activity filter CfgActivityFilter
stateFilter
- Schedule state filter SchStateFilter
autoCommit
- Specifies whether to auto-commit the changes that are being made, or make them "pending".SchStateGroupCoverageHolder getStateGroupCoverage(SchSource source, int scheduleID, double startDate, double endDate, int timezoneId, CfgAgentFilter agentFilter, CfgActivityFilter activityFilter, SchStateFilter stateFilter, CfgStateGroupFilter stateGroupFilter, int granularity)
source
- Specifies schedule source ESchSource
scheduleID
- Schedule (Scenario) identifier (zero for the Master Schedule)startDate
- Period start date OleDateTime
endDate
- Period end date OleDateTime
timezoneId
- Time zone ID (can be zero)agentFilter
- Agent filter CfgAgentFilter
activityFilter
- Activity filter CfgActivityFilter
stateFilter
- Schedule state filter SchStateFilter
stateGroupFilter
- State group filter CfgStateGroupFilter
granularity
- The granularity of the returned coverage ESchGranularity
SchStateGroupCoverageHolder
SchStateGroupCoverageHolder getStateGroupCoverageFromSnapshot(java.lang.String schSnapshotID, CfgStateGroupFilter stateGroupFilter, int granularity, java.util.List<SchAgentDay> modifiedSchedule)
schSnapshotID
- Schedule snapshot IDstateGroupFilter
- State Group filtergranularity
- The granularity of the returned coverage ESchGranularity
modifiedSchedule
- An array of agent schedule days that are not saved yetSchStateGroupCoverageHolder
void assignProfileTeams(int scheduleID, int siteID, java.util.List<SchTeamAssignment> assignments)
scheduleID
- Schedule scenario IDsiteID
- Site IDassignments
- List
<SchTeamAssignment
>void clearProfileTeamAssignments(int scheduleID, int siteID, java.util.List<java.lang.Integer> teamIDArray)
scheduleID
- Schedule scenario IDsiteID
- Site IDteamIDArray
- An array of real team IDs.Copyright © 2005-2016 Genesys Telecommunications Labs, Inc. All Rights Reserved.