Load from cache shape

Introduction

The load from cache shape is used to retrieve a stored payload from an existing cache key (created from an add to cache shape).

You might configure a load from cache shape in the same process flow as the original add to cache step or - if a cache was added and set to company level - you might choose to load it in a different process flow.

Adding & configuring a load from cache shape to a process flow

To add a load from cache shape to a process flow, follow the steps below.

Step 1 Find the point in your process flow where you want to load the payload from a cache - this could be at the very start of a process flow, or perhaps somewhere further down.

Step 2 Select the load from cache shape from the shapes palette:

Step 3 Click in the select cache field and choose which cache you want to retrieve:

In this list, you'll find any caches that have been added to this process flow (via the add to cache shape), together with any caches that have been added to other process flows and set to a cache level of company.

Step 4 Enter the cache key that you want to retrieve - for example:

Your given cache key might be static or dynamic, depending on how the cache was configured in the corresponding add to cache shape:

Cache key	Summary	Example
Static	Data is cached to the key exactly as it is specified. Typically used when your aim it to load the entire cache later in the flow (or in other flows).	orders
Dynamic	The cache key resolves dynamically based on a payload variable. Typically used when your aim it to load single or multiple items from the cache later in the flow (or in other flows). For more information please see our Generating dynamic cache keys with payload variables.	order-[[payload.0.id]] OR order-[payload.*.id]]

For detailed information about each of these approaches, please see What cached data do you want to load?

The cache key must be associated with an existing add to cache shape, either in the same process flow or (in the case of company-level caches) in another process flow.

Step 5 If you want this process flow to fail if for any reason this cache can't be retrieved, tick the fail on cache miss option:

If you leave this option un-ticked, the process flow will continue to run if the cache can't be loaded.

Step 6 If the cache that you're loading was created with the save all pages option toggled ON, you should toggle the load all pages option ON when loading this data:

When paginated data is pulled from a connection shape, a payload is created for each page. If the save all pages option is toggled ON when a cache is created, the payload for each page is saved to its own cache key (with key names generated dynamically from a specified key and page numbers). If the save all pages option is toggled OFF, all pages are saved to a single cache key. For more information please see our Cache pagination options.

Step 7 Save changes. The load from cache shape is added to your process flow, displaying the given name and key - for example:

Can I see the data associated with a load from cache shape?

Yes. As with any other process flow shape, you can view the associated payload for a load from cache shape after the process flow has run. To do this, click the shape's tick icon and then select the payload tab in the run log panel - for example: