Define an External Searcher

All external search access configuration procedures are available here.

An External Searcher is represented in the system as a custom metadata record of type Textkernel searcher authentication.

This guide assumes that you have a list of the external searchers supported in the Textkernel integration that you want to activate. See Textkernel's list of supported job boards and configuration requirements for more information. Some are configured out of the box, but you will still need to activate them.

Record Configuration

Each record has a number of configuration options. For each of the jobClosed boards you want to enable, repeat the following steps:

  1. Navigate to Setup > Custom Metadata Types > Textkernel searcher authentication.
  2. Fill in the fields below as follows:
    Field NameDescription

    Label

    Display name of the job board/External Searcher. Used in the UI for Users to enter their credentials

    Textkernel searcher authentication Name

    The Developer Name (populated automatically) for the record. Used as part of authorisation to use an External Searcher

    Country

     

    Searcher Access Type

    How credentials are managed for the External Searcher:

    TKClosed Search! Reference

    The stem of an identifier used by Search! for an External Searcher (e.g. monster)

    TK Source! Reference

    The stem of an identifier used by Source! for an External Searcher 

    Credential Keys

    Only applicable when credentials are managed per User. 

    A Comma separated list of the keys for the credential fields, for example username,password.   

    These are shown in the UI for Users to enter their credentials, for example: cvlibrary_registered_email, cvlibrary_username, cvlibrary_password

    Credentials

    Only applicable when the credentials are managed org wide,

    While the Credentials Keys field captures the format of the authentication required by an external searcher, in the Credentials field, you enter the actual credentials for the job board.

    The definition is in key/value pairs such as:

    key1:value1

    key2:value2

    The value can be a (custom) field on the current User or a literal value. Keys come for the external job board and should be provided by Textkernel.

    Note: For the formatting, don't use a delimiter, such as:

    cat:catcode

    Use json key:pair instead:

    {

        "cat":"catcode"

    }

    Active

    Enable

    Default

    Defines whether the External Searcheer is available for all users

  • Please disregard any other fields. The ones listed above are the only ones in use.
  • Please always double-check with Textkernel about the format of the credentials (json) and access to job boards, as they may change.

TK Search!/Source! Validation Rule

A validation rule ensures that at least one of TK Search! reference of TK Source! Reference is populated. Having two separate references allows for a number of scenarios:

  • The same External Searcher has different keys between TK Source! and TK Search!. By populating both references for the same record, credentials are re-used for both search brokers making management by admins and users simpler. [Obviously this also works if they have the same keys - the reference is just entered in both fields].
  • Management of credentials or authorisation is different between TK Search! and TK Source!. In this case, multiple records can be used to represent the same 3rd party search provider, and each would be treated as a separate External Searcher; one for TK Source! and one for TK Search!. In each record, only one reference field is populated. Note that Users would need to manage credentials independently in this case.
  • The External Searcher is only available through one broker. Only one metadata record is needed, and only one reference field would be populated.

Next Procedure

External Searcher Authorisation