Organization Reports Module

The module adds a report from your app to the Reports of a Crowdin Enterprise organization. In Permission granularity mode, the report also appears in the Reports of each group.

The module is available only in Crowdin Enterprise. To add a report to a project, use the Reports module.

Access

You can grant access to this module to one of the following user categories:

• Only admins
• Admins, managers and developers / translation requestors
• Custom Access

Within the chosen category, organization admins see the report in the organization and in every group, and group managers see it in the groups they manage.

Structure

manifest.json

{
  "modules": {
    "group-reports": [
      {
        "key": "your-module-key",
        "name": "Module name",
        "description": "Module description",
        "logo": "/logo.png",
        "url": "/reports-page"
      }
    ]
  }
}

Properties

key	Type: string Required: yes Description: Module identifier within the Crowdin app.
name	Type: string Required: yes Description: The human-readable name of the module.
description	Type: string Description: The human-readable description of what the module does. The description will be visible in the Crowdin Enterprise UI.
logo	Type: string Description: The relative URL to the report’s logo that will be displayed in the Crowdin Enterprise UI. If not set, the app’s logo is used. The recommended resolution is 48x48 pixels.
url	Type: string Required: yes (self-hosted apps only) Description: The relative URL to the content page of the module that will be integrated into the Crowdin Enterprise UI.
environments	Type: string Allowed values: crowdin-enterprise Description: Set of environments where a module could be installed. This parameter is needed for cross-product applications.

Organization and Group Levels

Crowdin Enterprise opens the same module url for the organization and for its groups. When the report is opened in a group, the context includes group_id (the ID of that group) in both the JWT token payload and the AP.getContext() response. Without group_id, the report is opened in the organization’s Reports.

Crowdin Enterprise adds group_id to the token after it checks the user’s access to that group, so use the token value to decide which data the report shows.