URL Parameters🔗
Passing URL parameters to TKPortal🔗
The TK Portal URL varies depending on where the customer account is hosted. In this document, an example of such URL will be used, but a Textkernel consultant can provide the correct URL for any specific customer.
TKPortal example base URL: https://home.textkernel.nl/portal/
When using the TK Portal URL, additional URL parameters can be passed for further use in the Search! application. The TK Portal URL would follow a structure like so:
https://home.textkernel.nl/portal/?PARAMETER1=VALUE&PARAMETER2=VALUE#TKPORTAL_TAB_NAME
Important
When using SAML SSO, URL parameters that should be passed, need to be appended to the SSO-initiating URL in a specific format. Please refer to your Textkernel Technical consultant for further information.
By default, TK Portal accepts the following URL parameters:
| Parameter name | Description |
|---|---|
query |
used for defining a Search query |
candidateId |
used for Actions back |
jobId |
used for Actions back |
URL Encoding
It is advised to URL-encode all parameters, as a matter of best practice.
Selecting a TK Portal tab🔗
It is possible to instruct TK Portal to display and/or pass parameters to a desired tab in the UI.
This can be achieved by sending a parameter at the end of the URL (URL fragment).
If a selection is not provided, TK Portal will select the first tab by default.
For a standard integration the following values can be used for selecting one of the Search! tabs:
| Parameter name | Description |
|---|---|
#candidateSearch |
Selects the Candidate Search! tab |
#jobSearch |
Selects the Jobs Search! tab |
TK Portal URL common use cases🔗
The most common use cases for passing URL parameters are:
- Opening Search! with a default query
- Initiating a Match! workflow from the integrating application
Any additional parameters to be propagated to Search! must be configured by a Textkernel consultant. If this configuration is not in place, the additional parameters will be ignored.
Opening Search! with a default query🔗
In order to open a Search! environment with a default query, the parameter query can be used. This parameter accepts a query in the Search! query language. A Textkernel consultant can help defining how to structure the query and what the correct query language is for each use case.
This parameter should be used in combination with the selector of a TK Portal tab (see section Selecting a TK Portal tab).
For example: to open the Search! Job environment (#jobSearch) with a default full-text query to search for 'java developer' jobs, the following URL can be used:
https://home.textkernel.nl/portal/?query=%22java%20developer%22#jobSearch
Note that the parameters are URL-encoded.
Initiating a Match! workflow from the integrating application🔗
It is possible to open a Search! environment matching directly from a candidate or job record in the integrating party system. To do so, the parameters candidateId and jobId can be used:
candidateId: can be used to match from a candidate record in the Search! Candidates environment to jobs in the Search! Jobs environment. It should be used in combination with the tab selector#jobSearch;jobId: can be used to match from a job record in the Search! Jobs environment to candidates in the Search! Candidates environment. It should be used in combination with the tab selector#candidateSearch.
Both parameters expect the ID of the record as provided when indexing it in the corresponding Search! environment.
Hiding Tabs and Contents🔗
With url parameter, it is possible to show only one or some tabs and their contents and hide the others.
tabs: use this parameter with the tabs to show only the desired content. If we want to show only candidateSearch, we can filter other tabs by only providing the URLhttps://home.textkernel.nl/portal/?tabs=candidateSearch. To show multiple tabs the value of the parameter must be comma separated.
Important
To use this feature, please refer to your Textkernel technical consultant for further information.