Job Post Component: Difference between revisions

From 3B Knowledge
Jump to navigation Jump to search
No edit summary
 
(One intermediate revision by the same user not shown)
Line 92: Line 92:


''Note that attributes will always override URL params and you can mix and match''
''Note that attributes will always override URL params and you can mix and match''
==Setup & ATS Link==
{| class="wikitable"
|+Default Setup (no ATS)
!Portals Attribute
!Component Attribute
!Default Value
!Comments
|-
|Job Board Name
|job-board-name
|Default
|Must match the Name field on the Job Board record in the table Job Boards
|-
|Contact Id
|user-id
| --{-{-contactUser.Id-}-}--
|
|-
|Hide Theme Switch
|hide-theme-switch
|false
|true/false
|-
|Theme
|theme-type
|light
|light/dark
|-
|No Post Message
|post-not-found
|Error 404
|
|-
|No Post Details
|post-not-found-details
|Post not found.
|
|-
|Job Post Link
|portal-post-link
|#JobPost?jobId={0}
|The name of the page that hosts the Job Post component. Use # for portal pages
|-
|Google API Key
|places-api-key
|
|google places api key
|-
|Application Documents Link
|app-documents-link
|/b3o__JobDocuments
|The name of the page that hosts the Compliance component. Use # for portal pages
|-
|Job Object Name
|job-object-name
|b3o__Job__c
|Job object API name
|-
|Featured Path
|job-featured-path
|b3o__Featured_Job__c
|Checkbox indicating job is featured
|-
|Posted Path
|job-posted-path
|b3o__Date_Posted__c
|Date field
|-
|Jobboard Path
|job-board-path
|b3o__Job_Boards__c
|Multi-select, options must match the Name of the Job Board records created in the Job Boards table
|-
|Site Path
|site-field-path
|b3o__Site__c
|Lookup to 3B Site
|-
|Employment Type Path
|emp-type-path
|b3o__Employment_Type__c
|Drop down with employment type options
|-
|Job Type Path
|job-type-field-path
|b3o__Job_Type__c
|Lookup to 3B Job Type
|-
|Site Coordinates Path
|site-coordinates-path
|b3o__Site__r.b3o__Coordinates__c
|
|-
|Job Ref Path
|job-ref-path
|b3o__Job_ID__c
|This field can be used for the URL slug
|-
|Job App Schema
|job-app-schema
|b3o__Application__c:b3o__Job__c:b3o__Candidate__c
|Schema configuration - first string is the API name of the Application object. Second string is the API name of the field on the Application that links the application to a Job. Third string is the API name of the field on the Application that links the application to a Contact.
|-
|Job Title Path
|job-title-path
|b3o__Job_Advert_Title__c
|
|-
|Short Desc Path
|job-short-path
|b3o__Job_Post_Short_Description__c
|
|-
|Job Body Path
|job-body-path
|b3o__Job_Post_Body__c
|
|-
|Footer Path
|job-foot-path
|b3o__Job_Post_Footer__c
|
|-
|Site Name Path
|site-name-path
|b3o__Site__r.b3o__Public_Name__c
|
|-
|Job Type Name Path
|job-type-path
|b3o__Job_Type__r.Name
|
|-
|Pay Info Path
|pay-info-path
|b3o__Pay_Information__c
|Can be a text field or formula, effectively outputting pay info
|-
|Expirty Date Path
|job-expiry-path
|b3o__Available_Until__c
|Date field
|-
|App Form Path
|job-app-form-path
|b3o__Application_Form__c
|Lookup to Form. A form selected in this field must have a core object = Application
|-
|App Button Label Path
|job-app-btn-label-path
|b3o__Apply_Button_Text__c
|If any text is added, default button label will be overriden
|-
|Document Pack Path
|job-doc-pack-path
|b3o__Document_Pack__c
|Lookup to Document Pack. If a record is selected, user will be re-directed to the Compliance page
|-
|Registration Form Path
|job-reg-form-path
|b3o__Registration_Form__c
|Lookup to Form. A form selected in this field must have a core object = Contact
|-
|App: Job Field Path
|job-relationship-field
|b3o__Job__c
|Application to Job lookup field
|-
|App: Candidate Field Path
|candidate-relationship-field
|b3o__Candidate__c
|Application to Contact lookup field
|-
|App Documents Page Params
|app-documents-params
|?id={0}&dpId={1}&applicationId={2}
|do not change
|}
{| class="wikitable"
|+Target Recruit Sample Setup
!Portals Attribute
!Component Attribute
!TargetRecruit Value
!Comments
|-
|Job Board Name
|job-board-name
|Default
|
|-
|Contact Id
|user-id
| --{-{-contactUser.Id-}-}--
|
|-
|Hide Theme Switch
|hide-theme-switch
|true
|
|-
|Theme
|theme-type
|light
|
|-
|Theme
|theme-type
|light
|light/dark
|-
|No Post Message
|post-not-found
|Error 404
|
|-
|Job Post Link
|portal-post-link
|#JobPost?jobId={0}
|
|-
|Google API Key
|places-api-key
|
|
|-
|Application Documents Link
|app-documents-link
|#Compliance
|
|-
|Job Object Name
|job-object-name
|AVTRRT__Job__c
|
|-
|Featured Path
|job-featured-path
|Featured_Job__c
|New checkbox field
|-
|Posted Path
|job-posted-path
|Date_Posted__c
|New date field
|-
|Jobboard Path
|job-board-path
|Job_Boards__c
|New multi-select field
|-
|Site Path
|site-field-path
|Site__c
|New lookup field to Site
|-
|Employment Type Path
|emp-type-path
|Employment_Type__c
|New drop down field
|-
|Job Type Path
|job-type-field-path
|Job_Type__c
|New lookup field to Job Type
|-
|Site Coordinates Path
|site-coordinates-path
|Site__r.b3o__Coordinates__c
|
|-
|Job Ref Path
|job-ref-path
|Name
|
|-
|Job App Schema
|job-app-schema
|AVTRRT__Job_Applicant__c:AVTRRT__Job__c:AVTRRT__Contact_Candidate__c
|Schema configuration
|-
|Job Title Path
|job-title-path
|AVTRRT__Job_Title__c
|
|-
|Short Desc Path
|job-short-path
|AVTRRT__Job_Summary__c
|
|-
|Job Body Path
|job-body-path
|AVTRRT__Job_Description_Rich__c
|
|-
|Footer Path
|job-foot-path
|AVTRRT__Internal_Notes__c
|Can be any other field
|-
|Site Name Path
|site-name-path
|Site__r.b3o__Public_Name__c
|
|-
|Job Type Name Path
|job-type-path
|Job_Type__r.Name
|
|-
|Pay Info Path
|pay-info-path
|Pay_Information__c
|New custom text field
|-
|Expirty Date Path
|job-expiry-path
|Available_Until__c
|New custom Date field
|-
|App Form Path
|job-app-form-path
|Application_Form__c
|New lookup to Form, form record with context object AVTRRT__Job_Applicant__c
|-
|App Button Label Path
|job-app-btn-label-path
|Apply_Button_Text__c
|
|-
|Document Pack Path
|job-doc-pack-path
|Document_Pack__c
|New lookup to Document Pack
|-
|Registration Form Path
|job-reg-form-path
|Registration_Form__c
|New lookup to Form with Contact context object
|-
|App: Job Field Path
|job-relationship-field
|AVTRRT__Job__c
|Application to Job lookup field
|-
|App: Candidate Field Path
|candidate-relationship-field
|AVTRRT__Contact_Candidate__c
|Application to Contact lookup field
|-
|App Documents Page Params
|app-documents-params
|?id={0}&dpId={1}
|Notice, no applicationId
|}
[[Category:3B Onboarding]]
[[Category:3B Onboarding]]
[[Category:3B Portals]]
[[Category:3B Portals]]

Latest revision as of 04:09, 3 July 2024

Intro

This component renders an ATS job and allows a user to apply

3B Portals Compatibility

This component is fully compatible with 3B Portals

Implementation

Portals

Drag and drop the component on any page. You can customize the component properties from the Traits Manager.

Visualforce Pages

You can embed the component component in a Visualforce Page using the following syntax:

<!-- Load Supporting Components and Global Functions -->
<script src="{!URLFOR($Resource.b3o__GeneralUtils, 'index.js')}" defer="true" type="module"></script>

<!-- This Component -->
<script src="{!URLFOR($Resource.b3o__JobPostResources, 'index.js')}" defer="true" type="module"></script>

<job-post 
    job-id="{!$CurrentPage.parameters.id}" 
    job-board-name="Default"
></job-post>

<script>
    const globals = {
        sessionId: '{!GETSESSIONID()}',
        siteUrl: '{!$Site.baseUrl}',
        useREST: false,
        router: b3o.GlobalRemotingRouter
    };
    window['globals'] = globals;
</script>

External Websites

You can embed the component component in a wordpress/custom sites using the following syntax:

<!-- Make sure to point the beginning of the URL to your guest site endpoint -->
<!-- Load Supporting Components and Global Functions -->
<script src=".../b3o__GeneralUtils/index.js" defer="true" type="module"></script>

<!-- This Component -->
<script src=".../b3o__JobPostResources/index.js" defer="true" type="module"></script>

<job-post 
    job-board-name="Default"
></job-post>

<script> 
    const globals = {
        siteUrl: '.../Onboarding/',
        useREST: true
    };
    window['globals'] = globals;
</script>

Options and ATS Config

Attributes

  • job-id - the Job record Id or Reference
  • external-post-link - overrides the Job Post Link field from the Job Board and allows you to define how to get to the page where the <job-post> component is embedded
  • list-view - controls whether to show as list or as block
  • job-board-name - we will match the value provided in this attribute against the defined Job Boards field value on the Job object
  • job-object-name = 'b3o__Job__c' - the job object name
  • job-app-schema = 'b3o__Application__c:b3o__Job__c:b3o__Candidate__c' - the app schema - Application Object Name : Job Object Name : Merge Field Name from App -> Job
  • job-board-path = 'b3o__Job_Boards__c' - the job boards multi-select field
  • job-title-path = 'b3o__Job_Advert_Title__c'
  • job-short-path = 'b3o__Job_Post_Short_Description__c'
  • job-body-path = 'b3o__Job_Post_Body__c'
  • job-foot-path = 'b3o__Job_Post_Footer__c'
  • job-featured-path = 'b3o__Featured_Job__c'
  • job-posted-path = 'b3o__Date_Posted__c'
  • siteFieldPath = 'b3o__Site__c'
  • site-name-path = 'b3o__Site__r.b3o__Public_Name__c'
  • job-type-path = 'b3o__Job_Type__r.Name'
  • job-type-field-path = 'b3o__Job_Type__c'
  • employment-type-path = 'b3o__Employment_Type__c'
  • pay-info-path = 'b3o__Pay_Information__c'
  • job-ref-path = 'b3o__Job_ID__c'
  • job-expiry-path = 'b3o__Available_Until__c'
  • job-reg-form-path = 'b3o__Registration_Form__c'
  • job-app-form-path = 'b3o__Application_Form__c'
  • job-app-btn-label-path = 'b3o__Apply_Button_Text__c'
  • job-doc-pack-path = 'b3o__Document_Pack__c'

Note: for attributes that are not documented, please see the 3B Job object's fields.

URL Params

id or jobId - the Job record Id or Reference

Note that attributes will always override URL params and you can mix and match

Setup & ATS Link

Default Setup (no ATS)
Portals Attribute Component Attribute Default Value Comments
Job Board Name job-board-name Default Must match the Name field on the Job Board record in the table Job Boards
Contact Id user-id --{-{-contactUser.Id-}-}--
Hide Theme Switch hide-theme-switch false true/false
Theme theme-type light light/dark
No Post Message post-not-found Error 404
No Post Details post-not-found-details Post not found.
Job Post Link portal-post-link #JobPost?jobId={0} The name of the page that hosts the Job Post component. Use # for portal pages
Google API Key places-api-key google places api key
Application Documents Link app-documents-link /b3o__JobDocuments The name of the page that hosts the Compliance component. Use # for portal pages
Job Object Name job-object-name b3o__Job__c Job object API name
Featured Path job-featured-path b3o__Featured_Job__c Checkbox indicating job is featured
Posted Path job-posted-path b3o__Date_Posted__c Date field
Jobboard Path job-board-path b3o__Job_Boards__c Multi-select, options must match the Name of the Job Board records created in the Job Boards table
Site Path site-field-path b3o__Site__c Lookup to 3B Site
Employment Type Path emp-type-path b3o__Employment_Type__c Drop down with employment type options
Job Type Path job-type-field-path b3o__Job_Type__c Lookup to 3B Job Type
Site Coordinates Path site-coordinates-path b3o__Site__r.b3o__Coordinates__c
Job Ref Path job-ref-path b3o__Job_ID__c This field can be used for the URL slug
Job App Schema job-app-schema b3o__Application__c:b3o__Job__c:b3o__Candidate__c Schema configuration - first string is the API name of the Application object. Second string is the API name of the field on the Application that links the application to a Job. Third string is the API name of the field on the Application that links the application to a Contact.
Job Title Path job-title-path b3o__Job_Advert_Title__c
Short Desc Path job-short-path b3o__Job_Post_Short_Description__c
Job Body Path job-body-path b3o__Job_Post_Body__c
Footer Path job-foot-path b3o__Job_Post_Footer__c
Site Name Path site-name-path b3o__Site__r.b3o__Public_Name__c
Job Type Name Path job-type-path b3o__Job_Type__r.Name
Pay Info Path pay-info-path b3o__Pay_Information__c Can be a text field or formula, effectively outputting pay info
Expirty Date Path job-expiry-path b3o__Available_Until__c Date field
App Form Path job-app-form-path b3o__Application_Form__c Lookup to Form. A form selected in this field must have a core object = Application
App Button Label Path job-app-btn-label-path b3o__Apply_Button_Text__c If any text is added, default button label will be overriden
Document Pack Path job-doc-pack-path b3o__Document_Pack__c Lookup to Document Pack. If a record is selected, user will be re-directed to the Compliance page
Registration Form Path job-reg-form-path b3o__Registration_Form__c Lookup to Form. A form selected in this field must have a core object = Contact
App: Job Field Path job-relationship-field b3o__Job__c Application to Job lookup field
App: Candidate Field Path candidate-relationship-field b3o__Candidate__c Application to Contact lookup field
App Documents Page Params app-documents-params ?id={0}&dpId={1}&applicationId={2} do not change
Target Recruit Sample Setup
Portals Attribute Component Attribute TargetRecruit Value Comments
Job Board Name job-board-name Default
Contact Id user-id --{-{-contactUser.Id-}-}--
Hide Theme Switch hide-theme-switch true
Theme theme-type light
Theme theme-type light light/dark
No Post Message post-not-found Error 404
Job Post Link portal-post-link #JobPost?jobId={0}
Google API Key places-api-key
Application Documents Link app-documents-link #Compliance
Job Object Name job-object-name AVTRRT__Job__c
Featured Path job-featured-path Featured_Job__c New checkbox field
Posted Path job-posted-path Date_Posted__c New date field
Jobboard Path job-board-path Job_Boards__c New multi-select field
Site Path site-field-path Site__c New lookup field to Site
Employment Type Path emp-type-path Employment_Type__c New drop down field
Job Type Path job-type-field-path Job_Type__c New lookup field to Job Type
Site Coordinates Path site-coordinates-path Site__r.b3o__Coordinates__c
Job Ref Path job-ref-path Name
Job App Schema job-app-schema AVTRRT__Job_Applicant__c:AVTRRT__Job__c:AVTRRT__Contact_Candidate__c Schema configuration
Job Title Path job-title-path AVTRRT__Job_Title__c
Short Desc Path job-short-path AVTRRT__Job_Summary__c
Job Body Path job-body-path AVTRRT__Job_Description_Rich__c
Footer Path job-foot-path AVTRRT__Internal_Notes__c Can be any other field
Site Name Path site-name-path Site__r.b3o__Public_Name__c
Job Type Name Path job-type-path Job_Type__r.Name
Pay Info Path pay-info-path Pay_Information__c New custom text field
Expirty Date Path job-expiry-path Available_Until__c New custom Date field
App Form Path job-app-form-path Application_Form__c New lookup to Form, form record with context object AVTRRT__Job_Applicant__c
App Button Label Path job-app-btn-label-path Apply_Button_Text__c
Document Pack Path job-doc-pack-path Document_Pack__c New lookup to Document Pack
Registration Form Path job-reg-form-path Registration_Form__c New lookup to Form with Contact context object
App: Job Field Path job-relationship-field AVTRRT__Job__c Application to Job lookup field
App: Candidate Field Path candidate-relationship-field AVTRRT__Contact_Candidate__c Application to Contact lookup field
App Documents Page Params app-documents-params ?id={0}&dpId={1} Notice, no applicationId