---
title: "Page TSconfig Reference (tx_crawler.crawlerCfg)"
manual: "Crawler"
version: "main"
permalink: "https://docs.typo3.org/permalink/tomasnorre/crawler:page-tsconfig@main"
source: "Configuration/PageTsconfigReference(txCrawlercrawlercfg)/Index.rst"
rendered: "2026-10-16T17:00:27+00:00"
---
# Page TSconfig Reference (tx_crawler.crawlerCfg) {#page-tsconfig}
- **paramSets.\[key\]**
- *Type:* string
Get Parameter configuration. The values of GET variables are according
to a special syntax. From the code documentation
(class.tx_crawler_lib.php):
- Basically: If the value is wrapped in \[...\] it will be expanded
according to the following syntax, otherwise the value is taken
literally
- Configuration is splitted by "|" and the parts are processed
individually and finally added together
- For each configuration part:
- - **"\[int\]-\[int\]" = Integer range, will be expanded to all values in**
between, values included, starting from low to high (max. 1000).
Example "1-34" or "-40--30"
- - **"**\\\_TABLE:**" in the beginning of string indicates a look up in a**
table. Syntax is a string where \[keyword\]:\[value\] pairs are separated
by semi-colon. Example "\_TABLE:tt_content; \_PID:123"
- **\- Keyword " **\\\_TABLE** ": (mandatory, starting string): Value is table**
name from TCA to look up into.
- **\- Keyword " **\\\_ADDTABLE** ": Additional tables to fetch data from.**
This value will be appended to "\_TABLE" and used as "FROM"
part of SQL query.
- **\- Keyword " **\\\_PID** ": Value is optional page id to look in (default**
is current page).
- **\- Keyword " **\\\_RECURSIVE** ": Optional flag to set recursive crawl**
depth. Default is 0.
- **\- Keyword " **\\\_FIELD** ": Value is field name to use for the value**
(default is uid).
- **\- Keyword " **\\\_PIDFIELD** ": Optional value that contains the name of**
the column containing the pid. By default this is "pid".
- **\- Keyword " **\\\_ENABLELANG** ": Optional flag. If set only the records**
from the current language are fetched.
- **\- Keyword " **\\\_WHERE** ": Optional flag. This can be use to e.g. if**
you don't want hidden records to be crawled.
- \- Default: Literal value
**Examples:**
```plaintext
&L=[|1|2|3]
&L=[0-3]
```
**packages/my_extension/Configuration/Sets/MySet/page.tsconfig**
```typoscript
tx_crawler.crawlerCfg.paramSets {
myConfigurationKeyName = &tx_myext[items]=[_TABLE:tt_myext_items;_PID:15;_WHERE: hidden = 0]
myConfigurationKeyName {
pidsOnly = 13
procInstrFilter = tx_indexedsearch_reindex
}
}
```
- **paramSets.\[key\].procInstrFilter**
- *Type:* string
List of processing instructions, eg. "tx_indexedsearch_reindex" from
indexed_search to send for the request. Processing instructions are
necessary for the request to perform any meaningful action, since they
activate third party activity.
- **paramSets.\[key\].procInstrParams.\[procIn.key\].\[...\]**
- *Type:* strings
Options for processing instructions. Will be defined in the respective
third party modules.
**Examples:**
`procInstrParams.tx_staticpub_publish.includeResources=1`
- **paramSets.\[key\].pidsOnly**
- *Type:* list of integers (pages uid)
List of Page Ids to limit this configuration to
- **paramSets.\[key\].force_ssl**
- *Type:* integer
Whether https should be enforced or not. 0 = false (default), 1 = true.
- **paramSets.\[key\].userGroups**
- *Type:* list of integers (fe_groups uid)
User groups to set for the request.
- **paramSets.\[key\].baseUrl**
- *Type:* string
If not set, t3lib_div::getIndpEnv('TYPO3_SITE_URL') is used to
request the page.
MUST BE SET if run from CLI (since TYPO3_SITE_URL does not exist in
that context!)
\[Page TSconfig: tx_crawler.crawlerCfg\]
## Example {#page-tsconfig-example}
**packages/my_extension/Configuration/Sets/MySet/page.tsconfig**
```typoscript
tx_crawler.crawlerCfg.paramSets.test = &L=[0-3]
tx_crawler.crawlerCfg.paramSets.test {
procInstrFilter = tx_indexedsearch_reindex
pidsOnly = 1,5,13,55
userGroups = 1
force_ssl = 1
}
```