topic Re: ArcGIS Pro Python AddJoin in Python Questions

ArcGIS Pro Python AddJoin

Darrin_Smith — Tue, 12 Jan 2021 22:16:57 GMT

In ArcGIS Pro, I am running the AddJoin tool. I have run this command from ModelBuilder and from the Data Management Geoprocessing tool. Obviously, after running the tool, it functions as it should by joining one featureclass to another. After running from Geoprocessing, I saved as a Python script. When I create a new script in Pro, then reference the file I just created, it does not create the join. It runs and completes successfully but no effect?

arcpy.management.AddJoin("INFEATURE1", "JOINFIELD1", "INFEATURE2", "JOINFIELD2", "KEEP_ALL")

Is there some backend event like a refresh or response that occurs from a Geoprocessing tool that would not necessarily be reflected in the Python script?

Re: ArcGIS Pro Python AddJoin

DanPatterson — Tue, 12 Jan 2021 22:35:26 GMT

Add Join (Data Management)—ArcGIS Pro | Documentation

This join is temporary.

To make a permanent join, either use the Join Fieldtool or use the joined layer as input to one of the following tools:Copy Features,Copy Rows,Feature Class To Feature Class, orTable To Table.When saving the results to a new feature class or table, theQualified Field Namesenvironment can be used to control whether the joined output field names will be qualified with the name of the table the field came from.

Join Field (Data Management)—ArcGIS Pro | Documentation

is different

Re: ArcGIS Pro Python AddJoin

Darrin_Smith — Wed, 13 Jan 2021 01:07:50 GMT

The Join is intended to be temporary so I believe the AddJoin command is correct. The issue is it does not create the join. The attribute table does not contain the joined fields and the Data Tab-->Joins dropdown is empty i.e. there are no Joins to remove that would normally be listed after AddJoin. Running the command from Python script does nothing. This is the same exact command and syntax that the Geoprocessing tool uses. The only thing I can come up with is must I explicitly define some Derived Output.

Re: ArcGIS Pro Python AddJoin

DanPatterson — Wed, 13 Jan 2021 03:17:04 GMT

The joins are temporary, so you need to specify a new output featureclass/table to persist the join.

The link and notes I posted was for ArcGIS Pro 2.7.

An alternative is to use numpy structured arrays and arcpy's TableToNumPyArray to get a tabular data out of Pro. To bring an array back in you use arcpy's ExtendTable ... That option makes permanent joins and the whole process doesn't even require a toolset or specifying parameters.

TableToNumPyArray—ArcGIS Pro | Documentation

ExtendTable—ArcGIS Pro | Documentation

Re: ArcGIS Pro Python AddJoin

Darrin_Smith — Wed, 13 Jan 2021 14:10:36 GMT

For my workflows, it must be a temporary join with the intent to join, calculate a value, then remove the join. I did find a post from 2019 with the same issue. arcpy.AddJoin Not Working In ArcGIS Pro Script - GeoNet, The Esri Community

I now know the AddJoin command creates the join as expected when run from the Python window. One thing I did notice after running from the Python window was the History results lists the input layer as an Output Layer or View compared to the script results which does not (it reports No Parameters)

Re: ArcGIS Pro Python AddJoin

DanPatterson — Wed, 13 Jan 2021 16:48:54 GMT

That makes the case for using numpy more solid.

Alternately, to use existing tools, do the join but send the output to in_memory, do the calculation, then it gets deleted automatically from memory when you are done

Considerations when using the in_memory workspace—ArcGIS Pro | Documentation

Re: ArcGIS Pro Python AddJoin

DavidBlanchard — Fri, 15 Jan 2021 14:20:11 GMT

If I understand correctly, when you perform the join using the geoprocessing tool or model builder, you get the expected behaviour. However, running the join from a Python script you saved from the geoprocessing tool results, your dataset does not get joined?

Where are you running your script file from, and where are you expecting to see the results? For example, are you running the Python script file by double-clicking it in Windows, and then looking for the result in ArcGIS Pro?

Re: ArcGIS Pro Python AddJoin

Darrin_Smith — Fri, 15 Jan 2021 15:05:01 GMT

Correct. The script does not create the Join, but ModelBuilder and the out of the box geoprocessing tool do.

The script is run within Pro.

The in_layer_or_view is a hosted feature layer.
I have tried variables for the path + layer as well as the simple layer name as found in the map. Both of which demonstrate a successful run (the green checkmark). Below is the script which uses the simple layername:
To confirm it does or does not work, I check two sources.
- One is to open the in layer attribute table which does not contain the join fields
- The other is to look at Data Tab-->Joins pulldown menu where "Remove Join" and "Remove All Joins" are grayed out.
The only difference I see in the Script and Geoprocessor is the Parameters from History where the Script has no parameters but the Geoprocessor notes an updated layer (see attachment)

import arcpy

#Reference map document from within ArcGIS Pro

aprx = arcpy.mp.ArcGISProject('CURRENT')

map = aprx.activeMap

# Process: Add Join (Data Management)

path = "\\\\localpath\Test.gdb\\"

hostedpath = "https://services7.arcgis.com/zHNS16tz3znqN3gM/arcgis/rest/services/TEST_gdb/FeatureServer/0"

feature1 = "SWNODE"

feature2 = "JUNK"

infeature1 = hostedpath

infeature2 = path + feature2

arcpy.AddJoin_management(feature1, "INPUTID", "feature2", "INPUTID", "KEEP_ALL")

Re: ArcGIS Pro Python AddJoin

DanPatterson — Fri, 15 Jan 2021 15:10:19 GMT

Validate Join (Data Management)—ArcGIS Pro | Documentation might be a good addition prior to AddJoin and check its results

Re: ArcGIS Pro Python AddJoin

DavidBlanchard — Fri, 15 Jan 2021 20:17:39 GMT

You say you run the script in ArcGIS Pro. Do you have it setup as a Toolbox script tool. Do you copy-paste it into the Python window? Or do you launch it from the Python window (if so, what command do you use to do that).

Re: ArcGIS Pro Python AddJoin

Darrin_Smith — Fri, 15 Jan 2021 20:42:57 GMT

Yes it is a Toolbox script tool (not a Python Toolbox). I just Run directly from the Toolbox. However, if I copy/paste the entire script into the Python window it creates the join?

Note in my script example above I did remove the quotes from feature2. I inadvertently had that when I copied the code into this post.

Re: ArcGIS Pro Python AddJoin

DavidBlanchard — Mon, 18 Jan 2021 15:39:34 GMT

I can't get it to work either. The script works as expected when copy-pasted into the Python window, but when run as a script, it doesn't apply the join.

Below is the script I modified to try and get it to work (but it did not):

import arcpy in_layer_name = 'Alpha' join_table = 'C:\\Users\\dblanchard\\Desktop\\Python_Join\\Default.gdb\\Beta' join_field = 'JID' # Get the currently active map aprx = arcpy.mp.ArcGISProject('CURRENT') map = aprx.activeMap # Get the in layer from the map in_layer_list = map.listLayers(in_layer_name) if len(in_layer_list) == 1: in_layer = in_layer_list[0] arcpy.management.AddJoin(in_layer, join_field, join_table, join_field, "KEEP_ALL") aprx.save() else: arcpy.AddError('Found {} layers matching the "{}" name when only 1 was expected.'.format(len(in_layer_list), in_layer_name))

I also experienced this issue when using ModelBuilder. It works if I run it with the model open, but if I close the model and run it from the toolbox, it doesn't apply the join.

I would suggest you log a support ticket if you have access to Esri Support. Unfortunately, I cannot log a support ticket on your behalf.

A workaround which may be suitable for you is to use a Task. I have a tried a simple task which has the Add Join tool in it and it works as expected.

Re: ArcGIS Pro Python AddJoin

Darrin_Smith — Tue, 19 Jan 2021 16:07:04 GMT

Thanks for the responses. I will go to Esri support. I am also confirming it is successful as a Task.

One note about your ModelBuilder comment. I understand a Model will not run again after it has been run without first doing a Validate. If I run from the ModelBuilder tab, it will display the attached message. If I simply Run as a geoprocess, it will give me a green check, but does nothing probably because it needs to be validated. My question on the side is, do you know how to automate validating a model? I would love to run a Python script that would loop through all my Models and validate them. Otherwise, I must open them up in Edit mode and Validate--Run.

Re: ArcGIS Pro Python AddJoin

Scott_T_Anderson — Tue, 29 Mar 2022 19:58:26 GMT

Did ESRI ever respond to this issue? I see this problem as well. Frustrating.

Re: ArcGIS Pro Python AddJoin

meloking_PNM — Tue, 26 Jul 2022 23:49:42 GMT

echoing Scott's question. I'm seeing the same issue. Would love to know if/how you resolved it?

Re: ArcGIS Pro Python AddJoin

Anonymous User — Thu, 28 Jul 2022 13:44:57 GMT

The docs 'quietly' say at the end of the last bullet that the join is temporary: "This join is temporary." so you must save the output for it to persist. Maybe try saving the output to a new featureclass?

If you also look at their examples, they all include a Copy Features method at the end.

I do think they should emphasize that the join is temporary and you must save it for it to last.