Accessing the Institutions page
To open the Institutions page, click Institutions in the left-side menu of the Reporter page. The page lists the institutions in a table with these columns: Name, CNPJ, Data Sources, Last Modified, and Actions. The Data Sources column names each Data Source in the scope of the institution. It shows None when the scope is empty. The menu () of each row has Edit and Delete. Each action on the Institutions screen needs the matching
institutions permission: get to see and propose institutions, post to create and confirm, put to edit, and delete to delete.
Add an institution
1
Open the form
On the Institutions page, click New Institution.
2
Identify the institution
Enter the Business name and the CNPJ. The CNPJ can be numeric or alphanumeric, with or without punctuation.
3
Define the scope
Click Add data source and select a Data Source. Then tell Reporter which of its rows belong to the institution. See Scope rules.
4
Save
Click Save. If Reporter refuses the institution, the form shows its reason and keeps what you typed.
Scope rules
The scope names the rows of each Data Source that belong to the institution. An institution with no Data Source in its scope reads nothing. For each Data Source, choose one of these:- The whole data source belongs to this institution: the institution reads every table of the Data Source.
- Tables: click Add table and enter the table name. For each table, choose one of these:
- Shared: every institution reads this table whole: use it for reference data that every institution needs.
- Conditions: click Add condition, type the Field, select an Operator, and type the Values, comma separated. A table with conditions needs at least one condition with the Equal or the In operator. These two operators claim the rows of the institution.
Field guide
Propose institutions from Midaz
Reporter can read the organization table of Midaz and propose one institution for each organization that is not registered yet.
1
Open the proposals panel
On the Institutions page, click Propose from Midaz.
2
Select the Data Sources
Under Data sources to read, select the PostgreSQL Data Sources that read Midaz. The panel lists the PostgreSQL Data Sources that you registered. It does not list Data Sources provided by the platform.
3
Find the proposals
Click Find proposals. Each proposal shows the name, the CNPJ, and the proposed scope in each Data Source.
4
Confirm a proposal
Click Confirm on a proposal. The New Institution form opens with the proposal filled in. Review it, then click Save. When you close the form, the proposals panel opens again.
Edit an institution
Click the name of the institution, or select Edit in the row menu. Change the fields, then click Save.
Delete an institution
Select Delete in the row menu and confirm. After the deletion, you can register the same CNPJ again at once.
Where institutions apply
When the tenant has several institutions, Regulatory Filing also shows these items:
- Each subscription shows the institution it files for, or No institution set. Set the institution before you generate a draft.
- Activate for another institution appears on an activated document when an institution does not file it yet.
- Set institution in the menu of a subscription changes the institution for the next filings. Reports already generated keep their institution.
regulatory:post. Mapping its fields and setting its institution need regulatory:put. Deactivating a subscription needs regulatory:delete. Approving a draft needs regulatory-approval:post.
Next steps
- Use Generate a Report to generate a Report for an institution.
- Use Managing Data Sources to register the Data Sources that a scope names.