IFS Report Data Service¶
##Content - Overview - XML Result Set Data Provider - Report Schema Provider - Archived PDF Provider
Overview¶
IFS Report Data Service is a Web Service in IFS Reporting framework. It is capable of providing XML Result Sets, Report Schemas & Archived PDFs upon requests from external entities. Users are authenticated via IFS Java Access Provider.
The SOAP Web Service has three separate end points for providing above types of objects.
- XML Result Set Data Provider
- Report Schema Provider
- Archived PDF Provider
XML Result Set Data Provider¶
This end point is capable of providing a Full XML Result Set Data including Result Set Data, Header & Footer information based on below parameters.
Parameter | Description |
---|---|
Report Id | Unique Identity of the Report (found in Report Definition) |
Result Key | Key value of the Archive instance generated |
Instance Id | Unique Id generated specific to each format request (when printing) |
Flattened | Defines whether the XML Result needs to be flattened or not |
To receive a valid XML result from this service, the IFS user should either have a valid token or the specific archive instance needs to be distributed to him/her. i.e. for instance, an administrative IFS user is capable of receiving a Full XML Result Set by only mentioning a valid Report Id without having a valid token.
Report Schema Provider¶
Report Schema Provider can provide a Report Schema XML based on following parameters.
Parameter | Description |
---|---|
Report Id | Unique Identity of the Report (found in Report Definition) |
Flattened | Defines whether the XML Result needs to be flattened or not |
Archived PDF Provider¶
This provides an Archived PDF file according to the parameter values given that the result key is distributed to the end user.
Parameter | Description |
---|---|
Report Id | Unique Identity of the Report (found in Report Definition) |
Result Key | Key value of the Archive instance generated |
Notes | Notes text set at the PDF Archive instance |