diff --git a/stroom-state/stroom-planb-impl/README.md b/stroom-state/stroom-planb-impl/README.md index 1842c479a5..6d1f808fd7 100644 --- a/stroom-state/stroom-planb-impl/README.md +++ b/stroom-state/stroom-planb-impl/README.md @@ -25,7 +25,45 @@ Just like the previous state store implementation, Plan B can store data in the * Temporal Ranged State * Session -Each of these store types require data to be descrided in specific ways, however the first 4 types will work with data specified in the same way as any existing reference data. +Each of these store types require data to be described in specific ways, however the first 4 types will work with data specified in the same way as any existing reference data, e.g. + +```xml + + + cityToCountry + cardiff + Wales + + + countryToCity + wales + cardiff + + + + + employeeIdToCountry + 1001 + 1700 + UK + + ... + +``` + +Sessions are specified with the following XML, although the reference-data schema has yet to be updated to reflect this: + +```xml + + + user1_app1 + + 15m + + ... + +``` + Specifics for each state type will be discussed later in this document. Because the data required for the first 4 types is the same as current reference data, it is easy for users to load data into these stores by just creating a new pipeline that is similar to the `Reference Loader` standard pipeline.