CreateReportForCurrentBranch Functions
The CreateReportForCurrentBranch function runs a report against a specific record from the list of search results.
Syntax
The following is the syntax for an HTTP request:
POST /WindchillRiskandReliability12.0/DataEngine.asmx/CreateReportForCurrentBranch HTTP/1.1
Host: HostName
Content-Type: application/x-www-form-urlencoded
Content-Length: length
UserName=string&Password=string&GroupName=string&ProjectName=string
&SystemName=string&ReportName=string&ExtraParameter=string
&FilterParameters=string&TreeId=integer&ExtraId=integer
Parameters
In addition to login parameters, the CreateReportForCurrentBranchfunction uses these parameters:
• ProjectName—The name of the Windchill Risk and Reliability Project. This value is case-sensitive.
• SystemName—The name of the System file. This value is case-sensitive.
• ReportName—The name of the Report Design file or Report Binder file for the report to generate. Any files in the Common Library must be prefixed with (Common).
• ExtraParameter—For an FMEA or FTA report, the identifier of the item on which you want to report. For an FMEA report, you must specify the identifier of the FMEA on which to report. For an FTA report, if you want to report on a specific top gate, you must specify the identifier of the top gate. Otherwise, if no identifier is specified, all top gates are included in the report. This parameter is not required for a FRACAS report.
• FilterParameters—The specific values that you want to use for the parameters required by an applied filter. If values are not specified, default values are used. To specify values, you must know the number and order of the required parameters. When passing values for multiple parameters, two colons (::) must separate each text string. You can see the required parameters in the Filter file in which the filter is stored. If passed values do not match or are unnecessary, they are ignored.
• TreeId—The system tree identifier of the selected record.
• ExtraId—The default value is -1.
The following is an example of an HTTP POST request:
POST /WindchillRiskandReliability12.0/DataEngine.asmx/CreateReportForCurrentBranch HTTP/1.1
Host: HostName
Content-Type: application/x-www-form-urlencoded
Content-Length: length
UserName=admin&Password=passwd&GroupName=Administrators&ProjectName=Tablet PC&
&SystemName=Tablet PC&ReportName=(Common) FMEA Standard Design
&ExtraParameter=System Functional FMEA&TreeId=1101&ExtraId=-1
Returns
If the user is authenticated and the specified parameter values are found, the name of the generated report is returned. Function returns a report pdf, which contains the report data based on the selected record from search results.
If the call fails, the AdditionalData tag provides the reason for the failure.
FileAccessCookie is returned in result response while generating output that needs to be downloaded.