Difference between revisions of "Stardust/KnowledgeBase/Reports/HowToRunReportAndAttachAsProcessAttachment"

Revision as of 05:50, 16 May 2012

This article will show how to run default or custom reports in Stardust and attach them as process attachments. This article assumes that reader is already familiar with Stadust Bert report component.

Demo Model

We will use the following example process definition.

Process 1:

Report Runner Java App

package com.sungard.infinity.reports;
 
import java.io.IOException;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
 
import org.apache.commons.httpclient.DefaultHttpMethodRetryHandler;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.HttpException;
import org.apache.commons.httpclient.HttpStatus;
import org.apache.commons.httpclient.methods.GetMethod;
import org.apache.commons.httpclient.params.HttpMethodParams;
import org.eclipse.stardust.common.log.LogManager;
import org.eclipse.stardust.common.log.Logger;
import org.eclipse.stardust.engine.api.runtime.DmsUtils;
import org.eclipse.stardust.engine.api.runtime.Document;
import org.eclipse.stardust.engine.api.runtime.DocumentInfo;
import org.eclipse.stardust.engine.api.runtime.DocumentManagementService;
import org.eclipse.stardust.engine.api.runtime.WorkflowService;
import org.eclipse.stardust.engine.api.spring.SpringUtils;
import org.eclipse.stardust.engine.extensions.dms.data.DmsConstants;
import org.eclipse.stardust.ui.web.processportal.view.ActivityDetailsBean;
import org.eclipse.stardust.ui.web.viewscommon.services.ContextPortalServices;
 
public class ReportAttachmentAPI {
 
	private static final Logger log = LogManager
			.getLogger(ReportAttachmentAPI.class);
	private ActivityDetailsBean activityDetails;
 
	public ReportAttachmentAPI() {
		log.debug("Instanciating ReportAttachmentAPI");
		activityDetails = (ActivityDetailsBean) SpringUtils
				.getWebApplicationContext().getBean("activityDetailsBean");
	}
 
	/**
	 * @param reportRunURL
	 *            URL of the report to be run and attach
	 */
	public void runAndAttachReport(String reportRunURL) {
		log.debug("Got in val as : " + reportRunURL);
 
		DocumentManagementService dmsService = ContextPortalServices
				.getDocumentManagementService();
		WorkflowService workflowService = ContextPortalServices
				.getWorkflowService();
 
		String targetFolder = activityDetails.getProcessAttachmentsFolderId();
 
		// Create an instance of HttpClient.
		HttpClient client = new HttpClient();
 
		reportRunURL = "http://localhost:8082/ipp-portal-m21/run?__report=/reports/carnot/AnalysisOverview.rptdesign&__format=pdf";
 
		// Create a method instance.
		GetMethod method = new GetMethod(reportRunURL);
 
		// Provide custom retry handler is necessary
		method.getParams().setParameter(HttpMethodParams.RETRY_HANDLER,
				new DefaultHttpMethodRetryHandler(3, false));
 
		try {
			// Execute the method.
			int statusCode = client.executeMethod(method);
 
			if (statusCode != HttpStatus.SC_OK) {
				System.err.println("Method failed: " + method.getStatusLine());
			}
 
			// Read the response body.
			byte[] responseBody = method.getResponseBody();
 
			// Deal with the response.
			// Use caution: ensure correct character encoding and is not binary
			// data
			log.debug(new String(responseBody));
 
			DocumentInfo docInfo = DmsUtils
					.createDocumentInfo("ReportRunAttachment_"
							+ (new Date()).getTime());
			// docInfo.setContentType("text/html");
			docInfo.setContentType("application/pdf");
			docInfo.setDescription("TestReportName1 desc");
			// docInfo.setOwner(wfService.getUser().getAccount());
			docInfo.setOwner(workflowService.getUser().getAccount());
 
			byte[] docContent = responseBody;
			DmsUtils.ensureFolderHierarchyExists(targetFolder, dmsService);
			Document doc = dmsService.createDocument(targetFolder, docInfo,
					docContent, null);
			List<Document> docList = new ArrayList<Document>();
			docList.add(doc);
 
			workflowService.setOutDataPath(activityDetails.getProcessInstance()
					.getOID(), DmsConstants.PATH_ID_ATTACHMENTS, docList);
 
		} catch (HttpException e) {
			System.err.println("Fatal protocol violation: " + e.getMessage());
			e.printStackTrace();
		} catch (IOException e) {
			System.err.println("Fatal transport error: " + e.getMessage());
			e.printStackTrace();
		} finally {
			// Release the connection.
			method.releaseConnection();
		}
 
	}
 
}

@@ Line 9: / Line 9: @@
 Process 1:
-  [[Image:Example.jpg]]
+  [[Image:ReportRunDemoProcess.jpg]]
 == Report Runner Java App ==

Breadcrumbs

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Difference between revisions of "Stardust/KnowledgeBase/Reports/HowToRunReportAndAttachAsProcessAttachment"

Revision as of 05:50, 16 May 2012

Demo Model

Report Runner Java App