idea Provide ability to create new ArcGIS Pro projects from Python in ArcGIS Pro Ideas

Create new Map Document (*.mxd) using ArcPy

GraemeBrowning — Tue, 12 Feb 2013 23:24:24 GMT

I know that arcpy.mapping was not designed to author new objects - http://help.arcgis.com/en/arcgisdesktop/10.0/help/index.html#//00s30000006s000000 - but I wish that it had been and would like to see ArcPy enhanced to be able to create a new map document.

Re: Create new Map Document (*.mxd) using ArcPy

ChrisFox — Wed, 13 Feb 2013 18:30:31 GMT

What if you had a blank MXD available with the tool or script that you just created a copy from and did what you needed to do?

Re: Create new Map Document (*.mxd) using ArcPy

GraemeBrowning — Wed, 13 Feb 2013 23:18:41 GMT

If that blank MXD was part of the ArcGIS install then I would consider it a solution but if you mean post-install having to ensure that one is made available on every machine my code gets run on then to me that's a workaround.

Its a shame the code below does not work - perhaps arcpy.mapping.MapDocument() can be enhanced to allow opening of the Normal.mxt?

import arcpy

mxd = arcpy.mapping.MapDocument(r"C:\Users\Graeme\AppData\Roaming\ESRI\Desktop10.1\ArcMap\Templates\Normal.mxt")
mxd.saveACopy(r"C:\temp\test.mxd")

Re: Create new Map Document (*.mxd) using ArcPy

ChrisFox — Thu, 14 Feb 2013 18:21:34 GMT

At 10.0 and 10.1 you will find many MXDs are available with the install at:

<ArcGIS Desktop Install>\MapTemplates

This gives you all sorts of MXDs with different layout sizes and orientation. In addition, depending on how you are sharing your code, if you are building a python add-in it is possible to package data including a blank MXD along with your add-in:

http://resources.arcgis.com/en/help/main/10.1/#/Essential_Python_add_in_concepts/014p0000001p000000/

Re: Create new Map Document (*.mxd) using ArcPy

GraemeBrowning — Fri, 15 Feb 2013 00:52:36 GMT

Thanks Chris

Those two recommendations should provide good workarounds (even a virtual solution).

However, it will probably just shift the blocking point for me to being why can't new layout elements and other objects like grids and graticules be created using ArcPy?

Re: Create new Map Document (*.mxd) using ArcPy

ChrisFox — Fri, 15 Feb 2013 17:40:16 GMT

Yes, unfortunately those are just not implemented. We did add the ability at 10.1 to clone a text or graphic element in the layout. So if one already exists you can clone a copy it and modify some properties.

Re: Create new Map Document (*.mxd) using ArcPy

GraemeBrowning — Wed, 20 Feb 2013 02:49:06 GMT

Cloning text and graphic elements so properties can be modified is certainly a help so thanks for reminding me of them.

The biggest one for me is not being able to change intervals on existing graticules using ArcPy - hopefully the ArcGIS Idea related to that will continue to attract votes.

Re: Create new Map Document (*.mxd) using ArcPy

SachinKanaujia — Fri, 28 Mar 2014 18:37:30 GMT

A must have !!!

Re: Create new Map Document (*.mxd) using ArcPy

maxsquires2 — Thu, 08 Aug 2019 20:09:59 GMT

sources:

arcpy - Seeking Python script for creating .mxd files? - Geographic Information Systems Stack Exchange

pip - Installing python module within code - Stack Overflow

python:

import arcpy
import subprocess
import sys

def install(package):
subprocess.call([sys.executable, "-m", "pip", "install", package])

install('comtypes')

import comtypes,os

def CreateMXD(path):
GetModule('esriCarto.olb')
import comtypes.gen.esriCarto as esriCarto
pMapDocument = CreateObject(esriCarto.MapDocument, esriCarto.IMapDocument)
pMapDocument.New(path)
pMapDocument.Save() #probably not required...

def GetLibPath():
""" Get the ArcObjects library path

It would be nice to just load the module directly instead of needing the path,
they are registered after all... But I just don't know enough about COM to do this

"""
compath=os.path.join(arcpy.GetInstallInfo()['InstallDir'],'com')
return compath

def GetModule(sModuleName):
""" Generate (if not already done) wrappers for COM modules
"""
from comtypes.client import GetModule
sLibPath = GetLibPath()
GetModule(os.path.join(sLibPath,sModuleName))

def CreateObject(COMClass, COMInterface):
""" Creates a new comtypes POINTER object where
COMClass is the class to be instantiated,
COMInterface is the interface to be assigned
"""
ptr = comtypes.client.CreateObject(COMClass, interface=COMInterface)
return ptr

if __name__=='__main__':
#testing...
arcpy.SetProduct('arcview')
filepath='c:/admin/testing123.mxd'
if os.path.exists(filepath):os.unlink(filepath)
CreateMXD(filepath)

Provide ability to create new ArcGIS Pro projects from Python

MaryGraceMcClellan — Thu, 25 Apr 2024 19:38:17 GMT

I'm creating a script that will convert all of my MXDs to APRXs, and I find it extremely inconvenient that I can't create a new blank project from scratch form within ArcGIS Pro. This utility would make switching to ArcGIS Pro so much easier, along with the ability to create blank toolboxes.

Edited to add: @Rhys-Donoghue posted a good workaround for this issue if anyone is interested.

Re: Provide ability to create new ArcGIS Pro projects from Python - Status changed to: Closed

JeffBarrette — Fri, 08 Jul 2022 22:10:13 GMT

We can NOT implement this idea with arcpy/arcpy.mp. Creating a new project requires a "restart" and because Python gets loaded after the project is being opened, its a bit of a catch-22. For a similar reason, there are some project options that can't be changed using arcpy.mp because the project needs to be restarted after a change is made.

Jeff - arcpy.mp and Layout teams.

Re: Provide ability to create new ArcGIS Pro projects from Python

Rhys-Donoghue — Mon, 26 Sep 2022 05:09:46 GMT

@JeffBarrette and @MaryGraceMcClellan:

FYI, I have this working. For one of my clients, I had to migrate hundreds of MXDs to ArcGIS Pro, and move their locations. This is how I did it:

Create a blank aprx and save it to a temporary location, e.g. C:\temp\blank.aprx
For each MXD, import it into the aprx - e.g. aprx.importDocument(mxd)
Save the aprx to the new location - e.g. aprx.saveACopy(new_aprx)
Remap the datasources
Check the datasources were mapped correctly and run a few other validation tests

It only took half an hour or so to write the script, and then took a bit longer to test and make changes to handle exceptions. I didn't have any issues with the new aprxs.

@MaryGraceMcClellan if you still need help with this, let me know and I will see if I still have a copy of my script, or I can rewrite the script for you when I get a chance.

Re: Provide ability to create new ArcGIS Pro projects from Python

MaryGraceMcClellan — Wed, 12 Oct 2022 19:12:23 GMT

@Rhys-Donoghue -- thank you for the follow up! I actually ended up doing something similar within my script if memory serves.

Re: Provide ability to create new ArcGIS Pro projects from Python

Rhys-Donoghue — Wed, 12 Oct 2022 21:53:27 GMT

@MaryGraceMcClellan - awesome. I have hundreds of useful scripts like these. I will start putting them online when I get a chance.

Re: Provide ability to create new ArcGIS Pro projects from Python

FredSpataro — Mon, 15 Apr 2024 20:25:04 GMT

@Rhys-Donoghue I came up with about the same process... however one thing i'm noticing is that the 'projects home folder' is still mapped to the original 'folder of the blank aprx'. Did you figure out a way to remap this?

Re: Provide ability to create new ArcGIS Pro projects from Python

JeffBarrette — Tue, 16 Apr 2024 15:59:34 GMT

@FredSpataro there is an ArcGISProject.homeFolder property. In fact when trying to rebuild a project using the techniques above by importing into a blank project, there are many other items to consider.

ArcGISProject.databases / updateDatabases

ArcGISProject.defaultGeodatabase

ArcGISProject.defaultToolbox

ArcGISProject.folderConnections / updateFolderConnections

ArcGISProjec.homeFolder

ArcGISProject.styles / updateStyles (Pro 3.3)

ArcGISProject.toolboxes / updateToolboxes (Pro 3.3)

ArcGISProject.updateConnectionProperties

We are considering creating New Project but there are some technical hurdles we need to resolve.

Jeff - arcpy.mp team

Re: Provide ability to create new ArcGIS Pro projects from Python - Status changed to: Under Consideration

JeffBarrette — Tue, 16 Apr 2024 16:01:17 GMT

This is functionality we would like to provide in the arcpy.mp API but need to overcome a few technical hurdles.

Re: Provide ability to create new ArcGIS Pro projects from Python

FredSpataro — Tue, 16 Apr 2024 16:24:13 GMT

@JeffBarrette Thanks! Obviously this is not a normal type thing but now that i'm working thru it, I can see a lot of potential uses. Couple other thoughts:

* It would be nice to have a similar method to ConvertLayoutFileToLayout for just the MAPX file. Seems like this function already does the work since it imports the Layout and Map... why can't I do the same with just the map? This technique is really useful for server-side geoprocessing services and the pagx/mapx files are easy to handle and keep in source control

* I'm using 3.1.x right now (due to 11.1 at the Portal/Server level) and the .database and .updateDatabases isn't available until 3.2 ... took me a bit to figure out why i kept getting an error on thsoe.

* I was able to update the homeFolder, default toolbox, default geodatabase using the specific properties you mentioned. However it leaves references to the original atbx and gdb in the project. Not a huge deal, someone can clean those open when they first open the project manually or otherwise not a big deal. The database one probably cleans up when you use the updateDatabases() method but I'm not seeing anything that allow you to remove the toolbox. removeItem() or a updateToolboxes method is probably needed as well?

Re: Provide ability to create new ArcGIS Pro projects from Python

rhys-kdrm — Tue, 16 Apr 2024 22:40:22 GMT

@FredSpataro as @JeffBarrette mentioned above, this is how I would do it.

Re: Provide ability to create new ArcGIS Pro projects from Python

MErikReedAugusta — Thu, 10 Apr 2025 15:28:55 GMT

Stumbled upon this Idea today while trying to figure out how to initiate an APRX from Python, and was disappointed to see it's not currently possible. I was also especially disappointed to see that almost all of the focus was based on the need to convert MXD to APRX, because of the approaching final sunset point of ArcMap and the decreasing utility of such a function.

Given that, I thought it might be helpful to provide two parallel use cases for the benefit of @JeffBarrette and the ESRI team that would still stand completely irrespective of ArcMap's status (since our team is fully on ArcPro, already) and help give reason for this functionality to come to arcpy.mp or the CIM or something similar:

Use Case 1:

Our team periodically receives requests for maps of sections of our stormwater system. These are nearly the exact same map every time, with only the extents changing, so I built an APTX for us all to use for consistency & speed. Our current workflow:

Open the Excel sheet where we track our projects, generate unique Project IDs, and determine the correct server location to save the project file(s).
Create a work order in our work order tracking system for the public record
Create a new Pro project based on the team APTX, based on the Project ID & server location from Step 1.
Navigate to the requested Area of Interest and set the requisite definition query(-ies) in our Parcel and/or Road datasets to match the request.
Output the final PDF and send it to the client
Update the work order from Step 2 & close out the job.

The two big problems we have with this workflow are Steps 1, 3, & 4. First, that AOI data never makes it anywhere outside that project, so it's difficult to do things like analyze hot spots of map requests. Second, the Excel project sheet has gotten quite unwieldy and was never supposed to be the de facto database that it's become, so I thought I'd combine Steps 1, 3, & 4 into a single step inside ArcGIS Pro by creating a "Master Project Database" APRX.

The thought was that we'd pop open that master project, designate the AOI, and then trigger a script that would go create a second APRX we're actually going to be working in to produce the map. That way, all of our map requests and other projects are now in a central, spatially-aware and queryable database. Sadly, this is apparently not possible with the current arcpy.mp library, based on this thread. In theory, we could still do the master APRX, but all the steps creating the secondary APRX would have to be manual operations and prone to quite a bit of confusion and error among some of our team.

Use Case 1b/2:

The next use case is partially an extension of the above and partially a separate use case. That same Excel database that tracks our map requests also tracks our internal team projects. They're divvied up in a sufficiently similar way to the map requests that they work best in the same database, but they also have a number of minor differences, which added to the complexity of the Excel database. The workflow is basically the same as above, but without the work order tracking system, and with a wider variety of APTX file setups we might be referencing as the baselines of our analysis work, based on project needs.

While the process is largely similar, the need is in many ways greater, because of the value in adding a spatial component to our project database. But having to do a manual process involving multiple APRX files is not currently feasible or reasonable the way a partially-automated process could have been.

Based on my understanding of the "workaround" mentioned in here, it likely wouldn't work for either of these use cases, because avoiding "straggler" linkages in things like the Styles & Toolboxes would potentially be a tedious problem. We're already dealing with that with an empty nonsense GDB that's stored itself in the APTX, as discussed in this other Ideas post.