Display Name: Spatial Join

Description: Geoprocessing tool used to join the attributes of two feature classes based on the spatial relationships between the features in the two feature classes and to write the join an output.

Category:

Help URL: https://egis.tbc.sa/server/rest/directories/arcgisoutput/SpatialJoin_GPServer/SpatialJoin/SpatialJoin.htm

Execution Type: esriExecutionTypeAsynchronous

Parameters:

Parameter: target_features

Data Type: GPFeatureRecordSetLayer
Display Name Target Features
Description: Attributes of the target features and the attributes from the joined features are transferred to the output feature class. However, a subset of attributes can be defined in the field map parameter.
Direction: esriGPParameterDirectionInput
Default Value:
Geometry Type: esriGeometryPolygon
HasZ: false
HasM: false
Spatial Reference: 4326  (4326)

Fields:
• OBJECTID ( type: esriFieldTypeOID, alias: OBJECTID )
• REGION_ID ( type: esriFieldTypeSmallInteger, alias: REGION_ID )
• ANAME ( type: esriFieldTypeString, alias: ANAME, length: 50 )
• ENAME ( type: esriFieldTypeString, alias: ENAME, length: 50 )
• Test_ID ( type: esriFieldTypeSmallInteger, alias: iest_id )
• SHAPE_Length ( type: esriFieldTypeDouble, alias: SHAPE_Length )
• SHAPE_Area ( type: esriFieldTypeDouble, alias: SHAPE_Area )
Features: None.



Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: join_features

Data Type: GPString
Display Name Join Features
Description: The attributes from the join features are joined to the attributes of the target features. See the explanation of the Join Operation parameter for details on how the aggregation of joined attributes are affected by the type of join operation.
Direction: esriGPParameterDirectionInput
Default Value: FC_SCHOOLS
Parameter Type: esriGPParameterTypeRequired
Category:
Choice List: [ Cities_CollectEvents, Cities, FC_SCHOOLS, Areigions__SpatialJoin ]

Parameter: out_feature_class

Data Type: GPFeatureRecordSetLayer
Display Name Output Feature Class
Description: A new feature class containing the attributes of the target and join features. By default, all attributes of target features and the attributes of the joined features are written to the output. However, the set of attributes to be transferred can be controlled by the field map parameter.
Direction: esriGPParameterDirectionOutput
Default Value:
Geometry Type: esriGeometryPolygon
HasZ: false
HasM: false
Spatial Reference: 4326  (4326)

Fields:
• OBJECTID ( type: esriFieldTypeOID, alias: OBJECTID )
• Join_Count ( type: esriFieldTypeInteger, alias: Join_Count )
• TARGET_FID ( type: esriFieldTypeInteger, alias: TARGET_FID )
• REGION_ID ( type: esriFieldTypeSmallInteger, alias: REGION_ID )
• ANAME ( type: esriFieldTypeString, alias: ANAME, length: 50 )
• ENAME ( type: esriFieldTypeString, alias: ENAME, length: 50 )
• Test_ID ( type: esriFieldTypeSmallInteger, alias: iest_id )
• ANAME_1 ( type: esriFieldTypeString, alias: ANAME_1, length: 254 )
• ENAME_1 ( type: esriFieldTypeString, alias: ENAME_1, length: 254 )
• MINISTERIAL_ID ( type: esriFieldTypeString, alias: MINISTERIAL_ID, length: 50 )
• SCHOOL_LANDS_ID ( type: esriFieldTypeInteger, alias: SCHOOL_LANDS_ID )
• GENDER_ID ( type: esriFieldTypeSmallInteger, alias: GENDER_ID )
• EDUC_LEVEL_ID ( type: esriFieldTypeInteger, alias: EDUC_LEVEL_ID )
• SHIFT_ID ( type: esriFieldTypeInteger, alias: Shift_ID )
• OWNERSHIP_ID ( type: esriFieldTypeInteger, alias: Ownership_ID )
• EDUC_TYPE_ID ( type: esriFieldTypeInteger, alias: EDUC_TYPE_ID )
• SCHOOL_TYPE_ID ( type: esriFieldTypeInteger, alias: SCHOOL_TYPE_ID )
• MODEL_ID ( type: esriFieldTypeInteger, alias: MODEL_ID )
• INDEPENDENCE_STATE_ID ( type: esriFieldTypeInteger, alias: INDEPENDENCE_STATE_ID )
• X ( type: esriFieldTypeDouble, alias: X )
• Y ( type: esriFieldTypeDouble, alias: Y )
• SCHOOL_STATUS_ID ( type: esriFieldTypeInteger, alias: SCHOOL_STATUS )
• REGION_ID_1 ( type: esriFieldTypeInteger, alias: Region_ID )
• CITY_ID ( type: esriFieldTypeInteger, alias: City_ID )
• DISTRICT_ID ( type: esriFieldTypeInteger, alias: District_ID )
• EDUC_GEN_DEP_ID ( type: esriFieldTypeInteger, alias: EDUC_GEN_DEP_ID )
• EDUC_DEP_ID ( type: esriFieldTypeInteger, alias: EDUC_DEP_ID )
• EDUC_OFIICE_BOYS_ID ( type: esriFieldTypeInteger, alias: Edu_Office_Boys )
• EDUC_OFIICE_GIRLS_ID ( type: esriFieldTypeInteger, alias: Edu_Office_Girls )
• RentValue ( type: esriFieldTypeDouble, alias: RentValue )
• MainSchool_ID ( type: esriFieldTypeInteger, alias: MainSchool_ID )
• MARKAZ_NAME ( type: esriFieldTypeString, alias: MARKAZ_NAME, length: 50 )
• MARKAZ_ID ( type: esriFieldTypeString, alias: MARKAZ_ID, length: 50 )
• URBAN_RURAL_ID ( type: esriFieldTypeInteger, alias: URBAN_RURAL_ID )
• SCHOOL_ID ( type: esriFieldTypeInteger, alias: SCHOOL_ID )
• BATCH_NO ( type: esriFieldTypeInteger, alias: BATCH_NO )
• SHAPE_Length ( type: esriFieldTypeDouble, alias: SHAPE_Length )
• SHAPE_Area ( type: esriFieldTypeDouble, alias: SHAPE_Area )
Features: None.



Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: join_operation

Data Type: GPString
Display Name Join Operation
Description: Determines how joins between the target features and join features will be handled in the output feature class if multiple join features are found that have the same spatial relationship with a single target feature.JOIN_ONE_TO_ONE—If multiple join features are found that have the same spatial relationship with a single target feature, the attributes from the multiple join features will be aggregated using a field map merge rule. For example, if a point target feature is found within two separate polygon join features, the attributes from the two polygons will be aggregated before being transferred to the output point feature class. If one polygon has an attribute value of 3 and the other has a value of 7, and a Sum merge rule is specified, the aggregated value in the output feature class will be 10. This is the default.JOIN_ONE_TO_MANY—If multiple join features are found that have the same spatial relationship with a single target feature, the output feature class will contain multiple copies (records) of the target feature. For example, if a single point target feature is found within two separate polygon join features, the output feature class will contain two copies of the target feature: one record with the attributes of one polygon, and another record with the attributes of the other polygon.
Direction: esriGPParameterDirectionInput
Default Value: JOIN_ONE_TO_ONE
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ JOIN_ONE_TO_ONE, JOIN_ONE_TO_MANY ]

Parameter: join_type

Data Type: GPBoolean
Display Name Keep All Target Features
Description: Determines if all target features will be maintained in the output feature class (known as outer join), or only those that have the specified spatial relationship with the join features (inner join). Checked—All target features will be maintained in the output (outer join). This is the default. Unchecked—Only those target features that have the specified spatial relationship with the join features will be maintained in the output feature class (inner join). For example, if a point feature class is specified for the target features, and a polygon feature class is specified for the join features, with a Match Option of WITHIN, the output feature class will only contain those target features that are within a polygon join feature; any target features not within a join feature will be excluded from the output.
Direction: esriGPParameterDirectionInput
Default Value: true
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: field_mapping

Data Type: GPString
Display Name Field Map of Join Features
Description: Controls which attribute fields will be in the output feature class. The initial list contains all the fields from both the target features and the join features. Fields can be added, deleted, renamed, or have their properties changed. The selected fields from the target features are transferred as is, but selected fields from the join features can be aggregated by a valid merge rule. The default value is an empty string, in which case, all fields from both target and join features are transferred to the output. For details on field mapping, see the help topics "Using the field mapping control" and "Mapping input fields to output fields." Multiple fields and statistic combination may be specified.Merge rules allow you to specify how values from two or more input fields are merged or combined into a single output value. There are several merge rules that determine how the output field is populated with values.First—Use the input fields' first value.Last—Use the input fields' last value.Join—Concatenate (join) the input fields' values.Sum—Calculate the total of the input fields' values.Mean—Calculate the mean (average) of the input fields' values.Median—Calculate the median (middle) of the input fields' values.Mode—Use the value with the highest frequency.Min—Use the minimum value of all input fields' values.Max—Use the maximum value of all input fields' values.Standard deviation—Use the standard deviation classification method on all input fields' values.Count—Find the number of records included in the calculation.
Direction: esriGPParameterDirectionInput
Default Value: REGION_ID "REGION_ID" true true false 2 Short 0 5 ,First,#,Database Connections\Connection to TBCWEB.sde\TBC_FINAL.DBO.Areigions_,REGION_ID,-1,-1;ANAME "ANAME" true true false 50 Text 0 0 ,First,#,Database Connections\Connection to TBCWEB.sde\TBC_FINAL.DBO.Areigions_,ANAME,-1,-1;ENAME "ENAME" true true false 50 Text 0 0 ,First,#,Database Connections\Connection to TBCWEB.sde\TBC_FINAL.DBO.Areigions_,ENAME,-1,-1;Test_ID "iest_id" true true false 2 Short 0 5 ,First,#,Database Connections\Connection to TBCWEB.sde\TBC_FINAL.DBO.Areigions_,Test_ID,-1,-1;SHAPE_STArea__ "SHAPE_STArea__" false false true 0 Double 0 0 ,First,#,Database Connections\Connection to TBCWEB.sde\TBC_FINAL.DBO.Areigions_,SHAPE.STArea(),-1,-1;SHAPE_STLength__ "SHAPE_STLength__" false false true 0 Double 0 0 ,First,#,Database Connections\Connection to TBCWEB.sde\TBC_FINAL.DBO.Areigions_,SHAPE.STLength(),-1,-1;ANAME_1 "ANAME_1" true true false 254 Text 0 0 ,First,#,FC_SCHOOLS,ANAME,-1,-1;ENAME_1 "ENAME_1" true true false 254 Text 0 0 ,First,#,FC_SCHOOLS,ENAME,-1,-1;MINISTERIAL_ID "MINISTERIAL_ID" true true false 50 Text 0 0 ,First,#,FC_SCHOOLS,MINISTERIAL_ID,-1,-1;SCHOOL_LANDS_ID "SCHOOL_LANDS_ID" true true false 4 Long 0 10 ,First,#,FC_SCHOOLS,SCHOOL_LANDS_ID,-1,-1;GENDER_ID "GENDER_ID" true true false 2 Short 0 5 ,First,#,FC_SCHOOLS,GENDER_ID,-1,-1;EDUC_LEVEL_ID "EDUC_LEVEL_ID" true true false 4 Long 0 10 ,First,#,FC_SCHOOLS,EDUC_LEVEL_ID,-1,-1;SHIFT_ID "Shift_ID" true true false 4 Long 0 10 ,First,#,FC_SCHOOLS,SHIFT_ID,-1,-1;OWNERSHIP_ID "Ownership_ID" true true false 4 Long 0 10 ,First,#,FC_SCHOOLS,OWNERSHIP_ID,-1,-1;EDUC_TYPE_ID "EDUC_TYPE_ID" true true false 4 Long 0 10 ,First,#,FC_SCHOOLS,EDUC_TYPE_ID,-1,-1;SCHOOL_TYPE_ID "SCHOOL_TYPE_ID" true true false 4 Long 0 10 ,First,#,FC_SCHOOLS,SCHOOL_TYPE_ID,-1,-1;MODEL_ID "MODEL_ID" true true false 4 Long 0 10 ,First,#,FC_SCHOOLS,MODEL_ID,-1,-1;INDEPENDENCE_STATE_ID "INDEPENDENCE_STATE_ID" true true false 4 Long 0 10 ,First,#,FC_SCHOOLS,INDEPENDENCE_STATE_ID,-1,-1;X "X" true true false 8 Double 8 38 ,First,#,FC_SCHOOLS,X,-1,-1;Y "Y" true true false 8 Double 8 38 ,First,#,FC_SCHOOLS,Y,-1,-1;SCHOOL_STATUS_ID "SCHOOL_STATUS" true true false 4 Long 0 10 ,First,#,FC_SCHOOLS,SCHOOL_STATUS_ID,-1,-1;REGION_ID_1 "Region_ID" true true false 4 Long 0 10 ,First,#,FC_SCHOOLS,REGION_ID,-1,-1;CITY_ID "City_ID" true true false 4 Long 0 10 ,First,#,FC_SCHOOLS,CITY_ID,-1,-1;DISTRICT_ID "District_ID" true true false 4 Long 0 10 ,First,#,FC_SCHOOLS,DISTRICT_ID,-1,-1;EDUC_GEN_DEP_ID "EDUC_GEN_DEP_ID" true true false 4 Long 0 10 ,First,#,FC_SCHOOLS,EDUC_GEN_DEP_ID,-1,-1;EDUC_DEP_ID "EDUC_DEP_ID" true true false 4 Long 0 10 ,First,#,FC_SCHOOLS,EDUC_DEP_ID,-1,-1;EDUC_OFIICE_BOYS_ID "Edu_Office_Boys" true true false 4 Long 0 10 ,First,#,FC_SCHOOLS,EDUC_OFIICE_BOYS_ID,-1,-1;EDUC_OFIICE_GIRLS_ID "Edu_Office_Girls" true true false 4 Long 0 10 ,First,#,FC_SCHOOLS,EDUC_OFIICE_GIRLS_ID,-1,-1;RentValue "RentValue" true true false 8 Double 8 38 ,First,#,FC_SCHOOLS,RentValue,-1,-1;MainSchool_ID "MainSchool_ID" true true false 4 Long 0 10 ,First,#,FC_SCHOOLS,MainSchool_ID,-1,-1;MARKAZ_NAME "MARKAZ_NAME" true true false 50 Text 0 0 ,First,#,FC_SCHOOLS,MARKAZ_NAME,-1,-1;MARKAZ_ID "MARKAZ_ID" true true false 50 Text 0 0 ,First,#,FC_SCHOOLS,MARKAZ_ID,-1,-1;URBAN_RURAL_ID "URBAN_RURAL_ID" true true false 4 Long 0 10 ,First,#,FC_SCHOOLS,URBAN_RURAL_ID,-1,-1;SCHOOL_ID "SCHOOL_ID" true true false 4 Long 0 10 ,First,#,FC_SCHOOLS,SCHOOL_ID,-1,-1;BATCH_NO "BATCH_NO" true true false 4 Long 0 10 ,First,#,FC_SCHOOLS,BATCH_NO,-1,-1
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: match_option

Data Type: GPString
Display Name Match Option
Description: Defines the criteria used to match rows. The match options are:INTERSECT—The features in the join features will be matched if they intersect a target feature. This is the default. Specify a distance in the Search Radius parameter.INTERSECT_3D— The features in the join features will be matched if they intersect a target feature in three-dimensional space (x, y, and z). Specify a distance in the Search Radius parameter.WITHIN_A_DISTANCE—The features in the join features will be matched if they are within a specified distance of a target feature. Specify a distance in the Search Radius parameter.WITHIN_A_DISTANCE_GEODESIC—Same as Within a distance except that geodesic distance is used rather than planar distance. Choose this if your data covers a large geographic extent or the coordinate system of the inputs is unsuitable for distance calculations.WITHIN_A_DISTANCE_3D—The features in the join features will be matched if they are within a specified distance of a target feature in three-dimensional space. Specify a distance in the Search Radius parameter.CONTAINS—The features in the join features will be matched if a target feature contains them. The target features must be polygons or polylines. For this option, the target features cannot be points, and the join features can only be polygons when the target features are also polygons.COMPLETELY_CONTAINS—The features in the join features will be matched if a target feature completely contains them. Polygon can completely contain any feature. Point cannot completely contain any feature, not even a point. Polyline can completely contain only polyline and point.CONTAINS_CLEMENTINI—This spatial relationship yields the same results as Completely contains with the exception that if the join feature is entirely on the boundary of the target feature (no part is properly inside or outside) the feature will not be matched. Clementini defines the boundary polygon as the line separating inside and outside, the boundary of a line is defined as its end points, and the boundary of a point is always empty.WITHIN—The features in the join features will be matched if a target feature is within them. It is opposite to Contains. For this option, the target features can only be polygons when the join features are also polygons. Point can be join feature only if point is target. COMPLETELY_WITHIN—The features in the join features will be matched if a target feature is completely within them. This is opposite to Completely contains. WITHIN_CLEMENTINI—The result will be identical to Within except if the entirety of the feature in the join features is on the boundary of the target feature, the feature will not be matched. Clementini defines the boundary polygon as the line separating inside and outside, the boundary of a line is defined as its end points, and the boundary of a point is always empty.ARE_IDENTICAL_TO—The features in the join features will be matched if they are identical to a target feature. Both join and target feature must be of same shape type—point-to-point, line-to-line, and polygon-to-polygon. BOUNDARY_TOUCHES—The features in the join features will be matched if they have a boundary that touches a target feature. When the target and join features are lines or polygons, the boundary of the join feature can only touch the boundary of the target feature and no part of the join feature can cross the boundary of the target feature.SHARE_A_LINE_SEGMENT_WITH—The features in the join features will be matched if they share a line segment with a target feature. The join and target features must be lines or polygons.CROSSED_BY_THE_OUTLINE_OF—The features in the join features will be matched if a target feature is crossed by their outline. The join and target features must be lines or polygons. If polygons are used for the join or target features, the polygon's boundary (line) will be used. Lines that cross at a point will be matched, not lines that share a line segment.HAVE_THEIR_CENTER_IN—The features in the join features will be matched if a target feature's center falls within them. The center of the feature is calculated as follows: for polygon and multipoint the geometry's centroid is used, and for line input the geometry's midpoint is used. Specify a distance in the Search Radius parameter.CLOSEST—The feature in the join features that is closest to a target feature is matched. See the usage tip for more information. Specify a distance in the Search Radius parameter.CLOSEST_GEODESIC—Same as Closest except that geodesic distance is used rather than planar distance. Choose this if your data covers a large geographic extent or the coordinate system of the inputs is unsuitable for distance calculations
Direction: esriGPParameterDirectionInput
Default Value: CONTAINS
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ INTERSECT, INTERSECT_3D, WITHIN_A_DISTANCE_GEODESIC, WITHIN_A_DISTANCE, WITHIN_A_DISTANCE_3D, CONTAINS, COMPLETELY_CONTAINS, CONTAINS_CLEMENTINI, WITHIN, COMPLETELY_WITHIN, WITHIN_CLEMENTINI, ARE_IDENTICAL_TO, BOUNDARY_TOUCHES, SHARE_A_LINE_SEGMENT_WITH, CROSSED_BY_THE_OUTLINE_OF, HAVE_THEIR_CENTER_IN, CLOSEST_GEODESIC, CLOSEST ]

Parameter: search_radius

Data Type: GPLinearUnit
Display Name Search Radius
Description: Join features within this distance of a target feature will be considered for the spatial join. A search radius is only valid when the spatial relationship (Match Option) INTERSECT, WITHIN_A_DISTANCE, WITHIN_A_DISTANCE_GEODESIC, HAVE_THEIR_CENTER_IN, CLOSEST or CLOSEST_GEODESIC is specified. Using a search radius of 100 meters with the spatial relationship WITHIN_A_DISTANCE will join feature within 100 meters of a target feature. For the three WITHIN_A_DISTANCE relationships, if no value is specified for search radius then a distance of 0 is used.
Direction: esriGPParameterDirectionInput
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: distance_field_name

Data Type: GPString
Display Name Distance Field Name
Description:
Direction: esriGPParameterDirectionInput
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:

Supported Operations:   Submit Job