Defining an FOP Report

Prerequisites

To define an FOP report you should have:

  • FOP reporting framework configured in the system

  • C1_​FOPONBL algorithm defined in the system to create FOP reports for bill templates

  • Parameters defined for the C1_​FOPONBL algorithm

  • C1_​FOPONBL algorithm attached to the Online Bill Display system event

  • C1_​ FOPLTRALG algorithm defined in the system to create FOP reports for letter templates

  • Parameters defined for the C1_​ FOPLTRALG algorithm

  • C1_​ FOPLTRALG algorithm attached to the Online Letter Image system event

  • Algorithms defined in the application for creating custom FOP reports

Procedure

To define an FOP report:

  1. Click the Admin link in the Application toolbar.
    A list appears.
  2. From the Admin menu, select R and then click Report Creation.
    The Report Creation screen appears.
  3. Click the Add button available at the upper right corner of the Report Creation screen.

    The Report Creation screen appears. It contains the following fields:

    Field Name Field Description Mandatory (Yes or No)
    Report Used to specify the FOP report No
    Description Used to specify the description for the FOP report No
    Output Format Used to indicate the format in which you want to generate the FOP report. The valid values are:

    • CSV

    • DOCX

    • JSON

    • PDF

    • Web

    • XLS

    • XML

    Note:

    At present, the system supports extraction of an FOP report in the CSV, JSON, PDF, XML, and XLS formats.

    You can customize the algorithm to support the extraction of an FOP report in the DOCX and Web formats.

    		 Yes
    Script Used to indicate the script using which the FOP report is extracted in the Web format.
    Note: This field is enabled only when you select the Web option from the Output Format list.
    		 No
    Report Type Used to indicate the type of information that you want to extract using the FOP report. The valid values are:

    • Bill

    • Custom

    • Letter

    Note: This field is disabled when you select the Web option from the Output Format list.
    		 Yes
    Report Template Used to indicate the template using which the FOP report is uploaded in the system.
    Note: This field appears only when you select the Bill or Letter option from the Report Type list.
    		 Yes
    XSL Template Used to indicate the XSL template file using which you want to create the FOP report.
    Note:

    The Upload button appears corresponding to the XSL Template field. On clicking the Upload button, the Upload XSL Template window appears where you can choose the required XSL template.

    This field is disabled when you select the Web option from the Output Format list.

    		 Yes
    Report Generation Algorithm Used to indicate the algorithm defined for creating a custom FOP report.
    Note:

    The Search (The Search Icon) icon appears corresponding to the Report Generation Algorithm field. On clicking the Search icon, the Algorithm Code/Description window appears where you can search for the required algorithm.

    This field is enabled only when you select the Custom option from the Report Type list.

    		 Yes (Conditional)
    Note: This field is required while creating a custom FOP report.
    Reporting Mode Used to indicate whether you want to generate the FOP report in the batch mode or online mode. The valid values are:

    • Batch

    • Online

    		 Yes
    Email ID Used to specify the email ID where you want to send the notification of the FOP report generation.
    Note: This field is enabled only when you select the Batch option from the Reporting Mode list.
    		 Yes (Conditional)
    Note: The field is required for generating FOP report in the batch mode.
    Subject Used to specify the text which you want to appear in the subject line of the email.
    Note: This field is enabled only when you select the Batch option from the Reporting Mode list.
    		 Yes (Conditional)
    Note: The field is required for generating FOP report in the batch mode.
    Email Body Content Used to specify the content which you want to appear in the email body,
    Note: This field is enabled only when you select the Batch option from the Reporting Mode list.
    		 Yes (Conditional)
    Note: The field is required for generating FOP report in the batch mode.

    In addition, the Report Creation screen contains the following columns:

    Column Name Column Description Mandatory (Yes or No)
    Display Sequence Used to indicate the sequence of the parameter. No
    Report Parameter Used to indicate the parameter which you want to define while generating the FOP report.
    Note:

    The Search (The Search Icon) icon appears corresponding to the Report Parameter field. On clicking the Search icon, the Field Details window appears where you can search for the required parameter.

    On specifying the parameter, the description of the parameter appears corresponding to the Report Parameter field.

    		 No
    Note: The above columns do not appear when you select the Web option from the Output Format list.
  4. Enter the required details in the Report Creation screen.
  5. Click Save.
    The FOP report is defined.

Related Topics

For more information on... See...
Report Creation screen Report Creation