nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

(IMPLEMENTED) Generate Feature Report directly by URL Parameters

Hussam_AlJabri

I designed two smart forms for my company and leverage the data to be in the dashboards where the end-users could generate the feature reports by configuring the popup in the webmap and adding the URL to generate feature reports.

What I did exactly was using the URL parameters of the report as below:

https://survey123.arcgis.com/surveys/xyz/data?report=templateItemId:xyz;format:pdf;objectIds:all;mergeFiles:nextPage&extent=58.3926,23.5739,58.3966,23.5744&filter=(0.dss_gis_objectid%20is%${dss_gis_objectid})

There might be the possibility to enhance the generating report by URL and adding all the fields in the report panel as a URL parameters of the "report="

report=
Select a template: templateItemId:xyz;
Format: format:pdf;
Choose records to include: objectIds:all;
Output settings: mergeFiles:nextPage;

My sugession to add:

Report name

Save to my ArcGIS account (check or un check)

Generate button

So the users will generate the reports by clicking only on the link through the ArcGIS Dashboards and ArcGIS Field Maps in the popup or any platform!

See the video for more clarification.

Trouver plus de publications taguées avec

Implemented

Status: Implemented

Réponses

OussamaMerhi

Hi.

I am new to this topic. I didn't know from where to start. can you please provide me step by step to integrate it in dashboard.

Thanks in advance.

Blevins_Mark

ZhifangWang

In the June 2024 Update, Survey123 introduced a new report page for generating reports. It looks similar to and has the same capabilities as the report panel on the Data tab, but it excludes other UI elements, so it can be embedded in other pages or apps.

Please feel free to try it out by following the details in this EAC document: New web page for Survey123 report capability.

ZhifangWang

Hi all,

In the June 2024 Update, we will introduce a new report page for generating reports. It looks similar to and has the same capabilities as the report panel on the Data tab, but it excludes other UI elements, so it can be embedded in other pages or apps.

Please feel free to try it out by following the details in this EAC document: New web page for Survey123 report capability.

Any feedback, please feel free to post in the Survey123 Beta Website Feedback forum. Thank you.

MajidAlabrawi1

hi @LouisDECOMBE ,

sure, soon I will share the full solution in GitHub and how to deploy it in enterprise and AGO

i will let you know when its live

LouisDECOMBE

hi @MajidAlabrawi1

i'm interested about your solution in dashboard if you can explain us how you did.

Thank you

MajidAlabrawi1

hi @ZhifangWang , @ChristopherCounsell

actually , i have work on the generating report tool embedded in dashboard the token will be updated directly once you open the dashboard

ChristopherCounsell

@ZhifangWang that would be great.

We've got purpose built web apps and field app surveys. None of our users use the Survey123 website and we don't want them to.

Having the ability to generate reports directly through Esri web apps or by clicking on a link (e.g. in Survey123 Inbox) would be extremely beneficial to our workflows.

ZhifangWang

@MajidAlabrawi1 ,

Thank you for sharing your great work in Dashboard, that is helpful and can inspire our community.

For everyone who is interested in this idea, we are working to build a reusable component for the report service, so it can be configured and embedded into other ArcGIS products (Dashboard, Experience Builder...), as well as a standalone, simple web page (dedicated to generate reports) hosted on Survey123 website.

The new standalone, simple web page can be configured (e.g., by URL parameters) and shared with stakeholders to generate reports easily; it also can manage recently generated reports as the Report panel does on the Data page of the Survey123 website.

Please stay tuned and let us know what else you would like to have for your workflow.

MajidAlabrawi1

hi @LouisDECOMBE ,

grate that it works with you .. i was looking for solution that does not need to update the token every 2 weeks and till data i did not find solution.

thanks,

LouisDECOMBE

yeah, it's great, it worked !

still interested to know how to pass the token in a pop-up of webappbuilder application for exemple. The idea is to put a link in the popup to generate the report

thank

LouisDECOMBE

thank you

for the accesstoken, where i have to generate it? in portal or arcgis server?

Is there a solution so that the user doesn't have to enter a token he doesn't know about, and the simple fact of being connected to portal can suffice?

Thank you

majidalabrawi

Hi @LouisDECOMBE ,

yes i did some modifications. and it works in portal enterprise , but you need to update the token every 2 weeks , i will share the modified code. and just replace where you need to change the ID's and portal url
copy the below and paste it in xhr js file

const estimateBtn = document.getElementById('estimate-btn');
const reportBtn = document.getElementById('report-btn');


const sendHttpRequest = (method, url, data) => {
  const promise = new Promise((resolve, reject) => {
    const xhr = new XMLHttpRequest();
    xhr.open(method, url);

    xhr.responseType = 'json';

    if (data) {
      xhr.setRequestHeader('Content-Type', 'application/json');
    }

    xhr.onload = () => {
      if (xhr.status >= 400) {
        reject(xhr.response);
      } else {
        resolve(xhr.response);
      }
    };

    xhr.onerror = () => {
      reject('Something went wrong!');
    };

    xhr.send(JSON.stringify(data));
  });
  return promise;
};

const estimate = () => {
  let params = new URLSearchParams(document.location.search.substring(1));
  let oid = parseInt(params.get("objectId"));
  let token = params.get("token");
  console.log(oid);
  console.log(token);
  
  sendHttpRequest('GET', 'https://survey123.arcgis.com/api/featureReport/estimateCredits?portalurl=https://geo.********man.com/portal&featureLayerUrl=https://geo.man.com/server/rest/services/Hosted/service_cc2e2ab2544fd4cebdb833ae354/FeatureServer/0&queryParameters={"where": "objectId='+oid+'"}&templateItemId=0f088a**********5a6f48a1f14ee&token='+token).then(responseData => {
	console.log(responseData['resultInfo'].cost);
	//return responseData['resultInfo'].cost
	document.getElementById("estimate_credits").innerHTML = "Estimated credit cost: " + responseData['resultInfo'].cost;
	//return x.innerHTML = responseData['resultInfo'].cost;
	});
  
};


const createReport = () => {
	let params = new URLSearchParams(document.location.search.substring(1));
	let oid = parseInt(params.get("objectId"));
	let token = params.get("token");
	console.log(oid);
	console.log(token);
	sendHttpRequest('POST', 'https://survey123.arcgis.com/api/featureReport/createReport/submitJob', {
	"portalUrl":'https://geo.man.com/portal',
	"utcOffset":'||+04:00',
	featureLayerUrl: 'https://ge*****o.mm*******an.com/server/rest/services/Hosted/service_cc2e2a08b4*********fd49*b833ae354/FeatureServer/0',
	queryParameters: '{"objectIds":"' + oid + '","orderByFields":"||last_edited_date DESC, objectid ASC"}',
	templateItemId: '09f08e66aa6f85********48414ee',
	token: token,
	surveyItemId: '4204632348a8a*******6adcf4a705',
	outputFormat: 'pdf'
	})
		.then(responseData => {
		console.log(responseData);
		checkJobStatus(responseData['jobId'], token);
	})
		.catch(err => {
		console.log(err);
	});

  
};

const checkJobStatus = (jobId, token) => {
	sendHttpRequest('GET', 'https://survey123.arcgis.com/api/featureReport/jobs/' + jobId + '?token='+token+'&portalUrl=https://geo******.******man.com/portal').then(responseData => {
		console.log(responseData);
		document.getElementById("generate_report").innerHTML = responseData['jobStatus'];
		if (responseData['jobStatus'] == 'esriJobExecuting') {
			document.getElementById("generate_report").innerHTML = responseData['jobStatus'];
			setTimeout(checkJobStatus(responseData['jobId'], token), 10000);			
		} else if (responseData['jobStatus'] == 'esriJobSucceeded') {
			console.log(responseData['resultInfo'].resultFiles[0].url);
			// document.getElementById("generate_report").innerHTML = responseData['resultInfo'].resultFiles[0].url;
			document.getElementById("generate_report").innerHTML = "Download Report Here";
			document.getElementById("generate_report").href = responseData['resultInfo'].resultFiles[0].url;
		}
	});	
};	



reportBtn.addEventListener('click', createReport);

LouisDECOMBE

Hi @MajidAlabrawi1 , did you success to user Zachary-Sutherby GitHbu process with Portal Arcgis Enterprise?

If yes, can you explain me with more details please.

Thnak you

MajidAlabrawi1

Hi ,

@r_povilaityte , you can refer to the below link

GitHub - Zachary-Sutherby/Zachary-Sutherby.github.io: host report API test app

there are all what you need by changing some parameters for the online it will work directly and for the enterprise you need to delete anything related to token.

thanks ,

r_povilaityte

@MajidAlabrawi1 ,

looks great! Could you share, how you did that?

MajidAlabrawi1

Hi RubenBenne,

actually i embed a report generator tool using (js and html) so now the end user can generate a report within a dashboard.

you can see downright the report there is a button of creating report.

RubenBenne

Hi @ZhifangWang,

The use cases that I experience are similar to a previous placed comment in this thread:

"...Right now, we have to guide inexperienced and infrequent users through the Survey123 Data page just for generating their reports...that's be such a great addition to automate report generation in an automated way..."

The Survey123 features are broad, but this makes it somewhat overwhelming for the one-time report generator that opens the application.

Report generation with a single click would be amazing to have in web maps, dashboards, experience builder etc. An experience builder widget would only solve the demand for this feature in that specific application. The expansion of possibilities in the URL parameters, such as being able to access the 'generate' button, would be a single implementation that can be used throughout all software components.

Hope this helps in finding use cases.

ZhifangWang

@majidalabrawi ,

We are still evaluating/collecting use cases for this scenario.

Would you mind sharing some info about your workflow? For example:

What is the app the user tries to print a report?
Compared to a dedicated report workflow, e.g. the report panel on the Survey123 Data page or even a report widget in Experience Builder, how can this "click a URL to show a simple web page to generate the report" workflow help?

Note: Based on our current evaluation, it is not suitable to directly generate a report by clicking a URL because it would be difficult to re-download the report if you missed it the first time and also could time out if it takes some time to generate the report. Instead, we are evaluating a new simple web page that can be opened by clicking a URL and on that page, the user can confirm/trigger the report generation, and retrieve/re-download the report file.

Will the above approach work for your workflow?

majidalabrawi

Hi @ZhifangWang

Any update about the Enhancement Number: ENH-000142314

Synopsis: Generate Feature Report directly by URL Parameters in Survey123

BKS

Couldn't agree more that this would be a very beneficial (and I suspect not very difficult) enhancement to implement. Just like @Geoeki , we have inexperienced users and being able to see their data in report form is fantastic, but having to instruct them on how to do so via Data tab in ArcGIS Survey123 website tends to downplay the enthusiasm they have for getting their reports. Some will be intimidated by the Data page on the website. They just want the report.

Per @ZhifangWang options 1 and 2 above, avoiding the need to open Survey123 website data page and simply downloading the report via browser window is necessary to remove users confusion. Leaving them on the Data page for some may be a good idea but for others the confusion will still remain. Thus both choices would be best, but if I had to pick one it would be option 2.

Hope others see the value of this and upvote (via contacting local support).

BKS

Hussam_AlJabri

Great!

I can see now we can add the report name using URL.

Kara_Shindle

Absolutely a need for us. County government, using Survey123 to build forms on existing enterprise feature services. We are converting old databases into GIS, but still need the ability to create printouts for the public who cannot/will not use computers or do not have access to them, but still need the information from the databases.

I see now that I can overwrite a report if I have it saved in my ArcGIS Online Content, but being able to have URL parameters would be lovely. I could then imbed that in a button in an experience builder. I have users who need certain administrative rights to certain applications we develop for them, but they do not want (& I don't want them) to export reports from Survey123.

In my instance, we are moving an Access database of county human services into a geodatabase for creating a searchable experience builder application. But we still need the reports to be generated as needed by less technical users. Instead of having to have my staff do that or give licensing out to those who don't need it or don't want to pay for it, I could use a URL to generate the reports.

ZhifangWang

Hi @Hussam_AlJabri ,

Thanks for checking. ENH-000142314 is still under consideration and we don't have a solid plan for it yet.

If this is important to your workflow, please consider raising a defect escalation to Esri Support Service for ENH-000142314 by providing business justifications. This can escalate the priority of this feature in our release plans.

Thanks,

Zhifang

Hussam_AlJabri

@IsmaelChivite, any update?

Enhancement Number: ENH-000142314

Hussam_AlJabri

Hello @ZhifangWang

Any update about the Enhancement Number: ENH-000142314

Synopsis: Generate Feature Report directly by URL Parameters in Survey123

Hussam_AlJabri

Hello @ZhifangWang

Any update about the Enhancement Number: ENH-000142314

Synopsis: Generate Feature Report directly by URL Parameters in Survey123

jessneuner

This would be useful for us also. Our Neighborhood Enhancement team will be implementing the Special Events permitting solution and have a need to print the applications. Rather than sending them to yet another app for one workflow, it would be handy if they could print the application details directly from the Crowdsource Manager app where they will be doing the review.

Geoeki

Hi @ZhifangWang fewer clicks is always better...so clearly suggestion 2, if there are enough parameters available to actually define what features should go into the automatically generated report.

When following on the suggestion by Hussam, that'd be this parameter: Choose records to include: objectIds:all;

It shouldn't be just all features, but offer a choice on what features (or even layers) you'd like to include: 1.) all features on a specific feature layer, 2.) all features on the layer currently available due to filter settings, 3.) all features currently in the map view, 4.) all features from a table/map selection.

ZhifangWang

Hi @Hussam_AlJabri , @Geoeki

Can I ask in your workflow "let another user generate a report automatically", which one of the following is better?

Click a link outside the Survey123 website, open the Data page and generate the report automatically, then the user leaves the page open or closes it directly
Click a link outside the Survey123 website, generate the report directly and open the download dialog for the generated report in the browser, without the need to open the Data page of the Survey123 website

Rejoindre la conversation

Connectez-vous pour publier, suivre le contenu, et plus encore. Nouveau ici ? Inscrivez-vous gratuitement.