topic Re: AddIn behaviour change in ArcMap 10.4 in Developers Questions

AddIn behaviour change in ArcMap 10.4

DaveSunerton-Burl — Thu, 07 Jul 2016 13:55:34 GMT

Hi - I'm just trying to get something looked at by ESRI support :-s and it would be fantastic to get some other confirmation/denials on the issue I've found. It seems that any AddIn which contains folders (i.e. there is some kind of folder structure within the Install area of the add in file) will fail to load up in ArcMap 10.4. It's always been fine in previous versions, and I even noticed that the standard MapCenter AddIn hasn't got folders in since version 10.4 - and always has had up to 10.3.

Attached is an extremely minimal (68kb) AddIn/procedure to show the problem. If anyone developing AddIns and using/moving to ArcMap 10.4 could just try this out on your own AddIn for some extra confirmation I'd be extremely grateful. Just add a folder inside the "Install" bit of your AddIn (can be empty) and see if it fails after the next upgrade....

This happens with both Java and .NET addins.

Re: AddIn behaviour change in ArcMap 10.4

DanPatterson_Retired — Thu, 07 Jul 2016 14:44:33 GMT

From the link here, for 10.4 Essential Python add-in concepts—Help | ArcGIS for Desktop folder structure is still in use

Re: AddIn behaviour change in ArcMap 10.4

DaveSunerton-Burl — Thu, 07 Jul 2016 15:37:24 GMT

Have you actually tried it though? I haven't tried it with a Python addin, just with .NET and Java (which both fail if there are any folders within the Install folder).

Re: AddIn behaviour change in ArcMap 10.4

DaveSunerton-Burl — Thu, 07 Jul 2016 15:56:46 GMT

I've not used Python before, but I just downloaded ESRI's wizard thing and built a skeleton Python AddIn. It suffers from the same problem. With subfolders inside the Install folder, the AddIn fails to load up (or show in any way) within ArcMap. Given that the Python documentation specifically mentions having subfolders for data etc. I'm thinking this is a bug rather than a change of behaviour.

Re: AddIn behaviour change in ArcMap 10.4

DanPatterson_Retired — Thu, 07 Jul 2016 16:22:59 GMT

you should submit a bug report. I don't use add-ins since I have no use for them in my workflow. I prefer, and only need, conventional python toolboxes and tools. Outside of that pure python and its brothers and sisters in the scipy stack

Re: AddIn behaviour change in ArcMap 10.4

DaveSunerton-Burl — Thu, 07 Jul 2016 18:52:51 GMT

Yes, of course I have done that - I was just asking here if anyone else could confirm what I've found - you never know when something is machine-specific. Thank you for reminding me about Python though.

Re: AddIn behaviour change in ArcMap 10.4

RebeccaStrauch__GISP — Thu, 07 Jul 2016 23:46:19 GMT

I know you are not asking about Python adding, but I just downloaded and tested my Python addin Python addin for data inventory and “broken-link” repair. and tested it on a 10.4.1 machine that did not have it installed effort, and it worked without any issues. I just tested the first tool, fgdb inventory.

if it makes a difference, this addin works in ArcCatalog, not ArcMap.

Re: AddIn behaviour change in ArcMap 10.4

DaveSunerton-Burl — Fri, 08 Jul 2016 08:00:41 GMT

Thanks, I'll have a look to see if ArcCatalog manages to load up Java/.NET Addins correctly - I tried your Python one and it comes up fine in ArcCatalog on my machine too.

Re: AddIn behaviour change in ArcMap 10.4

DaveSunerton-Burl — Fri, 08 Jul 2016 08:58:29 GMT

...interestingly though, if I open up the addin and add another folder within Install (alongside your scripts folder) and increase the version number, it fails to load. Something to do with folders that aren't referenced in the config.xml file maybe? I've still not heard back from ESRI so this is more information for them...

Re: AddIn behaviour change in ArcMap 10.4

RebeccaStrauch__GISP — Fri, 08 Jul 2016 12:06:54 GMT

Just addin a folder would not make a difference in a Python addin. You would have to modify the config.xml and rerun the build to reflect the changes in the .addin file. Then reinstalling while in Catalog wouldn't automatically update unless you either close/reopen, or use the "customize" option an refer to it be file name. I have this written out a little better Tip: Python Addin - getting custom tools/toolbox to work - GPToolDialog

I personally really like the Python addins (which wont work in Pro, at least not as toolbars....toolbox should work) and don't work with the .net or Java addins, some due to preference but realistically because I feel much more comfortable with my Python skills than the others.....for whatever that's worth.

Re: AddIn behaviour change in ArcMap 10.4

DaveSunerton-Burl — Fri, 08 Jul 2016 12:49:06 GMT

Yes, I increased the version number in config.xml and restarted ArcCatalog to get it to update (the esriaddin file is just a ZIP file, so you can open it up and change things). I keep meaning to get to grips with Python generally, but time slips away...

Re: AddIn behaviour change in ArcMap 10.4

RebeccaStrauch__GISP — Fri, 08 Jul 2016 13:12:21 GMT

Although the .addin is just a zip, I thing the script to create the .addin file does more than just zip it...at the very least it tells where the files are to be unzipped. If you run the .addin file after modifying the ".zip", does it add your new folder to the addin install folder? If not, then just adding it to the zip doesn't work.

not that this is the same Python AddIn: How can I package/deploy a custom lib with my python addin? It was my attempt to use different folders at one time, and my conclusion/solution (before anyone responded). Edit: for convenience, adding conclusion here

"I just moved them to the folder with my other scripts (i.e. addin\Install\scripts in my case). Since my tool scripts do not specify a folder, it appears it first looks in the current folder of the calling script, before or if it doesn't find it in the \lib folder. In any case it worked for this addin. "

i have a PowerPoint file loaded somewhere on how I usually go about making the Python addins. It may have been included on the previous like I sent.

If if you still having issues with you addins and ArcGIS 10.4, I would start up a support ticket.

Re: AddIn behaviour change in ArcMap 10.4

DaveSunerton-Burl — Mon, 11 Jul 2016 09:02:04 GMT

So, interestingly, if I take my Java AddIn files (the output before it's packaged into a ".esriAddIn" file) and use the Python script "makeaddin.py" to actually create the package - it works. The working and non-working esriAddIn files contain *exactly* the same thing (they are just ZIP files with a specific structure inside). This leads me to believe that there is some difference in the file/folder encoding or some other low level ZIP-reading mechanism which has changed in version 10.4. It's hard to work out as the contents of the AssemblyCache look exactly the same. So I have a sort-of solution (use the Python script to pack the file) but if anyone else sees this issue and finds a real solution (i.e. some specific ZIP file encoding settings that work) then I'd be happy to hear it - we have an automated build system set up and integrating Python into it is a bit of a pain.

Re: AddIn behaviour change in ArcMap 10.4

RebeccaStrauch__GISP — Mon, 11 Jul 2016 10:33:19 GMT

I would say this is definitely worth reporting to tech support.

Hard to say is it is a bug or "as designed"...maybe it is necessary for use with Pro? As I probably mentioned already, Python .addin files are not, although I think the toolbox tools will work...although some tweaks might be necessary for Python 3.x.

glad you found a work-a-round anyway. You may want to mark this thread as "assumed answered" unless you want to leave it open in case anyone else wants to jump in.

Re: AddIn behaviour change in ArcMap 10.4

DaveSunerton-Burl — Mon, 11 Jul 2016 16:05:12 GMT

So for anyone who finds this thread in the future, here's my real solution....

What with my theory about the ZIP format and ESRI pushing the new(ish) ArcGIS Pro - which is purely .NET - I made the assumption that all or part of ArcMap 10.4 has been re-developed using .NET. I looked into the ZIP support in .NET which, as it turns out, has almost always been terrible. So I tried building the .esriAddIn file (a ZIP file) using a fairly old-fashioned way (where you only store files and not folders, but the file names include a full relative path - it's up to the program reading it to work out what the folders are and to honour the structure) and it worked.

In Java/Ant builds you can do this by adding the filesonly="true" attribute to the ZIP task and making sure the file encoding is UTF-8 (it is by default). I'm assuming that addin files created using a .NET builder will work anyway, as they'll be using the same system to write that ArcMap uses to read. The Python builder works, so it must be using a "files only" format by default.