Create and Manage Reports

As the Buyer Administrator, you can create reports that are specific to an application by uploading the report design file and configuring the required conditions.  By default, some standard reports are provided for supply chain issue management (SCIM) app when a tenant is created.

In this section, we will discuss all the features pertaining to Report Management, such as:

Create Reports

To create a report:

1. Log in the IENT Application.

2. Go to Analytics and select the + button from the top right corner.

   

3. Enter the following information:

   • Application: The application for which you are creating this report. Select from the dropdown list.
     Note: This is a mandatory field.

   • Report Name: Provide a unique name for this new report.
     Note: This is a mandatory field.

   • Versions: Select one or more versions of the selected application. The data will be queried with the selected versions.
     Note: This is a mandatory field.

   • Chart Type: Select one or more charts from the dropdown (line chart, bar chart, pie chart, table) for your report design.
     Note: This is a mandatory field.

   • Report Design File: Create a report using the BIRT design tool and upload the design file. See here for more information.
     Note: This is a mandatory field

   • Configurations: Click the + on the Configuration section to view the configuration options.

     

     • Form: You can select a form from the available forms for the latest selected version of your selected application.

     • Response Fields: You can select one or more fields from the selected form. To select fields from another form, simply select a different form and add your fields.
       Note: This is a mandatory field.

     • Group By: Use this option to group different fields as required.

     • Due Date: Select this option if you want to data to be fetched as per due date. Selecting this option removes the From Date, To Date and Interval options.

     • From Date: Select the start date from which you want data to be fetched.
       Note: This is a mandatory field.

     • To Date: Select the end date from which you want data to be fetched.
       Note: This is a mandatory field.

     • Interval: You can select intervals (daily / weekly / monthly / yearly) based on which data can be grouped and displayed in report charts.

   • Conditions: Click on Conditions section to configure the conditions for the report and click on + Add to add one or more conditions. Enter the following details:

     

     • Form: Select a form from all the available forms.
       Note: This is a mandatory field.

     • Field: Select the field on which you want the condition to be applied.
       Note: This is a mandatory field.

     • Condition: Select a conditional operator (equals, not equals, in, not in, all, etc.).
       Note: This is a mandatory field.

     • Value: Enter the value to apply conditions on.
       Note: This is a mandatory field. You can use commas to separate values.

     • Actions: From the dropdown list select one of the following options. This is a mandatory field

       • Keep Hidden: If checked, this row will not be visible to users executing or viewing this report.

       • Can be modified: If checked, users can change values and conditions of the field while viewing the report.

4. Click on Submit.

Generate Report Design Files

To generate report design files:

1. Download the BIRT Designer Tool from https://download.eclipse.org/birt/downloads/drops

2. Create a new report from the BIRT Designer tool by selecting File>New>New Report.

   

   You can use the existing templates like line charts, bar charts, tables, or any third-party libraries such as D3.js. (https://d3js.org/ )

3. At runtime, the selected response fields' data will be sent as json strings to the report via the data report parameter.

4. Once the report is created, the file will be generated in an .rtpdesign format.
   

Below is a sample data that will be sent as the input to a report:

• reportTranslationFields: Translated values will be sent as input to the report based on the selected language.

• data: The actual data used to plot the graph will be sent.

• dateFormat: User-specific date format will be sent if present or else tenant-specific date format will be sent as input.

• chartType: Indicates the chart that needs to be plotted (Line Chart/ Bar Chart/ Pie Chart/ Table).

• responseFields: Sends all the Response Fields selected during report configuration.

View Reports

To view all reports:

1. Log in the IENT Application.

2. Go to Analytics

3. You can view all created reports.

   

4. To download a list of reports, select the particular reports and then click on the kebab menu on the top right corner of the screen and select Download Options as needed:

   

   • Download as PDF: Export all the selected records in the data table in PDF format.

   • Download as CSV: Export all the selected records in the data table in CSV format.

5. To export reports to a specific tenant, select the particular reports and then click on Export to Tenant from the kebab menu in the top right corner, and select a target tenant.

   

   The selected tenant will have to approve the import request through their account.

6. To view a report, click on a report name or click on View from the kebab menu on your selected report.

   

7. You will be able to view all the configured conditions. Users will be able to change the condition/value/ From Date/ To Date/ Interval/ Chart Type inputs.

   Pin To Dashboard: Click on this button to pin the selected report with the current conditions onto your dashboard for quick access.
   Execute: Click on this button to generate a report based on the modified conditions and configurations.