Connect Vena#
Reportworq refreshes Vena report templates - Excel workbooks built with Vena's reporting features, where each linked cell carries Vena's own tuple metadata. Reportworq reads that metadata and queries Vena's Public Export API to bring current values back into the workbook, so a template built by a Vena administrator can be refreshed, parameterized, and distributed by Reportworq without anyone reopening it in Vena.
The connection reads data from Vena only. It does not write values back to Vena.
Before you begin#
- You are a Reportworq administrator. Only administrators can add or configure datasource connections.
- Vena's Public Export API must be enabled for your Vena account. This is a Vena-side setting, not something Reportworq can turn on. Ask your Vena administrator or account manager to enable it before you add the connection; if it is not enabled, Test connection fails with a specific error (see Troubleshooting below).
- You have a Vena application token - a dedicated
apiUserandapiKeypair, generated in Vena and described below. Reportworq authenticates with this token, not with a personal Vena sign-in. - You know your Vena Hub - the subdomain of the Vena URL you sign in to, for example
us6forhttps://us6.vena.io. Enter just the subdomain (us6); if you paste the full URL instead, it is reduced to its subdomain automatically when you save or test the connection.
Create a Vena application token#
An application token is a Vena-side credential meant for integrations like Reportworq, separate from any person's own Vena sign-in. Create it in Vena as an Administrator:
- Sign in to Vena and open the Admin tab.
- Select Application Tokens, then Add Application Token.
- Give the token a name (for example,
Reportworq) and select Save. - Select the new token, then select Show Token. Vena displays the token's apiUser and apiKey values.
Copy both values now - you enter apiUser as the Reportworq API User field and apiKey as the
API Key field. Treat them like a password; Reportworq stores the API Key encrypted on the connection.
The token's Vena user also needs read permission on every Vena model you plan to report on. A token that can sign in but cannot read a specific model returns a permission error when a job touches that model; see Troubleshooting.
Add the connection in Reportworq#
Sign in to Reportworq as an administrator and go to Settings > Integrations. Datasource connectors live under the DATASOURCES heading.
Select Add integration, find Vena in the catalog, and add it. The connection editor opens.
Select Enable datasource connection and give the connection a Datasource Name. This name is how parameters and formulas refer to the datasource, so it must be unique across the instance and is awkward to change later.
Enter the three connection fields:
Reportworq field What it is Vena Hub Just the subdomain of your Vena URL, for example us6forhttps://us6.vena.io. If you paste the full URL instead, it is reduced to its subdomain automatically when you save or test the connection.API User The apiUservalue from your Vena application token.API Key The apiKeyvalue from your Vena application token. Masked once saved.Select Test connection. A reachable, correctly configured connection succeeds. If it fails, see Troubleshooting below.
Select Save.
Troubleshooting#
Test connection errors#
Test connection only queries a fixed, non-existent model (model 0) to confirm Reportworq can reach your Vena Hub and authenticate - it does not check access to any of your real models.
| Vena response | Meaning | What to do |
|---|---|---|
| 422 - "The Public Export API feature is not enabled for this customer." | Your Vena account has not turned on the Public Export API. | Ask your Vena administrator or account manager to enable the Public Export API for your Vena account, then test again. |
| 401 - "Invalid authentication credentials" | The API User or API Key is wrong, or does not belong to a valid application token. | Check the API User and API Key against the values shown for the token in Vena (Admin > Application Tokens > the token > Show Token). |
| A TLS or certificate error (for example, the remote certificate is not trusted) | Reportworq verifies Vena's HTTPS certificate against the server's trusted certificate authorities and rejects a connection it cannot verify. This typically happens when a proxy or firewall inspects HTTPS traffic with its own certificate. | Install your organization's inspection certificate in the Reportworq server's trusted root store, or exempt the Vena Hub address from HTTPS inspection, then test again. |
| A successful response that is not a Vena API response | Reportworq reached something at the Vena Hub address, but the response is not from Vena's API - for example, a proxy or gateway login page returned instead. This usually means the Vena Hub subdomain is wrong. | Check the Vena Hub value, then test again. |
Each error is shown in the Reportworq toast prefixed Error connecting to Vena: .
Model permission errors during a job#
| Vena response | Meaning | What to do |
|---|---|---|
| 403 - access denied | The token's Vena user does not have read permission on the specific model a report or job is reading. Because Test connection only queries model 0, this error does not appear until a report or job actually reads a model the token cannot access. | In Vena, grant the application token's user read access to the model, then run the report or job again. |
Prepare a Vena template#
A Vena report template is an Excel workbook you build with Vena's own reporting features, the same way you would for Vena's native refresh. Reportworq reads the tuple metadata Vena stores on each linked cell and asks Vena's API to resolve a current value for it.
Save and upload the template with its data cleared. Reportworq only overwrites a cell whose Vena tuple it can fully resolve. A cell Reportworq cannot resolve is left exactly as it was saved - so a template saved with old values keeps showing those old, stale values for anything Reportworq could not refresh, rather than an error or a blank cell. Clearing the data before saving means an unsupported cell reads as blank rather than as a number that looks current but is not.
A small set of Vena template features are not evaluated by Reportworq today:
- Attribute cells.
- Dimension-operator-start expressions.
- Named ranges that reference a Vena global variable.
- Dynamic ranges whose Filter Type is set to Dynamic.
- A few other dynamic-range filter expressions.
If a template uses one of these, the affected cells keep their saved (cleared) value rather than resolving through Reportworq. Rebuild the affected area with plain member-based ranges where you need it refreshed by Reportworq, or accept that those cells are not refreshed.
Use Vena as a report source#
Reportworq can also browse straight into Vena and add a workbook stored there as a report source, through a Vena report provider. This is a separate integration from the connection above, and it adds nothing to configure: it holds no credentials of its own and instead uses every enabled Vena data source connection's API User and API Key (see Create a Vena application token above; the Public Export API note there still applies to the connection test) as its list of roots.
- Go to Settings > Integrations, select Add integration, and add Vena from the Report Providers family.
- Select Enable Integration and Save. There is nothing else to fill in on this pane.
- On a job's Reports step, select Add a Report. Every enabled Vena connection appears as a root in the provider tree, listed under Vena templates.
- Browse into a connection: Vena folders and processes are listed together, sorted alphabetically by
name - a folder and a process look alike in the tree, so watch the icon, not the position, to tell
them apart. Open a process to reach its Files Library - the sub-folders and Excel workbooks
(
.xlsx,.xlsm,.xls) Vena stores for that process. Select a workbook and confirm with OK, the same as any other provider. A folder, process, or file kept in a hidden, deleted, or system Vena folder does not appear in the tree at all.
Upload and New Folder work only inside a process's Files Library (a process itself, or a folder inside one) - select the process or folder first, then use Upload File(s) or New Folder from there. Uploading a file whose name already exists in that Vena folder is refused, to avoid creating a duplicate file: Reportworq can't replace an existing Vena file, so it doesn't offer the usual Overwrite prompt for Vena the way it does for a writable provider - a file whose name already exists is reported as not uploaded ("A file named 'X' already exists here, so it was not uploaded. Rename or remove it in the source system first." - "the source system" is Vena), while every non-clashing file in the same upload still goes through. Rename it in Vena, or upload it under a different name, then try again.
Rename, move, and delete are not supported from Reportworq. Do these in Vena itself; Reportworq's Select a Report dialog shows those buttons grayed out for this provider.
A saved reference to a Vena file is found again by its saved file id even after the file moves to
another folder within the same process - the id, not the path, is what Reportworq resolves first. If
a file is moved to a different process, or the id can no longer be found, Reportworq falls back to
its friendly path (connection/folder or process/.../file.xlsx) and finds the file again only if
something with that same name and path has since been re-created at that location; a genuine
cross-process move is not found by either route. A
dynamic, parameter-driven source path
for this provider takes the same form: connection/.../process/.../file.xlsx.
The provider must be enabled (its own Enable Integration switch above) before its connections appear in the Select a Report dialog - a disabled Vena report provider disappears from the picker even if the underlying Vena data source connections are still enabled. A job that references a file through a Vena connection that has since been disabled or deleted reports it plainly - "This Vena data source connection no longer exists or is disabled. Check the Vena connection under Data Sources." - rather than a generic file-not-found error.
If a report or job call to Vena's file manager (browsing, uploading, downloading, or creating a folder) fails with a 403, it means the application token's Vena user does not have access to that process's Files Library specifically - grant it there and try again; this is a different permission from the model read-access the Troubleshooting table above describes.
A note on who can reach what#
Enabling the Vena report provider lets any Reportworq user who can edit a job browse, upload into, and create folders in every process Files Library that the connection's application token can see - not just the models the token is scoped to read. Every upload made this way is recorded in Vena as having been made by the token's own Vena user, not the Reportworq user who triggered it. Scope the application token's Vena permissions with this in mind: grant it only the Files Library access your Reportworq users actually need to browse and upload into.
A template added this way still needs its data cleared before you save it in Vena. Everything in Prepare a Vena template above applies just the same, whichever way the workbook reached Reportworq: Reportworq can only refresh a cell whose Vena tuple fully resolves, and a cell it cannot refresh keeps showing whatever value the workbook was saved with.
Where to store a Vena template#
You are not limited to browsing Vena directly - a Vena template can also live in any other configured report provider Reportworq can read: Workspace Files, SharePoint, OneDrive, Box, Google Drive, or a network share. Point your Distribution Job at that copy, and Reportworq refreshes its Vena-linked cells against the connection you configured here, exactly as it would for a copy browsed from Vena itself.
Use Vena data in a job#
Once the connection tests:
- Add the Vena report template as a source report in a Distribution Job. Reportworq resolves the Vena tuples on the sheet and fills them from the connection at run time.
- The connector adds a Vena Dimension parameter type for selecting a Vena process, model, dimension, and members - use it to drive multi-copy or burst output the same way you would with any other dimension-based parameter. See Parameterize a report and Burst with parameters.
Related#
- Connect a data source for the general add, test, and manage flow.
- Connector catalog for the full list of connectors and their traps.
- Data models for building curated, reusable data for report authors.
Feedback on this page
Comments, questions, requests, or something missing or unclear? Email us - the page you are on is filled in for you.
Email feedback on this pageOr write to support@reportworq.com directly.