- \n"
]
}
],
- "source": [
- "itm = arcgis.gis.Item(gis,itemID)\n",
- "print(itm)\n",
- "tmpdir = tempfile.TemporaryDirectory()\n",
- "download_folder = tmpdir.name\n",
- "savedZip = itm.download(save_path=download_folder)"
- ]
+ "metadata": {}
},
{
"cell_type": "markdown",
- "metadata": {},
"source": [
"Extract the ZIP file to an *`_extracted`* folder in the download location. This *`_extracted`* folder is where the updated media files will be copied and rezipped later on. "
- ]
+ ],
+ "metadata": {}
},
{
"cell_type": "code",
"execution_count": 5,
- "metadata": {},
- "outputs": [],
"source": [
"def extractZIP(filename,folder):\n",
" zfile = zipfile.ZipFile(filename)\n",
" zfile.extractall(folder)\n",
"\n",
"extractZIP(savedZip, os.path.join(download_folder + \"/_extracted/\"))\n"
- ]
+ ],
+ "outputs": [],
+ "metadata": {}
},
{
"cell_type": "markdown",
- "metadata": {},
"source": [
"Copy the updated file to the media folder, replacing the old file. "
- ]
+ ],
+ "metadata": {}
},
{
"cell_type": "code",
"execution_count": 6,
- "metadata": {},
+ "source": [
+ "for file in updated_files:\n",
+ " source_file = os.path.join(source_loc, file)\n",
+ " dest_file = download_folder + \"/_extracted/esriinfo/media/\" + file\n",
+ " shutil.copyfile(source_file, dest_file)\n",
+ " print (file, \" updated to: \", download_folder + \"/_extracted/esriinfo/media/\")"
+ ],
"outputs": [
{
- "name": "stdout",
"output_type": "stream",
+ "name": "stdout",
"text": [
"employees.csv updated to: /tmp/tmpkxv1hpzo/_extracted/esriinfo/media/\n",
"locations.csv updated to: /tmp/tmpkxv1hpzo/_extracted/esriinfo/media/\n"
]
}
],
- "source": [
- "for file in updated_files:\n",
- " source_file = os.path.join(source_loc, file)\n",
- " dest_file = download_folder + \"/_extracted/esriinfo/media/\" + file\n",
- " shutil.copyfile(source_file, dest_file)\n",
- " print (file, \" updated to: \", download_folder + \"/_extracted/esriinfo/media/\")"
- ]
+ "metadata": {}
},
{
"cell_type": "markdown",
- "metadata": {},
"source": [
"Delete the ZIP file you downloaded previously. This will prevent any namespace issues and ensure the process of zipping and uploading the updated survey goes smoothly. "
- ]
+ ],
+ "metadata": {}
},
{
"cell_type": "code",
"execution_count": 7,
- "metadata": {},
+ "source": [
+ "os.remove(savedZip)\n",
+ "print (\"Old ZIP file deleted from: \" + download_folder)"
+ ],
"outputs": [
{
- "name": "stdout",
"output_type": "stream",
+ "name": "stdout",
"text": [
"Old zip file deleted from: /tmp/tmpkxv1hpzo\n"
]
}
],
- "source": [
- "os.remove(savedZip)\n",
- "print (\"Old ZIP file deleted from: \" + download_folder)"
- ]
+ "metadata": {}
},
{
"cell_type": "markdown",
- "metadata": {},
"source": [
"## Upload updated survey\n",
"\n",
"Zip the updated survey and place it in the download folder you defined previously. \"The code below extracts the survey title from the survey properties and passes it into the file name for the ZIP file."
- ]
+ ],
+ "metadata": {}
},
{
"cell_type": "code",
"execution_count": 8,
- "metadata": {},
+ "source": [
+ "zipFileName = surveyProp['title']\n",
+ "updateZip = shutil.make_archive(zipFileName, 'zip', download_folder + '/_extracted/')\n",
+ "print (updateZip)"
+ ],
"outputs": [
{
- "name": "stdout",
"output_type": "stream",
+ "name": "stdout",
"text": [
"/arcgis/EmployeeForm.zip\n"
]
}
],
- "source": [
- "zipFileName = surveyProp['title']\n",
- "updateZip = shutil.make_archive(zipFileName, 'zip', download_folder + '/_extracted/')\n",
- "print (updateZip)"
- ]
+ "metadata": {}
},
{
"cell_type": "markdown",
- "metadata": {},
"source": [
"Upload the new ZIP file and update the form item with the new media folder content. For more information on the update property of items please visit this link."
- ]
+ ],
+ "metadata": {}
},
{
"cell_type": "code",
"execution_count": 9,
- "metadata": {},
+ "source": [
+ "itm.update({},updateZip)"
+ ],
"outputs": [
{
+ "output_type": "execute_result",
"data": {
"text/plain": [
"True"
]
},
- "execution_count": 9,
"metadata": {},
- "output_type": "execute_result"
+ "execution_count": 9
}
],
- "source": [
- "itm.update({},updateZip)"
- ]
+ "metadata": {}
},
{
"cell_type": "markdown",
- "metadata": {},
"source": [
"Clean up the intermediate data. This process deletes the updated ZIP file as well as the extracted folder containing the unzipped survey content."
- ]
+ ],
+ "metadata": {}
},
{
"cell_type": "code",
"execution_count": 10,
- "metadata": {},
+ "source": [
+ "tmpdir.cleanup()\n",
+ "print (\"Temp folder deleted from: \" + download_folder)\n",
+ "# print (zipFileName + \" successfully updated with \" + source_file + \" and uploaded to your organization!\")\n",
+ "print (zipFileName + \" successfully updated with \" + ' & '.join(map(str, updated_files)) + \" and uploaded to your organization!\")"
+ ],
"outputs": [
{
- "name": "stdout",
"output_type": "stream",
+ "name": "stdout",
"text": [
"Temp folder deleted from: /tmp/tmpkxv1hpzo\n",
"EmployeeForm successfully updated with employees.csv & locations.csv and uploaded to your organization!\n"
]
}
],
- "source": [
- "tmpdir.cleanup()\n",
- "print (\"Temp folder deleted from: \" + download_folder)\n",
- "# print (zipFileName + \" successfully updated with \" + source_file + \" and uploaded to your organization!\")\n",
- "print (zipFileName + \" successfully updated with \" + ' & '.join(map(str, updated_files)) + \" and uploaded to your organization!\")"
- ]
+ "metadata": {}
}
],
"metadata": {
@@ -310,4 +310,4 @@
},
"nbformat": 4,
"nbformat_minor": 4
-}
+}
\ No newline at end of file
diff --git a/Work with Reports/create_reports_using_the_arcgis_api_for_python.ipynb b/Work with Reports/create_reports_using_the_arcgis_api_for_python.ipynb
index c0029e1..c98ff79 100644
--- a/Work with Reports/create_reports_using_the_arcgis_api_for_python.ipynb
+++ b/Work with Reports/create_reports_using_the_arcgis_api_for_python.ipynb
@@ -2,131 +2,130 @@
"cells": [
{
"cell_type": "markdown",
- "metadata": {},
"source": [
"# Create reports using the ArcGIS API for Python"
- ]
+ ],
+ "metadata": {}
},
{
"cell_type": "markdown",
- "metadata": {},
"source": [
- "\n",
- "\n",
- "ArcGIS Survey123 reports are an effective way to quickly visualize, interpret, and share survey responses. Reports use a template you can personalize, that's applied to your survey results and shared as either a Microsoft Word or PDF document. \n",
- "\n",
- "It's common to deploy a webhook as an automated process to create and share reports with survey results. Although, using a third party webhook provider may not be a feasible workflow due to organizational or security policies. This is where the ArcGIS Survey123 module in the ArcGIS API for Python can be used to acheive a similar goal.\n",
- "\n",
- "This sample notebook demonstrates ways you can use the ArcGIS Survey123 module to work with reports and covers the following functionality: \n",
- "\n",
- "* Generate a default report template\n",
- "* Identify report templates associated with a survey\n",
- "* Generate a single report\n",
- "* Generate multiple reports\n",
- "* Generate multiple reports and save to your organization\n",
- "* List saved reports\n",
- "\n",
- "
The Survey123 report service is an ArcGIS Online Premium service. It takes 0.5 credits per survey report generated. For more information, see the
Understand credits documentation.
The Survey123 report service is an ArcGIS Online Premium service. It takes 0.5 credits per survey report generated. For more information, see the
Understand credits documentation.
This parameter is required in order to upload your report to your organization. However, the name of your report or code sample will default to survey_name_report_unique_ID.
\n",
"\n",
"The code sample can then be shared to a group or publicly so that others can download the ZIP and view the reports."
- ]
+ ],
+ "metadata": {}
},
{
"cell_type": "code",
"execution_count": 7,
- "metadata": {},
+ "source": [
+ "import datetime\r\n",
+ "nowstring = datetime.datetime.now().strftime(\"%Y%m%d%H%M%S\")\r\n",
+ "batch_reports = survey_by_id.generate_report(templates[0], report_title=\"Test_{0}\".format(nowstring))\r\n",
+ "print(batch_reports)"
+ ],
"outputs": [
{
- "name": "stdout",
"output_type": "stream",
+ "name": "stdout",
"text": [
"- \n"
]
}
],
- "source": [
- "import datetime\n",
- "nowstring = datetime.datetime.now().strftime(\"%Y%m%d%H%M%S\")\n",
- "batch_reports = survey_by_id.generate_report(templates[0], report_title=\"Test_{0}\".format(nowstring))\n",
- "print(batch_reports)"
- ]
+ "metadata": {}
},
{
"cell_type": "markdown",
- "metadata": {},
"source": [
"\n",
"### List saved reports\n",
"\n",
"Finally, use the `reports` property to list the reports stored in the ArcGIS organizational account from the current GIS connection. This shows all reports that are saved in that named user's content."
- ]
+ ],
+ "metadata": {}
},
{
"cell_type": "code",
"execution_count": 8,
- "metadata": {},
+ "source": [
+ "recentReports = survey_by_id.reports\r\n",
+ "p = [print(t.title) for t in recentReports]"
+ ],
"outputs": [
{
- "name": "stdout",
"output_type": "stream",
+ "name": "stdout",
"text": [
"Manhole_Inspection_report_7844e0\n",
"Tree_Health_Survey_statistic.docx\n",
@@ -244,10 +247,7 @@
]
}
],
- "source": [
- "recentReports = survey_by_id.reports\n",
- "p = [print(t.title) for t in recentReports]"
- ]
+ "metadata": {}
}
],
"metadata": {
@@ -271,4 +271,4 @@
},
"nbformat": 4,
"nbformat_minor": 4
-}
+}
\ No newline at end of file