This is the documentation for ConfiForms Server/Data Center app
However, this might also work for ConfiForms cloud and in most cases it does. But please see this page to understand the differences between server and cloud versions of the ConfiForms app.
Since version 1.53.4 we have introduced couple of experimental APIs which help you to make a bridge between ConfiForms web-services backed fields and Excel files attached to your Confluence page.
3 services:
These 2 APIs are available at the following URLs:
File format | API URL | Method |
---|---|---|
Excel 97-2004 (xls) | https://YOUR_CONFLUENCE_SERVER/ajax/confiforms/rest/excel-2json.action | GET |
Excel (xlsx) | https://YOUR_CONFLUENCE_SERVER/ajax/confiforms/rest/excel2007-2json.action | GET |
CSV (default format) | https://your_confluence_server/ajax/confiforms/rest/csv-2json.action | GET |
Services expect/support the following parameters:
Parameter | Description | Type | Required |
---|---|---|---|
attachmentId | Attachment ID of the Excel file attachment to use as source | Numeric | Yes |
skipRows | Number of rows to skip (from the top). Defaults to 0 (rows to skip, from the top of the sheet) | Numeric | No |
idCellNum | Which column to use as ID | Numeric | No |
labelCellNum | Which column to use as label | Numeric | No |
lookupValue Since 2.27.21 | Can supply a lookup value for the service to lookup. The subset returned will be filtered to match (as substring) the given value | Text | No |
lookupField Since 2.27.23 | Limiting the matching logic to specific field (cell) Example: cell1 to limit to cell1 value only. If not specified then the match for given lookupValue is done against the whole row (all cells) | Text | No |
exactMatch Since 2.27.24 | You can set the search to use "exact match", by default (when exactMatch is unspecified or false) the search is done as text substring match (case insensitive) | Boolean | No |
Column and rows numbering starts with 0
NB! Only the first sheet from Excel file is currently supported!
Examples:
Last example reads ALL the rows and columns (skipping just the first one) and creates a structure similar to the one listed below
[ { "cell2": "uno", "cell3": "in cell 3", "cell1": "1" }, { "cell2": "duo", "cell1": "2" }, { "cell2": "tres", "cell3": "here is cell three", "cell1": "3" }, { "cell2": "four", "cell1": "4" }, { "cell2": "five", "cell1": "5" }, { "cell2": "six", "cell1": "6" } ]
From the following excel file
As you can see, we can create a JSON Array structure that perfectly fits our ConfiForms web-service enabled fields
So, here is how you can create a ConfiForms Form which uses this file and shows it's values in the dropdown
Configuration for ConfiForms looks like this
With "myvalues" field configured as web-service dropdown
We have defined new connection to use the above mentioned excel to JSON APIs
And set the mapping to use cell1 as ID column for the dropdown and cell2 as a label
And you can see the online results right here
Date created |
My excel values |
myvalues.id |
myvalues.cell1 |
myvalues.label |
myvalues.cell3 |
---|---|---|---|---|---|
2022-09-13 16:57 | 2 | 2 | 2 | 2 | 2 |
2022-10-09 12:13 | 5 | 5 | 5 | 5 | 5 |
2022-11-09 05:03 | 6 | 6 | 6 | 6 | 6 |
2022-11-14 11:31 | 4 | 4 | 4 | 4 | 4 |
2022-11-16 16:59 | 1 | 1 | 1 | 1 | 1 |
2022-11-21 18:02 | 1 | 1 | 1 | 1 | 1 |
2022-11-21 21:19 | 1 | 1 | 1 | 1 | 1 |
2022-11-22 00:48 | 1 | 1 | 1 | 1 | 1 |
2022-11-30 03:29 | 2 | 2 | 2 | 2 | 2 |
2022-12-13 10:53 | 4 | 4 | 4 | 4 | 4 |
2022-12-13 10:59 | 6 | 6 | 6 | 6 | 6 |
2022-12-13 10:59 | 1 | 1 | 1 | 1 | 1 |
2022-12-14 12:24 | 6 | 6 | 6 | 6 | 6 |
2022-12-14 12:24 | 1 | 1 | 1 | 1 | 1 |
2022-12-16 03:05 | 4 | 4 | 4 | 4 | 4 |
2022-12-22 14:22 | 1 | 1 | 1 | 1 | 1 |
2023-01-05 08:51 | 1 | 1 | 1 | 1 | 1 |
2023-01-20 18:05 | 1 | 1 | 1 | 1 | 1 |
2023-01-26 14:38 | 1 | 1 | 1 | 1 | 1 |
2023-01-31 10:10 | 2 | 2 | 2 | 2 | 2 |
2023-02-08 16:53 | 1 | 1 | 1 | 1 | 1 |
2023-02-16 06:55 | 1 | 1 | 1 | 1 | 1 |
2023-02-20 15:57 | 1 | 1 | 1 | 1 | 1 |
2024-02-28 14:29 | 2 | 2 | 2 | 2 | 2 |
2024-03-06 09:18 | 2 | 2 | 2 | 2 | 2 |
2024-03-11 14:57 | 1 | 1 | 1 | 1 | 1 |
2024-04-18 03:16 | 1 | 1 | 1 | 1 | 1 |
2024-04-18 03:17 | 3 | 3 | 3 | 3 | 3 |
2024-04-26 17:09 | 3 | 3 | 3 | 3 | 3 |
2024-05-04 00:40 | 1 | 1 | 1 | 1 | 1 |
2024-05-08 14:09 | 1 | 1 | 1 | 1 | 1 |
2024-05-15 11:46 | 3 | 3 | 3 | 3 | 3 |
2024-06-18 11:48 | 6 | 6 | 6 | 6 | 6 |
2024-07-03 18:43 | 2 | 2 | 2 | 2 | 2 |
2024-07-03 18:43 | 4 | 4 | 4 | 4 | 4 |
2024-07-04 13:05 | 2 | 2 | 2 | 2 | 2 |
2024-07-05 13:33 | 5 | 5 | 5 | 5 | 5 |
2024-08-21 07:57 | 3 | 3 | 3 | 3 | 3 |
2024-08-28 13:45 | 1 | 1 | 1 | 1 | 1 |
2024-08-29 05:49 | 1 | 1 | 1 | 1 | 1 |
2024-09-18 21:33 | 1 | 1 | 1 | 1 | 1 |
2024-09-19 03:35 | 1 | 1 | 1 | 1 | 1 |