Get UDR Data

Description

This method gets XML data from UDR output.

Support

This process is supported under both company and project/shell-level reports. Only reports that are marked for Integration are eligible for integration.

Installation: ASP and Self host

Level	Yes or No
Company Level	Yes
Project/Shell Level	Yes

Prototype

public XMLObject getUDRData(String shortname, String authcode, string projectNumber, String reportName);

Parameters

Parameter	Description
shortname	identifier of the company, company's short name
authcode	authentication key for the company, in text string
projectNumber	identifier of the project/shell. If you want to get company-level report, pass null for this parameter.
reportName	name of the report user defined report

Return Value

Response will contain following data elements

Tag Name	Description
<report>	Main report tag
<report_header>	Element that carries all report header column names.
<report_row>	Element that carries data of all rows. This element will also show following information: Group By: If report has group by condition, the data value will show under this element Subtotal: If report is configured to show sub-total, the data value will show under this element Count: If report is configured to show count, the data value will show under this element.

Tag Name

Description

Main report tag

<report_header>

Element that carries all report header column names.

<report_row>

Element that carries data of all rows.

This element will also show following information:

Group By: If report has group by condition, the data value will show under this element

Subtotal: If report is configured to show sub-total, the data value will show under this element

Count: If report is configured to show count, the data value will show under this element.

Sample Method

getUDRData ("acme", "acme_authcode", "project_info", "Funding Report")

The XML output of an UDR will be based on report design.

Tabular UDR with no Group
Tabular UDR with Group
Tabular UDR with Sub-Total
Tabular UDR with Count
Cross Tab UDR
Summary UDR
Alert UDR

Additional Information

A user-defined report (UDR) always runs upon receiving the message. This ensures that the latest data is returned.

Web Services call does not need any additional permission to run a UDR that is marked for Integration.

If UDR has query parameters defined, the Web Services method will retain that if the query parameters are pre-populated during report design.

Following are the failure reasons and descriptions:

Reason	Description
Report name is not valid. Check if report exists or is enabled for Integration	Invalid Report Name (If report does not exist or is not marked for Integration)
Unable to run report. Contact System Administrator	While running report if there is a system error or for any reason Unifier cannot run this report

This service can be used for Projects/Shells of cost code type CBS and Generic.

In case of the getUDR web-service call:

If the report data being retrieved is based on permission aware data sources, nothing will be returned.
If the report being retrieved is based on system defined data sources, it will work as per existing functionality.