ActiveVOS Designer User’s Guide

Previous | Next

Reporting Service

ActiveVOS server supports a reporting service. The service allows you to automate the reporting capability in the ActiveVOS Console of saving a report to PDF, MS Word, or other format. With the reporting service, you create a BPEL process to get a snapshot of an ActiveVOS report and then you can provide programming logic to email or use the report in a People activity. Upon deploying the process, you can schedule it to run daily (or other frequency) to have a daily report emailed.

Any BPEL process that implements report-based activities imports the WSDL provided with the ActiveVOS Designer product. The name of the WSDL is reporting.wsdl, and its port type, reportingPT, is in the Participants view in the New Partner Service Provider wizard under System Services. The WSDL contains a report operation. 

<invoke
    inputVariable="reportMessageInput"
    operation="report" 
    outputVariable="reportMessageOutput"
    partnerLink="Provider" />

To create a BPEL process which requests a report:

  1. In the Project Explorer, create a new Orchestration project.
  2. Select File>New>BPEL Process.
  3. Name the process and click Finish.
  4. In the Participants view, select New Partner Service Provider.
  5. In the wizard, select System Services.
  6. Select the Get Server Report, and select Finish.
  7. Create an invoke activity which uses the reporting participant/operation.
  8. Fill in the Input values as described below.

Note: On the Server Administration Console, go to the URN Mappings page and update the URL for Internal Reports, if needed. The default is localhost:8080.

Input Message for Reporting Service

The input message for the invoke activity has the following parts, as shown in the example. 

<ns2:reportMessageInput xmlns:ns2="http://schemas.active-endpoints.com/reporting/2009/05/reporting.xsd">
   <ns2:report>ServiceActivityDetail.rptdesign</ns2:report>
   <ns2:format>pdf</ns2:format>
   <ns2:parameters>
     <ns2:param name="Service_Name" value="OrderProcessSvc"/>
   </ns2:parameters>
   <ns2:otherOptions>
     <ns2:option name="BIRT Parameter" value="true"/>
   </ns2:otherOptions>
</ns2:reportMessageInput>

Specify the input parameters for the invoke activity as follows.

<report>

(Required). Name of the report design template. The report names are visible in the ActiveVOS Console Catalog

<format>

(Required). Format of the generated report. Valid formats are:

  • pdf (default)
  • doc (Word)
  • xls (Excel)
  • ppt (Powerpoint)
  • ps (postscript)
  • html

<parameters>

Each report can have its own set of parameters which are input to the report. For example, specify the name of a deployed service to get a report about one particular running process. Parameters for the standard ActiveVOS reports are described below.

<otherOptions>

Options for producing the report. There are many options, and they are documented in the BIRT documentation.For details, here is a link. http://www.birt-exchange.org/devshare/deploying-birt-reports/492-birt-viewer-2-3-user-reference/#description

ActiveVOS Reports and Their Parameters

You can use the reporting service to access your own custom reports or the ActiveVOS standard reports that are displayed in the ActiveVOS Console.

In the ActiveVOS Console, you can view a list of ActiveVOS report designs. You can then select a report design to name in the <report></report> element of the reportMessageInput variable.

To view a list of ActiveVOS report design names, do the following:

  1. Ensure that the server is running.
  2. Open the ActiveVOS Console.
  3. Select Catalog>Resources>Report Definitions.
  4. In the Filters table, disable the check box for Hide System and select Submit.

Some of the ActiveVOS Reports have parameters, and you can use them in the <ael:param name="string" value="string"/> element of the reportMessageInput variable.

The following reports contain parameters and valid values.

Active Tasks

RP_State - (To see a complete list of states, go to the Active Tasks page of ActiveVOS Console and select the Run Report button. In the RP_State drop-down list, you can view the 14 different states.)

RP_CreatedAfter - Date

RP_CreatedBefore - Date

RP_CompletedAfter - Date

RP_CompletedBefore - Date

RP_Name - String

RP_Owner - String

RP_SearchBy - String

RP_OwnerType - integer

RP_IdentityType - integer

RP_NamesText - String

Server Log

RP_LogLevel VERBOSE = 1, INFO = 5, WARNING = 6, ERROR = 7 CRITICAL = 8

RP_LogSource USER = 8, MAINTENANCE = 9 and SYSTEM = 10

RP_LogService ENGINE = 3, ALERT = 4, MESSAGING = 5, TASK = 6, VERBOSE = 7, EVENTING = 8, EMAIL = 9, IDENTITY = 10

RP_LogEngineId integer greater than or equal to 1

Copyright (c) 2004-2010 Active Endpoints, Inc.