The following JSON message will be passed to the rule from a website. The Realtime Input will receive this JSON.

{
  "Customer Id": 1,
  "Email Address": "ExampleOne@domain.com",
  "Customer Name": "Example One",
  "Order Date": "28/02/2020 11:14:00",
  "Order Number": "12345",
  "Product Name": "3 Seater Sofa"
}

The Decode JSON will decode the JSON into fields:

Image Modified

The Access cache step will write the data to a cache table in cassandra using the “customer Id” as the primary key:

Image Modified

Step Type

• Read values from the cache

• Write values into the cache (Update / Insert)

• Update numeric values in the cache (Increment / Decrement)

• Delete from the cache

• Field Value - Write discrete field values to the cache

Server names(s)

The name of the cache server(s) you are using. If the rule is running in Journey Orchestration then this is automatically populated when the Template is loaded and the provided here value will be ignored.

In the example below we are looking at the template in Template builder where this value and the keyspace are automatically configured.

Keyspace

Tables exist in a Keyspace (similar to a database). If the rule is running in Journey Orchestration then this is automatically populated when the Template is loaded and the provided here value will be ignored.

In the example below we are looking at the template in Template builder where this value and the keyspace are automatically configured.

This is only required if you are running this plugin locally.

Table

The name of the table which will be created in Cassandra. If left blank this will be the same as the key field name.

Expiry Time (secs)

The amount of time in seconds after which the data in the cache table should expire. This can be specified as either a static value or populated by a value in a field:

Image Modified

Specifying the value in a field allows the time to be dynamically populated for each row of data.

See this page for the default values that are applied to the data saved to the cache. Several layers can apply.

Update TTL Value after Reading

With this option selected each read of a value in the cache will automatically rewrite the value. This allows the the expiry time set above to be reapplied. This ensures that data that is regularly used is persisted and data that is not accessed is safely and cleanly removed after the chosen timeframe.

Key

The field that contains the unique key (primary key) which identify items in the cache. e.g. Customer ID or Order ID

Timeseries

Allows you to save the data against specific timeseries

Read

The column to read from the cache specifying the:

1. The data type (String or Integer) to read

2. The Cassandra column name to read from the cache table

3. The rule field name to write the data into. Note: If the field doesn't exist then the plugin will create a new field

4. The default value to return if the Key doesn't exist within the table

Image Modified

When the Server name, Keyspace and Table are configured correctly in the step screen clicking on Get Fields* in the top bar will popup a dialogue that shows the fields already available in the chosen table:

1. You can highlight fields singularly or select multiple fields using Shift and Control.

2. Alternatively select the fields you do NOT want and click on delete leaving only those you want for your selection

3. Once you have your chosen fields click on OK and the chosen fields will be added.

4. We will take the existing field name and default the field name to created to be the same value.

Note: The Get Fields functionality only works when calling the remote DDE server and does not work when run locally

Write

The column to write into the cache specifying the:

1. The data field name within the rule to that should be written to the cache

2. The Cassandra column name to write the data into

3. How to write to the table

Image Modified

When the step is placed into a Rule clicking on Get Fields* in the top bar will popup a dialogue that shows the fields flowing into the step:

1. You can highlight fields singularly or select multiple fields using Shift and Control.

2. Alternatively select the fields you do NOT want and click on delete leaving only those you want for your selection

3. Once you have your chosen fields click on okay and the chosen fields will be added.

4. We will default the cache column with the same value as the mapped field.

5. We will default the Timestamp value to Timestamp. This can be changed by the user if required.

How to Write…

Overwrite - Will replace the current value with the new value.

Append - Will append the current value to the existing values.

Append if not already present - Will check to see if the value being written already exists. If the column contains the value, nothing is written.  If the column does NOT contain the value, the value is appended.

Write Once - This options writes a column to the cache ONCE for a specific key.  If the column contains a value, nothing is written.  If the column does NOT contain a value, the value is written. Additionally, if a value was written AND the step is doing error handling, the row will be placed on the error branch as a "cache miss".

Update

For numeric values only:

1. increment or decrement the cache column value

2. The Cassandra cache column to increment / decrement

3. The static number to increment / decrement the column by

4. The rule field containing the number to increment / decrement the column by

Image Modified

When the Server name, Keyspace and Table are configured correctly in the step screen clicking on Get Fields in the top bar will popup a dialogue that shows the fields already available in the chosen table:

1. You can highlight fields singularly or select multiple fields using Shift and Control.

2. Alternatively select the fields you do NOT want and click on delete leaving only those you want for your selection

3. Once you have your chosen fields click on OK and the chosen fields will be added.

Delete

The column to delete from the cache specifying the:

1. The data type (String or Integer) to delete

2. The Cassandra column name to delete from the cache table

3. Only delete the value in the cache if the data is older / newer than the specified column

Image Modified

When the Server name, Keyspace and Table are configured correctly in the step screen clicking on Get Fields* in the top bar will popup a dialogue that shows the fields already available in the chosen table:

1. You can highlight fields singularly or select multiple fields using Shift and Control.

2. Alternatively select the fields you do NOT want and click on delete leaving only those you want for your selection

3. Once you have your chosen fields click on OK and the chosen fields will be added.