- Property Manager name: Message Store database selection
- Behavior version: The
v2024-08-13
rule format supports theecmsDatabase
behavior v1.0. - Rule format status: GA, stable
- Access: Read/Write
- Allowed in includes: No (temporarily)
Edge Connect Message Store is available for Internet of Things: Edge Connect users. It lets you create databases and data sets within these databases. You can use this object store to save files smaller than 2 GB. ecmsDatabase
specifies a default database for requests to this property, unless indicated otherwise in the URL. To access objects in the default database, you can skip its name in the URLs. To access objects in a different database, pass its name in the header, query parameter, or a regular expression matching a URL segment. You can also configure the ecmsDataset
behavior to specify a default data set for requests.
Option | Type | Description | Requires | |
---|---|---|---|---|
database | string | Specifies a default database for this property. If you don't configure a default data set in the | {"displayType":"string","tag":"input","type":"text"} | |
extractLocation | enum | Specifies where to pass a database name in requests. If the specified location doesn't include the database name or the name doesn't match the regular expression, the default database 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 database 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 database 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 database name in the URL. | extractLocation is REGEX | {"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"extractLocation","op":"eq","value":"REGEX"}} |