HiBobSettings
| Setting | What it is |
|---|---|
| ConnectionRequired | The HiBob connection the step signs in with. |
| Report idRequired | The List reports node gives you the id. |
| Format | "csv" or "xlsx" or "json" |
| Add the report's own header rows | Adds the report's name and the date it ran as extra rows at the top of the file — handy for a human, in the way of a parser. |
| Language | A locale like en-GB or nl-NL. Leave empty for the company's own. |
| List values | Bob only applies this to the rows form. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `hibob`) |
reportId | text |
format | "csv" or "xlsx" or "json", by default "json" |
includeInfo | true/false, by default false |
locale | text |
humanReadable | "" or "APPEND" or "REPLACE"used when `format` is "json" |
Output
| Field | Type |
|---|---|
rows | array |
rowCountRows in this answer | number |
fileThe report as a file | any |
file.name | string |
file.contentType | string |
file.base64File contents (base64) | string |
file.sizeSize in bytes | number |
Sample output, and the expression for each field
- filenull
- rowCount0
- rows[]
Errors
When a step of this node stops a run, the run page shows a code. Look it up:
Example step
The step as a flow file holds it. Replace each value in <…>.
{
"config": {
"connection": "<connection id>",
"format": "json",
"humanReadable": "",
"includeInfo": false,
"locale": "",
"reportId": "<report id>"
},
"label": "Download report",
"type": "hibob.downloadReport",
"version": 1
}