Stores

Stores are a central entity in workflow. You can use them to collect data, to modify records in existing workflows via lookup mappings, and you can use them to send data to other applications. We'll dive into greater detail in this section.

Store options

A store belongs to at minimum one of these three categories:

• sources: you're collecting data. That could be e.g. a Google spreadsheet you want to process, or the Workflow API which you can post data to.
• targets: you're sending data to other applications. A target store contains the logic to process incoming records with the integration-specific logic, i.e. pushing data to the "GMail Send" store will categorize your inbox, or it will create drafts for you.
• modifiers: use them as a step in your workflow to enrich records via lookup tables.

You can see all existing store options in the store catalogue:

Adding stores

Each store has its own logic to be added; generally, you can click on Add store if you want to add one. The logic to add a store ranges from authenticating Google via Oauth up to creating a schema. In our example here, we create a "Workflow Read" store by defining which fields we'd like to have in the store:

Maintaining stores

For every store, you can look into the current entries:

In some cases, you can enter data manually:

What options you have in a store is highly depending on the integration used to build that store. For the "Workflow Read" store, you can also post data to the store via API (see also below):

Synchronizing a store with refinery

One of the key benefits of using workflow is that you can synchronize stores with refinery. For instance, if you have an inbox you want to use to steadily grow your database, you can simply set up a refinery project from the store itself.

Once you set up a synchronization, a batch job will be started to push the current store data to a newly created refinery project. Afterwards, new incoming data is directly sent to the refinery project and appended to the database.

Store API

You can easily retrieve stores from workflow via their unique ID and an access token you create in the application. This is helpful if you want to monitor the size of your stores programmatically, or if you want to add new entries to the API.

The store model

The store model contains informations such as the name, integration, and the entries.

Properties

The store entry model

The store entry contains information about the storeId, its data and the timestamp when it was created.

Properties

Retrieve a store

curl https://app.kern.ai/workflow-api/stores/WAz8eIbvDR60rouK?page=1 \
  -H "Authorization: {token}"

{
  "id": "1e844bf2-5ebb-40a5-8aa4-7e6b5e79479a",
  "organizationId": "8502b0fb-cfaf-45ce-b0a7-71231cb8e769",
  "name": "My store",
  "integration":
  "Workflow Read",
  "description": "Reads data from an API or a UI",
  "icon": "workflow",
  "entries": [{
    "id": "87e71284-4c3f-46a1-a58c-55ccc08c7349",
    "storeId": "1e844bf2-5ebb-40a5-8aa4-7e6b5e79479a",
    "record": {"field_1": "This is an example!"},
    "timestamp": "2023-02-13T20:22:03.260008"
    }, {
      "id": "6e86b3ad-5436-4c23-bfb2-036216166c76",
      "storeId": "1e844bf2-5ebb-40a5-8aa4-7e6b5e79479a",
      "record": {"field_1": "Hello World"},
      "timestamp": "2023-02-13T20:21:59.775006"
  }],
  "numEntries": 2,
  "numPages": 1,
  "pageSize": 25,
  "configSetup": {
    "config": {"field_1": "Text"}
  },
  "configActions": {},
  "state": "RUNNING",
  "refineryProjectId": "None"
}

Post an entry

curl -X DELETE https://app.kern.ai/workflow-api/stores/WAz8eIbvDR60rouK/add-entry \
  -H "Authorization: {token}"

{
  "id": "70ecd4ad-9270-43ea-b439-5ee628833016",
  "storeId": "1e844bf2-5ebb-40a5-8aa4-7e6b5e79479a",
  "record": {"field_1": "Text"},
  "timestamp": "2023-02-13T20:25:57.822324"
}