A filing is made for an institution. Register at least one institution on the Institutions page before you subscribe to a document.
Browse the catalog
In the left-side menu of the Reporter page, open Regulatory Filings, then Catalog. Each card shows the title and the version of the document. The Reference mapping line of a card says if Lerian includes a mapping for Midaz. With a reference mapping, you subscribe without mapping anything. The reference mapping needs a COSIF account on every operation route and the CNPJ of the organization. Without one, you map the fields from the start. When a newer version of a document is available, the card shows Update. It updates every active subscription that is behind. An inactive subscription keeps its version. A subscription keeps generating with its adopted version until you update it. When the catalog is empty, no regulatory document is mounted in this environment. An administrator mounts the regulatory catalog on the Reporter service.
Subscribe to a document
1
Open the dialog
On a card of the Catalog, click Subscribe. The Subscribe to document dialog opens.
2
Choose the institution
With one institution, the dialog uses it. With several, choose the institution that files the document.
3
Choose the mapping
When the document includes a reference mapping, choose Use the reference mapping for Midaz or Map my own database. Map my own database starts from an empty mapping. Without a reference mapping, the dialog does not ask.
4
Subscribe
Click Subscribe. The Document subscribed dialog shows what the starting mapping can read now, and what it cannot read.
Map the fields
On My Regulatory Documents, select Open mapping in the menu () of a subscription. The mapping page shows the mapping version and two sections:
- What this mapping reads: the queries of the mapping. A query reads one table of one of your Data Sources, or the rows of another query. To add a query that reads a table, click Add query. A query can join tables, filter rows, and compute a value, and give an amount its plus or minus sign from another column. It can also group and sum rows, and read each item of a list in a MongoDB collection. Preview the rows shows the first rows that a query returns. It saves nothing.
- What the document asks for: one row for each field that the regulator declares. For each set, choose the query that fills its rows. Then choose where each field is read from. A set that the document lets you consolidate also accepts queries from your other Data Sources.
Click Save mapping. If Reporter refuses the mapping, the page shows the reason and keeps your changes.
A reference mapping opens locked. To edit it, click Edit mapping and confirm that you take it out of the reference. You can still add sources from your other Data Sources to the sets that allow it, without unlocking the reference. To start again, click Start over, then select Restore the reference mapping for Midaz or Start from a blank mapping. When you restore the reference mapping, the additional sources stay. Filings already generated keep the mapping that generated them.
Check readiness
On My Regulatory Documents, Reporter checks each active subscription against your databases as they are now. The Readiness column shows the result. Click the summary to open or close the details. Deactivated subscriptions are hidden until you select Show deactivated.
Warnings are listed apart. They do not block the generation. To check again, open the mapping and click Check now.
Generate a draft
1
Open the dialog
Open Filings and click New filing. Choose a document that you subscribe to. The list shows only active subscriptions. Click Continue.
2
Fill in the parameters
The document sets the parameters that the filing needs. Write a competency month as
YYYY-MM and a date as YYYY-MM-DD. Some documents are filed for specific months. The field tells you which months.3
Generate
Click Generate. The Draft generated dialog lists the blank fields. A blank field is a field that the mapping could not fill. It is not a generation failure.
4
Open the filing
Click Open the filing.
Draft. It shows on Filings. It does not show on the Generated Reports queue.
Find a filing
Filings lists every regulatory document generated: drafts to review, approved filings, and failed generations with the reason. Filter the list by document or by institution. To see one subscription, select See filings in its menu on My Regulatory Documents. The list shows the current generations only. A newer draft or an approved filing of the same subscription, period and remittance takes the place of an older draft, which becomes history. A generation that does not end as a draft replaces nothing. To list the older ones, select Show superseded generations. A superseded draft cannot be corrected or approved.
Correct and approve the filing
The filing page shows the status, the blank fields, the File content, the Corrections, and the Provenance. Provenance shows the document, the document version, the mapping version, the generation time, the parameters, and the file checksum (SHA-256). While a required field is blank, you cannot approve or download the filing. The page lists each blank field.
Correct a figure
1
Choose the cell
On the filing page of a
Draft, find the figure under File content. Search a set, or select Only corrected. Click the cell. The Correct dialog opens with the set, the row, and the field already chosen.2
Enter the correction
Enter the New value. Under Why (recorded in the audit trail), write why the figure changes. The reason is mandatory.
3
Apply
Click Apply correction.
Approve the draft
1
Open the dialog
On the filing page of a
Draft, click Approve. The Console hides Approve while a required field is blank.2
Confirm
Click Approve as the filing.
Final. A Final filing refuses corrections, and its provenance does not change.
Download and replace
Click Download on the filing page to get the file. The file format comes from the filing. You can download aDraft or a Final filing with no blank required field.
When the document declares a replacement remittance, a Final filing also offers Generate a replacement. The button appears only while the subscription is active.
Manage a subscription
On My Regulatory Documents, a subscription row can show these items:
- Update: appears when the catalog has a newer version. Filings already produced keep their version. After the update, the dialog shows what the new version does to your mapping.
- Version history in the menu (): lists each adopted version, newest first.
- Set institution in the menu: appears when the tenant has several institutions and the subscription has none. It sets the institution for the next filings. A subscription that has an institution keeps it. To file the document for another institution, subscribe it again from the Catalog.
- Deactivate in the menu: stops the filing of the document. The subscription stays in the list as Inactive after you select Show deactivated. Nothing is deleted, and reports already generated from it stay readable.
Permissions
Opening the regulatory screens needs
regulatory:get. Filings, the filing page, and Download also need reports:get. Subscribing to or reactivating a document, generating a draft, correcting a figure, and updating a version need regulatory:post. Saving a mapping and setting an institution need regulatory:put. Deactivating a subscription needs regulatory:delete. Approving a draft needs regulatory-approval:post.
Next steps
- Use Managing Institutions to register the institutions that file documents.
- Use Managing Data Sources to register the Data Sources that a mapping reads.
- Use Managing Reports for operational reports from Templates.

