Manage Financial Report Groups
This document explains how to create and manage financial report groups. Financial report groups enable you to trigger the creation of proposals and files for multiple financial reports at once. When creating the proposal or file run, the functionality calls the financial reports in 'Financial Report. Open' (RGS300) that have been selected as included and performs the procedure according to the process described in Manage Financial Reports.
Status handling for the group is used to monitor the progress of the run. When creating the files, you can also create a separate file describing the contents of the included files.
Limitations
A financial report identity in (RGS300) can only be connected to one financial report group.
Before you start
Financial reports must be defined in 'Financial Report. Specify' (RGS900) and created in (RGS300) before creating financial report groups. See Manage Financial Reports.
Follow these steps
Specifying financial report groups
To specify a financial report group, follow these steps:
- In 'Financial Report Group. Specify' (RGS905), specify a unique financial report group ID and select option 1-'Create'.
- On the (RGS905/E) panel, select and specify the following:
- A description and name for the report group.
- Whether a contents description file should be created when creating the files of the reports connected to the group at a later stage. See Creating contents description file.
- An optional folder name used to specify the path within MvxFileTransfer to where the contents description file is transferred. This field is only applicable if the contents description field is selected with a value other than 0.
- On the (RGS905/B) panel, select related option 11-‘Details' to enter 'Financial Report Group. Specify Details' (RGS906).
- On the (RGS906/B) panel, specify a financial report identity from 'Financial Report. Specify' (RGS900) and select option 1-‘Create’. Repeat this step until all reports that should be connected to the group have been added.
Creating financial report group proposals
To create financial report group proposals, follow these steps:
- In 'Financial Report Group. Open' (RGS305), the financial report group specified in (RGS905) is automatically created. If the record has been deleted in (RGS305), you can manually create it again by specifying the financial report group ID and selecting option 1-'Create'.
- On the (RGS305/B) panel, select the 11-'Details' related option to enter 'Financial Report Group. Open Details' (RGS306).
- In (RGS306), the financial report identities connected to the group (RGS905) are automatically created. If a record has been deleted in (RGS306), you can manually create again it by specifying the financial report identity and selecting option 1-'Create'. Select which financial report identities to include in the next creation of proposals. Alternatively, you can perform the selection in the next step.
- On the (RGS305/B) panel, select the 8-'Create proposals' related option to enter the (RGS306/B) panel. Select which financial report identities to include in the run. Click Exit.
- On the (RGS305/K) panel, specify the selection values for the report. The selection values are equal to the ones in (RGS300), see Manage Financial Report Proposal. Any value entered on this panel overwrites the selection values on the individual reports in (RGS300) when creating the proposal. Click Next, and then Next again to confirm the run.
- On the (RGS305/B) panel, the group status is set to 10, indicating that proposals are being created for one or more reports. On the same panel, select the 11='Details' related option to open (RGS306). In this program, the status of each individual financial report in (RGS300) is displayed. When all reports are successfully created (status 20), the group status in (RGS305) is also set to 20.
Managing stopped or terminated proposal creations for a financial report group
In case one or more included financial reports are stopped in (RGS300) or terminated by the system, the group status is set to 15. The individual reports must be corrected in (RGS300) according to the section Managing stopped or terminated proposal creations in Manage Financial Report Proposal. Once all reports with an error have been corrected, select the 12-'Reset status' related option on the (RGS305/B) panel to update the group status. This related option checks the status of all selected financial reports and updates the group status accordingly.
Creating financial report group files
To create the XML or CSV files based on a group proposal created in (RGS305), follow these steps:
- Ensure that you specified a valid printer file ID and service ID on the (RGS900/E) panel for all selected financial reports. Also ensure that you specified an XML structure for all selected reports. See Configuring the XML structure of the financial report in Manage Financial Reports. Create a report group proposal in (RGS305). See Creating financial report group proposals.
- On the (RGS305/B) panel, select the 9='Create files' related option. Once done:
- The group status is set to 80 and the files are generated through the generic configurable output functionality. When all jobs used to generate the XML or CSV file jobs are complete, the group status is set to 90. The 90 status means that the files may still be under creation.
- If you have selected to create a contents description file, that file is created and transferred to the specified path within MvxFileTransfer. When the file has been created, the group status is set to 95. See Creating contents description file.
- The creation time and creation date are updated on the (RGS300/E) panel and in the FREHED table.
- Retrieve the files from the applicable destination according to the selected service ID and its related settings. The files are named using the job number, printer file ID (from RGS900/E) and a sequence number as seen in 'Output. Manage per Job' (MNS270).
- When applicable, retrieve the contents description file from MvxFileTransfer. The file created for the '1-GDPdU index file for Germany' contents description option is named 'index' followed by date (in YYYYMMDD format) and time (in hhmmss format).
Creating contents description file
When you create files, you also have the option to create a contents description file which describes the contents of the data included in the detailed files. You select whether to create the file on the (RGS905/E) panel.
Index file for German GDPdU
Select the '1-GDPdU index file for Germany' contents description option on (RGS905/E) to create the index file in XML format required for German GDPdU reporting. The file is created according to version 1.5 of the DTD (Document Type Definition) file provided by the local authorities.
If this option is selected on (RGS905/E), the XML structure of each printer file connected to the included financial report headers in (RGS900) is retrieved. For each section with XML section type 'CUSTOM', a new <Table> level is created in the file. Within that level, a <VariableColumn> or <VariablePrimaryKey> level is created for each element in the XML structure section.
This table shows the structure of the index file and how values are set:
Level 1 | Level 2 | Level 3 | Level 4 | Level 5 | Level 6 |
---|---|---|---|---|---|
Fixed element '<?xml version="1.0" encoding="utf-8"?>' | |||||
Fixed element '<!DOCTYPE DataSet SYSTEM "gdpdu-01-09-2004.dtd">' | |||||
Fixed element ‘<DataSet>' | |||||
Element '<Version>' with fixed value '1' | |||||
Fixed element '<DataSupplier>' | |||||
Element ' <Name>' with value from field 'Company name' in 'Company. Connect Division' (MNS100) | |||||
Element ' <Location>' with a concatenated value from fields 'Address line 1', 'Address line 2', 'Address line 3', and 'Address line 4' in (MNS100) | |||||
Element '<Comment>' with a value of 'Datum: [Current date in format DD.MM.YYYY] erstellt von [Name of the user from 'User. Open' (MNS150)]' | |||||
Element '<Name>' with fixed value 'Disk1' | |||||
Element '<Table>' that is created once per each XML section with section type 'CUSTOM' for all selected reports in the group run. Normally, this means that one financial report CSV file corresponds to one '<Table>' element. | |||||
Element ' <URL>' with value of the used printer file concatenated with the job number generated by the corresponding file and fixed value '_0.csv'. This value forms the CSV file name generated by the financial report. If no corresponding job is found for the report, the element is populated with value from field 'Description' of the financial report on (RGS300/E) followed by fixed value '.csv'. Note that the corresponding file name must match this value when the files are submitted to the authorities. |
|||||
Element ' <Name>' with value from field 'Description' of the financial report on (RGS300/E) | |||||
Element ' <Description>' with value from field 'Description' of the financial report on (RGS300/E) | |||||
Element ‘<DigitGroupingSymbol>' with fixed value ''' (apostrophe) | |||||
Fixed element '<Range>' | |||||
Element '<From>' with fixed value '2'. This indicates that the data in each CSV file starts on line 2, since line 1 consists of the column headers. | |||||
Fixed element '<VariableLength>' | |||||
Element '<ColumnDelimiter>' with value from field 'Separator sign' on 'Output Service Type. Open' (MNS217/E). ';' is set as the default value in case the field is not defined. | |||||
Element '<VariablePrimaryKey>'' or '<VariableColumn>' is automatically set for each element defined in the XML structure. '<VariablePrimaryKey>' is set if the current field has been defined as a dynamic key object for the report section in (RGS901). If not, '<VariableColumn>' is set as the element ID. | |||||
Element '<Name>' with value set to 4-'Overriding name' is set as the label on 'XML Structure Section. Open Element' (CMS009/E). If a translation using a language code with ISO code DE has been defined for the overriding name field, the translated overriding name from 'Language Handling. Open' (CRS830) is used. Otherwise, the value from the field 'Overriding name' on (CMS009/E) is used. | |||||
Element '<Name>' with value set to 3-'Standard message ID' as the field label on (CMS009/E), the value is set according to the standard message ID. In all other cases than the ones described above, the value is retrieved this way. If a translation using a language code with ISO code DE has been defined for the description field on (CMS009/E), the overriding name from (CRS830) is used. Otherwise, the value from the description field on (CMS009/E) is used. | |||||
Element '<Description>' with value set according to the same logic as described for element '<Name>' above. | |||||
Element '<Numeric>', '<AlphaNumeric>', or '<Date>' is set. '<Numeric>' is set if the 5-'Decimal' or 6-'Integer' data type option is defined for the field on (CMS009/E), or for a virtual field where the N-'Numeric' field type option is defined on 'Virtual Fields. Connect' (CMS012/E). '<Date>' is set if the 2-'Date' data type option is defined for the field on (CMS009/E). '<AlphaNumeric>' is set in all other cases than the ones described above. |
|||||
For element '<Numeric>', element '<Accuracy>' is created with the number of decimals for the field as value. The element is only created if the number of decimals is greater than 0. For element '<Date>', element '<Format>' is created with fixed value 'YYYY-MM-DD'. |