Included schema TerritoryPlanning.xsd
Namespace No namespace
Properties
attribute form default: unqualified
element form default: qualified
Element TerritoryPlanning / SolutionQuality
Namespace No namespace
Annotations
 
Defines the behaviour of the solution quality selected in the request.
Diagram
Diagram TerritoryPlanning_xsd.tmp#TerritoryPlanning_TerritoryPlanning_SolutionQuality_HighSolutionQuality TerritoryPlanning_xsd.tmp#TerritoryPlanning_TerritoryPlanning_SolutionQuality_BasicSolutionQuality
Properties
content: complex
minOccurs: 0
Model ALL(HighSolutionQuality{0,1} BasicSolutionQuality{0,1})
Children BasicSolutionQuality, HighSolutionQuality
Instance
 
<SolutionQuality>
  <HighSolutionQuality>{0,1}</HighSolutionQuality>
  <BasicSolutionQuality>{0,1}</BasicSolutionQuality>
</SolutionQuality>
Element TerritoryPlanning / SolutionQuality / HighSolutionQuality
Namespace No namespace
Diagram
Diagram TerritoryPlanning_xsd.tmp#TerritoryPlanning_TerritoryPlanning_SolutionQuality_TerritoryPlanning_TerritoryPlanning_SolutionQuality_HighSolutionQuality_PlanTerritories TerritoryPlanning_xsd.tmp#TerritoryPlanning_TerritoryPlanning_SolutionQuality_TerritoryPlanning_TerritoryPlanning_SolutionQuality_HighSolutionQuality_DistributeLocations
Properties
content: complex
minOccurs: 0
Model ALL(PlanTerritories{0,1} DistributeLocations{0,1})
Children DistributeLocations, PlanTerritories
Instance
 
<HighSolutionQuality>
  <PlanTerritories approximationTolerance="" compactnessLevel="" considerActivities="" maximumNumberOfIterations="" maximumNumberOfStarts="" minimumRelativeImprovement="" numberOfNearestNeighbors="" performPreprocessingStep="" solverTimeLimit="">{0,1}</PlanTerritories>
  <DistributeLocations approximationTolerance="" compactnessLevel="" considerActivities="" maximumNumberOfSamplings="" numberOfNearestNeighbors="" performPreprocessingStep="" solverTimeLimit="">{0,1}</DistributeLocations>
</HighSolutionQuality>
Element TerritoryPlanning / SolutionQuality / HighSolutionQuality / PlanTerritories
Namespace No namespace
Annotations
 
Parametrization for the use case plan territories from scratch.
Diagram
Diagram TerritoryPlanning_xsd.tmp#considerActivities TerritoryPlanning_xsd.tmp#compactnessLevel TerritoryPlanning_xsd.tmp#solverTimeLimit TerritoryPlanning_xsd.tmp#maximumNumberOfIterations TerritoryPlanning_xsd.tmp#minimumRelativeImprovement TerritoryPlanning_xsd.tmp#approximationTolerance TerritoryPlanning_xsd.tmp#performPreprocessingStep TerritoryPlanning_xsd.tmp#maximumNumberOfStarts TerritoryPlanning_xsd.tmp#numberOfNearestNeighbors
Properties
content: complex
minOccurs: 0
Attributes
QName Type Fixed Default Use Annotation
approximationTolerance restriction of xs:double optional 
Defines (in percent) how close to the optimal solution value the solver should come before exiting an iteration. For instance, compared to 10% the value of 5% means better solution at the cost of higher running time.
compactnessLevel restriction of xs:positiveInteger optional 
Defines the exponent with which the distances are incorporated in the model.
considerActivities xs:boolean optional 
Setting this parameter will privilege important locations with high activity when determining territory centers.
maximumNumberOfIterations xs:positiveInteger optional 
The maximum number of iterations the solver may use to provide a solution.
maximumNumberOfStarts xs:positiveInteger optional 
The maximum number of starts the solver may use to provide a solution. For each start the maximum number of iterations mentioned in this profile will be used.
minimumRelativeImprovement restriction of xs:double optional 
The minimum relative solution value improvement (in percent) between iterations. If the relative improvement is less than the given value, no further iterations will be performed.
numberOfNearestNeighbors restriction of xs:positiveInteger optional 
The number of nearest neighbors used for the tour estimator.
performPreprocessingStep xs:boolean optional 
Do preprocessing to reduce the complexity of the optimization problem. For example by excluding forbidden or redundant combinations.
solverTimeLimit xs:positiveInteger optional 
The maximum time in seconds the solver may use to provide a solution. When this period of time is elapsed the best solution available will be returned.
Element TerritoryPlanning / SolutionQuality / HighSolutionQuality / DistributeLocations
Namespace No namespace
Annotations
 
Parametrization for the use case distribute locations to territories.
Diagram
Diagram TerritoryPlanning_xsd.tmp#considerActivities TerritoryPlanning_xsd.tmp#compactnessLevel TerritoryPlanning_xsd.tmp#solverTimeLimit TerritoryPlanning_xsd.tmp#approximationTolerance TerritoryPlanning_xsd.tmp#performPreprocessingStep TerritoryPlanning_xsd.tmp#maximumNumberOfSamplings TerritoryPlanning_xsd.tmp#numberOfNearestNeighbors
Properties
content: complex
minOccurs: 0
Attributes
QName Type Fixed Default Use Annotation
approximationTolerance restriction of xs:double optional 
Defines (in percent) how close to the optimal solution value the solver should come before exiting an iteration. For instance, compared to 10% the value of 5% means better solution at the cost of higher running time.
compactnessLevel restriction of xs:positiveInteger optional 
Defines the exponent with which the distances are incorporated in the model.
considerActivities xs:boolean optional 
Setting this parameter will privilege important locations with high activity when determining territory centers.
maximumNumberOfSamplings xs:positiveInteger optional 
The maximum number of samplings needed mainly in the case that the number of territories is being changed and it is required to choose some "territory centers" from a given list.
numberOfNearestNeighbors restriction of xs:positiveInteger optional 
The number of nearest neighbors used for the tour estimator.
performPreprocessingStep xs:boolean optional 
Do preprocessing to reduce the complexity of the optimization problem. For example by excluding forbidden or redundant combinations.
solverTimeLimit xs:positiveInteger optional 
The maximum time in seconds the solver may use to provide a solution. When this period of time is elapsed the best solution available will be returned.
Element TerritoryPlanning / SolutionQuality / BasicSolutionQuality
Namespace No namespace
Diagram
Diagram TerritoryPlanning_xsd.tmp#TerritoryPlanning_TerritoryPlanning_SolutionQuality_TerritoryPlanning_TerritoryPlanning_SolutionQuality_BasicSolutionQuality_PlanTerritories TerritoryPlanning_xsd.tmp#TerritoryPlanning_TerritoryPlanning_SolutionQuality_TerritoryPlanning_TerritoryPlanning_SolutionQuality_BasicSolutionQuality_DistributeLocations
Properties
content: complex
minOccurs: 0
Model ALL(PlanTerritories{0,1} DistributeLocations{0,1})
Children DistributeLocations, PlanTerritories
Instance
 
<BasicSolutionQuality>
  <PlanTerritories compactnessLevel="" considerActivities="" maximumNumberOfIterations="" maximumNumberOfStarts="" minimumRelativeImprovement="" numberOfNearestNeighbors="" reassignmentMethod="" solverTimeLimit="">{0,1}</PlanTerritories>
  <DistributeLocations compactnessLevel="" considerActivities="" maximumNumberOfSamplings="" numberOfNearestNeighbors="" reassignmentMethod="" solverTimeLimit="">{0,1}</DistributeLocations>
</BasicSolutionQuality>
Element TerritoryPlanning / SolutionQuality / BasicSolutionQuality / PlanTerritories
Namespace No namespace
Annotations
 
Parametrization for the use case plan territories from scratch.
Diagram
Diagram TerritoryPlanning_xsd.tmp#considerActivities TerritoryPlanning_xsd.tmp#compactnessLevel TerritoryPlanning_xsd.tmp#solverTimeLimit TerritoryPlanning_xsd.tmp#maximumNumberOfIterations TerritoryPlanning_xsd.tmp#minimumRelativeImprovement TerritoryPlanning_xsd.tmp#reassignmentMethod TerritoryPlanning_xsd.tmp#maximumNumberOfStarts TerritoryPlanning_xsd.tmp#numberOfNearestNeighbors
Properties
content: complex
minOccurs: 0
Attributes
QName Type Fixed Default Use Annotation
compactnessLevel restriction of xs:positiveInteger optional 
Defines the exponent with which the distances are incorporated in the model.
considerActivities xs:boolean optional 
Setting this parameter will privilege important locations with high activity when determining territory centers.
maximumNumberOfIterations xs:positiveInteger optional 
The maximum number of iterations the solver may use to provide a solution.
maximumNumberOfStarts xs:positiveInteger optional 
The maximum number of starts the solver may use to provide a solution. For each start the maximum number of iterations mentioned in this profile will be used.
minimumRelativeImprovement restriction of xs:double optional 
The minimum relative solution value improvement (in percent) between iterations. If the relative improvement is less than the given value, no further iterations will be performed.
numberOfNearestNeighbors restriction of xs:positiveInteger optional 
The number of nearest neighbors used for the tour estimator.
reassignmentMethod restriction of xs:string optional 
Defines the method of reassignment for locations after an iteration. Setting this to REDUCE might yield a better solution at the cost of more execution time.
solverTimeLimit xs:positiveInteger optional 
The maximum time in seconds the solver may use to provide a solution. When this period of time is elapsed the best solution available will be returned.
Element TerritoryPlanning / SolutionQuality / BasicSolutionQuality / DistributeLocations
Namespace No namespace
Annotations
 
Parametrization for the use case distribute locations to territories.
Diagram
Diagram TerritoryPlanning_xsd.tmp#considerActivities TerritoryPlanning_xsd.tmp#compactnessLevel TerritoryPlanning_xsd.tmp#solverTimeLimit TerritoryPlanning_xsd.tmp#reassignmentMethod TerritoryPlanning_xsd.tmp#maximumNumberOfSamplings TerritoryPlanning_xsd.tmp#numberOfNearestNeighbors
Properties
content: complex
minOccurs: 0
Attributes
QName Type Fixed Default Use Annotation
compactnessLevel restriction of xs:positiveInteger optional 
Defines the exponent with which the distances are incorporated in the model.
considerActivities xs:boolean optional 
Setting this parameter will privilege important locations with high activity when determining territory centers.
maximumNumberOfSamplings xs:positiveInteger optional 
The maximum number of samplings needed mainly in the case that the number of territories is being changed and it is required to choose some "territory centers" from a given list.
numberOfNearestNeighbors restriction of xs:positiveInteger optional 
The number of nearest neighbors used for the tour estimator.
reassignmentMethod restriction of xs:string optional 
Defines the method of reassignment for locations after an iteration. Setting this to REDUCE might yield a better solution at the cost of more execution time.
solverTimeLimit xs:positiveInteger optional 
The maximum time in seconds the solver may use to provide a solution. When this period of time is elapsed the best solution available will be returned.
Complex Type TerritoryPlanning
Namespace No namespace
Annotations
 
Defines parameters for territory planning and optimization.
Diagram
Diagram TerritoryPlanning_xsd.tmp#TerritoryPlanning_majorVersion TerritoryPlanning_xsd.tmp#TerritoryPlanning_minorVersion TerritoryPlanning_xsd.tmp#TerritoryPlanning_SolutionQuality
Used by
Model ALL(SolutionQuality{0,1})
Children SolutionQuality
Attributes
QName Type Fixed Default Use Annotation
majorVersion xs:unsignedInt 1 required 
Holds the major version number.
minorVersion xs:unsignedInt 1 required 
Holds the minor version number.
Attribute @considerActivities
Namespace No namespace
Annotations
 
Setting this parameter will privilege important locations with high activity when determining territory centers.
Type xs:boolean
Properties
default: true
Used by
Attribute @compactnessLevel
Namespace No namespace
Annotations
 
Defines the exponent with which the distances are incorporated in the model.
Type restriction of xs:positiveInteger
Properties
default: 2
Facets
maxInclusive 4
minInclusive 1
Used by
Attribute @solverTimeLimit
Namespace No namespace
Annotations
 
The maximum time in seconds the solver may use to provide a solution. When this period of time is elapsed the best solution available will be returned.
Type xs:positiveInteger
Properties
default: 300
Used by
Attribute @maximumNumberOfIterations
Namespace No namespace
Annotations
 
The maximum number of iterations the solver may use to provide a solution.
Type xs:positiveInteger
Properties
default: 5
Used by
Attribute @minimumRelativeImprovement
Namespace No namespace
Annotations
 
The minimum relative solution value improvement (in percent) between iterations. If the relative improvement is less than the given value, no further iterations will be performed.
Type restriction of xs:double
Properties
default: 5
Facets
maxInclusive 10.0
minInclusive 1.0
Used by
Attribute @approximationTolerance
Namespace No namespace
Annotations
 
Defines (in percent) how close to the optimal solution value the solver should come before exiting an iteration. For instance, compared to 10% the value of 5% means better solution at the cost of higher running time.
Type restriction of xs:double
Properties
default: 2
Facets
maxInclusive 10.0
minInclusive 1.0
Used by
Attribute @performPreprocessingStep
Namespace No namespace
Annotations
 
Do preprocessing to reduce the complexity of the optimization problem. For example by excluding forbidden or redundant combinations.
Type xs:boolean
Properties
default: true
Used by
Attribute @maximumNumberOfStarts
Namespace No namespace
Annotations
 
The maximum number of starts the solver may use to provide a solution. For each start the maximum number of iterations mentioned in this profile will be used.
Type xs:positiveInteger
Properties
default: 5
Used by
Attribute @numberOfNearestNeighbors
Namespace No namespace
Annotations
 
The number of nearest neighbors used for the tour estimator.
Type restriction of xs:positiveInteger
Properties
default: 5
Facets
maxInclusive 40
minInclusive 3
Used by
Attribute @maximumNumberOfSamplings
Namespace No namespace
Annotations
 
The maximum number of samplings needed mainly in the case that the number of territories is being changed and it is required to choose some "territory centers" from a given list.
Type xs:positiveInteger
Properties
default: 100
Used by
Attribute @reassignmentMethod
Namespace No namespace
Annotations
 
Defines the method of reassignment for locations after an iteration. Setting this to REDUCE might yield a better solution at the cost of more execution time.
Type restriction of xs:string
Properties
default: DECIDE
Facets
enumeration DECIDE 
Assign locations at territory edges to the territory in which it probably fits best. Might cause territories to be slightly more unbalanced than specified in the request.
enumeration REDUCE 
Only conduct definite assignments to reduce the problem. Other locations are left unassigned for the next iteration.
Used by
Attribute TerritoryPlanning / @majorVersion
Namespace No namespace
Annotations
 
Holds the major version number.
Type xs:unsignedInt
Properties
use: required
fixed: 1
Used by
Complex Type TerritoryPlanning
Attribute TerritoryPlanning / @minorVersion
Namespace No namespace
Annotations
 
Holds the minor version number.
Type xs:unsignedInt
Properties
use: required
fixed: 1
Used by
Complex Type TerritoryPlanning