Package Setup
Firstly, it is necessary to install the Broadbean package into the client's org - contact the Seven20 Product team to obtain the link for the latest package version. Seven20's Broadbean package is dependent on the following core product packages:
- Seven20 - Utilities
- Seven20 - Core
- Seven20 - Parse and Match
- Seven20 - Integration Utilities
User Setup
Every user who uses the integration should have the Broadbean Username (seven20__Broadbean_Username__c) field populated on their user record and have the Broadbean Permissions permission set assigned.
Credential Configuration
The below configuration metadata records must be updated with values provided by Broadbean:
- Broadbean API Key (Broadbean_API_Key)
- Broadbean Client Id (Broadbean_Client_Id)
- Broadbean Secret (Broadbean_Secret)
iFrame Setup
Two iFrames are available as part of the integration and both can be added to any Job (seven20__Job__c) lightning record page as required.
Posting iFrame
The posting iFrame component Broadbean iFrame allows for the sending and management of Job adverts in Broadbean.
Responses iFrame
The responses iFrame component Broadbean Response iFrame allows for the management of applications against Job adverts in Broadbean.
The Responses iFrame uses Broadbean's optional Manage Responses add-on; clients should contact their Broadbean account manager to enable it if required
Job References
The Broadbean integration supports configurable Job References; see here for details.
Applications
Once a Job has been posted to Broadbean, any applications sent through to Seven20 via the API will result in the creation of either a Job Board Application or an Application. This option is controlled via the Broadbean Applications Straight To ATS Seven20 Configuration Metadata setting; the default state for the setting is Active = FALSE, which results in Job Board Applications being created.
The candidate details on the application received from Broadbean will also be used either to create a new candidate record in Seven20 or to update an existing one, if a matching record is found. Candidate matching uses the email address as the unique identifier.
Webhook Setup
Create Permissions
Create a new permission set called Broadbean guest site standard fields and assign the below permissions:
| Type | Name | Access |
|---|---|---|
| Object | Account | Read, Create |
| Field | Account.Name | Read, Edit |
Create a site in Salesforce
- In Salesforce setup, create a site
- Assign the below permission sets to the Site:
- Broadbean guest site standard fields
- Broadbean guest site
- A delivery URL based on this site needs to be provided to Broadbean. To obtain this, copy the URL of the site and append the following: services/apexrest/seven20/broadbean/candidate/push/
Configuration Options
Various configuration options are available to change the behaviour of the integration, these are controlled by Seven20 Configuration Metadata records:
| Configuration Name | Details |
|---|---|
| Integration Job owner field | Dictates who will be the owner of new candidates and applications. Must be a user lookup field on Job. The default value is OwnerId. |
| Integration Override File Owner | If active the owner of any inserted files will be the same as the ‘Integration job owner field’ otherwise it will be the guest site user. |
| Integration maintain candidate source | Being active will maintain a candidate source field in the case of updates. If set to inactive the integration will overwrite the source. Default is active. |
| Integration Parse Candidates | See reparsing for details |
| Integration use aggregator file name | When active the system uses the file name provided by Broadbean. If inactive Seven20 will generate a file name. Default is active. |
| Broadbean Applications Straight To ATS | If active, applications received from Broadbean will be created as seven20__Application__c records; if inactive, seven20__Job_Board_Application__c records. Default is inactive. |
| Job Board Reference Field | Defines what field should be mapped as the reference when posting Jobs, must be populated with the API Name of a field on the Job object. The default value is seven20__Job_Board_Reference__c |