FlowmageDocs

List table for many employees

BetaReads data

Reads a Bob table for up to 200 employees at a time.

Settings

SettingWhat it is
ConnectionRequiredThe HiBob connection the step signs in with.
TableSalary history, Equity grants, Variable pay and Deductions are sensitive: the service user's group needs View and Edit on the fields, and View history on the category.
EmployeesLeave empty for everyone Bob lets this service user see. Bob takes at most 200 ids in one request; anyone asked for and not answered comes back under Errors.
Include archived entriestrue/false
Fetch every pageFollows Bob's cursor, and refuses past 20,000 entries rather than answering a short list.
Entries per call1 to 200. Bob's own default is 50.
Start at cursorThe Next cursor from an earlier run of this node, to carry on where it stopped. Bob's cursors expire — leave this empty to start at the beginning.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `hibob`)
table"work" or "employment" or "salaries" or "lifecycle" or "deduction" or "dependents" or "entitlement" or "equities" or "right-to-work" or "variable", by default "work"
employeeIdstext
includeArchivedtrue/false, by default false
returnAlltrue/false, by default false
limitnumber, by default 50
cursortext

Output

FieldType
resultsEntriesarray
entryCountEntries in this answernumber
errorsEmployees Bob could not answer forarray
hasMoreMore entries are waiting behind this pageboolean
nextCursorstring
Sample output, and the expression for each field
  • entryCount0
  • errors[]
  • hasMorefalse
  • nextCursor""
  • results[]

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>",
    "cursor": "",
    "employeeIds": "",
    "includeArchived": false,
    "limit": 50,
    "returnAll": false,
    "table": "work"
  },
  "label": "List table for many employees",
  "type": "hibob.listBulkTableEntries",
  "version": 1
}