public interface WFMForecastService750Soap
extends java.rmi.Remote
Modifier and Type | Method and Description |
---|---|
void |
addScenarioActivity(int scenarioId,
FrcActivity[] activities)
Adds scenario Activities.
|
void |
addTemplateActivities(int templateId,
FrcActivity[] activities)
Method modifies existing template and adds specified Activities.
|
java.lang.String |
adjustForecastInformation(int scenarioId,
int[] bUIDArray,
int[] siteIDArray,
FrcActivity[] activities,
int[] types,
double start,
double end,
double percentage)
Adjust forecast data values for requested target by given percentage.
|
java.lang.String |
asyncGetForecastInformation(int scenarioID,
int target,
int targetID,
int[] types,
double start,
double end,
int branchSelection,
int[] granularities,
int request)
Starts an asynchronous request for forecast information for the specified period and specified target.
|
java.lang.String |
asyncSplitPredictedData(int scenarioId,
FrcActivity[] sourceActivity,
FrcActivity[] targetActivities,
double start,
double end,
boolean keepAHT,
boolean useAllActivities,
boolean frcSaveSplitResults,
boolean considerPlannedItems)
Method takes specified source Multi-site Activities Interaction Volume (and Average Handle Time, if the parameter is specified) data and splits using [splitting] algorithm between specified Activities for the specified date range.
|
java.lang.String |
buildPredictedDataBasedOnConstant(int scenarioId,
FrcActivity[] activities,
int[] types,
double start,
double end,
double growthRate,
double IVValue,
double AHTValue,
boolean frcSaveBuildResults)
Method takes specified value and fills in all periods in the specified date range for the requested data types.
|
java.lang.String |
buildPredictedDataBasedOnHistory(int scenarioId,
FrcActivity[] activities,
int[] types,
double start,
double end,
double historyStart,
double historyEnd,
double growthRate,
FrcTemplateData[] overrideData,
boolean frcSaveBuildResults)
Method takes specified values (historical data or data overridden by specified values) and fills in corresponding periods (template values or provided specific dates) in specified date range for the requested data types.
|
java.lang.String |
buildPredictedDataBasedOnTemplate(int scenarioId,
FrcActivity[] activities,
int[] types,
double start,
double end,
double growthRate,
FrcTemplateData[] templateData,
boolean frcSaveBuildResults)
Method takes specified values (usually a combination of values from templates) and fills in corresponding periods (template values are provided for weekdays, not specific dates) in the specified date range for requested data types.
|
java.lang.String |
buildPredictedDataUseMethod(int scenarioId,
FrcActivity[] activities,
int[] types,
double start,
double end,
int method,
double historyStart,
double historyEnd,
double growthRate,
FrcTemplateData[] data,
FrcActivityEvents[] events,
boolean frcSaveBuildResults,
boolean useAllEvents)
Method takes the specified parameters and uses a method from the WFM Prediction Library to create data in the specified date range for the requested data types.
|
java.lang.String |
calculateStaffingRequirementData(int scenarioId,
FrcActivity[] targetActivities,
int[] types,
double start,
double end,
int method,
FrcActivityPeriodParameters[] periodParameters,
FrcActivityStaffingDataParameters[] parameters,
FrcActivityStaffingDataObjectives[] objectives,
FrcActivityTemplateData[] templateData,
boolean frcSaveBuildResults)
Method takes Activity parameters according to method used to calculate data in the specified date range for requested data types, and saves data for the specified scenario and return request identifier (asynchronous).
|
int |
createScenario(java.lang.String name,
java.lang.String comments,
int type,
FrcActivity[] activities,
double start,
double end)
Gets attributes (name, type etc.), specified Activities, requested period (start and end), and saves to the new scenario.
|
int |
createTemplate(int type,
java.lang.String name,
int parentType,
int parentId,
double start,
double end,
FrcActivity[] activities,
double initialValue,
int basedOnTemplate)
Creates new template under "parent".
|
void |
deleteForecastInformation(int scenarioId,
FrcActivity[] activities,
double start,
double end)
Deletes specified scenario Activities information for requested date range.
|
void |
deleteScenario(int scenarioId)
Deletes specified scenario information and related Activities information.
|
void |
deleteScenarioActivity(int scenarioId,
FrcActivity[] activities)
Deletes scenario Activities.
|
void |
deleteTemplate(int[] templates)
Deletes all specified templates.
|
void |
deleteTemplateActivities(int templateId,
FrcActivity[] activities)
Modifies existing template and removes specified Activities.
|
int |
findScenarioInSnapshot(java.lang.String snapshotId,
java.lang.String name,
int startIndex)
Allows locatation of a specific forecast scenario inside the existing snapshot.
|
FrcActivityFactors[] |
getActivityFactors(FrcActivity[] activities,
double start,
double end)
Returns array of factors and events assigned to Activity(ies) for the specified period.
|
FrcActivityFactors[] |
getActivityFactorsEx(FrcActivity[] activities,
double start,
double end)
Returns array of factors and events assigned to all specified Activity(ies) for specified period.
|
FrcActivityHistoricalInformationIndicators[] |
getActivityHistoricalInformationIndicators(FrcActivity[] activities,
int[] types,
double start,
double end,
int request)
Returns historical data indicators for requested Activities and historical data date ranges for specified period.
|
FrcTargetForecastInformation[] |
getAsyncRequestForecastInformation(java.lang.String asyncRequestID)
Gets an asynchronous request result of forecast information for the specified period and specified target.
|
FrcActivityEvents[] |
getForecastActivityEvents(int scenarioId,
FrcActivity[] activities,
double start,
double end)
Returns forecast Activity events for specified period.
|
FrcActivityEvents[] |
getForecastActivityEventsEx(int scenarioId,
FrcActivity[] activities,
double start,
double end)
Returns forecast events for the specified period which is associated with all specified Activities.
|
FrcActivityBuildSelection |
getForecastActivityPredictionBuildSelection(int scenarioID,
int target,
int targetID)
Method returns the user selection made for the last predicted data build for the selected target (Activity or Multi-site Activity) in the scenario.
|
FrcActivityBuildSelection |
getForecastActivityStaffingBuildSelection(int scenarioID,
int target,
int targetID)
Method returns the user selection made for the last staffing requirements build for the selected target (Activity or Multi-site Activity) in the scenario.
|
FrcTargetForecastInformation[] |
getForecastInformation(int scenarioId,
int target,
int targetId,
int[] types,
double start,
double end,
int timeZone,
int branchSelection,
int granularity,
int request)
Returns requested forecast information for specified period and specified target.
|
FrcActivityDataIndicator[] |
getForecastInformationIndicators(int scenarioId,
double start,
double end,
FrcActivity[] activities)
Returns data indicators for requested scenario Activities and date period, if specified
|
FrcTargetForecastInformation[] |
getForecastRequestActivityData(java.lang.String requestID,
int activityID,
int[] types,
double start,
double end,
int granularity)
Method returns forecast results for the specified Activity, if request completed.
|
FrcSplitResult[] |
getForecastSplitResult(java.lang.String asyncRequestID)
Method returns forecast data split result for the request (requested/split data).
|
SFrcSplitResult[] |
getForecastSplitResults(java.lang.String asyncRequestID)
Deprecated.
|
FrcActivityEventsEx[] |
getForecastTargetEvents(int scenarioId,
int target,
int targetId,
double start,
double end)
Returns forecast events for the specified period which is associated with the specified target.
|
FrcTargetForecastInformation[] |
getHistoricalInformation(int target,
int targetId,
int[] types,
double start,
double end,
int granularity)
Returns historical data for specified period and specified Activities.
|
FrcHistoricalShortInformation |
getHistoricalShortInformation()
Returns basic historical data (start/end, Activities).
|
FrcScenarioInformation[] |
getScenario(int scenarioId)
Retrieves a scenario by means of an identifier.
|
CfgActivityShort[] |
getScenarioActivityConfiguration(int scenarioId,
int[] sites,
int sortMode,
boolean sortAscending)
Get forecast scenario Activity configuration information.
|
CfgBUShort[] |
getScenarioBUConfiguration(int scenarioId,
int sortMode,
boolean sortAscending)
Get forecast scenario Business Unit configuration information.
|
FrcScenarioInformation[] |
getScenarioFromSnapshot(java.lang.String snapshotId,
int first,
int last)
Retrieves the specified number of scenarios from the existing snapshot.
|
CfgSiteShort[] |
getScenarioSiteConfiguration(int scenarioId,
int[] bUnits,
int sortMode,
boolean sortAscending)
Get forecast scenario Site configuration information.
|
CfgActivityShort[] |
getScenarioToVirtualAssignedActivityConfiguration(int scenarioId,
int[] virtualActivities,
int sortMode,
boolean sortAscending)
Get forecast scenario Activity associated with specified Multi-site Activity(ies) configuration information.
|
CfgVirtualActivityShort[] |
getScenarioVirtualActivityConfiguration(int scenarioId,
int[] bUnits,
int sortMode,
boolean sortAscending)
Get forecast scenario Virtual Activity configuration information.
|
FrcSiteFactors |
getSiteFactors(int siteId,
double start,
double end)
Returns array of Site factors and events for specified period.
|
FrcTemplate |
getTemplate(int templateId,
int request)
Returns template's header, activities, and data values.
|
FrcActivity[] |
getTemplateActivities(int templateId)
Returns all template's Activities.
|
FrcData[] |
getTemplateData(int templateId)
Returns template's data values.
|
FrcTemplateHeader[] |
getTemplatesList(int[] BUs,
int[] sites,
int[] types)
Returns all templates for the specified target.
|
FrcTemplateHeader[] |
getTemplatesListEx(int[] BUs,
int[] sites,
int[] types,
FrcActivity[] activities)
Returns templates associated with specified Activities.
|
FrcScenarioSnapshot |
openScenarioSnapshot(int ownership,
int[] types,
int[] statuses,
double start,
double end,
int sortMode,
boolean sortAscending)
Opens a snapshot of forecast scenarios based on specified filtering parameters.
|
java.lang.String |
publishForecast(FrcActivity[] activities,
int sourceScenarioId,
double sourceStartDate,
double sourceEndDate,
int targetScenarioId,
double targetStartDate,
double targetEndDate)
Publishes requested Activity forecast information from the forecast scenario to the master forecast, or from the master to the forecast scenario, or from one forecast scenario to another forecast scenario.
|
long |
readScenarioDBTimestamp(int scenarioId)
Retrieves the scenario timestamp.
|
java.lang.String |
saveForecastRequestData(java.lang.String asyncRequestToSaveID)
Method should be used to save results of forecast build request.
|
int |
saveHistoricalDataAsTemplate(int type,
java.lang.String name,
int parentType,
int parentId,
double start,
double end,
FrcActivity[] activities,
FrcActivity[] sourceActivities)
Saves historical Interaction Volume or Average Handle Time data as template.
|
int |
saveStaffingDataAsTemplate(java.lang.String name,
int parentType,
int parentId,
double start,
double end,
FrcActivity[] activities,
int sourceScenarioId,
FrcActivity[] sourceActivities)
Saves specified scenario Activities Staffing requirements as template for requested Activities.
|
java.lang.String |
setForecastInformation(int scenarioId,
FrcActivityForecastInformation[] information)
Updates scenario Activity information.
|
void |
setScenarioComments(int scenarioId,
java.lang.String comments)
Updates/sets scenario comments.
|
void |
setScenarioName(int scenarioId,
java.lang.String name)
Updates scenario name.
|
void |
setScenarioType(int scenarioId,
int type)
Updates scenario type.
|
void |
setTemplateData(int templateId,
FrcData[] data)
Modifies existing template and sets specified values for periods.
|
void |
setTemplateName(int templateId,
java.lang.String name)
Modifies existing template's name.
|
void |
sortScenarioSnapshot(java.lang.String snapshotId,
int sortMode,
boolean sortAscending)
Allows a change to the sort order for the existing scenario snapshot.
|
java.lang.String |
splitPredictedData(int scenarioId,
FrcActivity[] sourceActivity,
FrcActivity[] targetActivities,
double start,
double end,
boolean keepAHT,
boolean useAllActivities,
boolean frcSaveSplitResults)
Method takes specified source Multi-site Activities Interaction Volume (and Average Handle Time, if the parameter is specified) data and splits using [splitting] algorithm between specified Activities for the specified date range.
|
java.lang.String |
splitStaffingDataAsync(int scenarioId,
FrcActivity[] sourceActivity,
FrcActivity[] targetActivities,
double start,
double end,
FrcActivityPeriodParameters[] periodParameters,
FrcActivityStaffingDataParameters[] parameters,
boolean splitRequired,
boolean useAHT,
boolean useAllActivities,
boolean frcSaveSplitResults)
Method takes specified source Multi-site Activities Calculated Staffing requirements (and Required if the parameter is specified) data and splits using [splitting] algorithm between specified Activities for the specified date range.
|
FrcScenarioInformation[] getScenario(int scenarioId) throws java.rmi.RemoteException
scenarioId
- Forecast scenario identifierjava.rmi.RemoteException
long readScenarioDBTimestamp(int scenarioId) throws java.rmi.RemoteException
scenarioId
- Forecast scenario identifierjava.rmi.RemoteException
FrcScenarioSnapshot openScenarioSnapshot(int ownership, int[] types, int[] statuses, double start, double end, int sortMode, boolean sortAscending) throws java.rmi.RemoteException
ownership
- Allows specification of which scenarios to retrieve based on ownershiptypes
- Defines type filter. Empty means "all types".statuses
- Defines status filter: private/shared. Empty means "all statuses".start
- Scenarios should fall (at least partially) within a defined date range. Null means the date range is not defined.end
- Date range end. Null means date range is not defined.sortMode
- Scenario sort modesortAscending
- Ascending/descendingjava.rmi.RemoteException
FrcScenarioInformation[] getScenarioFromSnapshot(java.lang.String snapshotId, int first, int last) throws java.rmi.RemoteException
snapshotId
- Forecast scenario snapshot identifierfirst
- Index of first requested scenario in the snapshotlast
- Index of last requested scenario in the snapshotjava.rmi.RemoteException
void sortScenarioSnapshot(java.lang.String snapshotId, int sortMode, boolean sortAscending) throws java.rmi.RemoteException
snapshotId
- Forecast scenario snapshot identifiersortMode
- Scenario sort modesortAscending
- Ascending/descendingjava.rmi.RemoteException
int findScenarioInSnapshot(java.lang.String snapshotId, java.lang.String name, int startIndex) throws java.rmi.RemoteException
snapshotId
- Forecast scenario snapshot IDname
- A name or partial name of a scenario to locate in the snapshotstartIndex
- The starting index of the scenario from which to start the searchjava.rmi.RemoteException
CfgBUShort[] getScenarioBUConfiguration(int scenarioId, int sortMode, boolean sortAscending) throws java.rmi.RemoteException
scenarioId
- Scenario identifier, 0 - for mastersortMode
- Sort modesortAscending
- Ascending/descendingjava.rmi.RemoteException
ECfgSortMode.BU
,
CfgBUShort
CfgSiteShort[] getScenarioSiteConfiguration(int scenarioId, int[] bUnits, int sortMode, boolean sortAscending) throws java.rmi.RemoteException
scenarioId
- Scenario identifier, 0 - for masterbUnits
- Site filter by parent: empty - all Sites; 0 - Sites without parent BU.sortMode
- Sort modesortAscending
- Ascending/descendingjava.rmi.RemoteException
ECfgSortMode.Site
,
CfgSiteShort
CfgActivityShort[] getScenarioToVirtualAssignedActivityConfiguration(int scenarioId, int[] virtualActivities, int sortMode, boolean sortAscending) throws java.rmi.RemoteException
scenarioId
- Scenario identifiervirtualActivities
- Multi-site ActivitiessortMode
- Sort modesortAscending
- Ascending/descendingjava.rmi.RemoteException
ECfgSortMode.Activity
,
CfgActivityShort
CfgVirtualActivityShort[] getScenarioVirtualActivityConfiguration(int scenarioId, int[] bUnits, int sortMode, boolean sortAscending) throws java.rmi.RemoteException
scenarioId
- Scenario identifier, 0 - for masterbUnits
- Virtual Activity filter by parent, empty - all Virtual Activities.sortMode
- Sort modesortAscending
- Ascending/descendingjava.rmi.RemoteException
ECfgSortMode.VirtualActivity
,
CfgVirtualActivityShort
CfgActivityShort[] getScenarioActivityConfiguration(int scenarioId, int[] sites, int sortMode, boolean sortAscending) throws java.rmi.RemoteException
scenarioId
- Scenario identifier, 0 - for mastersites
- Activity filter by parent, empty - all Activities.sortMode
- Sort modesortAscending
- Ascending/descendingjava.rmi.RemoteException
ECfgSortMode.Activity
,
CfgActivityShort
FrcActivityDataIndicator[] getForecastInformationIndicators(int scenarioId, double start, double end, FrcActivity[] activities) throws java.rmi.RemoteException
scenarioId
- Scenario identifier, 0 - for masterstart
- Requested start date, null - all scenario periodend
- Requested end date, null - all scenario periodactivities
- Activities filter, empty - all activitiesjava.rmi.RemoteException
FrcTargetForecastInformation[] getForecastInformation(int scenarioId, int target, int targetId, int[] types, double start, double end, int timeZone, int branchSelection, int granularity, int request) throws java.rmi.RemoteException
scenarioId
- Scenario identifier, 0 - for mastertarget
- Target leveltargetId
- Target identifiertypes
- Array of required data typesstart
- Requested start dateend
- Requested end datetimeZone
- Indicates use of time zones, 0 - ignore time zonesbranchSelection
- Indicator specifies how target Activities must be selected: 0 - (default) Site branch; 1 - Multi-site Activity branch.granularity
- Requested granularity period, in minutes. Period data is aggregated from the start to the end using the given granularity. Meaningful values:
0 - total for the whole period;
15 min (time step);
1440 (1 day);
10080 (1 week);
60480 (max long period - 6 weeks).
Monthly aggregation performed on calendar-month basis (special value is -1), e.g. start Jun 15, 2003, and end Jul 15, 2003, aggregates as 2 values for the periods Jun 15, 2003 - Jun 30, 2003 and Jul 1, 2003 - Jul 15, 2003.
Special values:
0 - for total value;
-1 - calendar month;
-10 - calendar week starts Sunday;
-11 - calendar week starts Mon.;
-12 - calendar week starts Tue.;
-13 - calendar week starts Wed.;
-14 - calendar week starts Thu.;
-15 - calendar week starts Fri.;
-16 - calendar week starts Sat.request
- Requested information flag:
0 - all information;
1 - forecast data only;
2 - parameters only;
4 - objectives only;
8 - period parameters only;
16 - data comments.
Request is a bit mask and can specify more than one information request, e.g. 5 = forecast data and objectives.java.rmi.RemoteException
java.lang.String asyncGetForecastInformation(int scenarioID, int target, int targetID, int[] types, double start, double end, int branchSelection, int[] granularities, int request) throws java.rmi.RemoteException
scenarioID
- Scenario identifier, 0 - for mastertarget
- Target leveltargetID
- Target identifiertypes
- Array of required data typesstart
- Requested start dateend
- Requested end datebranchSelection
- Indicator specifies how target Activities must be selected: 0 - (default) Site branch; 1 - Multi-site Activity branch.granularities
- Requested granularity period, in minutes. Period data aggregated from the start to the end using the given granularity. Meaningful values:
0 - total for the whole period;
15 min (time step);
1440 (1 day);
10080 (1 week);
60480 (max long period - 6 weeks).
Monthly aggregation performed on calendar-month basis (special value is -1), e.g. start Jun 15, 2003, and end Jul 15, 2003, aggregates as 2 values for periods Jun 15, 2003 - Jun 30, 2003, and Jul 1, 2003 - Jul 15, 2003.
Special values:
0 - for total value;
-1 - calendar month;
-10 - calendar week starts Sunday;
-11 - calendar week starts Mon.;
-12 - calendar week starts Tue.;
-13 - calendar week starts Wed.;
-14 - calendar week starts Thu.;
-15 - calendar week starts Fri.;
-16 - calendar week starts Sat.request
- Requested information flag:
0 - all information;
1 - forecast data only;
2 - parameters only;
4 - objectives only;
8 - period parameters only;
16 - data comments.
Request is a bit mask and can specify more than one information request, e.g. 5 = forecast data and objectives.java.rmi.RemoteException
FrcTargetForecastInformation[] getAsyncRequestForecastInformation(java.lang.String asyncRequestID) throws java.rmi.RemoteException
asyncRequestID
- Asynchronous request identifierjava.rmi.RemoteException
SFrcSplitResult[] getForecastSplitResults(java.lang.String asyncRequestID) throws java.rmi.RemoteException
asyncRequestID
- Request identifierjava.rmi.RemoteException
FrcSplitResult[] getForecastSplitResult(java.lang.String asyncRequestID) throws java.rmi.RemoteException
asyncRequestID
- Request identifierjava.rmi.RemoteException
int createScenario(java.lang.String name, java.lang.String comments, int type, FrcActivity[] activities, double start, double end) throws java.rmi.RemoteException
name
- Created scenario namecomments
- Scenario commentstype
- Selected type of scenario (private/shared)activities
- Activities to be associated with the scenario. Scenario can be empty, without Activities.start
- Requested start dateend
- Requested end datejava.rmi.RemoteException
void setScenarioComments(int scenarioId, java.lang.String comments) throws java.rmi.RemoteException
scenarioId
- Scenario identifier, 0 - for mastercomments
- Contains requested updatejava.rmi.RemoteException
void setScenarioName(int scenarioId, java.lang.String name) throws java.rmi.RemoteException
scenarioId
- Scenario identifier, 0 - for mastername
- Contains requested updatejava.rmi.RemoteException
void setScenarioType(int scenarioId, int type) throws java.rmi.RemoteException
scenarioId
- Scenario identifier, 0 - for mastertype
- Contains requested updatejava.rmi.RemoteException
void addScenarioActivity(int scenarioId, FrcActivity[] activities) throws java.rmi.RemoteException
scenarioId
- Scenario identifier, 0 - for masteractivities
- Contains requested updatejava.rmi.RemoteException
void deleteScenarioActivity(int scenarioId, FrcActivity[] activities) throws java.rmi.RemoteException
scenarioId
- Scenario identifieractivities
- Contains requested updatejava.rmi.RemoteException
java.lang.String setForecastInformation(int scenarioId, FrcActivityForecastInformation[] information) throws java.rmi.RemoteException
scenarioId
- Scenario identifier, 0 - for masterinformation
- Contains updated information values related to the scenariojava.rmi.RemoteException
java.lang.String adjustForecastInformation(int scenarioId, int[] bUIDArray, int[] siteIDArray, FrcActivity[] activities, int[] types, double start, double end, double percentage) throws java.rmi.RemoteException
scenarioId
- Scenario identifier, 0 - for masterbUIDArray
- Array of Business Unit IDssiteIDArray
- Array of Site IDsactivities
- Array of forecast Activitiestypes
- Array of required data typesstart
- Date range startend
- Date range endpercentage
- Data change percentage: 0-99% is a decreased value, 100% no change, and 101+% is an increased value.java.rmi.RemoteException
void deleteScenario(int scenarioId) throws java.rmi.RemoteException
scenarioId
- Scenario identifierjava.rmi.RemoteException
void deleteForecastInformation(int scenarioId, FrcActivity[] activities, double start, double end) throws java.rmi.RemoteException
scenarioId
- Scenario identifieractivities
- Involved scenario's Activitiesstart
- Date range startend
- Date range endjava.rmi.RemoteException
java.lang.String publishForecast(FrcActivity[] activities, int sourceScenarioId, double sourceStartDate, double sourceEndDate, int targetScenarioId, double targetStartDate, double targetEndDate) throws java.rmi.RemoteException
activities
- Source scenario's Activities. If empty - means all source Activities.sourceScenarioId
- ID of the source forecast. 0 - for Master.sourceStartDate
- Source date range startsourceEndDate
- Source date range endtargetScenarioId
- ID of the target forecast. 0 - for Master.targetStartDate
- Target date range starttargetEndDate
- Target date range endjava.rmi.RemoteException
FrcSiteFactors getSiteFactors(int siteId, double start, double end) throws java.rmi.RemoteException
siteId
- Site identifierstart
- Period start date, null means all site factors.end
- Period end date, null means all site factors.java.rmi.RemoteException
FrcActivityFactors[] getActivityFactors(FrcActivity[] activities, double start, double end) throws java.rmi.RemoteException
activities
- Activity informationstart
- Period start date, null means all factors.end
- Period end date, null means all factors.java.rmi.RemoteException
FrcActivityFactors[] getActivityFactorsEx(FrcActivity[] activities, double start, double end) throws java.rmi.RemoteException
activities
- Activity informationstart
- Period start date, null means all factors.end
- Period end date, null means all factors.java.rmi.RemoteException
FrcActivityEvents[] getForecastActivityEvents(int scenarioId, FrcActivity[] activities, double start, double end) throws java.rmi.RemoteException
scenarioId
- Scenario's identifieractivities
- Activities arraystart
- Requested start dateend
- Requested end datejava.rmi.RemoteException
FrcActivityEvents[] getForecastActivityEventsEx(int scenarioId, FrcActivity[] activities, double start, double end) throws java.rmi.RemoteException
scenarioId
- Scenario's identifieractivities
- Activities arraystart
- Requested start dateend
- Requested end datejava.rmi.RemoteException
FrcActivityEventsEx[] getForecastTargetEvents(int scenarioId, int target, int targetId, double start, double end) throws java.rmi.RemoteException
scenarioId
- Scenario's identifiertarget
- Target leveltargetId
- Target identifierstart
- Requested start dateend
- Requested end datejava.rmi.RemoteException
java.lang.String buildPredictedDataUseMethod(int scenarioId, FrcActivity[] activities, int[] types, double start, double end, int method, double historyStart, double historyEnd, double growthRate, FrcTemplateData[] data, FrcActivityEvents[] events, boolean frcSaveBuildResults, boolean useAllEvents) throws java.rmi.RemoteException
scenarioId
- Scenario identifieractivities
- Scenario Activities data to be builttypes
- Array of required data types (IV and AHT supported)start
- Requested start dateend
- Requested end datemethod
- Method to be used (3, 4 supported)historyStart
- Historical data start datehistoryEnd
- Historical data start dategrowthRate
- Used to adjust historical data, if any, and template values. 0 - do not use.data
- Array contains data values for items (IV overlap, AHT overlap from FrcTemplateTypes) from periods when historical data should be overridden.events
- Involved EventsfrcSaveBuildResults
- true - save build results to DB; false - results not saved (additional action required)useAllEvents
- Ignores events parameter and uses all applicable eventsjava.rmi.RemoteException
java.lang.String buildPredictedDataBasedOnTemplate(int scenarioId, FrcActivity[] activities, int[] types, double start, double end, double growthRate, FrcTemplateData[] templateData, boolean frcSaveBuildResults) throws java.rmi.RemoteException
scenarioId
- Scenario identifieractivities
- Scenario Activities data to be builttypes
- Array of required data types (IV and AHT types are supported)start
- Requested start dateend
- Requested end dategrowthRate
- Used to adjust (if any) template values. 0 - do not use.templateData
- Array contains data values for item (IV, AHT types from FrcTemplateTypes). Data can be combined from several same type templates.frcSaveBuildResults
- true - save build results to DB; false - results not saved (additional action required)java.rmi.RemoteException
java.lang.String buildPredictedDataBasedOnConstant(int scenarioId, FrcActivity[] activities, int[] types, double start, double end, double growthRate, double IVValue, double AHTValue, boolean frcSaveBuildResults) throws java.rmi.RemoteException
scenarioId
- Scenario identifieractivities
- Scenario Activities data to be builttypes
- Array of required data types (IV and AHT types supported)start
- Requested start dateend
- Requested end dategrowthRate
- Used to adjust values. 0 - do not use.IVValue
- Constant Interaction Volume value to be assignedAHTValue
- Constant Average Handle Time value to be assignedfrcSaveBuildResults
- true - save build results to DB; false - results not saved (additional action required)java.rmi.RemoteException
java.lang.String buildPredictedDataBasedOnHistory(int scenarioId, FrcActivity[] activities, int[] types, double start, double end, double historyStart, double historyEnd, double growthRate, FrcTemplateData[] overrideData, boolean frcSaveBuildResults) throws java.rmi.RemoteException
scenarioId
- Scenario identifieractivities
- Scenario Activities data to be builttypes
- Array of required data types (IV and AHT types are supported)start
- Requested start dateend
- Requested end datehistoryStart
- Historical data start datehistoryEnd
- Historical data start dategrowthRate
- Used to adjust historical data, if any, and template values, 0 - do not use.overrideData
- Array contains data values for item (IV overlap, AHT overlap types from FrcTemplatesTypes) for periods when historical data should be overridden.frcSaveBuildResults
- true - save build results to DB; false - results not saved (additional action required)java.rmi.RemoteException
java.lang.String splitPredictedData(int scenarioId, FrcActivity[] sourceActivity, FrcActivity[] targetActivities, double start, double end, boolean keepAHT, boolean useAllActivities, boolean frcSaveSplitResults) throws java.rmi.RemoteException
scenarioId
- Scenario identifiersourceActivity
- Scenario Multi-Site Activities used as data sourcetargetActivities
- Scenario Activities (data split target)start
- Requested start dateend
- Requested end datekeepAHT
- true - keep original Activity AHT; false - use MS Activity AHT (split AHT too)useAllActivities
- true - use all scenario activities to split data; false - use only activities associated with the virtual activityfrcSaveSplitResults
- true - save spilt results to DB; false - results not saved (additional action required)java.rmi.RemoteException
java.lang.String asyncSplitPredictedData(int scenarioId, FrcActivity[] sourceActivity, FrcActivity[] targetActivities, double start, double end, boolean keepAHT, boolean useAllActivities, boolean frcSaveSplitResults, boolean considerPlannedItems) throws java.rmi.RemoteException
scenarioId
- Scenario identifiersourceActivity
- Scenario Multi-Site Activities used as data sourcetargetActivities
- Scenario Activities (data split target)start
- Requested start dateend
- Requested end datekeepAHT
- true - keep original Activity AHT; false - use MS Activity AHT (split AHT too)useAllActivities
- true - use all scenario activities to split data; false - use just activities associated with the virtual activityfrcSaveSplitResults
- true - save spilt results to DB; false - results not saved (additional action required)considerPlannedItems
- true - splitting will consider pre-planned granted Calendar itemsjava.rmi.RemoteException
java.lang.String splitStaffingDataAsync(int scenarioId, FrcActivity[] sourceActivity, FrcActivity[] targetActivities, double start, double end, FrcActivityPeriodParameters[] periodParameters, FrcActivityStaffingDataParameters[] parameters, boolean splitRequired, boolean useAHT, boolean useAllActivities, boolean frcSaveSplitResults) throws java.rmi.RemoteException
scenarioId
- Scenario identifiersourceActivity
- Scenario Multi-Site Activities used as data sourcetargetActivities
- Scenario Activities (data split target)start
- Requested start dateend
- Requested end dateperiodParameters
- Period and basic parameters for target Activitiesparameters
- IOT and overheads for target ActivitiessplitRequired
- true - also split Required Staffing using the same settingsuseAHT
- true - use MS Activity child Activities AHT; false - use MS Activity AHTuseAllActivities
- true - use all scenario activities to split data; false - use just activities associated with virtualfrcSaveSplitResults
- true - save spilt results to DB; false - results not saved (additional action required)java.rmi.RemoteException
java.lang.String calculateStaffingRequirementData(int scenarioId, FrcActivity[] targetActivities, int[] types, double start, double end, int method, FrcActivityPeriodParameters[] periodParameters, FrcActivityStaffingDataParameters[] parameters, FrcActivityStaffingDataObjectives[] objectives, FrcActivityTemplateData[] templateData, boolean frcSaveBuildResults) throws java.rmi.RemoteException
scenarioId
- Scenario identifiertargetActivities
- Scenario Activities data to be builttypes
- Array of required data types (Calculated and Required Staffing supported)start
- Requested start dateend
- Requested end datemethod
- Types 0, 2, 5 and 6 supported.periodParameters
- Period and basic parametersparameters
- IOT and overheadsobjectives
- Service ObjectivestemplateData
- Array contains data values for item (Staffing type from FrcTemplatesTypes). Data can be combined from several templates.frcSaveBuildResults
- true - save build results to DB, false - results not saved (additional action required)java.rmi.RemoteException
FrcHistoricalShortInformation getHistoricalShortInformation() throws java.rmi.RemoteException
java.rmi.RemoteException
FrcActivityHistoricalInformationIndicators[] getActivityHistoricalInformationIndicators(FrcActivity[] activities, int[] types, double start, double end, int request) throws java.rmi.RemoteException
activities
- Required Activitiestypes
- Required information types: IV or/and AHTstart
- Requested start dateend
- Requested end daterequest
- 0 - only historical data earliest and latest dates (min/max);
1 - historical data min/max dates and date ranges for the specified periodjava.rmi.RemoteException
FrcTargetForecastInformation[] getHistoricalInformation(int target, int targetId, int[] types, double start, double end, int granularity) throws java.rmi.RemoteException
target
- Target leveltargetId
- Requested target identifiertypes
- Array of required types (IV and/or AHT supported)start
- Requested start dateend
- Requested end dategranularity
- Requested period of granularity, in minutes. Period data aggregated from the start to the end, according to the given granularity. Meaningful values:
0 - total for the whole period;
15 min (time step);
1440 (1 day);
10080 (1 week);
60480 (max long period - 6 weeks).
Monthly aggregation performed on calendar-month basis (special value is -1), e.g. starting Jun 15, 2003, and ending Jul 15, 2003, aggregates as 2 values for the periods: Jun 15, 2003, to Jun 30, 2003, and Jul 1, 2003,to Jul 15, 2003.
Special values:
0 - for total value;
-1 - calendar month;
-10 - calendar week starts Sunday;
-11 - calendar week starts Mon.;
-12 - calendar week starts Tue.;
-13 - calendar week starts Wed.;
-14 - calendar week starts Thu.;
-15 - calendar week starts Fri.;
-16 - calendar week starts Sat.java.rmi.RemoteException
FrcTemplateHeader[] getTemplatesList(int[] BUs, int[] sites, int[] types) throws java.rmi.RemoteException
BUs
- Array of Business Units identifiers: if empty, and the sites array is empty as well, the service returns all templates of the specified types.sites
- Array of Site identifiers: if empty, and the BUs array is empty as well, the service returns all templates of the specified types.types
- Array of required template types: if empty, service returns all.java.rmi.RemoteException
FrcTemplateHeader[] getTemplatesListEx(int[] BUs, int[] sites, int[] types, FrcActivity[] activities) throws java.rmi.RemoteException
BUs
- Array of Business Units identifierssites
- Array of Site identifierstypes
- Array of required template types: if empty, the service returns all types.activities
- Activity filter: if array is empty, then this method works as method getTemplateList does.java.rmi.RemoteException
FrcData[] getTemplateData(int templateId) throws java.rmi.RemoteException
templateId
- Template's identifierjava.rmi.RemoteException
FrcTemplate getTemplate(int templateId, int request) throws java.rmi.RemoteException
templateId
- Template's identifierrequest
- Request mask:
0 - all data;
1 - header only;
2 - activities only;
4 - data only. Combinations accepted, e.g. 5 for template header and data request.java.rmi.RemoteException
FrcActivity[] getTemplateActivities(int templateId) throws java.rmi.RemoteException
templateId
- Template's identifierjava.rmi.RemoteException
int createTemplate(int type, java.lang.String name, int parentType, int parentId, double start, double end, FrcActivity[] activities, double initialValue, int basedOnTemplate) throws java.rmi.RemoteException
type
- Template's typename
- Template's name (cannot be empty)parentType
- Site or BUparentId
- Site or BU identifierstart
- Start date of the template data (obsolete for non-overlap templates)end
- End date of the template data (obsolete for non-overlap-templates)activities
- Array of associated ActivitiesinitialValue
- Initial value for all Activities and all time steps (-1 to be ignored)basedOnTemplate
- "Base" template identifier (-1 to be ignored). "based on" template must be of the same type as the template itself.java.rmi.RemoteException
void setTemplateName(int templateId, java.lang.String name) throws java.rmi.RemoteException
templateId
- Template's identifiername
- Template's namejava.rmi.RemoteException
void setTemplateData(int templateId, FrcData[] data) throws java.rmi.RemoteException
templateId
- Template's identifierdata
- Contains list of data valuesjava.rmi.RemoteException
void deleteTemplate(int[] templates) throws java.rmi.RemoteException
templates
- Template to be deleted identifiersjava.rmi.RemoteException
void addTemplateActivities(int templateId, FrcActivity[] activities) throws java.rmi.RemoteException
templateId
- Template's identifieractivities
- Contains list of Activitiesjava.rmi.RemoteException
void deleteTemplateActivities(int templateId, FrcActivity[] activities) throws java.rmi.RemoteException
templateId
- Template's identifieractivities
- Contains list of Activitiesjava.rmi.RemoteException
int saveHistoricalDataAsTemplate(int type, java.lang.String name, int parentType, int parentId, double start, double end, FrcActivity[] activities, FrcActivity[] sourceActivities) throws java.rmi.RemoteException
type
- Template type (IV, AHT, IV overlap, AHT overlap are supported)name
- Template's nameparentType
- Site or BUparentId
- Template's parent identifierstart
- Source start dateend
- Source end dateactivities
- Activities to be associated with the new templatesourceActivities
- Source Activity identifiers (sourceActivities can be different from activities and used to retrieve data for the template.)java.rmi.RemoteException
int saveStaffingDataAsTemplate(java.lang.String name, int parentType, int parentId, double start, double end, FrcActivity[] activities, int sourceScenarioId, FrcActivity[] sourceActivities) throws java.rmi.RemoteException
name
- Template's nameparentType
- Site or BUparentId
- Template's parent (Site or BU) identifierstart
- Source start dateend
- Source end dateactivities
- Activities data to be associated with the new template. New template's Activities can differ from source Activities and can be from a different Site or BU. If more than one source Activity is specified, data is aggregated and then assigned to each template's Activity.sourceScenarioId
- Source scenario identifiersourceActivities
- Source Activity identifiersjava.rmi.RemoteException
java.lang.String saveForecastRequestData(java.lang.String asyncRequestToSaveID) throws java.rmi.RemoteException
asyncRequestToSaveID
- Previous build request identifierjava.rmi.RemoteException
FrcTargetForecastInformation[] getForecastRequestActivityData(java.lang.String requestID, int activityID, int[] types, double start, double end, int granularity) throws java.rmi.RemoteException
requestID
- Request identifieractivityID
- Activity identifiertypes
- Array of required types from FrcDataTypesstart
- Requested period start dateend
- Requested period end dategranularity
- Requested period's granularity, in minutesjava.rmi.RemoteException
FrcActivityBuildSelection getForecastActivityPredictionBuildSelection(int scenarioID, int target, int targetID) throws java.rmi.RemoteException
scenarioID
- Scenario identifiertarget
- Target leveltargetID
- Activity/Multi-site Activity identifierjava.rmi.RemoteException
FrcActivityBuildSelection getForecastActivityStaffingBuildSelection(int scenarioID, int target, int targetID) throws java.rmi.RemoteException
scenarioID
- Scenario identifiertarget
- Target leveltargetID
- Activity/Multi-site Activity identifierjava.rmi.RemoteException
Copyright © 2005-2016 Genesys Telecommunications Labs, Inc. All Rights Reserved.