Un défi courant dans l'administration d'un système ArcGIS Enterprise est la nécessité de documenter et/ou de communiquer autrement sa conception et sa configuration. <\/P>
Typiquement, cela est fait par une personne créant un ou plusieurs diagrammes. Ces diagrammes comportent parfois des erreurs et/ou des omissions. Et, ils perdent facilement leur pertinence à mesure que le système évolue. Le défi sous-jacent est que la documentation du système n'est pas générée par le système lui-même, elle reflète la compréhension d'une personne à un moment donné.<\/P>
GIS Enterprise Reporter est conçu pour aider à relever ce défi en automatisant la création d'artefacts de documentation. Pointez l'outil vers votre ArcGIS Enterprise, avec des identifiants administratifs, et il générera une documentation qui inclut :<\/P>
La documentation est produite au format Microsoft Excel, ce qui facilite le partage, l'analyse et l'annotation.<\/P>
Cet outil est destiné à être utilisé par les administrateurs ArcGIS Enterprise pour comprendre et documenter leurs déploiements système. Il fonctionne mieux s'il est exécuté sous un identifiant qui est également administrateur local de la machine, mais ce n'est pas obligatoire.<\/P>
Veuillez noter que cet outil a été créé pour soutenir les pratiques de conseil Esri Professional Services. En tant que tel, il n'est pas supporté par le Support Technique Esri. Toutes les requêtes émises par l'outil sont prises en charge par les opérations ArcGIS REST API<\/A>. <\/P>Vous pouvez télécharger l'outil ici : https:\/\/github.com\/EsriPS\/gisenterprisereporter<\/A>. Le fichier .zip contient à la fois l'exécutable et la documentation. L'exécutable est un exécutable ".Net Core" qui devrait fonctionner sur tout système d'exploitation Windows contemporain. <\/P>L'exécutable est signé avec un certificat qui n'est pas émis par une autorité de certification publique. Vous pouvez donc recevoir des avertissements (ou restrictions) de votre système d'exploitation à ce sujet. Si c'est le cas, veuillez suivre les directives de votre organisation et les privilèges qui vous sont accordés en travaillant avec les autorités compétentes en sécurité informatique, en important le certificat dans votre référentiel de confiance, ou en utilisant des privilèges élevés pour exécuter l'outil.<\/P>Merci de me contacter, Danny Krouk (dkrouk@esri.com<\/A>) pour toute question ou idée d'amélioration.<\/P>Cet article est destiné à être le premier d'une courte série d'articles sur GIS Enterprise Reporter. Les articles futurs aborderont des sujets tels que l'exécution de l'outil, l'interprétation de ses résultats, et la création d'analyses utiles à partir des résultats.<\/P>Article suivant de la série : Exécuter GIS Enterprise Reporter, astuces & conseils<\/A><\/P> <\/P>
Vous pouvez télécharger l'outil ici :
L'exécutable est signé avec un certificat qui n'est pas émis par une autorité de certification publique. Vous pouvez donc recevoir des avertissements (ou restrictions) de votre système d'exploitation à ce sujet. Si c'est le cas, veuillez suivre les directives de votre organisation et les privilèges qui vous sont accordés en travaillant avec les autorités compétentes en sécurité informatique, en important le certificat dans votre référentiel de confiance, ou en utilisant des privilèges élevés pour exécuter l'outil.<\/P>
Merci de me contacter, Danny Krouk (
Cet article est destiné à être le premier d'une courte série d'articles sur GIS Enterprise Reporter. Les articles futurs aborderont des sujets tels que l'exécution de l'outil, l'interprétation de ses résultats, et la création d'analyses utiles à partir des résultats.<\/P>
<\/P>
Thanks for the kind words @PrayagShah. I'm glad the tool is helpful. If you are interested, there is a separate tool, officially supported by Esri, which is catching up to the features of Enterprise Reporter. I hope that, someday soon, it will eliminate the need for Enterprise Reporter (which is not supported by Esri). This is the Configuration Reporter overview: https://www.esri.com/arcgis-blog/products/arcgis-enterprise/administration/introducing-the-configuration-reporter-for-arcgis-enterprise.
Thank you so much, Danny — this is amazing! I had already deployed the Enterprise environment and kept all the documentation notes with me, but this tool still provided extra information that I had forgotten (haha). It really helped me a lot. Thanks again for creating it!
I'm glad the tool is useful for you @RickeyFight 🙂
@DannyKrouk Thank you for this tool. I ran it and created a simple local html that allows for the search for layers and webapp titles. That way others in our dept can look up layers or webapps if they need service information.
@iprameshwari - Thank you for the kind words. For reasons that are not known to me, ArcGIS Server puts the layer id's in the REST services API but not the REST admin API. This tool only accesses the admin API. So, unless the product developers put the layer id's in the admin API, then it would not be in the foreseeable future of this tool. Sorry about that. - Danny
Hi @DannyKrouk! thanks for creating this awesome tool! it helped me a lot in doing assessment contents of our organization's Portal 😀
I've been searching thoroughly but I haven't found any columns in Portal Content and Server Admin's excel that represent the serviceLayerID (like MapServer/3). Is there anything like so or probably it's going to be improved in the future?
@DeanMoiler Thank you for the kind words. If you have enhancement ideas (or defects), please be in touch.
Thanks for creating this tool @DannyKrouk, I make use of it quite a bit and it's brilliant!
@LHo I see. So, you don't want *objects*, you want *classes*. I have no plans to generate classes from GIS Enterprise Reporter. Sorry.
Hi @DannyKrouk
I was more thinking a kind of adaptor or ingestion function to create at least a subset of the objects, properties, methods etc available in the arcgis python api.
For example, this works when we connect directly to a portal via https.
import arcgisgis = arcgis.GIS(url, u, p)user = gis.users.get(username)groups = user.groupsBut we have a lot of the info in the GIS Reporter output excel files / artifacts, and we could potentially use a lot of the same code if we create similar objects. Exampleimport arcgis_from_reporter as repgisgis = repgis.GIS(admin_excel_file, content_excel_file)user = gis.users.get(username)groups = user.groups
@LHo If you are asking about creating JSON objects, this is what the "migrator artifacts" button does. Be careful what you ask for ... it writes a lot of files.
Hi Danny
Thanks for providing this tool!
Just wondering are you aware of any tool that can convert these excel output files into dummy arcgis python api objects? This way we could reuse python using arcgis code without having to rely on https.
@TracyMoy I'm glad the tool is useful for you. Thank you saying so. 🙂
We just used the tool on our system. Thank you so much! Awesome tool!
Thanks Danny
I will give it a try, thanks for your help.
@ShaunGibbins - You may be interested in the "Services datasets" sheet in the Admin Excel. Each row is a unique combination of service, workspace, and dataset. So, you can see not just which repositories are referenced by a service, but also which datasets. "Manifest workspace info" also reports the repositories referenced by services (slightly different details). The question of *registered* repository is much trickier. It is not always possible to relate the repositories used by services to those which are registered (for a variety of reasons). But, "Registered Workspace Cross References" attempts to do that.
Is it possible to determine which registered datastore is in use by each service? I know I can get which database is in use from the manifest but its the datastore name I am after.I have inherited a bit of mess to unravel where datastores have been registered with different names but reference the same database, so I want to identify services that are using the spurious datastores, republish them with the correct datastore then get rid of the mess once there are no services using them.
Hello @AkmalJasman - I believe queue store is a "quiet default" at a certain release of ArcGIS Enterprise (in the Data Store). It is not another name for the Graph Store (you can add a Graph Store also). I've never seen an option to configure it (or to leave it out of the configuration). I don't know what it does. And, I've not seen any documentation that explains. Sorry that I cannot offer any clarity. To me, it is just a fact reported by the API.
I've run the enterprise reporter in purpose to understand our customer environment deployment. While we analyze the report, we find out one of the repositories categorized as "queue store" just below the relational store. Is queue store being another name for graph store?
@dgiersz_cuyahoga Thanks for the update. The app should run on Win11. If you continue to have problems after your re-download, please reach out *with screen captures* ... here or via email (dkrouk@esri.com).
Will there be a Windows 11 version released? I get a 'This app can't run on your PC' warning when starting the executable. I am using Windows 11 Enterprise.
***Edit*** My bad, I think my exe was corrupted somehow. Downloading the latest version corrected my issue. Keep up the great work!
@DannyKrouk
That is exactly what I needed. Appreciate the info!
@Daniel_C Thank you for the kind words!There is a separate executable called "er.exe" which can be used for scheduled execution of GIS Enterprise Reporter. That's kind of an historical accident. The code called by the executable is the same as that which gets called by the GUI.Section #6 in the Word document that comes with the tool discusses how to use the command-line interface. Essentially, you put your parameters in a json file and provide the file as an argument to the command-line. Here's a partial screen capture from that section of the doc:
Please note that AsynchronousExecution is no longer supported (i.e. the parameter should either be absent or the value should be "false" if it is present) ... another historical accident (sorry).Does this help?
@DannyKrouk This tool is amazing and has saved me a ton of time tracking dependencies on services/databases when we migrated our org to a new server stack last year that had a totally revamped architecture.
I would like to use the output from this this as the source data for some Power BI dashboarding that we are looking to develop to give an admin perspective of our Prod/Test/AGOL environments. The part I'm trying to work though is figuring out how to set this up as a scheduled task. I have been looking at Python subprocess and I can open the program but am struggling with the arguments. Do you have any advice for scheduling Enterprise Reported to run on an interval.
@SteveMcCarthy - Thanks for the idea (and the kind sentiment). I have worked with the ArcGIS Monitor team to help them plan their functionality roadmap as it relates to eGDBs. I had built extensions for the "classic" ArcGIS Monitor edition. I believe their design intent was to include much of what those extensions did in the core product. I have to confess that I have not followed what has come to fruition. But, it does seem like there has been interest and intent. I am sure that, if you have specific ideas, that they would appreciate hearing them. 🙂
@DannyKrouk Has there been any thought as to adding this amazing tool to ArcGIS Monitor? It would be a great fit based on the permissions required to run ArcGIS Monitor. The ArcGIS Monitor Excel Report tool and the would Enterprise Reporting Tool really compliment each other.
Great job on this tool!
Thank you,
Steve
@cboyerTucson Ha! Thanks. Virtual cookies are almost as good as real ones! 😉
Dearest @DannyKrouk , you have just saved me HOURS and HOURS of work. If I could bake you a box of cookies, you'd best believe I would. Thank you so so much for your lightning quick and immeasurably helpful reply and work on this incredible product. 🙏
@cboyerTucson Thanks for the kind words. You might be looking for:
Which gives you this kind of thing:
If that's not quite what you're after, perhaps you can tell me what is missing relative to your interests?Thanks 🙂
Hello! Thank you so much for providing this very powerful tool, we have used it quite a lot. I have a (hopefully) simple question: our organization is attempting to track down what EGDB connections were used when the map services on our stand-alone ArcGIS Server sites were published. I know I can find this information in the \arcgisserver\directories\arcgissystem\arcgisinput\[Folder]\[xyz.MapServer]\extracted\manifest.xml file, however, I am curious if Enterprise Reporter is capable of collecting all of this information into a single source? I have briefly examined its outputs and I definitely see registered data stores, but I have been unable to identify specific service database connections. Any advice is very appreciated 🙂 Thank you, kindly.
Les membres connectés peuvent publier, suivre les mises à jour, et plus encore. Nouveau ici ? Inscrivez-vous gratuitement.
Find useful guides, FAQs, and documents to help you navigate and make the most of Esri Community.
