| FRAMES | NO FRAMES |
Parameters of AssignCustomersByTradeArea task.
Availability: Business Analyst Server.
class AssignByTradeAreaParameters : AssignParameters
| Property | Description |
|---|---|
| Boundaries | The polygon layer that will be used to assign customers to areas. This boundary layer is usually a Business Analyst trade area layer. Type DataLayer. |
| AnalysisExtent (optional) | Data extent to restrict the analysis. Type ExtentData. Inherited from AssignParameters.. |
| CustomerLinkField | The name of field in the Customers layer to be used for assignment customers with stores. Type String. Inherited from AssignParameters. |
| Customers | The customer layer used to make the customers assignment to stores. Type PointLayer. Inherited from AssignParameters. |
| StoreIDField | The attribute field name in the Stores layer which is associated with unique store/business IDs (typically store numbers for retail establishments with multiple locations). Type String. Inherited from AssignParameters. |
| ActiveDatasetID | ID of the active dataset. Type String. Inherited from AnalysisParameters. |
| IsFullErrorMessage | Mode for composing error messages. Type Boolean. Inherited from AnalysisParameters. |
| OutputSpatialReference | An option specifying the spatial reference to return the output feature layer. Type SpatialReference. If this parameter is missing, the output record set will be returned in the default spatial reference. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters. |
| ReturnGeometry | An option specifying the presence
of the shape attribute in the returned record set. Type Boolean.
Available with Business Analyst Server 10.0 SP1.
Inherited from AnalysisParameters.
Default: true. |
The analysis can be restricted to an analysis extent if the AnalysisExtent property is specified.