FRAMES | NO FRAMES
CustomerStoreSetupByCoordinatesParameters Type

Parameters of CustomerStoreSetupByCoordinates task.

Availability: Business Analyst Server.

class CustomerStoreSetupByCoordinatesParameters : CustomerStoreSetupParameters

Property Description
DataTable Data table. Type TableData.
LatitudeFieldName Name of the latitude (y) field. Type String.
LongitudeFieldName Name of the longitude (x) field. Type String.
Points Array of point records. Type PointRecord[].
SpatialReference (optional) The spatial reference associated with points of this layer. Type SpatialReference.
GeocodeCustomers (optional) An option specifying the setup type. Type Boolean. Inherited from CustomerStoreSetupParameters.
LinkField (optional) The name of field for Customer Setup to be used for assignment customers with stores or trade areas. Type String. Inherited from CustomerStoreSetupParameters.
NameField (optional) Store/customer name field. Type String. Inherited from CustomerStoreSetupParameters.
StoreIDField Store ID field name for Store Setup. Type String. Inherited from CustomerStoreSetupParameters.
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.

Remarks

Point data for Customer/Store Setup are specified with either the DataTable or Points properties. In the first case, the names of fields specified by properties of this class should match with fields of the input data table and the output layer will contain all fields specified in the input data table. In the last case, the customer/store layer will contain fields with the names specified by properties of this class.

The spatial reference can be specified by the SpatialReference property. If this parameter is null, the Business Analyst Server default coordinate system is used.

The GeocodeCustomers property specifies the Setup type: the true value (default) means Customer Setup and the false value means Store Setup.

For Customer Setup, the NameField and LinkField properties can be specified. A new customer ID field is created.

For Store Setup, the StoreIDField property should be specified, the NameField and CreateNewIDField properties are optional.

See Also