App Framework

Tasks

Tasks form the backbone of our framework and are tailored for each individual app. They hold crucial configurations and are responsible for executing specific operations. You can manage tasks by creating, editing, or deleting them according to your requirements. It’s important to note that task configurations are app-specific. Tasks can be executed manually or scheduled, and disabling or deactivating a task stops its operations.

Operations

Operations represent the actual outcomes of tasks. They encompass various data such as time data, logs, and generated files. Certain operations might require input files uploaded beforehand. Operations can exist in different states such as created, queued, running, failed, completed, or archived, indicating their current condition.

Filters

Introduction

Our platform empowers users to design filters, refining search results according to their needs. When designing a filter, you have a plethora of options to narrow down your search result.

Creating a filter

Step 1:

Go to the top right corner of your browser and select the settings icon:

Step 2:

Select the Filters option. Choose create to create a filter.

Step 3:

Edit your filter, give it a recognizable label, criteria and classification level. See Setting up a filter.

Step 4:

Use your created filter in combination with a task.

Setting up a filter

Classification level

Our products are organized into two main topologies: product and product-model. Each topology comprises two classification levels. The Classification Level Filter enables you to specify the exact classification level or topology you require.

Connection

Selection the connection you want to combine your filter with. This step is currently not required if you only have one connection.

Criteria

Combination
You can create combinations by combining multiple criteria. Due to API limitations, each criteria use the AND statement, significantly reducing the result set.

Example:
"product enabled EQUALS true" AND "description NOT EMPTY"

Scope option: locale or scope 'Provided by Task'

This option allows the task to specify the correct Channel or Locale when using the filter. However, not all tasks may support or fill this option.

Filter Examples

Here are some examples to illustrate the capabilities of creating filters.

Attribute Criteria (Filter on Product Attribute Values)

• • Text attribute
    field: decription
    operator: NOT EMPTY
    locale: en_US
    channel: null
    This filter searches for text descriptions where the locale is set to en_US and is not empty.
    
    

  • Boolean Attribute
    field: publish_on_website
    operator: EQUAL
    value: true
    locale: en_US
    channel: null
    This filter searches for boolean attributes where the value is set to true.
    
    

Product system field criteria (Filter on product system fields)

• Enabled products
  field: enabled
  operator: EQUAL
  value: true
  locale: null
  channel: null
  This filter searches for boolean attributes where the value is set to true.
  
  

• By categories
  field: categories
  operator: IN
  value: master
  locale: null
  channel: null
  This filter searches for products within the ‘master’ category.
  
  

• By families
  field: families
  operator: IN
  value: shoes
  locale: null
  channel: null
  This filter searches for products within the ‘shoes’ family.