Appearance
Report Optional feature
A report publishes the content of a notebook as a snapshot at the time it's published. You can share analysis results even with members and guests who don't have connection permissions. Viewing a report requires logging in to Codatum.
Granting permissions and inviting guests after publishing is done from the report side. See Invitations and joining for guest invitations, and Report permissions for details on permissions. See Sharing for a comparison of sharing methods, and Comment for comments.
TIP
This is an optional feature. Depending on your contract, it might not be available.
List
Open global nav > Reports to view reports you have access to. You can filter using the following tabs in the left sidebar.
| Tab | Description |
|---|---|
| All reports | A list of the reports you can view. |
| Recently viewed | Reports you've recently opened. |
| Newly added | Reports that were recently published. |
| Published by me | Reports you've published. |
| Starred | Reports you've starred. |
You can also filter by tag. Use Manage tags to go to the tag management screen.
Publishing
Publishing requires publish permission on the source notebook, and publish permission on the connections used by the pages being published. Notebooks accessed through a shared folder can't be published. See Report permissions for details on permissions.
- Open Share on the notebook screen, then select the Report tab.
- Select Create report.
- Configure the following, then select Publish.
| Item | Description |
|---|---|
| Report name | The name of the report. Defaults to the notebook name. You can also set an icon. |
| Pages to publish | The pages to publish. At least one page other than a section divider is required. Defaults to all pages. |
| Embedded connections | Automatically extracted from the pages being published. Publish permission on the target connections is required. |
| Report type | Determines the range of operations available to viewers. Defaults to Interactive report. |
| Publish options | Available options depend on the report type. |
After publishing, you can do the following from the Published reports list.
- Select the name to open the report.
- Publish changes: republishes to reflect changes to the notebook. You can check the diff with Compare notebook before publishing.
- Report settings: go to the report screen's settings, permissions, and invitations.
- Compare with current notebook
- Delete
Changes to the notebook itself aren't automatically reflected. You need Publish changes to reflect them. Republishing is also required to change the report type, or to change a publish option that requires republishing.
Publish settings
You choose the report type and options when publishing. These publish settings determine the range of operations available to report viewers. If you change the report type, or change a publish-time option that requires republishing, you need to select Publish changes again.
Report types
| Type | Description |
|---|---|
| Interactive report | Viewers can edit parameters and re-run SQL. |
| Refreshable report | Viewers can only re-run SQL. |
| Static report | Shows a fixed display of the run results at the time of publishing. SQL can't be re-run. |
Publish options
The following options aren't available for a static report.
| Option | Description | Applies to |
|---|---|---|
| Enable downloads | Lets report viewers download the source data. | Interactive report |
| Enable Explorer | Lets report viewers explore the source data. | Interactive report |
| Use fixed parameters | Fixes some parameters within the report. When enabled, Embed data at publish time can't be used, and Enable auto-run is turned on. | Interactive report / Refreshable report |
| Embed data at publish time | Publishes with the SQL run results at the time of publishing embedded. | Interactive report / Refreshable report |
| Enable auto-run | Automatically runs SQL when the page loads. Turned on automatically if data isn't embedded. Can be changed after publishing from Report settings without republishing. | Interactive report / Refreshable report |
| Use parameter default values | Uses parameter default values on auto-run. Dynamic default values, such as relative dates, are also recalculated. If there are fixed parameters, the fixed values take priority. Can be changed after publishing from Report settings without republishing. | Interactive report (when auto-run is enabled) |
Permissions and invitations are configured on the report side after publishing.
Report settings
From Report settings on the report screen, you can change the following settings without republishing. Changing them requires publish permission on the source notebook. Auto-run and Use parameter default values are the same items as the publish options.
| Setting | Description |
|---|---|
| Report name / Tags | The report's display name and report tags. |
| Auto-run | Automatically runs SQL when the page loads. Always on if data isn't embedded at publish time. |
| Use parameter default values | Uses parameter default values on auto-run (interactive report). See Relative dates for how relative dates are handled. |
| Sync parameter changes across pages | Syncs changes to notebook-wide parameter values across published pages (interactive report). See Parameter for details. |
| Cache duration | The maximum period SQL run results can be reused. 0 disables caching; the maximum is 24 hours, in 10-minute increments. |
| Hide SQL block | Hides SQL blocks and built SQL. |
| Show only results within SQL block | Hides the SQL portion and built SQL within a SQL block. Can't be set if Hide SQL block is enabled. |
| Disable comments | Disables comments. See Comment for details. |
Publish settings on the same screen shows the report type and publish options. To change them, go to the sharing screen from Edit and republish.
Permissions and invitations
Open Share report from Share on the report screen to configure the following.
- Users with access: grant or remove Report Viewer for a user or group.
- Invite guest by email: invite a user who hasn't joined the workspace as a guest. You can check or cancel pending invitations from Pending guest invitations.
See Report permissions and Invitations and joining for details.
Report analytics
Open Report analytics in the report screen's header to check viewing activity. You can choose from the following periods (default is Last 7 days).
| Period | Description |
|---|---|
| Last 7 days | The most recent 7 days. |
| Last 30 days | The most recent 30 days. |
| All time | The entire period since publishing. |
The following metrics are shown.
| Metric | Description |
|---|---|
| Total views | The number of views within the period. |
| Unique users | The number of users who viewed it within the period. |
| Average view duration | The average view duration within the period. |
In the user list, you can check Name / First access / Last access.
Specification
- Re-running SQL, downloads, and the Explorer within a report don't require connection permission. A report viewer can run them if allowed by the publish settings.
- The number you can create has a limit that depends on your contract (see Limits).
- A workspace policy can disable guest invitations by workspace editors.
When you can't publish
Check the following.
- Whether you have publish permission on the source notebook (notebooks accessed through a shared folder can't be published).
- Whether you have publish permission on the connections used by the pages being published.
- Whether you've reached the limit on the number of reports (global nav > Workspace settings > Usage).