- Property Manager name: Message Store data set selection
- Behavior version: The
v2024-10-21
rule format supports theecmsDataset
behavior v1.0. - Rule format status: GA, stable
- Access: Read/Write
- Allowed in includes: No (temporarily)
Specifies a default data set for requests to this property unless indicated otherwise in the URL. To access objects in this data set, you can skip the data set name in the URLs. To access objects in a different data set within a database, pass the data set name in the header, query parameter, or a regular expression pattern matching a URL segment. You can also configure the ecmsDatabase
behavior to specify a default database for requests.
Option | Type | Description | Requires | |
---|---|---|---|---|
dataset | string | Specifies a default data set for this property. If you don't configure a default database in the | {"displayType":"string","tag":"input","type":"text"} | |
extractLocation | enum | Specifies where to pass a data set name in requests. If the specified location doesn't include the data set name or the name doesn't match the regular expression pattern, the default data set is used. | {"displayType":"enum","options":["CLIENT_REQUEST_HEADER","QUERY_STRING","REGEX"],"tag":"select"} | |
CLIENT_REQUEST_HEADER | Name is a request header. | |||
QUERY_STRING | Name is a query parameter. | |||
REGEX | Name matches the URL. | |||
headerName | string | Specifies the request header that passed the data set name. By default, it points to | extractLocation is CLIENT_REQUEST_HEADER | {"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"extractLocation","op":"eq","value":"CLIENT_REQUEST_HEADER"}} |
queryParameterName | string | Specifies the query string parameter that passed the data set name. By default, it points to | extractLocation is QUERY_STRING | {"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"extractLocation","op":"eq","value":"QUERY_STRING"}} |
regexPattern | string | Specifies the regular expression that matches the data set name in the URL. | extractLocation is REGEX | {"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"extractLocation","op":"eq","value":"REGEX"}} |