ecms_dataset

Property Manager name: Message Store data set selection
Behavior version: The v2024-01-09 rule format supports the ecms_dataset 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 ecms_database 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 `ecms_database` behavior, requests to objects in this data set follow the pattern: `<hostname>/datastore/<database_name>/<object_key>`.		{"displayType":"string","tag":"input","type":"text"}
`extract_location`	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.
`header_name`	string	Specifies the request header that passed the data set name. By default, it points to `X-KV-Dataset`.	`extract_location` is `CLIENT_REQUEST_HEADER`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"extractLocation","op":"eq","value":"CLIENT_REQUEST_HEADER"}}
`query_parameter_name`	string	Specifies the query string parameter that passed the data set name. By default, it points to `dataset`.	`extract_location` is `QUERY_STRING`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"extractLocation","op":"eq","value":"QUERY_STRING"}}
`regex_pattern`	string	Specifies the regular expression that matches the data set name in the URL.	`extract_location` is `REGEX`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"extractLocation","op":"eq","value":"REGEX"}}