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:
- excel-2json
- excel2007-2json
- csv-2json (starting from ConfiForms 2.27.17 - Release Notes#Version2.27.17)
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 |
| Info |
|---|
Column and rows numbering starts with 0 |
| Warning |
|---|
NB! Only the first sheet |
...
from Excel file is currently supported! |
Examples:
...
| ConfiForms Form Definition | ||
|---|---|---|
| ||
Configuration for ConfiForms looks like this
...
| ConfiForms (FormView) Registrations Control | ||
|---|---|---|
| ||
All the registrations so far (and yes, we can access ANY other field, like cell3 in our views, see below)
| ConfiForms TableView | ||
|---|---|---|
| ||