Greenhouse Connector CLI Setup Guide

Prerequisites

Please complete these steps before adding in the CLI

note

Please note that both the terminologies slice and connector in CLI commands refer to connector.

Step 1 : Download an existing configuration

To get a template for the Greenhouse connector configuration save the output of the describe command as follows:

mkdir <config-directory>
datacoral connector describe --slice-type ingest_greenhouse > <config-directory>/<params>.json

Step 2 : Update the parameters file

Modify the input parameters file (Ex.greenhouse_input_params.json) by adding the below fields.

Example template:

{
"sliceName": "",
"sliceType": "ingest_greenhouse",
"targetWarehouses": [],
"connectionConfiguration": {
"apiKey": {
"encrypt": true,
"key": ""
}
},
"extractConfiguration": {
"schedule": "",
"backfill": ""
}
}

Confidential columns in specific loadunits can be excluded from being written to S3 and Warehouse with the columnBlacklist parameter in the extractConfiguration of each loadunit. In the below example template, custom_fields and keyed_custom_fields are excluded for applications loadunit using columnBlacklist parameter.

{
"sliceName": "",
"sliceType": "ingest_greenhouse",
"targetWarehouses": [],
"connectionConfiguration": {
"apiKey": {
"encrypt": true,
"key": ""
}
},
"extractConfiguration": {
"schedule": "",
"backfill": ""
},
"loadunits": {
"candidates": {
"extractConfiguration": {
"mode": "incrementalupdate",
"paginate": true,
"timestampCol": "updated_at"
}
},
"applications": {
"extractConfiguration": {
"parent": "candidates",
"ignoreSchedule": true,
"mode": "incrementalupdate",
"paginate": true,
"timestampCol": "last_activity_at",
"columnBlacklist": [
"custom_fields",
"keyed_custom_fields"
]
}
},
"jobs": {
"extractConfiguration": {
"mode": "snapshot",
"paginate": true
}
},
"job_posts": {
"extractConfiguration": {
"mode": "incrementalupdate",
"paginate": true,
"timestampCol": "updated_at"
}
},
"job_stages": {
"extractConfiguration": {
"mode": "incrementalupdate",
"paginate": true,
"timestampCol": "updated_at"
}
},
"offers": {
"extractConfiguration": {
"mode": "incrementalupdate",
"paginate": true,
"timestampCol": "updated_at"
}
},
"scheduled_interviews": {
"extractConfiguration": {
"mode": "incrementalupdate",
"paginate": true,
"timestampCol": "updated_at"
}
},
"users": {
"extractConfiguration": {
"mode": "incrementalupdate",
"paginate": true,
"timestampCol": "updated_at"
}
},
"user_permissions": {
"extractConfiguration": {
"parent": "users",
"ignoreSchedule": true,
"mode": "incrementalupdate",
"timestampCol": "__dc_load_time",
"paginate": true
}
},
"user_roles": {
"extractConfiguration": {
"mode": "snapshot",
"paginate": false
}
},
"scorecards": {
"extractConfiguration": {
"mode": "incrementalupdate",
"paginate": true,
"timestampCol": "updated_at"
}
},
"sources": {
"extractConfiguration": {
"mode": "snapshot",
"paginate": true
}
},
"demographic_question_sets": {
"extractConfiguration": {
"mode": "snapshot",
"paginate": true
}
},
"demographic_questions": {
"extractConfiguration": {
"mode": "snapshot",
"paginate": true
}
},
"demographic_answer_options": {
"extractConfiguration": {
"mode": "snapshot",
"paginate": true
}
},
"demographic_answers": {
"extractConfiguration": {
"mode": "incrementalupdate",
"paginate": true,
"timestampCol": "updated_at"
}
},
"departments": {
"extractConfiguration": {
"mode": "snapshot",
"paginate": true
}
},
"offices": {
"extractConfiguration": {
"mode": "snapshot",
"paginate": true
}
},
"rejection_reasons": {
"extractConfiguration": {
"mode": "snapshot",
"paginate": true
}
},
"tags": {
"extractConfiguration": {
"mode": "snapshot",
"paginate": true
}
},
"eeoc": {
"extractConfiguration": {
"mode": "incrementalupdate",
"paginate": true,
"timestampCol": "submitted_at"
}
}
}
}

Step 3 : Add the connector

datacoral connector add --connector-name <connector-name> --config-directory <config-directory>
  • <connector-name> Name of your connector. A schema with this name is automatically created in your warehouse
  • <config-directory> File path to the input parameters file must be in this directory

Got questions? Interested?

Please contact Datacoral's Support Team, we'd be more than happy to answer any of your questions.