CreateReport Functions
The
CreateReport and
CreateReportSession functions run the specified report against a specified System file. These two functions differ only in respect to parameters for login. For more information, see
Login Parameters.
When either of these functions run, the license for the product module specified in the report is checked out. This means that to generate a FRACAS report, a Windchill FRACAS license must be available.
When generating reports, the API ignores any personal filters that are applied. The resulting report is stored in the Temp folder on the web server in PDF format. Reports generated by these functions are cleaned up in 24 hours.
Syntax
The following is the syntax for an HTTP request:
POST /WindchillRiskandReliability12.0/DataEngine.asmx/CreateReport 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
Parameters
In addition to login parameters, both the CreateReport and CreateReportSession functions use 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.
The following is an example of an HTTP POST request:
POST /WindchillRiskandReliability12.0/DataEngine.asmx/CreateReport HTTP/1.1
Host: vm-test
Content-Type: application/x-www-form-urlencoded
Content-Length: length
UserName=Bill&Password=passwd&GroupName=Manager&ProjectName=Tablet PC &SystemName=Tablet PC&ReportName=(Common) FMEA Standard Design &ExtraParameter=System Functional FMEA
Returns
If the user is authenticated and the specified parameter values are found, the name of the generated report is returned.
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.