528
edits
Job Board Component: Difference between revisions
no edit summary
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
== Intro == | == Intro == | ||
This component | The <code>JobBoard</code> is a versatile web component designed for job listings. This component can fetch and display job posts from a given endpoint and also allows for search functionality based on a variety of criteria. | ||
== 3B Portals Compatibility == | == 3B Portals Compatibility == | ||
This component is fully compatible with 3B Portals | This component is fully compatible with 3B Portals. Simply drag and drop it in a portal page. | ||
== Set Up == | == Set Up == | ||
| Line 10: | Line 10: | ||
When creating a Job Board record in the system, please set the following fields: | When creating a Job Board record in the system, please set the following fields: | ||
* Name - this is the name of the job board and must match one of the options defined on the Job Boards multi-select field on the job object | |||
* Job Post Link (b3o__Job_Post_Link__c) - this is a template link telling the Job Board component where to re-direct the user when they click on a Job Post. A valid value is https://.../JobPost?id={0}. The {0} param will be merged with either the Job Id or the Job Reference | * Job Post Link (b3o__Job_Post_Link__c) - this is a template link telling the Job Board component where to re-direct the user when they click on a Job Post. A valid value is https://.../JobPost?id={0}. The {0} param will be merged with either the Job Id or the Job Reference | ||
| Line 67: | Line 68: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== | == Attributes == | ||
=== | === User and Job Board Settings === | ||
* user-id | * <code>user-id</code>: User's unique ID. | ||
* job-board-name - | * <code>job-board-name</code>: The name of the job board. | ||
* <code>portal-post-link</code>: The link when embedded in 3B Portals which defines the Job Post page. | |||
=== Customization and Overrides === | |||
* <code>default-search-radius</code>: Sets the default search radius (default is <code>10</code>). | |||
* <code>places-api-key</code>: Key for Google Places API, if using. | |||
* <code>job-object-name</code>: The API name of the job object (default is <code>b3o__Job__c</code>). | |||
=== Search Parameters === | |||
* <code>search-radius-opts</code>: Options for the search radius dropdown. | |||
=== Field Paths for ATS Integration === | |||
These attributes define the field paths for specific pieces of data within your ATS (Applicant Tracking System). Defaults are provided, but can be overridden for customization: | |||
* default-search-radius - defaults to 10 | * default-search-radius - defaults to 10 | ||
* places-api-key - not set by default | * places-api-key - not set by default | ||
| Line 79: | Line 94: | ||
* site-coordinates-path = 'b3o__Site__r.b3o__Coordinates__c' - for radius search, this is the coordinates of the job | * site-coordinates-path = 'b3o__Site__r.b3o__Coordinates__c' - for radius search, this is the coordinates of the job | ||
* job-board-path = 'b3o__Job_Boards__c' - the job boards multi-select field | * job-board-path = 'b3o__Job_Boards__c' - the job boards multi-select field | ||
* job-title-path = 'b3o__Job_Advert_Title__c' | * job-title-path = 'b3o__Job_Advert_Title__c' | ||
* job-short-path = 'b3o__Job_Post_Short_Description__c' | * job-short-path = 'b3o__Job_Post_Short_Description__c' | ||
* job-body-path = 'b3o__Job_Post_Body__c' | * job-body-path = 'b3o__Job_Post_Body__c' | ||
| Line 85: | Line 100: | ||
* job-featured-path = 'b3o__Featured_Job__c' | * job-featured-path = 'b3o__Featured_Job__c' | ||
* job-posted-path = 'b3o__Date_Posted__c' | * job-posted-path = 'b3o__Date_Posted__c' | ||
* siteFieldPath = 'b3o__Site__c' | * siteFieldPath = 'b3o__Site__c' | ||
* site-name-path = 'b3o__Site__r.b3o__Public_Name__c' | * site-name-path = 'b3o__Site__r.b3o__Public_Name__c' | ||
* job-type-path = 'b3o__Job_Type__r.Name' | * job-type-path = 'b3o__Job_Type__r.Name' | ||
| Line 100: | Line 115: | ||
Note: for attributes that are not documented, please see the 3B Job object's fields. | Note: for attributes that are not documented, please see the 3B Job object's fields. | ||
== URL Parameters == | |||
The <code>JobBoard</code> component can pre-populate filters using URL parameters. For example, to filter by employment type, location, job type, and keyword, the URL might look like:<syntaxhighlight lang="text"> | |||
.../JobBoard?employmentType=Contract&location=London&jobType=Vaccinator&keyword=blah | |||
</syntaxhighlight> | |||
[[Category:3B Onboarding]] | [[Category:3B Onboarding]] | ||
[[Category:3B Portals]] | [[Category:3B Portals]] | ||