Skip to content
Textkernel Salesforce Connector
Component: Embedded TKPortal
latest

Using embedded TKPortal🔗

TKPortal can be embedded in a candidate or job record, where users can see matching records, finding similar candidates, or rank candidates that have applied to a job.

This is an example of TKPortal embedded in a job record:

Embedded TKPortal

Configuring the TKPortal component🔗

Note

This procedure assumes the existence of a Lightning Record Page for the candidates/jobs, as the TKPortal component is only compatible with Lightning.

  1. Select a candidate or job record.
  2. Go to Setup -> Edit Page to open the Lightning App Builder for your record page.
  3. Drag the custom-managed component Textkernel Portal onto the desired page location.
  4. Select the component, so that the configuration choices are visible on the right-hand side:

    • TKPortal Tabs: a list of TKPortal tab names to display when loading TKPortal. This allows to show only some of the available TKPortal tabs.
    • TKPortal Selected Tab: the tab opened as default when loading TKPortal.
    • Search Record Context: specifies the context in which TKPortal is loaded, either a candidate or a job record.
    • Predefined Query: it is possible to provide an additional query to be used when loading Search within TKPortal.
  5. Click Save to save your changes.

  6. Return to your Vacancy record and now users with access to the widget will see the match results whenever they view a Vacancy.

The above is the basic configuration required to embed TKPortal in a candidate or job record. Each supported use case requires some additional configuration as described below.

Use case: matching a job to the best candidates🔗

In order to implement this use case, the component parameters must be set up as follows:

  • TKPortal Tabs: candidateSearch
  • TKPortal Selected Tab: candidateSearch
  • Search Record Context: jobId
  • Predefined Query: <empty>

Use case: matching a candidate to the best jobs🔗

In order to implement this use case, the component parameters must be set up as follows:

  • TKPortal Tabs: jobSearch
  • TKPortal Selected Tab: jobSearch
  • Search Record Context: candidateId
  • Predefined Query: <empty>

Use case: ranking applicants for a job🔗

In order to implement this use case, the component parameters must be set up as follows:

  • TKPortal Tabs: candidateSearch
  • TKPortal Selected Tab: candidateSearch
  • Search Record Context: jobId
  • Predefined Query: job_submissions.job_id:{RecordID}

Use case: finding similar candidates based on a given candidate🔗

In order to implement this use case, the component parameters must be set up as follows:

  • TKPortal Tabs: candidateSearch
  • TKPortal Selected Tab: candidateSearch
  • Search Record Context: candidateId
  • Predefined Query: -docid:{RecordID}