Reports

Select the organization associated with the report and click on Create. Only users with this organization will be able to edit, delete or generate this report.

When creating a new report, you need to specify all of the following general information:

• The report name to be able to easily find it.

• The title of the report.

• The description to describe the report goal.

• Select the report language (English or French).

• Choose the report data format: JSON, PDF, or CSV.

• Click on Select Organizations and expand the list of organizations from the dropdown. Select the organizations whose data will be contained in the report.

For each report, you need to select the list of sections (report types) composing the report.

You can move all sections by double-clicking on them or by using the drag-and-drop icon. The order of all sections is taken into account during the creation of the report.

The Skip header option allows CSV files to be generated without a header (name, title, description). This option is only available for reports in CSV format and can only be used if only one report type is selected.

The Generate report if all report types are empty option allows prevent the email from being sent if the report is empty (OFF), or conversely, to send an email containing an empty report as an attachment (ON).

When creating a new report, you need to specify all of the following period information:

• Choose the Period Number you want the reporting period to cover.

• The report Period (Hour, Days, Month).

• The Timezone of the report.

• The date type on which the period should be based (Value date, Send date, Update date, Creation date).

For each report, you will need to select a period for which you want the data to be retrieved. To do this, select a number and the desired period, the timezone, and the type of date you want to use in the new report. You can also specify the until date (the date until which the data will be collected).

• Choose the medium:

  • You can receive the report by email by selecting all Destination Email Addresses you want.

  • You can receive the report by SFTP by selecting an SFTP outbound connectivity available.

  • You can directly download the report from the platform.

• Choose the report generation trigger to create it.

  • If you select the manual option, you can directly generate the report from the platform whenever you want.

  • If you select the automatic option, you can select the following options:

    • Daily: up to 12 fixed schedules or using specific minute or hour intervals.

    • Weekly: at a specific time.

    • Monthly: at a specific time, choosing days of the month.

    • End of Month: at a specific time.

  • If you select the business hours - End of day option, the report will be generated at the exact time defined for the chosen Business hours.

Select the organization associated with the report type and click on Create. Only users with this organization will be able to edit, delete or use this report type.

When creating a new report type, you need to specify all of the following general information:

• The report type name to be able to easily find it.

• The report type description: This description is mandatory because it’s displayed in final reports to describe the report section.

• Choose the data type of your report type. You can display 4 types of data in your reports:

  • Financial messaging - File

  • Financial messaging - Transaction

  • Financial messaging - Internal Transaction Position

  • Financial messaging - Transaction Position From Organization

  • Financial messaging - Transaction Position From/To Organization

  • Administration - Users

  • Administration - Roles

This choice of data type influences the fields available in the Data and Criteria sections.

• Choose the Data format:

  • Full data: If you want to display all desired fields about your data type.

  • Statistic data: If you want to extract the total count or average on your data type.

    • If you want to add a total line at the end of your report, please choose Add total line Yes.

• Organization data is the list of organizations from which the data will be extracted.

To choose more than one item in a list, please keep the control key (Ctrl) down on your keyboard while clicking a new item on the list with your mouse.

• If you have selected full data format:

  • Select all fields you want to display in your report type with the fields list section. If no field is chosen, default fields are generated.

  • Select all fields by which you want to order your report-type data with the order by section. No order by field is required.

• If you have selected statistical data:

  • Select all fields you want to display in your report type with the group data section. At least one group data field is required.

  • Select all fields by which you want to group your report-type data with the group by section. No group by field is required.

You can move all fields by double-clicking on them or by using the drag-and-drop icon. The order of all the fields is taken into account during the extraction of the report data.

If you select more than 12 fields in the fields list and generate a PDF report, the report type cannot be displayed.

• Define all criteria to be applied to your report types with:

  • Field: Select the field whose results you want to restrict.

  • Comparator: Choose between "equals (String)", "not equals (String)", "starts with (CSV Strings)", "not starts with (CSV Strings)", "in (CSV Strings)", "not in (CSV Strings)" values.

  • Value: Enter the desired values.

Please refer to the following table of values to make the most of this feature.

Table 1. Criteria values

Report type	Fields	Values available
Financial messaging - File	Status	PROCESSED, GENERATED, TOSEND, SENT, RECONCILED, RJCT.
	Category	PAYMENT, PSR.
	Creator	The username of the user who created the file.
	Direction	I, O.
Financial messaging - Transaction	From Currency	All ISO 4217 Currency codes.
	To currency	All ISO 4217 Currency codes.
	Status	SENT, ACK, CMPLT, RJCT, TOCORRECT, HOLD, PLANNED, FRAUD, TOAPPROVE, INPROGRESS.
	Payment type	The payment type code list is available in the payment type configuration.
	Debtor Agent BIC	BIC of the debtor agent.
	Debtor Agent Country	Country of the debtor agent.
	Debtor Agent National ID	The national ID of the debtor agent.
	Debtor Agent Country of Residence	Country of Residence of Debtor Agent
	Creditor agent BIC	BIC of the creditor agent.
	Creditor Agent Country	Country of the creditor agent.
	Creditor Agent National ID	The national ID of the creditor agent.
	Creditor Agent Country of Residence	Country of Residence of Creditor Agent
	Instructing Agent BIC	BIC of the instructing agent.
	Instructed Agent BIC	BIC of the instructed agent.
	Priority	1 or 2.
	Approving	The username of the user who approved the transaction.
	Creator	The username of the user who created the transaction.
	File format	The name of the inbound file format.
	Bypass mode	To perform penny tests during weekends.
	Custom references 1/2/3	Specific residencies added to the transaction.
	Send date	The sent date of the transaction. For the report generation date, put the “CURRENT_DATE” string.
	Value date	The value date of the transaction. For the report generation date, put the “CURRENT_DATE” string.
	Tag	All specific tags are added to the rules.
Administration - User	Role	Please refer to Default Role Specifications for the role list.
	Status	Blocked or Active.
Administration - Role	Name	Please refer to Default Role Specifications for the role list.
	Scope	Please ask your Support contact for more information.