All adverts and candidate applications to adverts, are identified over the Broadbean API by a combination of filters.
The filterable attributes consist of the Custom Field properties of an advert. These attributes are propagated to all candidate applications for the corresponding advert.
Filterable properties are attributed to an advert via the "vacancy_details" XML in the "Post + Dashboard" API call. The Custom Field values are attached to adverts created via the initial advert post, and adverts resent via the "Edit and Repost" functionality of the Dashboard.
Your "vacancy_details" XML should contain sufficient filters to identify that the job/vacancy in your system that the advert corresponds to.
It is recommended that you add the following custom fields as follows:
To identify the job/vacancy, Broadbean recommend using a custom field "JOB_ID".
Add a custom field or combination of such as “ATS_CLIENT_ID” to uniquely identify client instance.
Using Custom Fields
Custom fields are the core mechanism for tracking your vacancy and it's important to understand how they work and certain caveats and restrictions. They can appear in three possible places within the Dashboard component of Bean Widgets:
The Filter node of the Post plus Dashboard call
The Base64 encoded Advert content in the Vacancy Details node of the Post plus Dashboard call
Attached to a previously posted Advert stored in Broadbean
The following is a guide to how they are used:
Custom Fields in the Filter section of the JSON are used to match the postings loaded and displayed in the Dashboard, these are never sent in the postings itself.
Custom fields in the Base64 content of the Vacancy Details are sent in a posting when either ‘Publish' or 'Edit and Resend' is used.
When using ‘Edit and Resend’ any Custom Fields from the original advert are dropped.
When using ‘Edit' or 'Resend Post’ Custom fields from the original advert only are sent in the posting.
Finally, in terms of best practice we advise ensuring the Custom Fields in the Filter section match those in the Vacancy Details section exactly.