Packagecom.esri.baserver.tasks.segmentation
Classpublic class ProfileByImportFromTableParameters
InheritanceProfileByImportFromTableParameters Inheritance BAUtilityParameters Inheritance BABaseParameters Inheritance Object
Implements IBAResultProcessor

The ProfileByImportFromTableParameters class provides input parameters for the Profile by Import from Table task.

The import table should only have one record for each segmentation code and it must contain summarized counts for each segment. The import table can contain summarized volumes (e.g. total sales) for each segment.

The output profile can be saved in the Business Analyst Server repository if the outputItem parameter is specified.

View the examples

See also

ProfileByImportFromTableTask


Public Properties
 PropertyDefined By
 InheritedactiveDatasetID : String
Active dataset ID.
BAUtilityParameters
  countField : String
The attribute field in the dataTable table which contains summarized counts (e.g., number of customers) for each Tapestry segment (required).
ProfileByImportFromTableParameters
  dataTable : TableData
The data table to import profile from (required).
ProfileByImportFromTableParameters
  idField : String
The attribute field in the dataTable table which contains IDs of Tapestry segments (required).
ProfileByImportFromTableParameters
  outputItem : FolderItem
Configuration options for storing the output item in the repository.
ProfileByImportFromTableParameters
 InheritedresultType : BAResultType
[read-only] Type of a result returned by the task associated with these parameters.
BABaseParameters
 InheritedtaskName : String
[read-only] Name of a Business Analyst Server task associated with these parameters.
BABaseParameters
  volumeField : String
The attribute field in the dataTable table which contains summarized volume (e.g., total sales) for each Tapestry segment (optional).
ProfileByImportFromTableParameters
Public Methods
 MethodDefined By
  
Creates a new instance of the ProfileByImportFromTableParameters class.
ProfileByImportFromTableParameters
Property Detail
countFieldproperty
countField:String

The attribute field in the dataTable table which contains summarized counts (e.g., number of customers) for each Tapestry segment (required).


Implementation
    public function get countField():String
    public function set countField(value:String):void
dataTableproperty 
dataTable:TableData

The data table to import profile from (required).


Implementation
    public function get dataTable():TableData
    public function set dataTable(value:TableData):void
idFieldproperty 
idField:String

The attribute field in the dataTable table which contains IDs of Tapestry segments (required).


Implementation
    public function get idField():String
    public function set idField(value:String):void
outputItemproperty 
outputItem:FolderItem

Configuration options for storing the output item in the repository.


Implementation
    public function get outputItem():FolderItem
    public function set outputItem(value:FolderItem):void
volumeFieldproperty 
volumeField:String

The attribute field in the dataTable table which contains summarized volume (e.g., total sales) for each Tapestry segment (optional).


Implementation
    public function get volumeField():String
    public function set volumeField(value:String):void
Constructor Detail
ProfileByImportFromTableParameters()Constructor
public function ProfileByImportFromTableParameters()

Creates a new instance of the ProfileByImportFromTableParameters class.

Examples
ActionScript to create ProfileByImportFromTableParameters and then use in a Profile by Import from Table task:
                     
     var parameters : ProfileByImportFromTableParameters = new ProfileByImportFromTableParameters();
     
     // The TableData type could take either data as type
     // com.esri.baserver.GeocodeAddressesData, com.esri.baserver.FolderItem,
     // com.esri.ags.tasks.FeatureSet, or string URL to an external table.
     
     // Set dataTable as a FeatureSet.
     parameters.dataTable = new TableData(featureSet);
     
     // Set an attribute field in the dataTable table which contains summarized counts.
     parameters.countField = "COUNT";
     
     // Set an attribute field in the dataTable table which contains IDs.
     parameters.idField = "SEGMENT";
     
     // Set an attribute field in the dataTable table which contains summarized volume (optional).
     parameters.volumeField = "SALES";
     
     profileByImportFromTableTask.execute(parameters, new Responder(resultHandler, faultHandler));