Type	Description

Type	Description
`filter-form-ui`	Allows you to define options and associate a filter to each option. The filter will be applied in the logic deployment process (will be used by the deploy-filter step) if the option is not selected.

Specific Attributes

Attribute Name	Description	Example	Required

Attribute Name

Description

Example

Required

ui

Object containing UI specific fields. Contains:

title – Page title.
description – Page description.

{"title": "Title", "description": "desc"}

true

options

List of options. Contains:

name – Name of the option (must be unique).
title – Title which will be displayed within the option.
ifNotPickedFilter – Filter which will be applied if the option is not selected. All filters are used by the "deploy-logic" step. Structure:
- key – Type descriptor on an entity type (case insensitive name of the folder created by Packaging Tool – DataSource, ProductExtension, etc.). Contains an array of filters which will be applied on the folder.
  - fieldName – Name of a field in an object.
  - notEquals – Value which will be used for comparison.

[
  { 
     "name": "option1",
     "title": "Option 1",
     "description": "really good option", 
     "ifNotPickedFilter": 
         {  
            "productExtension": [ 
               { 
                  "fieldName": "uniqueName", 
                   "notEquals": "PX1"
                },
                { 
                   "fieldName": "uniqueName", 
                   "notEquals": "PX2"
                 }
               ],
             "customerExtension": [ 
                 { 
                    "fieldName": "uniqueName", 
                     "notEquals": "CX1"
                 },
                 {  
                    "fieldName": "uniqueName", 
                    "notEquals": "CX2"
                 }
             ] 
         } 
     }
 ]

true

Example

{
  "type": "filter-form-ui",
  "name": "filter-test",
  "ui": {
    "title": "Rebate Types",
    "description": "description 1"
  },
  "options": [
    {
      "name": "option1",
      "title": "Option 1",
      "description": "really good option",
      "ifNotPickedFilter": {
        "productExtension": [
          {
            "fieldName": "uniqueName",
            "notEquals": "PX1"
          },
          {
            "fieldName": "uniqueName",
            "notEquals": "PX2"
          }
        ],
        "customerExtension": [
          {
            "fieldName": "uniqueName",
            "notEquals": "CX1"
          },
          {
            "fieldName": "uniqueName",
            "notEquals": "CX2"
          }
        ]
      }
    },
    {
      "name": "option2",
      "title": "Option 2",
      "description": "really shitty option",
      "ifNotPickedFilter": {
        "productExtension": [
          {
            "fieldName": "uniqueName",
            "notEquals": "PX3"
          }
        ],
        "customerExtension": [
          {
            "fieldName": "uniqueName",
            "notEquals": "CX3"
          }
        ]
      }
    },
    {
      "name": "option3",
      "title": "Option 3",
      "description": "like the worst option there is",
      "ifNotPickedFilter": {
        "productExtension": [
          {
            "fieldName": "uniqueName",
            "notEquals": "PX4"
          },
          {
            "fieldName": "uniqueName",
            "notEquals": "PX5"
          }
        ],
        "customerExtension": [
          {
            "fieldName": "uniqueName",
            "notEquals": "CX4"
          },
          {
            "fieldName": "uniqueName",
            "notEquals": "CX5"
          }
        ]
      }
    }
  ]
}

PlatformManager Documentation

Filter Form UI Step – filter-form-ui

Specific Attributes

Example